mirror of
https://github.com/NohamR/knowledge-kit.git
synced 2026-05-25 12:27:15 +00:00
59 lines
4.1 KiB
Markdown
59 lines
4.1 KiB
Markdown
# SOLID之接口隔离原则
|
||
|
||
## 定义
|
||
接口隔离原则“Interface Segregation Principle”，ISP。Robert Martin 在 SOLID 原则中是这样定义它的：“Clients should not be forced to depend upon interfaces that they do not use。”直译成中文的话就是：客户端不应该强迫依赖它不需要的接口。其中的“客户端”，可以理解为接口的调用者或者使用者。
|
||
|
||
微服务用户系统提供了一组跟用户相关的 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 中添加一个 deleteUserByPhone 就可以。但存在一个安全隐患。
|
||
|
||
删除用户是一个非常慎重的操作，我们只希望通过后台管理系统来执行，所以这个接口只限于给后台管理系统使用。如果我们把它放到 UserService 中，那所有使用到 UserService 的系统，都可以调用这个接口。不加限制地被其他业务系统调用，就有可能导致误删用户。
|
||
|
||
当然，最好的解决方案是从架构设计的层面，通过接口鉴权的方式来限制接口的调用。不过，如果暂时没有鉴权框架来支持，我们还可以从代码设计的层面，尽量避免接口被误用。
|
||
|
||
我们参照接口隔离原则，调用者不应该强迫依赖它不需要的接口，将删除接口单独放到另外一个接口 RestrictedUserService 中，然后将 RestrictedUserService 只打包提供给后台管
|
||
理系统来使用。具体的代码实现如下所示：
|
||
```
|
||
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 {
|
||
// ... 省略实现代码...
|
||
}
|
||
```
|
||
|
||
在刚刚的这个例子中，我们把接口隔离原则中的接口，理解为一组接口集合，它可以是某个微服务的接口，也可以是某个类库的接口等等。在设计微服务或者类库接口的时候，如果部分接口只被部分调用者使用，那我们就需要将这部分接口隔离出来，单独给对应的调用者使用，而不是强迫其他调用者也依赖这部分不会被用到的接口。
|
||
|
||
## 理解
|
||
如何理解“接口隔离原则”？
|
||
|
||
如果把“接口”理解为一组接口集合，可以是某个微服务的接口，也可以是某个类库的接口等。如果部分接口只被部分调用者使用，我们就需要将这部分接口隔离出来，单独给这部分调用者使用，而不强迫其他调用者也依赖这部分不会被用到的接口。
|
||
|
||
如果把“接口”理解为单个 API 接口或函数，部分调用者只需要函数中的部分功能，那我们就需要把函数拆分成粒度更细的多个函数，让调用者只依赖它需要的那个细粒度函数。
|
||
|
||
如果把“接口”理解为 OOP 中的接口，也可以理解为面向对象编程语言中的接口语法。那接口的设计要尽量单一，不要让接口的实现类和调用者，依赖不需要的接口函数。
|
||
|
||
接口隔离原则与单一职责原则的区别？
|
||
|
||
单一职责原则针对的是模块、类、接口的设计。接口隔离原则相对于单一职责原则，一方面更侧重于接口的设计，另一方面它的思考角度也是不同的。接口隔离原则提供了一种判断接口的职责是否单一的标准：通过调用者如何使用接口来间接地判定。如果调用者只使用部分接口或接口的部分功能，那接口的设计就不够职责单一。
|
||
|