SpringBoot中@PathVaribale/@RequestParam/@GetMapping介绍

水深无声 2022-05-28 08:49 155阅读 0赞

本篇博文将介绍几种如何处理url中的参数的注解@PathVaribale/@RequestParam/@GetMapping。

其中，各注解的作用为：

@PathVaribale 获取url中的数据

@RequestParam 获取请求参数的值

@GetMapping 组合注解，是@RequestMapping(method = RequestMethod.GET)的缩写

***@PathVaribale 获取url中的数据***

看一个例子，如果我们需要获取Url=localhost:8080/hello/id中的id值，实现代码如下：

@RestController
    public class HelloController {
    
        @RequestMapping(value="/hello/{id}",method= RequestMethod.GET)
        public String sayHello(@PathVariable("id") Integer id){
            return "id:"+id;
        }
    }

![这里写图片描述][70]

同样，如果我们需要在url有多个参数需要获取，则如下代码所示来做就可以了。

@RestController
    public class HelloController {
    
        @RequestMapping(value="/hello/{id}/{name}",method= RequestMethod.GET)
        public String sayHello(@PathVariable("id") Integer id,@PathVariable("name") String name){
            return "id:"+id+" name:"+name;
        }
    }

![这里写图片描述][70 1]  
以上，通过@PathVariable注解来获取URL中的参数时的前提条件是我们知道url的格式时怎么样的。

只有知道url的格式，我们才能在指定的方法上通过相同的格式获取相应位置的参数值。

一般情况下，url的格式为：localhost:8080/hello?id=98,这种情况下该如何来获取其id值呢,这就需要借助于@RequestParam来完成了  
@RequestParam 获取请求参数的值

直接看一个例子，如下

@RestController
    public class HelloController {
    
        @RequestMapping(value="/hello",method= RequestMethod.GET)
        public String sayHello(@RequestParam("id") Integer id){
            return "id:"+id;
        }
    }

在浏览器中输入地址：localhost:8080/hello?id=1000，可以看到如下的结果：  
![这里写图片描述][70 2]  
当我们在浏览器中输入地址：localhost:8080/hello?id ,即不输入id的具体值，此时返回的结果为null。具体测试结果如下：  
![这里写图片描述][70 3]  
但是，当我们在浏览器中输入地址：localhost:8080/hello ,即不输入id参数，则会报如下错误：  
![这里写图片描述][70 4]  
@RequestParam注解给我们提供了这种解决方案，即允许用户不输入id时，使用默认值，具体代码如下：

@RestController
    public class HelloController {
        @RequestMapping(value="/hello",method= RequestMethod.GET)
        //required=false 表示url中可以不穿入id参数，此时就使用默认参数
        public String sayHello(@RequestParam(value="id",required = false,defaultValue = "1") Integer id){
            return "id:"+id;
        }
    }

测试结果如下；  
![这里写图片描述][70 5]  
如果在url中有多个参数，即类似于localhost:8080/hello?id=98&&name=wojiushimogui这样的url，同样可以这样来处理。具体代码如下：

/** * Created by wuranghao on 2017/4/7. */
    @RestController
    public class HelloController { 
    
        @RequestMapping(value="/hello",method= RequestMethod.GET)
        public String sayHello(@RequestParam("id") Integer id,@RequestParam("name") String name){
            return "id:"+id+ " name:"+name;
        }
    }

在浏览器中的测试结果如下：  
![这里写图片描述][70 6]

***@GetMapping 组合注解***

@GetMapping是一个组合注解，是@RequestMapping(method = RequestMethod.GET)的缩写。该注解将HTTP Get 映射到 特定的处理方法上。

即可以使用@GetMapping(value = “/hello”)来代替@RequestMapping(value=”/hello”,method= RequestMethod.GET)。即可以让我们精简代码。

例子

@RestController
    public class HelloController {
        //@RequestMapping(value="/hello",method= RequestMethod.GET)
        @GetMapping(value = "/hello")
        //required=false 表示url中可以不穿入id参数，此时就使用默认参数
        public String sayHello(@RequestParam(value="id",required = false,defaultValue = "1") Integer id){
            return "id:"+id;
        }
    }

[70]: /images/20220528/8c97eda9aec24151ba7d1acdf6626778.png
[70 1]: /images/20220528/490788435ef24478b45273042e10efde.png
[70 2]: /images/20220528/f9bc0516bd334736ae080bb003f0284b.png
[70 3]: /images/20220528/4a4ec29d971f41f7bafd97bcdb39190d.png
[70 4]: /images/20220528/2ccac15692244033990e0d475f0ea909.png
[70 5]: /images/20220528/10e0926c40cd499a80494668cfdb787a.png
[70 6]: /images/20220528/78d70dec6bd24898917d52683571587c.png