在Android开发中我们经常会用到注解,例如@Override
Butterknife中的BindView
等。这里主要记录下注解怎么写和简单的使用。
基本语法
我们通过Override
注解的定义来切入注解的语法。
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}
在java源码中,通过上面的几行代码就定义了一个Override
的注解,定义注解的时候用到了两个元注解Target
,Retention
。什么是元注解?注解注解的注解就是元注解。跟定义接口差不多,就是用到的是@interface
,然后加上了元注解。那么元注解的作用是什么呢?
元注解
元注解:@Target
,@Retention
,@Documented
,@Inherited
@Target
@Target说明了注解所修饰对象的类型。由EelmentType
所描述
public enum ElementType {
TYPE, //class interface enum
FIELD, //域
METHOD, //方法
PARAMETER, //参数
CONSTRUCTOR, //构造
LOCAL_VARIABLE, //局部变量
ANNOTATION_TYPE, //注解
PACKAGE, //包
}
实例:
/**
* 这样我们就定义了一个作用在类型和域上面的注解
*/
@Target({ElementType.TYPE, ElementType.FIELD})
public @interface Entity {
}
@Retention
@Retention
表明注解作用的时间。由RetentionPolicy
所描述
public enum RetentionPolicy {
/**
* 只在源码显示,编译时丢弃;
*/
SOURCE,
/**
* 编译时记录到.class中,运行时忽略;默认值
*/
CLASS,
/**
* 运行时保留,运行中可以处理。(我们用的较多的就是这个)
*/
RUNTIME
}
@Documented
含有该注解类型的元素(带有注释的)会通过javadoc或类似工具进行文档化。
我们来对比一下:
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface NoDocumented {
}
@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestDocumented {
}
@TestDocumented
public void funTestDocumented(){
System.out.println("有@Documented");
}
@NoDocumented
public void funNoDocucmented(){
System.out.println("无@Documented");
}
定义以上两个注解并测试,利用javadoc生成文档后显示如下:
@Inherited
根据字面意思是继承。也就是标识该注解可以被继承。只作用在类上面。
注解参数
@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Entity {
String value() default "";
int name() default 0;
}
我们在定义注解的时候,可以添加相关的参数。定义了参数之后我们就可以通过反射的方式获取到注解,然后获取该参数了。如下所示:
Class<TestInheritedC> cClass = TestInheritedC.class;
Entity annotation = cClass.getAnnotation(Entity.class);
if (annotation != null) {
String value = annotation.value();
int name = annotation.name();
System.out.println("value = " + value + " name = " + name);
}
注解参数的类型包括:基本数据类型
,String
,Class
,Enum
,Annotation
,及前边这些类型的数组类型
。
Java的内置注解
@Override 重写了父类的方法
@Deprecated 表示已过时,不推荐使用。一般在使用被标注的方法、类等时编辑器会出现删除线。
@@SuppressWarnnings 用于通知Java编译器关闭对特定类、方法、成员变量、变量初始化的警告
Android的相关注解
compile 'com.android.support:support-annotations:24.2.0'
support-annotations
包为我们提供了很多实用的注解,来方便代码的检查,例如 @Nullable
,@NonNull
等,具体的使用参考Android官方文档。
这里说一下类型的定义IntDef
和StringDef
,在开发中经常要使用Enum
类型。不过Enum
在开发中性能不如常量。我们可以使用注解的方式进行替换。例如下面是View
源码中的一个栗子
@IntDef({VISIBLE, INVISIBLE, GONE})
@Retention(RetentionPolicy.SOURCE)
public @interface Visibility {}
借用官方文档上的栗子,是这么使用的:
// Define the list of accepted constants and declare the NavigationMode annotation
@Retention(RetentionPolicy.SOURCE)
@IntDef({NAVIGATION_MODE_STANDARD, NAVIGATION_MODE_LIST, NAVIGATION_MODE_TABS})
public @interface NavigationMode {}
// Declare the constants
public static final int NAVIGATION_MODE_STANDARD = 0;
public static final int NAVIGATION_MODE_LIST = 1;
public static final int NAVIGATION_MODE_TABS = 2;
// Decorate the target methods with the annotation
@NavigationMode
public abstract int getNavigationMode();
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。