SpringBoot参数验证

新建SpringBoot项目引入依赖

       <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

新建Bean文件

import lombok.Data;
import java.io.Serializable;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import org.hibernate.validator.constraints.Length;

/**
 * 用户
 *
 * @author Tortoise
 * @since 2019-04-16
 **/
@Data
public class User implements Serializable {
    private static final long serialVersionUID = 1L;

    @NotNull
    private Long id;

    @NotBlank
    @Length(max = 64)
    private String name;

}

新建全局返回对象

import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.Data;

import java.io.Serializable;
import java.util.Objects;

/**
 * 返回对象
 *
 * @author Tortoise
 * @since 2019-04-16
 **/
@Data
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Response<T> implements Serializable {
    private static final long serialVersionUID = 1L;

    public static final Integer SUCCESS = 200;
    public static final Integer FAILED = 500;

    /**
     * 响应代码
     */
    protected Integer code;

    /**
     * 响应消息
     */
    protected String msg;

    /**
     * 响应数据
     */
    protected T data;

    /**
     * 成功
     *
     * @param data 消息
     * @param <T>  返回数据类型
     * @return Response
     */
    public static <T> Response<T> success(T data) {
        return new Response<>(SUCCESS , "操作成功", data);
    }

    /**
     * 成功
     *
     * @param msg  消息
     * @param data 数据
     * @param <T>  返回数据类型
     * @return Response
     */
    public static <T> Response<T> success(String msg, T data) {
        return new Response<>(SUCCESS , msg, data);
    }

    /**
     * 失败
     *
     * @param code 数据
     * @param msg  消息
     * @return Response
     */
    public static <T> Response<T> failed(int code, String msg) {
        return new Response<>(code, msg, null);
    }

    /**
     * 失败
     *
     * @param code 数据
     * @param msg  消息
     * @param <T>  返回数据类型
     * @return Response
     */
    public static <T> Response<T> failed(int code, String msg,T data) {
        return new Response<>(code, msg, data);
    }

    /**
     * 判断响应结果是否成功
     *
     * @return true：成功，false：失败
     */
    public boolean isSuccess() {
        if (Objects.isNull(code)) {
            return false;
        }

        return Objects.equals(SUCCESS , code);
    }

}

新建Controller文件

import org.springframework.web.bind.annotation.*;
import javax.validation.Valid;

/**
 * 控制器
 *
 * @author Tortoise
 * @since 2019-04-16
 **/
@RestController
@RequestMapping("/users")
public class UserController {
  
    @PostMapping
    public Response<User> insert(@Valid User user) {
        return Response.success(user);
    }

}

新建异常转换类

import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.validation.Errors;
import org.springframework.validation.FieldError;
import org.springframework.validation.ObjectError;

import java.io.Serializable;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

/**
 * 全局参数校验异常信息
 *
 * @author Tortoise
 * @since 2019-04-16
 */
@Data
@NoArgsConstructor
public class ValidateErrors implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * 全局错误
     */
    private List<String> globalErrors;

    /**
     * 字段错误
     */
    private Map<String, String> fieldErrors;

    public static Builder builder() {
        return new Builder();
    }

    public static class Builder {
        private Errors errors;

        private List<String> globalErrors;

        private Map<String, String> fieldErrors;

        public Builder errors(Errors errors) {
            this.errors = errors;
            return this;
        }

        public Builder globalErrors(List<String> globalErrors) {
            this.globalErrors = globalErrors;
            return this;
        }

        public Builder fieldErrors(Map<String, String> fieldErrors) {
            this.fieldErrors = fieldErrors;
            return this;
        }

        public ValidateErrors build() {
            ValidateErrors validateErrors = new ValidateErrors();

            if (errors != null) {
                if (errors.hasGlobalErrors()) {
                    validateErrors.setGlobalErrors(new LinkedList<>());
                    for (ObjectError error : errors.getGlobalErrors()) {
                        String message = error.getDefaultMessage();
                        validateErrors.getGlobalErrors().add(message);
                    }
                }

                if (errors.hasFieldErrors()) {
                    validateErrors.setFieldErrors(new HashMap<>(errors.getFieldErrors().size()));
                    for (FieldError error : errors.getFieldErrors()) {
                        String message = error.getDefaultMessage();
                        validateErrors.getFieldErrors().put(error.getField(), message);
                    }
                }
            }

            if (fieldErrors != null) {
                validateErrors.fieldErrors = fieldErrors;
            }

            if (globalErrors != null) {
                validateErrors.globalErrors = globalErrors;
            }

            return validateErrors;
        }

    }

}

新建全局异常拦截配置

import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.BindException;
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 org.springframework.web.bind.support.WebExchangeBindException;

import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import javax.validation.Path;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;

/**
 * 异常配置
 *
 * @author Tortoise
 * @since 2019-04-16
 **/
@Slf4j
@ControllerAdvice
public class ExceptionConfig {

   
    /**
     * 对象参数验证异常
     *
     * @param e 异常
     * @return 异常信息
     */
    @ResponseBody
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public Response methodArgumentNotValidException(MethodArgumentNotValidException e) {
        return Response.failed(Response.FAILED, "对象参数验证异常",
                ValidateErrors.builder().errors(e.getBindingResult()).build());
    }

    /**
     * 参数验证异常
     *
     * @param e 异常
     * @return 异常信息
     */
    @ResponseBody
    @ExceptionHandler(value = WebExchangeBindException.class)
    public Response webExchangeBindException(WebExchangeBindException e) {
        return Response.failed(Response.FAILED, "参数验证异常",
                ValidateErrors.builder().errors(e.getBindingResult()).build());
    }

    /**
     * 参数绑定异常
     *
     * @param e 异常
     * @return 异常信息
     */
    @ResponseBody
    @ExceptionHandler(value = BindException.class)
    public Response bindException(BindException e) {
        return Response.failed(Response.FAILED, "参数绑定异常",
                ValidateErrors.builder().errors(e.getBindingResult()).build());
    }

    /**
     * 方法参数验证异常
     *
     * @param e 异常
     * @return 异常信息
     */
    @ResponseBody
    @ExceptionHandler(value = ConstraintViolationException.class)
    public Response constraintViolationException(ConstraintViolationException e) {
        Set<ConstraintViolation<?>> constraintViolations = e.getConstraintViolations();
        Map<String, String> fieldErrors = new HashMap<>(constraintViolations.size());
        for (ConstraintViolation<?> constraintViolation : constraintViolations) {
            Path propertyPath = constraintViolation.getPropertyPath();
            Iterator<Path.Node> iterator = propertyPath.iterator();
            Path.Node node = null;
            while (iterator.hasNext()) {
                node = iterator.next();
            }

            if (node != null) {
                fieldErrors.put(node.getName(), constraintViolation.getMessage());
            }
        }

        return Response.failed(Response.FAILED, "方法参数验证异常",
                ValidateErrors.builder().fieldErrors(fieldErrors).build());
    }

    /**
     * 拦截异常
     *
     * @param e 异常
     * @return 异常信息
     */
    @ResponseBody
    @ExceptionHandler(value = Exception.class)
    public Response exception(Exception e) {
        log.error(e.getMessage(), e);
        return Response.failed(Response.FAILED, e.getMessage());
    }

}
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 218,036评论 6赞 506
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 93,046评论 3赞 395
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 164,411评论 0赞 354
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,622评论 1赞 293
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,661评论 6赞 392
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,521评论 1赞 304
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 40,288评论 3赞 418
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 39,200评论 0赞 276
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,644评论 1赞 314
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,837评论 3赞 336
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,953评论 1赞 348
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,673评论 5赞 346
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 41,281评论 3赞 329
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,889评论 0赞 22
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,011评论 1赞 269
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 48,119评论 3赞 370
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,901评论 2赞 355