目录
接口就是互相联系的双方共同遵守的一种协议规范。在我们软件系统内部,一般的接口是指通过定义一组API函数来约定软件模块之间的沟通方式。换句话说,接口具体定义软件模块对系统的其他部分提供怎样的服务,以及系统的其他部分如何访问所提供的服务。
1接口设计的基本原则
在设计软件接口时,需要遵循以下基本原则:
- 抽象性:接口设计应基于业务需求,定义清晰的业务问题域模型,并建立起问题的现实映射,以统一不同角色对API设计的认知。通过抽象设计,可以屏蔽具体的业务实现细节,提供更好的可扩展性。
- 简单性:接口设计应遵守最少的知识原则,客户端不需要知道服务的API接口细节。使用外观模式和中介者模式等设计模式,将多个服务进行业务封装与整合,提供一个简单的API调用给客户端。
- 安全性:考虑接口暴露的考虑、并发量、防攻击、跨域等问题,确保接口的安全。
- 可扩展性:在设计接口时,充分考虑接口的可扩展性,根据实际业务场景设计接口,避免不必要的复杂性和重复工作。
接口设计的具体步骤和注意事项
- 定义参数验证:定义参数验证类及抽象接口,添加参数验证