Android AOP注解Annotation详解(一)

Android 注解Annotation

相关文章:

Android AOP注解Annotation详解(一)
Android AOP之注解处理解释器详解(二)
Android AOP 注解详解及简单使用实例(三)

Android AOP 等在Android上应用越来越广泛,例如框架ButterKnife,Dagger2,EventBus3等等,这里我自己总结了一个学习路程。

- Java的注解Annotation
- 注解处理解析器APT(Annotation Processing Tool)
- Android上的注解
- 。。。。

一、啥是注解

从JDK5开始,Java增加了Annotation(注解),Annotation是代码里的特殊标记,这些标记可以在编译、类加载、运行时被读取,并执行相应的处理。通过使用Annotation,开发人员可以在不改变原有逻辑的情况下,在源文件中嵌入一些补充的信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证、处理或者进行部署。

Annotation提供了一种为程序元素(包、类、构造器、方法、成员变量、参数、局域变量)设置元数据的方法。Annotation不能运行,它只有成员变量,没有方法。Annotation跟public、final等修饰符的地位一样,都是程序元素的一部分,Annotation不能作为一个程序元素使用。

annotation并不直接影响代码语义,但是它能够被看作类似程序的工具或者类库,它会反过来对正在运行的程序语义有所影响。

  • Annotations可以为编译器提供而外信息,以便于检测错误,抑制警告等.
  • 软件工具可以通过处理Annotation信息来生成原代码,xml文件等等.
  • 有一些annotation甚至可以在程序运行时被检测,使用.

总结一句话:注解是一种元数据,起到了”描述,配置”的作用。

二、自定义Annotation

2.1 定义注解

定义新的Annotation类型使用@interface关键字(在原有interface关键字前增加@符号)。定义一个新的Annotation类型与定义一个接口很像,例如:

public @interface Test{

}

2.2 使用注解

定义完该Annotation后,就可以在程序中使用该Annotation。使用Annotation,非常类似于public、final这样的修饰符,通常,会把Annotation另放一行,并且放在所有修饰符之前。例如:

@Test
public class MyClass{
....
}

三、Annotation的一些概念

3.1 定义属性

Annotation只有成员变量,没有方法。Annotation的成员变量在Annotation定义中以“无形参的方法”形式来声明,其方法名定义了该成员变量的名字,其返回值定义了该成员变量的类型。下面示例中定义了2个成员变量,这2个成员变量以方法的形式来定义:

public @interface MyTag{
 string name();
 int age();
}

一旦在Annotation里定义了成员变量后,使用该Annotation时就应该为该Annotation的成员变量指定值(如果有默认值可以不用指定) 。例如:

public class Test{
 @MyTag(age=30,name="天平")
 public void info(){

 }
}

参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型 , 以及这一些类型的数组。

3.2 分类

根据Annotation是否包含成员变量,可以把Annotation分为如下两类:

- 标记注解Annotation:没有成员变量的Annotation被称为标记。这种Annotation仅用自身的存在与否来为我们提供信息,例如@override等。

- 元数据Annotation:包含成员变量的Annotation。因为它们可以接受更多的元数据,因此被称为元数据Annotation。

3.3 默认值

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

定义注解

public @interface MyTag {
 public int id() default -1;
 public String name() default "";//使用default可以设置默认值
 public itn age();
}

使用注解

public class Test{
 @MyTag(age=30)
 public void info(){
 //age没有指定默认值,所以这里必须要设置age
 }
}

四、元注解meta-annotation

注解的注解,不是上述的”元数据Annotation”。

元注解的作用就是负责注解其他注解,它们被用来提供对其它annotation类型作说明。JDK提供了如下4个元注解:

- @Retention
- @Target
- @Documented
- @Inherited

4.1 @Retention

保留的意思,用于指定Annotation可以保留多长时间。

@Retention包含一个名为“value”的成员变量,该value成员变量是RetentionPolicy枚举类型。使用@Retention时,必须为其value指定值。value成员变量的值只能是如下3个:

作用:表示需要在什么级别保存该注释信息,用于描述注解的生命周期(即:被描述的注解在什么范围内有效)

  1. RetentionPolicy.SOURCE: Annotation只保留在源代码中,编译器编译时,直接丢弃这种Annotation。在源文件中有效。
  2. RetentionPolicy.CLASS: 编译器把Annotation记录在class文件中。当运行Java程序时,JVM中不再保留该Annotation。在class中有效。
  3. RetentionPolicy.RUNTIME: 编译器把Annotation记录在class文件中。当运行Java程序时,JVM会保留该Annotation,程序可以通过反射获取该Annotation的信息。在运行时有效。

例子:

定义注解

//name=value形式
//@Retention(value=RetentionPolicy.RUNTIME)
//直接指定
@Retention(RetentionPolicy.RUNTIME)
public @interface MyTag {
 String value();
}

使用

@MyTag("天平")
public class RMain {

}

ps: 如果Annotation里有一个名为“value“的成员变量,使用该Annotation时,可以直接使用XXX(val)形式为value成员变量赋值,无须使用name=val形式,看上面的例子。

4.2 @Target

目标,指定Annotation用于修饰哪些程序元素。@Target也包含一个名为”value“的成员变量,该value成员变量类型为ElementType[],ElementType为枚举类型,值有如下几个:

作用: 规定Annotation所修饰的对象范围。

  1. ElementType.TYPE:能修饰类、接口(包括注解类型)或枚举类型
  2. ElementType.FIELD:能修饰成员变量、对象、属性(包括enum实例)
  3. ElementType.METHOD:能修饰方法
  4. ElementType.PARAMETER:能修饰参数
  5. ElementType.CONSTRUCTOR:能修饰构造器
  6. ElementType.LOCAL_VARIABLE:能修饰局部变量
  7. ElementType.ANNOTATION_TYPE:能修饰注解
  8. ElementType.PACKAGE:能修饰包

4.2.1 栗子1

注解定义

//FIELD 只能修饰成员变量
@Target(ElementType.FIELD)
public @interface TargetTest {
 String name() default "天平";
}

使用

public class TMain {

 @TargetTest
 String test;

}

4.2.2 栗子2

注解定义

//FIELD,METHOD 同时修饰成员变量和方法
@Target({ElementType.FIELD,ElementType.METHOD})
public @interface TargetTest {
 String name() default "sunchp";
}

使用

public class TMain {

 @TargetTest
 String test;

 @TargetTest
 public void testMethod(){

 }
}

4.3 @Documented

如果定义注解A时,使用了@Documented修饰定义,则在用javadoc命令生成API文档后,所有使用注解A修饰的程序元素,将会包含注解A的说明。Documented是一个标记注解,没有成员。栗子:

定义注解

@Documented
public @interface DTest {

}

使用注解

@DTest
public class DMain {
 //使用javadoc生成api文档之后,这个类就会包含注解DTest的说明。
}

4.4 @Inherited

继承,是一个标记注解,阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将会被用于该class的子类。栗子:

定义注解:

@Inherited
public @interface ITest {

}

一个父类使用注解:

@ITest
public class IMain {

}

一个子类继承父类:

public class IMainChild extends IMain {
 //这时候这个类也有IMain的注解属性
}

五、基本Annotation

JDK默认提供了如下几个基本Annotation:

- @Override
- @SuppressWarning
- @Deprecated
- @SafeVarargs

5.1 @Override

限定重写父类方法。对于子类中被@Override修饰的方法,如果存在对应的被重写的父类方法,则正确;如果不存在,则报错。@Override 只能作用于方法,不能作用于其他程序元素。

父类:

public class Father{

 public void test(){

 }

}

子类:

public class Child{

 //加上这个注解表示重写父类的方法
 @Override
 public void test(){

 }

}

5.2 @SuppressWarning

抑制编译器警告。指示被@SuppressWarning修饰的程序元素(以及该程序元素中的所有子元素,例如类以及该类中的方法…..)取消显示指定的编译器警告。例如,常见的@SuppressWarning(“unchecked”)

5.3 @Deprecated

用于表示某个程序元素(类、方法等)已过时。如果使用 被@Deprecated修饰的类或方法等,编译器显示为红色,表示这个方法已经被弃用。

例子:

public class Main{

 @Deprecated
 public void test(){

 }

 public static void main(String[] args){

 Main main = new Main();
 main.test(); //这时候编辑器就会报红色,提示过时
 }

}

5.4 @SafeVarargs

安全参数,@SafeVarargs注解只能用在参数长度可变的方法或构造方法上,且方法必须声明为static或final,否则会出现编译错误。是JDK7专门为抑制“堆污染”警告提供的。例如:

如果我传递一个List给下面的方法,编译器就会报警告

public static <T> T useVarargs(T... args) {
 return args.length > 0 ? args[0] : null;
}

当然使用@SuppressWarnings(“unchecked”)可以不显示警告,但是这样子是不好的。这时候用@SageVarargs,如果开发人员确信某个使用了可变长度参数的方法,在与泛型类一起使用时不会出现类型安全问题,就可以用这个注解进行声明。在使用了这个注解之后,编译器遇到类似的情况,就不会再给出相关的警告信息:

@SafeVarargs
public static <T> T useVarargs(T... args) {
 return args.length > 0 ? args[0] : null;
}

六、Annotation的本质

注解在编译之后,会生成一个class文件。例如4.2.1的TargetTest,使用下面的命令生成生成的class字节码

javap -verbose -c Target.class > test.txt

生成的字节码内容为:

Classfile /C:/Users/Litp/Desktop/TargetTest.class
 Last modified 2017-2-18; size 397 bytes
 MD5 checksum 99ffe85662789e888a8e913b96961233
 Compiled from "TargetTest.java"
public interface com.tpnet.annotationtest.target.TargetTest extends java.lang.annotation.Annotation
 SourceFile: "TargetTest.java"
 RuntimeVisibleAnnotations:
 0: #11(#12=[e#13.#14,e#13.#15])
 minor version: 0
 major version: 51
 flags: ACC_PUBLIC, ACC_INTERFACE, ACC_ABSTRACT, ACC_ANNOTATION
Constant pool:
 #1 = Class  #16  // com/tpnet/annotationtest/target/TargetTest
 #2 = Class  #17  // java/lang/Object
 #3 = Class  #18  // java/lang/annotation/Annotation
 #4 = Utf8  name
 #5 = Utf8  ()Ljava/lang/String;
 #6 = Utf8  AnnotationDefault
 #7 = Utf8  sunchp
 #8 = Utf8  SourceFile
 #9 = Utf8  TargetTest.java
 #10 = Utf8  RuntimeVisibleAnnotations
 #11 = Utf8  Ljava/lang/annotation/Target;
 #12 = Utf8  value
 #13 = Utf8  Ljava/lang/annotation/ElementType;
 #14 = Utf8  FIELD
 #15 = Utf8  METHOD
 #16 = Utf8  com/tpnet/annotationtest/target/TargetTest
 #17 = Utf8  java/lang/Object
 #18 = Utf8  java/lang/annotation/Annotation
{
 public abstract java.lang.String name();
 descriptor: ()Ljava/lang/String;
 flags: ACC_PUBLIC, ACC_ABSTRACT
 AnnotationDefault:
 default_value: s#7}

可以看出:

- 注解是被编译成了接口,继承java.lang.annotation.Annotation
- 注解里面的成员变量编译成了同名的构造方法,AnnotationDefault定义默认值
- 注解的注解 利用了一个RuntimeVisibleAnnotations标识。

感谢阅读,希望能帮助到大家,谢谢大家对本站的支持!

(0)

相关推荐

  • Android 中的注解深入探究

    本文系GDG Android Meetup分享内容总结文章 注解是我们经常接触的技术,Java有注解,Android也有注解,本文将试图介绍Android中的注解,以及ButterKnife和Otto这些基于注解的库的一些工作原理. 归纳而言,Android中的注解大概有以下好处 提高我们的开发效率 更早的发现程序的问题或者错误 更好的增加代码的描述能力 更加利于我们的一些规范约束 提供解决问题的更优解 准备工作 默认情况下,Android中的注解包并没有包括在framework中,它独立成一个

  • Android注解使用之ButterKnife 8.0详解

    前言: App项目开发大部分时候还是以UI页面为主,这时我们需要调用大量的findViewById以及setOnClickListener等代码,控件的少的时候我们还能接受,控件多起来有时候就会有一种想砸键盘的冲动.所以这个时候我们想着可以借助注解的方式让我们从这种繁重的工作中脱离出来,也让代码变得更加简洁,便于维护,今天主要学习一下只专注View.Resource.Action注解框架ButterKnife. ButterKnife介绍 ButterKnife是一个专注于Android系统的V

  • Android注解ButterKnife的基本使用

    ButterKnife的最新版本是8.4.0. 首先,需要导入ButterKnife的jar包. 在AndroidStudio中,File->Project Structure->Dependencies->Library dependency 搜索butterknife即可,第一个就是. 另外一种就是直接在build:grade(app)dependencies里添加: compile 'com.jakewharton:butterknife:8.4.0' annotationProc

  • Android AOP之注解处理解释器详解(二)

    Android APO 注解处理解释器 相关文章: Android AOP注解Annotation详解(一) Android AOP之注解处理解释器详解(二) Android AOP 注解详解及简单使用实例(三) 一.提取Annotation信息 当开发者使用了Annotation修饰了类.方法.Field等成员之后,这些Annotation不会自己生效,必须由开发者提供相应的代码来提取并处理Annotation信息.这些处理提取和处理Annotation的代码统称为APT(Annotation

  • Android注解框架对比分析

    Java的注解(Annotation)相当于一种标记,在程序中加入注解就等于为程序打上某种标记,标记可以加在包,类,属性,方法,本地变量上.然后你可以写一个注解处理器去解析处理这些注解(人称编译时注解),也可以在程序运行时利用反射得到注解做出相应的处理(人称运行时注解). 开发Android程序时,没完没了的findViewById, setOnClickListener等等方法,已经让大多数开发者头疼不已.好在市面上有所谓的注解框架可以帮助开发者简化一些过程.比较流行的有butterknife

  • Android 中的注解详细介绍

    注解是我们经常接触的技术,Java有注解,Android也有注解,本文将试图介绍Android中的注解,以及ButterKnife和Otto这些基于注解的库的一些工作原理. 归纳而言,Android中的注解大概有以下好处 提高我们的开发效率 更早的发现程序的问题或者错误 更好的增加代码的描述能力 更加利于我们的一些规范约束 提供解决问题的更优解 准备工作 默认情况下,Android中的注解包并没有包括在framework中,它独立成一个单独的包,通常我们需要引入这个包. dependencies

  • Android AOP 注解详解及简单使用实例(三)

    Android  注解 相关文章: Android AOP注解Annotation详解(一) Android AOP之注解处理解释器详解(二) Android AOP 注解详解及简单使用实例(三) 一.简介 在Android 里面 注解主要用来干这么几件事: 和编译器一起给你一些提示警告信息. 配合一些ide 可以更加方便快捷 安全有效的编写Java代码.谷歌出的support-annotations这个库 就是主要干这个的. 和反射一起 提供一些类似于spring 可配置的功能,方便简洁. 二

  • Android中封装SDK时常用的注解总结

    前言 在工作中我们经常需要将功能模块封装成库供合作厂商调用, 如何写好一个健壮的Android Library有很多讲究,使用注解可以对SDK暴露给开发者的接口做出一些限制,从而尽可能地避免开发者错误地使用API. 下面我们介绍几种封装SDK时常用到的注解,需要的朋友们可以参考学习. 一.IntDef与StringDef 我们有时候会使用int常量或者String常量来代替枚举, 特别在你编写SDK的时候,你可以通过IntDef或者StringDef来限制接口可接受的参数. 比如,有一个 dis

  • 深入分析安卓(Android)中的注解

    归纳而言,Android中的注解大概有以下好处 1.提高我们的开发效率 2.更早的发现程序的问题或者错误 3.更好的增加代码的描述能力 4.更加利于我们的一些规范约束 5.提供解决问题的更优解 准备工作 默认情况下,Android中的注解包并没有包括在framework中,它独立成一个单独的包,通常我们需要引入这个包. dependencies { compile 'com.android.support:support-annotations:22.2.0' } 但是如果我们已经引入了 app

  • Android AOP注解Annotation详解(一)

    Android 注解Annotation 相关文章: Android AOP注解Annotation详解(一) Android AOP之注解处理解释器详解(二) Android AOP 注解详解及简单使用实例(三) Android AOP 等在Android上应用越来越广泛,例如框架ButterKnife,Dagger2,EventBus3等等,这里我自己总结了一个学习路程. - Java的注解Annotation - 注解处理解析器APT(Annotation Processing Tool)

  • Android studio 混淆配置详解

    混淆 studio 使用Proguard进行混淆,其是一个压缩.优化和混淆java字节码文件的一个工具. 功能:Shrinking(压缩).Optimization(优化).Obfuscattion(混淆).Preverification(预校验)四个操作. 优点: 1.删除项目无用的资源,有效减小apk大小: 2.删除无用的类.类成员.方法和属性,还可以删除无用的注释,最大限度的优化字节码文件: 3.使用简短无意义的名称重命名已存在的类.方法.属性等,增加逆向工程的难度. 配置 buildTy

  • JSP 中Spring组合注解与元注解实例详解

    JSP 中Spring组合注解与元注解实例详解 摘要: 注解(Annotation),也叫元数据.一种代码级别的说明.它与类.接口.枚举是在同一个层次.它可以声明在包.类.字段.方法.局部变量.方法参数等的前面,用来对这些元素进行说明 1. 可以注解到别的注解上的注解称为元注解,被注解的注解称为组合注解,通过组合注解可以很好的简化好多重复性的注解操作 2. 示例组合注解 import org.springframework.context.annotation.ComponentScan; im

  • Kotlin 的注解类详解及实例

    Kotlin 的注解类详解及实例 注解声明 注解是将元数据附加到代码的方法.要声明注解,请将 annotation 修饰符放在类的前面: annotation class Fancy 注解的附加属性可以通过用元注解标注注解类来指定: @Target 指定可以用 该注解标注的元素的可能的类型(类.函数.属性.表达式等): @Retention 指定该注解是否 存储在编译后的 class 文件中,以及它在运行时能否通过反射可见 (默认都是 true): @Repeatable 允许 在单个元素上多次

  • 基于Android RxCache使用方法详解

    前言 我为什么使用这个库? 事实上Android开发中缓存功能的实现选择有很多种,File缓存,SP缓存,或者数据库缓存,当然还有一些简单的库/工具类,比如github上的这个: [ASimpleCache]:a simple cache for android and java 但是都不是很好用(虽然可能学习成本比较低,因为它使用起来相对简单),我可能需要很多的静态常量来作为key存储缓存数据value,并设置缓存的有效期,这可能需要很多Java代码去实现,并且过程繁琐. 如果您使用的网络请求

  • SpringAOP中的注解配置详解

    这篇文章主要介绍了SpringAOP中的注解配置详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 使用注解实现SpringAOP的功能: 例子: //表示这是被注入Spring容器中的 @Component //表示这是个切面类 @Aspect public class AnnotationHandler { /* * 在一个方法上面加上注解来定义切入点 * 这个切入点的名字就是这个方法的名字 * 这个方法本身不需要有什么作用 * 这个方法的

  • 史上最全Android build.gradle配置详解(小结)

    Android Studio是采用gradle来构建项目的,gradle是基于groovy语言的,如果只是用它构建普通Android项目的话,是可以不去学groovy的.当我们创建一个Android项目时会包含两个Android build.gradle配置详解文件,如下图: 一.Project的build.gradle文件: 对应的build.gradle代码如下: // Top-level build file where you can add configuration options

  • java中@SuppressWarnings注解用法详解

    SuppressWarnings注解是jse提供的注解.作用是屏蔽一些无关紧要的警告.使开发者能看到一些他们真正关心的警告.从而提高开发者的效率 简介: java.lang.SuppressWarnings是J2SE 5.0中标准的Annotation之一.可以标注在类.字段.方法.参数.构造方法,以及局部变量上.作用:告诉编译器忽略指定的警告,不用在编译完成后出现警告信息. 使用: @SuppressWarnings("") @SuppressWarnings({}) @Suppre

  • Android ViewBinding的使用详解

    目录 一.什么是view binding 设置说明 二.基本用法 Activity中使用 Fragment 中使用 Adapter 中使用 三.了解源码实现 BaseActivity BaseFragment BaseAdapter 四.其他 最近Android Studio 升级后 butterknife 有一个警告: Resource IDs will be non-final in Android Gradle Plugin version 5.0, avoid using them as

随机推荐