Spring数据类型转换的魅力与意义

后端

2023-10-19 09:45:55

一、什么是类型转换体系

类型转换体系指的是参与完成类型转换功能的所有类/接口的集合。Spring中，需要类型转换的场景比较多，这里举两个例子：

当我们在控制器方法中定义一个参数时，如果该参数的类型与请求参数的类型不一致，Spring会自动进行类型转换。
当我们在表单中提交数据时，Spring会将表单字段的值转换为对应的Java类型，然后将这些值绑定到控制器方法的参数上。

二、Spring数据类型转换体系的组成

Spring数据类型转换体系主要包括以下几个部分：

转换器：转换器负责将一种类型的值转换为另一种类型的值。Spring提供了多种内置的转换器，包括基本数据类型转换器、日期转换器、字符串转换器等。
转换服务：转换服务负责协调转换器的使用。当需要进行类型转换时，转换服务会选择合适的转换器来完成转换。
@InitBinder注解：@InitBinder注解可以将自定义的转换器添加到Spring的转换服务中。
@DateTimeFormat注解：@DateTimeFormat注解可以指定日期字段的格式，以便Spring能够正确地将字符串转换为日期。

三、Spring数据类型转换的用法

1. 使用内置转换器

Spring提供了多种内置的转换器，我们可以直接使用这些转换器来进行类型转换。例如，我们可以使用IntegerConverter转换器将字符串转换为整数，使用DateConverter转换器将字符串转换为日期。

@Controller
public class MyController {

    @RequestMapping("/test")
    public String test(@RequestParam("id") Integer id) {
        // id的值为"123"，Spring会自动将字符串"123"转换为整数123
        System.out.println(id);
        return "success";
    }
}

2. 使用自定义转换器

如果内置的转换器无法满足我们的需求，我们可以自定义转换器。自定义转换器需要实现Converter接口。Converter接口定义了两个方法：

convert()方法：负责将一种类型的值转换为另一种类型的值。
getConvertibleTypes()方法：返回转换器支持的源类型和目标类型。

public class MyConverter implements Converter<String, User> {

    @Override
    public User convert(String source) {
        // 将字符串source转换为User对象
        return new User();
    }

    @Override
    public Set<ConvertiblePair> getConvertibleTypes() {
        // 返回转换器支持的源类型和目标类型
        return Set.of(new ConvertiblePair(String.class, User.class));
    }
}

自定义转换器需要添加到Spring的转换服务中，可以通过在控制器类中使用@InitBinder注解来实现。

@Controller
public class MyController {

    @InitBinder
    public void initBinder(WebDataBinder binder) {
        // 将自定义转换器添加到Spring的转换服务中
        binder.addCustomFormatter(new MyConverter());
    }

    @RequestMapping("/test")
    public String test(@RequestParam("user") User user) {
        // user的值为"张三,18"，Spring会自动将字符串"张三,18"转换为User对象
        System.out.println(user);
        return "success";
    }
}

3. 使用`@DateTimeFormat`注解

@DateTimeFormat注解可以指定日期字段的格式，以便Spring能够正确地将字符串转换为日期。

@Controller
public class MyController {

    @RequestMapping("/test")
    public String test(@RequestParam("birthday") @DateTimeFormat(pattern="yyyy-MM-dd") Date birthday) {
        // birthday的值为"2022-01-01"，Spring会自动将字符串"2022-01-01"转换为日期对象
        System.out.println(birthday);
        return "success";
    }
}

四、常见问题

1. 类型转换失败

如果类型转换失败，Spring会抛出ConversionFailedException异常。我们可以通过在控制器方法中捕获ConversionFailedException异常来处理类型转换失败的情况。

@Controller
public class MyController {

    @RequestMapping("/test")
    public String test(@RequestParam("id") Integer id) {
        try {
            // id的值为"abc"，Spring会自动将字符串"abc"转换为整数，但由于"abc"不是一个有效的整数，因此会抛出ConversionFailedException异常
            System.out.println(id);
            return "success";
        } catch (ConversionFailedException e) {
            // 处理类型转换失败的情况
            return "error";
        }
    }
}

2. 如何添加自定义转换器

我们可以通过在控制器类中使用@InitBinder注解来添加自定义转换器。

@Controller
public class MyController {

    @InitBinder
    public void initBinder(WebDataBinder binder) {
        // 将自定义转换器添加到Spring的转换服务中
        binder.addCustomFormatter(new MyConverter());
    }

    @RequestMapping("/test")
    public String test(@RequestParam("user") User user) {
        // user的值为"张三,18"，Spring会自动将字符串"张三,18"转换为User对象
        System.out.println(user);
        return "success";
    }
}

3. 如何指定日期字段的格式

我们可以通过使用@DateTimeFormat注解来指定日期字段的格式。

@Controller
public class MyController {

    @RequestMapping("/test")
    public String test(@RequestParam("birthday") @DateTimeFormat(pattern="yyyy-MM-dd") Date birthday) {
        // birthday的值为"2022-01-01"，Spring会自动将字符串"2022-01-01"转换为日期对象
        System.out.println(birthday);
        return "success";
    }
}