技术设计_接口平台透传及协议转换框架

1、-接口透传及协议转换框架接口技术详细设计文档作者:创建日期:更新日期:当前版本：2018-09-132018-09-131.0文档控制更改Hand审阅职位2018-09-13V1.0新建版本日期作者版本修改目录文档控制2更改2审阅2目录3接口透传及协议转换框架4简单功能流程说明4依赖关系4配置信息4数据库设计4hitf_erface_server4hitf_erface4E-R 图4应用设计4*原型图设计4API. 5应用服务方法5类图5注意事项6开发参考6规范6未决问题8未决问题8接口透传及协议转换框架简单功能流程说明 接口透传及协议转换框架主要涵盖以下内容：1、 接口透传转发2、 协议转换

2、（Rest - Soap, Soap -Rest）依赖关系1、 说明该功能依赖的特别组件2、 说明该功能调用的其他服务的 API配置信息1、 快速编码配置：2、 编码规则配置：3、 描述配置：数据库设计表设计EXCEL 路径：hitf_erface_server表功能简介：服务配置hitf_erface表功能简介：接口列表E-R 图应用设计*原型图设计功能设计路径： SVN/HZero/30功能设计/HITF 接口/接口.rpAPI应用服务方法开发完成后，Javadoc 导出：类图开发完成后，Ide 工具导出：名称Api权限层级公共&登录请求类型描述REST 服务调用接口/v1/api/res

3、t/invokeGET/ TREST - REST SOAP - REST1、 获取请求参数并构造接口参数（涉及请 求 参 数 转 换 Mapper）2、 依据接口认证类 型，构造接口认证信息；例如，如果是 Oauth2 方式，则更新 Token 并缓存到 REDIS3、 执行请求并获取请求结果（涉及响应数据转换 Mapper）T 服务调用接口/v1/api/soap/invoke.ws dlREST - SOAP SOAP - SOAP通过 CXF 等工具动态发布标准 SOAP 接口(所有接口调用的都是相同的 WSDL)注意事项需特别：开发参考规范需要特别注意的规范：一、 发布REST 与

4、SOAP 接口参数处理/ 固定格式化 Response Result 及Request Payload: public Class ApiInfo private String apiVer; / api 版本private String apiSus; / api 状态private String apiWarnings; / api 警告信息，例如，即将过期public Class ResponseResult private String sus; private String message;private String mediaType; / 指定 payload格式，默认为：ap

5、plication/json;charset=UTF-8private String payload; / 指定 payload 实体内容private ApiInfo apiInfo; / API 信息public Class ReqeustPayload private Map headaramMap; / Reqeust Header 参数列表private Map pathVariableMap; / Path 变量列表private Map requestParamMap; / 请求查询参数列表private String mediaType; / 指定 payload格式，默认为：

6、application/json;charset=UTF-8private String payload; / 指定 payload 实体内容1、REST 接口识别如下三个 Query Param 参数及一个 Body 参数：/* 租户 ID，anizationId* 服务代码，serverCode* 接口代码， erfaceCode* 参数实体，payload* return ResponseResult 通用响应结果*/RequestMap(value = /v1/api/rest/invoke , method= RequestMethod.GET , RequestMethod.T )

7、public ResponseEntity invoke(RequestParam(value = “anizationId”, required = false) LonganizationId,RequestParam(“serverCode”) String serverCode,RequestParam(“erfaceCode”) StringerfaceCode,RequestBody(value = “payload”, required = false) RequestPaylo2、SOAP 接口同样识别相同的几个参数，只不过通过 SOAP 协议格式进行处理ayload);public ResponseResult invoke(WWW Wram(“anizationId”) LonganizationId,ram(“serverCode”) String serverCode,ram(“erfaceCode”) StringerfaceCode,ram(“payload”) RequestPayloayload);3、可以通过MapperClass 进行相应参数和响应的转化，可以传入 HttpConnection，进行个性化设置和二、 租户处理1、 服务层可以选择特定租户进行，如果不选，则默认为 0，也即时，（可选）；租户层默认与当前