这篇文章的产出也是最近在写代码的时候,遇到的一个很简单的问题,也是大家嘴边常常挂着的
if...else if...else
问题。其实一两个
if...else if...else
也没啥问题的,如果好几个地方用到了的话, 就显得有些磨人了,每次执行那一步操作之前,都必须先判断一遍~。
但其实肿么说勒,在你不知道可以优化代码的方式时,你不会觉得自己写出来的代码有啥问题,甚至还会觉得自己写的还不错。(说的是我自己啦...)
但是如果你知道可以把这件事情做的更好一些,然后你再回头看看自己为了完成任务写出的代码时,就有种自己看着自己把代码写成一副烂代码的感觉。
所以我觉得多学一点设计模式和工作所结合,作用还是特别大的。
开始的缘由
让我去整理一个上传文件的模块,然后项目中的话,就本地和云都混合的,并且也没有确定一定是使用某个存储服务。
目前的话,就支持local、minio、阿里云
,但是我在另外的一个项目中(不是现在我弄的项目),看到了七牛云
。
项目中就写了一个所谓的全局上传的方法:
public static String upload(MultipartFile file, String bizPath, String uploadType) {
String url = "";
if(CommonConstant.UPLOAD_TYPE_MINIO.equals(uploadType)){
url = MinioUtil.upload(file,bizPath);
}else{
url = OssBootUtil.upload(file,bizPath);
}
return url;
}
复制代码
本地上传接口没囊括在内....,是嵌入在业务代码中判断的。
咋一看这个代码,其实不会觉得有啥的,哈哈。
肿么说我自己勒,我在最开始的时候,就按照这个方法,在业务代码中嵌入了一些判断,然后调用的这个方法去上传。
等到功能实现之后,再回头看自己写的代码,是真的觉得....,然后就想动一动它。
在这期间也看了许多文章。
推荐大佬的文章:
代码中的问题
我们先说说上面代码中存在的问题:
- 如果我后期需要增加一个七牛云的文件存储服务,是不是必须要去动这段代码,不动的话,就只能在业务增加逻辑判断。
- 其次,我截图的只是
upload
这一个方法,其他例如delete、download
等等,都需要改动代码去增加一段逻辑。
多个扩展就需要做多个判断,改多次代码。
在维护期间,其实在能不改动源代码的情况下,尽量不要去改动源代码,一定确定能对还好,怕就怕改出了问题,就糟糕了。
并且在设计原则与思想中就有这一点,对开闭原则( 对扩展开放、修改关闭)
开闭原则如何理解呢?
软件实体(模块、类、方法等)应该“对扩展开放、对修改关闭” .
添加一个新的功能,应该是通过在已有代码基础上扩展代码(新增模块、类、方法、属性等),而非修改已有代码(修改模块、类、方法、属性等)的方式来完成。
当然开闭原则并不是说完全杜绝修改,而是以最小的修改代码的代价来完成新功能的开发。
策略模式
关于这个策略模式,其实我一年前记过一篇刚学的笔记Java设计模式-策略模式,当时就是觉得学到了那个阶段,顺着学了一遍,但都是囫囵吞枣,一知半解。
今天是真的实战篇~ 我觉得是有效且可以应用上的一篇文章。
而策略模式又恰好是实现开闭原则的其中的一种模式, 当然很多设计模式的目的之一都是为了实现代码的扩展性。
策略(Strategy)模式的定义:该模式定义了一系列算法,并将每个算法封装起来,使它们可以相互替换,且算法的变化不会影响使用算法的客户。策略模式属于对象行为模式
,它通过对算法进行封装,把使用算法的责任和算法的实现分割开来,并委派给不同的对象对这些算法进行管理。
说概念不好说,我们还是直接上代码~
策略模式代码实现
1、类图
先来整个类图:
(图片说明:类图本身不应该有颜色的,此处是我为了观感更舒适而添加的)
整体不难~
2、编写一个统一的上层接口
/**
* @description:
* @author: Ning Zaichun
* @date: 2022年10月25日 19:53
*/
public interface FileStoreManagerService {
// 此处就是一个枚举类,在后文中
UploadTypeEnum getUploadType();
void upload();
void download();
void deleteFile();
List<String> getFiles();
}
复制代码
我们目前有aliyun、minio、local
三种存储文件的方式,因此我们第二步就是分别编写这三个服务类。
3、编写相关的实现类
/**
* @description:
* @author: Ning Zaichun
* @date: 2022年10月25日 19:59
*/
@Service
public class AliyunFileServiceImpl implements FileStoreManagerService {
@Override
public UploadTypeEnum getUploadType() {
return UploadTypeEnum.ALIYUN;
}
@Override
public void upload() {
System.out.println("调用aliyun的upload方法");
}
@Override
public void download() {
System.out.println("调用aliyun的download方法");
}
@Override
public void deleteFile() {
System.out.println("调用aliyun的deleteFile方法");
}
@Override
public List<String> getFiles() {
System.out.println("调用aliyun的getFiles方法");
return new ArrayList<>();
}
}
复制代码
/**
* @description:
* @author: Ning Zaichun
* @date: 2022年10月25日 20:00
*/
@Service
public class LocalFileServiceImpl implements FileStoreManagerService {
@Override
public UploadTypeEnum getUploadType() {
return UploadTypeEnum.LOCAL;
}
@Override
public void upload() {
System.out.println("调用Local的upload方法");
}
@Override
public void download() {
System.out.println("调用Local的download方法");
}
@Override
public void deleteFile() {
System.out.println("调用Local的deleteFile方法");
}
@Override
public List<String> getFiles() {
System.out.println("调用Local的getFiles方法");
return new ArrayList<>();
}
}
复制代码
/**
* @description:
* @author: Ning Zaichun
* @date: 2022年10月25日 19:56
*/
@Service
public class MinioServiceImpl implements FileStoreManagerService {
@Override
public UploadTypeEnum getUploadType() {
return UploadTypeEnum.MINIO;
}
@Override
public void upload() {
System.out.println("调用minio的upload方法");
}
@Override
public void download() {
System.out.println("调用minio的download方法");
}
@Override
public void deleteFile() {
System.out.println("调用minio的deleteFile方法");
}
@Override
public List<String> getFiles() {
System.out.println("调用minio的getFiles方法");
return new ArrayList<>();
}
}
复制代码
编写完真正实现的服务类后,我们还需要一个方式来获取这些具体的服务类。
比如我们可以实现ApplicationContextAware
接口,把那些具体的实现的服务类,初始化到map里面,等到我们要使用时再通过map
直接获取即可。
4、使用前的准备
我原本想把它叫做初始化的,但是想了想,不太符合,就还是用了这个小标题吧。
/**
* @description:
* @author: Ning Zaichun
* @date: 2022年10月25日 20:04
*/
@Component
public class FileStoreManagerStrategyService implements ApplicationContextAware {
private Map<UploadTypeEnum,FileStoreManagerService> fileStoreManagerStrategy =new HashMap<>();
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
Map<String, FileStoreManagerService> tmepMap = applicationContext.getBeansOfType(FileStoreManagerService.class);
tmepMap.values().forEach(strategyService -> fileStoreManagerStrategy.put(strategyService.getUploadType(), strategyService));
}
public FileStoreManagerService getFileStoreManagerService(UploadTypeEnum uploadTypeEnum){
return fileStoreManagerStrategy.get(uploadTypeEnum);
}
}
复制代码
ApplicationContextAware
是在spring
初始化完bean后才注入上下文的,所以在注入的上下文中,已经将我们具体的实现类加载好啦~
5、使用
/**
* @description:
* @author: Ning Zaichun
* @date: 2022年10月25日 20:39
*/
@RunWith(SpringRunner.class)
@SpringBootTest(classes = {DemoApplication.class})
public class DemoTest {
@Autowired
private FileStoreManagerStrategyService fileStoreManagerStrategyService;
private final String uploadType="aliyun";
@Test
public void test1(){
UploadTypeEnum uploadTypeEnum = DescribableEnum.getByProperty(UploadTypeEnum.class, u -> u.getName(), uploadType);
System.out.println(uploadType);
FileStoreManagerService fileStoreManagerService = fileStoreManagerStrategyService.getFileStoreManagerService(uploadTypeEnum);
fileStoreManagerService.upload();
/**
* out:
* aliyun
* 调用aliyun的upload方法
*/
}
}
复制代码
在测试代码中可以看到,我们直接通过fileStoreManagerStrategyService.getFileStoreManagerService(uploadTypeEnum)
方法就可以获取到我们想要的实现类,完全不需要我们进行繁琐的if...else
去判断到底该new哪个实现类。
这种思想贯穿于诸多框架之中,并且我敢肯定的是,你看到我编写的使用前的准备那段代码时,会觉得意外的熟悉。因为
Spring
生态中太多地方在使用啦,只是很少整体的去看待。
补充
:枚举类的代码和使用,在上一篇文章中,因为更多的关乎思路,就没有将这些贴出来占篇幅了。
要看的可以点击👉你知道 Java 中关键字 enum 是一个语法糖吗?反编译枚举类
6、扩展
之前还说到了策略模式是遵守了开闭原则的~
假如我现在要在之前的代码中,增加一个七牛云的服务,那么我们只需要增加一个七牛云的服务实现类(枚举类增加一个七牛云的枚举值)就完事了,其他的该肿么使用就还是肿么使用。
/**
* @description:
* @author: Ning Zaichun
* @date: 2022年10月25日 20:00
*/
@Service
public class QiniuyunServiceImpl implements FileStoreManagerService {
@Override
public UploadTypeEnum getUploadType() {
return UploadTypeEnum.QINIUYUN;
}
@Override
public void upload() {
System.out.println("调用Qiniuyun的upload方法");
}
@Override
public void download() {
System.out.println("调用Qiniuyun的download方法");
}
@Override
public void deleteFile() {
System.out.println("调用Qiniuyun的deleteFile方法");
}
@Override
public List<String> getFiles() {
System.out.println("调用Qiniuyun的getFiles方法");
return new ArrayList<>();
}
}
复制代码
demo项目的结构
总结
将自己学到的知识,融合到自己的实践中,永远都是最好的方式。
“实践是检验真理的唯一标准”,学了许许多多的理论,但无处实施的话,那也只是纸上谈兵罢啦。
纸上得来终觉浅,绝知此事要躬行。