通用接口标准规范v1.doc

word
word
1 / 16
word
接口标准规
NO.
修改后
版本号
修改的
页码及条款
修改类型、原因及说明
修改人
修改时间
1
全文
创建
2019/1/1
目录
然后把加密结果和传过来的_sign比较，相同则执行调用请求。
如果服务器和客户端的时间没有同步，可以返回错误的同时候在返回一个服务器的当前时间，客户端接收到该错误后再请求上一个接口，时间则传服务器刚刚返回的时间。
涉及到比较重要的信息，可以用AES对value进行加密，防止抓包拉取到上传的数据。
支持高并发
根据实际情况选择合适的方式方法来实现，可动态通过集群节点进行扩展。
例如：Java的并发包提供了三个常用的并发队列实现，分别是：ArrayBlockingQueue、ConcurrentLinkedQueue 和 LinkedBlockingQueue
可监控
日志全覆盖
正常运行信息
异常捕获信息
日志打印规
满足运维需求、日志格式统一规。
系统资源的动态扩展
保证在充分利用系统资源的前提下，实现系统平滑的移植和扩展，同时在系统并发增加时提供系统资源的动态扩展，以保证系统的稳定性。
word
word
7 / 16
word
异常处理机制
表单验证、唯一性检查、或其他可预期的错误。我们需要编写特定代码来捕获这类错误，并抛出一个包含提示信息的全局异常，捕获并返回给客户端。
业务扩展
在进行新业务扩展时，应能提供快速、方便和准确的实现方式。
接口通讯方式
同步请求/应答方式
客户端向服务器端发送服务请求，客户端阻塞等待服务器端返回处理结果。
异步请求/应答方式
客户端向服务器端发送服务请求，与同步方式不同的是，在此方式下，服务器端处理请求时，客户端继续运行；当服务器端处理结束时返回处理结果。
会话方式
客户端与服务器端建立连接后，可以多次发送或接收数据，同时存储信息的上下文关系
广播通知方式
由服务器端主动向客户端以单个或批量方式发出未经客户端请求的广播或通知消息，客户端可在适当的时候检查是否收到消息并定义收到消息后所采取的动作
事件订阅方式
客户端可事先向服务器端订阅自定义的事件，当这些事件发生时，服务器端通知客户端事件发生，客户端可采取相应处理。事件订阅方式使客户端拥有了个性化的事件触发功能，极大方便了客户端及时响应所订阅的事件
文件传输
客户端和服务器端通过文件的方式来传输消息，并采取相应处理
可靠消息传输
word
word
8 / 16
word
在接口通讯中，基于消息的传输处理方式，除了可采用以上几种通讯方式外，还可采用可靠消息传输方式，即通过存储队列方式，客户端和服务器端来传输消息，采取相应处理
传输控制要求
传输控制利用高速数据通道技术实现把前端的大数据量并发请求分发到后端，从而保证应用系统在大量客户端同时请求服务时，能够保持快速、稳定的工作状态。
系统应采用传输控制手段降低接口网络负担，提高接口吞吐能力，保证系统的整体处理能力。具体手段包括负载均衡、伸缩性与动态配置管理、网络调度等功能：
负载均衡
有必要时为了确保接口服务吞吐量最大，接口应自动地在系统中完成动态负载均衡调度。
伸缩性与动态配置管理
由系统自动伸缩管理方式或动态配置管理方式实现队列管理、存取资源管理，以及接口应用的恢复处理等。
网络调度
当对接口有较高通讯保障要求时可能会在在双方接口之间设置多个网络通道，需要实现接口的多数据通道和容错性，保证当有一网络通道通讯失败时，进行自动的切换，实现接口连接的自动恢复。
接口设计原则
充分理由
不是随便一个功能、需求就要加个接口。每新建一个接口，就要有充分的理由和考虑，即这个接口的存在是十分有意义额价值的，无意义的接口不仅增加了维护的难度，更重要是对于程序的可控性的大大降低，接口也会十分臃肿。
word
word
9 / 16
word
单一职责
一个接口只负责一个业务功能。
高聚低耦合
一个接口要包含完整的业务功能，而不同接口之间的业务关联要尽可能的小。还是查询会员的例子，有时查询会员的同时，可能该会员的相关信息要随之发生变化(如状态)，如果这时一条完整的业务流水线，那么就应该在一个接口里完成，而不应再单独设立接口去操作完成。就是说一个接口不应该随着另一个变化而变化或以某几个接口为前提而存在。
状态及消息
提供必要的接口调用状态信息。调用是否成功?如果失败，那么失败的原因是什么。这些必要的信息必须要告诉给客户端。提供必要的接口调用状态信息。调用是否成功?如果失败，那么失败的原因是什么。这些必要的信息必须要告诉给客户端。