SpringBoot参数验证(前后端分离设计)

本文的框架使用的是SpringBoot1.5

1.前端表单层

代码中的 @Getter@Setter@ToString 是使用的 lombok 用于替代传统的 settergettertoString方法。

@Getter
@Setter
@ToString
public class UserFormVo {
    /**
     * 用户id,修改用户时是必填项。增加用户时不能传输
     */
    @NotNull(groups = Update.class, message = "用户Id不能为空")
    @Null(groups = Add.class, message = "不能传输用户Id")
    private Long id;

    /**
     * 用户名
     */
    @NotEmpty(groups = Add.class, message = "用户名不能为空")
//    @Null(groups = Update.class, message = "不能修改用户名")
    @Size(min = 5, max = 20, message = "用户名个数必须为5-20位")
    private String name;

    /**
     * 密码。新增用户时不能为空。修改用户时不能修改用户密码
     */
    @NotNull(groups = Add.class, message = "密码不能为空")
    @Null(groups = Update.class, message = "不能修改用户密码")
    private String password;

    /**
     * 用户状态。0禁用,1启用
     */
    @NotNull(group = Add.class, message = "状态不能为空")
    @Range(min = 0, max = 1, message = "状态值不正确")
    private Integer status;

    /**
     * 继承Default类,可以在不指定@Validated的group时,使用所有默认校验方式。
     */
    public interface Add extends Default {
    }

    public interface Update extends Default {
    }
}

2.controller层

校验操作是使用 @Validated 来实现的,通过里面指定的 class 文件来使用不同的注解分组

@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    private UserService userService;

    /**
     * 新增用户
     * @Validated 中指定了校验分组,当校验注解中有对应的class时,才会使用对应的校验方式。由于Add.class继承了Default,所以没有指定分组的校验方式也会进行调用
     * controller方法可以再添加一个BindingResult 来接收校验结果,当前后端分离时,因为我们要直接把错误返回前端,所以要直接获取BindingResult中的报错信息。
     * @Return Response是自定义的返回类型。用于同一返回的格式
     */
    @PostMapping("/add")
    public Response addUser(@Validated(UserFormVo.Add.class) @RequestBody UserFormVo formVo) {
        userService.saveUser(formVo);
        return Response.success();
    }

    /**
     * 修改用户
     */
    @PostMapping("/modify")
    public Response updateUser(@Validated(UserFormVo.Update.class) @RequestBody UserFormVo formVo) {
        userService.updateUser(formVo);
        return Response.success();
    }
}

3.GlobalExceptionHandler

当前后端进行分离设计时,不推荐使用BindingResult来接收校验结果,controller的方法中不需要添加BindingResult参数。我改用使用GlobalExceptionHandler来处理错误信息。

controller的方法中指定了@Validated,又没有添加BindingResult参数时,如果参数没有通过校验,就会直接抛出异常,抛出的异常,可以通过使用了@ControllerAdvice的 类进行捕获。

@RestController
@ControllerAdvice
public class GlobalExceptionHandler {

    /**
     * 用于处理参数校验错误
     * @Validated校验失败时会抛出MethodArgumentNotValidException异常
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Response methodArgumentValidExceptionHandler(MethodArgumentNotValidException e) throws Exception {
        String code = "200001";
        String message = null;
        //如果抛出了异常,这个getErrorCount一定会>0
        if (e.getBindingResult().getErrorCount() > 0) {
            //校验会把所有不通过的选项的错误信息记录下来,现在先默认给前端提供第一个错误信息
            message = e.getBindingResult().getAllErrors().get(0).getDefaultMessage();
        }
        return new Response(code, message);
    }
    
    //...其他捕获全局异常的代码
    
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,451评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,172评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,782评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,709评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,733评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,578评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,320评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,241评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,686评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,878评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,992评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,715评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,336评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,912评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,040评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,173评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,947评论 2 355

推荐阅读更多精彩内容