SpringBoot接收参数的几种常用方式

叁歲伎倆 2024-04-07 15:55 11阅读 0赞

#### 目录 ####

*   *  一、四种传参方式
     *  二、无注解
     *  三、@RequestParam
     *  四、@PathVariable
     *  五、@RequestBody
     *  六、@RequestHeader
     *  七、HttpServletRequest

如果对@RequestMapping不是特别了解的，建议读一下这篇文章： [https://blog.csdn.net/weixin\_43888891/article/details/126861310][https_blog.csdn.net_weixin_43888891_article_details_126861310]

> 参数映射准确来说是springmvc来帮我们干的活，但是由于springboot太过火爆，简化了springmvc相关配置文件，以至于很多人会误认为是springboot的功能。其实springboot是帮我们整合了spring相关框架。记住只是简化，底层还是不变的！

### 一、四种传参方式 ###

**在学习接收参数前，肯定要先了解一共有几种传参方式，下面一共提供了四种，供参考学习：**

1）params传参，params传参的格式是`http://xxx?参数名=值&参数名=值`。在postman当中params当中添加参数会发现，他就是在地址栏上加的参数。

![在这里插入图片描述][e63139a136c741be81de19dd043f7ff1.png]

2）body表单传参，就是请求体传参

> form-data的请求是在body中，为key=value格式，同时可以传文件，Content-Type为multipart/form-data，后端可以用@RequestParam接收。

![在这里插入图片描述][812b20e741144c7bad018c9864eb1a34.png]

3）json传参

> json传参也是在body当中，只不过json是一种数据格式，后端可以用@RequestBody接收。

![在这里插入图片描述][66fa16474c804f1f8f699dd5ec05a4f9.png]

4）地址栏传参，直接通过/在地址上拼接参数值，这种方式不需要在地址栏上写参数名，后端只需要知道他在地址的哪个位置传的参数就可以拿到值！

![在这里插入图片描述][01f0dd698cbc4478887bf1932a8bbff5.png]

**这两个实体类用来当做测试类，用来接参数，后续我们会不断的使用到他：**

public class Params {
        
        private String userName;
        private Integer age;
    
        public String getUserName() {
        
            return userName;
        }
    
        public void setUserName(String userName) {
        
            this.userName = userName;
        }
    
        public Integer getAge() {
        
            return age;
        }
    
        public void setAge(Integer age) {
        
            this.age = age;
        }
    
        @Override
        public String toString() {
        
            return "Param{" +
                    "userName='" + userName + '\'' +
                    ", age=" + age +
                    '}';
        }
    }

public class User {
        
        private String userName;
    
        @Override
        public String toString() {
        
            return "User{" +
                    "userName='" + userName + '\'' +
                    '}';
        }
    
        public String getUserName() {
        
            return userName;
        }
    
        public void setUserName(String userName) {
        
            this.userName = userName;
        }
    }

### 二、无注解 ###

import com.gzl.cn.demo.entity.Params;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @RequestMapping("/noAnno")
    public class NoAnnoController {
        
    
        @GetMapping("/url")
        public String getMapping(String msg) {
        
            return msg;
        }
    	
    	// 可以有多个实体类参数
        @GetMapping("/body")
        public String getMapping(Params param,User user) {
        
        	System.out.println(param);
            System.out.println(user);
            return param.toString();
        }
    
        @PostMapping("/post")
        public String postMapping(String msg) {
        
            return msg;
        }
    
        @PostMapping("/post-body")
        public String postMapping(Params msg) {
        
            return msg.toString();
        }
    
    }

**以下是测试的详细步骤：**

**（1）测试无注解params传参**

**测试：get请求：**

[http://localhost:8080/noAnno/url?msg=111][http_localhost_8080_noAnno_url_msg_111]  
[http://localhost:8080/noAnno/body?userName=张三&age=11][http_localhost_8080_noAnno_body_userName_age_11]  
![在这里插入图片描述][f0ec9ee79eb643ae87f0ead2746597d5.png]

**测试：post请求：post请求我们无法通过浏览器来访问，得需要借助postman调用**

[http://localhost:8080/noAnno/post?msg=111][http_localhost_8080_noAnno_post_msg_111]  
[http://localhost:8080/noAnno/post-body?userName=张三&age=22][http_localhost_8080_noAnno_post-body_userName_age_22]

> 当然也可以借用cmd框当中的curl命令来请求post  
> `curl http://localhost:8080/noAnno/post-body -X POST -d "userName=66&age=22"`

![在这里插入图片描述][1b1579d8c8da479e9757465173f64a04.png]

**（2）测试无注解body表单传参**

![在这里插入图片描述][9b8ca226078346749d7f4ed2f952985a.png]

**（3）测试无注解params传参+body表单传参 两种同时传参**

![在这里插入图片描述][1e8a06bc58884c3da0473a732d2976bd.png]

**总结：**

1.  没有注解的时候可以选择`params传参`也可以选择`body表单传参`，甚至可以两种同时传，两种同时传会将body传的参数使用`逗号`拼接上params传的参数
2.  不管是body还是params 在不传参的情况下都不会报错，`在后端会拿到null值`，这块需要注意一下！假如是null值的情况下去get属性，或者是tostring就会空指针！如果传参的话，参数名要和controller当中定义的`变量名一样`才能接受到参数！`任意请求方式` 都是一样的！
3.  可以有多个参数的，如果是实体类接参数的话，也是可以有多个实体类的！就算两个实体类当中有参数重复了，也不影响，两个实体类都会接到参数的！

### 三、@RequestParam ###

http://localhost:8089/conformity/parm/requestParm8?uid=1&uname=222&pwd=2222

就是在地址？然后加上&拼接。

不携带`@RequestParm`的时候，可以连key值都不传。

@GetMapping("/requestParm")
    public void requestParm(Integer id){
        
    	System.out.println("get不带@RequestParam:"+id);
    }

携带`@RequestParm`的时候，必须传值。因为`@RequestParam注解的required默认是true`。假如不传会报错。

@GetMapping("/requestParm1")
    public void requestParm1(@RequestParam Integer id){
        
    	System.out.println("get带@RequestParam:"+id);
    }

*  `@RequestParam`接收参数，不可使用使用实体来封装，如下所示，直接会报400错误。
 *  不带`@RequstParm`然后使用实体来接参数，其实是没问题的，并且不传key值也是可以的。post、get都一样。

// 错误的
    @PostMapping("/requestParm7")
    public void requestParm7(@RequestParam User user){
        
    	System.out.println("get带@RequestParam:"+user);
    }

`@RequestParam`参数映射：注意@RequestParam默认是以变量名作为前端传参名称，但是假如我们注解设置了名称，如下，那么参数名称以注解当中的属性为准！假如前端传msg而不是msg1就会报异常。

@GetMapping("/url")
    public String getMapping(@RequestParam("msg1") String msg) {
        
        System.out.println(msg);
        System.out.println(aaa);
        return msg;
    }

**总结：**

1、传单个参数的时候可以使用@RequestParam，不带也可以，带上就意味着前端必须传这个值。

2、实体接受参数的话，不可以带，带上就会报错。不带的话是可以接受多个参数的。并且没有key限制。

**@RequestParam的属性**

*  `value`和`name`属性使用了`@AliasFor`，在spring当中起着一个注解属性别名传递值的作用。也就是我给value属性赋值，name属性同样也能取到值，name属性赋值，value属性也同样可以取到值。  
    `@RequestParam(value = "msg")`等同于`@RequestParam("msg")`，因为注解当中不带属性名称默认指的就是value属性，而`@RequestParam("msg")`等同于`@RequestParam(name = "msg")`。
 *  `required`属性代表的是否是必填，默认是true，这个true代表的是前端必须传key值，value值可以随意，但是key值是必须的。假如不传就是400异常！
 *  `defaultValue`属性：设置默认值，可以避免`required`属性设置为true然后前端不传key值报错的问题。相当于设置defaultValue属性之后，前端传不传值都可以，传值就以前端的为准，不传值就以设置的defaultValue值为准！示例如下：  
    `@RequestParam(name = "pageNo",required = false,defaultValue = "1") Integer pageNo`

@Target(ElementType.PARAMETER)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface RequestParam {
        
    
    	@AliasFor("name")
    	String value() default "";
    
    	@AliasFor("value")
    	String name() default "";
    
    	boolean required() default true;
    
    	String defaultValue() default ValueConstants.DEFAULT_NONE;
    }

### 四、@PathVariable ###

`@PathVariable` 用于绑定 url 中的占位符。例如：请求 url 中 `/delete/{id}`，这个`{id}`就是 url 占位符。url 支持占位符是 spring3.0 之后加入的。是 springmvc 支持 rest 风格 URL 的一个重要标志。

@RequestMapping("/pathVariable2/{id}")
    public void pathVariable2(@PathVariable Integer id){
        
    	System.out.println("get带@RequestParam:"+id);
    }

上面代码示例使用了地址栏传参，就算不带@PathVariable也可以访问，只不过接不到值。

**@PathVariable 的属性**

@Target(ElementType.PARAMETER)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface PathVariable {
        
    
    	@AliasFor("name")
    	String value() default "";
    
    	@AliasFor("value")
    	String name() default "";
    
    	boolean required() default true;
    
    }

**总结：**

*  如果@PathVariable不设置属性值，默认的话，只要参数名称和占位符当中的名称一致就可以，如果名称不一致就会报错
 *  一旦设置属性值了，就一定要和占位符当中的一致，否则就会报错！

![在这里插入图片描述][f9d1ced97c8b47aaabf848403715e1a3.png]

### 五、@RequestBody ###

@RequestBody一般被用来接收http请求中body中json数据。

get、post都可以使用。一般用于post。

@RequestMapping("/requestBody2")
    public void requestBody2(@RequestBody Params params){
        
        System.out.println("get带@RequestParam:"+params);
    }

`{"userName":"111","age":"11"}`，传输json数据，也可以不传key。这里有一点需要注意，mvc给我们做了参数类型转换，Params 对象当中的age是Integer类型，但是json传字符串，照样可以映射进去。`Boolean、BigDecimal、Integer、String、Date`这些其实都可以映射进去的。当然Date相对来说比较特殊一点。传`yyyy-MM-dd`格式是不会报错的。但是其他格式可能就会报错了，一般使用Date类型接参数涉及到需要咱们自己格式化，关于日期相关问题感兴趣的可以看这一篇文章：[https://blog.csdn.net/weixin\_43888891/article/details/126846791][https_blog.csdn.net_weixin_43888891_article_details_126846791]

**@RequestBody 的属性**

@Target(ElementType.PARAMETER)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface RequestBody {
        
    
    	boolean required() default true;
    
    }

*  required默认为true，代表的就是json不能什么都不传，否则报错400，但是允许个别属性不传。
 *  设置为false的话就是可以什么都不传。

### 六、@RequestHeader ###

@RequestHeader主要用来获取请求当中的请求头

@RestController
    @RequestMapping("/requestHeader")
    public class RequestHeaderController {
        
        
        @PostMapping("/header")
        public String getMapping(@RequestHeader("param")String param){
        
            return param;
        }
    }

我们通过header进行参数传递，同样它可以设置是否必传，默认值等，请大家自行翻阅源码，就不一一罗列了。

![在这里插入图片描述][ee13c89c82eb4cf099f56b4f063fb7a9.png]

### 七、HttpServletRequest ###

这是直接拿到request对象，通过request可以从对象中灵活的获取参数:

@RestController
    @RequestMapping("/request")
    public class HttpServletRequestController {
        
    
        @GetMapping("/getUrlValue")
        public String getUrlValue(HttpServletRequest request) {
        
            // 没有的时候不会报错，直接为null
            String msg = request.getParameter("msg");
            System.out.println(msg);
            return msg;
        }
    
        @GetMapping("/getUrlValues")
        public String getHttpServletRequestValue(HttpServletRequest request) {
        
            Map<String, String[]> parameterMap = request.getParameterMap();
            return JSONObject.toJSONString(request.getParameterMap());;
        }
    }

> 针对于`request.getParameter("msg");`，其实就是跟@RequestParam差不多，可以获取到body当中的`for-data`的数据以及使用`url ？`拼接的参数的数据

[http://localhost:8080/request/getUrlValue][http_localhost_8080_request_getUrlValue]

[https_blog.csdn.net_weixin_43888891_article_details_126861310]: https://blog.csdn.net/weixin_43888891/article/details/126861310
[e63139a136c741be81de19dd043f7ff1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/14eb04b08a4b4aa98a7b748ba6dba522.png
[812b20e741144c7bad018c9864eb1a34.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/91e64b57514a415c80b505b9aa37378a.png
[66fa16474c804f1f8f699dd5ec05a4f9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/1525ffff6997488e811d98a6d96d66c3.png
[01f0dd698cbc4478887bf1932a8bbff5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/937a557a301649788d7fb23a8868777a.png
[http_localhost_8080_noAnno_url_msg_111]: http://localhost:8080/noAnno/url?msg=111
[http_localhost_8080_noAnno_body_userName_age_11]: http://localhost:8080/noAnno/body?userName=%E5%BC%A0%E4%B8%89&age=11
[f0ec9ee79eb643ae87f0ead2746597d5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/1b8160b2bd874badaa0b9a30930a5de0.png
[http_localhost_8080_noAnno_post_msg_111]: http://localhost:8080/noAnno/post?msg=111
[http_localhost_8080_noAnno_post-body_userName_age_22]: http://localhost:8080/noAnno/post-body?userName=%E5%BC%A0%E4%B8%89&age=22
[1b1579d8c8da479e9757465173f64a04.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/d1626d2736d545d2bc2d4cff0eee4c0b.png
[9b8ca226078346749d7f4ed2f952985a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/98bb1233dd5a427c8e0340f41e64b48f.png
[1e8a06bc58884c3da0473a732d2976bd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/62345db935a247d097ceb8629f4c56a9.png
[f9d1ced97c8b47aaabf848403715e1a3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/3fea40bbd84b4a29a16c2e84ac722495.png
[https_blog.csdn.net_weixin_43888891_article_details_126846791]: https://blog.csdn.net/weixin_43888891/article/details/126846791
[ee13c89c82eb4cf099f56b4f063fb7a9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/537ace72fcc24533aee86d0e6cc49192.png
[http_localhost_8080_request_getUrlValue]: http://localhost:8080/request/getUrlValue