上一篇java注解初探介紹了注解的基本概念, @Retention注解參數(shù)為CLASS時是編譯時注解而RUNTIME時是運行時注解牙捉,這些在上一篇都有介紹,本篇文章將通過Demo來說說編譯時注解和運行時注解橙喘。
1航唆、 運行時注解
運行時注解是通過反射在程序運行時獲取注解信息财异,然后利用信息進行其他處理阱冶。下面是運行時注解的一個簡單Damo寓搬,包含Company、EmployeeName双揪、EmployeeSex注解定義以及EmployeeInfoUtil注解處理器,客戶端包含EmployeeInfo類(成員變量使用注解)和一個main方法包帚。
Compay代碼:
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Company {
public int id() default -1;
public String name() default "";
public String address() default "";
}
EmployeeName代碼:
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface EmployeeName {
String value () default "";
}
EmployeeSex代碼:
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface EmployeeSex {
enum Sex{Man,Woman}//定義性別枚舉
Sex employeeSex() default Sex.Man;
}
上一篇文章我們也介紹了渔期,注解的關鍵是注解處理器,下面的注解處理器僅僅獲取注解信息
public class EmployeeInfoUtil {
public static Map getEmployeeInfo(Class<?> clazz){
HashMap<String ,String> info = new HashMap<>();
Field[] fields = clazz.getDeclaredFields();//獲取類成員變量
for (Field field: fields) {//遍歷
if (field.isAnnotationPresent(EmployeeName.class)){//判斷是不是EmployeeName類型注解
EmployeeName employeeName = field.getAnnotation(EmployeeName.class);
info.put("employeeName",employeeName.value());//獲取注解的值
}
if (field.isAnnotationPresent(EmployeeSex.class)) {
EmployeeSex employeeSex = field.getAnnotation(EmployeeSex.class);
info.put("employeeSex",employeeSex.employeeSex().toString());
}
if (field.isAnnotationPresent(Company.class)) {
Company company = field.getAnnotation(Company.class);
info.put("company",company.id()+":"+company.name()+":"+company.address());
}
}
return info;
}
}
EmployeeInfo代碼:
public class EmployeeInfo {
@EmployeeName("zfq")
private String employeeName;
@EmployeeSex(employeeSex = EmployeeSex.Sex.Woman)
private String employeeSex;
@Company(id = 1,name = "HYR集團",address = "河南開封")
private String company;
//省略set和get方法
}
客戶端代碼:
public class EmployeeRun {
public static void main(String[] args) {
Map fruitInfo = EmployeeInfoUtil.getEmployeeInfo(EmployeeInfo.class);
System.out.println(fruitInfo);
}
}
運行結(jié)果:
{employeeName=zfq, employeeSex=Woman, company=1:HYR集團:河南開封}
2渴邦、編譯時注解
編譯時注解是在程序編譯的時候動態(tài)的生成一些類或者文件疯趟,所以編譯時注解不會影響程序運行時的性能,而運行時注解則依賴于反射谋梭,反射肯定會影響程序運行時的性能信峻,所以一些知名的三方庫一般都是使用編譯時時注解,比如大名鼎鼎的ButterKnife瓮床、Dagger盹舞、Afinal等。下面編譯時注解是編譯時打印使用指定注解的方法的方法信息隘庄,注解的定義和運行時注解一樣踢步,主要是注解處理器對注解的處理不同 。首先AS的工程中新加Module丑掺,選擇java Library(指定library name)获印。
@InjectPrint注解代碼:
@Target({ElementType.FIELD, ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.CLASS)
public @interface InjectPrint {
String value();
}
InjectPrintProcessor處理器代碼:
@SupportedAnnotationTypes("com.example.InjectPrint")//參數(shù)是指定注解類型的全路徑
public class InjectPrintProcessor extends AbstractProcessor {
@Override
public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
//獲取InjectPrint類型注解,然后遍歷
for(Element element : roundEnvironment.getElementsAnnotatedWith(InjectPrint.class)){
//元素類型是一個方法
if(element.getKind() == ElementKind.METHOD){
//強轉(zhuǎn)成方法對應的element街州,同
// 理兼丰,如果你的注解是一個類,那你可以強轉(zhuǎn)成TypeElement
ExecutableElement executableElement = (ExecutableElement)element;
//打印方法名
System.out.println(executableElement.getSimpleName());
//打印方法的返回類型
System.out.println(executableElement.getReturnType().toString());
//獲取方法所有的參數(shù)
List<? extends VariableElement> params = executableElement.getParameters();
for(VariableElement variableElement : params){//遍歷并打印參數(shù)名
System.out.println(variableElement.getSimpleName());
}
//打印注解的值
System.out.println("AnnotationValue:"+executableElement.getAnnotation(InjectPrint.class).value());
}
}
return false;
}
@Override
public SourceVersion getSupportedSourceVersion() {
return SourceVersion.latestSupported();
}
}
為了我們的AbstractProcessor內(nèi)被使用唆缴,需要在META-INF中顯示標識鳍征,在resources資源文件夾下新建 META-INF/services/javax.annotation.processing.Processor,其內(nèi)容:
com.example.InjectPrintProcessor //注解處理器的全路徑
具體的目錄結(jié)構如下圖所示:
到此我們就可以build整個工程(要把我們的myanno模塊添加到主工程下一起編譯,build->Edit Libraries and Dependencies->主工程module->Dependencies->+->Module dependency)生成jar包了面徽,如下圖
我們可以把myanno.jar拷貝出來蟆技,添加到主工程的libs文件夾里,別忘Add As Library
然后,我們就可以在我們的主工程里使用@InjectPrint注解了
Build我們的項目质礼,然后Gradle Console控制臺就可以看到輸出信息了
注意:如果你編譯過一次下次可能在build的時候可能就看不到控制臺輸出旺聚,這時候你要選擇Rebuild Project
自定義運行時和編譯時注解到這里就介紹完了,如果感興趣的同學可以自己寫寫感受一下眶蕉,下一篇博客我會去研究一下ButterKnife源碼砰粹,繼續(xù)學習。