Java Annotation(注解)

最新推荐文章于 2022-09-18 10:21:39 发布
最新推荐文章于 2022-09-18 10:21:39 发布
阅读量708 收藏 1
点赞数
分类专栏： Java 文章标签： java annotations deprecated interface string javadoc

  Annotation(注释)是 JDK5.0 及以后版本引入的。它可以用于创建文档，跟踪代码中的依赖性，甚至执行基本编译时检查。注释是以 @注释名 在代码中存在的，根据注释参数的个数，我们可以将注释分为：标记注释、单值注释、完整注释三类。它们都不会直接影响到程序的语义，只是作为注释(标识)存在，我们可以通过反射机制编程实现对这些元数据的访问。另外，你可以在编译时选择代码里的注释是否只存在于源代码级，或者它也能在 class 文件中出现。

        如果要对于元数据的作用进行分类，目前还没有明确的定义，不过我们可以根据它所起的作用，大致可分为三类：

  1. 编写文档：通过代码里标识的元数据生成文档
  2. 代码分析：通过代码里标识的元数据对代码进行分析
  3. 通过代码里标识的元数据让编译器能实现基本的编译检查


        ● 基本内置注释
        @Override
        不用多说，用来标注方法是覆写父类的方法。

        @Deprecated
        @Deprecated 的作用是对不应该在使用的类或方法添加注释，当编程人员使用这些类或方法时，将会在编译时显示提示信息，它与 javadoc 里的 @deprecated 标记有相同的功能，准确的说，它还不如 javadoc @deprecated，因为它不支持参数。

        @SuppressWarnings
        @SuppressWarnings 允许你选择性地取消特定代码段(即，类或方法)中的警告。其中的想法是当你看到警告时，你将调查它，如果你确定它不是问题，你就可以添加一个 @SuppressWarnings 注解，以使你不会再看到警告。虽然它听起来似乎会屏蔽潜在的错误，但实际上它将提高代码安全性，因为它将防止你对警告无动于衷 — 你看到的每一个警告都将值得注意。
        @SuppressWarnings 有如下参数：
        deprecation: 使用了过时的类或方法时的警告
        unchecked: 执行了未检查的转换时的警告
        fallthrough: 当 switch 程序块直接通往下一种情况而没有 Break 时的警告
        path: 在类路径、源文件路径等中有不存在的路径时的警告
        serial: 当在可序列化的类上缺少 serialVersionUID 定义时的警告
        finally: 任何 finally 子句不能正常完成时的警告
        all: 关于以上所有情况的警告

        ● 自定义注释
        它类似于新创建一个接口类文件，但为了区分，我们需要将它声明为 @interface，如下例：

Java代码 复制代码
  1. public @interface MyAnnotation {   
  2.   
  3. }  
public @interface MyAnnotation {

}


        使用自定义的注释类型：

Java代码 复制代码
  1. public class AnnotationTest {   
  2.     @MyAnnotation    
  3.     public static void main(String[] args) {   
  4.        
  5.     }   
  6. }  
public class AnnotationTest {
    @MyAnnotation 
    public static void main(String[] args) {
    
    }
}


        为自定义注释添加变量：

Java代码 复制代码
  1. public @interface MyAnnotation {    
  2.     String value();    
  3. }  
public @interface MyAnnotation { 
    String value(); 
}

 

Java代码 复制代码
  1. public class AnnotationTest {    
  2.     @MyAnnotation("main method")    
  3.     public static void main(String[] args) {    
  4.         saying();    
  5.     }    
  6.        
  7.     @MyAnnotation(value = "say method")    
  8.     public static void saying() {   
  9.        
  10.     }   
  11. }  
public class AnnotationTest { 
    @MyAnnotation("main method") 
    public static void main(String[] args) { 
        saying(); 
    } 
    
    @MyAnnotation(value = "say method") 
    public static void saying() {
    
    }
}


        定义一个枚举类型，然后将参数设置为该枚举类型，并赋予默认值：

Java代码 复制代码
  1. public @interface Greeting {      
  2.     public enum FontColor {   
  3.         BLUE,RED,GREEN   
  4.     }   
  5.        
  6.     String name();   
  7.     FontColor fontColor() default FontColor.RED;   
  8. }  
public @interface Greeting {   
    public enum FontColor {
        BLUE,RED,GREEN
    }
	
    String name();
    FontColor fontColor() default FontColor.RED;
}


        这里有两种选择，其实变数也就是在赋予默认值的参数上，我们可以选择使用该默认值，也可以重新设置一个值来替换默认值：

Java代码 复制代码
  1. @MyAnnonation("main method")   
  2. public static void main(String[] args) {   
  3.     saying();      
  4.     sayHelloWithDefaultFontColor();      
  5.     sayHelloWithRedFontColor();      
  6.   
  7. }   
  8.   
  9. @MyAnnonation("say method")   
  10. public static void saying() {   
  11.            
  12. }   
  13.   
  14. // 此时的 fontColor 为默认的 RED   
  15. @Greeting(name="defaultfontcolor")   
  16. public static void sayHelloWithDefaultFontColor() {      
  17.            
  18. }   
  19.   
  20. //现在将 fontColor 改为 BLUE   
  21. @Greeting(name="notdefault",fontColor=Greeting.FontColor.BLUE)   
  22. public static void sayHelloWithRedFontColor() {      
  23.               
  24. }  
@MyAnnonation("main method")
public static void main(String[] args) {
    saying();   
    sayHelloWithDefaultFontColor();   
    sayHelloWithRedFontColor();   

}

@MyAnnonation("say method")
public static void saying() {
    	
}

// 此时的 fontColor 为默认的 RED
@Greeting(name="defaultfontcolor")
public static void sayHelloWithDefaultFontColor() {   
        
}

//现在将 fontColor 改为 BLUE
@Greeting(name="notdefault",fontColor=Greeting.FontColor.BLUE)
public static void sayHelloWithRedFontColor() {   
           
}



        ● 注释的高级应用
        限制注释的使用范围
        用 @Target 指定 ElementType 属性：

Java代码 复制代码
  1. package java.lang.annotation;   
  2.   
  3. public enum ElementType {      
  4.     // 用于类，接口，枚举但不能是注释   
  5.     TYPE,   
  6.     // 字段上，包括枚举值     
  7.     FIELD,   
  8.     // 方法，不包括构造方法   
  9.     METHOD,   
  10.     // 方法的参数   
  11.     PARAMETER,   
  12.     // 构造方法   
  13.     CONSTRUCTOR,     
  14.     // 本地变量或 catch 语句   
  15.     LOCAL_VARIABLE,   
  16.     // 注释类型(无数据)   
  17.     ANNOTATION_TYPE,   
  18.     // Java 包   
  19.     PACKAGE   
  20. }  
package java.lang.annotation;

public enum ElementType {   
    // 用于类，接口，枚举但不能是注释
    TYPE,
    // 字段上，包括枚举值  
    FIELD,
    // 方法，不包括构造方法
    METHOD,
    // 方法的参数
    PARAMETER,
    // 构造方法
    CONSTRUCTOR,  
    // 本地变量或 catch 语句
    LOCAL_VARIABLE,
    // 注释类型(无数据)
    ANNOTATION_TYPE,
    // Java 包
    PACKAGE
}


        注解保持性策略

Java代码 复制代码
  1. // 限制注解使用范围   
  2. @Target({ElementType.METHOD, ElementType.CONSTRUCTOR})   
  3. public @interface Greeting {   
  4.     // 使用枚举类型   
  5.     public enum FontColor {   
  6.         BLUE,RED,GREEN   
  7.     }   
  8.        
  9.     String name();   
  10.     FontColor fontColor() default FontColor.RED;   
  11. }  
// 限制注解使用范围
@Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
public @interface Greeting {
    // 使用枚举类型
    public enum FontColor {
        BLUE,RED,GREEN
    }
    
    String name();
    FontColor fontColor() default FontColor.RED;
}


        在 Java 编译器编译时，它会识别在源代码里添加的注释是否还会保留，这就是 RetentionPolicy。下面是 Java 定义的 RetentionPolicy枚举(编译器的处理有三种策略)：

  1. 将注释保留在编译后的类文件中，并在第一次加载类时读取它
  2. 将注释保留在编译后的类文件中，但是在运行时忽略它
  3. 按照规定使用注释，但是并不将它保留到编译后的类文件中

 

Java代码 复制代码
  1. package java.lang.annotation;   
  2.   
  3. public enum RetentionPolicy {      
  4.     // 此类型会被编译器丢弃   
  5.     SOURCE,   
  6.     // 此类型注释会保留在class文件中，但JVM会忽略它   
  7.     CLASS,      
  8.     // 此类型注释会保留在class文件中，JVM会读取它   
  9.     RUNTIME    
  10. }  
package java.lang.annotation;

public enum RetentionPolicy {   
    // 此类型会被编译器丢弃
    SOURCE,
    // 此类型注释会保留在class文件中，但JVM会忽略它
    CLASS,   
    // 此类型注释会保留在class文件中，JVM会读取它
    RUNTIME 
}

 

Java代码 复制代码
  1. // 让保持性策略为运行时态，即将注解编码到 class 文件中，让虚拟机读取   
  2. @Retention(RetentionPolicy.RUNTIME)   
  3. public @interface Greeting {   
  4.     //使用枚举类型   
  5.     public enum FontColor {   
  6.         BLUE,RED,GREEN   
  7.     };   
  8.        
  9.     String name();   
  10.     FontColor fontColor() default FontColor.RED;   
  11. }  
// 让保持性策略为运行时态，即将注解编码到 class 文件中，让虚拟机读取
@Retention(RetentionPolicy.RUNTIME)
public @interface Greeting {
    //使用枚举类型
    public enum FontColor {
        BLUE,RED,GREEN
    };
    
    String name();
    FontColor fontColor() default FontColor.RED;
}


        文档化功能
        Java 提供的 Documented 元注释跟 Javadoc 的作用是差不多的，其实它存在的好处是开发人员可以定制 Javadoc 不支持的文档属性，并在开发中应用。它的使用跟前两个也是一样的，简单代码示例如下：

Java代码 复制代码
  1. // 让它定制文档化功能   
  2. // 使用此注解时必须设置 RetentionPolicy 为 RUNTIME   
  3. @Documented  
  4. public @interface Greeting {   
  5.     //使用枚举类型   
  6.     public enum FontColor{   
  7.         BLUE,RED,GREEN   
  8.     };   
  9.        
  10.     String name();   
  11.     FontColor fontColor() default FontColor.RED;   
  12. }  
// 让它定制文档化功能
// 使用此注解时必须设置 RetentionPolicy 为 RUNTIME
@Documented
public @interface Greeting {
    //使用枚举类型
    public enum FontColor{
        BLUE,RED,GREEN
    };
    
    String name();
    FontColor fontColor() default FontColor.RED;
}



        标注继承

Java代码 复制代码
  1. // 让它允许继承，可作用到子类   
  2. @Inherited  
  3. public @interface Greeting {   
  4.     //使用枚举类型   
  5.     public enum FontColor{   
  6.         BLUE,RED,GREEN   
  7.     };   
  8.        
  9.     String name();   
  10.     FontColor fontColor() default FontColor.RED;   
  11. }  
// 让它允许继承，可作用到子类
@Inherited
public @interface Greeting {
    //使用枚举类型
    public enum FontColor{
        BLUE,RED,GREEN
    };
    
    String name();
    FontColor fontColor() default FontColor.RED;
}



        ● 读取注解信息
        属于重点，在系统中用到注解权限时非常有用，可以精确控制权限的粒度。

Java代码 复制代码
  1. package com.iwtxokhtd.annotation;   
  2. import java.lang.annotation.Annotation;   
  3. import java.lang.reflect.Method;   
  4.   
  5. //读取注解信息   
  6. public class ReadAnnotationInfoTest {   
  7.   public static void main(String[] args)throws Exception {   
  8.     // 测试 AnnotationTest 类，得到此类的类对象   
  9.     Class c=Class.forName("com.iwtxokhtd.annotation.AnnotationTest");   
  10.     // 获取该类所有声明的方法   
  11.     Method []methods=c.getDeclaredMethods();   
  12.     // 声明注解集合   
  13.     Annotation[] annotations;   
  14.     // 遍历所有的方法得到各方法上面的注解信息   
  15.     for (Method method:methods) {   
  16.       // 获取每个方法上面所声明的所有注解信息   
  17.       annotations=method.getDeclaredAnnotations();   
  18.       // 再遍历所有的注解，打印其基本信息   
  19.       for (Annotation an:annotations) {   
  20.         System.out.println("方法名为："+ method.getName() + " 其上面的注解为：" +    
  21.             an.annotationType().getSimpleName());   
  22.         Method []meths=an.annotationType().getDeclaredMethods();   
  23.         // 遍历每个注解的所有变量   
  24.         for (Method meth:meths) {   
  25.           System.out.println("注解的变量名为："+meth.getName());   
  26.         }   
  27.       }   
  28.     }   
  29.   }   
  30. }  
package com.iwtxokhtd.annotation;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

//读取注解信息
public class ReadAnnotationInfoTest {
  public static void main(String[] args)throws Exception {
    // 测试 AnnotationTest 类，得到此类的类对象
    Class c=Class.forName("com.iwtxokhtd.annotation.AnnotationTest");
    // 获取该类所有声明的方法
    Method []methods=c.getDeclaredMethods();
    // 声明注解集合
    Annotation[] annotations;
    // 遍历所有的方法得到各方法上面的注解信息
    for (Method method:methods) {
      // 获取每个方法上面所声明的所有注解信息
      annotations=method.getDeclaredAnnotations();
      // 再遍历所有的注解，打印其基本信息
      for (Annotation an:annotations) {
        System.out.println("方法名为："+ method.getName() + " 其上面的注解为：" + 
            an.annotationType().getSimpleName());
        Method []meths=an.annotationType().getDeclaredMethods();
        // 遍历每个注解的所有变量
        for (Method meth:meths) {
          System.out.println("注解的变量名为："+meth.getName());
        }
      }
    }
  }
}
tianlincao
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Java annotation diff getAnnotation and getDeclaredAnnotation
修也
07-05 2561
package xy.core.test; import java.lang.annotation.ElementType; import java.lang.annotation.Inherited; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java....
@Repeatable详解-getAnnotation、getDeclaredAnnotation获取不到对象
热门推荐
beFocused的博客
03-11 1万+
dk8之前不存在可重复注解，如果想添加多个相同注解，只能用容器注解。jdk8引入了@Repeatable元注解。被@Repeatable修饰的注解即是可重复使用在同一个元素上的。getAnnotation、getAnnotations、getAnnotationsByType、getDeclaredAnnotation、getDeclaredAnnotations()、getDeclaredAnnotationsByType这些方法获取的都是运行时注解
Java_Annotation
小特
03-28 355
内容概述Annotation概述基本AnnotationJDK的元Annotation自定义Annotation注解分类一、Annotation概述        Annotation,其实是代码里的特殊标记，这些标记可以在编译、类加载、运行时被读取，并执行相应的处理。通过使用注解，程序开发人员可以在不改变原有逻辑的情况下，在源文件中嵌入一些补充的信息。代码分析工具、开发工具和部署工具可以通过这些...
java declared_Java Class getDeclaredAnnotation()用法及代码示例
weixin_36056010的博客
02-13 1247
如果此类中存在声明的注释，则使用java.lang.Class类的getDeclaredAnnotation()方法获取指定的声明的注释类型的声明的注释。该方法以对象的形式返回该类。用法:public T getDeclaredAnnotation(Class declared annotationClass)参数：此方法接受一个声明的注释类型的参数，该参数是要获取的声明注释的类型。返回值：此方法...
注解编程 | 自定义注解
死牛胖子的技术随笔
01-04 831
目录注解的概念如何自定义注解元注解自定义注解如何使用注解通过反射得到注解通过反射得到元注解@Inherited 的用法@Repeatable 的用法待思考的问题如何快速得到注解？如何动态为元注解的属性设值？ 注解的概念 注解（Annotation）从 JDK1.5 开始引入，具有以下几个特点 注解是一种元数据形式，即注解属于 JAVA 的一种数据类型，和类、接口、数组、枚举类似 注解用来修饰类、方法、变量、参数、包 注解不会对所修饰的对象产生直接的影响 如何自定义注解 在学习如何自定义注解之前，先学习一
Java Annotation注解
09-15
本篇将深入探讨Java Annotation注解的相关知识点。 1. **注解类型**： Java提供了三种类型的注解：源码级注解、编译器级注解和运行时注解。源码级注解在编译后不保留，只用于源码阶段；编译器级注解会影响编译过程...
Java Annotation注解相关原理代码总结
08-18
在Java编程语言中，Annotation（注解）是一种元数据，它提供了一种安全的方法来将信息附加到代码中，而不必改变代码的行为。注解在编译时或运行时被读取，通常用于代码分析、编译器警告、运行时处理等。下面我们将...
java Annotation 注解
11-28
Java Annotation，也称为注解，是Java编程语言中的一种元数据机制，自JDK 5.0开始引入。注解提供了在源代码中嵌入元数据的能力，这些元数据可以被编译器、构建工具或者运行时环境用来处理代码。它们在代码中看起来...
Java Annotation注解技术
10-11
Java Annotation注解技术是自Java SE 5.0版本引入的一种元编程机制，它允许程序员在源代码的各个层面（如类、方法、变量等）添加元数据，以供编译器、JVM或第三方工具在编译时或运行时进行处理。Annotation简化了...
Java annotation元注解原理实例解析
08-19
Java Annotation元注解原理实例解析 Java annotation是Java语言中的一种元编程技术，用于在编译期或运行期提供元数据，以便简化代码、提高开发效率和程序的可读性。在这篇文章中，我们将深入探讨Java annotation的...
利用AOP编程完成mybatis 动态切换数据源
success could be revenge的博客
12-21 2509
mybatis 实现接口和xml的绑定。sql的执行等一系列处理。当我们在使用过程中需要从A服务器数据库查询某张表。B服务器数据库查询另一张表又该怎么做呢？ 实现思路 1、配置多个dataSource。 2、设置主从关系 3、定义切面监控所有 mybatis接口。。 4、利用@around注解完成对执行接口类方法的数据源切换。 5、写工具类完成切换 第一步、app
Java注解底层原理分析
weixin_42360572的博客
01-18 576
注解是什么？ 其实注解和注释是很类似，区别在于注释是给开发人员看的，而注解是给编译器和jvm看的，是可以在程序编译时被编译器获取或运行时通过反射被用户获取的。引用Think in java中的一句话:"如果没有用来读取注解的工具，那注解也不会比注释更有用"。关于如何读取注解， jdk为我们提供了一系列的api，包括AnnotatedElement类和sun.reflect.annotation包等。 注解的本质？ Annotation类的描述中说:Annotation是所有注解的父接口。那么也就是说.
Java.lang.Class类 getDeclaredAnnotations()方法有什么功能呢？
qq_25073223的博客
09-18 2101
Java.lang.Class类 getDeclaredAnnotations()方法的功能简介说明
java annotations详解_Java_注解_01_注解（Annotation）详解
weixin_39926040的博客
02-16 430
一、注解的概念Annotation(注解)是插入代码中的元数据(元数据从metadata一词译来，就是“描述数据的数据”的意思)，在JDK5.0及以后版本引入。它可以在编译期使用预编译工具进行处理, 也可以在运行期使用 Java 反射机制进行处理，用于创建文档，跟踪代码中的依赖性，甚至执行基本编译时检查。因为本质上，Annotion是一种特殊的接口，程序可以通过反射来获取指定程序元素的Annoti...
9.3 LinkedList设计思想
杨充
09-23 5377
LinkedList设计思想
Reflections中的getDeclared**与get**的区别
li346985170的专栏
10-13 2567
转自[枝叶飞扬]  http://blog.sina.com.cn/s/blog_605f5b4f0100i77k.html java.lang.Class中有关getDeclared**和get**的方法以getDeclaredMethods和getMethods为例说明：   getDeclaredMethod(s):返回自身类的所有公用（public）方法包括私有(pr
注解（Annotation）
zy_tiger的博客
03-05 1236
注解 Java类提供的基本注解： · @SuppressWarnings：取消警告。例如：当你调用了已经过时的方法时，编译器会警告你该方法已经过时。如果你认为这不是问题，可以加上@SuppressWarnings("deprecation")。压制这个警告 · @Override：覆盖父类。当要覆盖父类的方法时，可以在方法上加上这个注解，如果该方法没有覆盖父类中的方法，会报错。 · @De
JAVA注解——Annotation--简单使用
haobo__的博客
11-16 209
文章目录一、注解定义注解中的参数类型二、元注解1、什么是元注解2、四种元注解@Target@Inherited@Retention@Documented三、JAVA内置的的注解，定义在java.lang中@Override@Deprecated@SuppressWarnings四、注解的使用定义一个自定义的注解案例---用户输入判断 一、注解定义 注解（也被称为元数据）为我们在代码中添加信息提供了一种形式化的方法，使我们可以在稍后某个时刻非常方便地使用这些数据。 注解中的参数类型 注解中的参数只支持如下类
java annotation自定义注解
最新发布
10-12
Java中的注解是一种元数据，它提供了关于程序代码的额外信息。Java中有许多内置的注解，例如@Override和@Deprecated。除此之外，我们还可以自定义注解。 自定义注解需要使用@interface关键字，它类似于定义一个接口。注解可以包含元素，这些元素可以在使用注解时进行设置。下面是一个自定义注解的示例： ``` public @interface MyAnnotation { String value(); } ``` 在上面的示例中，我们定义了一个名为MyAnnotation的注解，并且它包含一个名为value的元素。我们可以在使用注解时设置这个元素的值。 下面是一个使用自定义注解的示例： ``` @MyAnnotation(value = "Hello World") public class MyClass { // ... } ``` 在上面的示例中，我们使用了我们刚刚定义的MyAnnotation注解，并且设置了它的value元素的值为"Hello World"。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值