策略模式实现文件上传
大约 6 分钟
策略模式实现文件上传
1、策略模式介绍
策略模式（Strategy Design Pattern），定义一堆算法类，并将每个算法分别封装起来，让它们可以互相替换，被封装起来的算法具有独立性外部不可改变其特性。
策略模式可以使算法的变化独立于使用它们的客户端（这里的客户端代指使用算法的代码）。
策略模式的应用场景 策略模式最常见的应用场景是，利用它来避免冗长的 if-else 或 switch 分支判断。不过，它的作用还不止如此。它也可以像模板模式那样，提供框架的扩展点等等。
当我们需要多个功能相似的类，并且需要它们之间可以灵活切换时，就非常适合使用策略模式。
策略模式的构成 策略类的定义比较简单，需要定义以下两种角色：
- 抽象策略接口类：定义了策略类需要实现的方法规范。
- 策略实现类：继承自抽象策略接口，为具体策略类。
- 当有多个策略时，可以通过简单工厂封装所有的策略，使调用更加易用：
策略工厂类：一般来说，通过一个策略工厂，将一群功能相同的策略封装起来，调用更加方便。 通过一个文件处理的例子来说明；有一个文件处理的通用类，可以处理excel、txt、exe文件。 面对不同类型的文件，返回具体对应的文件处理类，也就是具体的策略类。
2、实战
说明：使用策略模式从系统配置文件中切换文件上传方式：①、阿里云oss上传；②、Minio文件上传
①、导入依赖
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--确保在使用@ConfigurationProperties注解时，可以优雅的读取配置信息-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
</dependency>
<!--热部署工具-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>2.0.21</version>
</dependency>
<!-- 阿里云oss依赖 -->
<dependency>
<groupId>com.aliyun.oss</groupId>
<artifactId>aliyun-sdk-oss</artifactId>
<version>3.10.2</version>
</dependency>
<!-- 日期工具栏依赖 -->
<dependency>
<groupId>joda-time</groupId>
<artifactId>joda-time</artifactId>
<version>2.9.9</version>
</dependency>
<!--minio依赖-->
<dependency>
<groupId>io.minio</groupId>
<artifactId>minio</artifactId>
<version>8.4.3</version>
</dependency>
</dependencies>
②、配置文件
特别说明：这里默认读者会使用阿里云oss和分布式文件存储Minio上传文件
server:
port: 8080
spring:
servlet:
multipart:
max-file-size: 100MB
max-request-size: 100MB
application:
store:
oss:
endpoint: oss-cn-beijing.aliyuncs.com
accessKey: LTAI5tGSrnxxxxxxxxxxxxxx
secretKey: sXW8K7HPD9xxxxxxxxxxxxxxx
bucketname: sixkey
minio:
endpoint: http://localhost:9000
accessKey: minioadmin
secretKey: minioadmin
bucketName: test
项目模块
读取配置文件中的值
@Getter
@Setter
@Component
@ConfigurationProperties("application.store") //获取配置文件中的配置信息
public class ObjectStoreProperties {
private ConfigEntity oss;
private ConfigEntity minio;
//静态内部类
@Getter
@Setter
public static class ConfigEntity{
private String endpoint;
private String accessKey;
private String secretKey;
private String bucketname;
}
}
③、定义一个文件上传的顶级接口
//文件上传顶级接口
public interface UploadStrategy {
/**
* 上传文件
* @param file
* @return
*/
String uploadFile(MultipartFile file);
}
④、文件上传抽象类
/**
* 文件上传执行抽象类
*/
public abstract class AbstractUploadStrategyImpl implements UploadStrategy {
@Override
public String uploadFile(MultipartFile file) {
try {
//region 初始化
initClient();
String fileRelativePath;
try {
fileRelativePath = executeUpload(file);
} catch (Exception e) {
throw new RuntimeException(e);
}
//endregion
//返回图片访问路径url
return getPublicNetworkAccessUrl(fileRelativePath);
} catch (Exception e) {
throw new RuntimeException("文件上传失败");
}
}
/**
* 初始化客户端
*/
public abstract void initClient();
/**
* 检查文件是否已经存在（文件MD5值唯一）
*
* @param fileRelativePath 文件相对路径
* @return true 已经存在 false 不存在
*/
public abstract boolean checkFileIsExisted(String fileRelativePath);
/**
* 执行上传操作
*
* @param file 文件
* @param
* @throws IOException io异常信息
*/
public abstract String executeUpload(MultipartFile file) throws IOException, ServerException, InsufficientDataException, ErrorResponseException, NoSuchAlgorithmException, InvalidKeyException, InvalidResponseException, XmlParserException, InternalException;
/**
* 获取公网访问路径
*
* @param fileRelativePath 文件相对路径
* @return 公网访问绝对路径
*/
public abstract String getPublicNetworkAccessUrl(String fileRelativePath);
}
⑤、阿里云和Minio上传实现类
Minio实现类
/**
* ClassName:OssUploadStrategyImpl
* Package:com.strategy.strategy.impl
* Description
*
* @Author:@wenxueshi
* @Create:2023/7/16 - 22:16
* @Version:v1.0
*/
@Slf4j
@Getter
@Setter
@RequiredArgsConstructor
@Service("MinioUploadServiceImpl")
public class MinioUploadStrategyImpl extends AbstractUploadStrategyImpl {
/**
* 构造器注入配置文件bean
*/
private final ObjectStoreProperties properties;
/**
* 当前类的属性
*/
private MinioClient minioClient;
//初始化Minio对象
@Override
public void initClient() {
minioClient = MinioClient.builder()
.endpoint(properties.getMinio().getEndpoint())
.credentials(properties.getMinio().getAccessKey(),
properties.getMinio().getSecretKey())
.build();
log.info("OssClient Init Success...");
}
@Override
public boolean checkFileIsExisted(String fileRelativePath) {
return true;
}
//Minio方式上传逻辑
@Override
public String executeUpload(MultipartFile file) {
log.info("File Upload Starts...");
String fileName = file.getOriginalFilename();
//必须写出\\.这是转义，将文件名2.jpg从.开始分割成 2 和 jpg
String[] split = fileName.split("\\.");
if (split.length > 1) {
//防止文件重名：添加系统时间：文件名为：2_37598375837.jpg
//方式1：
//fileName = split[0] + "_" + System.currentTimeMillis() + "." + split[1];
//方式2：
// 完善1、 --> 在文件名中添加唯一值
String uuid = UUID.randomUUID().toString().replace("-", "");
fileName = uuid + split[0] + "." + split[1];
// 完善2、 --> 把文件按照日期分类
String datePath = new DateTime().toString("yyyy/MM/dd");
// 拼接时间 yyyy/MM/dd/filename
fileName = datePath + "/" + fileName;
} else {
fileName = fileName + System.currentTimeMillis();
}
InputStream in = null;
try {
//开始上传
in = file.getInputStream();
minioClient.putObject(PutObjectArgs.builder()
.bucket(properties.getMinio().getBucketname())
.object(fileName)
.stream(in, in.available(), -1)
.contentType(file.getContentType())
.build()
);
} catch (Exception e) {
e.printStackTrace();
} finally {
//关闭流
if (in != null) {
try {
in.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
fileName = properties.getMinio().getEndpoint() + "/" + properties.getMinio().getBucketname() + "/" + fileName;
log.info("File Upload Finish...");
//最后文件返回路径：http://localhost:9000/test/2023/07/20/06a415a221804ceebe8048d015c97f9a1.jpg
return fileName;
}
//返回文件访问公网地址
@Override
public String getPublicNetworkAccessUrl(String fileRelativePath) {
return fileRelativePath;
}
}
阿里云实现类
/**
* ClassName:OssUploadStrategyImpl
* Package:com.strategy.strategy.impl
* Description
*
* @Author:@wenxueshi
* @Create:2023/7/16 - 22:16
* @Version:v1.0
*/
@Slf4j
@Getter
@Setter
@RequiredArgsConstructor
@Service("ossUploadServiceImpl")
public class OssUploadStrategyImpl extends AbstractUploadStrategyImpl {
/**
* 构造器注入bean
*/
private final ObjectStoreProperties properties;
/**
* 当前类的属性
*/
private OSS ossClient;
//初始化ossClient对象
@Override
public void initClient() {
ossClient = new OSSClientBuilder().build(properties.getOss().getEndpoint(), properties.getOss().getAccessKey(), properties.getOss().getSecretKey());
log.info("OssClient Init Success...");
}
@Override
public boolean checkFileIsExisted(String fileRelativePath) {
return ossClient.doesObjectExist(properties.getOss().getBucketname(), fileRelativePath);
}
//阿里云文件上传逻辑
@Override
public String executeUpload(MultipartFile file) throws IOException {
log.info("File Upload Starts...");
// 获取文件原始名称
String filename = file.getOriginalFilename();
// 完善1、 --> 在文件名中添加唯一值
String uuid = UUID.randomUUID().toString().replace("-", "");
filename = uuid + filename;
// 完善2、 --> 把文件按照日期分类
String datePath = new DateTime().toString("yyyy/MM/dd");
// 拼接时间 yyyy/MM/dd/filename
filename = datePath + "/" + filename;
ossClient.putObject(properties.getOss().getBucketname(), filename, file.getInputStream());
log.info("File Upload Finish...");
return filename;
}
//返回文件访问公网地址
@Override
public String getPublicNetworkAccessUrl(String fileRelativePath) {
String url = "https://"+properties.getOss().getBucketname()+"."+properties.getOss().getEndpoint()+"/"+fileRelativePath;
return url;
}
}
⑥、执行文件上传上下文
说明：好好理解Map的value的值为接口时的作用
/**
* ClassName:UploadStrategyContext
* Package:com.strategy.strategy.context
* Description
*
* @Author:@wenxueshi
* @Create:2023/7/16 - 22:25
* @Version:v1.0
*/
//文件上传上下问实现
@Component
@RequiredArgsConstructor
public class UploadStrategyContext {
/*
当Map集合的Value为接口类型时，Spring会自动对Map集合进行注入。
其中map集合的key为接口对应实现类的BeanName
其中map集合的vlaue为接口对应实现类的实例
*/
private final Map<String, UploadStrategy> uploadStrategyMap;
/**
* 执行上传策略
*
* @param file 文件
* @param
* @return {@link String} 文件上传全路径
*/
public String executeUploadStrategy(MultipartFile file, String uploadServiceName) {
// 执行特点的上传策略
return uploadStrategyMap.get(uploadServiceName).uploadFile(file);
}
}
⑦、指定上传方式
一般配置在数据库中进行动态切换，这里为了测试方便，直接定义成常量
package com.strategy.config;
/**
* ClassName:SystemConfig
* Package:com.strategy.config
* Description
*
* @Author:@wenxueshi
* @Create:2023/7/20 - 23:24
* @Version:v1.0
*/
//获取实际项目中的系统配置，为了方便测试，直接定义为常量
public class SystemConfig {
//Minio上传方式
public static final String MINIO_STRATEGY = "MinioUploadServiceImpl";
//阿里云上传方式
public static final String OSS_STRATEGY = "ossUploadServiceImpl";
}
⑧、测试接口
/**
* ClassName:UploadController
* Package:com.strategy.controller
* Description
*
* @Author:@wenxueshi
* @Create:2023/7/16 - 22:29
* @Version:v1.0
*/
@RestController
@RequiredArgsConstructor
public class UploadController {
private final UploadStrategyContext uploadStrategyContext;
@PostMapping("/upload")
public String upload(MultipartFile file){
//指定上传文件以及上传方式。
return uploadStrategyContext.executeUploadStrategy(file, SystemConfig.MINIO_STRATEGY);
}
}
⑨、测试返回展示
Minio方式展示
直接在浏览器中复制访问即可
阿里云展示
策略模式上传文件到此结束！