Android Annotation 基础

前言

以前项目中很排斥使用注解,一来不利于新人熟悉代码,二来维护起来稍麻烦,不直观,再者就是考虑兼容性,和性能问题。最近看到好多关于编译时生成代码的例子,运行时也没有使用反射的弊端。就从新拿起来学习一下基础。

注解的语法比较简单,除了@符号的使用之外,它基本与Java固有语法一致。Java SE5内置了三种标准注解:

@Override,表示当前的方法定义将覆盖超类中的方法。

@Deprecated,使用了注解为它的元素编译器将发出警告,因为注解@Deprecated是不赞成使用的代码,被弃用的代码。

@SuppressWarnings,关闭不当编译器警告信息。

mete注解:

元注解的作用就是负责注解其他注解。

Java5.0定义了4种注解,它们被用来提供对其它 annotation类型作说明。

Java SE5定义的元注解:

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

这些类型和它们所支持的类在java.lang.annotation包中可以找到。下面我们看一下每个元注解的作用和相应分参数的使用说明。

@Target:

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

ElementType.CONSTRUCTOR:构造器声明
ElementType.FIELD:成员变量、对象、属性(包括enum实例)
ElementType.LOCAL_VARIABLE:局部变量声明
ElementType.METHOD:方法声明
ElementType.PACKAGE:包声明
ElementType.PARAMETER:参数声明
ElementType.TYPE:类、接口(包括注解类型)或enum声明

使用实例:

@Target(ElementType.TYPE)
public @interface Table {
    /**
     * 数据表名称注解,默认值为类名称
     * @return
     */
    public String tableName() default "className";
}
@Target还支持填写数组,同时支持多种范围

@Target({ElementType.TYPE,ElementType.FIELD})
public @interface Test {}

@Retention:

对Annotation的“生命周期”限制:某些Annotation仅出现在源代码中,而被编译器丢弃;
而另一些却被编译在class文件中;
编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取。

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

RetentionPolicy.SOURCE:在源文件中有效
RetentionPolicy.CLASS:在class文件中有效
RetentionPolicy.RUNTIME:在运行时有效

使用实例:

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
    public String name() default "fieldName";
    public boolean defaultDBValue() default false;
}

Column注解的的RetentionPolicy的属性值是RUTIME,这样注解处理器可以通过反射,获取到该注解的属性值,
从而去做一些运行时的逻辑处理。

@Documented:

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

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Column {
    public String name() default "fieldName";
}

@Inherited:

是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。

如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。

注意:

@Inherited的Retention是RetentionPolicy.RUNTIME,则反射API增强了这种继承性。
如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时,
反射代码检查将展开工作:检查class和其父类,直到发现指定的annotation类型被发现。

@Inherited
public @interface Greeting {
    public enum FontColor{ BULE,RED,GREEN};
    String name();
    FontColor fontColor() default FontColor.GREEN;
}

注解参数

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

默认值

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

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitProvider {
    public int id() default -1;
    public String name() default "";
    public String address() default "";
}

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitProvider {
    public int value() default -1;
}

引用地址:
https://joyrun.github.io/2016/07/18/java-annotation/

猜你喜欢

转载自blog.csdn.net/o279642707/article/details/79141883