[发明专利]一种REST风格框架下响应的动态封装方法

说明书

技术领域

本发明涉及动态封装技术领域，尤其涉及一种REST风格框架下响应的动态封装方 法，用于按照REST风格动态构建含有不同类型属性的响应。

背景技术

在REST风格的框架下，描述一个Web服务的接口通常需要包含如下元素：

用于标识被请求资源的URL地址（URI）

请求资源的方法（HTTPMethod）

请求的参数（RequestBody）

响应的参数（Response）

其中RequestBody和Response中的参数通常以预定义的数据结构进行保存。在REST风 格的框架下，对于具有相同URI和HTTPMethod的请求，若RequestBody中的参数不同，那么 返回的Response可能具有完全不同的数据结构。若想实现在相同URI和HTTPMethod下返回 不同结构的响应，常见思路有以下三种：

1.在Response中置入一个Map，Map中包含响应中的所有信息。其优点是组装方式比较 灵活。缺点是响应结构没有直观的定义，并且使用Swagger等API生成框架生成的API中无法 正常的解析response结构。

2.在Response中置入一个bean，该bean包含所有响应中可能包含的属性。优点是 用一个bean定义了所有的响应类型，且在API生成框架中能够正常解析显示。缺点是如果响 应类型很多，那么bean中包含的属性也会非常多，不但不利于后期维护，生成的API文档也 不易阅读。

3.在Response中置入一个bean，该bean需要继承一个包含不同类型响应中都具有 的属性的公共bean，bean中只需要定义某类响应特有的属性即可。本方法作为方法2的改进 版，其优点是响应结构直观易懂，且在API生成框架中能够正常解析显示。缺点是如果响应 的种类很多，仍然需要编写大量的bean文件，增加了工作量和后期维护的难度。

发明内容

为了解决以上技术问题，本发明提出了一种REST风格框架下响应的动态封装方 法，旨在提供一种结构直观，能被API生成框架正确解析，同时不需要编写大量bean文件，而 通过动态附加属性的方式生成响应的方法。使用本发明可以有效的减少编写bean文件的工 作量，降低后期维护的难度。

本发明利用了cglib库动态生成bean的特性，对给定的公共bean进行解析，获取其 属性，并增加新的定制属性，然后重新封装成bean。新生成的bean类型与公共bean一致，且 同时具有公共bean的属性和定制属性，并且属性值也得到了保留。

本发明的技术方案：

一种REST风格框架下响应的动态封装方法，

利用cglib库可以动态生成bean的特性，将需要返回的公共bean进行解析，提取其属 性，并通过反射的方式添加定制的属性，生成新的bean，最后将属性值重新写入bean中，生 成新的bean实例，嵌入response中并返回。

利用BeanInfo和PropertyDescriptor对bean进行解析，并获取属性的名称、类型， 并通过反射机制调用bean的getter方法获取属性值。

通过反射的方式添加定制的属性，生成新的bean：利用BeanGenerator添加bean属 性，并构建新的bean对象。

将属性值重新写入bean中：利用BeanMap向bean中的属性赋值。

本发明的有益效果是：

本发明通过调用一个静态函数，即可动态的向一个给定bean中附加定制属性，而无需 编写大量的bean文件。同时新获取的bean实例类型与给定bean相同，规范性得到了保证，在 Swagger等API生成框架中也可以正确的解析，有效降低了开发难度和后期维护难度。

为REST风格框架下相同URI和HTTPMethod下需要返回不同类型响应的需求提供 了简易的响应封装方式，并且可以支持第三方API生成框架的解析。由于是直接对返回的响 应实例附加属性，所以不再需要针对不同的响应编写bean文件，大大降低了工作量和后期 维护的难度。

附图说明

图1是本发明的整体处理过程示意图。

具体实施方式

下面对本发明的内容进行更加详细的阐述：