Java 如何优雅的使用注解

时间  2019-11-06
标签 java 如何 优雅 使用 注解 栏目 Java 繁體版
原文   原文链接

什么是注解

Java注解能够想象成代码是具备生命的，注解就是对于代码中的某些鲜活的个体贴上一张标签。简单的说，注解就如同一张标签。java

元注解

元注解是能够注解到注解上的注解，或者说元注解是一种基本注解，可是它可以应用到其它的注解上面。程序员

其实说白了，元注解也是一张标签，可是它是一张特殊的标签，它的做用和目的就是给其余普通的标签进行解释说明的。数组

元注解的类型

  • @Documented安全

    若是使用@Documented修饰Annotation，则表示它能够出如今javadoc中。 定义Annotation时，@Documented无关紧要；若没有定义，则Annotation不会出如今javadoc中。bash

  • @Retentionide

    Retention 的英文意为保留期的意思。当 @Retention 应用到一个注解上的时候，它解释说明了这个注解的的存活时间。定义Annotation时，@Retention无关紧要。若没有@Retention，则@Retention的默认取值是RetentionPolicy.CLASS。函数

    它的取值以下：工具

    • RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃并忽视。
    • RetentionPolicy.CLASS 注解只被保留到编译进行的时候，在加载到 JVM 以前进行丢弃并忽略，即不会加载到JVM中。。
    • RetentionPolicy.RUNTIME 注解能够保留到程序运行的时候，它会被加载进入到 JVM 中，因此在程序运行时能够获取到它们。

  • @Targetui

    Target 是目标的意思，@Target 指定了注解运用的地方。 定义Annotation时，@Target无关紧要。如有@Target，则该Annotation只能用于它所指定的地方；若没有@Target，则该Annotation能够用于任何地方。spa

    你能够这样理解，当一个注解被 @Target 注解时，这个注解就被限定了运用的场景。

    @Target 有下面的取值

    • ElementType.PACKAGE 能够给一个包进行注解
    • ElementType.ANNOTATION_TYPE 能够给一个注解进行注解
    • ElementType.TYPE 能够给一个类型进行注解，好比类、接口、枚举
    • ElementType.CONSTRUCTOR 能够给构造方法进行注解
    • ElementType.FIELD 能够给属性进行注解
    • ElementType.METHOD 能够给方法进行注解
    • ElementType.PARAMETER 能够给一个方法内的参数进行注解
    • ElementType.LOCAL_VARIABLE 能够给局部变量进行注解

  • @Repeatable

    Repeatable 天然是可重复的意思.是指由另外一个注解来存储重复注解，在使用的时候，用存储注解来扩展重复注解。

    建立重复注解Authority时，加上@Repeatable,指向存储注解Authorities，在使用时候，直接能够重复使用Authority注解。

  • @Inherited

    @Inherited 元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。若是一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。

    注意：@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。

    当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME，则反射API加强了这种继承性。若是咱们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时，反射代码检查将展开工做：检查class和其父类，直到发现指定的annotation类型被发现，或者到达类继承结构的顶层。

注解语法

由于日常开发少见使用注解，致使有很多人认为注解的地位不高。其实Annotation同 classs 和 interface 同样，注解也是一种类型，只不过它是在 Java SE 5.0 版本中才开始引入的概念。

一个Annotation和一个@Retention中的RetentionPolicy关联，即每一个Annotation，都会有惟一的RetentionPolicy的属性。

1个Annotation 和 1~n个@Target中的ElementType关联，即对于每1个Annotation对象，能够有若干个@Target的ElementType属性值。

示例：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value = {ElementType.ANNOTATION_TYPE, ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
public @interface AnnotationTest {
}
复制代码

上面的示例，使用@Documented说明能够出如今Java文档中，@Retention(RetentionPolicy.RUNTIME)说明AnnotationTest能够加载到JVM 中，能够在程序运行的时候的时候经过反射获取到。@Target(value = {ElementType.ANNOTATION_TYPE, ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})说明AnnotationTest能够用于注解，类和接口，方法，属性中。

注解的定义

注解经过 @interface关键字进行定义。自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其余细节

定义注解时的注意事项

  • 在定义注解时，不能继承其余的注解或接口。
  • @interface用来声明一个注解，其中的每个方法实际上至关于一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型。
  • 能够经过default来声明参数的默认值。

注解参数支持数据类型：

  1. 全部基本数据类型（int,float,boolean,byte,double,char,long,short)
  2. String类型
  3. Class类型
  4. enum类型
  5. Annotation类型
  6. 以上全部类型的数组

注解参数的设定:

第一,只能用public或default这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型； 

第二,参数成员只能使用注解参数支持的数据类型  

第三,若是只有一个参数成员,最好把参数名称设为value,后加小括号.

注解元素的默认值：

注解元素必须有肯定的值，要么在定义注解的默认值中指定，要么在使用注解时指定，非基本类型的注解元素的值不可为null。所以, 使用空字符串或0做为默认值是一种经常使用的作法。这个约束使得处理器很难表现一个元素的存在或缺失的状态，由于每一个注解的声明中，全部元素都存在，而且都具备相应的值，为了绕开这个约束，咱们只能定义一些特殊的值，例如空字符串或者负数，一次表示某个元素不存在，在定义注解时，这已经成为一个习惯用法。

定义了注解，并在须要的时候给相关类，类属性加上注解信息，若是没有相应的注解信息处理流程，注解能够说是没有实用价值。如何让注解真真的发挥做用，主要就在于注解处理方法。

若是没有用来读取注解的方法和工做，那么注解也就不会比注释更有用处了。使用注解的过程当中，很重要的一部分就是建立于使用注解处理器。Java SE5扩展了反射机制的API，以帮助程序员快速的构造自定义注解处理器。

简单的自定义注解和使用注解实例：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value = {ElementType.ANNOTATION_TYPE, ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
public @interface AnnotationTest {

    /***
     * 实体默认firstLevelCache属性为false
     * @return boolean
     */
    boolean firstLevelCache() default false;
    /***
     * 实体默认secondLevelCache属性为false
     * @return boolean
     */
    boolean secondLevelCache() default true;
    /***
     * 表名默认为空
     * @return String
     */
    String tableName() default "";
    /***
     * 默认以""分割注解
     */
    String split() default "";
}

复制代码

它的形式跟接口很相似，只不过前面多了一个@符号。经过上面的语句，就能够建立一个名为AnnotationTest的注解。

注解的使用

@AnnotationTest
public class Test {
}
复制代码

上面的代码，建立一个类 Test,而后在类定义的地方加上 @AnnotationTest 就能够用 AnnotationTest 注解这个类了。能够简单的理解为将AnnotationTest 这张标签贴到 Test 这个类上面。

Java预置的注解

@Deprecated

这个元素是用来标记过期的元素。编译器在编译阶段遇到这个注解时会发出提醒警告，告诉开发者正在调用一个过期的元素好比过期的方法、过期的类、过期的成员变量。

使用以下

public class Hero {
	
	@Deprecated
	public void say(){
		System.out.println("Noting has to say!");
	}
	
	public void speak(){
		System.out.println("I have a dream!");
	}
}
复制代码

在IDE中调用hero.say()时，say()方法的上面会有方法过期的提醒。

@Override

这个你们应该很熟悉了，提示子类要复写父类中被 @Override 修饰的方法

@SuppressWarnings

阻止警告的意思。以前说过调用被 @Deprecated 注解的方法后，编译器会警告提醒，而有时候开发者会忽略这种警告，他们能够在调用的地方经过 @SuppressWarnings 达到目的。

@SafeVarargs

参数安全类型注解。它的目的是提醒开发者不要用参数作一些不安全的操做,它的存在会阻止编译器产生 unchecked 这样的警告。

@SafeVarargs // Not actually safe!
	static void m(List<String>... stringLists) {
	Object[] array = stringLists;
	List<Integer> tmpList = Arrays.asList(42);
	array[0] = tmpList; // Semantically invalid, but compiles without warnings
	String s = stringLists[0].get(0); // Oh no, ClassCastException at runtime!
}
复制代码

@FunctionalInterface

函数式接口 (Functional Interface) 就是一个只具备一个方法的普通接口。

例如：

@FunctionalInterface
public interface Runnable {
    /**
     * When an object implementing interface <code>Runnable</code> is used
     * to create a thread, starting the thread causes the object's * <code>run</code> method to be called in that separately executing * thread. * <p> * The general contract of the method <code>run</code> is that it may * take any action whatsoever. * * @see java.lang.Thread#run() */ public abstract void run(); } 复制代码

可能有人会疑惑，函数式接口标记有什么用，这个缘由是函数式接口能够很容易转换为 Lambda 表达式

注解的提取

Java使用Annotation接口来表明程序元素前面的注解，该接口是全部Annotation类型的父接口。除此以外，Java在java.lang.reflect 包下新增了AnnotatedElement接口，该接口表明程序中能够接受注解的程序元素，该接口主要有以下几个实现类：

  • Class：类定义
  • Constructor：构造器定义
  • Field：类的成员变量定义
  • Method：类的方法定义
  • Package：类的包定义

java.lang.reflect 包下主要包含一些实现反射功能的工具类，实际上，java.lang.reflect 包全部提供的反射API扩充了运行时读取Annotation信息的能力。当一个Annotation类型被定义为运行时的Annotation后，该注解才能是运行时可见，当class文件被装载时被保存在class文件中的Annotation才会被虚拟机读取。

AnnotatedElement 接口是全部程序元素（Class、Method和Constructor）的父接口，因此程序经过反射获取了某个类的AnnotatedElement对象以后，程序就能够调用该对象的以下四个个方法来访问Annotation信息：   

  • 方法1： T getAnnotation(Class annotationClass): 返回该程序元素上存在的、指定类型的注解，若是该类型注解不存在，则返回null。
  • 方法2：Annotation[] getAnnotations():返回该程序元素上存在的全部注解。
  • 方法3：boolean is AnnotationPresent(Class<?extends Annotation> annotationClass):判断该程序元素上是否包含指定类型的注解，存在则返回true，不然返回false.
  • 方法4：Annotation[] getDeclaredAnnotations()：返回直接存在于此元素上的全部注释。与此接口中的其余方法不一样，该方法将忽略继承的注释。（若是没有注释直接存在于此元素上，则返回长度为零的一个数组。）该方法的调用者能够随意修改返回的数组；这不会对其余调用者返回的数组产生任何影响。

注解与反射

注解经过反射获取。

  1. 首先能够经过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解
public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}
复制代码
  1. 而后经过 getAnnotation() 方法来获取 Annotation 对象。
public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}
复制代码

或者是 getAnnotations() 方法

public Annotation[] getAnnotations() {}
复制代码

前一种方法返回指定类型的注解，后一种方法返回注解到这个元素上的全部注解。

使用方法

@TestAnnotation()
public class Test {
	
	public static void main(String[] args) {
		
		boolean hasAnnotation = Test.class.isAnnotationPresent(AnnotationTest.class);
		
		if ( hasAnnotation ) {
			TestAnnotation testAnnotation = Test.class.getAnnotation(AnnotationTest.class);
			
			System.out.println("id:"+testAnnotation.firstLevelCache());
			System.out.println("msg:"+testAnnotation.tableName());
		}

	}

}

复制代码

注解的使用场景

注解是一系列元数据，它提供数据用来解释程序代码，可是注解并不是是所解释的代码自己的一部分。注解对于代码的运行效果没有直接影响。

注解用处主要以下：

  • 提供信息给编译器

    编译器能够利用注解来探测错误和警告信息

  • 编译阶段时的处理

    软件工具能够用来利用注解信息来生成代码、Html文档或者作其它相应处理。

  • 运行时的处理

    某些注解能够在程序运行的时候接受代码的提取

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程