摘要：介紹出發(fā)點(diǎn)在日常開(kāi)發(fā)中經(jīng)常需要對(duì)方法的入?yún)⒆鲂ｒ?yàn)，特別是在遠(yuǎn)程調(diào)用的方法中。類字段無(wú)參方法方法參數(shù)為或數(shù)組或集合類型提供長(zhǎng)度或大小校驗(yàn)。類非靜態(tài)方法方法參數(shù)指定參數(shù)校驗(yàn)失敗時(shí)拋出異常。方法方法參數(shù)禁用校驗(yàn)邏輯。

在日常開(kāi)發(fā)中經(jīng)常需要對(duì)方法的入?yún)⒆鲂ｒ?yàn)，特別是在遠(yuǎn)程調(diào)用的方法中。

我基于這個(gè)需求便開(kāi)發(fā)了這款工具，可以節(jié)省在這方面所花費(fèi)的精力，通過(guò)配置的注解，在編譯期對(duì)語(yǔ)法樹(shù)進(jìn)行修改，就能為方法加入?yún)?shù)的校驗(yàn)邏輯。

知道Lombok的同學(xué)肯定不少吧，其實(shí)原理都是一樣的。

現(xiàn)在所支持的校驗(yàn)有數(shù)字、字符串、數(shù)組、集合和Map，并且能夠在校驗(yàn)失敗時(shí)選擇是拋出異?；蚍祷?cái)?shù)據(jù)。

下面讓我們直接先看下使用效果吧。

public class MyApp {

    @Throw
    public Info run(Args args,
                    @Nullable Info info,
                    @Return({"test", "0"}) @NotBlank String name,
                    @Return("null") @NumberRule(min = "1") int num) {
        // process
        System.out.println("run");
        return new Info();
    }
}

如上代碼，經(jīng)過(guò)編譯后將會(huì)是這樣的 :

public class MyApp {
    public MyApp() {
    }
    public MyApp.Info run(MyApp.Args args, MyApp.Info info, String name, int num) {
        if (args == null) {
            throw new IllegalArgumentException("Invalid input parameter, cause args is null");
        } else {
            String mvar_0 = args.invalid0();
            if (mvar_0 != null) {
                throw new IllegalArgumentException("Invalid input parameter, cause " + mvar_0);
            } else {
                if (info != null) {
                    mvar_0 = info.invalid0();
                    if (mvar_0 != null) {
                        throw new IllegalArgumentException("Invalid input parameter, cause " + mvar_0);
                    }
                }

                if (name == null) {
                    return new MyApp.Info("test", (Double)null);
                } else if (Util.isBlank(name)) {
                    return new MyApp.Info("test", (Double)null);
                } else if (num < 1) {
                    return null;
                } else {
                    System.out.println("run");
                    return new MyApp.Info();
                }
            }
        }
    }
}

原始的邏輯 System.out.println("run"); new Info(); 被放置在了最后，當(dāng)調(diào)用時(shí)參數(shù)校驗(yàn)都通過(guò)后才會(huì)執(zhí)行。
其實(shí)例子中的代碼省略了對(duì)參數(shù)定義校驗(yàn)注解的部分，這些類在經(jīng)過(guò)編譯器后將會(huì)生成參數(shù)的校驗(yàn)方法。。。完整的代碼如下

public class MyApp {

    @Throw
    public Info run(Args args,
                    @Nullable Info info,
                    @Return({"test", "null"}) @NotBlank String name,
                    @Return("null") @NumberRule(min = "1") int num) {
        // process
        System.out.println("run");
        return new Info();
    }

    class Args {

        @NumberRule(max = "1000") int id;

        @NotNull HashMap param;

        @Nullable @SizeRule(min = 5) boolean[] value;
    }

    static class Info {

        @SizeRule(min = 50) String name;

        @Nullable @NumberRule(min = "-25.02", max = "200") Double price;

        @SizeRule(min = 10, max = 10) List extra;

        public Info() {
        }

        Info(String name, Double price) {
            this.name = name;
            this.price = price;
        }
    }
}

其中的 Args 和 Info 在經(jīng)過(guò)編譯后將會(huì)根據(jù)定義的注解生成校驗(yàn)方法。

   static class Info {
       String name;
       Double price;
       List extra;

       public Info() {
       }

       Info(String name, Double price) {
           this.name = name;
           this.price = price;
       }

       public String invalid0() {
           if (this.name == null) {
               return "name is null";
           } else if (this.name.length() < 50) {
               return "name.length() less than 50";
           } else if (this.price != null && this.price > 200.0D) {
               return "price great than 200.0";
           } else if (this.extra == null) {
               return "extra is null";
           } else {
               return this.extra.size() != 10 ? "extra cannot equals 10" : null;
           }
       }
   }

   class Args {
       int id;
       HashMap param;
       boolean[] value;

       Args() {
       }

       public String invalid0() {
           if (this.value != null && this.value.length < 5) {
               return "value.length less than 5";
           } else if (this.id > 1000) {
               return "id great than 1000";
           } else {
               return this.param == null ? "param is null" : null;
           }
       }
   }

看到這兒，你應(yīng)該對(duì)這個(gè)工具的基本功能有了大概的了解，下面我會(huì)介紹如果使用這個(gè)工具。

Maven

    
        io.github.moyada
        medivh
        1.2.0
        provided
    

Gradle

dependencies {
  compileOnly "io.github.moyada:medivh:1.2.0"
}

如果沒(méi)有使用構(gòu)建工具也沒(méi)問(wèn)題，可以從網(wǎng)上下載jar包，一樣配置，在后面用 javac -cp 編譯就好了。

現(xiàn)在可供使用的注解有這幾種，支持以類、枚舉、接口作為參數(shù)添加校驗(yàn)規(guī)則。

例如我需要提供一個(gè)判斷String是否為null或空白字符串的方法。

@Return("true")
public boolean isEmpty(@NotBlank String str) {
    return false;
}

使用構(gòu)建工具的編譯命令, 如 mvn compile 或 gradle build。

或者使用 Java 命令進(jìn)行編譯，如 javac -cp medivh.jar MyApp.java

如上述代碼，經(jīng)過(guò)編譯期后，即可生成方法邏輯，并且創(chuàng)建一個(gè) io.moyada.medivh.support.Util 類提供檢驗(yàn)是否為空白字符串的方法，當(dāng)然也支持自己指定方法。

public boolean isEmpty(String str) {
    if (str == null) {
        return true;
    } else {
        return Util.isBlank(str);
    }
}

看完這份介紹，如果有興趣的同學(xué)還可以前往 github 查看，會(huì)有更詳細(xì)的文檔和示例，歡迎大家進(jìn)行使用和提出意見(jiàn)。

github.com/moyada/medivh