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下的注解,可以用在属性、参数等。直接使用,直接生效

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,417评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,921评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,850评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,945评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,069评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,188评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,239评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,994评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,409评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,735评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,898评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,578评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,205评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,916评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,156评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,722评论 2 363
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,781评论 2 351