什么是注解?
- Annotation是从JDK5.0开始引入的新技术
- Annotation的作用:
- 不是程序本身,可以对程序作出解释(这一点,跟注释没什么区别)
- 可以被其他程序(比如:编译器等)读取。(注解信息处理流程,是注解和注释的重大区别。如果没有注解信息处理流程,则注解毫无意义)。
- Annotation的格式:
- 注解是以"@注释名"在代码中存在的,还可以添加一些参数值,例如:@SuppressWarnings(value="unchecked")。
- Annotation在哪里使用?
- 可以附加在package,class,method,field等上面,相当于给它们添加了额外的辅助信息,我们可以通过反射机制编程实现对这些元数据的访问。
1. 内置注解(1)
@Override
- 定义在java.lang.Override中,此注解只适用于修饰方法,表示一个方法声明打算重写超类中的另一个方法声明。
@Deprecated
- 定义在java.lang.Deprecated中,此注解可用于修饰方法,属性,类,表示不推荐程序员使用这样的元素,通常是因为它很危险或存在更好的选择。
@SuppressWarnings
定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息。
与前两个注释有所不同,你需要添加一个参数才能正确使用,这些参数都是已经定义好了的,我们选择性的使用就好了,参数如下:
参数 | 说明
--- |---|
deprecation | 使用了过时的类或方法的警告
unchecked | 执行了未检查的转换时的警告,如使用集合时未指定泛型
fallthrough | 当在switch语句使用时发生case穿透
path | 在类路径,源文件路径等中有不存在路径的警告
serial | 当在可序列化的类上缺少serialVersionUID定义时的警告
all | 关于以上所有情况的警告@SuppressWarnings("unchecked")
@SuppressWarnings(value={"uncheck","deprecation"})
自定义注解
@Target(value = {ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Annotation01 {
String studentName() default "";
int age() default 0;
int id() default -1;
String[] schools() default {"清华大学","北京大学"};
}
- 使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口
- 要点:
- @interface用来声明注解
- 格式为:public @interface 注解名{定义体}
- 其中的每一个方法实际上是声明了一个配置参数
- 方法的名称就是参数的名称
- 返回值类型就是参数的类型(返回值类型只能是基本类型,Class,String,enum)
- 可以通过default来声明参数的默认值
- 如果只有一个参数成员,一般参数名为value
- @interface用来声明注解
注意:
- 注解元素必须要有值。我们定义注解元素时经常使用空字符串,0作为默认值
- 也经常使用负数(比如:-1)表示不存在的含义
元注解
- 元注解的作用就是负责注解其他注解。Java定义了4个标准的meta-annotation类型,它们被用来提供对其他annotation类型做说明。
- 这些类型和它们所支持的类在java.lang.annotation包中可以找到
- @Target
- @Retention
- @Documented
- @Inheerited
@Target
- 作用:
- 用于描述注解的使用范围(即:被描述的注解可以用在什么地方)
所修饰范围 | 取值ElementType |
---|---|
package | PACKAGE |
类,接口,枚举,Annotation类型 | TYPE |
类型成员(方法,构造方法,成员变量,枚举值) | CONSTRUCTOR:用于描述构造器 FIELD:用于描述域(属性)METHOD:用于描述方法 |
方法参数和本地变量 | LOCAL_VARIABLE:用于描述局部变量 PARAMETER:用于描述参数 |
- @Target(value=ElementType.TYPE)
@Retention
- 作用:
- 表示需要在什么级别保存该注释信息,用于描述注解的生命周期
取值RetentionPolicy | 作用 |
---|---|
SOURCE | 在源文件中有效(即源文件保留) |
CLASS | 在class文件中有效(即class保留) |
RUNTIME | 在运行时有效(即运行时保留)为Runtime可以被反射机制读取 |
注解2
@Target(value = {ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Annotation02 {
String value();
}
使用注解
@Annotation02(value = "清华")
public void test() {}
注解作业
- 什么是ORM(Object Relationship Mapping)
- 类和表结构对应
- 属性和字段对应
- 对象和记录对应
- 使用注解完成类和表结构的映射关系
类的注解
@Target(value = {ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface SxtTable {
String value();
}
属性的注解
@Target(value = {ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface SxtField {
String columnName();
String type();
int length();
}
使用注解修饰类
@SxtTable("tb_student")
public class SxtStudent {
@SxtField(columnName = "id",type = "int",length = 10)
private int id;
@SxtField(columnName = "sname",type = "varchar",length = 10)
private String studentName;
@SxtField(columnName = "age",type = "int",length = 3)
private int age;
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getStudentName() {
return studentName;
}
public void setStudentName(String studentName) {
this.studentName = studentName;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
}
利用反射读取注解
/**
* 使用反射读取注解的信息,模拟处理注解信息的流程
*/
public void testAnnotation() {
try {
Class clazz = Class.forName("com.study.wumeng.practice.SxtStudent");
/**获得类的所有有效注解**/
Annotation[] annotations = clazz.getAnnotations();
for (Annotation a : annotations) {
Log.d(TAG,a + ""); // @com.study.wumeng.practice.SxtTable(value=tb_student)
}
/**获得类的指定注解**/
SxtTable st = (SxtTable) clazz.getAnnotation(SxtTable.class);
Log.d(TAG,st.value()); // tb_student
/**获得属性的注解**/
Field field = clazz.getDeclaredField("studentName");
SxtField sxtField = field.getAnnotation(SxtField.class);
Log.d(TAG,sxtField.columnName()); // sname
Log.d(TAG,sxtField.type()); // varchar
Log.d(TAG,sxtField.length() + ""); // 10
/**根据获得的表名,字段的信息,拼出SQL语句,然后在数据库中生成相关的表**/
} catch (Exception e) {
e.printStackTrace();
}
}