SpringBoot-@RequestParam 比较

Request参数

在访问各种各样网站时,经常会发现网站的URL的最后一部分形如:?xxxx=yyyy&zzzz=wwww。这就是HTTP协议中的Request参数,它有什么用呢?先来看一个例子:

  • 在知乎中搜索web
  • 浏览器跳转到新页面后,URL变为https://www.zhihu.com/search?type=content&q=web

这里type=content&q=web就是搜索请求的参数,不同参数之间用&分隔,每个参数形如name=value形式,分别表示参数名字和参数值。在这个例子中,我们输入不同的搜索关键词,在搜索结果页面的URL的q参数是不同的,也就是说,HTTP参数实际上可以认为是一种用户的输入,根据不同的用户输入,服务器经过处理后返回不同的输出(例如搜索spring和搜索java,显示结果是不一样的。)

Spring MVC中的Request参数

在SpringMVC框架中,现在我们已经可以通过定义@RequestMapping来处理URL请求了,和@PathVariable一样,我们也需要再处理URL的函数中获取URL中的参数-也就是?key=value1&key2=value2这样的参数列表。通过注解@RequestParam可以轻松的将URL中的参数绑定到处理函数方法的变量中:

  @RequestMapping("/user")
    @ResponseBody
//    public String getUerBlog(@PathVariable String username , @PathVariable int blogId) {
//        return "user: " + username + "blog->" + blogId;
//    }
    public String getUserBlog(@RequestParam("id") int blogId) {
        return "blogId = " + blogId;
    }

这样当我们访问/user/?id=123时,Spring MVC帮助我们将Request参数id的值绑定到了处理函数的参数blogId上。这样就能够轻松获取用户输入,并根据它的值进行计算并返回了。

运行结果:

@RequestParam vs @PathVariable

相信大家可能注意到了,@RequestParam和@PathVariable都能够完成类似的功能——因为本质上,它们都是用户的输入,只不过输入的部分不同,一个在URL路径部分,另一个在参数部分。要访问一篇博客文章,这两种URL设计都是可以的:

  • 通过@PathVariable,例如/blogs/1
  • 通过@RequestParam,例如blogs?blogId=1

那么究竟应该选择哪一种呢?建议:

  1. 当URL指向的是某一具体业务资源(或者资源列表),例如博客,用户时,使用@PathVariable
  2. 当URL需要对资源或者资源列表进行过滤,筛选时,用@RequestParam

例如我们会这样设计URL:

  • /blogs/{blogId}
  • /blogs?state=publish而不是/blogs/state/publish来表示处于发布状态的博客文章
更多用法

一旦我们在方法中定义了@RequestParam变量,如果访问的URL中不带有相应的参数,就会抛出异常——这是显然的,Spring尝试帮我们进行绑定,然而没有成功。但有的时候,参数确实不一定永远都存在,这是我们可以通过定义required属性:

@RequestParam(name="id",required=false)

当然,在参数不存在的情况下,可能希望变量有一个默认值:

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

### Spring Boot `@RequestParam` 注解详解 #### 使用场景 在Spring Boot中,`@RequestParam`用于绑定HTTP请求中的查询参数到控制器方法的形参上。此注解允许开发者轻松获取URL中的GET或POST请求参数[^2]。 #### 基本语法 基本形式如下所示: ```java @RequestParam(value="paramName", required=true, defaultValue="") ``` - `value`: 参数名称,默认情况下如果未指定,则取变量名作为key。 - `required`: 是否必需,默认为true;当设置为false时,即使前端不传该参数也不会报错。 - `defaultValue`: 默认值,在参数缺失的情况下返回默认设定的内容。 #### 实际案例展示 下面通过几个例子来说明如何运用这个注解。 ##### 单个参数接收 对于简单的单个参数传递情况,可以直接这样写: ```java @GetMapping("/hello") public String sayHello(@RequestParam("name") String name){ return "Hello," + name; } ``` 上述代码表示访问路径/hello?name=John将会得到响应"Hello, John"。 ##### 多个参数处理 面对多个参数的情况也不复杂: ```java @PostMapping("/addUser") public User addUser( @RequestParam("username") String username, @RequestParam("age") Integer age){ //业务逻辑... } ``` 这里定义了一个接受两个参数(username 和 age)的方法,适用于表单提交等场景。 ##### 可选参数支持 有时候某些参数不是必填项,这时可以通过调整属性让其变得可选: ```java @GetMapping("/search") public List<Item> searchItems(@RequestParam(required=false, defaultValue="defaultVal") String keyword){ //根据关键词查找商品列表... } ``` 这段程序展示了keyword是一个非必要的字段,并设定了它的缺省值"defaultVal"。 #### 注意事项 需要注意的是,当使用`@RequestParam`映射请求参数至Java对象时,应确保参数的名字与实体类里的属性相匹配,否则会抛出异常提示找不到对应的参数。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值