Spring 5中使用Bean绑定请求参数并自定义参数名的疑问

嘿，这个问题我之前也纠结过，刚好用Spring 5解决过类似场景！其实完全不用手动写Argument Resolver那么麻烦，Spring 5本身就提供了更优雅的方式来实现Bean字段和请求参数名的映射。

核心方案：利用@JsonProperty注解 #

Spring MVC在处理请求参数（无论是URL查询参数还是表单参数）绑定到POJO时，会识别Jackson的@JsonProperty注解来映射参数名。举个例子：

public class UserQuery {
    // 让请求参数`user_id`绑定到Bean的`userId`字段
    @JsonProperty("user_id")
    private Long userId;
    
    // 让请求参数`user_name`绑定到Bean的`userName`字段
    @JsonProperty("user_name")
    private String userName;

    // getter和setter省略
}

然后在Controller里直接用这个Bean作为参数（默认会被@ModelAttribute处理）：

@GetMapping("/users")
public List<User> getUsers(UserQuery query) {
    // 直接使用query里的userId和userName即可
    return userService.queryUsers(query.getUserId(), query.getUserName());
}

这样当请求/users?user_id=1&user_name=jack时，参数会自动映射到UserQuery的对应字段，完全不需要额外的Resolver。

为什么这个方案可行？ #

Spring 5的WebDataBinder在处理POJO绑定的时候，会自动识别Jackson的注解（只要你的项目里引入了Jackson依赖，这在Spring Boot项目里是默认的），把@JsonProperty指定的参数名和Bean字段关联起来，省去了手动编写绑定逻辑的麻烦。

替代方案：自定义PropertyEditor（不推荐） #

如果你的项目没有引入Jackson，或者不想依赖Jackson注解，也可以通过@InitBinder注册自定义的PropertyEditor，但这种方式需要为每个字段单独处理，比较繁琐：

@Controller
public class UserController {
    @InitBinder
    public void initBinder(WebDataBinder binder) {
        binder.registerCustomEditor(Long.class, "userId", new PropertyEditorSupport() {
            @Override
            public void setAsText(String text) throws IllegalArgumentException {
                // 这里手动处理参数名`user_id`到`userId`的映射
                // 不过这种方式需要逐个字段配置，不如@JsonProperty方便
                setValue(Long.parseLong(text));
            }
        });
    }
}

总结 #

Spring 5完全不需要手动实现Argument Resolver来处理这种场景，用@JsonProperty注解就能轻松搞定Bean字段和请求参数名的映射，简单又优雅。

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