你必須瞭解的反射——反射來實現實體驗證

時間 2019-11-17

標籤必須瞭解反射實現實體驗證简体版

原文原文鏈接

開發工做中，都會須要針對傳入的參數進行驗證，特別是針對實體進行驗證，確保傳入的參數格式正確。這裏作了一個很是簡單的組件進行驗證。拋磚引玉，讓你們深刻思考下反射的應用。java

需求

平常開發，都是經過API進行先後端的系統對接，對API參數的驗證是一個使用率很是高的功能，若是能很是簡便的的進行參數驗證，能下降代碼量，提高工做效率。git

使用

項目地址：https://github.com/itmifen/mfutilitygithub

之前使用最原始的驗證方式：正則表達式

if(testEntity.getImages().length()>2){
            //這裏是業務邏輯
        }
        if(testEntity.getTitle().length()>2){
            //這裏是業務邏輯
        }

這樣致使實現起來重複的代碼太多，並且開發起來太耗時。這裏使用註解的方式進行優化，只須要在實體定義的時候，定義驗證的內容，使用的時候用只須要調用驗證的方法就能夠了。redis

/**
     * 定義測試的實體
     */

    public class TestEntity{
        /**
         * 圖片
         */
        @Valid(description = "圖片",minLength = 1,maxLength = 200,regex=".*runoob.*")
        private String images;

        /**
         * 標題
         */
        @Valid(description = "標題",isEmpty = false,maxLength = 20)
        private String title;


        public String getImages() {
            return images;
        }

        public void setImages(String images) {
            this.images = images;
        }

        public String getTitle() {
            return title;
        }

        public void setTitle(String title) {
            this.title = title;
        }
    }

字段	說明
description	字段中文名
isEmpty	是否可爲空
maxLength	最大長度
minLength	最小長度
regex	正則表達式

驗證的時候只須要調用實體就能夠進行驗證後端

ValidResultEntity validResultEntity = EntityCheckUtil.validate(testEntity);
System.out.println(validResultEntity.getMessage());

返回的ValidResultEntity會告訴你是否成功，若是錯誤，會告訴你錯誤的緣由。緩存

源碼說明

其實，總體的實現思路很是簡單，主要是使用java的自定義註解來進行驗證。
新定義一個註解(Valid.java)：微信

@Documented
@Inherited
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Valid {


    /**
     * @return 字段描述
     */
    public String description() default "";

    /**
     * 是否能夠爲空
     * @return true能夠爲空，false不能爲空
     */
    public boolean isEmpty() default true;

    /**
     * 最大長度
     * @return
     */
    public int maxLength() default 1000;

    /**
     * 最小長度
     * @return
     */
    public int minLength() default 0;

    /**
     * 正則表達式
     * @return
     */
    public  String regex() default "";

}

建一個通用的方法來進行驗證：框架

/**
     * 註解驗證電泳方法
     *
     * @param bean 驗證的實體
     * @return
     */

    public static ValidResultEntity validate(Object bean) {
        ValidResultEntity result = new ValidResultEntity();
        result.setSucceed(true);
        result.setMessage("驗證經過");

        Class<?> cls = bean.getClass();

        // 檢測field是否存在
        try {
            // 獲取實體字段集合
            Field[] fields = cls.getDeclaredFields();
            for (Field f : fields) {
                // 經過反射獲取該屬性對應的值
                f.setAccessible(true);
                // 獲取字段值
                Object value = f.get(bean);
                // 獲取字段上的註解集合
                Annotation[] arrayAno = f.getAnnotations();
                for (Annotation annotation : arrayAno) {
                    // 獲取註解類型（註解類的Class）
                    Class<?> clazz = annotation.annotationType();
                    // 獲取註解類中的方法集合
                    Method[] methodArray = clazz.getDeclaredMethods();
                    for (Method method : methodArray) {
                        // 獲取方法名
                        String methodName = method.getName();

                        if("description".equals(methodName)) {
                            continue;
                        }


                        // 初始化註解驗證的方法處理類 （個人處理方法寫在本類中）
                        Object obj = EntityCheckUtil.class.newInstance();
                        // 獲取方法
                        try {
                            // 根據方法名獲取該方法
                            Method m = obj.getClass().getDeclaredMethod(methodName, Object.class, Field.class);
                            // 調用該方法
                            result = (ValidResultEntity) m.invoke(obj, value, f);
                            /* 驗證結果 有一處失敗則退出 */
                            if(result.isSucceed()==false) {
                                return result;
                            }
                        } catch (Exception e) {
                            e.printStackTrace();
                        }
                    }
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return result;
    }

validate 主要是經過反射獲取類的值、註解，根據獲取的數據進行調用：學習

// 根據方法名獲取該方法
Method m = obj.getClass().getDeclaredMethod(methodName, Object.class, Field.class);
// 調用該方法
result = (ValidResultEntity) m.invoke(obj, value, f);
/* 驗證結果 有一處失敗則退出 */
if(result.isSucceed()==false) {
   return result;
}

invoke 中對獲取的方法進行具體調用實現，這裏我定義了最簡單的幾個方法，包括：

isEmpty
maxLength
minLength
regex

其實，本身也能夠擴展更多的方法，只要能瞭解這個思路，徹底能夠本身定製更多的規則。

思路擴展

無論是java 仍是 .net，都是支持反射的，反射的應用其實很廣的，能夠很容易的針對代碼進行抽象處理，在具體的開發過成功，實際上是能夠很好的進行擴展的。其實，關於實體驗證的框架也是有不少成熟的產品(如：http://hibernate.org/validator/)，可是大多數都是考慮很廣，實現比較複雜點，若是本身只想作一個很輕量級的，徹底能夠本身來實現。
以上的代碼很是簡單，可是卻能節省很大工做量的，再次拋磚引玉，你們也能夠思考下不少相似的實現，如：

基於緩存註解

@redis(key='test',expire=1800)
    public void  testOldRedis(){
        if(testEntity.getImages().length()>2){
            //這裏是業務邏輯
        }
        if(testEntity.getTitle().length()>2){
            //這裏是業務邏輯
        }
    }