java注解机制_Java注解机制基础

最近整体研究了一下ButterKnife这个框架&＃xff0c;顺带着系统回顾梳理了一遍Java注解相关的知识点。本文大致整理了一下注解的几个核心部分&＃xff0c;内容参考了很多现有的资料&＃xff0c;在参考文献中做出了说明。希望通过本文能对注解的基本原理做一个简要的梳理&＃xff0c;为后续两篇文章深入的分析ButterKnife实现原理做好铺垫。

1.注解概述

(1)定义

注解(Annotation)是Java1.5中引入的一个重大修改之一&＃xff0c;为我们在代码中添加信息提供了一种形式化的方法&＃xff0c;使我们可以在稍后某个时刻非常方便的使用这些数据。

注解在一定程度上是把元数据与源代码结合在一起&＃xff0c;而不是保存在外部文档中。

注解的含义可以理解为java中的元数据。元数据是描述数据的数据。如下所示&＃xff1a;

5.4

这里的”app_version”就是描述数据”5.4”的数据&＃xff0c;这是在配置文件中写的&＃xff0c;注解是在源码中写的。另外一种开发人员很熟悉的元数据是注释(comment)。注释用来描述源代码中的类&＃xff0c;域和方法的作用等。

(2)注解与注释的不同注解会影响代码的行为&＃xff0c;而注释不会&＃xff1b;

编译器对代码进行处理时&＃xff0c;注释会被直接删除&＃xff0c;而注解可能会被保留在字节代码中&＃xff1b;

(3)注解的作用格式检查&＃xff1a;告诉编译器信息&＃xff0c;比如被&＃64;Override标记的方法如果不是父类的某个方法&＃xff0c;IDE会报错&＃xff1b;

减少配置&＃xff1a;运行时动态处理&＃xff0c;得到注解信息&＃xff0c;实现代替配置文件的功能&＃xff1b;

减少重复工作&＃xff1a;减轻编写“样板”代码的负担&＃xff0c;比如第三方框架ButterKnife&＃xff0c;通过注解&＃64;BindView减少对findViewById的调用&＃xff0c;类似的还有(Lombok,Dagger,AndroidAnnotation等)&＃xff1b;

(4)注解是如何工作的

注解仅仅是元数据&＃xff0c;和业务逻辑无关&＃xff0c;所以查看注解类时&＃xff0c;发现里面没有任何逻辑处理&＃xff1a;

&＃64;Retention(RetentionPolicy.CLASS)

&＃64;Target({ElementType.FIELD})

public &＃64;interface InjectView {

int value();

}

如果注解不包含业务逻辑处理&＃xff0c;必然有人来实现这些逻辑。注解的逻辑实现是元数据的用户来处理的&＃xff0c;注解仅仅提供它定义的属性(类/方法/变量/参数/包)的信息&＃xff0c;注解的用户来读取这些信息并实现必要的逻辑。当使用java中的注解时(比如&＃64;Override、&＃64;Deprecated、&＃64;SuppressWarnings)JVM就是用户&＃xff0c;由编译器来负责处理。如果是程序中自定义的注解&＃xff0c;就需要开发者或者第三方库自己去进行处理了。

(5)注解和配置文件的区别

通过上面的描述可以发现&＃xff0c;其实注解干的很多事情&＃xff0c;通过配置文件也可以干&＃xff0c;比如为类设置配置属性&＃xff1b;但注解和配置文件是有很多区别的&＃xff0c;在实际编程过程中&＃xff0c;注解和配置文件配合使用在工作效率、低耦合、可拓展性方面才会达到权衡。

配置文件&＃xff1a;

a.使用场合

外部依赖的配置&＃xff0c;比如build.gradle中的依赖配置&＃xff1b;

同一个项目团队内部达成一致的时候&＃xff1b;

非代码类的资源文件(比如图片&＃xff0c;布局&＃xff0c;数据&＃xff0c;签名文件等)&＃xff1b;

b.优点

降低耦合&＃xff0c;配置集中&＃xff0c;容易扩展&＃xff0c;比如Android应用多语言支持&＃xff1b;

对象之间的关系一目了然&＃xff0c;比如strings.xml&＃xff1b;

xml配置文件比注解功能齐全&＃xff0c;支持的类型更多&＃xff0c;比如drawable、style等&＃xff1b;

c.缺点

繁琐&＃xff1b;

类型不安全&＃xff0c;比如R.java中的都是资源ID&＃xff0c;用TextView的setText方法时传入int值时无法检测出该值是否为资源ID&＃xff0c;但&＃64;StringRes可以&＃xff1b;

注解&＃xff1a;

a.使用场合

动态配置信息&＃xff1b;

代为实现程序逻辑(比如ButterKnife中的&＃64;BindView代替实现findViewById)&＃xff1b;

代码格式检查&＃xff0c;比如&＃64;Override、&＃64;Deprecated、&＃64;NonNull、&＃64;StringRes等&＃xff0c;便于IDE能够检查出代码错误&＃xff1b;

b.优点

在class文件中&＃xff0c;提高程序的内聚性&＃xff1b;

减少重复工作&＃xff0c;提升开发效率&＃xff0c;比如findViewById&＃xff1b;

c.缺点

如果对Annotation修改&＃xff0c;需要重新编译整个工程&＃xff1b;

业务类之间的关系不如xml配置那样一目了然&＃xff1b;

程序中过多的Annotation&＃xff0c;对于代码的简洁度有一定影响&＃xff1b;

扩展性较差&＃xff1b;

(6)注解类型

很多资料对Java Annotation进行了分类&＃xff0c;大部分是分为&＃xff1a;Java内置、元注解、自定注解。这里因为考虑到Android库提供的注解&＃xff0c;本文将其总结归纳为如下几种类型&＃xff1a;

Java标准库中内置的注解(Built-in Java Annotations)

元注解(Meta-annotations)

Android Support Annotations

自定义注解

2.Java标准库中内置的注解

Java内置注解&＃xff1b;定义在java.lang中&＃xff0c;Java1.5中内置了三个&＃xff1a;&＃64;Deprecated、&＃64;Overrride、&＃64;SuppressWarnings。java1.7中增加了&＃64;SafeVarargs&＃xff0c;java1.8中增加了&＃64;FunctionsalInterface。详细介绍如下&＃xff1a;

(1)java.lang.Override

用于表示一个方法声明覆写父类型中的对应方法。Override注解的作用是避免开发人员没有正确区分方法重载和覆写而带来的错误。当需要覆写一个方法的时候&＃xff0c;可以在方法声明前面加上Override注解。如果这个方法实际上并没有覆写父类型中的方法&＃xff0c;而是进行了重载&＃xff0c;那么编译器将产生相应的错误信息。如下所示的代码&＃xff1a;

class User{

public boolean equals(User user){

return true;

}

}

User类的equals方法本意是覆写Object类中的equals方法&＃xff0c;提供自己的对象比较方式的实现&＃xff0c;而实际上User类中的equals方法并没有覆写Object类的equals方法&＃xff0c;而是提供了一个重载的形式。这种错误在编程过程中很难发现。如果加上了Override注解&＃xff0c;那么编译器会给出错误的信息&＃xff0c;开发人员会意识到这个错误&＃xff0c;并根据需要进行相应的修改。

&＃64;Target({ElementType.METHOD})

&＃64;Retention(RetentionPolicy.SOURCE)

public &＃64;interface Override {

}

(2)java.lang.Deprecated

属于标记注解&＃xff0c;不需要设置属性值&＃xff1b;可以对构造方法、变量、方法、包、参数标记&＃xff0c;告知用户和编译器被标记的内容已不建议被使用&＃xff0c;如果被使用&＃xff0c;编译器会报警告&＃xff0c;但不会报错&＃xff0c;程序也能正常运行&＃xff1a;

&＃64;Documented

&＃64;Retention(RetentionPolicy.RUNTIME)

&＃64;Target({ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.LOCAL_VARIABLE, ElementType.METHOD, ElementType.PACKAGE, ElementType.PARAMETER, ElementType.TYPE})

public &＃64;interface Deprecated {

}

(3)java.lang.SuppressWarnings

可以对构造方法、变量、方法、包、参数标记&＃xff0c;用于告知编译器忽略指定的警告&＃xff0c;不用在编译完成后出现警告信息&＃xff1a;

&＃64;Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.CONSTRUCTOR, ElementType.LOCAL_VARIABLE})

&＃64;Retention(RetentionPolicy.SOURCE)

public &＃64;interface SuppressWarnings {

String[] value();

}

(4)&＃64;SafeVarargs(Java SE 7)

作用&＃xff1a;Claims to the compiler that the annotation target does nothing potentially unsafe to its varargs argument.。

&＃64;SafeVarargs用于指明那些使用可变长度参数的方法和构造器是安全的。这些方法能被传入长度可变的参数。这些参数可以是泛型的。如果它们是泛型参数&＃xff0c;使用&＃64;SafeVarargs注释就可以抑制警告信息。使用该注解的前提是&＃xff0c;开发人员必须确保这个方法的实现中对泛型类型参数的处理不会引发类型安全问题。

使用示例&＃xff1a;

&＃64;SafeVarargs

public static void displayElements(T... array){

for (T element : array) {

System.out.println(element.getClass().getName() &＃43; ":" &＃43; element);

}

}

在这里&＃xff0c;方法displayElements的形参是可变长度的泛型类型。

(5)&＃64;FunctionalInterface(Java SE 8)

作用&＃xff1a;An informative annotation type used to indicate that an interface type declaration is intended to be a functional interface as defined by the Java Language Specification. 帮助编译器检查函数式接口的合法性。

3.Java标准库中的元注解(Meta-annotations)

所谓元注解&＃xff0c;就是负责注解其他注解的&＃xff0c;主要是描述注解的一些属性&＃xff0c;任何注解都离不开元注解&＃xff0c;元注解的用户是JDK&＃xff0c;JDK已经帮助我们实现了这些元注解的逻辑。常见的四个类型是&＃64;Documented、&＃64;Inherited、&＃64;Retention、&＃64;Target。在Java 8新增了&＃64;Repeatable。具体描述如下&＃xff1a;

(1)&＃64;Target&＃xff1a;

作用&＃xff1a;用于描述注解的使用范围&＃xff0c;即被描述的注解可以用在什么地方(Indicates the contexts in which an annotation type is applicable)&＃xff1b;

取值&＃xff1a;

CONSTRUCTOR&＃xff1a;构造器&＃xff1b;

FIELD&＃xff1a;实例&＃xff1b;

LOCAL_VARIABLE&＃xff1a;局部变量&＃xff1b;

METHOD&＃xff1a;方法&＃xff1b;

PACKAGE&＃xff1a;包&＃xff1b;

PARAMETER&＃xff1a;参数;

TYPE&＃xff1a;类、接口(包括注解类型) 或enum声明&＃xff1b;

ElementType 常量在 Target 注解中至多只能出现一次&＃xff0c;如下是非法的&＃xff1a;&＃64;Target({ElementType.FIELD, ElementType.METHOD, ElementType.FIELD})

(2)&＃64;Retention&＃xff1a;

作用&＃xff1a;表示需要在什么级别保存该注解信息&＃xff0c;用于描述注解的生命周期&＃xff0c;即被描述的注解在什么范围内有效(Indicates how long annotations with the annotated type are to be retained.)&＃xff1b;

取值&＃xff1a;

RetentionPolicy.SOURCE&＃xff1a;

The marked annotation is retained only in the source level and is ignored by the compiler.

该注解只保留到代码层&＃xff0c;编译器将对其忽略。因此其不会出现在生成的class文件中&＃xff1b;

RetentionPolicy.CLASS&＃xff1a;

The marked annotation is retained by the compiler at compile time, but is ignored by the Java Virtual Machine (JVM).

该注解保留在编译器中&＃xff0c;因此能出现在生成的class文件中&＃xff0c;但是被JVM忽略&＃xff0c;所以不能在运行时获取注解内容。

RetentionPolicy.RUNTIME&＃xff1a;

The marked annotation is retained by the JVM so it can be used by the runtime environment.

该注解能保留在JVM中&＃xff0c;可以在运行时通过反射的方法获取具体内容。

如果自定义注解时不进行指定&＃xff0c;默认为RetentionPolicy.CLASS。

(3)&＃64;Documented&＃xff1a;

作用&＃xff1a;指示该注解是否默认通过Javadoc或者类似的工具进行文档化&＃xff0c;是一种语义元注解(Indicates that annotations with a type are to be documented by javadoc and similar tools by default)。

取值&＃xff1a;它属于标记注解&＃xff0c;没有成员&＃xff1b;

(4)&＃64;Inherited&＃xff1a;

作用&＃xff1a;指示注解类型被自动继承。如果在解析注解时发现了该字段&＃xff0c;并且在该类中没有该类型的注解&＃xff0c;则对其父类进行查询。举个例子&＃xff0c;如果一个类中&＃xff0c;没有A注解&＃xff0c;但是其父类是有A注解的&＃xff0c;并且A注解是被&＃64;Inherited注解的(不妨认为保留时态是Runtime)&＃xff0c;那么使用反射获取子类的A注解时&＃xff0c;因为获取不到&＃xff0c;所以会去其父类查询到A注解。使用了&＃64;Inherited注解的类&＃xff0c;这个注解是可以被用于其子类。

取值&＃xff1a;它属于标记注解&＃xff0c;没有成员&＃xff1b;

(5)&＃64;Repetable(Java 8中新增加的):

作用&＃xff1a;指示该注解是否可以多次使用(used to indicate that the annotation type whose declaration it (meta-)annotates is repeatable.)。在这个注解出现前&＃xff0c;一个位置要想注两个相同的注解&＃xff0c;是不可能的&＃xff0c;编译会出错误。所以要想使一个注解可以被注入两次&＃xff0c;需要声明一个高级注解&＃xff0c;这个注解中的成员类型为需要多次注入的注解的注解数组。

取值&＃xff1a;它属于标记注解&＃xff0c;没有成员&＃xff1b;

使用示例&＃xff1a;

在没有该注解以前&＃xff1a;

public &＃64;interface Authority {

String role();

}

public class RepeatAnnotationUseOldVersion{

&＃64;Authority(role&＃61;"Admin")

&＃64;Authority(role&＃61;"Manager")

public void doSomeThing(){

}

}

类似于这样的使用编译器是会报错的。

通常的做法是&＃xff1a;

public &＃64;interface Authority {

String role();

}

public &＃64;interface Authorities {

Authority[] value();

}

public class RepeatAnnotationUseOldVersion{

&＃64;Authorities({&＃64;Authority(role&＃61;"Admin"),&＃64;Authority(role&＃61;"Manager")})

public void doSomeThing(){

}

}

在java 8以后&＃xff1a;

&＃64;Repeatable(Authorities.class)

public &＃64;interface Authority {

String role();

}

public &＃64;interface Authorities {

Authority[] value();

}

public class RepeatAnnotationUseNewVersion{

&＃64;Authority(role&＃61;"Admin")

&＃64;Authority(role&＃61;"Manager")

public void doSomeThing(){ }

}

在注解Authority上告诉该注解&＃xff0c;如果多次用Authority注解了某个方法&＃xff0c;则自动把多次注解Authority作为Authorities注解的成员数组的一个值&＃xff0c;当取注解时&＃xff0c;可以直接取Authorities&＃xff0c;即可取到两个Authority注解。要求&＃xff1a;&＃64;Repeatable注解的值的注解类Authorities.class&＃xff0c;成员变量一定是被注解的注解Authority的数组。

不同的地方是&＃xff0c;创建重复注解Authority时&＃xff0c;加上&＃64;Repeatable,指向存储注解Authorities&＃xff0c;在使用时候&＃xff0c;直接可以重复使用Authority注解。从上面例子看出&＃xff0c;java 8里面做法更适合常规的思维&＃xff0c;可读性强一点。其实从原理上看和第一种是一模一样的&＃xff0c;只是增加了可读性。

其实在Java 8中&＃xff0c;Annotation还得到了很多很好的扩展。更多Java 8对Annotation提供的改进和支持可参阅&＃xff1a;Java 8 Annotation 新特性在软件质量和开发效率方面的提升

4.Android Support Annotations

Android support library从19.1版本开始引入了一个新的注解库&＃xff0c;它包含很多有用的元注解&＃xff0c;开发者可以用他们来修饰代码&＃xff0c;帮助发现bug。Support library自己本身也用到了这些注解&＃xff0c;所以作为support library的用户&＃xff0c;Android Studio已经基于这些注解校验了开发者的代码并且标注其中潜在的问题。

这些注解是作为一个support包提供给开发者使用&＃xff0c;要使用他们&＃xff0c;需要在build.gradle中添加对android support-annotations的依赖&＃xff1a;

compile &＃39;com.android.support:support-annotations:22.2.0&＃39;

提供的注释概览如下&＃xff1a;

下面分类说明如下&＃xff1a;

(1)Nullness Annotations&＃xff1a;

作用&＃xff1a;check the nullness of a given variable, parameter, or return value.

&＃64;Nullable&＃xff1a;用于标记方法参数或者返回值可以为空&＃xff1b;

&＃64;NonNull&＃xff1a;用于标记方法参数或者返回值不能为空&＃xff0c;如果为空编译器会报警告

(2)Resource Annotations&＃xff1a;

主要用于标记方法的参数必须要是指定的资源类型&＃xff0c;如果不是&＃xff0c;IDE就会给出警告。因为资源文件都是静态的&＃xff0c;所以在编写代码时IDE就知道传值是否错误&＃xff0c;可以避免传的资源id错误导致运行时异常。如下所示&＃xff1a;

public abstract void setTitle(&＃64;StringRes int resId){ … }

在代码检查阶段&＃xff0c;如果传递的引用类型不是R.string类型&＃xff0c;编辑器会给出警告。

资源类型注解包括&＃xff1a;

&＃64;AnimatorRes、&＃64;AnimRes、&＃64;AnyRes、&＃64;ArrayRes、&＃64;BoolRes、&＃64;ColorRes、&＃64;DimenRes、&＃64;DrawableRes、&＃64;FractionRes、&＃64;IdRes、&＃64;IntgerRes、&＃64;InterpolatorRes、&＃64;LayoutRes、&＃64;MenuRes、&＃64;PluralsRes、&＃64;RawRes、&＃64;StringRes、&＃64;StyleableRes、&＃64;StyleRes、&＃64;TransitionRes、&＃64;XmlRes。

&＃64;AnyRes&＃xff1a;表示可以是任何资源类型&＃xff1b;

(3)Thread Annotations&＃xff1a;

作用&＃xff1a;用于标记指定的方法、类(如果一个类中的所有方法都有相同的线程需求&＃xff0c;就可以对这个类进行注解&＃xff0c;比如View.java就被&＃64;UIThread所标记)只能在指定的线程类中被调用。

类型&＃xff1a;

&＃64;MainThread

&＃64;UiThread

&＃64;WorkerThread

&＃64;BinderThread

&＃64;AnyThread

典型使用&＃xff1a;A common use of the thread annotation is to validate method overrides in the AsyncTask class class performs background operations and publishes results only on the UI thread.

(4)Value Constraint Annotations(值约束注解)&＃xff1a;

用于标记参数必须是指定类型的值&＃xff0c;并且值的范围必须在约束的范围内&＃xff0c;包括&＃64;Size、&＃64;IntRange、&＃64;FloatRange。

&＃64;IntRange

标识一个interger或者lang型的参数在一个指定的范围之内&＃xff1b;

public void setAlpha(&＃64;IntRange(from&＃61;0,to&＃61;255) int alpha){ … }

&＃64;FloatRange

标识一个float或者double型的参数在一个指定的范围之内&＃xff1b;

public void setAlpha(&＃64;FloatRange(from&＃61;0.0, to&＃61;1.0) float alpha){...}

&＃64;Size

对于数据、集合以及字符串&＃xff0c;可以用&＃64;Size注解参数来限定集合的大小(当参数是字符串的时候&＃xff0c;可以限定字符串的长度)。

集合不能为空: &＃64;Size(min&＃61;1)&＃xff1b;

字符串最大只能有23个字符: &＃64;Size(max&＃61;23)&＃xff1b;

数组只能有2个元素: &＃64;Size(2)&＃xff1b;

(5)Permission Annotations(权限注解)&＃xff1a;

如果方法需要调用者有特定的权限&＃xff0c;可以使用&＃64;RequiresPermission注解。

&＃64;RequiresPermission(Manifest.permission.SET_WALLPAPER)

public abstract void setWallpaper(Bitmap bitmap) throws IOException;

如果至少需要权限集合中的一个&＃xff0c;可以使用anyOf属性&＃xff1a;

&＃64;RequiresPermission(anyOf &＃61; {

Manifest.permission.ACCESS_COARSE_LOCATION,

Manifest.permission.ACCESS_FINE_LOCATION})

public abstract Location getLastKnownLocation(String provider);

如果你同时需要多个权限&＃xff0c;可以用allOf属性&＃xff1a;

&＃64;RequiresPermission(allOf &＃61; {

Manifest.permission.READ_HISTORY_BOOKMARKS,

Manifest.permission.WRITE_HISTORY_BOOKMARKS})

public static final void updateVisitedHistory(ContentResolver cr, String url, boolean real)

(6)CallSuper Annotations(复写方法注解)&＃xff1a;

如果你的API允许使用者重写你的方法&＃xff0c;但你又需要你自己的方法(父方法)在重写的时候也被调用&＃xff0c;这时候你可以使用&＃64;CallSuper标注&＃xff1a;

&＃64;CallSuper

protected void onCreate(Bundle savedInstanceState){

}

用了这个后&＃xff0c;当重写的方法没有调用父方法时&＃xff0c;工具就会给予警告提示。

5.自定义注解

(1)基本格式&＃xff1a;元注解

public &＃64;interface 注解名{

定义体&＃xff1b;

}

(2)相关说明

注解类型是一种特殊的接口&＃xff0c;在声明时使用的是“&＃64;interface”而不是“interface”。

一个注解类型中可以包含多个元素。每个元素都可以看做注解中的配置项&＃xff0c;通过方法声明的形式来定义。这些方法声明中不能有任何形式参数或类型参数&＃xff0c;也不能有抛出受检异常的throws声明。方法的名称是元素的名称&＃xff0c;方法的返回值类型决定了元素的类型。可以支持的返回值类型如下&＃xff1a;

(1)所有基本数据类型(int,float,boolean,byte,double,char,long,short)&＃xff1b;

(2)String类型&＃xff1b;

(3)Class类型&＃xff1b;

(4)enum类型&＃xff1b;

(5)Annotation类型&＃xff1b;

(6)以上所有类型的数组。

注意点&＃xff1a;

(1)注解类中的方法只能用public或者默认这两个访问权修饰&＃xff0c;不写public就是默认&＃xff1b;

(2)如果注解类中只有一个成员&＃xff0c;最好把方法名设置为”value”&＃xff1b;

(3)注解元素必须有确定的值&＃xff0c;要么在定义注解的默认值中指定&＃xff0c;要么在使用注解时指定&＃xff0c;非基本类型的注解元素的值不可为null。因此,使用空字符串或0作为默认值是一种常用的做法。&＃xff1b;

注解类型中可以没有任何元素&＃xff0c;这种注解类型称为标记注解类型&＃xff0c;是作标记用的。如果注解类型中只有一个元素&＃xff0c;那么这个元素的名称应该根据惯例使用value。使用value的好处是可以简化注解的使用方式&＃xff0c;可以为注解类型设定默认值。通过在方法声明的default关键词来指定。

(3)注解的解析

当注解被添加到java源代码中后&＃xff0c;并不会自动产生作用。某些注解甚至不会在字节代码中出现。创建和使用注解只是完成了第一步&＃xff0c;重要的是如何对注解进行相应的处理。在一般情况下&＃xff0c;创建和处理注解是Java标准库和第三方库应该做的事情&＃xff0c;开发人员只需要使用注解就可以。

根据生存周期不同&＃xff0c;可以分为两种解析方式&＃xff1a;运行时解析和编译时解析。后续会对这两种解析技术进行详细的分析说明&＃xff0c;并分别基于运行时解析和编译时解析简单的模拟实现ButterKnife的效果。

参考文献