使用自定义HttpMessageConverter对返回内容进行加密
目录
如何在Spring MVC中统一对返回的Json进行加密大部分人的第一反应是通过Spring拦截器(Interceptor)中的postHandler方法处理。实际这是行不通的,因为当程序运行到该方法,是在返回数据之后,渲染页面之前,所以这时候Response中的输出流已经关闭了,自然无法在对返回数据进行处理。
其实这个问题用几行代码就可以搞定,因为Spring提供了非常丰富的扩展支持,无论是之前提到的Interceptor和MethodArgumentResolver,还是接下来要提到的HttpMessageConverter。
在Spring MVC的 Controller层经常会用到@RequestBody和@ResponseBody,通过这两个注解,可以在Controller中直接使用Java对象作为请求参数和返回内容,而完成这之间转换作用的便是HttpMessageConverter。
HttpMessageConverter接口提供了5个方法:
其中read和write方法的参数分别有有HttpInputMessage和HttpOutputMessage对象,这两个对象分别代表着一次Http通讯中的请求和响应部分,可以通过getBody方法获得对应的输入流和输出流。
这里通过实现该接口自定义一个Json转换器作为示例:
class CustomJsonHttpMessageConverter implements HttpMessageConverter { ObjectMapper supportedMediaTypes MediaType. /** * 判断转换器是否可以将输入内容转换成Java类型 * @param clazz 需要转换的Java类型 * @param mediaType 该请求的MediaType * @return */ @Override clazz, MediaType mediaTypemediaType MediaType supportedMediaType supportedMediaType. /** * 判断转换器是否可以将Java类型转换成指定输出内容 * @param clazz 需要转换的Java类型 * @param mediaType 该请求的MediaType * @return */ @Override clazz, MediaType mediaTypemediaType MediaType.MediaType supportedMediaType supportedMediaType. /** * 获得该转换器支持的MediaType * @return */ @Override supportedMediaTypes; } /** * 读取请求内容,将其中的Json转换成Java对象 * @param clazz 需要转换的Java类型 * @param inputMessage 请求对象 * @return * @throws IOException * @throws HttpMessageNotReadableException */ @Override clazz, HttpInputMessage inputMessage, HttpMessageNotReadableException inputMessage., clazz /** * 将Java对象转换成Json返回内容 * @param o 需要转换的对象 * @param contentType 返回类型 * @param outputMessage 回执对象 * @throws IOException * @throws HttpMessageNotWritableException */ @Override o, MediaType contentType, HttpOutputMessage outputMessage, HttpMessageNotWritableException { mapper., o
Spring中已经默认提供了相当多的转换器名称 作用 读支持MediaType 写支持MediaType
ByteArrayHttpMessageConverter 数据与字节数组的相互转换 */* application/octet-stream
StringHttpMessageConverter 数据与String类型的相互转换 text/* text/plain
FormHttpMessageConverter 表单与MultiValueMap的相互转换 application/x-www-form-urlencoded application/x-www-form-urlencoded
SourceHttpMessageConverter 数据与javax.xml.transform.Source的相互转换 text/xml和application/xml text/xml和application/xml
MarshallingHttpMessageConverter 使用Spring的Marshaller/Unmarshaller转换XML数据 text/xml和application/xml text/xml和application/xml
MappingJackson2HttpMessageConverter 使用Jackson的ObjectMapper转换Json数据 application/json application/json
MappingJackson2XmlHttpMessageConverter 使用Jackson的XmlMapper转换XML数据 application/xml application/xml
BufferedImageHttpMessageConverter 数据与java.awt.image.BufferedImage的相互转换 Java I/O API支持的所有类型 Java I/O API支持的所有类型
HttpMessageConverter是对http的request和response进行自动转换
配置HttpMessageConverter可重载下面两个方法任意一个
configureMessageConverters:重载会覆盖掉spring mvc默认注册的多个HttpMessageConverter
extendMessageConverters:仅添加一个自定义的HttpMessageConverter,不覆盖默认注册的HttpMessageConverter
通过对上面的讲述,我们一般是重载extendMessageConverters方法;
如何在Spring MVC中统一对返回的Json进行加密?既然要对返回的Json内容进行加密,肯定是对MappingJackson2HttpMessageConverter进行改造,并且只需要重写write方法。
从MappingJackson2HttpMessageConverter的父类AbstractHttpMessageConverter中的write方法可以看出,该方法通过writeInternal方法向返回结果的输出流中写入数据,所以只需要重写该方法即可:
@Bean MappingJackson2HttpMessageConverter@Override object, HttpOutputMessage outputMessage, HttpMessageNotWritableException { //使用Jackson的ObjectMapper将Java对象转换成Json String ObjectMapper mapper json LOGGER.result LOGGER.outputMessage..
在这之后还需要将这个自定义的转换器配置到Spring中,这里通过重写WebMvcConfigurer中的configureMessageConverters方法添加自定义转换器:
@Configuration public class ResponseInfoConfig extends WebMvcConfigurerAdapter { @Bean MappingJackson2HttpMessageConverter@Override object, HttpOutputMessage outputMessage, HttpMessageNotWritableException { //使用Jackson的ObjectMapper将Java对象转换成Json String ObjectMapper mapper json LOGGER.result LOGGER.outputMessage..extendMessageConverters(List<HttpMessageConverter<?>> converters) { converters.ResposeInfoHttpMessageConverterconverters..
自定义feign的消息编码解码器不要在如下代码中getObject方法内new 对象,外部会频繁调用getObject方法。