【设计模式之美】 SOLID 原则之四：接口隔离原则有哪三种应用？原则中的“接口”该如何理解？

2024-01-08 14:20
文章标签 接口 设计模式 应用 三种 理解 原则 之美 solid 之四 接口隔离

本文主要是介绍【设计模式之美】 SOLID 原则之四：接口隔离原则有哪三种应用？原则中的“接口”该如何理解？，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

文章目录

  • 一. 如何理解“接口隔离原则”？
  • 二. 接口隔离的三个情况
    • 1. 把“接口”理解为一组 API 接口集合
    • 2. 把“接口”理解为单个 API 接口或函数 ing（能够使用的场景并未理解）
    • 3. 把“接口”理解为 OOP 中的接口概念

一. 如何理解“接口隔离原则”？

客户端不应该被强迫依赖它不需要的接口（简单的理解：不在原有接口的增加方法）。其中的“客户端”，可以理解为接口的调用者或者使用者。

在这条原则中，我们可以把“接口”理解为下面三种情况：

  • 一组 API 接口集合
  • 单个 API 接口或函数
  • OOP 中的接口概念

接下来从这三个方面举例说明，接口隔离的具体应用

 

二. 接口隔离的三个情况

1. 把“接口”理解为一组 API 接口集合

微服务用户系统提供了一组跟用户相关的 API 给其他系统使用，比如：注册、登录、获取用户信息等。具体代码如下所示：

public interface UserService {boolean register(String cellphone, String password);boolean login(String cellphone, String password);UserInfo getUserInfoById(long id);UserInfo getUserInfoByCellphone(String cellphone);
}public class UserServiceImpl implements UserService {//...
}

现在，我们的后台管理系统要实现删除用户的功能，希望用户系统提供一个删除用户的接口。

 

违背接口隔离的方案

只需要在 UserService 中新添加一个 deleteUserByCellphone() 或 deleteUserById() 接口就可以了。这个方法可以解决问题，但是也隐藏了一些安全隐患。
删除用户是一个非常慎重的操作，我们只希望通过后台管理系统来执行，所以这个接口只限于给后台管理系统使用。如果我们把它放到 UserService 中，那所有使用到 UserService 的系统，都可以调用这个接口。不加限制地被其他业务系统调用，就有可能导致误删用户。
当然，最好的解决方案是从架构设计的层面，通过接口鉴权的方式来限制接口的调用。不过，如果暂时没有鉴权框架来支持，我们还可以从代码设计的层面，尽量避免接口被误用。

 

参照接口隔离原则

调用者不应该强迫依赖它不需要的接口，那么我们将删除接口单独放到另外一个接口中，然后将接口只打包（即只是UserServiceImpl集成新增接口）提供给后台管理系统来使用。

public interface UserService {boolean register(String cellphone, String password);boolean login(String cellphone, String password);UserInfo getUserInfoById(long id);UserInfo getUserInfoByCellphone(String cellphone);
}// 接口隔离原则：再新增一个接口，而不是在原有的接口中进行修改
public interface RestrictedUserService {boolean deleteUserByCellphone(String cellphone);boolean deleteUserById(long id);
}public class UserServiceImpl implements UserService, RestrictedUserService {// ...省略实现代码...
}

 
小结

在设计微服务或者类库接口的时候，如果部分接口只被部分调用者使用，那我们就需要将这部分接口隔离出来，单独给对应的调用者使用，而不是强迫其他调用者也依赖这部分不会被用到的接口。

 

2. 把“接口”理解为单个 API 接口或函数 ing（能够使用的场景并未理解）

把接口理解为单个（接口或）函数（以下为了方便讲解，我都简称为“函数”）。那接口隔离原则就可以理解为：函数的设计要功能单一，不要将多个不同的功能逻辑在一个函数中实现。

接下来，我们还是通过一个例子来解释一下。

public class Statistics {private Long max;private Long min;private Long average;private Long sum;private Long percentile99;private Long percentile999;//...省略constructor/getter/setter等方法...
}public Statistics count(Collection<Long> dataSet) {Statistics statistics = new Statistics();//...省略计算逻辑...return statistics;
}

在上面的代码中，count() 函数的功能不够单一:

  • 包含很多不同的统计功能， 比如，求最大值、最小值、平均值等等。按照接口隔离原则，我们应该把 count() 函数拆成几个更小粒度的函数，每个函数负责一个独立的统计功能。
  • 代码实现可能通过if else、Switch、函数式接口等。

拆分之后的代码如下所示：

public Long max(Collection<Long> dataSet) { //... }
public Long min(Collection<Long> dataSet) { //... } 
public Long average(Colletion<Long> dataSet) { //... }
// ...省略其他统计函数...

接口隔离原则跟单一职责原则有点类似，不过稍微还是有点区别。

单一职责原则针对的是模块、类、接口的设计。而接口隔离原则相对于单一职责原则，一方面它更侧重于接口的设计，另一方面它的思考的角度不同。它提供了一种判断接口是否职责单一的标准：通过调用者如何使用接口来间接地判定。如果调用者只使用部分接口或接口的部分功能，那接口的设计就不够职责单一。

 

3. 把“接口”理解为 OOP 中的接口概念

假设我们的项目中用到了三个外部系统：Redis、MySQL、Kafka。

每个系统都对应一系列配置信息，比如地址、端口、访问超时时间等。为了在内存中存储这些配置信息，供项目中的其他模块来使用，我们分别设计实现了三个 Configuration 类：RedisConfig、MysqlConfig、KafkaConfig。

这里给出了 RedisConfig 的代码实现，另外两个类似。

public class RedisConfig {private ConfigSource configSource; //配置中心（比如zookeeper）private String address;private int timeout;private int maxTotal;//省略其他配置: maxWaitMillis,maxIdle,minIdle...public RedisConfig(ConfigSource configSource) {this.configSource = configSource;}public String getAddress() {return this.address;}//...省略其他get()、init()方法...public void update() {//从configSource加载配置到address/timeout/maxTotal...}
}public class KafkaConfig { //...省略... }
public class MysqlConfig { //...省略... }

新需求1
支持 Redis 和 Kafka 配置信息的热更新，但并不希望对 MySQL 的配置信息进行热更新。

所谓“热更新（hot update）”就是，如果在配置中心中更改了配置信息，我们希望在不用重启系统的情况下，能将最新的配置信息加载到内存中（也就是 RedisConfig、KafkaConfig 类中）。

这里设计实现了一个 ScheduledUpdater 类，以固定时间频率（periodInSeconds）来调用 RedisConfig、KafkaConfig 的 update() 方法更新配置信息。具体的代码实现如下所示：

public interface Updater {void update();
}// mysql不想热更新，所有没有实现接口
public class RedisConfig implemets Updater {//...省略其他属性和方法...@Overridepublic void update() { //... }
}public class KafkaConfig implements Updater {//...省略其他属性和方法...@Overridepublic void update() { //... }
}public class MysqlConfig { //...省略其他属性和方法... }public class ScheduledUpdater {private final ScheduledExecutorService executor = Executors.newSingleThreadScheduledExecutor();;private long initialDelayInSeconds;private long periodInSeconds;private Updater updater;public ScheduleUpdater(Updater updater, long initialDelayInSeconds, long periodInSeconds) {this.updater = updater;this.initialDelayInSeconds = initialDelayInSeconds;this.periodInSeconds = periodInSeconds;}//开启一个线程：定时更新public void run() {executor.scheduleAtFixedRate(new Runnable() {@Overridepublic void run() {updater.update();}}, this.initialDelayInSeconds, this.periodInSeconds, TimeUnit.SECONDS);}
}public class Application {ConfigSource configSource = new ZookeeperConfigSource(/*省略参数*/);public static final RedisConfig redisConfig = new RedisConfig(configSource);public static final KafkaConfig kafkaConfig = new KakfaConfig(configSource);public static final MySqlConfig mysqlConfig = new MysqlConfig(configSource);public static void main(String[] args) {ScheduledUpdater redisConfigUpdater = new ScheduledUpdater(redisConfig, 300, 300);redisConfigUpdater.run();ScheduledUpdater kafkaConfigUpdater = new ScheduledUpdater(kafkaConfig, 60, 60);kafkaConfigUpdater.run();}
}

 
新增需求二：新增监控功能

我们可以在项目中开发一个内嵌的 SimpleHttpServer，输出项目的配置信息到一个固定的 HTTP 地址，比如：http://127.0.0.1:2389/config 。

我们只需要在浏览器中输入这个地址，就可以显示出系统的配置信息。不过，出于某些原因，我们只想暴露 MySQL 和 Redis 的配置信息，不想暴露 Kafka 的配置信息。

代码改造

public interface Updater {void update();
}//新增监控
public interface Viewer {//监控内容String outputInPlainText();Map<String, String> output();
}//三个类都实现Viewer监控接口
public class RedisConfig implemets Updater, Viewer {//...省略其他属性和方法...@Overridepublic void update() { //... }@Overridepublic String outputInPlainText() { //... }@Overridepublic Map<String, String> output() { //...}
}public class KafkaConfig implements Updater {//...省略其他属性和方法...@Overridepublic void update() { //... }
}public class MysqlConfig implements Viewer {//...省略其他属性和方法...@Overridepublic String outputInPlainText() { //... }@Overridepublic Map<String, String> output() { //...}
}public class SimpleHttpServer {private String host;private int port;private Map<String, List<Viewer>> viewers = new HashMap<>();public SimpleHttpServer(String host, int port) {//...}public void addViewers(String urlDirectory, Viewer viewer) {if (!viewers.containsKey(urlDirectory)) {viewers.put(urlDirectory, new ArrayList<Viewer>());}this.viewers.get(urlDirectory).add(viewer);}public void run() { //... }
}public class Application {ConfigSource configSource = new ZookeeperConfigSource();public static final RedisConfig redisConfig = new RedisConfig(configSource);public static final KafkaConfig kafkaConfig = new KakfaConfig(configSource);public static final MySqlConfig mysqlConfig = new MySqlConfig(configSource);public static void main(String[] args) {ScheduledUpdater redisConfigUpdater =new ScheduledUpdater(redisConfig, 300, 300);//run：更新配置redisConfigUpdater.run();ScheduledUpdater kafkaConfigUpdater =new ScheduledUpdater(kafkaConfig, 60, 60);redisConfigUpdater.run();SimpleHttpServer simpleHttpServer = new SimpleHttpServer(“127.0.0.1”, 2389);simpleHttpServer.addViewer("/config", redisConfig);simpleHttpServer.addViewer("/config", mysqlConfig);//暴露配置信息到网络simpleHttpServer.run();}
}

 

来回顾一下接口隔离原则的设计思想。

我们设计了两个功能非常单一的接口：Updater 和 Viewer。

  • ScheduledUpdater 只依赖 Updater 这个跟热更新相关的接口，不需要被强迫去依赖不需要的 Viewer 接口，满足接口隔离原则。

  • SimpleHttpServer 只依赖跟查看信息相关的 Viewer 接口，不依赖不需要的 Updater 接口，也满足接口隔离原则。

 

不按照接口隔离原则设计

设计一个大而全的 Config 接口，让 RedisConfig、KafkaConfig、MysqlConfig 都实现这个 Config 接口，并且将原来传递给 ScheduledUpdater 的 Updater 和传递给 SimpleHttpServer 的 Viewer，都替换为 Config。

public interface Config {void update();String outputInPlainText();Map<String, String> output();
}public class RedisConfig implements Config {//...需要实现Config的三个接口update/outputIn.../output
}public class KafkaConfig implements Config {//...需要实现Config的三个接口update/outputIn.../output
}public class MysqlConfig implements Config {//...需要实现Config的三个接口update/outputIn.../output
}public class ScheduledUpdater {//...省略其他属性和方法..private Config config;public ScheduleUpdater(Config config, long initialDelayInSeconds, long periodInSeconds) {this.config = config;//...}//...
}public class SimpleHttpServer {private String host;private int port;private Map<String, List<Config>> viewers = new HashMap<>();public SimpleHttpServer(String host, int port) {//...}public void addViewer(String urlDirectory, Config config) {if (!viewers.containsKey(urlDirectory)) {viewers.put(urlDirectory, new ArrayList<Config>());}viewers.get(urlDirectory).add(config);}public void run() { //... }
}

这样的设计思路也是能工作的，但是对比前后两个设计思路，在同样的代码量、实现复杂度、同等可读性的情况下，第一种设计思路显然要比第二种好很多。为什么这么说呢？主要有两点原因。

  1. 第一种设计思路更加灵活、易扩展、易复用。

因为 Updater、Viewer 职责更加单一，单一就意味了通用、复用性好。
 
比如，我们现在又有一个新的需求，开发一个 Metrics 性能统计模块，并且希望将 Metrics 也通过 SimpleHttpServer 显示在网页上，以方便查看。这个时候，尽管 Metrics 跟 RedisConfig 等没有任何关系，但我们仍然可以让 Metrics 类实现非常通用的 Viewer 接口，复用 SimpleHttpServer 的代码实现。如下：

public class ApiMetrics implements Viewer {//...}
public class DbMetrics implements Viewer {//...}public class Application {ConfigSource configSource = new ZookeeperConfigSource();public static final RedisConfig redisConfig = new RedisConfig(configSource);public static final KafkaConfig kafkaConfig = new KakfaConfig(configSource);public static final MySqlConfig mySqlConfig = new MySqlConfig(configSource);public static final ApiMetrics apiMetrics = new ApiMetrics();public static final DbMetrics dbMetrics = new DbMetrics();public static void main(String[] args) {SimpleHttpServer simpleHttpServer = new SimpleHttpServer(“127.0.0.1”, 2389);simpleHttpServer.addViewer("/config", redisConfig);simpleHttpServer.addViewer("/config", mySqlConfig);simpleHttpServer.addViewer("/metrics", apiMetrics);simpleHttpServer.addViewer("/metrics", dbMetrics);simpleHttpServer.run();}
}

 

  1. 第二种设计思路在代码实现上做了一些无用功。
  • 因为 Config 接口中包含两类不相关的接口，一类是 update()，一类是 output() 和 outputInPlainText()。
  • 理论上，KafkaConfig 只需要实现 update() 接口，并不需要实现 output() 相关的接口。同理，MysqlConfig 只需要实现 output() 相关接口，并需要实现 update() 接口。但第二种设计思路要求 RedisConfig、KafkaConfig、MySqlConfig 必须同时实现 Config 的所有接口函数（update、output、outputInPlainText）。
  • 除此之外，如果我们要往 Config 中继续添加一个新的接口，那所有的实现类都要改动。相反，如果我们的接口粒度比较小，那涉及改动的类就比较少。

 

参考：《设计模式之美》 – 王争

这篇关于【设计模式之美】 SOLID 原则之四：接口隔离原则有哪三种应用？原则中的“接口”该如何理解？的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/583747。

相关文章

中文分词jieba库的使用与实景应用（一）

中文分词jieba库的使用与实景应用（一）

知识星球：https://articles.zsxq.com/id_fxvgc803qmr2.html 目录 一.定义： 精确模式（默认模式）： 全模式： 搜索引擎模式： paddle 模式（基于深度学习的分词模式）： 二 自定义词典 三.文本解析   调整词出现的频率 四. 关键词提取 A. 基于TF-IDF算法的关键词提取 B. 基于TextRank算法的关键词提取
阅读更多...
水位雨量在线监测系统概述及应用介绍

水位雨量在线监测系统概述及应用介绍

在当今社会，随着科技的飞速发展，各种智能监测系统已成为保障公共安全、促进资源管理和环境保护的重要工具。其中，水位雨量在线监测系统作为自然灾害预警、水资源管理及水利工程运行的关键技术，其重要性不言而喻。 一、水位雨量在线监测系统的基本原理 水位雨量在线监测系统主要由数据采集单元、数据传输网络、数据处理中心及用户终端四大部分构成，形成了一个完整的闭环系统。 数据采集单元：这是系统的“眼睛”，
阅读更多...
认识、理解、分类——acm之搜索

认识、理解、分类——acm之搜索

普通搜索方法有两种：1、广度优先搜索；2、深度优先搜索； 更多搜索方法： 3、双向广度优先搜索； 4、启发式搜索（包括A*算法等）； 搜索通常会用到的知识点：状态压缩（位压缩，利用hash思想压缩）。
阅读更多...
csu 1446 Problem J Modified LCS （扩展欧几里得算法的简单应用）

csu 1446 Problem J Modified LCS （扩展欧几里得算法的简单应用）

这是一道扩展欧几里得算法的简单应用题，这题是在湖南多校训练赛中队友ac的一道题，在比赛之后请教了队友，然后自己把它a掉 这也是自己独自做扩展欧几里得算法的题目 题意：把题意转变下就变成了：求d1*x - d2*y = f2 - f1的解,很明显用exgcd来解 下面介绍一下exgcd的一些知识点：求ax + by = c的解 一、首先求ax + by = gcd(a,b)的解 这个
阅读更多...
hdu1394(线段树点更新的应用)

hdu1394(线段树点更新的应用)

题意：求一个序列经过一定的操作得到的序列的最小逆序数 这题会用到逆序数的一个性质，在0到n-1这些数字组成的乱序排列，将第一个数字A移到最后一位，得到的逆序数为res-a+(n-a-1) 知道上面的知识点后，可以用暴力来解 代码如下： #include<iostream>#include<algorithm>#include<cstring>#include<stack>#in
阅读更多...
zoj3820(树的直径的应用)

zoj3820(树的直径的应用)

题意：在一颗树上找两个点，使得所有点到选择与其更近的一个点的距离的最大值最小。 思路：如果是选择一个点的话，那么点就是直径的中点。现在考虑两个点的情况，先求树的直径，再把直径最中间的边去掉，再求剩下的两个子树中直径的中点。 代码如下： #include <stdio.h>#include <string.h>#include <algorithm>#include <map>#
阅读更多...
在JS中的设计模式的单例模式、策略模式、代理模式、原型模式浅讲

在JS中的设计模式的单例模式、策略模式、代理模式、原型模式浅讲

1. 单例模式（Singleton Pattern） 确保一个类只有一个实例，并提供一个全局访问点。 示例代码： class Singleton {constructor() {if (Singleton.instance) {return Singleton.instance;}Singleton.instance = this;this.data = [];}addData(value)
阅读更多...
【区块链 + 人才服务】可信教育区块链治理系统 | FISCO BCOS应用案例

【区块链 + 人才服务】可信教育区块链治理系统 | FISCO BCOS应用案例

伴随着区块链技术的不断完善，其在教育信息化中的应用也在持续发展。利用区块链数据共识、不可篡改的特性， 将与教育相关的数据要素在区块链上进行存证确权，在确保数据可信的前提下，促进教育的公平、透明、开放，为教育教学质量提升赋能，实现教育数据的安全共享、高等教育体系的智慧治理。 可信教育区块链治理系统的顶层治理架构由教育部、高校、企业、学生等多方角色共同参与建设、维护，支撑教育资源共享、教学质量评估、
阅读更多...
【生成模型系列（初级）】嵌入（Embedding）方程——自然语言处理的数学灵魂【通俗理解】

【生成模型系列（初级）】嵌入（Embedding）方程——自然语言处理的数学灵魂【通俗理解】

【通俗理解】嵌入（Embedding）方程——自然语言处理的数学灵魂 关键词提炼 #嵌入方程 #自然语言处理 #词向量 #机器学习 #神经网络 #向量空间模型 #Siri #Google翻译 #AlexNet 第一节：嵌入方程的类比与核心概念【尽可能通俗】 嵌入方程可以被看作是自然语言处理中的“翻译机”，它将文本中的单词或短语转换成计算机能够理解的数学形式，即向量。 正如翻译机将一种语言
阅读更多...
AI行业应用(不定期更新)

AI行业应用(不定期更新)

ChatPDF 可以让你上传一个 PDF 文件，然后针对这个 PDF 进行小结和提问。你可以把各种各样你要研究的分析报告交给它，快速获取到想要知道的信息。https://www.chatpdf.com/
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2