服务总线接口规范分析.doc

安徽电信服务总线接口规范 安徽电信有限公司 2014年02月 服务总线接口规范 安徽电信服务总线 第 PAGE 2页，共 NUMPAGES 24页 版本记录 版本号 时间 记录人 变更原因 变更描述 V0.1 2014-1-5 李超 初始 V0.2 2014-2-22 李超 修订 增加接口参数描述  TOC \o 1-3 \h \z \u 第1章 概述 5 1.1 概述 5 1.2 目标 5 1.3 规范使用对象及说明 5 1.4 名词解释 6 第2章 服务设计原则 6 2.1 接口协议统一原则 6 2.2 数据格式统一原则 7 2.3 服务定义唯一性原则 7 2.4 服务无状态原则 7 2.5 服务部署原则 8 2.6 服务组合原则 8 2.7 报文内容处理的原则 8 2.8 出入参设计原则 9 2.9 规则校验的原则 9 2.10 数据量原则 9 2.11 同步调用原则 10 2.12 统一入口原则 10 2.13 持久化原则 10 第3章 服务接入规范 10 3.1 调用方式 11 3.2 参数说明 12 3.2.1 系统级参数 12 3.3 返回业务功能 14 第4章 安全控制 14 4.1 访问鉴权 15 4.2 传输加密 16 第5章 异常分类编码 16 第6章 服务注册、注销、变更、调用流程 17 6.1 服务注册的流程 17 6.2 服务注册的内容 18 6.3 测试环境服务注册的流程 19 第7章 服务治理 19 7.1 目标 19 7.2 检查方法 20 7.3 服务监控的指标 21 7.4 服务目录树 22 概述 概述 本规范明确了安徽电信服务总线接入及服务使用的标准和规范，为服务使用方和服务提供方提供开发参考。 目标 本规范为了指导各业务系统与服务总线平台的对接，实现以下目标： 当服务总线接入业务系统服务时，为该服务提供方提供开发依据。 当服务使用方调用服务总线提供的服务时，为该服务使用方提供开发依据。 为服务使用过程中安全及控制提供标准和参考。 规范使用对象及说明 本规范适用于所有新建或改造的服务接口，均需要遵守本规范约定。 名词解释 服务提供方：提供原始服务，并将服务发布到服务总线的内部业务系统、第三方企业或个人。 服务使用方：使用服务总线上的服务进行应用开发的内部应用系统、第三方企业或个人。 服务商：平台为统一管理服务的提供方和使用方，综合其统称为服务商。 服务：服务是执行可重复任务的可发现资源，由外部化的服务规范进行描述。服务可分为技术服务和业务服务两种。 服务设计原则 由于各个系统和平台之间存在差异性，为确保安徽电信服务总线的稳定高效，服务设计原则如下： 接口协议统一原则 所有服务的接口均基于Http协议。服务提供方和服务使用方必须同时使用同一种类型的技术来进行开发和调用，调用的服务通过HTTP URL中特定属性进行标识，具体见接口协议。 数据格式统一原则 服务的接口数据包含业务所有的业务数据，数据采用JSON格式表示，并且符合相应的JSON Schema。服务提供方和服务消费方必须同时使用同一种格式进行数据交互。 服务定义唯一性原则 一个服务应该只实现一个业务功能，业务功能的区别通过服务编码来区分，不应通过定义不同的业务数据在同一个服务编码下实现不同的业务功能。 服务无状态原则 服务应是无状态的，两次请求之间无须状态和会话的保持，并可以采用轮询的方式在负载均衡器上进行注册 服务部署原则 服务应是全局的，不应区分本地网、大区等，但可以部署多份用以提供不同优先级的服务。 服务组合原则 服务按照服务粒度设计成原子服务和组合服务。原子服务为最细粒度的服务，组合服务由原子服务组合而成。为有效提高组合服务的效率，跨系统的组合服务由服务总线调用不同的原子服务实现组合，系统内的组合服务由服务提供方在应用内部进行组合。 报文内容处理的原则 服务请求和返回的的报文应符合JSON Schema格式。服务请求方和提供方应采用通用的JSON解析器来构造和解析数据，JSON不同含义的段落应定义明确含义的字段名称，相同内容的数据应采用数组来进行描述，双方可根据JSON名称和路径进行精确定位，不应根据字段的顺序来获取字段值，字段值不受字段顺序调整的影响。报文统一采用UTF-8进行编码。 出入参设计