開發工作中，都會需要針對傳入的參數進行驗證，特別是針對實體進行驗證，確保傳入的參數格式正確。這里做了一個非常簡單的組件進行驗證。拋磚引玉，讓大家深入思考下反射的應用。
需求
日常開發，都是通過API進行前后端的系統對接，對API參數的驗證是一個使用率非常高的功能，如果能非常簡便的的進行參數驗證，能降低代碼量，提升工作效率。
使用
項目地址：https://github.com/itmifen/mfutility
以前使用最原始的驗證方式：
if(testEntity.getImages().length()>2){
//這里是業務邏輯
}
if(testEntity.getTitle().length()>2){
//這里是業務邏輯
}
這樣導致實現起來重復的代碼太多，而且開發起來太耗時。這里使用注解的方式進行優化，只需要在實體定義的時候，定義驗證的內容，使用的時候用只需要調用驗證的方法就可以了。
/**
* 定義測試的實體
*/
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){
//這里是業務邏輯
}
}
- 基於MQ注解
當然，這些都是需要自己開發的，其實開發的負責難度不高，但是卻能讓代碼的結構更加清晰簡潔，反射絕對不是黑科技，而是提高效率的核武器。
（完）
歡迎大家關注我的公眾號交流、學習、第一時間獲取最新的文章。
微信號：itmifen
