SpringMVC自定义消息转换器的使用其实很简单

 更新时间:2024年07月08日 10:01:27   作者:kusedexingfu  
这篇文章主要介绍了SpringMVC自定义消息转换器的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

在我们的日常开发中,作为服务端,接收的数据是加密的字符串。我们可能会在Controller中获取到加密的字符串,然后手动解密,类似于如下做法(用base64做样例):

@PostMapping
public void base64Post(String base64Param) throws UnsupportedEncodingException {
    String jsonStr = new String(Base64.getDecoder().decode(base64Param), "UTF-8");
}

其实通过SpringMVC的消息转换器HttpMessageConverter可以统一的处理这种问题。

下面就来介绍下实现方式吧。

什么是消息转换器

在SpringMVC中,可以使用@RequestBody和@ResponseBody两个注解,分别完成请求报文到对象和对象到响应报文的转换,这种灵活的消息转换机制就是利用HttpMessageConverter来实现的,Spring内置了很多HttpMessageConverter,比如MappingJackson2HttpMessageConverter,StringHttpMessageConverter等,下面我们来自定义自己的消息转换器来满足上面的需求

自定义消息转换器

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpOutputMessage;
import org.springframework.http.MediaType;
import org.springframework.http.converter.AbstractHttpMessageConverter;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.http.converter.HttpMessageNotWritableException;
import org.springframework.util.StreamUtils;

import java.io.IOException;
import java.nio.charset.Charset;
import java.util.Base64;

/**
 * 针对Object的base64消息处理器
 */
public class Base64ObjMessageConverter extends AbstractHttpMessageConverter<Object> {

    public Base64ObjMessageConverter() {
        // 新建一个我们自定义的媒体类型application/base64obj
        super(new MediaType("application", "base64obj", Charset.forName("UTF-8")));
    }


    @Override
    protected boolean supports(Class<?> clazz) {
        return true;
    }

    @Override
    protected Object readInternal(Class<? extends Object> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException {
        String source = new String(Base64.getDecoder().decode(StreamUtils.copyToString(inputMessage.getBody(), Charset.forName("UTF-8"))), "UTF-8");
        return new ObjectMapper().readValue(source, clazz);
    }

    @Override
    protected void writeInternal(Object obj, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {
        byte[] encode = Base64.getEncoder().encode(new ObjectMapper().writeValueAsString(obj).getBytes());
        outputMessage.getBody().write(encode);
    }
}

如上,我们继承了泛型类AbstractHttpMessageConverter,并重写了它的几个方法。

  • supports:设置处理哪些类。
  • readInternal:处理输入内容,即处理请求值。
  • writeInternal:处理输出内容,即处理返回值。

构造方法定义了要处理的MediaType,这里我定义的是application/base64obj;charset=utf-8,接下来在Controller中也要用到这个MediaType

上面我自定义的消息转换器处理的是Object类型,你也可以指定泛型为特定的类型,只处理该种类型的数据。

将自定义的消息转换器加入到springmvc容器中

这里采用配置类的形式

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.util.List;

@Configuration
public class MessageConverterConfig implements WebMvcConfigurer {

    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.add(base64ObjMessageConverter());
    }

    @Bean
    public Base64ObjMessageConverter base64ObjMessageConverter() {
        return new Base64ObjMessageConverter();
    }
}

Controller代码

@PostMapping(value = "base64obj",  consumes = "application/base64obj;charset=utf-8",produces = "application/base64obj;charset=utf-8")
    public User base64obj(@RequestBody User user) {
        System.out.println(user);
        return user;
    }

我们可以通过设置consumes和produces来让springmvc采用不同的消息转换器处理我们的请求。

我们的测试代码设置的@PostMapping的属性consumers和produces都为我们的自定义的消息处理器要处理的类型application/base64obj;charset=utf-8

即请求和返回都需要经过自定义消息处理器Base64ObjMessageConverter的处理。

注意:

  • 我们可以将consumers和produces设置为不同的MediaType来让不同的消息转换器来处理,但是开发中一般不会这么做。
  • 比如输入的格式是XML,返回的格式确实JSON,这样做是很逆天的。
  • consumers和produces一般都会采用相同的MediaType。

PostMan请求测试

我们将json字符串 {"id":1,"name":"name","sex":"男"} 转为base64字符串:eyJpZCI6MSwibmFtZSI6Im5hbWUiLCJzZXgiOiLnlLcifQ==

用postma请求,设置Content-Type为我们自定义的application/base64obj;charset=utf-8

设置请求体,发送请求,结果能响应

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • 在win10系统下,如何配置Spring Cloud alibaba Seata以及出现问题时怎么解决

    在win10系统下,如何配置Spring Cloud alibaba Seata以及出现问题时怎么解决

    今天教大家如何在win10系统下,配置Spring Cloud alibaba Seata以及出现问题时怎么解决,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
    2021-06-06
  • java执行shell命令及日志收集避坑指南分享

    java执行shell命令及日志收集避坑指南分享

    这篇文章主要介绍了java执行shell命令及日志收集避坑指南,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-04-04
  • Spring 父类变量注入失败的解决

    Spring 父类变量注入失败的解决

    这篇文章主要介绍了Spring 父类变量注入失败的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • Java中的@Async异步功能详解

    Java中的@Async异步功能详解

    这篇文章主要介绍了Java中的@Async异步功能详解,@Async注解,可以实现异步处理的功能,它可以有返回值,或者直接在新线程时并行执行一个任务,对于异步来说,它的执行是有条件的,你需要把异步代码块放在单独的类里,需要的朋友可以参考下
    2023-11-11
  • Java基础之查找文本特定内容后进行修改

    Java基础之查找文本特定内容后进行修改

    这篇文章主要介绍了Java基础之查找文本特定内容后进行修改,文中有非常详细的代码示例,对正在学习java基础的小伙伴们有非常好的帮助,需要的朋友可以参考下
    2021-04-04
  • Spring Boot使用profile如何配置不同环境的配置文件

    Spring Boot使用profile如何配置不同环境的配置文件

    ,springboot支持通过不同的profile来配置不同环境的配置,下面就大致介绍一下yml配置文件跟properties配置文件怎么使用profile配置不同环境的配置文件
    2018-01-01
  • 详解Spring注解 @Configuration

    详解Spring注解 @Configuration

    @Configuration 是 Spring 中的一个注解,它用于标记一个类为配置类,通过配置类可以定义和组装 Spring Bean,并且支持高度灵活的配置方式。本问详细介绍了Spring注解 @Configuration,感兴趣的小伙伴可以参考一下
    2023-04-04
  • java实现酒店管理系统

    java实现酒店管理系统

    这篇文章主要为大家详细介绍了java实现酒店管理系统,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-02-02
  • Java多线程Semaphore工具的使用详解

    Java多线程Semaphore工具的使用详解

    Semaphore 是一种用于控制线程并发访问数的同步工具。它通过维护一定数量的许可证来限制对共享资源的访问,许可证的数量就是可以同时访问共享资源的线程数目,需要的朋友可以参考下
    2023-05-05
  • Java面向对象程序设计多态性示例

    Java面向对象程序设计多态性示例

    这篇文章主要介绍了Java面向对象程序设计多态性,结合实例形式分析了java多态性的概念、原理、定义与使用方法及相关注意事项,需要的朋友可以参考下
    2018-03-03

最新评论