使用自定义HttpMessageConverter对返回内容进行加密

“如何在 Spring MVC 中统一对返回的 Json 进行加密?”。

大部分人的第一反应是通过 Spring 拦截器(Interceptor)中的postHandler方法处理。实际这是行不通的,因为当程序运行到该方法,是在返回数据之后(controller执行之后),渲染页面之前,所以这时候 Response 中的对返回数据的输出已经完成了,自然无法在对返回数据进行处理。

其实这个问题用几行代码就可以搞定,因为 Spring 提供了非常丰富的扩展支持,无论是之前提到的Interceptor和MethodArgumentResolver,还是接下来要提到的HttpMessageConverter。

在 Spring MVC 的 Controller 层经常会用到@RequestBody和@ResponseBody,通过这两个注解,可以在 Controller 中直接使用 Java 对象作为请求参数和返回内容,而完成这之间转换作用的便是HttpMessageConverter。

HttpMessageConverter接口提供了 5 个方法:

  • canRead
    :判断该转换器是否能将请求内容转换成 Java 对象
  • canWrite
    :判断该转换器是否可以将 Java 对象转换成返回内容
  • getSupportedMediaTypes
    :获得该转换器支持的 MediaType 类型
  • read
    :读取请求内容并转换成 Java 对象
  • write
    :将 Java 对象转换后写入返回内容

其中read和write方法的参数分别有有HttpInputMessage和HttpOutputMessage对象,这两个对象分别代表着一次 Http 通讯中的请求和响应部分,可以通过getBody方法获得对应的输入流和输出流。
这里通过实现该接口自定义一个 Json 转换器作为示例:

class CustomJsonHttpMessageConverter implements HttpMessageConverter {

    //Jackson 的 Json 映射类
    private ObjectMapper mapper = new ObjectMapper ();

    // 该转换器的支持类型:application/json
    private List supportedMediaTypes = Arrays.asList (MediaType.APPLICATION_JSON);

    /**
    * 判断转换器是否可以将输入内容转换成 Java 类型
    * @param clazz 需要转换的 Java 类型
    * @param mediaType 该请求的 MediaType
    * @return
    */
    @Override
    public boolean canRead (Class clazz, MediaType mediaType) {
        if (mediaType == null) {
            return true;
        }
        for (MediaType supportedMediaType : getSupportedMediaTypes ()) {
            if (supportedMediaType.includes (mediaType)) {
                return true;
            }
        }
        return false;
    }

    /**
    * 判断转换器是否可以将 Java 类型转换成指定输出内容
    * @param clazz 需要转换的 Java 类型
    * @param mediaType 该请求的 MediaType
    * @return
    */
    @Override
    public boolean canWrite (Class clazz, MediaType mediaType) {
        if (mediaType == null || MediaType.ALL.equals (mediaType)) {
            return true;
        }
        for (MediaType supportedMediaType : getSupportedMediaTypes ()) {
            if (supportedMediaType.includes (mediaType)) {
                return true;
            }
        }
        return false;
    }

    /**
    * 获得该转换器支持的 MediaType
    * @return
    */
    @Override
    public List getSupportedMediaTypes () {
        return supportedMediaTypes;
    }

    /**
    * 读取请求内容,将其中的 Json 转换成 Java 对象
    * @param clazz 需要转换的 Java 类型
    * @param inputMessage 请求对象
    * @return
    * @throws IOException
    * @throws HttpMessageNotReadableException
    */
    @Override
    public Object read (Class clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException {
        return mapper.readValue (inputMessage.getBody (), clazz);
    }

    /**
    * 将 Java 对象转换成 Json 返回内容
    * @param o 需要转换的对象
    * @param contentType 返回类型
    * @param outputMessage 回执对象
    * @throws IOException
    * @throws HttpMessageNotWritableException
    */
    @Override
    public void write (Object o, MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {
        mapper.writeValue (outputMessage.getBody (), 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 支持的所有类型

回到最开始所提的需求,既然要对返回的 Json 内容进行加密,肯定是对MappingJackson2HttpMessageConverter
进行改造,并且只需要重写write方法。

从MappingJackson2HttpMessageConverter的父类AbstractHttpMessageConverter中的write方法可以看出,该方法通过writeInternal方法向返回结果的输出流中写入数据,所以只需要重写该方法即可:

@Bean
public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter () {
    return new MappingJackson2HttpMessageConverter () {
        // 重写 writeInternal 方法,在返回内容前首先进行加密
        @Override
        protected void writeInternal (Object object, HttpOutputMessage outputMessage) throws IOException,
        HttpMessageNotWritableException {
            // 使用 Jackson 的 ObjectMapper 将 Java 对象转换成 Json String
            ObjectMapper mapper = new ObjectMapper ();
            String json = mapper.writeValueAsString (object);
            LOGGER.error (json);
            // 加密
            String result = json + "加密了!";
            LOGGER.error (result);
            // 输出
            outputMessage.getBody ().write (result.getBytes ());
        }
    };
}

在这之后还需要将这个自定义的转换器配置到 Spring 中,这里通过重写WebMvcConfigurer
中的configureMessageConverters
方法添加自定义转换器:

// 添加自定义转换器
@Override
public void configureMessageConverters (List> converters) {
    converters.add (mappingJackson2HttpMessageConverter ());
    super.configureMessageConverters (converters);
}

测试一下:

如此便简单的完成了对返回内容进行加密的功能。(一般加密也伴随入参的解密。所以很多场景下read方法也需解密,不过思路一致)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,718评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,683评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,207评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,755评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,862评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,050评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,136评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,882评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,330评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,651评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,789评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,477评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,135评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,864评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,099评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,598评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,697评论 2 351

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,602评论 18 399
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,778评论 6 342
  • 我一直都记得,一次萨提亚课堂开课前的自我介绍,当有一个同学说,我刚离婚,心情很低落,想来到课堂上寻求一些力量…… ...
    叶子1975阅读 376评论 0 0
  • 手里有个项目,要在win环境下连接linux,用到了xshell5.0。开始用的时候没问题,昨天再打开xshell...
    我是王小一阅读 1,945评论 0 1