SpringBoot之@RequestParam，@PathVariable，@RequestBody注解区别

1、@RequestParam注解

主要参数如下：

String value：请求中传入参数的名称，如果不设置value值，则会默认为该变量名即参数名一致。
String name：等价与value，和value无本质上的差异，两个属性指定其一即可。
boolean required：是否必需，默认为 true，即请求中必须包含该参数，如果没有包含，将会抛出异常（可选配置）
String defaultValue：参数的默认值，如果请求中没有同名的参数时，该变量默认为此值。

注意事项：

1、如果参数前写了@RequestParam(xxx)，那么前端必须有对应的xxx名字才行(不管其是否有值，当然可以通过设置该注解的required属性来调节是否必须传)，如果没有xxx名的话，那么请求会出错，报400。如：public String test(@RequestParam(value="name") String username)
2、如果参数前不写@RequestParam(xxx)的话，那么就前端可以有可以没有对应的xxx名字才行，如果有xxx名的话，那么就会自动匹配；没有的话，请求也能正确发送。如：public String test(@RequestParam String username)

样例：

@GetMapping("/test_RequestParam")
public String test_RequestParam(@RequestParam String name){
    return name;
}

运行效果：

2、@PathVariable注解

@PathVariable注解是映射URL绑定占位符

注意参数如下：

String value：可指定占位符 { } 中的参数名，若只指定value这一个属性可省略属性名不写，若占位符中的参数名和处理方法中的参数名相同可省略此属性。
String name：等价与value，和value无本质上的差异，两个属性指定其一即可。
boolean required：是否必需，默认为 true，即请求中必须包含该参数，如果没有包含，将会抛出异常（可选配置）

样例：

@GetMapping("/test_PathVariable/{name}")
public String test_PathVariable(@PathVariable String name){
     return name;
}

运行效果：

@RequestParam和@PathVariable区别
都能够完成类似的功能——因为本质上，它们都是用户的输入，只不过输入的部分不同，一个在参数部分，另一个在URL路径部分。
@PathVariable主要用于接收http://host:port/path/{参数值}数据。
@RequestParam主要用于接收http://host:port/path?参数名=参数值数据。
@RequestParam和@PathVariable这两者之间区别不大，主要是请求的URL不一样

3、@RequestBody注解

@RequestBody用来处理不是 application/x-www-form-urlencoded 编码的内容例如:application/json application/xml
form-data、x-www-form-urlencoded：不可以用@RequestBody；可以用@RequestParam。
@RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的)；GET方式无请求体，所以使用@RequestBody接收数据时，前端不能使用GET方式提交数据，而是用POST等方式进行提交。

注意事项：
如果后端参数是一个对象，且该参数前是以@RequestBody修饰的，那么前端传递json参数时，必须满足以下要求：
后端@RequestBody注解对应的类在将HTTP的输入流(含请求体)装配到目标类(即：@RequestBody后面的类)时，会根据json字符串中的key来匹配对应实体类的属性，如果匹配一致且json中的该key对应的值符合(或可转换为)，实体类的对应属性的类型要求时,会调用实体类的setter方法将值赋给该属性。
json字符串中，如果value为""的话，后端对应属性如果是String类型的，那么接受到的就是""，如果是后端属性的类型是Integer、Double等类型，那么接收到的就是null。
json字符串中，如果value为null的话，后端对应收到的就是null。
如果某个参数没有value的话，在传json字符串给后端时，要么干脆就不把该字段写到json字符串中；要么写value时，必须有值，null 或""都行

样例：

1、参数是实体类对象

编写实体类User

package com.example.springboot.entity;

import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @author wengly
 * @date 2022-07-09 15:12:54
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
@JsonInclude(JsonInclude.Include.NON_NULL)
public class UserEntity {
    private String name;
    private int age;
}

编写controller

package com.example.springboot.controller;

import com.example.springbootdocker.entity.UserEntity;
import org.springframework.web.bind.annotation.*;

/**
 * @author wengly
 * @date 2022-07-01 16:01:08
 */
@RestController
public class TestController {

    /**
     * @author wengly
     * @date 2022-07-01 16:01:08
     * @RequestBody
     */
    @PostMapping("/test_RequestBodyUser")
    public UserEntity test_RequestBodyUser(@RequestBody UserEntity userEntity){
        return userEntity;
    }
}

运行效果：

2、参数是普通字符串

编写controller：

package com.example.springbootdocker.controller;

import com.example.springbootdocker.entity.UserEntity;
import org.springframework.web.bind.annotation.*;

/**
 * @author wengly
 * @date 2022-07-01 16:01:08
 */
@RestController
public class TestController {

    /**
     * @author wengly
     * @date 2022-07-01 16:01:08
     * @RequestBody
     */
    @PostMapping("/test_RequestBody")
    public String test_RequestBody(@RequestBody String name){
        return name;
    }

}

运行效果：

SpringBoot之@RequestParam，@PathVariable，@RequestBody注解区别

猜你喜欢