0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

Java中注解的作用

科技绿洲 来源:Java技术指北 作者:Java技术指北 2023-09-30 10:12 次阅读

Annotation

注解(Annotation),也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性,与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释。作用分类:

  1. 编写文档:通过代码里标识的元数据生成文档【生成文档doc文档】
  2. 代码分析:通过代码里标识的元数据对代码进行分析【使用反射】
  3. 编译检查:通过代码里标识的元数据让编译器能够实现基本的编译检查【Override】

注解不会改变程序的语义,只是作为注解(标识)存在,我们可以通过反射机制编程实现对这些元数据(用来描述数据的数据)的访问

分类

  • 运行期注解 程序运行时才会被解析到的注解,一般通过反射机制来实现,很多框架中都会用到,经常会看到一个注解和一些简单的配置来实现非常复杂的功能
  • 编译期注解 一般用来解析类型元数据,根据特定注解解析并生成代码,或者生成一些描述性文件,比如properties、json等,比如为Pojo生成getter和setter方法

关键注解

@java.lang.annotation.Retention定义注解的有效时期

相关参数:RetentionPolicy.SOURCE: 编译期生效,编译器会丢弃,编译后的class文件并不包含该注解 RetentionPolicy.CLASS: 注解会被保留在class文件中,但是运行期不会生效,被JVM忽略 RetentionPolicy.RUNTIME: 注解会被保留在class文件中,并且会在运行期生效,JVM会读取

@Target定义注解作用对象,也就是注解是可以用在类、方法、参数还是其他等待

相关参数:ElementType.TYPE: 该注解只能运用到Class, Interface, enum上 ElementType.FIELD: 该注解只能运用到Field上 ElementType.METHOD: 该注解只能运用到方法上 ElementType.PARAMETER: 该注解只能作用在参数上 ElementType.CONSTRUCTOR: 该注解只能作用在构造方法上 ElementType.LOCAL_VARIABLE: 该注解作用在地变量或catch语句 ElementType.ANNOTATION_TYPE: 该注解只能作用在注解上 ElementType.PACKAGE: 该注解只能用在包上


Java中常见的内置注解:

  • @Override
  • @Deprecated
  • @SuppressWarnings

继承关系

  • @Inherited

如果某个注解上有@Inherited注解,当查找该类型的注解时,会先查找目标类型是否存在注解,如果有,直接返回;否则,继续在父类上寻找注解, 停止的条件为在父类上找到该类型的注解或者父类为Object类型。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Inherited
public @interface ClassMapper {

}

下面的示例中,如果ClassMapper没有@Inherited修饰,则返回null

Child.class.getAnnotation(ClassMapper.class);
@Slf4j
public class ExtendAnnotationTests {
    @ClassMapper
    public class Demo { }

    public class Child extends Demo{  }
}
  • 元注解 (注解上的注解)

我们知道,在Spring中,注解@Service与@Component都是用来标记类,交由Spring容器管理其对应的Bean,是结果是等效的。主要是Spring将注解和元注解进行了合并

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Mapper {

}

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Mapper
public @interface ClassMapper {

}

通过下面的方法可以拿到元注解,从而进行其他扩展。

public class Tests {
    @Test
    public void test(){
        ClassMapper classMapper = Demo.class.getAnnotation(ClassMapper.class);
        log.info("classMapper: {}", classMapper);
        Mapper mapper = classMapper.annotationType().getAnnotation(Mapper.class);
        log.info("mapper: {}", mapper);
    }
}

示例

示例主要针对@java.lang.annotation.Retention参数的三种情况,了解注解是生效时期:

RetentionPolicy.RUNTIME

该示例实现通过自定义注解@SystemProperty,实现为对象字段设置系统属性

  1. 定义注解@SystemProperty
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@Documented
public @interface SystemProperty {

    String value();
}
  1. 定义对象工厂

主要作用是在运行时解析注解@SystemProperty,并实现系统属性注入的逻辑。前面说到,注解的作用主要是标记,针对RetentionPolicy.RUNTIME类型的注解,一般是在运行时 通过反射实现注解标识的类、字段或方法等等元数的处理过程。

ObjectFactory是一个对象生产工厂,这样我们可以在运行期解析目标对象中的是否有@SystemProperty标识的字段,并对该字段进行值的设定,这样式该注解设计的初衷,但是 实现需要我们根据需求实现

@Slf4j
public class ObjectFactory {
    // 省略 ...
  
    public static < T > T getObject(Class< T > type, Object... args){
        Constructor< T > constructor = findTypeConstructor(type, args);
        T object = constructor.newInstance(args);
        // 通过反射找到对象中@SystemProperty的字段,并根据其设置参数将系统属性设定到该对象字段中
        processFieldAnnotations(object, type, SystemProperty.class);
        return object;
    }
    
    // 省略 ...  
}
  1. 验证
    可以查看对象中被注解标识的属性被设置上去了
@Slf4j
public class RuntimeAnnotationTests {
    @Test
    public void run(){
        Demo demo = ObjectFactory.getObject(Demo.class);
        log.info(" >> result: {}", demo.user);
    }

    @Data
    public static class Demo{
        @SystemProperty("user.name")
        private String user;
    }
}

RetentionPolicy.CLASS

该示例主要实现,编译器判断通过@FinalClass注解标记的类是否为final类型

  1. 定义注解
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
@Documented
public @interface FinalClass {

}
  1. 编写AbstractProcessor的实现
@SupportedAnnotationTypes({FinalClassProcessor.FINAL_CLASS})
@SupportedSourceVersion(SourceVersion.RELEASE_8)
@AutoService(Processor.class)
public class FinalClassProcessor extends AbstractProcessor {

    public static final String FINAL_CLASS = "com.sucl.blog.jdk.annotation.compile.FinalClass";
    
    @Override
    public boolean process(Set< ? extends TypeElement > annotations, RoundEnvironment roundEnv) {
        TypeElement annotationType = this.processingEnv.getElementUtils().getTypeElement(FINAL_CLASS);
        if( annotationType != null ){
            for (Element element : roundEnv.getElementsAnnotatedWith(annotationType)) {
                if( element instanceof TypeElement ){
                    TypeElement typeElement = (TypeElement) element;
                    if( !typeElement.getModifiers().contains(Modifier.FINAL) ){
                        String message = String.format("类【%s】必须为final类型", typeElement);
                        this.processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, message);
                    }
                }
            }
        }
        return true;
    }
}
  1. 使FinalClassProcessor生效
  • 基于google auto-service
    3.1 添加依赖
< dependency >
      < groupId >com.google.auto.service< /groupId >
      < artifactId >auto-service< /artifactId >
      < version >1.1.0< /version >
    < /dependency >

3.2 在Processor通过注解@AutoService标识

@AutoService(Processor.class)
public class FinalClassProcessor extends AbstractProcessor{}
  • 基于maven插件
< plugin >
    < groupId >org.apache.maven.plugins< /groupId >
    < artifactId >maven-compiler-plugin< /artifactId >
    < configuration >
        < annotationProcessors >
            < annotationProcessor >
                com.sucl.blog.jdk.annotation.compile.FinalClassProcessor
            < /annotationProcessor >
        < /annotationProcessors >
    < /configuration >
< /plugin >
  1. 验证

打包,在项目中引入该jar,定义一个类,类似下面这样,当该类没有final修饰时,通过maven install命令,可以看到控制台打印自定义的错误信息

@FinalClass
public final class ProcessorFinder {}

图片

注意

RetentionPolicy.CLASS的使用需要达打成jar包才行,不然无法再编译时处理注解

RetentionPolicy.SOURCE

定义一个注解,通过打包后的结果观察该注解的状态

  1. 定义注解
@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE)
@Documented
public @interface System {
    
}
  1. 定义测试类,并通过@System修饰
@System
public class SystemProvider {

}
  1. 打包,借助maven-source-plugin同时将源码打包
< plugins >
        < plugin >
            < groupId >org.apache.maven.plugins< /groupId >
            < artifactId >maven-source-plugin< /artifactId >
            < version >3.2.1< /version >
            < executions >
                < execution >
                    < id >attach-sources< /id >
                    < goals >
                        < goal >jar< /goal >
                    < /goals >
                < /execution >
            < /executions >
        < /plugin >
    < /plugins >
  1. 在源码包中,可以看到该注解仍然存在,但是class文件中却没有

在基于Spring Boot开发项目时,我们一般通过 @ConfigurationProperties 配合 spring-boot-configuration-processor ,可以实现在项目打包时 生成一个spring-configuration-metadata.json的配置描述文件,这样在编写application.yml配置时,就会得到配置提示,其实现方式就是基于 ConfigurationMetadataAnnotationProcessor,


结束语

注解本身没有含义,主要作用是标记目标元素,后续拿到改标识的元数据,进行一系列的处理。注解的使用是非常广泛的,各种框架中都使用频繁,基于注解可以将很多抽象功能提取出来,通过简单 的标识来实现各种复杂的功能

声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • JAVA
    +关注

    关注

    19

    文章

    2957

    浏览量

    104534
  • 代码
    +关注

    关注

    30

    文章

    4741

    浏览量

    68326
  • 编译器
    +关注

    关注

    1

    文章

    1618

    浏览量

    49043
  • 元数据
    +关注

    关注

    0

    文章

    32

    浏览量

    9125
  • 注解
    +关注

    关注

    0

    文章

    18

    浏览量

    2668
收藏 人收藏

    评论

    相关推荐

    Java中常见的注解

    Annotation 注解(Annotation),也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性,与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量
    的头像 发表于 09-30 15:35 587次阅读
    <b class='flag-5'>Java</b>中常见的<b class='flag-5'>注解</b>

    如何通过注解来优化我们的Java代码

    Java注解可以说是我们编码过程中最常用的。本篇文章将给大家介绍Java注解的概念、作用以及如何使用注解
    的头像 发表于 09-30 11:39 592次阅读

    详细介绍了Java泛型、注解、并发编程

    介绍了Java泛型、注解、并发编程、数据传输与序列化、高效IO、容器集合、反射与类加载以及JVM重点知识线程、内存模型、JVM运行时内存、垃圾回收与算法、Java中四种引用类型、GC 分代收集算法
    发表于 08-20 06:09

    HarmonyOS注解的使用方法分享

    概述主要作用:简化代码,提高开发效率。通过自定义的注解使我们能够在源码阶段、编译阶段、运行阶段对代码进行操控。减轻编写”样板”代码的负担,使代码干净易读。元注解在自定义注解的时候,需要
    发表于 03-28 14:04

    关于Java变量的作用域分析

    目录 1.静态作用域与动态作用域 2.变量的作用域 3.Java 中变量的作用域 4.Java
    发表于 09-25 16:28 0次下载

    分析java注解基本概念

    什么是注解(Annotation): Annotation(注解)就是Java提供了一种元程序中的元素关联任何信息和着任何元数据(metadata)的途径和方法。Annotion(注解
    发表于 09-27 14:53 0次下载

    Spring Boot中常见的各类型注解的使用方式

    大家好,我是程序汪,企业开发项目SpringBoot已经是必备框架了,其中注解是开发中的小工具(谁处可见哦),用好了开发效率大大提升,当然用错了也会引入缺陷。
    的头像 发表于 06-20 16:38 1756次阅读

    Spring Boot常用注解与使用方式

    企业开发项目SpringBoot已经是必备框架了,其中注解是开发中的小工具(谁处可见哦),用好了开发效率大大提升,当然用错了也会引入缺陷。
    的头像 发表于 07-08 10:57 1337次阅读

    注解定义Bean及开发

    注解本质是一个继承了Annotation 的特殊接口,其具体实现类是Java 运行时生成的动态代理类。
    发表于 08-02 10:26 430次阅读

    容器配置及Spring Boot注解

    Autowired注解用于标记Spring将要解析和注入的依赖项。此注解可以作用在构造函数、字段和setter方法上。
    的头像 发表于 04-07 11:45 557次阅读
    容器配置及Spring Boot<b class='flag-5'>注解</b>

    JAVA中注解是怎么做到的(上)

    。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释。那么你知道JDK什么是元注解吗?注解有哪些分类吗?以及注解Java中最本质究竟是什么东西,
    的头像 发表于 05-11 10:57 618次阅读

    JAVA中注解是怎么做到的(下)

    。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释。那么你知道JDK什么是元注解吗?注解有哪些分类吗?以及注解Java中最本质究竟是什么东西,
    的头像 发表于 05-11 10:57 546次阅读
    <b class='flag-5'>JAVA</b><b class='flag-5'>中注解</b>是怎么做到的(下)

    3分钟纯Java注解搭个管理系统

    Erupt一个通用后台管理框架,据说有 超低代码量 、 零前端代码 、零 CURD操作 、无需建表 ,纯Java注解开发 等特色,号称三分钟就可以搭建一个完整的后台管理系统。
    的头像 发表于 07-28 11:27 1045次阅读
    3分钟纯<b class='flag-5'>Java</b><b class='flag-5'>注解</b>搭个管理系统

    Java Agent的作用及原理

    Java Agent相关的信息。下面给大家盘一盘Java Agent! 1 Java Agent的作用 Java Agent是
    的头像 发表于 10-10 15:53 1649次阅读
    <b class='flag-5'>Java</b> Agent的<b class='flag-5'>作用</b>及原理

    springmvc常用5种注解

    SpringMVC是一种基于Java的Web框架,使用注解可以更加方便灵活地开发和管理控制器,实现请求的映射和处理。在SpringMVC中,有许多常用的注解,本文将详细介绍其中的五种注解
    的头像 发表于 11-22 16:51 804次阅读