spring boot 接口参数校验 @PathVariable @RequestBody @RequestParam

• 一、前言
• 二、4种写法以及对应的参数校验方式

一、前言

本文主要演示常见的 Spring Boot 接口写法，以及对应的参数校验方式。

动动发财小手，关注 + 点赞 + 收藏不迷路。

二、4种写法以及对应的参数校验方式

1.Json 格式的 Post 请求

直接在 @RequestBody 后面加上 @Valid，在入参 Bean 中使用注解 @NotBlank 进行参数校验

校验失败会抛出：org.springframework.web.bind.MethodArgumentNotValidException

示例代码如下：

package com.validate.controller;

import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.hibernate.validator.constraints.NotBlank;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.Valid;


/**
 * @Author: tinker
 * @Date: 2022/03/10 14:07
 */
@Slf4j
@RestController
public class ValidateControllerDemo1 {

    @PostMapping("/user/query1")
    public String userQuery(@RequestBody @Valid User user) {
        log.info("query user process...");
        return "SUCCESS";
    }

    @Data
    public static class User {
        private long userId;
        @NotBlank(message = "name can not be blank")
        private String name;
    }

}

2.form-data 格式的 Post 请求

在 Controller 上加 @Validated，之后在 @RequestParam 前面加上 @NotBlank。

需要注意的是，@RequestParam 注解只能通过添加 @Validated 注解才可以让校验生效，添加 @Valid 不会生效。

校验失败会抛出：javax.validation.ConstraintViolationException

示例代码如下：

package com.validate.controller;

import lombok.extern.slf4j.Slf4j;
import org.hibernate.validator.constraints.NotBlank;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;


/**
 * @Author: tinker
 * @Date: 2022/03/10 14:07
 */
@Slf4j
@Validated
@RestController
public class ValidateControllerDemo2 {

    @PostMapping("/file/upload")
    public String fileUpload(@RequestParam(value = "file") MultipartFile file,
                             @NotBlank(message = "file desc can not be blank")
                             @RequestParam(value = "fileDesc") String fileDesc) {
        log.info("upload file process...");
        return "SUCCESS";
    }

}

3.@PathVariable 注解的 Get 请求

在 Controller 上加 @Validated，之后在 @PathVariable 后面加上 @Max。

需要注意的是，@PathVariable 注解只能通过添加 @Validated 注解才可以让校验生效，添加 @Valid 不会生效。

校验失败会抛出：javax.validation.ConstraintViolationException

示例代码如下：

package com.validate.controller;

import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.constraints.Max;


/**
 * @Author: tinker
 * @Date: 2022/03/10 14:07
 */
@Slf4j
@RestController
@Validated
public class ValidateControllerDemo3 {

    @GetMapping("/user/query2/{userId}")
    public String userQuery(@PathVariable(value = "userId") @Max(value = 10) int userId) {
        log.info("query user process...");
        return "SUCCESS";
    }

}

4.传 Body 的 Get 请求

重要的事情说三遍：
不建议这么写，不排除有些地方不支持 Get 请求传 Body
不建议这么写，不排除有些地方不支持 Get 请求传 Body
不建议这么写，不排除有些地方不支持 Get 请求传 Body

在入参 Bean 前面添加 @Valid

校验失败会抛出：org.springframework.validation.BindException

示例代码如下：

package com.validate.controller;

import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.hibernate.validator.constraints.NotBlank;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.Valid;


/**
 * @Author: tinker
 * @Date: 2022/03/10 14:07
 */
@Slf4j
@RestController
public class ValidateControllerDemo4 {

    @GetMapping("/user/query3")
    public String userQuery(@Valid User user) {
        log.info("query user process...");
        return "SUCCESS";
    }

    @Data
    public static class User {
        private long userId;
        @NotBlank(message = "name can not be blank")
        private String name;
    }

}