一种基于XML模板配置的接口服务请求方法、系统及设备与流程
本发明涉及信息，提供了一种基于xml模板配置的接口服务请求方法、系统及设备。
背景技术：
1、在当前互联网日新月异的背景下，软件系统的快速更新迭代已成为业界的普遍趋势。这一现象主要受到以下几个方面的影响：
2、1、用户需求的不断变化：互联网用户的需求日益多样化和变化迅速，这要求软件系统能够快速适应市场的变化。为了保持竞争力，软件开发者必须及时了解用户反馈，根据市场需求进行迭代更新，确保软件系统能够满足用户的期望。
3、2、敏捷开发和devops文化的兴起：敏捷开发和devops的理念强调快速响应变化、持续交付和持续集成。这种文化的推动下，软件开发团队更加注重快速迭代、及时交付和团队协作，以缩短开发周期，提高软件质量。
4、3、竞争压力和市场需求：在激烈的市场竞争中，软件公司需要不断提升其产品的竞争力。快速更新迭代成为了保持市场份额和吸引用户的一种有效手段。这种竞争压力促使开发者保持高度敏感，随时准备推出新功能或修复问题。
5、在此背景下，需要软件系统及时的响应业务需求，应对业务变化，更加便捷快速的完成开发任务，交付业务功能。
技术实现思路
1、本发明的目的在于解决传统接口代码编写量大，同类型接口代码重复，完成所需时间长的问题。
2、为解决以上技术问题，本发明采用以下技术手段：根据本发明的第一方面，提供了一种基于xml模板配置的接口服务请求方法，包括以下步骤：
3、步骤1：根据需求设计接口文档，根据接口设计文档定义接口报文对应实体类；
4、步骤2：根据接口设计文档和实体类定义接口输入和输出的报文xml模板；
5、步骤3：根据接口需要编写业务逻辑处理类service；
6、步骤4：根据接口逻辑执行顺序定义对应的报文交易xml配置。
7、上述技术方案中，所述根据接口设计文档定义接口报文对应实体类包括以下步骤：
8、步骤1.1：根据接口交易输入和输出要求编写对应的实体bean；
9、步骤1.2：实体bean中对应字段属性通过相应注解加以配置说明。
10、上述技术方案中，所述实体bean中对应字段属性通过以下注解加以配置说明：
11、@entity：用于实体配置，属性code用于表示实体对应的数据库表名；属性name用于表示实体对应的中文名称；属性description用于表示实体对应的中文说明；
12、@field：用于实体中字段配置，属性code用于表示实体字段对应的数据库字段代码；属性name用于表示字段的中文名称；属性datatype用于表示字段对应的数据类型，包含data_type_string、data_type_date、data_type_datetime、data_type_double、data_type_int、data_type_bigdecimal，缺省时默认值为data_type_string；属性length用于限制字段的长度；属性defaultvalue用于设置字段的默认值；属性description用于描述字段含义。
13、上述技术方案中，所述根据接口设计文档和实体类定义接口输入和输出的报文xml模板包括以下步骤：
14、步骤2.1：根据服务方要求定义输入输出报文模板请求头；
15、步骤2.2：根据具体接口要求，定义输入输出报文模板的请求体。
16、上述技术方案中，所述请求头包含的标签和属性如下：
17、<service>：根节点标签，其下包含不同类别节点，用于传输不用类型别信息；
18、<sys-header>：报文系统头节点标签，用于识别接口类型、接口用途、接口请求方信息等，使用<data>标签来传输具体的字段信息，使用tran_code字段标示具体接口交易码，使用seq_no字段传输具体的交易流水号，使用source_type字段传输具体的请求渠道等等，根据接口具体要求灵活配置；
19、<app-header>：报文程序头节点标签，属性为数据分页字段，用于数据分页，根据接口需要配置具体的分页参数；
20、<local-head>：报文本地头节点标签，属性为本地系统属性，为缺省字段，根据需要自定义添加；
21、<struct>：数据对象标签，属性为节点实体类对象，类型为自定义实体对象类型，将对应节点属性与具体的实体bean对象关联，也与数组对象<array>互相嵌套使用；
22、<array>:数组节点标签，属性为根节点实体内数组对象，类型为list，与数据对象<struct>互相嵌套使用；
23、<data>：数据属性标签，属性为实体对象内基础属性字段，用于传输具体的字段属性，name属性表示具体的字段名称，其下包含<field>子标签进行使用；
24、<field>：字段属性标签，用于描述和限制具体字段的属性，具体属性如下：
25、length：表示具体字段的长度，也对报文中上送的字段长度进行校验；
26、type：表示具体字段的类型，用于限制具体字段上送的数据类型；
27、scale：表示数据精度，当type属性为数字类型时，用于限制数据精度；
28、上述技术方案中，所述请求体包含标签属性如下：
29、<body>：报文体最外层节点，包含<data>标签用于传输具体字段值；
30、<struct>：数据对象标签，属性为节点实体类对象，类型为自定义实体对象类型，将对应节点属性与具体的实体bean对象关联，也与数组对象<array>互相嵌套使用；
31、<array>:数组节点标签，属性为根节点实体内数组对象，类型为list，与数据对象<struct>互相嵌套使用；
32、<data>：数据属性标签，属性为实体对象内基础属性字段，用于传输具体的字段属性，name属性表示具体的字段名称，其下包含<field>子标签进行使用；
33、<field>：字段属性标签，用于描述和限制具体字段的属性，具体属性如下：
34、length：表示具体字段的长度，也对报文中上送的字段长度进行校验；
35、type：表示具体字段的类型，用于限制具体字段上送的数据类型；
36、scale：表示数据精度，当type属性为数字类型时，用于限制数据精度。
37、上述技术方案中，所述根据接口需要编写业务逻辑处理类service包括以下步骤：
38、步骤3.1：如果接口为透传到下一系统，根据下一系统的请求调用方式编写统一的remoreservice处理类，所有到发送到同一系统的请求均使用这一remoreservice处理类进行远程调用；
39、步骤3.2：如果对接接口有特殊逻辑需要处理根据业务需要编写对应的业务service类和具体的业务执行方法method；
40、步骤3.3：根据业务处理类是否需要进行事务管理添加对应注解，默认不添加注解为开启事务管理，如果不需要进行事务处理在对应业务service类的具体方法method上添加如下注解：
41、@transactional(propagation＝propagation.not_supported)。
42、上述技术方案中，所述根据接口逻辑执行顺序定义对应的报文交易xml配置包括以下步骤：
43、步骤4.1：配置接口请求交易xml配置文件，交易配置文件可以有多个，可按交易分类创建文件，每个交易分类建立一个独立的配置文件，一个配置文件中包含同类别的多个交易请求，配置文件名称定义为trans-*.xml；
44、步骤4.2：如果在交易中存在调用其他三方系统接口时，根据调用的先后顺序使用<preexecute>、<execute>或<afterexecute>的扩展属性配置调用三方系统的参数信息，包括以下扩展属性：
45、servicesysid：三方系统在服务总线系统内的系统渠道标识码，通过此渠道码通过服务总线将请求发送到三方系统；
46、messagetype：三方系统的接口类型编码，用于标识三方系统接口在服务总系统内注册的接口类型；
47、messagecode：三方系统接口码，用于标识三方系统接口在服务总线系统内注册的接口码，以此定位到需要调用的具体接口；
48、sysninoxm：调用三方接口的输入参数xml模板，配置方式同步骤2中的输入参数xml模板；
49、sysnoutoxm：调用三方接口的输出参数模板，配置方式同步骤2中的输出参数xml模板。
50、根据本发明的第二方面，提供了一种基于xml模板配置的接口服务请求系统，包括：
51、第一设计模块，用于根据需求设计接口文档，并根据接口设计文档定义接口报文对应实体类；
52、第二设计模块，用于根据接口设计文档和实体类定义接口输入和输出的报文xml模板；
53、第三设计模块，用于根据接口需要编写业务逻辑处理类service；
54、第四设计模块，用于根据接口逻辑执行顺序定义对应的报文交易xml配置。
55、根据本发明的第三方面，提供了一种电子设备，包括存储器、处理器及存储在所述存储器上并可在所述处理器上运行的计算机程序，其特征在于，所述处理器执行所述程序时实现上述所述的一种基于xml模板配置的接口服务请求方法的步骤。
56、因为采用上述技术手段，因此本发明具备以下有益效果：
57、1、可读性强：xml是一种人类可读的标记语言，其结构清晰，易于理解。通过使用xml进行接口配置，开发人员和系统管理员可以轻松地查看和理解配置文件，而无需阅读复杂的代码或二进制文件；
58、2、灵活性好：xml的结构允许定义复杂的数据模型，从而提供了灵活性。开发人员可以轻松地扩展和修改配置，以适应系统需求的变化，而无需修改代码。这种灵活性对于应对不断变化的业务需求和环境变化非常有益；
59、3、易于维护：由于xml配置文件是文本文件，因此可以使用任何文本编辑器进行编辑。这使得维护配置变得简单，开发人员和管理员可以使用他们熟悉的工具进行修改和更新；
60、4、标准化：xml是一种通用的标准，广泛应用于各种领域。采用xml作为接口配置的标准，有助于确保系统的可操作性和可维护性。
61、5、支持复杂结构：xml支持层次结构和嵌套元素，因此可以轻松地表示和处理复杂的配置信息。这对于描述包含多层次关系或有层次结构的配置非常有用。
62、总体而言，使用xml进行后台接口配置可以提供可读性、灵活性、跨平台性、易维护性等多个优势，使得系统更易于开发、部署和维护。
- 还没有人留言评论。精彩留言会获得点赞！