★ FEATURED ARTICLE 文章目录一. 如何理解“接口隔离原则”二. 接口隔离的三个情况1. 把“接口”理解为一组 API 接口集合2. 把“接口”理解为单个 API 接口或函数 ing能够使用的场景并未理解3. 把“接口”理解为 OOP 中的接口概念一. 如何理解“接口隔离原则”客户端不应该被强迫依赖它不需要的接口简单的理解不在原有接口的增加方法。其中的“客户端”可以理解为接口的调用者或者使用者。在这条原则中我们可以把“接口”理解为下面三种情况一组 API 接口集合单个 API 接口或函数OOP 中的接口概念接下来从这三个方面举例说明接口隔离的具体应用二. 接口隔离的三个情况1. 把“接口”理解为一组 API 接口集合微服务用户系统提供了一组跟用户相关的 API 给其他系统使用比如注册、登录、获取用户信息等。具体代码如下所示publicinterfaceUserService{booleanregister(Stringcellphone,Stringpassword);booleanlogin(Stringcellphone,Stringpassword);UserInfogetUserInfoById(longid);UserInfogetUserInfoByCellphone(Stringcellphone);}publicclassUserServiceImplimplementsUserService{//...}现在我们的后台管理系统要实现删除用户的功能希望用户系统提供一个删除用户的接口。违背接口隔离的方案只需要在 UserService 中新添加一个 deleteUserByCellphone() 或 deleteUserById() 接口就可以了。这个方法可以解决问题但是也隐藏了一些安全隐患。删除用户是一个非常慎重的操作我们只希望通过后台管理系统来执行所以这个接口只限于给后台管理系统使用。如果我们把它放到 UserService 中那所有使用到 UserService 的系统都可以调用这个接口。不加限制地被其他业务系统调用就有可能导致误删用户。当然最好的解决方案是从架构设计的层面通过接口鉴权的方式来限制接口的调用。不过如果暂时没有鉴权框架来支持我们还可以从代码设计的层面尽量避免接口被误用。参照接口隔离原则调用者不应该强迫依赖它不需要的接口那么我们将删除接口单独放到另外一个接口中然后将接口只打包即只是UserServiceImpl集成新增接口提供给后台管理系统来使用。publicinterfaceUserService{booleanregister(Stringcellphone,Stringpassword);booleanlogin(Stringcellphone,Stringpassword);UserInfogetUserInfoById(longid);UserInfogetUserInfoByCellphone(Stringcellphone);}// 接口隔离原则再新增一个接口而不是在原有的接口中进行修改publicinterfaceRestrictedUserService{booleandeleteUserByCellphone(Stringcellphone);booleandeleteUserById(longid);}publicclassUserServiceImplimplementsUserService,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 Statisticscount(CollectionLongdataSet){Statistics statisticsnewStatistics();//...省略计算逻辑...returnstatistics;}在上面的代码中count() 函数的功能不够单一:包含很多不同的统计功能 比如求最大值、最小值、平均值等等。按照接口隔离原则我们应该把 count() 函数拆成几个更小粒度的函数每个函数负责一个独立的统计功能。代码实现可能通过if else、Switch、函数式接口等。拆分之后的代码如下所示publicLongmax(CollectionLongdataSet){//... }publicLongmin(CollectionLongdataSet){//... }publicLongaverage(ColletionLongdataSet){//... }// ...省略其他统计函数...接口隔离原则跟单一职责原则有点类似不过稍微还是有点区别。单一职责原则针对的是模块、类、接口的设计。而接口隔离原则相对于单一职责原则一方面它更侧重于接口的设计另一方面它的思考的角度不同。它提供了一种判断接口是否职责单一的标准通过调用者如何使用接口来间接地判定。如果调用者只使用部分接口或接口的部分功能那接口的设计就不够职责单一。3. 把“接口”理解为 OOP 中的接口概念假设我们的项目中用到了三个外部系统Redis、MySQL、Kafka。每个系统都对应一系列配置信息比如地址、端口、访问超时时间等。为了在内存中存储这些配置信息供项目中的其他模块来使用我们分别设计实现了三个 Configuration 类RedisConfig、MysqlConfig、KafkaConfig。这里给出了 RedisConfig 的代码实现另外两个类似。publicclassRedisConfig{privateConfigSourceconfigSource;//配置中心比如zookeeperprivateStringaddress;privateinttimeout;privateintmaxTotal;//省略其他配置: maxWaitMillis,maxIdle,minIdle...publicRedisConfig(ConfigSourceconfigSource){this.configSourceconfigSource;}publicStringgetAddress(){returnthis.address;}//...省略其他get()、init()方法...publicvoidupdate(){//从configSource加载配置到address/timeout/maxTotal...}}publicclassKafkaConfig{//...省略... }publicclassMysqlConfig{//...省略... }新需求1支持 Redis 和 Kafka 配置信息的热更新但并不希望对 MySQL 的配置信息进行热更新。所谓“热更新hot update”就是如果在配置中心中更改了配置信息我们希望在不用重启系统的情况下能将最新的配置信息加载到内存中也就是 RedisConfig、KafkaConfig 类中。这里设计实现了一个 ScheduledUpdater 类以固定时间频率periodInSeconds来调用 RedisConfig、KafkaConfig 的 update() 方法更新配置信息。具体的代码实现如下所示publicinterfaceUpdater{voidupdate();}// mysql不想热更新所有没有实现接口publicclassRedisConfigimplemetsUpdater{//...省略其他属性和方法...Overridepublicvoidupdate(){//... }}publicclassKafkaConfigimplementsUpdater{//...省略其他属性和方法...Overridepublicvoidupdate(){//... }}publicclassMysqlConfig{//...省略其他属性和方法... }publicclassScheduledUpdater{privatefinalScheduledExecutorServiceexecutorExecutors.newSingleThreadScheduledExecutor();;privatelonginitialDelayInSeconds;privatelongperiodInSeconds;privateUpdaterupdater;publicScheduleUpdater(Updaterupdater,longinitialDelayInSeconds,longperiodInSeconds){this.updaterupdater;this.initialDelayInSecondsinitialDelayInSeconds;this.periodInSecondsperiodInSeconds;}//开启一个线程定时更新publicvoidrun(){executor.scheduleAtFixedRate(newRunnable(){Overridepublicvoidrun(){updater.update();}},this.initialDelayInSeconds,this.periodInSeconds,TimeUnit.SECONDS);}}publicclassApplication{ConfigSourceconfigSourcenewZookeeperConfigSource(/*省略参数*/);publicstaticfinalRedisConfigredisConfignewRedisConfig(configSource);publicstaticfinalKafkaConfigkafkaConfignewKakfaConfig(configSource);publicstaticfinalMySqlConfigmysqlConfignewMysqlConfig(configSource);publicstaticvoidmain(String[]args){ScheduledUpdaterredisConfigUpdaternewScheduledUpdater(redisConfig,300,300);redisConfigUpdater.run();ScheduledUpdaterkafkaConfigUpdaternewScheduledUpdater(kafkaConfig,60,60);kafkaConfigUpdater.run();}}新增需求二新增监控功能我们可以在项目中开发一个内嵌的 SimpleHttpServer输出项目的配置信息到一个固定的 HTTP 地址比如http://127.0.0.1:2389/config 。我们只需要在浏览器中输入这个地址就可以显示出系统的配置信息。不过出于某些原因我们只想暴露 MySQL 和 Redis 的配置信息不想暴露 Kafka 的配置信息。代码改造publicinterfaceUpdater{voidupdate();}//新增监控publicinterfaceViewer{//监控内容StringoutputInPlainText();MapString,Stringoutput();}//三个类都实现Viewer监控接口publicclassRedisConfigimplemetsUpdater,Viewer{//...省略其他属性和方法...Overridepublicvoidupdate(){//... }OverridepublicStringoutputInPlainText(){//... }OverridepublicMapString,Stringoutput(){//...}}publicclassKafkaConfigimplementsUpdater{//...省略其他属性和方法...Overridepublicvoidupdate(){//... }}publicclassMysqlConfigimplementsViewer{//...省略其他属性和方法...OverridepublicStringoutputInPlainText(){//... }OverridepublicMapString,Stringoutput(){//...}}publicclassSimpleHttpServer{privateStringhost;privateintport;privateMapString,ListViewerviewersnewHashMap();publicSimpleHttpServer(Stringhost,intport){//...}publicvoidaddViewers(StringurlDirectory,Viewerviewer){if(!viewers.containsKey(urlDirectory)){viewers.put(urlDirectory,newArrayListViewer());}this.viewers.get(urlDirectory).add(viewer);}publicvoidrun(){//... }}publicclassApplication{ConfigSourceconfigSourcenewZookeeperConfigSource();publicstaticfinalRedisConfigredisConfignewRedisConfig(configSource);publicstaticfinalKafkaConfigkafkaConfignewKakfaConfig(configSource);publicstaticfinalMySqlConfigmysqlConfignewMySqlConfig(configSource);publicstaticvoidmain(String[]args){ScheduledUpdaterredisConfigUpdaternewScheduledUpdater(redisConfig,300,300);//run更新配置redisConfigUpdater.run();ScheduledUpdaterkafkaConfigUpdaternewScheduledUpdater(kafkaConfig,60,60);redisConfigUpdater.run();SimpleHttpServersimpleHttpServernewSimpleHttpServer(“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。publicinterfaceConfig{voidupdate();StringoutputInPlainText();MapString,Stringoutput();}publicclassRedisConfigimplementsConfig{//...需要实现Config的三个接口update/outputIn.../output}publicclassKafkaConfigimplementsConfig{//...需要实现Config的三个接口update/outputIn.../output}publicclassMysqlConfigimplementsConfig{//...需要实现Config的三个接口update/outputIn.../output}publicclassScheduledUpdater{//...省略其他属性和方法..privateConfigconfig;publicScheduleUpdater(Configconfig,longinitialDelayInSeconds,longperiodInSeconds){this.configconfig;//...}//...}publicclassSimpleHttpServer{privateStringhost;privateintport;privateMapString,ListConfigviewersnewHashMap();publicSimpleHttpServer(Stringhost,intport){//...}publicvoidaddViewer(StringurlDirectory,Configconfig){if(!viewers.containsKey(urlDirectory)){viewers.put(urlDirectory,newArrayListConfig());}viewers.get(urlDirectory).add(config);}publicvoidrun(){//... }}这样的设计思路也是能工作的但是对比前后两个设计思路在同样的代码量、实现复杂度、同等可读性的情况下第一种设计思路显然要比第二种好很多。为什么这么说呢主要有两点原因。第一种设计思路更加灵活、易扩展、易复用。因为 Updater、Viewer 职责更加单一单一就意味了通用、复用性好。比如我们现在又有一个新的需求开发一个 Metrics 性能统计模块并且希望将 Metrics 也通过 SimpleHttpServer 显示在网页上以方便查看。这个时候尽管 Metrics 跟 RedisConfig 等没有任何关系但我们仍然可以让 Metrics 类实现非常通用的 Viewer 接口复用 SimpleHttpServer 的代码实现。如下publicclassApiMetricsimplementsViewer{//...}publicclassDbMetricsimplementsViewer{//...}publicclassApplication{ConfigSourceconfigSourcenewZookeeperConfigSource();publicstaticfinalRedisConfigredisConfignewRedisConfig(configSource);publicstaticfinalKafkaConfigkafkaConfignewKakfaConfig(configSource);publicstaticfinalMySqlConfigmySqlConfignewMySqlConfig(configSource);publicstaticfinalApiMetricsapiMetricsnewApiMetrics();publicstaticfinalDbMetricsdbMetricsnewDbMetrics();publicstaticvoidmain(String[]args){SimpleHttpServersimpleHttpServernewSimpleHttpServer(“127.0.0.1”,2389);simpleHttpServer.addViewer(/config,redisConfig);simpleHttpServer.addViewer(/config,mySqlConfig);simpleHttpServer.addViewer(/metrics,apiMetrics);simpleHttpServer.addViewer(/metrics,dbMetrics);simpleHttpServer.run();}}第二种设计思路在代码实现上做了一些无用功。因为 Config 接口中包含两类不相关的接口一类是 update()一类是 output() 和 outputInPlainText()。理论上KafkaConfig 只需要实现 update() 接口并不需要实现 output() 相关的接口。同理MysqlConfig 只需要实现 output() 相关接口并需要实现 update() 接口。但第二种设计思路要求 RedisConfig、KafkaConfig、MySqlConfig 必须同时实现 Config 的所有接口函数update、output、outputInPlainText。除此之外如果我们要往 Config 中继续添加一个新的接口那所有的实现类都要改动。相反如果我们的接口粒度比较小那涉及改动的类就比较少。参考《设计模式之美》 – 王争
阅读完成 · 觉得有帮助？
