開發(fā)工作中，都會需要針對傳入的參數(shù)進行驗證，特別是針對實體進行驗證，確保傳入的參數(shù)格式正確。這里做了一個非常簡單的組件進行驗證。拋磚引玉，讓大家深入思考下反射的應(yīng)用。

需求

日常開發(fā)，都是通過API進行前后端的系統(tǒng)對接，對API參數(shù)的驗證是一個使用率非常高的功能，如果能非常簡便的的進行參數(shù)驗證，能降低代碼量，提升工作效率。

使用

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

以前使用最原始的驗證方式：

if(testEntity.getImages().length()>2){//這里是業(yè)務(wù)邏輯}if(testEntity.getTitle().length()>2){//這里是業(yè)務(wù)邏輯}

這樣導(dǎo)致實現(xiàn)起來重復(fù)的代碼太多，而且開發(fā)起來太耗時。這里使用注解的方式進行優(yōu)化，只需要在實體定義的時候，定義驗證的內(nèi)容，使用的時候用只需要調(diào)用驗證的方法就可以了。

/*** 定義測試的實體*/public class TestEntity{/*** 圖片*/@Valid(description = "圖片",minLength = 1,maxLength = 200,regex=".*runoob.*")private String images;/*** 標(biāo)題*/@Valid(description = "標(biāo)題",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	正則表達式

驗證的時候只需要調(diào)用實體就可以進行驗證

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

返回的ValidResultEntity會告訴你是否成功，如果錯誤，會告訴你錯誤的原因。

源碼說明

其實，整體的實現(xiàn)思路非常簡單，主要是使用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) {// 通過反射獲取該屬性對應(yīng)的值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 {// 根據(jù)方法名獲取該方法Method m = obj.getClass().getDeclaredMethod(methodName, Object.class, Field.class);// 調(diào)用該方法result = (ValidResultEntity) m.invoke(obj, value, f);/* 驗證結(jié)果 有一處失敗則退出 */if(result.isSucceed()==false) {return result;}} catch (Exception e) {e.printStackTrace();}}}}} catch (Exception e) {e.printStackTrace();}return result;}

validate 主要是通過反射獲取類的值、注解，根據(jù)獲取的數(shù)據(jù)進行調(diào)用：

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

invoke 中對獲取的方法進行具體調(diào)用實現(xiàn)，這里我定義了最簡單的幾個方法，包括：

• isEmpty
• maxLength
• minLength
• regex

其實，自己也可以擴展更多的方法，只要能了解這個思路，完全可以自己定制更多的規(guī)則。

思路擴展

不管是java 還是 .net，都是支持反射的，反射的應(yīng)用其實很廣的，可以很容易的針對代碼進行抽象處理，在具體的開發(fā)過成功，其實是可以很好的進行擴展的。 其實，關(guān)于實體驗證的框架也是有很多成熟的產(chǎn)品(如：http://hibernate.org/validator/)，但是大多數(shù)都是考慮很廣，實現(xiàn)比較復(fù)雜點，如果自己只想做一個很輕量級的，完全可以自己來實現(xiàn)。
以上的代碼非常簡單，但是卻能節(jié)省很大工作量的，再次拋磚引玉，大家也可以思考下很多類似的實現(xiàn)，如：

• 基于緩存注解

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

• 基于MQ注解

當(dāng)然，這些都是需要自己開發(fā)的，其實開發(fā)的負責(zé)難度不高，但是卻能讓代碼的結(jié)構(gòu)更加清晰簡潔，反射絕對不是黑科技，而是提高效率的核武器。

（完）

---

歡迎大家關(guān)注我的公眾號交流、學(xué)習(xí)、第一時間獲取最新的文章。
微信號：itmifen

轉(zhuǎn)載于:https://www.cnblogs.com/joylee/p/7721827.html

與50位技術(shù)專家面對面20年技術(shù)見證，附贈技術(shù)全景圖

總結(jié)

以上是生活随笔為你收集整理的你必须了解的反射——反射来实现实体验证的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。