Java中通过反射+自定义注解判断对象中部分属性是否为空，返回为空字段的名称或自定义含义

场景

若依管理系统前后端分离版基于ElementUI和SpringBoot怎样实现Excel导入和导出：

若依管理系统前后端分离版基于ElementUI和SpringBoot怎样实现Excel导入和导出_霸道流氓气质的博客-CSDN博客

在上面进行excel导入时，需要对数据进行非空校验。

比如对象中有多个属性，需要判断其中几个属性是否为空，为空则返回给前端提示。新建实体类，有如下字段

@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class LimitQuotaStatistics extends BaseEntity
{
    private static final long serialVersionUID = 1L;
 
    /** id */
    private Long id;
 
    /** 部门id */
    private Long deptId;
 
    /** 部门名称 */
    @Excel(name = "部门名称")
    private String deptName;
 
    /** 夜班人数 */
    @Excel(name = "夜班人数")
    private Long nightShiftNum;
 
    /** 早班人数 */
    @Excel(name = "早班人数")
    private Long morningShiftNum;
 
    /** 早中班人数 */
    @Excel(name = "早中班人数")
    private Long morningMiddlleShiftNum;
 
    /** 晚中班人数 */
    @Excel(name = "晚中班人数")
    private Long nightMiddleShiftNum;
 
    /** 合计人数 */
    @Excel(name = "合计人数")
    private Long totalNum;
 
    /** 定额人数 */
    @Excel(name = "定额人数")
    private Long quotaNum;
 
    /** 计划日期 */
    @JsonFormat(pattern = "yyyy-MM-dd")
    private Date planDate;
 
}

这里的@Excel注解为若依自带的自定义注解，下面会用到其name属性。

注：

博客：
霸道流氓气质的博客_CSDN博客-C#,架构之路,SpringBoot领域博主
关注公众号
霸道的程序猿
获取编程相关电子书、教程推送与免费下载。

实现

1、构造一个实体对象，并且只给morningShiftNum赋值

        LimitQuotaStatistics limitQuotaStatistics = LimitQuotaStatistics.builder()
                .morningShiftNum(3l)
                .build();

2、假设我们需要对其中的某些字段进行非空校验

把需要进行非空校验的字段抽离到Constants

public class LimitConstants
{
    public static final List<String> LIMIT_QUOTA_IMPORT_NOTNULL_CHECK = new ArrayList<String>(){{
        this.add("nightShiftNum");
        this.add("morningShiftNum");
        this.add("morningMiddlleShiftNum");
        this.add("totalNum");
        this.add("quotaNum");
    }};
}

假如需要对上面这几个字段进行非空校验，如果这几个字段中有为null，则返回对应的字段名

那么上面构造的实体对象，应该返回nightShiftNum、morningMiddlleShiftNum、totalNum、quotaNum这四个字段。

3、封装一个工具类方法，通过反射获取该对象的所有字段，然后筛选字段是否在上面要检查的list中并且值为null的即可

    /**
     * 检查对象的属性是否为空
     * @param obj 检查对象
     * @param checkField 要检查的属性名list
     * @return 为空的属性名list
     * @throws IllegalAccessException
     */
    public static List<String> checkObjFieldIsNull(Object obj, List<String> checkField) throws IllegalAccessException {
 
        List<String> res = new ArrayList<>();
        //获取对象的类
        Class<?> aClass = obj.getClass();
        //获取对象的所有字段，包含public、private和proteced
        Field[] declaredFields = aClass.getDeclaredFields();
        //筛选出包含在要检查的list 并且 属性为null的字段
        Arrays.stream(declaredFields).forEach(field -> {
            //设置属性可访问
            field.setAccessible(true);
            try {
                if(checkField.contains(field.getName()) && field.get(obj) == null){
                    //获取字段名
                    res.add(field.getName());
                }
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
        });
        return res;
    }

然后调用进行测试

    @Test
    public void checkFieldIsNull(){
        LimitQuotaStatistics limitQuotaStatistics = LimitQuotaStatistics.builder()
                .morningShiftNum(3l)
                .build();
        List<String> checkFields = LimitConstants.LIMIT_QUOTA_IMPORT_NOTNULL_CHECK;
        try {
            checkObjFieldIsNull(limitQuotaStatistics,checkFields).stream().forEach(System.out::println);
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        }
    }

测试结果

但是把这些对象的字段名直接返回给前端提示不大友好，是否可以直接返回对应的自定义的含义名称。

4、回到上面自定义注解@Excel中，是否可以获取每个字段上的name的值

首先自定义注解，比如这里的@Excel，就可以将注解作用在类上

/**
 * 自定义导出Excel数据注解
 *
 * @author ruoyi
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Excel
{
    /**
     * 导出时在excel中排序
     */
    public int sort() default Integer.MAX_VALUE;
 
    /**
     * 导出到Excel中的名字.
     */
    public String name() default "";
 
}

这里只做演示用，所以只保留了一个name属性

@Retention(RetentionPolicy.RUNTIME)表示注解不仅被保存到class文件中，jvm加载class文件之后，仍然存在。

@Target(ElementType.FIELD)表示此注解的作用目标是字段和枚举的常量上

2、创建实体类，并添加上面的自定义注解

@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class LimitQuotaStatistics extends BaseEntity
{
    private static final long serialVersionUID = 1L;
 
    /** id */
    private Long id;
 
    /** 部门id */
    private Long deptId;
 
    /** 部门名称 */
    @Excel(name = "部门名称")
    private String deptName;
 
    /** 夜班人数 */
    @Excel(name = "夜班人数")
    private Long nightShiftNum;
 
    /** 早班人数 */
    @Excel(name = "早班人数")
    private Long morningShiftNum;
 
    /** 早中班人数 */
    @Excel(name = "早中班人数")
    private Long morningMiddlleShiftNum;
 
    /** 晚中班人数 */
    @Excel(name = "晚中班人数")
    private Long nightMiddleShiftNum;
 
    /** 合计人数 */
    @Excel(name = "合计人数")
    private Long totalNum;
 
    /** 定额人数 */
    @Excel(name = "定额人数")
    private Long quotaNum;
 
    /** 计划日期 */
    @JsonFormat(pattern = "yyyy-MM-dd")
    private Date planDate;
 
}

3、通过反射获取对象属性的注解以及注解的值

field.getAnnotation(Excel.class).name()

具体示例：

    /**
     * 检查对象的属性是否为空
     * @param obj 检查对象
     * @param checkField 要检查的属性名list
     * @return 为空的属性名list
     * @throws IllegalAccessException
     */
    public static List<String> checkObjFieldIsNull(Object obj, List<String> checkField) throws IllegalAccessException {
 
        List<String> res = new ArrayList<>();
        //获取对象的类
        Class<?> aClass = obj.getClass();
        //获取对象的所有字段，包含public、private和proteced
        Field[] declaredFields = aClass.getDeclaredFields();
        //筛选出包含在要检查的list 并且 属性为null的字段
        Arrays.stream(declaredFields).forEach(field -> {
            //设置属性可访问
            field.setAccessible(true);
            try {
                if(checkField.contains(field.getName()) && field.get(obj) == null){
                    //获取自定义注解标识的属性名 如果没有则忽略
                    res.add(field.getAnnotation(Excel.class).name()); 
                }
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
        });
        return res;
    }

测试结果

​​​​​​​