Spring的@RequestParam对象绑定方式

目录

• Spring @RequestParam对象绑定
• 解决方案
• 在POJO中对请求参数进行校验
• SpringMvc参数绑定自定义对象
• json提交
• form提交
• 小结一下

Spring @RequestParam对象绑定

在Spring中，如果在方法参数列表中使用@RequestParam标注多个参数，会让映射方法的可读性大大降低。

如果映射请求的参数只有一两个的话，使用@RequestParam会非常直观，但是如果参数列表越来越长，就很容易晕菜。

解决方案

可以直接使用ParameterObject模式来处理【注：ParameterObject就是把参数组装成对象】。

如果要传参对数据库操作，则参数对应数据库中的某些字段，此时表对应的entity对象可以直接作为ParameterObject。

其他情况下则可以使用一个POJO来包装这些参数，这个POJO本身没有要求额外的注解，但是POJO本身必须包含和请求参数完全匹配的字段，标准的setter/getter，和一个无参的构造器：

class ProductCriteria {
   private String query;
   private int offset;
   private int limit;
   ProductCriteria() {
   }
   public String getQuery() {
       return query;
   }
   public void setQuery(String query) {
       this.query = query;
   }
   // other getters/setters
}
@GetMapping
List searchProducts(ProductCriteria productCriteria) {
   return productRepository.search(productCriteria);
}

在POJO中对请求参数进行校验

虽然上面的案例已经可以正常使用，但是我们知道，使用@RequestParam注解，不仅仅只是为了绑定请求参数，一个非常重要的功能是，我们可以对绑定的参数请求验证，比如参数是否必要，如果请求中缺少该参数，则我们的服务端可以拒绝该请求。

想为我们的POJO中的字段添加验证规则。如果想模仿@RequestParam(required = false)的表现，可以使用@NotNull注解在对应的字段上即可。

在更多的情况下，我们一般使用@NotBlank多于@NotNull，因为@NotBlank考虑了空字符串的情况。

final class ProductCriteria {
   @NotBlank
   private String query;
   @Min(0)
   private int offset;
   @Min(1)
   private int limi;
   // ...
}

这里务必注意一点：

仅仅只是在对象的字段上添加验证注解是不够的。

一定要在controller的方法参数里诶包中，在POJO对应的参数前加上@Valid注解。该注解会让Spring在绑定参数前执行校验动作。

@GetMapping
List searchProducts(@Valid ProductCriteria productCriteria) {
   // ...
}

@RequestParam注解的另一个非常有用的功能就是设置参数的默认值。

如果我们使用POJO的方式来绑定参数，只需要在定义参数的时候设置好字段的默认值就行了。如果请求中没有该参数，Spring不会把参数的默认值覆盖为null的。

SpringMvc参数绑定自定义对象

springmvc我们经常在写controller一般都接受两种方式，一种是form提交，一种是json提交，下面就来介绍如何在这两种方式中将提交的数据自动绑定到自定义对象中。

json提交

这个比较简单，在网上搜一下一大把，这里就简单放一段代码：

@RequestMapping("/testjson")
public String testjson(@RequestBody User user){
    return "ok";
}

form提交

这个是比较头疼的，一般form有很多的参数，我们可以像下面这样写：

@RequestMapping("/test")
public String testParam(@RequestParam(name = "name") String name, @RequestParam(name = "sex") String sex) {
    return name + sex;
}

但是如果我改成下面这样会怎么样？然后用form提交参数 name=zack & sex=boy

@RequestMapping("/test")
public String test(@RequestParam(name = "user") User user) {
    return user.getName();
}

结果是报错：

{
"timestamp": "2018-05-29T11:58:37.450+0000",
"status": 400,
"error": "Bad Request",
"message": "Required User parameter 'user' is not present",
"path": "/test1"
}

我的参数里确实是没有user这个，其实我的原本目的是想让spring把我传递的name和sex熟悉拼装好生成一个user对象，因为刚好user对象就有这2个属性，spring可没有智能。那该怎么办？

这个时候引入WebDataBinder, 在你的controller里加上下面的代码：

@InitBinder
protected void initBinder(WebDataBinder binder) {
    binder.registerCustomEditor(User.class, new UserFormatEditor());
}
public static class UserFormatEditor extends PropertiesEditor {
    @Override
    public void setAsText(String text) throws IllegalArgumentException {
        setValue(JSONObject.parseObject(text, User.class));
    }
    @Override
    public String getAsText() {
        return getValue().toString();
    }
}

然后在请求时将参数改为 user = {"name":"zack","sex":"boy"} ，之后就成功的获取User对象，WebDataBinder帮我们告诉了spring，如果遇到了一个字符串参数要被包装成User.class，用我们自定义的UserFormatEditor就行。

小结一下

作为规范而言，form提交的方式本身就需要我们一个一个属性的接收，而不能用一个对象统一接收，如果你想用一个对象统一接收，请采用json的方式提交。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。