前言
OSS云服务可以便捷解决文件（如图片、视频、备份、日志）的存储、管理和访问问题。本文以阿里云OSS为例，（未开通的可以参考此处开通对象存储OSS服务并创建Bucket-开发者社区-阿里云）旨在说明如何在SpringBoot项目中正确，优雅地实现OSS的使用。
实现步骤
定义OSS相关配置
在application.yml配置文件中配置必要参数：
alioss:
endpoint:
access-key-id:
access-key-secret: ${OSS_ACCESS_KEY_SECRET}
bucket-name: ${OSS_ACCESS_KEY_ID}
：后面的参数一定要以自己的为准，笔者这里推荐将密钥和ID设为环境变量，程序运行时自动从环境变量中读取，安全性较高。
读取OSS配置
将这4个属性封装在一个配置类中
@Component
@ConfigurationProperties(prefix = "alioss")
@Data
public class AliOssProperties {
private String endpoint;
private String accessKeyId;
private String accessKeySecret;
private String bucketName;
}
装配OSS属性
通过配置类在项目启动时自动地将yml中的值填充入AliOssProperties中，降低代码耦合度，符合单一职责原则，便于代码的维护与扩展。
@Slf4j
@Configuration
public class OssConfiguration {
@Bean
@ConditionalOnMissingBean
public AliOssUtil aliOssUtil(AliOssProperties aliOssProperties){
log.info("开始创建阿里云文件上传工具类，配置信息：{}",aliOssProperties);
return new AliOssUtil(aliOssProperties.getEndpoint(),
aliOssProperties.getAccessKeyId(),
aliOssProperties.getAccessKeySecret(),
aliOssProperties.getBucketName());
}
}
带有@Bean的方法，形参会自动匹配Spring容器中的对象，并将返回值注册为Spring Bean。
- 因为AliOssProperties以及通过@Component注解交由容器管理，所以这里只要确保拼写正确就能够直接注入。
- 在方法体中赋值给AliOssUtil，同时返回的也是AliOssUtil，既完成了赋值，又完成了控制反转。
创建工具类
前置工作都完成后，就可以编写工具类，真正实现文件上传功能：
@Data
@AllArgsConstructor
@Slf4j
public class AliOssUtil {
private String endpoint;
private String accessKeyId;
private String accessKeySecret;
private String bucketName;
/**
* 文件上传
*
* @param bytes
* @param objectName
* @return
*/
public String upload(byte[] bytes, String objectName) {
// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
try {
// 创建PutObject请求。
ossClient.putObject(bucketName, objectName, new ByteArrayInputStream(bytes));
} catch (OSSException oe) {
System.out.println("Caught an OSSException, which means your request made it to OSS, "
+ "but was rejected with an error response for some reason.");
System.out.println("Error Message:" + oe.getErrorMessage());
System.out.println("Error Code:" + oe.getErrorCode());
System.out.println("Request ID:" + oe.getRequestId());
System.out.println("Host ID:" + oe.getHostId());
} catch (ClientException ce) {
System.out.println("Caught an ClientException, which means the client encountered "
+ "a serious internal problem while trying to communicate with OSS, "
+ "such as not being able to access the network.");
System.out.println("Error Message:" + ce.getMessage());
} finally {
if (ossClient != null) {
ossClient.shutdown();
}
}
//文件访问路径规则 https://BucketName.Endpoint/ObjectName StringBuilder stringBuilder = new StringBuilder("https://");
stringBuilder
.append(bucketName)
.append(".")
.append(endpoint)
.append("/")
.append(objectName);
log.info("文件上传到:{}", stringBuilder.toString());
return stringBuilder.toString();
}
}
方法形参分别为原始文件的字节数组（原始二进制内容）和保存到bucket中的名字， 返回值为访问该文件的路径。（格式一定要正确） 方法体中的代码参照官方SDK文档：访问管理OSS的Java客户端-OSS Java SDK V1-对象存储-阿里云
注意：objectName中可以使用”/“来达到文件夹分级的效果，笔者此处未进行相关处理，所有文件将直接保存在根目录下。
Controller层调用
@Slf4j
@Api(tags = "通用接口")
@RestController
@RequestMapping("/admin/common")
public class CommonController {
@Autowired
private AliOssUtil aliOssUtil;
@PostMapping("/upload")
public Result<String> upload(MultipartFile file){
log.info("文件上传：{}",file);
//获取文件扩展名
String originalFilename = file.getOriginalFilename();
String suffix = originalFilename.substring(originalFilename.lastIndexOf("."));
String fileName = UUID.randomUUID().toString() + suffix;
try {
String filePath = aliOssUtil.upload(file.getBytes(), fileName);
return Result.success(filePath);
} catch (IOException e) {
log.error("文件上传失败：{}", e.getMessage());
}
return Result.error(MessageConstant.UPLOAD_FAILED);
}
}
在配置类中使用带有@Bean注解的方法给属性赋值时，已经将AliOssUtil交给容器，在Controller层就可以直接通过@Autowired将其注入来使用。
注意：
- 接收文件的参数类型是MultipartFile，这是MVC已经封装好的对象，变量名file必须和前端保持一致才能够接收到文件。
- 为确保文件名不重复，此处使用UUID+原文件扩展名来作为上传到bucket之后的文件名，其本质是对字符串的处理。
- 调用aliOssUtil的upload方法时，第一个参数是字节数组，要使用MultipartFile的getBytes()方法转换数据类型。
- 本文中的示例代码中的请求路径请根据实际接口文档改写。
