Java中通过反射获取自定义注解中标识的对象属性信息(若依@Excel注解示例)

场景

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

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

在上面进行excel导入导出时在实体类上可见有个注解@Excel

这是自定义的注解，可以添加在对象字段上，进而给字段添加一些额外的信息和处理逻辑等。

比如：

后台在excel导入时，需要校验哪些字段值为空，然后将不能为空的字段返回给前台进行提示。

但是在返回字段名称时直接返回后台实体类字段名称时不友好的，需要返回对应的含义名称，

比如早班人数不能为空直接返回早班人数，而不是morningShiftNum

注：

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

实现

1、首先自定义注解，比如这里的@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;
 
}

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;
    }

测试结果