Spring MVC中@RequestParam绑定YearMonth参数报错问题

你遇到的这个错误，核心原因是Spring默认没有提供String到YearMonth的内置类型转换器，导致无法自动完成请求参数到目标类型的转换。下面给你两种实用的解决方案：

方案一：全局注册自定义Converter（全应用生效） #

这种方式适合多个控制器都需要处理YearMonth类型参数的场景，一次配置全局可用。

1. 实现Converter接口 #

创建一个转换器类，负责将yyyy-MM格式的字符串解析为YearMonth对象：

import org.springframework.core.convert.converter.Converter;
import java.time.YearMonth;
import java.time.format.DateTimeFormatter;

public class StringToYearMonthConverter implements Converter<String, YearMonth> {
    // 定义固定的日期格式
    private static final DateTimeFormatter DATE_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM");

    @Override
    public YearMonth convert(String source) {
        // 处理空输入的边界情况
        if (source == null || source.trim().isEmpty()) {
            return null;
        }
        // 解析字符串为YearMonth实例
        return YearMonth.parse(source, DATE_FORMATTER);
    }
}

2. 注册Converter到Spring容器 #

创建WebMvc配置类，将转换器添加到格式化注册表中：

import org.springframework.context.annotation.Configuration;
import org.springframework.format.FormatterRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(new StringToYearMonthConverter());
    }
}

配置完成后，控制器中的参数绑定就可以正常工作了，甚至可以省略@DateTimeFormat注解：

@GetMapping("/query")
public String handleQuery(@RequestParam(value = "start") YearMonth start) {
    // 业务逻辑处理
    return "Received start month: " + start;
}

方案二：控制器内添加@InitBinder（局部生效） #

如果只有单个控制器需要处理YearMonth参数，可以用@InitBinder注册属性编辑器，仅对当前控制器生效：

import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import java.beans.PropertyEditorSupport;
import java.time.YearMonth;
import java.time.format.DateTimeFormatter;

@RestController
public class DataQueryController {

    @InitBinder
    public void initYearMonthBinder(WebDataBinder binder) {
        binder.registerCustomEditor(YearMonth.class, new PropertyEditorSupport() {
            @Override
            public void setAsText(String text) throws IllegalArgumentException {
                // 解析输入字符串为YearMonth
                setValue(YearMonth.parse(text, DateTimeFormatter.ofPattern("yyyy-MM")));
            }
        });
    }

    @GetMapping("/data")
    public String getData(@RequestParam("start") YearMonth start) {
        return "Start month: " + start;
    }
}

额外注意事项 #

• 确保请求参数的格式严格匹配yyyy-MM，如果需要支持多种格式，可以在转换器中添加多格式解析的逻辑；
• 如果你使用Spring Boot，建议使用2.x及以上版本，对Java 8时间API的支持更完善；
• 两种方案二选一即可，全局Converter适合通用场景，@InitBinder适合局部特殊需求。

内容的提问来源于stack exchange，提问作者uromay