Spring Boot 实现后端进行参数校验

傷城~ 2022-11-15 15:51 208阅读 0赞

### 1 pom.xml(Maven依赖文件) ###

<dependency>
                <groupId>javax.validation</groupId>
                <artifactId>validation-api</artifactId>
                <version>2.0.1.Final</version>
            </dependency>
            
            <dependency>
                <groupId>org.hibernate.validator</groupId>
                <artifactId>hibernate-validator</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>

### 2 Entity(实体类) ###

User.java：

package com.entity;
    
    import javax.validation.constraints.NotBlank;
    import javax.validation.constraints.NotNull;
    import lombok.Data;
    import org.springframework.stereotype.Component;
    
    @Component
    @Data
    public class User {
        /**
         * 用户名(登录)
         */
        @NotNull(message = "没有用户名参数")
        @NotBlank(message = "用户名不能为空")
        private String username;
        /**
         * 密码
         */
        private String password;
    }

### 3 Controller(接口层) ###

LoginUser.java：

package com.controller;
    
    import com.entity.User;
    import io.swagger.annotations.ApiImplicitParam;
    import io.swagger.annotations.ApiImplicitParams;
    import org.springframework.validation.BindingResult;
    import org.springframework.validation.FieldError;
    import org.springframework.validation.annotation.Validated;
    import org.springframework.web.bind.annotation.*;
    
    @RestController
    @RequestMapping("/")
    public class LoginController {
    
        /**
         * 登录
         *
         * @param user 登录信息
         * @return
         */
        @PostMapping("/login")
        @ApiImplicitParams({
                @ApiImplicitParam(name = "username", value = "用户名"),
                @ApiImplicitParam(name = "password", value = "密码")
        })
        public String login(@Validated @RequestBody User user, BindingResult bindingResult) {
            //校验不通过
            if (bindingResult.hasErrors()) {
                FieldError fieldError = (FieldError) bindingResult.getAllErrors().get(0);
                return fieldError.getDefaultMessage();
            }
            return "校验通过";
        }
    }

### 4 调试结果 ###

NotNull校验：

![20210402134959776.png][]![20210402135008485.png][]

NotBlank校验：

![20210402135132164.png][]![20210402135141865.png][]

注：更多校验注解请查看以下博客。

[ Java 4种校验注解（值校验、范围校验、长度校验、格式校验）][Java 4]

[20210402134959776.png]: https://img-blog.csdnimg.cn/20210402134959776.png
[20210402135008485.png]: /images/20221022/3645db9ce3c14916a0fa235ff6d84be8.png
[20210402135132164.png]: https://img-blog.csdnimg.cn/20210402135132164.png
[20210402135141865.png]: /images/20221022/da3c3ec657e84286990329430903983d.png
[Java 4]: https://blog.csdn.net/qq_38974638/article/details/115396937