❤️SpringMVC成神之路之三十、Converter转换器详解

小明的学习圈子2023-12-24后端SpringMVC成神之路

本文将讲解Spring中的另外一个知识点:SpringMVC中转换器Converter的使用。

好陌生啊,这玩意是干啥的呢?请往下看。

1、来看一个需求

如下,有一个UserDto类,表示用户信息

public class UserDto {
    //用户名
    private String name;
    //年龄
    private Integer age;
    //省略getter、setter方法
}

要求后台所有接口接受UserDto数据时,参数的值格式为:name,age,比如下面接口

@RequestMapping("/convert/test1")
public UserDto test1(@RequestParam("user") UserDto user) {
    System.out.println("name:" + user.getName());
    System.out.println("age:" + user.getAge());
    return user;
}

能够接受的请格式:/convert/test1?user=ready,1,这种需求如何实现呢?

2、需用Converter接口来实现

SpringMVC中为我们提供的另外一个接口org.springframework.core.convert.converter.Converter,这个接口用来将一种类型转换为另一种类型,看看其源码如下,调用后端接口的时候,http传递的参数都是字符串类型的,但是后端却可以使用Integer、Double等其他类型来接收,这就是Converter实现的。

@FunctionalInterface
public interface Converter<S, T> {
    /**
     * 将source转换为目标T类型
     */
    @Nullable
    T convert(S source);
}

Spring内部提供了很多默认的实现,用于各种类型转换

image-20231231220609798

实现开头的需求,需要我们自定义一个Converter<String,UserDto>,将其添加到SpringMVC转换器列表中,他负责将String类型转换为UserDto类型。下面来看具体代码实现

3、代码实现

  • 代码如下,添加一个配置类,实现WebMvcConfigurer接口
  • 重写addFormatters方法,在这个方法中添加一个自定义的Converter,实现其convert方法,将name,age格式的字符串转换为UserDto对象返回
@Configuration
public class MvcConfig implements WebMvcConfigurer {
    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(new Converter<String, UserDto>() {
            @Override
            public UserDto convert(String source) {
                if (source == null) {
                    return null;
                }
                String[] split = source.split(",");
                String name = split[0];
                Integer age = Integer.valueOf(split[1]);
                return new UserDto(name, age);
            }
        });
    }
}

接口代码

@RestController
public class ConverterTestController {
    @RequestMapping("/convert/test1")
    public UserDto test1(@RequestParam("user") UserDto user) {
        System.out.println("name:" + user.getName());
        System.out.println("age:" + user.getAge());
        return user;
    }
}

访问请求/convert/test1?user=ready,1,效果如下:

image-20231231220712268

tomcat控制台输出

name:ready
age:1

4、案例代码git地址

4.1、git地址

https://gitee.com/javacode2018/springmvc-series

4.2、本文案例代码结构说明

image-20231231220815027

来源:http://www.itsoku.com/course/6/241

Last Updated 2024/4/6 11:55:17