自研校验器工具类—Java语言实现

作者：刘仁鹏
GitHub地址：https://github.com/LingPaicoder/agile-base-4j

转载请注明出处

1. 简介

  • 之前为大家介绍过用Kotlin语言实现的校验器版本。但大家工作中，很多时候都是使用Java语言进行开发。所以这里再介绍一下校验器的Java语言实现。
  • 功能与Kotlin的版本差别不大，但受语言的影响，特性上会有所不同。
  • 首先还是介绍一下校验器的功能。
    它是一款用于做 参数上下文校验 的工具类。说起校验器，大家比较熟悉的是Java的BeanValidation规范。但BeanValidation规范是用于做 参数字面值校验 的，即只能对 参数本身的值 做某种规则性的判断，如果需要对参数进行某种运算后的结果（例如算数运算、DB操作等）进行规则判断，就无法实现了。
    这种对 参数进行某种运算后的结果 进行校验的方式，我把它称作 参数上下文校验。而本文要介绍的校验器就是为了解决这种应用场景而生的。
  • 先来看一下校验器实际使用时的效果吧，这是一个对参数是否符合身份证号规则进行判断的方法：
public boolean valide(String idCard) {
    try {
        CheckUtil.check(idCard, StrRuler.notNull(), StrRuler.lengthEq(18));
        String front17Part = idCard.substring(0, 17);
        CheckUtil.check(front17Part, StrRuler.num());
        String lastStr = getLastCharByFront17Part(front17Part);
        CheckUtil.check(lastStr, StrRuler.eq(idCard.substring(17)));
        return true;
    } catch (CheckException e) {
        return false;
    }
}
  • 代码中的第3、5、7行就是三次校验动作，这里通过CheckUtil的check方法，对校验目标进行规则校验，简化代码，提高可读性。
  • 这里要额外说明一点的是，因为Java代码对null一般都需要额外处理，这里校验器也遵循这个约定，所有的内置的非nutNull规则，当校验目标为null时都按校验通过处理，因此当校验目标要求不能为null时，需要显式的通过notNull规则标识，这一特性与Kotlin的实现版本不同，需要特别注意。
  • 接下来就一起看一下对校验器更全面的介绍。

2.特性

下面这个图是校验器的特性总览。

校验器.png-196.3kB
校验器.png-196.3kB

接下来介绍一下校验器的使用方法：

1.通过构造函数获得Ruler对象进行校验

@Test
@SuppressWarnings("unchecked")
public void testCommon() {
    String trueIdcard = "130802198108204219";
    CheckUtil.check(trueIdcard, "身份证号",
            new StrNotNullRuler(),
            new StrNotEmptyRuler(),
            new StrIdCardRuler());

    thrown.expect(CheckException.class);
    thrown.expectMessage("code=-11007, desc=身份证号必须符合身份证格式");

    String falseIdcard = "130802198167204210";
    CheckUtil.check(falseIdcard, "身份证号",
            new StrNotNullRuler(),
            new StrNotEmptyRuler(),
            new StrIdCardRuler());
}

2.通过工厂方法获得Ruler对象进行校验

@Test
@SuppressWarnings("unchecked")
public void testFactory() {
    String trueIdcard = "130802198108204219";
    CheckUtil.check(trueIdcard, "身份证号",
            StrRuler.notNull(),
            StrRuler.notEmpty(),
            StrRuler.idCard());

    thrown.expect(CheckException.class);
    thrown.expectMessage("code=-11007, desc=身份证号必须符合身份证格式");

    String falseIdcard = "130802198108204210";
    CheckUtil.check(falseIdcard, "身份证号",
            StrRuler.notNull(),
            StrRuler.notEmpty(),
            StrRuler.idCard());
}

3.捕获校验失败异常，获取校验失败code码和描述

@Test
@SuppressWarnings("unchecked")
public void testCatch() {
    try {
        String falseIdcard = "130802198108204210";
        CheckUtil.check(falseIdcard, "身份证号",
                StrRuler.notNull(),
                StrRuler.notEmpty(),
                StrRuler.idCard());
    } catch (CheckException e) {
        Assert.assertEquals(-11007L, e.getCode());
        Assert.assertEquals("身份证号必须符合身份证格式", e.getDesc());
        Assert.assertEquals("code=-11007, desc=身份证号必须符合身份证格式", e.getMessage());
    }
}

4.自定义错误编号和错误描述(支持在desc中对norm进行格式化)

@Test
@SuppressWarnings("unchecked")
public void testUserDefinedFailCodeAndDesc() {
    String specialName = "乔伊·亚历山大·比基·卡利斯勒·达夫·埃利奥特·福克斯·伊维鲁莫";
    final String NAME_DESC = "姓名";
    final long NAME_TOO_LONG_CODE = -2L;
    final int lteNorm = 10;
    // 注意此处%d的用法
    final String NAME_TOO_LONG_DESC = "长度超过限制,允许的最大长度:%d";

    thrown.expect(CheckException.class);
    thrown.expectMessage("code=-2, desc=姓名长度超过限制,允许的最大长度:10");

    CheckUtil.check(specialName, NAME_DESC,
            StrRuler.notNull(),
            StrRuler.notEmpty(),
            StrRuler.lengthGte(2),
            StrRuler.lengthLte(lteNorm, NAME_TOO_LONG_CODE, NAME_TOO_LONG_DESC));
}

5.链式调用

@Test
@SuppressWarnings("unchecked")
public void testChainingCall() {
    String trueIdcard = "130802198108204219";
    String specialName = "乔伊·亚历山大·比基·卡利斯勒·达夫·埃利奥特·福克斯·伊维鲁莫";

    thrown.expect(CheckException.class);
    thrown.expectMessage("code=-11005, desc=姓名的长度必须小于或等于10");
    // 非链式调用
    CheckUtil.check(trueIdcard, "身份证号",
            StrRuler.notNull(),
            StrRuler.notEmpty(),
            StrRuler.idCard());
    CheckUtil.check(specialName, "姓名",
            StrRuler.notNull(),
            StrRuler.notEmpty(),
            StrRuler.lengthGte(2),
            StrRuler.lengthLte(10));

    // 链式调用
    thrown.expect(CheckException.class);
    thrown.expectMessage("code=-11005, desc=姓名的长度必须小于或等于10");
    CheckUtil
            .check(trueIdcard, "身份证号",
                    StrRuler.notNull(),
                    StrRuler.notEmpty(),
                    StrRuler.idCard())
            .check(specialName, "姓名",
                    StrRuler.notNull(),
                    StrRuler.notEmpty(),
                    StrRuler.lengthGte(2),
                    StrRuler.lengthLte(10));
}

6.已校验结果可依赖性/后置校验对象求值中断功能

@Test
@SuppressWarnings("unchecked")
public void testNull() {
    // 注意：并没有抛出NPE
    thrown.expect(CheckException.class);
    thrown.expectMessage("code=-10000, desc=商家不能为Null");
    Custom custom = null;
    CheckUtil.check(custom, "商家", new ObjNotNullRuler())
            .check(custom.getCustomId(), "商家Id", new StrNotNullRuler());

    // 补充：除了通过异常中断,还可以利用FunctionInterface的缓求值特性来实现该功能
    // 但只能通过lambda表达式来生成Supplier对象,方法引用仍会抛出NPE
    // 详见：https://www.jianshu.com/p/d3e69bd192c7
}

7.规则整合功能(Ruler多合一)

@Test
@SuppressWarnings("unchecked")
public void testRulerMerge() {
    String specialName = "乔伊·亚历山大·比基·卡利斯勒·达夫·埃利奥特·福克斯·伊维鲁莫";
    Ruler<String> nameRuler = Ruler.ofAll(
            StrRuler.notNull(),
            StrRuler.notEmpty(),
            StrRuler.lengthGte(2),
            StrRuler.lengthLte(10));

    thrown.expect(CheckException.class);
    thrown.expectMessage("code=-11005, desc=姓名的长度必须小于或等于10");
    CheckUtil.check(specialName, "姓名", nameRuler);
}

8.规则的“或”逻辑

@Test
@SuppressWarnings("unchecked")
public void testOr() {
    Ruler<String> nameRuler =
            StrRuler.empty().or(StrRuler.lengthGte(2), StrRuler.lengthLte(10));

    String specialName = "";
    CheckUtil.check(specialName, "姓名", nameRuler);

    specialName = "张三";
    CheckUtil.check(specialName, "姓名", nameRuler);

    thrown.expect(CheckException.class);
    thrown.expectMessage("code=-11005, desc=姓名的长度必须小于或等于10");
    specialName = "乔伊·亚历山大·比基·卡利斯勒·达夫·埃利奥特·福克斯·伊维鲁莫";
    CheckUtil.check(specialName, "姓名", nameRuler);

}

9.为实体类不同操作封装个性化Ruler

@Test
@SuppressWarnings("unchecked")
public void testEntity() {
    // 可在业务工程中将customAddRuler对象以常量的方式提取到统一的Rulers类中
    Ruler<Custom> customAddRuler = custom -> CheckUtil.check(custom, "商家", ObjRuler.notNull())
            .check(custom.getCustomId(), "商家Id", StrRuler.notEmpty())
            .check(custom.getName(), "商家姓名", StrRuler.notEmpty())
            .check(custom.getAge(), "商家年龄", IntRuler.lte(60));

    Custom custom = new Custom();
    custom.setCustomId("123");
    custom.setName("张三");
    custom.setAge(80);

    thrown.expect(CheckException.class);
    thrown.expectMessage("code=-18005, desc=商家年龄必须小于或等于60");
    CheckUtil.check(custom, customAddRuler);

}

@Data
static class Custom {
    private String customId;
    private String name;
    private Integer age;
}

3. 其他

  • 校验器的GitHub地址是https://github.com/LingPaicoder/agile-base-4j。
  • 所有的校验器相关代码都放在 com.lpcoder.agile.base.forj.check 包下。
  • 校验器的特性单测放在test的 com.lpcoder.agile.base.forj.check.CheckUtilTest 类中。

end
欢迎留言反馈对校验器的改进意见。

扫码可关注微信公众号：


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