SpringBoot自定义转换器应用实例讲解

在SpringBoot中，通过自定义转换器可以实现将一个类型转换为另外一个类型。本文将详细介绍如何在SpringBoot应用中创建自定义转换器，并提供两个示例。

创建自定义转换器

步骤如下：

1. 创建一个类并实现org.springframework.core.convert.converter.Converter接口。

public class StringToDateConverter implements Converter<String, Date> {

    private SimpleDateFormat format;

    public StringToDateConverter(String formatStr) {
        this.format = new SimpleDateFormat(formatStr);
    }

    @Override
    public Date convert(String source) {
        try {
            return format.parse(source);
        } catch (ParseException e) {
            throw new IllegalArgumentException("Invalid date format. Please use format: " + format.toPattern());
        }
    }
}

1. 将自定义的转换器注册到Spring容器中。

@Configuration
public class MyConversionServiceConfig {

    @Bean
    public ConversionService conversionService() {
        DefaultFormattingConversionService conversionService = new DefaultFormattingConversionService();
        conversionService.addConverter(new StringToDateConverter("yyyy-MM-dd"));
        return conversionService;
    }

}

注意，我们使用DefaultFormattingConversionService实现，这样我们就可以直接在SpringMVC的控制器中使用它。

示例1：将字符串转换成自定义对象

模拟一种情况：我们的应用需要从用户输入中解析出日期和时间，并将其保存为java.util.Date对象。假设我们的用户将日期和时间用空格分隔开了，例如 "2021-10-01 12:34:56"。

假设我们有一个DateInfo类，它有date和time两个属性，我们希望将用户输入的字符串转换为该对象。

@Getter
@Setter
public class DateInfo {
    private Date date;
    private Date time;
}

为此，我们需要创建一个自定义的转换器。

public class StringToDateInfoConverter implements Converter<String, DateInfo> {

    @Override
    public DateInfo convert(String source) {

        String[] split = source.split(" ");
        if (split.length != 2) {
            throw new IllegalArgumentException("Invalid date format. Please use format: yyyy-MM-dd HH:mm:ss");
        }

        String dateStr = split[0];
        String timeStr = split[1];
        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
        SimpleDateFormat timeFormat = new SimpleDateFormat("HH:mm:ss");
        try {
            Date date = dateFormat.parse(dateStr);
            Date time = timeFormat.parse(timeStr);
            DateInfo dateInfo = new DateInfo();
            dateInfo.setDate(date);
            dateInfo.setTime(time);
            return dateInfo;
        } catch (ParseException e) {
            throw new IllegalArgumentException("Invalid date format. Please use format: yyyy-MM-dd HH:mm:ss");
        }
    }
}

我们还需要在Spring容器中注册转换器。

@Configuration
public class MyConversionServiceConfig {

    @Bean
    public ConversionService conversionService() {
        DefaultFormattingConversionService conversionService = new DefaultFormattingConversionService();
        conversionService.addConverter(new StringToDateConverter("yyyy-MM-dd"));
        conversionService.addConverter(new StringToDateInfoConverter());
        return conversionService;
    }

}

现在我们就可以在控制器中使用自动绑定用户输入的日期和时间了。

@RestController
@RequestMapping("/demo")
public class DemoController {

    @GetMapping
    public String getDateInfo(DateInfo dateInfo) {
        return dateInfo.getDate() + " " + dateInfo.getTime();
    }

}

示例2：将表单数据转换为自定义JavaBean

@ModelAttribute注解可以将表单数据绑定到一个JavaBean中。通常情况下，表单数据的类型和JavaBean的类型不同，这时候就需要使用自定义的转换器。

假设我们有一个名为Person的JavaBean类。

@Getter
@Setter
public class Person {
    private String firstName;
    private String lastName;
    private Date birthDate;
}

我们将实现一个自定义的转换器，将表单数据转换为一个Person对象。

public class StringToPersonConverter implements Converter<String, Person> {

    @Override
    public Person convert(String source) {

        String[] split = source.split(",");
        if (split.length != 3) {
            throw new IllegalArgumentException("Invalid person format. Please use format: firstName,lastName,birthDate(yyyy-MM-dd)");
        }

        String firstName = split[0];
        String lastName = split[1];
        String dateStr = split[2];
        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
        try {
            Date birthDate = dateFormat.parse(dateStr);
            Person person = new Person();
            person.setFirstName(firstName);
            person.setLastName(lastName);
            person.setBirthDate(birthDate);
            return person;
        } catch (ParseException e) {
            throw new IllegalArgumentException("Invalid date format. Please use format: yyyy-MM-dd");
        }
    }
}

我们需要将自定义的转换器注册到Spring容器中。

@Configuration
public class MyConversionServiceConfig {

    @Bean
    public ConversionService conversionService() {
        DefaultFormattingConversionService conversionService = new DefaultFormattingConversionService();
        conversionService.addConverter(new StringToPersonConverter());
        return conversionService;
    }

}

我们还需要定义一个控制器类，它使用@ModelAttribute注解将表单数据绑定到一个Person对象中。

@RestController
@RequestMapping("/person")
public class PersonController {

    @PostMapping
    public String addPerson(@ModelAttribute("person") Person person) {
        return String.format("Person: %s %s, birthDay: %s", person.getFirstName(), person.getLastName(), person.getBirthDate());
    }

}

现在我们就可以向应用程序提交表单，并将其转换为自定义的JavaBean对象。