Java开发中业务层入参校验详细解析

Wesley13
• 阅读 413

Java开发中业务层入参校验详细解析

背景

首先,我们达成以下共识:

  • 一个服务方法,如果入参太多,且基本为非pojo,会给调用方造成不必要的干扰。尽管可以把文档写的很完善,但还是建议使用pojo对多个参数合理封装。
    如下示例:

    @Data public class UserVo { private String username; private Integer age; private List hobby; }

  • 执行方法都应该对入参进行校验。对于一些通用的简单的不涉及业务逻辑的校验,比如字符串不为空,数字的范围限制,我们没必要将校验代码写在方法内部。如下示例

    @Service public class UserService {

    public void addUser(UserVo userVo) {
        // 参数基本校验
        if (StringUtils.isEmpty(userVo.getUsername())
                || userVo.getAge() < 0
                || userVo.getAge() > 200
                || CollectionUtils.isEmpty(userVo.getHobby())) {
            throw new IllegalArgumentException();
        }
        
        // 业务逻辑操作
    }
    

    }

  • 我们的项目采用了spring框架,这是标配,且service bean是要被调用的。

实现思路

有了上述共识之后,我们来开始实现一点想法:结合Spring的切面用法,能够很方便的拿到切点的方法入参,然后可以进行参数校验。

比较常见的一种方式是:使用Java bean注解校验。大致用法就是:在pojo加上相应的校验注解,然后在切面中利用hibernate-validator进行校验。这种方式springmvc已经帮我们实现了,而且使用效果不错。

@Data
public class UserVo {

    @NotEmpty
    private String       username;
    
    @Max(value = 200)
    @Min(value = 1)
    private Integer      age;
    
    @NotEmpty
    private List<String> hobby;
}

前面提到,暴露的方法尽量简洁易用,不要造成太多的干扰。pojo的属性应该保持简洁,加上必要的注释。

我们原本的想法就是,利用切面把方法中大量类似的简单的校验逻辑抽离出来,在切面中执行校验的过程。不同pojo有不同的属性,那么校验逻辑还是会存在不同,如果不使用注解校验,在切面中拿到了不同的pojo,可能会写很多的 instance of判断,当然也可以利用设计模式实现的很好。总之,我们确实把service方法中的校验抽离出来了。

铺垫了这么多,我们为什么不可以把校验逻辑放进对应的pojo中呢?这样,调用方也能够清晰地看到基本的校验逻辑,其调用前也可以调用校验方法检查参数的合法性。

具体实现

1. 定义pojo要实现的校验接口

public interface ValidationHandler {
    /**
     * 校验pojo的属性
     *
     * @return 通过/不通过
     */
    boolean isValid();
}

2. pojo实现接口ValidationHandler,编写校验逻辑

@Data
public class UserVo implements ValidationHandler {

    private String       username;
    private Integer      age;
    private List<String> hobby;

    @Override
    public boolean isValid() {
        return StringUtils.isNotEmpty(username)
                && age > 0
                && age < 100
                && !hobby.isEmpty();
    }
}

3. 切面

  • 此处切点使用注解:

    @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface ParamValidation { }

  • 在service中使用

    @Service public class UserService {

    @ParamValidation
    public void addUser(UserVo userVo) {
    
        // 业务逻辑操作
    }
    

    }

  • 具体切面代码

    @Component @Aspect public class ParamValidator {

    @Pointcut("@annotation(com.ex.validator.ParamValidation)")
    public void validate() { }
    
    @Before("validate()")
    public void before(JoinPoint joinPoint) {
        for (Object arg : joinPoint.getArgs()) {
            if (arg instanceof ValidationHandler) {
                if (!((ValidationHandler) arg).isValid()) {
                    throw new IllegalArgumentException("参数校验不通过");
                }
            }
        }
    }
    

    }

4. 调用结果

自行写方法调用,能够正常执行到aop校验

升级版

本来写到这里就结束了,偶然发现了一个彩蛋,于是有了升级版。

我们看一下bean validation的标准注解@javax.validation.constraints.AssertTrue,这个注解要求bean的属性为true,除了放在属性上,也可以放在get/is方法上。经过测试,==可以放在自定义方法上,该方法名需以isget开头==。

说到底,我们就干了一件事:把校验逻辑放进对应的pojo。其实上面的实现都是没必要的,既然都用上了,就不重复造轮子了。把自定义接口和切面都去掉,UserVo可以变成如下:

@Data
public class UserVo {

    private String       username;
    private Integer      age;
    private List<String> hobby;

    @AssertTrue
    public boolean isValid() {
        return StringUtils.isNotEmpty(username)
                && age > 0
                && age < 100
                && !hobby.isEmpty();
    }
}

service方法就变成了:

@Validated //打开校验开关
@Service
public class UserService {

    // 入参pojo添加@Valid
    public void addUser(@Valid UserVo userVo) {

        // 业务逻辑操作
    }
}

是不是很熟悉呢?校验效果和前面一样,种一棵树最好的时间是十年前,而后是现在!

点赞
收藏
评论区
推荐文章
blmius blmius
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
待兔 待兔
4个月前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
Jacquelyn38 Jacquelyn38
3年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
Wesley13 Wesley13
3年前
mysql设置时区
mysql设置时区mysql\_query("SETtime\_zone'8:00'")ordie('时区设置失败,请联系管理员!');中国在东8区所以加8方法二:selectcount(user\_id)asdevice,CONVERT\_TZ(FROM\_UNIXTIME(reg\_time),'08:00','0
Wesley13 Wesley13
3年前
00:Java简单了解
浅谈Java之概述Java是SUN(StanfordUniversityNetwork),斯坦福大学网络公司)1995年推出的一门高级编程语言。Java是一种面向Internet的编程语言。随着Java技术在web方面的不断成熟,已经成为Web应用程序的首选开发语言。Java是简单易学,完全面向对象,安全可靠,与平台无关的编程语言。
Wesley13 Wesley13
3年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
为什么mysql不推荐使用雪花ID作为主键
作者:毛辰飞背景在mysql中设计表的时候,mysql官方推荐不要使用uuid或者不连续不重复的雪花id(long形且唯一),而是推荐连续自增的主键id,官方的推荐是auto_increment,那么为什么不建议采用uuid,使用uuid究
Java服务总在半夜挂,背后的真相竟然是... | 京东云技术团队
最近有用户反馈测试环境Java服务总在凌晨00:00左右挂掉,用户反馈Java服务没有定时任务,也没有流量突增的情况,Jvm配置也合理,莫名其妙就挂了
Python进阶者 Python进阶者
9个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这