Spring Boot中如何让路径参数名称支持短横线？求通用方案

核心问题定位 #

你当前代码的首要问题是注解误用：@PathParam是JAX-RS（Java EE）规范的注解，Spring MVC框架并不识别它。处理URL中的参数时，需根据参数类型选择正确的Spring注解：

• 如果是请求参数（如/employees?page-size=10）：用@RequestParam
• 如果是路径参数（如/employees/{page-size}）：用@PathVariable

直接可用的修正方案 #

1. 修正注解（最简方案） #

针对请求参数场景，修正后的代码如下，Spring可直接识别page-size参数：

@GetMapping("employees")
public ResponseEntity<Object> getEmployeesBySelection(@RequestParam("page-size") Optional<Integer> pageSize) {
    return ResponseEntity.ok(pageSize.orElse(0));
}

针对路径参数场景，需先在路径中定义占位符，再用@PathVariable绑定：

@GetMapping("employees/{page-size}")
public ResponseEntity<Object> getEmployeesBySelection(@PathVariable("page-size") Optional<Integer> pageSize) {
    return ResponseEntity.ok(pageSize.orElse(0));
}

全局统一配置方案（无需自定义包装器） #

如果项目中有大量含短横线的参数，可通过全局配置实现短横线参数名自动映射到驼峰命名的方法参数，无需逐个指定参数名：

Spring Boot 2.x+ 配置文件方式 #

在application.properties中添加以下配置：

# 启用驼峰-短横线参数自动转换
spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER
spring.mvc.servlet.init-param.use-expressions=false

Java配置类方式（更灵活） #

通过自定义WebMvcConfigurer实现全局参数命名策略：

@Configuration
public class WebParamConfig implements WebMvcConfigurer {

    @Override
    public void configureArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
        // 获取默认的请求参数解析器
        RequestParamMethodArgumentResolver paramResolver = new RequestParamMethodArgumentResolver(
                new DefaultParameterNameDiscoverer(), false);
        
        // 包装解析器，添加短横线转驼峰的逻辑
        resolvers.add(new HandlerMethodArgumentResolver() {
            @Override
            public boolean supportsParameter(MethodParameter parameter) {
                return paramResolver.supportsParameter(parameter);
            }

            @Override
            public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
                                          NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
                // 将方法参数的驼峰名转为短横线格式，匹配请求参数
                String paramName = parameter.getParameterName();
                if (paramName != null) {
                    String dashedName = IntStream.range(0, paramName.length())
                            .mapToObj(i -> {
                                char c = paramName.charAt(i);
                                if (Character.isUpperCase(c)) {
                                    return "-" + Character.toLowerCase(c);
                                }
                                return String.valueOf(c);
                            })
                            .collect(Collectors.joining());
                    // 尝试获取短横线格式的参数
                    String paramValue = webRequest.getParameter(dashedName);
                    if (paramValue != null) {
                        webRequest.setAttribute(paramName, paramValue, NativeWebRequest.SCOPE_REQUEST);
                    }
                }
                return paramResolver.resolveArgument(parameter, mavContainer, webRequest, binderFactory);
            }
        });
    }
}

配置后，方法参数用驼峰命名即可自动匹配短横线格式的请求参数：

@GetMapping("employees")
// 自动匹配?page-size=xxx
public ResponseEntity<Object> getEmployeesBySelection(@RequestParam Optional<Integer> pageSize) {
    return ResponseEntity.ok(pageSize.orElse(0));
}

注意事项 #

• Spring 4.3及以上版本原生支持Optional作为请求/路径参数类型，无需额外配置。
• 路径参数场景下，必须确保URL路径中存在对应的占位符（如{page-size}），否则无法绑定参数。

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