SpringBoot中的自定义注解开发与注解处理器

简介: 使用AnnotatedElement接口中的方法提取注解中的数据,像Class/Constructor/Field/Method/Package这些类都实现了AnnotatedElement接口 注:只有当定义Annotation时使用了@Retention(RetentionPolicy.RUNTIME)修饰, JVM才会在装载class文件时提取保存在class文件中的Annotation,该Annotation才会在运行时可见,这样我们才能够解析
  1. Java注解(Annotation)
    Java注解是附加在代码中的一些元信息,用于一些工具在编译、
    运行时进行解析和使用,起到说明、配置的功能。

    注解相关类都包含在java.lang.annotation包中。

  2. Java注解分类
    2.1 JDK基本注解
    2.2 JDK元注解
    2.3 自定义注解
  3. JDK基本注解
    3.1 @Override

    重写

    3.2 @Deprecated

    已过时 

    3.3 @SuppressWarnings(value = "unchecked")

    压制编辑器警告
    
    
  4. JDK元注解
    元注解用于修饰其他的注解(纪委:管干部的干部)
    4.1 @Retention:定义注解的保留策略

    @Retention(RetentionPolicy.SOURCE)             //注解仅存在于源码中,在class字节码文件中不包含
    @Retention(RetentionPolicy.CLASS)              //默认的保留策略,注解会在class字节码文件中存在,但运行时无法获得,
    @Retention(RetentionPolicy.RUNTIME)            //注解会在class字节码文件中存在,在运行时可以通过反射获取到
    

    4.2 @Target:指定被修饰的Annotation可以放置的位置(被修饰的目标)

    @Target(ElementType.TYPE)                      //接口、类
    @Target(ElementType.FIELD)                     //属性
    @Target(ElementType.METHOD)                    //方法
    @Target(ElementType.PARAMETER)                 //方法参数
    @Target(ElementType.CONSTRUCTOR)               //构造函数
    @Target(ElementType.LOCAL_VARIABLE)            //局部变量
    @Target(ElementType.ANNOTATION_TYPE)           //注解
    @Target(ElementType.PACKAGE)                   //包 
    
    注:可以指定多个位置,例如:

@Target({ElementType.METHOD, ElementType.TYPE}),也就是此注解可以在方法和类上面使用

4.3 @Inherited:指定被修饰的Annotation将具有继承性

4.4 @Documented:指定被修饰的该Annotation可以被javadoc工具提取成文档.

  1. 注解分类
    根据Annotation是否包含成员变量,可以把Annotation分为两类:
    5.1 标记Annotation:

没有成员变量的Annotation; 这种Annotation仅利用自身的存在与否来提供信息
5.2 元数据Annotation:

  包含成员变量的Annotation; 它们可以接受(和提供)更多的元数据;

自定义注解开发
使用@interface关键字, 其定义过程与定义接口非常类似, 需要注意的是:
Annotation的成员变量在Annotation定义中是以无参的方法形式来声明的, 其方法名和返回值类型定义了该成员变量的名字和类型,
而且我们还可以使用default关键字为这个成员变量设定默认值,例如:

@Inherited

@Retention(RetentionPolicy.RUNTIME)

@Target({ElementType.METHOD, ElementType.TYPE})

public @interface Tag {

 String name() default "该叫啥才好呢?";


 String description() default "这家伙很懒, 啥也没留下...";

}

注1:只有名字为“value”属性,赋值时可以省略属性名

  1. 提取Annotation信息
    使用AnnotatedElement接口中的方法提取注解中的数据,像Class/Constructor/Field/Method/Package这些类都实现了AnnotatedElement接口
    注:只有当定义Annotation时使用了@Retention(RetentionPolicy.RUNTIME)修饰,

     JVM才会在装载class文件时提取保存在class文件中的Annotation,该Annotation才会在运行时可见,这样我们才能够解析
    

    案例一:提供类的注解
    案例二:属性上的注解
    案例三:方法上的注解

  2. 注解处理器
    8.1 使用Annotation修饰了类/方法/成员变量等之后,这些Annotation不会自己生效,为了让程序中的这些注解起作用,

    必须由这些注解的开发者为这些注解提供一个注解处理器(Annotation Processor)。另外,在编译期间,
    JVM会自动运行注解处理器(当然,我们需要将其注册)
    

    8.2 创建注解处理器

    自定义处理器都需要继承于AbstractProcessor
    init(ProcessingEnvironment processingEnv):每一个注解处理器类都必须有一个空的构造函数。init()方法会被注解处理工具调用,并输入ProcessingEnviroment参数。ProcessingEnviroment提供很多有用的工具类Elements, Types和Filer。
    process(Set<? extends TypeElement> annotations, RoundEnvironment 

env):这是最重要的一个方法,你在这里写你的扫描、评估和处理注解的代码,以及生成Java文件。输入参数RoundEnviroment,可以让你查询出包含特定注解的被注解元素

  
  getSupportedAnnotationTypes():该注解处理器是注册到哪些注解上。它的返回值是一个字符串的集合,包含本处理器想要处理的注解类型的合法全称。    
  getSupportedSourceVersion():用来指定你使用的Java版本。通常这里返回SourceVersion.latestSupported()。然而,如果你有足够的理由只支持Java 7的话,你也可以返回SourceVersion.RELEASE_7。

  注1:在Java7还可以使用如下两个注解,而不用重写getSupportedAnnotationTypes()和getSupportedSourceVersion()
  @SupportedSourceVersion(SourceVersion.latestSupported())
  @SupportedAnnotationTypes({// 合法注解全名的集合})

  但要考虑代码兼容性的原因,特别是针对Android平台,我建议使用重载getSupportedAnnotationTypes()
  和getSupportedSourceVersion()方法代替@SupportedAnnotationTypes和@SuppozrtedSourceVersion

  注2:init方法参数详解:ProcessingEnvironment
       Elements elementUtils = processingEnv.getElementUtils();//一个用来处理Element的工具类;
       Types typeUtils = processingEnv.getTypeUtils();         //一个用来处理TypeMirror的工具类;
       Filer filer = processingEnv.getFiler();                 //正如这个名字所示,使用Filer你可以创建文件;       
       Messager messager = processingEnv.getMessager();        //一个用来处理消息的工具类,为了输出错误信息。
                                                               //因为在注解处理器里面不可以抛出Exception!
                                                               //为什么了?因为在编译阶段抛出错误后,注解处理器就不会运行完,
                                                               //也就没什么用了。 所以Message就是为了输出错误信息 

       private void error(Element e, String msg, Object... args) {
         messager.printMessage(
            Diagnostic.Kind.ERROR,
            String.format(msg, args),
            e);
       }

       
  注3:Element代表的是源代码,它的子类有这些:
       PackageElement:包名
       TypeElement:类
       VariableElement:变量
       ExecutableElement:方法
       详细见资料“Car.java”
      
  注4:process方法返回true即是退出处理
       return true; // 退出处理
       
       

8.3 注册注解处理器(静态处理器,非AOP处理)

8.3.1 手动
      在当前项目中的resources/META-INF/services目录需要新建一个特殊的文件javax.annotation.processing.Processor
      javax.annotation.processing.Processor文件的内容是注解处理器的合法的全名列表,每一个元素换行分割
      - META-INF 
      - - services 
      - - - javax.annotation.processing.Processor           

8.3.2 使用google的auto-service项目
      1. 导入依赖
         <dependency>
           <groupId>com.google.auto.service</groupId>
           <artifactId>auto-service</artifactId>
           <version>1.0-rc4</version>
         </dependency>
      2. 在注解处理器上添加@AutoService(Processor.class)即可

8.4 Maven打包(打包涵依赖jar包 )

   MAVEN打AR包,注意还要将依赖打到Jar包中。详情见资料“test1-pom.xml”


  1. 动态注解处理器(spring aop方式)

附录一:本章英语单词
Retention:保留
Policy:策略
RUNTIME:运行时间
Annotation:注释

@Service用于标注业务层组件

@Controller用于标注控制层组件(如struts中的action)

@Repository用于标注数据访问组件,即DAO组件

@Component泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。

@Aspect//切面

@Pointcut//定义需要切面的地方,表达式参数(https://blog.csdn.net/elim168/article/details/78150438

@annotation//当执行的方法上拥有指定的注解时生效。

@After

@Before

@Around

相关文章
|
7天前
|
XML Java 数据格式
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
25 0
|
25天前
|
Java Spring
在使用Spring的`@Value`注解注入属性值时,有一些特殊字符需要注意
【10月更文挑战第9天】在使用Spring的`@Value`注解注入属性值时,需注意一些特殊字符的正确处理方法,包括空格、引号、反斜杠、新行、制表符、逗号、大括号、$、百分号及其他特殊字符。通过适当包裹或转义,确保这些字符能被正确解析和注入。
|
14天前
|
XML JSON Java
SpringBoot必须掌握的常用注解!
SpringBoot必须掌握的常用注解!
40 4
SpringBoot必须掌握的常用注解!
|
1月前
|
XML Java 数据格式
Spring从入门到入土(bean的一些子标签及注解的使用)
本文详细介绍了Spring框架中Bean的创建和使用,包括使用XML配置文件中的标签和注解来创建和管理Bean,以及如何通过构造器、Setter方法和属性注入来配置Bean。
66 9
Spring从入门到入土(bean的一些子标签及注解的使用)
|
16天前
|
存储 缓存 Java
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
56 2
|
16天前
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
32 1
|
30天前
|
架构师 Java 开发者
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
在40岁老架构师尼恩的读者交流群中,近期多位读者成功获得了知名互联网企业的面试机会,如得物、阿里、滴滴等。然而,面对“Spring Boot自动装配机制”等核心面试题,部分读者因准备不足而未能顺利通过。为此,尼恩团队将系统化梳理和总结这一主题,帮助大家全面提升技术水平,让面试官“爱到不能自已”。
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
|
10天前
|
存储 安全 Java
springboot当中ConfigurationProperties注解作用跟数据库存入有啥区别
`@ConfigurationProperties`注解和数据库存储配置信息各有优劣,适用于不同的应用场景。`@ConfigurationProperties`提供了类型安全和模块化的配置管理方式,适合静态和简单配置。而数据库存储配置信息提供了动态更新和集中管理的能力,适合需要频繁变化和集中管理的配置需求。在实际项目中,可以根据具体需求选择合适的配置管理方式,或者结合使用这两种方式,实现灵活高效的配置管理。
10 0
|
1月前
|
XML Java 数据库
Spring boot的最全注解
Spring boot的最全注解
|
1月前
|
JSON NoSQL Java
springBoot:jwt&redis&文件操作&常见请求错误代码&参数注解 (九)
该文档涵盖JWT(JSON Web Token)的组成、依赖、工具类创建及拦截器配置,并介绍了Redis的依赖配置与文件操作相关功能,包括文件上传、下载、删除及批量删除的方法。同时,文档还列举了常见的HTTP请求错误代码及其含义,并详细解释了@RequestParam与@PathVariable等参数注解的区别与用法。