Spring Boot (Spring MVC)中Controller层入参说明

备注：新版本的Spring MVC也支持该方案。

问题描述

使用Spring Boot进行项目开发，想必大多都属于前后端分离项目。因此，我们讨论在这种场景下，前端如何传参，后端如何接受参数。

请求路径参数（参数在URL上）

@PathVariable：获取路径参数。 url/{id}这种形式

这种风格的api接口一般类似于取id为多少的新闻、文字等。
在url中输入:localhost:8080/**/?name=hk
请求中包含name参数（如/xx?name=hk），则自动传入。
接下来我们看一下@RequestParam注解主要有哪些参数：
value：参数名字，即入参的请求参数名字，如username表示请求的参数区中的名字为username的参数的值将传入；
required：是否必须，默认是true，表示请求中一定要有相应的参数，否则将报404错误码；
defaultValue：默认值，表示如果请求中没有同名参数时的默认值，默认值可以是SpEL表达式，如“#{systemProperties[‘java.vm.version’]}”。

表示请求中可以没有名字name的参数，如果没有默认为null，此处需要注意如下几点：

@GetMapping("/queryByName")
    public String queryByName(@RequestParam(value = "name" ,required = true) String name,
                              @RequestParam(value = "num")int num) {
        return name+" :"+ num;
    }

num因为默认是true，如果不传，则报404，如下：

{
    "timestamp": "2019-04-04T01:23:32.233+0000",
    "status": 400,
    "error": "Bad Request",
    "message": "Required int parameter 'num' is not present",
    "path": "/news/queryByName"
}

原子类型：必须有值，否则抛出异常，如果允许空值请使用包装类代替,如下

@GetMapping("/queryByName")
    public String queryByName(@RequestParam(value = "name" ,required = true) String name,
                              @RequestParam(value = "num",required = false)int num) {
        return name+" :"+ num;
    }

入参为：

http://localhost:8080/news/queryByName?name=hello

返回值为：

{
    "timestamp": "2019-04-04T01:25:50.016+0000",
    "status": 500,
    "error": "Internal Server Error",
    "message": "Optional int parameter 'num' is present but cannot be translated into a null value due
     to being declared as a primitive type. Consider declaring it as object wrapper for the corresponding primitive type.",
    "path": "/news/queryByName"
}

如果将上面的int类型改为对应包装类型Integer，那么请求则不会报错，不传入参数时，num为null。
Boolean包装类型类型：默认Boolean.FALSE，其他引用类型默认为null。
如果入参为：

http://localhost:8080/news/queryByName?name=zhangsan&name=lisi

那么实际接收时name将为“zhang,san”。
在实际中需要按数组类型传参时，可以使用如下方式：

@GetMapping("/queryByNames")
   public String queryByNames(@RequestParam(value = "name" ,required = true) String[] name) {
       return name.toString();
   }

或者

@GetMapping("/queryByNames")
    public String queryByNames(@RequestParam(value = "name" ,required = true) List<String> name) {
        return name.toString();
    }

前端传参
在这里插入图片描述
后端接受参数

@GetMapping("/query/{id}")
    public String query(@PathVariable(name = "id") String id) {
        return id;
    }

带占位符的 URL 是 Spring3.0 新增的功能，该功能在SpringMVC 向 REST 目标挺进发展过程中具有里程碑的意义

通过 @PathVariable 可以将 URL 中占位符参数绑定到控制器处理方法的入参中：URL 中的 {xxx} 占位符可以通过@PathVariable(“xxx“) 绑定到操作方法的入参中。

@RequestParam

获取查询参数。即为url?name=lofge

前端传参
在这里插入图片描述
后端接受参数

@GetMapping("/queryByName")
    public String queryByName(@RequestParam(value = "name" ,required = true) String name) {
        return name;
    }

Body参数

注解的

@RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的);
GET方式无请求体，所以使用@RequestBody接收数据时，前端不能使用GET方式提交数据，而是用POST方式进行提交。
在后端的同一个接收方法里，@RequestBody 与@RequestParam()可以同时使用，@RequestBody最多只能有一个，而@RequestParam()可以有多个。

注:一个请求，只有一个RequestBody;一个请求，可以有多个RequestParam
注:当同时使用@RequestParam（）和@RequestBody时，@RequestParam（）指定的参数可以是普通元素、数组、集合、对象等等(即:当，@RequestBody 与@RequestParam()可以同时使用时，原SpringMVC接收参数的机制不变，只不过RequestBody 接收的是请求体里面的数据；而RequestParam接收的是key-value里面的参数，所以它会被切面进行处理从而可以用普通元素、数组、集合、对象等接收)。

即:如果参数时放在请求体中，传入后台的话，那么后台要用@RequestBody才能接收到;如果不是放在请求体中的话，那么后台接收前台传过来的参数时，要用@RequestParam（）来接收，或则形参前什么也不写也能接收。
注:如果参数前写了@RequestParam(xxx)，那么前端必须有对应的xxx名字才行(不管其是否有值)，如果没有xxx名的话，那么请求会出错，报400。
注:如果参数前不写@RequestParam(xxx)的话，那么就前端可以有可以没有对应的xxx名字才行，如果有xxx名的话，那么就会自动匹配；没有的话，请求也能正确发送。

注:如果后端参数是一个对象，且该参数前是以@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 或"“都行。千万不能有类似"stature”:,这样的写法
** 前端入参**

后端接受参数

@PostMapping("/addUser")
    public String addUser(@RequestBody User user) {
        return user.toString();
    }

无注解的

@PostMapping("/addUser")
    public String addUser(User user) {
        return user.toString();
    }

此处需要form-data类型的（在前后端分离模式下，不推荐使用这种方式）

在这里插入图片描述
文件的上传

public void uploadAdvertisement(HttpServletRequest request, HttpServletResponse response, MultipartFile file) throws IOException {
        startTime = System.currentTimeMillis();
        String api = "upload/advertisement";
        AdvertisementDTO advertisementDTO = (AdvertisementDTO) initApiControllerAndgetParameter(request, response, api, AdvertisementDTO.class);
        if (MySessionContext.isAdmin(advertisementDTO.getSessionId())) {
            //文件的扩展名
            String originalFilename = file.getOriginalFilename();
            String extName = originalFilename.substring(originalFilename.lastIndexOf(".") + 1);
            SimpleDateFormat sdf = new SimpleDateFormat("yyyyMMddHHmmssSS");
            String res = sdf.format(new Date());
            ...............

入参形式
在这里插入图片描述

参考文献

[^1]@RequestParam详解
[^2 ]@RequestBody的使用