Android 2分钟学会xUtils 注解 Annotation（实例+原理）

转载： http://blog.csdn.net/lmj623565791/article/details/39269193 ，本文出自： 【张鸿洋的博客】

Annotation(注解)

目前市面上最流行的2种注解框架

Android Annotations和ButterKnife。

下面详细介绍   Annotations

注解的分类

注解分为两类，一类是元注解，另外一类是普通注解。
所谓元注解就是修饰注解的注解。
拿到一个注解，如何知道它是否是元注解呢？需要看它的元注解（无论是元注解还是普通注解都是有元注解的），如果看到这样的元注解：@Target(ElementType.ANNOTATION_TYPE)，那么此时这个注解一定是元注解。

注解的应用：用于框架中：如xUtils,Afinal和Evenbus

1、使用依赖注入（Dependency Injection）不熟悉的可以了解一下Inversion of Control（IoC）

2、事件绑定（Event binding）

3、简化的线程模型（Simplified  threading model)  

4、REST Client

5、No Magic  [不知道为什么这样称呼，直译过来就是：无魔法，它的意思是：AndroidAnnotations在编译

的时候会产生一个子类(接下来你会明白)，你查看这个子类，可以看到它是如何工作的]

@Target（必须）	表示该注解可以用于什么地方，可能的ElementType参数有： CONSTRUCTOR：构造器的声明 FIELD：域声明（包括enum实例） LOCAL_VARIABLE：局部变量声明 METHOD：方法声明 PACKAGE：包声明 PARAMETER：参数声明 TYPE：类、接口（包括注解类型）或enum声明
@Retention（常用）	表示需要在什么级别保存该注解信息。可选的RetentionPolicy参数包括： SOURCE：注解将被编译器丢弃 CLASS：注解在class文件中可用，但会被VM丢弃 RUNTIME：VM将在运行期间保留注解，因此可以通过反射机制读取注解的信息。
@Document	将注解包含在Javadoc中
@Inherited	允许子类继承父类中的注解

@Target：

　　　@Target说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

　　作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）

　　取值(ElementType)有：和反射对应

　　　
　　

1. TYPE,  //适用class,interface,enum   
2.     FIELD, //适用field   
3.     METHOD,//适用method   
4.     PARAMETER,  //适用method之上的parameter   
5.     CONSTRUCTOR, //适用constructor   
6.     LOCAL_VARIABLE, // 适用区域变量   
7.    ANNOTATION_TYPE, //适用annotation类型   
8.    PACKAGE  //适用package   
   
   
   

      

@Retention：

　　@Retention定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

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

　　取值（RetentionPoicy）有：

　　　　1.SOURCE:在源文件中有效（即源文件保留）
　　　　2.CLASS:在class文件中有效（即class保留）
　　　　3.RUNTIME:在运行时有效（即运行时保留）

如果不写的话，会怎样

@Documented:

　　@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。

@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类型被发现，或者到达类继承结构的顶层。

自定义注解：

　　使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

　　定义注解格式：
　　public @interface 注解名 {定义体}

　　注解参数的可支持数据类型：

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

　　Annotation类型里面的参数该怎么设定: 
　　第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型；　 　
　　第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;　　

下面看列子立刻可以明白了：

@ContentView(value = R.layout.activity_main)
public class MainActivity extends annotation.peng.cx.com.annotation.BaseActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
    }
    /**
     * 测试用方法的方式替代类的注释
     */
//    @ContentView(R.layout.activity_main)
//    private void  setContentView(){
//
//    }
    @ViewInject(R.id.id_btn)
    private Button mBtn1;
    @ViewInject(R.id.id_btn02)
    private Button mBtn2;

定义注解

需要掌握的4个部分：类注释，变量注释，方法注释，注释嵌套注释

类Type的定义

/**
 * 代表类,需要在类的外面一层引用
 * 好处：只有一个，不同于方法和变量，需要遍历出来进行查找
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ContentView
{
   int value();
}

@ContentView(value = R.layout.activity_main)

在 成员变量Filed 上使用

@ViewInject(R.id.id_btn)
private Button mBtn1;

/**
 * 代表变量
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ViewInject
{
   int value();//传给来的值得类型
}

在 方法 上使用注解：

 */
@OnClick({ R.id.id_btn, R.id.id_btn02})
public void clickBtnInvoked(View view)
{
    switch (view.getId())
    {
        case R.id.id_btn:
            Toast.makeText(this, "Inject Btn01 !", Toast.LENGTH_SHORT).show();
            break;
        case R.id.id_btn02:
            Toast.makeText(this, "Inject Btn02 !", Toast.LENGTH_SHORT).show();
            break;
    }
}

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
/**
 * 注释嵌套注释
 */
@EventBase(listenerType = View.OnClickListener.class, listenerSetter = "setOnClickListener", methodName = "onClick")
public @interface OnClick
{
   //返回数组,存放多个数据
   int[] value();
}

把注解注释到代码里面的综合逻辑：需要有反射基础， http://blog.csdn.net/whb20081815/article/details/61198050

/**
 * 注入主布局文件
 * 
 * @param activity
 */
private static void injectContentView(Activity activity)
{
   Class<? extends Activity> clazz = activity.getClass();
   // 查询类上是否存在ContentView注解
   ContentView contentView = clazz.getAnnotation(ContentView.class);
   if (contentView != null)// 存在
   {
      int contentViewLayoutId = contentView.value();
      try
      {
         Method method = clazz.getMethod(METHOD_SET_CONTENTVIEW, int.class);
         method.setAccessible(true);
         method.invoke(activity, contentViewLayoutId);
      } catch (Exception e)
      {
         e.printStackTrace();
      }
   }
}

注意：

注释类型不适用于该类型的声明

AS源代码：不知道为什么传上去就不见了