java自定义注解获取类的字段说明

已于 2023-04-16 18:55:26 修改
阅读量925 收藏
点赞数
文章标签： java spring
于 2023-04-15 22:15:35 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_38983728/article/details/130176200
版权

文章目录

业务需求：事件组件定义了事件类，项目启动的时候注册事件类的字段和字段说明到事件管理页面，可以查看每个事件的消息模板说明

1. 自定义注解

1.1 EventObject
package com.tophant.engine.event.starter.register;

import org.springframework.stereotype.Component;

import java.lang.annotation.*;


/**
 * 事件对象
 *
 * @author wanfei
 * @date 2023/03/22
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Inherited
@Component
public @interface EventObject {

    /**
     * 事件对象描述
     */
    String value() default "";
}
1.2 EventField
package com.tophant.engine.event.starter.register;

import java.lang.annotation.*;


/**
 * 事件字段说明
 *
 * @author wanfei
 * @date 2023/03/22
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
@Inherited
public @interface EventField {

    /**
     * 事件字段说明
     */
    String value() default "";
}

2. 创建事件类

package com.tophant.engine.event.starter.register;

import lombok.Data;
import lombok.experimental.Accessors;

import java.io.Serializable;
import java.util.List;

/**
 * 自动注册事件
 *
 * @author wanfei
 * @date 2023/03/29
 */
@Data
@Accessors(chain = true)
@EventObject("自动注册事件")
public class EventRegisterEvent implements Serializable {
    private static final long serialVersionUID = -8859370839349111445L;

    /**
     * 主题(profile + topic或事件类)
     */
    @EventField("主题")
    private String topic;

    /**
     * 名称
     */
    @EventField("名称")
    private String name;

    /**
     * 应用appid
     */
    @EventField("应用appid")
    private String appid;

    /**
     * 消息模板
     */
    @EventField("消息模板")
    private List<MessageTemplate> messageTemplate;

    /**
     * 消息模板
     *
     * @author wanfei
     * @date 2023/04/14
     */
    @Data
    @Accessors(chain = true)
    public static class MessageTemplate implements Serializable{
        private static final long serialVersionUID = -4884206767786386008L;

        /**
         * 字段
         */
        @EventField("字段")
        private String field;

        /**
         * 字段描述
         */
        @EventField("字段描述")
        private String fieldDesc;

        /**
         * 对象字段
         */
        @EventField("对象字段")
        private List<MessageTemplate> objField;
    }

}

注意：内部类字段objField集合类型是MessageTemplate，可能会无限嵌套，后面设置了递归两层后终止

3. 创建项目启动运行的Runner

package com.tophant.engine.event.starter.register;

import cn.hutool.core.util.StrUtil;
import com.tophant.engine.event.core.exception.MessageServiceException;
import com.tophant.engine.event.core.utils.EventUtil;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.context.ConfigurableApplicationContext;

import javax.annotation.PostConstruct;
import java.lang.reflect.Field;
import java.lang.reflect.ParameterizedType;
import java.util.*;

/**
 * 事件自动注册配置
 *
 * @author wanfei
 * @date 2023/03/29
 */
@Slf4j
@RequiredArgsConstructor
@EnableConfigurationProperties(EventRegisterProperties.class)
public class EventAutoRegisterRunner implements ApplicationRunner, ApplicationContextAware {

    @Value("${cloud.appid:}")
    private String appid;

    private ApplicationContext applicationContext;

    @PostConstruct
    public void init() {
        log.info("[Engine] |- Starter [Engine Event Auto Register Starter] Auto Configure.");
    }

    @Override
    public void run(ApplicationArguments args) throws Exception {
        // 扫描spring容器中所有包含 @EventObject 注解的类
        Map<String, Object> beans = applicationContext.getBeansWithAnnotation(EventObject.class);
        beans.values().forEach(event -> {
            EventObject eventObject = event.getClass().getAnnotation(EventObject.class);
            if (StrUtil.isBlank(eventObject.value())) {
                throw new MessageServiceException(StrUtil.format("未设置事件名称  [event={}] 配置参考: @EventObject(请配置事件名称)", event.getClass().getSimpleName()));
            }
            String topic = EventUtil.getTopic(event);
            // 发送消息到服务端
            EventUtil.send(new EventRegisterEvent()
                            .setName(eventObject.value())
                            .setTopic(topic)
                            .setAppid(appid)
                            .setMessageTemplate(getClassFieldDesc(event.getClass(), new ArrayList<>())));
            log.info("[event 对象类 自动注册] topic: {}, ", topic);

            // 删除spring容器中包含 @EventObject 注解的类
            ((ConfigurableApplicationContext) applicationContext).getBeanFactory().destroyBean(event);
        });
    }

    /**
     * 得到类字段和描述
     *
     * @param cls            cls
     * @param beforeClsNames cls名字之前 之前对象名字 如果 beforeClsNames 和当前对象的一样，说明循环了，直接终止
     * @return {@link List}<{@link EventRegisterEvent.MessageTemplate}>
     */
    private List<EventRegisterEvent.MessageTemplate> getClassFieldDesc(Class<?> cls, List<String> beforeClsNames) {
        if (hasTwoOrMore(beforeClsNames, cls.getName())) {
            // 如果之前链路里面已经包含了该类型 2 次，不能继续递归查询，直接终止，否则会进入死循环
            return Collections.emptyList();
        }
        List<EventRegisterEvent.MessageTemplate> messageTemplateList = new ArrayList<>();
        for (int i = 0; i < cls.getDeclaredFields().length; i++) {
            if (i == 0) {
                // 说明开始当前层级
                beforeClsNames.add(cls.getName());
            }
            Field field = cls.getDeclaredFields()[i];
            if (!StrUtil.equals(field.getName(), "serialVersionUID")) {
                // 过滤 serialVersionUID 字段
                EventField eventField = field.getAnnotation(EventField.class);
                List<EventRegisterEvent.MessageTemplate> objField = new ArrayList<>();
                if (Collection.class.isAssignableFrom(field.getType())) {
                    // 集合对象
                    ParameterizedType collectionType = (ParameterizedType) field.getGenericType();
                    Class<?> collectionClass = (Class<?>) collectionType.getActualTypeArguments()[0];
                    if (checkCustomClass(collectionClass)) {
                        // 每一层级都会创建新的集合，因为每个字段的链路都不一样，把前面层级的类名加进来
                        objField = getClassFieldDesc(collectionClass, new ArrayList<>(beforeClsNames));
                    }
                } else if (checkCustomClass(field.getType())) {
                    Class<?> customClass = field.getType();
                    // 每一层级都会创建新的集合，因为每个字段的链路都不一样，把前面层级的类名加进来
                    objField = getClassFieldDesc(customClass, new ArrayList<>(beforeClsNames));
                }
                messageTemplateList.add(new EventRegisterEvent.MessageTemplate()
                        .setField(field.getName())
                        .setFieldDesc(Optional.ofNullable(eventField).map(EventField::value).orElse(StrUtil.EMPTY))
                        .setObjField(objField));
            }
        }
        return messageTemplateList;
    }

    /**
     * 检查是否自定义类
     *
     * @param cls cls
     * @return boolean
     */
    private boolean checkCustomClass(Class<?> cls) {
        // 判断字段不是java的原始类型，不是hutool, spring和fastjson等json对象，说明是自定义的对象
        return !cls.isPrimitive() && !StrUtil.startWithAny(cls.getName(), "java.", "org.springframework", "cn.hutool", "com.alibaba");
    }

    /**
     * 有两个或更多
     *
     * @param list   列表
     * @param target 目标
     * @return boolean
     */
    private boolean hasTwoOrMore(List<String> list, String target) {
        int count = 0;
        for (String str : list) {
            if (str.equals(target)) {
                count++;
                if (count >= 2) {
                    return true;
                }
            }
        }
        return false;
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }
}

4. 测试

启动项目，注册完成，该事件的字段说明数据格式如下：

[{
	"field": "topic",
	"fieldDesc": "主题",
	"objField": []
}, {
	"field": "name",
	"fieldDesc": "名称",
	"objField": []
}, {
	"field": "appid",
	"fieldDesc": "应用appid",
	"objField": []
}, {
	"field": "messageTemplate",
	"fieldDesc": "消息模板",
	"objField": [{
		"field": "field",
		"fieldDesc": "字段",
		"objField": []
	}, {
		"field": "fieldDesc",
		"fieldDesc": "字段描述",
		"objField": []
	}, {
		"field": "objField",
		"fieldDesc": "对象字段",
		"objField": [{
			"field": "field",
			"fieldDesc": "字段",
			"objField": []
		}, {
			"field": "fieldDesc",
			"fieldDesc": "字段描述",
			"objField": []
		}, {
			"field": "objField",
			"fieldDesc": "对象字段",
			"objField": []
		}]
	}]
}]
wnfee
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
JAVA工具类:获取类中被指定注解标记的字段值
BUGSLAYER_的博客
07-13 4125
不说废话直接上代码 /** * @author Sihan Liu */ public class MineBeanUtils { private static final String ERROR_CODE = "-1"; /** * 合并该类和对应父类的所有Fields * @param object object * @return List<Field> */ public static List<Field
Java 自定义注解 校验指定字段对应数据库内容重复
weixin_30696427的博客
09-23 2877
一、前言 在项目中，某些情景下我们需要验证编码是否重复，账号是否重复，身份证号是否重复等... 而像验证这类代码如下： 那么有没有办法可以解决这类似的重复代码量呢？ 我们可以通过自定义注解校验的方式去实现，如下 在实体类上面加上自定义的注解 @FieldRepeatValidator(field = "resources", message = "菜单编码重复！") 即可 下面就先来...
Java自定义注解使用反射获取字段注解
10-31
简单demo，导入即可运行。
java根据字段名称获取注解数据
最新发布
weixin_29051811的博客
07-20 63
Java根据字段名称获取注解数据 作为一名刚入行的开发者，你可能会对如何使用Java注解感到困惑。注解是一种为Java代码提供元数据的方式，它们可以被编译器、运行时环境或工具用来实现特定的功能。在这篇文章中，我将向你展示如何根据字段名称获取注解数据。 步骤概览 以下是实现“Java根据字段名称获取注解数据”的步骤： ...
java遍历列名_java – 如何获取JPA实体的列名
weixin_26704349的博客
02-26 269
我的所有JPA实体类都实现了一个名为Entity的接口,它的定义如下：public interface Entity extends Serializable {// some methods}我的JPA实体的一些字段在它们之上有@Column注释,而有些则没有. MyEntity类的定义如下：@Entitypublic class MyEntity implements Entity {@Idp...
Java 获取自定义注解 字段值 及 注解值
空
04-10 1710
【代码】Java 获取自定义注解 字段值 及 注解值。
JAVA中获取注解对象及注解信息
qq_42843172的博客
07-12 5359
JAVA中获取注解对象及注解信息 创建注解测试类： @Annotation04("abc") public class MyAnnotationTest01 { @Annotation04("def") public void doSomething(){ } } 判断类是否被@Annotation04注解： c.isAnnotationPresent(Annotation04.class); 判断doSomething方法是否被@Annotation04注解： Me
java注解之运行时修改字段的注解值操作
08-24
Java 注解之运行时修改字段的注解值操作 Java 注解是一种用来标注Java代码的方式，它可以在编译期、运行期对代码进行处理和修改。本文主要介绍了 Java 注解之运行时修改字段的注解值操作，具有很好的参考价值，希望...
java 自定义注解验证
02-23
在本案例中，作者创建了三个自定义注解，具体细节虽未详述，但我们可以深入探讨一下Java自定义注解的基本概念、创建过程以及如何进行验证。 首先，我们需要理解Java注解的基本原理。注解是一种元数据，它提供了一种...
java自定义注解接口实现方案
09-05
Java自定义注解是一种强大的工具，允许开发者在代码中添加元信息，这些信息可以在编译时或运行时被解析和利用。本文将深入探讨如何在Java中实现自定义注解以及如何解析和利用这些注解。 首先，了解Java中的元注解是...
java 获取注解的值注解_Java 注解的读取注解信息的方法
weixin_36016360的博客
02-12 3127
展开全部@Retention(RetentionPolicy.RUNTIME) // 注解会在class字节码文件中62616964757a686964616fe78988e69d8331333361303038存在，在运行时可以通过反射获取到@Target({ElementType.FIELD,ElementType.METHOD})//定义注解的作用目标**作用范围字段、枚举的常量/方法@Do...
自定义注解获取类，属性变量，方法，方法参数上注解的值（Kotlin）
Sir的专栏
05-20 6411
先看下效果 我们先来看一下kotlin中的注解Annotation.kt： package kotlin.annotation import kotlin.annotation.AnnotationTarget.* public enum class AnnotationTarget { /** 类、接口或对象 */ CLASS, /** 仅注释类 */ ANNOTATION_CLASS, /** 泛型类型参数（尚不支持）*/ TYPE_PARAMET
解析java bean获取字段及注释
lanse_huanxiang的专栏
04-09 227
【代码】解析java bean获取字段及注释。
Java通过反射获取注解以及注解中的信息
qq_45800640的博客
07-15 5613
首先自定义两个注解： 1、用于描述表名，只能用在类、接口、枚举上 @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface TableName { String value(); } 2、用于描述列的信息，列名、数据类型、长度 @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) public @interface Colum
java 获取注解名称
weixin_40812238的博客
07-06 45
Java获取注解名称 在Java开发中，注解是一种元数据，可以用来为Java代码提供额外的信息。有时候，我们需要在运行时获取注解的名称，以便进行相应的处理。本文将介绍如何在Java中获取注解的名称，并提供相应的代码示例。 注解的概念 注解是一种Java语言的特性，可以在类、方法、字段等元素上添加额外的信息。注解以@符号开头...
java自定义注解并获取注解值
myz_lemon的博客
04-12 1627
从JDK5开始,Java增加对元数据的支持，也就是注解，注解与注释是有一定区别的，可以把注解理解为代码里的特殊标记，这些标记可以在编译，类加载，运行时被读取，并执行相应的处理。通过注解开发人员可以在不改变原有代码和逻辑的情况下在源代码中嵌入补充信息 什么是注解编辑 注解，可以看作是对 一个 类/方法 的一个扩展的模版，每个 类/方法 按照注解类中的规则，来为 类/方法 注解不同的参数，在用到的...
Java获取实体的所有字段，和对应注解值
热门推荐
qq_39486119的博客
03-24 12万+
1、实体属性 @Data @Table(name = "user") @ApiModel(value="用户表") public class User { private static final long serialVersionUID = 1L; @ApiModelProperty("用户名") private String username; @ApiModelProperty("密码") private String password; @A
java 获取注解上的值
我爱吃果冻的博客
05-10 1949
查看字段上的注解 : Foo2Annotation annotation = Foo.class.getDeclaredField("id" //注解字段).getAnnotation(Foo2Annotation.class // 注解类名); 查看方法上的注解 : FooAnnotation annotation = Foo.class.getAnnotation(Fo...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值