SpringBoot的参数注解

1、@PathVariable：接收请求路径中占位符的值

• 带占位符的 URL 是 Spring3.0 新增的功能，该功能在SpringMVC 向 REST 目标挺进发展过程中具有里程碑的意义
• 通过 @PathVariable 可以将 URL 中占位符参数绑定到控制器处理方法的入参中：URL 中的www.xxx.com/user/{xxx}/num/{bbb} 占位符可以通过@PathVariable(“xxx“)，@PathVariable(“bbb“) 绑定到操作方法的入参中。
  例如：

URL：http://localhost:9010/aa/789/mm/333
// 代码
    @RequestMapping("aa/{user}/mm/{num}")
    @ResponseBody
    public RestResponse activityaa(@PathVariable("user") String userID, @PathVariable("num") String num){
        return RestResponse.success(userID + "----" + num);
    }
// 返回
{"code":0,"msg":"OK","count":0,"data":"789----333"}

• 除了简单地定义{xxx}变量，还可以定义正则表达式进行更精确的控制，定义语法是{变量名：正则表达式}[a-zA-Z0-9_]+是一个正则表达式，表示只能包含小写字母，大写字母，数字，下划线。如此设置URL变量规则后，不合法的URL则不会被处理，直接由SpringMVC框架返回404Not Found

@RequestMapping("/aa/{user:[a-zA-Z0-9_]+}/mm/{num}")

2、@RequestParam：用于绑定请求参数里面的值

• 在SpringMVC框架中，通过定义@RequestMapping来处理不用的URL请求了，但我们也需要处理请求中的参数，也就是http://localhost:9010/aa?key=value1&key2=value2就是这样的?key=value1&key2=value2参数列表。通过注解@RequestParam可以轻松的将URL中的参数绑定到处理函数方法的变量中
• 请求类型为form-data和x-www-form-urlencoded的也是可以获取到的

URL: http://localhost:9010/aa?uu=22&user=44&num=55
// 代码
    @RequestMapping("aa")
    @ResponseBody
    public RestResponse activityaa11(@RequestParam String uu, @RequestParam("user") String userID, @RequestParam("num") String num){
        return RestResponse.success(uu + "----" + userID + "----" + num);
    }
// 结果
{"code":0,"msg":"OK","count":0,"data":"22----44----55"}

• 有的时候匹配的参数没有，则需要进一步处理:http://localhost:9010/aa?uu=22&user=44，缺少了参数num。如果不进行处理，则会后台报错，前端状态就是一直在请求的中

@RequestParam(name="num",required=false,defaultValue="0")

• 有的时候不写@RequestParam ，默认也是可以的。注意这里num就是为null了

URL:  http://localhost:9010/bb?uu=22&userID=44
// 代码
    @RequestMapping("bb")
    @ResponseBody
    public RestResponse activityaa22(String uu, String userID, String num){
        return RestResponse.success(uu + "----" + userID + "----" + num);
    }
// 返回
{"code":0,"msg":"OK","count":0,"data":"22----44----null"}

3、@RequestBody：注解接受参数是来自于body内容中，请求格式必须是raw并且是application/json

@PostMapping(value = "/11")
    public RestResponse device11(
            @RequestBody Test test
    ){
        if (StringUtils.isEmpty(test.getName())
                || test.getAdd() == null){
            return RestResponse.error(RestCode.ParamsAndInstanceIsNull);
        }
        return RestResponse.success(deviceService.deviceList());
    }

image.png

4、如果是下面这个情况

@PostMapping(value = "/11")
public RestResponse device11(Test test){}

• 这里的device11(Test test)参数里面，没有填写任何注解，这时他是可以接受来自于如下的请求格式，是可以获取到form-data和x-www-form-urlencoded

  
  image.png
  image.png
• 如果使用raw则是获取不到数据

5、校验

javax.validation.constraints里面自带的像@NotNull @NotEmpty...等等这类注解

• 如果用在类的属性上，必须配合@Valid才会生效。有其他的注解也不行，因为每个注解都有自己负责的功能例如：
  @RequestBodyTest22 test22。如果以为有了@RequestBody注解，@Valid就不用写了。那是不行的，@NotNull还是不会生效。必须@RequestBody @Valid Test22 test22这样写全才行
• 在name属性上面写了两个，就是不能为null也不能为空

- 定义类
@Data
public class Test22 {

    @NotNull
    @NotEmpty
    private String name;
    private Integer add;
}
- 使用类
public RestResponse device11(@Valid Test11 test11){}

• 如果直接使用到参数上面也是无效的

- 无效
public RestResponse device11(@NotNull String name){}

- 有效 用到另外一个注解 import lombok.NonNull;
public RestResponse device11(@NonNull String name){}

lombok.NonNull 这类的lombok下的注解，可以用在属性、参数等。直接使用，直接生效