spring boot 输入参数统一校验

1 引入spring boot validate maven 依赖

 <!-- 验证 -->

        <dependency>

            <groupId>org.hibernate.validator</groupId>

            <artifactId>hibernate-validator</artifactId>

        </dependency>

.csharpcode, .csharpcode pre
{
font-size: small;
color: black;
font-family: consolas, "Courier New", courier, monospace;
background-color: #ffffff;
/*white-space: pre;*/
}
.csharpcode pre { margin: 0em; }
.csharpcode .rem { color: #008000; }
.csharpcode .kwrd { color: #0000ff; }
.csharpcode .str { color: #006080; }
.csharpcode .op { color: #0000c0; }
.csharpcode .preproc { color: #cc6633; }
.csharpcode .asp { background-color: #ffff00; }
.csharpcode .html { color: #800000; }
.csharpcode .attr { color: #ff0000; }
.csharpcode .alt
{
background-color: #f4f4f4;
width: 100%;
margin: 0em;
}
.csharpcode .lnum { color: #606060; }

2 输入参数模型 dto
.csharpcode, .csharpcode pre
{
font-size: small;
color: black;
font-family: consolas, "Courier New", courier, monospace;
background-color: #ffffff;
/*white-space: pre;*/
}
.csharpcode pre { margin: 0em; }
.csharpcode .rem { color: #008000; }
.csharpcode .kwrd { color: #0000ff; }
.csharpcode .str { color: #006080; }
.csharpcode .op { color: #0000c0; }
.csharpcode .preproc { color: #cc6633; }
.csharpcode .asp { background-color: #ffff00; }
.csharpcode .html { color: #800000; }
.csharpcode .attr { color: #ff0000; }
.csharpcode .alt
{
background-color: #f4f4f4;
width: 100%;
margin: 0em;
}
.csharpcode .lnum { color: #606060; }

package com.example.demo.input;

import javax.validation.constraints.NotEmpty;

import javax.validation.constraints.Size;

public class AccountCreateInput {

    @Size(min=6, max=30,message = "账号名长度必须在6,30之间")

    private String loginName ;

    @NotEmpty(message = "密码不能为空")

    private String loginPwd;

    private String realName;

    public String getLoginName() {

        return loginName;

    }

    public void setLoginName(String loginName) {

        this.loginName = loginName;

    }

    public String getLoginPwd() {

        return loginPwd;

    }

    public void setLoginPwd(String loginPwd) {

        this.loginPwd = loginPwd;

    }

    public String getRealName() {

        return realName;

    }

    public void setRealName(String realName) {

        this.realName = realName;

    }

}

3 启用统一验证错误处理。当参数模型验证未通过，会抛出

MethodArgumentNotValidException  异常，统一处理即可。

package com.example.demo.config;

import com.example.demo.Infrastructure.FriendlyException;

import com.example.demo.Infrastructure.UnauthorizedException;

import com.example.demo.Infrastructure.http.ResultModel;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.validation.BindingResult;

import org.springframework.validation.FieldError;

import org.springframework.web.bind.MethodArgumentNotValidException;

import org.springframework.web.bind.annotation.ControllerAdvice;

import org.springframework.web.bind.annotation.ExceptionHandler;

import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;

@ControllerAdvice

public class GlobalExceptionHandler {

    private Logger logger = LoggerFactory.getLogger(this.getClass());

    @ExceptionHandler(value = Exception.class)

    @ResponseBody

    public ResultModel jsonErrorHandler(HttpServletRequest req, Exception e) {

        // 友好提示错误

        if (e instanceof FriendlyException) {

            logger.info(e.getMessage());

            return ResultModel.internalServerError(e.getMessage());

        }

        // 权限校验

        else if (e instanceof UnauthorizedException) {

            logger.info(e.getMessage());

            return ResultModel.Unauthorized(e.getMessage());

        }

        // 全局统一校验

        else if(e instanceof MethodArgumentNotValidException ){

            MethodArgumentNotValidException  ex = (MethodArgumentNotValidException ) e;

            BindingResult result = ex.getBindingResult();

            StringBuffer sb = new StringBuffer();

            for (FieldError error : result.getFieldErrors()) {

                String field = error.getField();

                String msg = error.getDefaultMessage();

                String message = String.format("%s:%s ", field, msg);

                sb.append(message);

            }

            return ResultModel.internalServerError(sb.toString());

        }

        // 未知异常

        else {

            logger.error(e.getMessage(), e);

            return ResultModel.internalServerError(e.toString());

        }

    }

}

4 在controller 中标注需要验证的输入参数，在CreateAccountInput 参数前，添加@validated 注解

package com.example.demo.controller;

import com.example.demo.Infrastructure.http.ResultModel;

import com.example.demo.domain.Account;

import com.example.demo.input.AccountCreateInput;

import com.example.demo.service.IAccountService;

import io.swagger.annotations.Api;

import io.swagger.annotations.ApiOperation;

import io.swagger.annotations.ApiParam;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.validation.annotation.Validated;

import org.springframework.web.bind.annotation.*;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import java.util.List;

@Api(value = "Account api", description = "api of account")

@RestController

@RequestMapping("/account")

public class AccountController {

    private Logger logger = LoggerFactory.getLogger(this.getClass());

    @Autowired

    IAccountService accountService;

    @ApiOperation(value = "account index list", notes = "账户列表信息")

    @RequestMapping(value = "/index", method = RequestMethod.GET)

    public ResultModel index() {

        List<Account> rows = this.accountService.findAll();

        return ResultModel.ok(rows);

    }

    @ApiOperation(value = "create a account", notes = "a account name")

    @RequestMapping(value = "/create", method = RequestMethod.POST)

    public ResultModel create(

            @ApiParam(name = "model", value = "input a account entity") @RequestBody @Validated AccountCreateInput model)  {

        this.accountService.Create(model);

        Account entity = this.accountService.findAccountByName(model.getLoginName());

        return ResultModel.ok(entity);

    }

    @ApiOperation(value = "find account by name", notes = "根据登录名查找账户")

    @RequestMapping(value = "/query", method = RequestMethod.GET)

    public ResultModel query(@RequestParam String name)  {

        this.logger.info(String.format("url:/account/query?name=%s ",name));

        List<Account> rows = this.accountService.findAllByName(name);

        return ResultModel.ok(rows);

    }

}

5 最后swagger 请求时结果：

请求参数，密码不填

响应结果：

spring boot 输入参数统一校验的更多相关文章

spring boot validation参数校验
对于任何一个应用而言在客户端做的数据有效性验证都不是安全有效的,这时候就要求我们在开发的时候在服务端也对数据的有效性进行验证. Spring Boot自身对数据在服务端的校验有一个比较好的支持,它能将 ...
Kotlin + Spring Boot 请求参数验证
编写 Web 应用程序的时候,经常要做的事就是要对前端传回的数据进行简单的验证,比如是否非空.字符长度是否满足要求,邮箱格式是否正确等等.在 Spring Boot 中,可以使用 Bean Valid ...
Spring boot 配置文件参数映射到配置类属性
[参考文章]:SpringBoot之@EnableConfigurationProperties分析 [参考文章]:在Spring Boot中使用 @ConfigurationProperties 注 ...
spring Boot使用AOP统一处理Web请求日志记录
1.使用spring boot实现一个拦截器 1.引入依赖: <dependency> <groupId>org.springframework.boot</grou ...
前端参数统一校验工具类ValidParamUtils
1,前端参数不可信,对于后端开发人员来说应该是一条铁律,所以对于前端参数的校验,必不可少,而统一的前端参数校验工具,对我们进行参数校验起到事半功倍的效果 2,统一参数校验工具ValidParamUti ...
spring boot 2 全局统一返回RESTful风格数据、统一异常处理
全局统一返回RESTful风格数据,主要是实现ResponseBodyAdvice接口的方法,对返回值在输出之前进行修改.使用注解@RestControllerAdvice拦截异常并统一处理. 开发环 ...
Spring Boot 构造器参数绑定，越来越强大了！
在之前的文章:Spring Boot读取配置的几种方式,我介绍到 Spring Boot 中基于 Java Bean 的参数绑定,在一个 Java Bean 类上用 @ConfigurationPro ...
spring boot 拦截异常统一处理
spring boot 默认情况下会映射到 /error 进行异常处理,提示不友好,需要自定义异常处理,提供友好展示 1.自定义异常类(spring 对于 RuntimeException 异常才会进 ...
spring boot datasource 参数设置
datasource spring.dao.exceptiontranslation.enabled是否开启PersistenceExceptionTranslationPostProcessor,默 ...

随机推荐

Java：类加载器（ClassLoader）
听上去很高端,其实一般自定义类加载器不需要用户去实现解析的过程,只要负责实现获取类对应的.class字节流部分就ok了,摘录深入理解Java虚拟机的一段话虚拟机设计团队把类加载阶段中的“通过一个类的 ...
思维导图_Python_内置函数
自定义scoll样式
使用伪类自定义scroll样式效果: 代码: <!DOCTYPE html> <html> <head> <meta charset="utf-8 ...
面向对象第四章(封装、static)
1.package: 1)作用:避免类名的冲突 2)包名可以有层次结构 3)类的全称: 包名.类名,同包中的类不能同名 4)建议:包名所有字母都小写 import: 1)同包中的类可以直接访问, 不同 ...
vue项目使用vue-i18n和iView切换多语言
效果图: 当然,如果使用iview组件,组件也会对应切换语言. 这里,假设已经用vue-cli脚手架创建了项目,熟悉vue-router,而且已经引入了iview UI. 第一步: 我们在main.j ...
【html/css】模态框的实现
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title> ...
css预处理器（sass）
学过CSS的人都知道,它不是一种编程语言.你可以用它开发网页样式,但是没法用它编程.也就是说,CSS基本上是设计师的工具,不是程序员的工具.在程序员眼里,CSS是一件很麻烦的东西.它没有变量,也没有条 ...
How to safely downgrade or remove glibc with yum and rpm
Environment Red Hat Enterprise Linux 5 Red Hat Enterprise Linux 6 glibc, glibc-common, glibc-devel, ...
hibernate简单入门教程（一）---------基本配置
应用级别所以很粗浅首先介绍一下hibernate框架: 1.优秀的持久化(通俗讲把内存上的短时间运行信息存储在持久化硬盘上)框架. 2.作用于持久层,因为没什么侵入性,所以同样适用于其他层面上的存储 ...
微软在WPC 2015中为“伙伴们”带来了什么？
在微软 WPC 2015(微软全球合作伙伴大会)上,微软全球渠道总监 Phil Sorgen 指出,微软总营收的 92% 来自合作伙伴.这句话验证了微软与合作伙伴间日益紧密的合作关系,也点出了本次大会 ...

spring boot 输入参数统一校验

spring boot 输入参数统一校验的更多相关文章

随机推荐

热门专题