Java 注解方式解决代码层数据完整性验证

场景

业务中需要在代码层面预先进行数据完整性验证，然后再将数据录入到数据库之中去。考虑到以后数据完整性规则可能会频繁更改，如果完全使用if-else的形式去写的话过于冗杂且难以维护。为了减少代码的修改量，我选用了自定义注解加check函数的方式来进行代码层的数据完整性验证。

步骤

1. 在实体类Account中定义注解Request

 class Account {
    @Retention(RetentionPolicy.RUNTIME)	// 此注解保证了定义的Required能够在运行时被保留，否则编译时Required就会消失
    @interface Required {
        String[] value();
    }
 }

2. 定义实体类的所有的属性，对需要验证完整性的属性添加Request注解

 class Account {
    @Retention(RetentionPolicy.RUNTIME)
    @interface Required {
        String[] value();
    }
    @Required("用户名")
    private String username;
    
    @Required("密码")
    private String password;
    
    private String nickname;
 }

3. 定义public的check方法，在此方法中对扫描类中的属性，并扫描他们的注解

 class Account {
    public void check() throws Exception {
        Class<Account> cls = Account.class;
        Field[] fields = cls.getDeclaredFields();
        for (Field field : fields) {
            Required annotation = field.getAnnotation(Required.class);
            // 若属性上有Required注解，并且该字段没有值，则返回false
            if (annotation != null && field.get(this) == null)
                throw new Exception(annotation.value()[0] + " 不得为空");
        }
    }
    
 	/**getter setter省略**/
 	
    @Retention(RetentionPolicy.RUNTIME)
    @interface Required {
        String[] value();
    }
    
    @Required("用户名")
    private String username;
    
    @Required("密码")
    private String password;
    
    private String nickname;
 }

4. 使用check方法

public class Main {
	public static void main(String[] args) {
		/**前置代码**/
		Account account = new Account();
		account.setUsername("root");
		account.setPassword("123456");
		try {
			account.check();
		} catch (Exception e) {
			/**验证不通过的处理代码**/
		}
		/**验证通过的处理代码**/
	}
}

后言

业务场景确实比较蛋疼，但是个人认为在代码层面用注解做数据完整性验证能对注解和反射机制有一个比较完整的应用体验。