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,默 ...

随机推荐

Bzoj2780: [Spoj]8093 Sevenk Love Oimaster
题目传送门 Sol 就是广义$sam$ 然后记录下每个状态属于哪些串,开$set$维护 $parent$树上启发式合并一下就好了 # include <bits/stdc++.h& ...
PHP之httpRequest
<?php /** * Respose A Http Request * * @param string $url * @param array $post * @param string $m ...
jsp页面乱码
LintCode2016年8月22日算法比赛----骰子求和
骰子求和题目描述扔n个骰子,向上面的数字之和为 S .给定 Given n,请列出所有可能的 S 值及其相应的概率. 样例给定n=1,返回 [ [1, 0.17], [2, 0.17], [3, ...
简单使用git上传代码
1,首先在github上面创建一个仓库 2,在本地目录中右击,选择git bash 3,将github上的仓库克隆到本地目录,(这个就是您的仓库) git clone https://github.c ...
横向开关（switch）
横向开关(switch) 一:属性 1.Activity //横向开关 public class SwitchActivity extends Activity { private Switch sw ...
notepad 操作总结
1.竖向选择先把鼠标光标放在起始位置,然后同时按 Alt+Ctrl 或Alt+shift键,然后移动鼠标选取内容. Word中只能用Alt+Shift .
Python中的基础数据类型
Python中基础数据类型 1.数字整型a=12或者a=int(2),本质上各种数据类型都可看成是类,声明一个变量时候则是在实例化一个类. 整型具备的功能: class int(object): & ...
Redis(二)：c#连接Redis
1.nuget StackExchange.Redis 2.建立RedisHelper类: public class RedisHelper { /// <summary> /// 连接字 ...
基于bootstrap模态框的alert弹窗
完成的效果如下: html代码:  <div class="modal fade" id="alert_like" t ...

spring boot 输入参数统一校验

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

随机推荐

热门专题