java自定义Validator 注解，实现检测某些属性至少有一个不可为空

场景

在开发过程中，我们常用javax-validation，hibernate-validator的校验注解@NotNull、@NotEmpty、@Max、@Min等等等。使用注解校验省去了我们很多重复与业务逻辑相关度较低的代码。最近我遇到一个场景，DTO中某些属性里只需要有一个不为空即可校验通过，例如：固定电话和手机号可选填其中一个。google无果，只好先硬着头皮写if-else。写着写着发现有另一个地方也会用到类似的校验。于是决定自定义注解校验规则。

基于搜索的编程

搜索发现实现自定义校验注解很简单，只要两步：

• 定义注解（message（错误信息）、groups（校验组）、payload（严重级别）三个为必需属性）
• 定义注解解释器实现ConstraintValidator接口
  因为我们要检验一组属性，所以这个注解应该是在类上生效，并且需要获取到类中需要校验的一组属性。那我这样定义：

package com.shang.test.demo.validator;
import com.shang.test.demo.validator.impl.AtLeastOneNotEmptyValidator;
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * @author 尚晓琼
 * @version V1.0
 * @since 2019/1/3
 */
@Target( { TYPE })
@Retention(RUNTIME)
@Constraint(validatedBy = AtLeastOneNotEmptyValidator.class)
@Documented
public @interface AtLeastOneNotEmpty {
    String message() default "{至少有一个属性不可为空}";

    Class[] groups() default {};

    Class[] payload() default {};

    String[] fields();
}

接下来就是校验器的定义和校验规则的编写：

package com.shang.test.demo.validator.impl;


import com.shang.test.demo.validator.AtLeastOneNotEmpty;


import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.lang.reflect.Field;

/**
 * @author 尚晓琼
 * @version V1.0
 * @since 2019/1/3
 */
public class AtLeastOneNotEmptyValidator implements ConstraintValidator {
    private String[] fields;

    @Override
    public void initialize(AtLeastOneNotEmpty atLeastOneNotEmpty) {
        this.fields = atLeastOneNotEmpty.fields();
    }

    @Override
    public boolean isValid(Object object, ConstraintValidatorContext constraintValidatorContext) {
        if (object == null) {
            return true;
        }
        try {
            for (String fieldName : fields) {
                Object property = getField(object, fieldName);

                if (property != null && !"".equals(property)) {
                    return true;
                }
            }
            return false;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    private Object getField(Object object, String fieldName) throws IllegalAccessException {
        if (object == null) {
            return null;
        }
        Class clazz = object.getClass();
        Field[] fields = clazz.getDeclaredFields();
        for (Field field : fields) {
            if (field.getName().equals(fieldName)) {
                field.setAccessible(true);
                return field.get(object);
            }
        }
        return null;
    }
}

自定义的AtLeastOneNotEmptyValidator实现ConstraintValidator接口，并实现initialize（初始化）、isValid（校验）两个方法，我们在初始化的方法内获取到需要校验的属性名，在isValid中通过反射机制遍历这些属性，当有一个属性不为空时返回true。

结论

可以优雅的校验了：
like this：

image.png