注解初步学习
1、注解的基础概念
Java 注解(Annotation)又称 Java 标注、元数据,是 JDK1.5 (JDK5)引入的一种注释机制,于类、接口、枚举是在同一个层次。Java 语言中的包、类、构造器、方法、成员变量、参数等都可以被注解进行标注。
注解的作用:Java中类、方法、成员变量做标记,然后进行特殊处理,特殊处理由业务需求决定,比如常见的有:
- 编译检查。规范代语法,比如:
@FunctionalInterface
、@Override
等注解用于规范代码语法 - 代码分析。通过代码里标识的注解对代码进行分析,比如:Junit框架用于测试代码的注解
- 编写文档:通过代码里标识的注解生成文档(详情)
……
2、自定义注解
语法格式:
public @interface 注解名称 {
public 属性类型 属性名() [default 默认值] ;
}
注意事项:
- 当注解只有一个Value属性,使用value属性的时候可以省略value名称不写!!(避免出错,最好都写上名称)
- 当注解中有多个Value属性时,value名称不能省略
示例:
@Mybook
package com.hhxy.annotation;
public @interface MyBook {
public String name();
String[] authors();
double price();
}
Book类
package com.hhxy.annotation;
@MyBook(name="《Java》",authors ={"黑马程序员","ghp"},price = 9.9)
public class Book {
@MyBook(name="《Java》",authors ={"黑马程序员","ghp"},price = 9.9)
public Book(){
}
@MyBook(name="《Java》",authors ={"黑马程序员","ghp"},price = 9.9)
public static void main(String[] args) {
@MyBook(name="《Java》",authors ={"黑马程序员","ghp"},price = 9.9)
int a = 2;
}
}
3、元注解
元注解:就是注解(v,动词)注解(n,名词)的注解(n,名词)(中华文化博大精深😆),大白话就是给注解加的注解。
常见的的元注解:
-
@Target
:约束自定义注解只能在那些地方用 -
@Retention
:申明注解的生命周期
用法示例:
package com.hhxy.annotation;
@Target({ElementType.METHOD,ElementType.FIELD})//限定MyBook注解只能对方法,成员变量使用
@Retention(RetentionPolicy.RUNTIME)//该注解只在运行阶段生效
public @interface MyBook {
public String name();
String[] authors();
double price();
}
5、注解解析
注解的操作中经常需要进行解析,注解的解析就是判断是否存在注解,存在注解就解析出内容
与注解解析相关的接口:
-
Annotation:注解的顶级接口,注解都是Annotation类型的对象
-
AnnotatedElement:该接口定义了与注解解析相关的解析方法
备注:所有的类成分Class, Method , Field , Constructor,都实现了AnnotatedElement接口他们都拥有解析注解的能力
类中的静态成员不具有
注解解析技巧:想要解析哪个注解,就先去拿注解所在的对象
BookAnnotation注解:自定义注解,添加相应的元注解
package com.hhxy.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)//该注解BookAnnotation只在运行时起作用
@Target({ElementType.TYPE,ElementType.METHOD})//该注解BookAnnotation只能作用在类和成员方法上
public @interface BookAnnotation {
String bookName();
double price() default 9.9;
String[] author();
}
BookStore类:在该类和该类的成员方法上添加@BookAnnotation注解
package com.hhxy.annotation;
@BookAnnotation(bookName = "《Java》",author = {"黑马成员","001"},price = 99.0)
public class BookStore{
public static void main(String[] args) {
System.out.println("这是一个书店");
}
@BookAnnotation(bookName = "《JavaSE基础教程》",author = {"黑马成员","001"})
public void see(){
}
}
ParseTest类:用于注解的解析测试
package com.hhxy.annotation;
import org.junit.Test;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.Arrays;
public class ParseTest{
@Test
public void testAnnotationParse() throws Exception {
//首先要获取想要测试的成员方法方法、类、构造器、成员变量对应的类对象
Class bsClass = BookStore.class;
/*解析类上面的注解*/
//判断这个类对象是否具有BookAnnotation注解
if(bsClass.isAnnotationPresent(BookAnnotation.class)){
//获取类上面的BookAnnotation注解
BookAnnotation cAnnotation = (BookAnnotation) bsClass.getDeclaredAnnotation(BookAnnotation.class);
System.out.println(cAnnotation.bookName());
//当返回数组时,要使用Arrays工具类中国toString方法
System.out.println(Arrays.toString(cAnnotation.author()));
System.out.println(cAnnotation.price());
}
System.out.println("---------------------------------------------------");
/*解析成员方法上面的注解*/
//获取类对象中的方法对象
Method m = bsClass.getDeclaredMethod("see");
//判断该方法是否具有BookAnnotation注解
if(m.isAnnotationPresent(BookAnnotation.class)){
//获取方法上面的BookAnnotation注解
BookAnnotation mAnnotation = (BookAnnotation)m.getDeclaredAnnotation(BookAnnotation.class);
System.out.println(mAnnotation.bookName());
System.out.println(Arrays.toString(mAnnotation.author()));
System.out.println(mAnnotation.price());
}
}
}
使用注解简单模拟Junit框架
自定义一个注解@MyTest对Junit框架进行
@MyTest注解
package com.hhxy.junit;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)//一定要设置成RUNTIME,因为检测注解是发生在运行阶段的,它默认是编译阶段有效
public @interface MyTest {
}
Main类:
package com.hhxy.junit;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
public class Main {
@MyTest
public void f1(){
System.out.println("我有MyTest注解");
}
public void f2(){
System.out.println("我没有MyTest注解");
}
/**
* 有@MyTest注解就执行
* @param args
*/
public static void main(String[] args) throws InvocationTargetException, IllegalAccessException {
Main main = new Main();//利用对象触发方法
//1.获取类对象
Class mClass = Main.class;
//2.获取类对象中所有的方法
Method[] methods = mClass.getDeclaredMethods();
for (Method method : methods) {
if(method.isAnnotationPresent(MyTest.class)){
System.out.println("111");
method.invoke(main);
}
}
}
}