整理SpringBoot实现文件上传所需的知识
使用的是腾讯云的COS对象存储服务
1. File类
java.io.包下的类，File对象代表当前操作系统下的文件或文件夹，可以调用其提供的方法对它代表的文件进行操作，File类只能对文件本身进行操作，而不能读写文件里面存储的数据
下面是例子中会用到的File类中的方法：
public static File createTempFile(String prefix, String suffix) throws IOExceptionpublic static File createTempFile(String prefix, String suffix, File directory) throws IOException作用：用于在服务器的指定目录或系统默认临时文件目录下创建一个空临时文件。该方法有两个重载版本
形参：prefix是临时文件名的前缀，suffix是临时文件名的后缀(可为null,如果为null则为 .tmp)，directory是临时文件要创建到哪个目录下(可为null,表示使用默认临时文件目录)。
返回值：返回创建的临时文件的File对象
2. MultipartFile类
接收用户上传的文件：在控制器方法中，可以直接使用
MultipartFile类型的参数来接收前端上传的文件。提供便捷的文件操作方法：它提供了一系列方法，可以轻松地获取文件信息（如文件名、大小、类型）以及将文件内容写入磁盘、转换为字节流等。
其中的方法：
| 方法 | 返回类型 | 描述 |
|---|---|---|
getOriginalFilename() | String | 获取客户端上传的原始文件名（包括扩展名），例如 "myphoto.jpg" |
getName() | String | 返回 multipart 表单中的参数名称（即 HTML 中 `` 的 name 属性），而不是文件名。 |
getSize() | long | 获取文件的大小（以字节为单位）。可用于在保存前检查文件是否为空或过大。 |
isEmpty() | boolean | 判断上传的文件是否为空。当用户没有选择文件就提交表单时，返回 true。 |
getContentType() | String | 获取文件的 MIME 类型，例如 "image/jpeg", "text/plain"。注意：这个值是从客户端请求头中获取的，可能不可靠或不提供。 |
getBytes() | byte[] | 将文件内容作为一个字节数组返回。适用于将文件内容读入内存进行处理或保存。 |
getInputStream() | InputStream | 返回一个 InputStream，用于读取文件的内容。这是处理大文件的首选方法，可以避免将整个文件加载到内存中。 |
transferTo(File dest) | void | 将上传的文件传输到给定的目标文件。这是将上传文件保存到本地文件系统最方便、最推荐的方法。 |
transferTo(Path dest) | void | (Since Spring 5.1) 与上一个方法类似，但使用 Java NIO 的 Path 对象作为参数，更现代。 |
3. @RequestPart注解
@RequestPart 是Spring MVC提供的一个注解，用于将multipart/form-data请求中的特定部分（part） 绑定到控制器方法的形参上。它比 @RequestParam 更强大和灵活，特别是当请求中包含非简单文本数据（如JSON、XML）和文件混合时。
例如：
/*** 测试文件上传*/@PostMapping("/test/upload")public BaseResponse<String> testUpload(@RequestParam("file")MultipartFile multipartFile) {}}4. COS对象存储的基本使用流程
首先肯定是要引入COS对象存储的maven依赖的：
<dependency><groupId>com.qcloud</groupId><artifactId>cos_api</artifactId><version>5.6.227</version></dependency>先在SpringBoot配置文件中配置对象存储的相关配置：
# 对象存储的相关配置（需要从腾讯云获取）
cos:client:host: 存储桶的域名secretId: 密钥IDsecretKey: 密钥KEYregion: 存储桶所在的地域bucket: 存储桶的名称
然后定义配置类来读取yml文件中COS对象存储服务的相关信息，同时声明COSClient客户端对象为一个Bean，后面将用这个对象来操作COS对象存储服务：
@Configuration
@ConfigurationProperties(prefix = "cos.client")
@Data
public class CosClientConfig { /** * 域名 */ private String host; /** * secretId */ private String secretId; /** * 密钥（注意不要泄露） */ private String secretKey; /** * 区域 */ private String region; /** * 桶名 */ private String bucket; /*** 创建COSClient实例,用于操作COS对象存储服务*/@Beanpublic COSClient cosClient() {// 初始化用户身份信息(secretId, secretKey) COSCredentials cred = new BasicCOSCredentials(secretId, secretKey);// 设置bucket的区域, COS地域的简称请参照 https://www.qcloud.com/document/product/436/6224 ClientConfig clientConfig = new ClientConfig(new Region(region));// 生成cos客户端 return new COSClient(cred, clientConfig); }
}
然后定义一个封装通用对象存储操作的通用类，比如文件上传、文件下载，该类需要注入对象存储配置类和COSClient对象：
/*** 封装对象存储的操作类*/
@Component
public class CosManager { @Resourceprivate CosClientConfig cosClientConfig;//操作对象存储的客户端对象@Resource private COSClient cosClient;/*** 上传对象** @param key 对象在存储桶中的唯一标识* @param file 本地文件*/public PutObjectResult putObject(String key, File file) {//创建一个PutObjectRequest上传对象请求对象，来指定要向哪个存储桶中上传哪个文件，同时需要指定对象在存储桶中的唯一标识PutObjectRequest putObjectRequest = new PutObjectRequest(cosClientConfig.getBucket(), key,file);//最后调用COSClient的putObject方法，将PutObjectRequest对象传入，上传文件return cosClient.putObject(putObjectRequest);}/*** 下载对象** @param key 唯一键*/public COSObject getObject(String key) {//创建一个GetObjectRequest下载对象请求对象，来指定从哪个存储桶中下载哪个文件GetObjectRequest getObjectRequest = new GetObjectRequest(cosClientConfig.getBucket(), key);//最后调用COSClient的getObject方法，将GetObjectRequest对象传入，下载文件return cosClient.getObject(getObjectRequest);}/*** 上传图片的同时解析图片（附带图片信息）** @param key 唯一键* @param file 文件*/public PutObjectResult putPictureObject(String key, File file) {PutObjectRequest putObjectRequest = new PutObjectRequest(cosClientConfig.getBucket(), key,file);// 对图片进行处理（获取基本信息也被视作为一种处理）PicOperations picOperations = new PicOperations();// 1 表示返回原图信息picOperations.setIsPicInfo(1);// 构造处理参数putObjectRequest.setPicOperations(picOperations);return cosClient.putObject(putObjectRequest);}}
再定义一个类来封装上传图片的方法：
/*** 上传图片的工具类*/
@Slf4j
@Service
public class FileManager {@Resourceprivate CosClientConfig cosClientConfig;@Resource private CosManager cosManager;/*** 上传图片** @param multipartFile 上传的文件* @param uploadPathPrefix 上传路径的前缀* @return*/public UploadPictureResult uploadPicture(MultipartFile multipartFile, String uploadPathPrefix) {// 校验图片validPicture(multipartFile);// 处理图片的上传地址String uuid = RandomUtil.randomString(16);String originFilename = multipartFile.getOriginalFilename();//自己处理上传文件的文件名，而不是使用原始的文件名，增加安全性String uploadFilename = String.format("%s_%s.%s", DateUtil.formatDate(new Date()), uuid,FileUtil.getSuffix(originFilename));//文件上传到存储桶中的路径（前缀/文件名.后缀）String uploadPath = String.format("/%s/%s", uploadPathPrefix, uploadFilename);//解析结果并返回File file = null;try {// 创建临时文件file = File.createTempFile(uploadPath, null);multipartFile.transferTo(file);// 上传图片PutObjectResult putObjectResult = cosManager.putPictureObject(uploadPath, file);//获取图片上传信息对象ImageInfo imageInfo = putObjectResult.getCiUploadResult().getOriginalInfo().getImageInfo();//计算图片的宽高int picWidth = imageInfo.getWidth();int picHeight = imageInfo.getHeight();double picScale = NumberUtil.round(picWidth * 1.0 / picHeight, 2).doubleValue();// 封装返回结果UploadPictureResult uploadPictureResult = new UploadPictureResult();uploadPictureResult.setPicName(FileUtil.mainName(originFilename));uploadPictureResult.setPicWidth(picWidth);uploadPictureResult.setPicHeight(picHeight);uploadPictureResult.setPicScale(picScale);uploadPictureResult.setPicFormat(imageInfo.getFormat());uploadPictureResult.setPicSize(FileUtil.size(file));uploadPictureResult.setUrl(cosClientConfig.getHost() + "/" + uploadPath);return uploadPictureResult;} catch (Exception e) {log.error("图片上传到对象存储失败", e);throw new BusinessException(ErrorCode.SYSTEM_ERROR, "上传失败");} finally {this.deleteTempFile(file);}}/*** 校验文件** @param multipartFile multipart 文件*/public void validPicture(MultipartFile multipartFile) {ThrowUtils.throwIf(multipartFile == null, ErrorCode.PARAMS_ERROR, "文件不能为空");// 1. 校验文件的大小long fileSize = multipartFile.getSize();final long ONE_M = 1024 * 1024L;ThrowUtils.throwIf(fileSize > 2 * ONE_M, ErrorCode.PARAMS_ERROR, "文件大小不能超过 2M");// 2. 校验上传文件的后缀String fileSuffix = FileUtil.getSuffix(multipartFile.getOriginalFilename());// 定义允许上传的文件后缀final List<String> ALLOW_FORMAT_LIST = Arrays.asList("jpeg", "jpg", "png", "webp");ThrowUtils.throwIf(!ALLOW_FORMAT_LIST.contains(fileSuffix), ErrorCode.PARAMS_ERROR, "文件类型错误");}/*** 删除临时文件*/public void deleteTempFile(File file) {if (file == null) {return;}// 删除临时文件boolean deleteResult = file.delete();if (!deleteResult) {log.error("file delete error, filepath = {}", file.getAbsolutePath());}}}
至此，其实使用COS对象存储上传文件的所有代码就已经编写完成了，上述代码都是上传文件时的通用代码。
下面再继续完成上传图片的完整业务：