首页 > 编程语言 >Java中通过反射+自定义注解判断对象中部分属性是否为空,返回为空字段的名称或自定义含义

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

时间:2022-11-14 14:59:01浏览次数:60  
标签:Java name 自定义 Excel private Long 为空 人数 public

场景

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

https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/108278834

在上面进行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属性。

注:

博客:
https://blog.csdn.net/badao_liumang_qizhi
关注公众号
霸道的程序猿
获取编程相关电子书、教程推送与免费下载。

实现

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

测试结果

 

 

 

标签:Java,name,自定义,Excel,private,Long,为空,人数,public
From: https://www.cnblogs.com/badaoliumangqizhi/p/16889010.html

相关文章

  • java基础笔记
    java的数据类型分为两大类  进制前缀二进制:0b八进制:0十六进制:0xJava会直接将它们转换为十进制输出 float、double并不能准确表示每一位小数,对于有的小数只能无......
  • 《JavaSE-第十九章》之Collection
    《JavaSE-第十九章》之Collection前言在你立足处深挖下去,就会有泉水涌出!别管蒙昧者们叫嚷:“下边永远是地狱!”博客主页:​​KC老衲爱尼姑的博客主页​​​​博主的github,......
  • Android自定义定时闹钟开发详解
    这篇文章主要为大家详细介绍了Android自定义定时闹钟开发,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下本文实例为大家分享了Android开发之自......
  • Java课后习题易错点
    Chapter1基础知识//JavaAPIcontainspredefinedclassesandinterfacesfordevelopingJavaprograms.JavaAPI包含用于开发Java程序的预定义类和接口。.JavaJD......
  • javascript对象和内置对象
    了解对象对象是什么?对象是一组无序的相关属性和方法集合,js中所有事物都是对象,例如字符串,数值,数组,函数等对象是由属性和方法组成的属性:事物的特征,在对象中用属性来表示(常......
  • Java中通过反射获取自定义注解中标识的对象属性信息(若依@Excel注解示例)
    场景若依管理系统前后端分离版基于ElementUI和SpringBoot怎样实现Excel导入和导出:https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/108278834在上面进行exc......
  • Java安全之CC2
    前言由于在2015年底commons-collections反序列化利⽤链被提出时,ApacheCommonsCollections有以下两个分⽀版本:commons-collections:commons-collectionsorg.apache......
  • Java多线程(一)
    一.线程的生命周期及五种基本状态关于Java中线程的生命周期,首先看一下下面这张较为经典的图:   上图中基本上囊括了Java中多线程各重要知识点。掌握了上图中的各知......
  • Java 几分钟处理完 30 亿个数据?
    1.场景说明现有一个10G文件的数据,里面包含了18-70之间的整数,分别表示18-70岁的人群数量统计。假设年龄范围分布均匀,分别表示系统中所有用户的年龄数,找出重复次数最多......
  • javascript尾递归优化
    JS中的递归我们来看一个阶乘的代码functionfoo(n){if(n<=1){return1;}returnn*foo(n-1);}foo(5);//120下面分析一下,代码运行过程中,......