软件开发原则

软件开发原则

原则介绍单一职责原则一个类或模块应该只负责一项任务或功能开闭原则软件实体（类、模块、函数等）应该对扩展开放，对修改关闭里氏替换原则子类应该能够替换其父类并且不会破坏程序的正确性接口隔离原则客户端不应该强制依赖它不需要的接口，即应该将接口拆分成更小的部分依赖倒置原则高层模块不应该依赖于底层模块，它们都应该依赖于抽象接口迪米特法则一个类应该对自己需要耦合或调用的类知道得最少（提供最简化调用接口）聚合复用原则尽量使用对象组合，而不是继承来达到复用的目的以我个人的开源项目举例，来介绍几个基本软件开发原则的基本使用
【SpringBoot集成OnlyOffice实现文档预览】
单一职责原则

模块的单一职责

该开源项目可以作为一个jar引入，其承担的职责就是对onlyoffice集成，实现对office文件的预览和编辑。在领域驱动设计中，每个领域对象和聚合根通常应该遵循单一职责原则，确保它们只负责一个明确定义的领域职责。这有助于保持领域模型的清晰性，同时也符合单一职责原则的要求。

类的单一职责

我定义了如下几个接口类，其中每个类只负责了单一的职能
存储服务接口

1. package org.lboot.onlyoffice.loader;
3. import org.lboot.onlyoffice.domain.Document;
5. import java.io.InputStream;
7. /**
8. * @author kindear
9. * office 文档存储服务
10. * 该服务与第三方或者本地文件系统集成
11. */
12. public interface OfficeStoreLoader {
13.     /**
14.      * 根据文件 key 获取文件信息
15.      * @param fileKey
16.      * @return
17.      */
18.     Document readFile(String fileKey);
20.     /**
21.      * 修改文件
22.      * @param fileKey
23.      * @param stream
24.      * @return
25.      */
26.     boolean writeFile(String fileKey, InputStream stream);
28. }

复制代码

鉴权服务接口

1. package org.lboot.onlyoffice.loader;
3. /**
4. * @author kindear
5. * Office 鉴权信息加载
6. */
7. public interface OfficeAuthLoader {
8.     /**
9.      * 获取当前登录用户ID
10.      * @return
11.      */
12.     default String getUserId(){
13.         return "0";
14.     }
16.     /**
17.      * 获取当前登录用户名称
18.      * @return
19.      */
20.     default String getUserName(){
21.         return "guest";
22.     }
23. }

复制代码

配置接口

1. package org.lboot.onlyoffice.loader;
3. /**
4. * @author kindear
5. * OnlyOffice配置加载
6. */
7. public interface OfficeConfigLoader {
8.     /**
9.      * 获取客制化LOGO地址
10.      * @return
11.      */
12.     @Deprecated
13.     default String getCustomLogo(){
14.         return "";
15.     }
17.     /**
18.      * 获取默认语言
19.      * 默认 zh-CN 中文
20.      * @return
21.      */
22.     default String getLang(){
23.         return "zh-CN";
24.     }
26.     /**
27.      * 获取回调地址
28.      * @return
29.      */
30.     default String getCallbackUrl(){
31.         return "";
32.     }
34. }

复制代码

开闭原则

对扩展开放，对修改关闭

将我的项目作为依赖引入后，自然而然符合对修改关闭这个特点，
集成的业务系统又可以基于上面所定义的接口，来拓展实现功能，满足对拓展开放
具体可以查看【拓展】
里氏替换原则

子类可以扩展父类的功能，但不能改变父类原有的功能

我在代码设计中加入了基于spring上下文的事件监听机制，该子类继承自父类ApplicationEvent，该实现没有改变父类可以被spring框架管理监听的特性，又拓展了新的字段属性，使得该子类可以在被spring管理监听的基础上，携带了更多参数。

1. package org.lboot.onlyoffice.event;
3. import lombok.Getter;
4. import org.springframework.context.ApplicationEvent;
6. import java.time.Clock;
8. /**
9. * @author kindear
10. * office 文档编辑构建事件 传入文件ID 和 用户ID
11. */
12. @Getter
13. public class OfficeEditBuildEvent extends ApplicationEvent {
14.     String userId;
16.     String fileKey;
18.     public OfficeEditBuildEvent(Object source, String userId, String fileKey) {
19.         super(source);
20.         this.userId = userId;
21.         this.fileKey = fileKey;
22.     }
24.     public OfficeEditBuildEvent(Object source, Clock clock) {
25.         super(source, clock);
26.     }
27. }

复制代码

接口依赖原则

接口仅仅提供客户端需要的行为，即所需的方法，客户端不需要的行为则隐藏起来，应当为客户端提供尽可能小的单独的接口，而不要提供大的总接口

在完成配置项后，不需要用户关注底层的编辑回调，文件装载，文件信息获取如何实现，该依赖为用户提供了最简单的调用接口OfficeCtl，所有引入该依赖的，都只需要该类即可。

1. package org.lboot.onlyoffice.service;
3. import org.lboot.onlyoffice.domain.DocEditor;
4. import org.lboot.onlyoffice.domain.Document;
5. import org.springframework.web.servlet.ModelAndView;
7. import javax.servlet.http.HttpServletResponse;
8. import java.util.Map;
10. /**
11. * @author kindear
12. * onlyoffice 服务实现类
13. */
14. public interface OfficeCtl {
15.     /**
16.      * 根据文件后缀 获取office 中类型
17.      * @param extName
18.      * @return 文件类型
19.      */
20.      String getDocumentType(String extName);
22.     /**
23.      * 构建远程文档访问 Document
24.      * @param remoteUrl
25.      * @return
26.      */
27.      Document buildRemoteDocument(String remoteUrl);
29.     /**
30.      * 构建文档预览 DocEditor
31.      * @param document
32.      * @return
33.      */
34.      DocEditor buildPreviewDocEditor(Document document);
36.     /**
37.      * 构建文档编辑 DocEditor
38.      * @param document
39.      * @return
40.      */
41.      DocEditor buildEditDocEditor(Document document);
43.     /**
44.      * 预览远程文件
45.      * @return file-temp
46.      */
47.     @Deprecated
48.     ModelAndView previewRemoteFile(String remoteUrl, HttpServletResponse servletResponse);
50.     /**
51.      * 预览远程文件
52.      * @param remoteUrl
53.      * @return
54.      */
55.      ModelAndView previewRemoteFile(String remoteUrl);
57.     /**
58.      * 移动端预览远程文件
59.      * @param remoteUrl
60.      * @return
61.      */
62.      ModelAndView previewRemoteFileOnMobile(String remoteUrl);
64.     /**
65.      * 嵌入式预览远程文件
66.      * @param remoteUrl
67.      * @return
68.      */
69.      ModelAndView previewRemoteFileOnEmbedded(String remoteUrl);
71.     /**
72.      * 根据文件key 预览文件
73.      * @param fileKey
74.      * @return 预览试图
75.      */
76.      ModelAndView previewFile(String fileKey);
78.     /**
79.      * 文件预览
80.      * @param editor
81.      * @return
82.      */
83.     ModelAndView previewFile(DocEditor editor);
85.     /**
86.      * 文件预览 制定预览标题
87.      * @param editor
88.      * @param title
89.      * @return
90.      */
91.     ModelAndView previewFile(DocEditor editor, String title);
94.     /**
95.      * 编辑远程文件
96.      * @param remoteUrl
97.      * @return
98.      */
99.     ModelAndView editRemoteFile(String remoteUrl);
103.     /**
104.      * 文件编辑
105.      * @param fileKey
106.      * @return
107.      */
108.     ModelAndView editFile(String fileKey);
110.     /**
111.      * 文件编辑
112.      * @param document
113.      * @return
114.      */
115.     ModelAndView editFile(Document document);
117.     /**
118.      * 文件编辑
119.      * @param editor
120.      * @return
121.      */
122.     ModelAndView editFile(DocEditor editor);
126.     /**
127.      * 编辑回调
128.      * @param params
129.      * @return
130.      */
131.     Object editCallback(Map<String,Object> params);
133.     /**
134.      * 将远程访问文件转化为 Pdf
135.      * @param remoteUrl
136.      * @return pdf 下载地址
137.      */
138.     String covertToPdf(String remoteUrl);
140.     /**
141.      * 将文件转化未 pdf
142.      * @param document
143.      * @return
144.      */
145.     String covertToPdf(Document document);
148.     /**
149.      * 文件生成缩略图
150.      * @param remoteUrl
151.      * @return
152.      */
153.     String generateThumbnail(String remoteUrl);
155.     /**
156.      * 文件生成缩略图
157.      * @param document
158.      * @return
159.      */
160.     String generateThumbnail(Document document);
162. }

复制代码

依赖倒置原则

高层模块不应该依赖于底层模块，它们都应该依赖于抽象接口

以OfficeCtl接口的实现举例，注入的接口全都是抽象接口，无论是基于默认的服务实现还是拓展实现，都可以注入。

1. @Slf4j
2. @Service
3. @AllArgsConstructor
4. public class OfficeCtlImpl implements OfficeCtl {
5.     OnlyOfficeProperties officeProps;
7.     OfficeConfigLoader configLoader;
9.     OfficeAuthLoader authLoader;
11.     OfficeStoreLoader storeLoader;
13.     @Resource
14.     ApplicationContext context;
15.    
16.     //...
17. }

复制代码

迪米特法则

一个类应该对自己需要耦合或调用的类知道得最少（提供最简化调用接口）

例如读取本地存储系统文件并预览的接口

1.         @SneakyThrows
2.           @Override
3.     public ModelAndView previewFile(String fileKey) {
4.         Document document = storeLoader.readFile(fileKey);
5.         DocEditor docEditor = buildPreviewDocEditor(document);
6.         return previewFile(docEditor);
7.     }

复制代码

我们只需要关注调用storeLoader.readFile(fileKey);可以获取对应的信息，对于该接口中如何获取文件并读取信息的实现不需要关注。
合成复用原则

OfficeCtl的实现类即是几种服务的合成复用的案例

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！