您好,登錄后才能下訂單哦!
1. 一些基本概念
在開始之前,我們需要聲明一件重要的事情是:我們不是在討論在運(yùn)行時(shí)通過反射機(jī)制運(yùn)行處理的注解,而是在討論在編譯時(shí)處理的注解。
編譯時(shí)注解跟運(yùn)行時(shí)注解到底區(qū)別在什么地方?其實(shí)說大也不大,主要是考慮到性能上面的問題。運(yùn)行時(shí)注解主要是完全依賴于反射,反射的效率比原生的慢,所以在內(nèi)存比較少,CPU比較爛的機(jī)器上會(huì)有一些卡頓現(xiàn)象出現(xiàn)。而編譯時(shí)注解完全不會(huì)有這個(gè)問題,因?yàn)樗谖覀兙幾g過程(java->class)中,通過一些注解標(biāo)示,去動(dòng)態(tài)生成一些類或者文件,所以跟我們的APK運(yùn)行完全沒有任何關(guān)系,自然就不存在性能上的問題。所以一般比較著名的開源項(xiàng)目如果采用注解功能,通常采用編譯時(shí)注解
注解處理器是 javac 自帶的一個(gè)工具,用來在編譯時(shí)期掃描處理注解信息。你可以為某些注解注冊(cè)自己的注解處理器。這里,我假設(shè)你已經(jīng)了解什么是注解及如何自定義注解。如果你還未了解注解的話,可以查看官方文檔。注解處理器在 Java 5 的時(shí)候就已經(jīng)存在了,但直到 Java 6 (發(fā)布于2006看十二月)的時(shí)候才有可用的API。過了一段時(shí)間java的使用者們才意識(shí)到注解處理器的強(qiáng)大。所以最近幾年它才開始流行。
一個(gè)特定注解的處理器以 java 源代碼(或者已編譯的字節(jié)碼)作為輸入,然后生成一些文件(通常是.java文件)作為輸出。那意味著什么呢?你可以生成 java 代碼!這些 java 代碼在生成的.java文件中。因此你不能改變已經(jīng)存在的java類,例如添加一個(gè)方法。這些生成的 java 文件跟其他手動(dòng)編寫的 java 源代碼一樣,將會(huì)被 javac 編譯。
Annotation processing是在編譯階段執(zhí)行的,它的原理就是讀入Java源代碼,解析注解,然后生成新的Java代碼。新生成的Java代碼最后被編譯成Java字節(jié)碼,注解解析器(Annotation Processor)不能改變讀入的Java 類,比如不能加入或刪除Java方法。
2. AbstractProcessor
讓我們來看一下處理器的 API。所有的處理器都繼承了AbstractProcessor,如下所示:
package com.example; import java.util.LinkedHashSet; import java.util.Set; import javax.annotation.processing.AbstractProcessor; import javax.annotation.processing.ProcessingEnvironment; import javax.annotation.processing.RoundEnvironment; import javax.annotation.processing.SupportedAnnotationTypes; import javax.annotation.processing.SupportedSourceVersion; import javax.lang.model.SourceVersion; import javax.lang.model.element.TypeElement; public class MyProcessor extends AbstractProcessor { @Override public boolean process(Set<? extends TypeElement> annoations, RoundEnvironment env) { return false; } @Override public Set<String> getSupportedAnnotationTypes() { Set<String> annotataions = new LinkedHashSet<String>(); annotataions.add("com.example.MyAnnotation"); return annotataions; } @Override public SourceVersion getSupportedSourceVersion() { return SourceVersion.latestSupported(); } @Override public synchronized void init(ProcessingEnvironment processingEnv) { super.init(processingEnv); } }
init(ProcessingEnvironment processingEnv) :所有的注解處理器類都必須有一個(gè)無參構(gòu)造函數(shù)。然而,有一個(gè)特殊的方法init(),它會(huì)被注解處理工具調(diào)用,以ProcessingEnvironment作為參數(shù)。ProcessingEnvironment 提供了一些實(shí)用的工具類Elements, Types和Filer。我們?cè)诤竺鎸?huì)使用到它們。
process(Set<? extends TypeElement> annoations, RoundEnvironment env)
:這類似于每個(gè)處理器的main()方法。你可以在這個(gè)方法里面編碼實(shí)現(xiàn)掃描,處理注解,生成 java 文件。使用RoundEnvironment 參數(shù),你可以查詢被特定注解標(biāo)注的元素(原文:you can query for elements annotated with a certain annotation )。后面我們將會(huì)看到詳細(xì)內(nèi)容。
getSupportedAnnotationTypes():
在這個(gè)方法里面你必須指定哪些注解應(yīng)該被注解處理器注冊(cè)。注意,它的返回值是一個(gè)String集合,包含了你的注解處理器想要處理的注解類型的全稱。換句話說,你在這里定義你的注解處理器要處理哪些注解。
getSupportedSourceVersion()
: 用來指定你使用的 java 版本。通常你應(yīng)該返回SourceVersion.latestSupported()
。不過,如果你有足夠的理由堅(jiān)持用 java 6 的話,你也可以返回SourceVersion.RELEASE_6
。我建議使用SourceVersion.latestSupported()
。在 Java 7 中,你也可以使用注解的方式來替代重寫getSupportedAnnotationTypes()
和 getSupportedSourceVersion()
,如下所示:
@SupportedSourceVersion(value=SourceVersion.RELEASE_7) @SupportedAnnotationTypes({ // Set of full qullified annotation type names "com.example.MyAnnotation", "com.example.AnotherAnnotation" }) public class MyProcessor extends AbstractProcessor { @Override public boolean process(Set<? extends TypeElement> annoations, RoundEnvironment env) { return false; } @Override public synchronized void init(ProcessingEnvironment processingEnv) { super.init(processingEnv); } }
由于兼容性問題,特別是對(duì)于 android ,我建議重寫getSupportedAnnotationTypes()
和 getSupportedSourceVersion()
,而不是使用 @SupportedAnnotationTypes
和 @SupportedSourceVersion
。
接下來你必須知道的事情是:注解處理器運(yùn)行在它自己的 JVM 中。是的,你沒看錯(cuò)。javac 啟動(dòng)了一個(gè)完整的 java 虛擬機(jī)來運(yùn)行注解處理器。這意味著什么?你可以使用任何你在普通 java 程序中使用的東西。使用 guava! 你可以使用依賴注入工具,比如dagger或者任何其他你想使用的類庫。但不要忘記,即使只是一個(gè)小小的處理器,你也應(yīng)該注意使用高效的算法及設(shè)計(jì)模式,就像你在開發(fā)其他 java 程序中所做的一樣。
3. 注冊(cè)你的處理器
你可能會(huì)問 “怎樣注冊(cè)我的注解處理器到 javac ?”。你必須提供一個(gè).jar文件。就像其他 .jar 文件一樣,你將你已經(jīng)編譯好的注解處理器打包到此文件中。并且,在你的 .jar 文件中,你必須打包一個(gè)特殊的文件javax.annotation.processing.Processor到META-INF/services目錄下。因此你的 .jar 文件目錄結(jié)構(gòu)看起來就你這樣:
MyProcess.jar -com -example -MyProcess.class -META-INF -services -javax.annotation.processing.Processor
javax.annotation.processing.Processor 文件的內(nèi)容是一個(gè)列表,每一行是一個(gè)注解處理器的全稱。例如:
com.example.MyProcess
com.example.AnotherProcess
4. 例子:工廠模式
我們要解決的問題是:我們要實(shí)現(xiàn)一個(gè) pizza 店,這個(gè) pizza 店提供給顧客兩種 pizza (Margherita 和 Calzone),還有甜點(diǎn) Tiramisu(提拉米蘇)。
public interface Meal { public float getPrice(); } public class MargheritaPizza implements Meal{ @Override public float getPrice() { return 6.0f; } } public class CalzonePizza implements Meal{ @Override public float getPrice() { return 8.5f; } } public class Tiramisu implements Meal{ @Override public float getPrice() { return 4.5f; } } public class PizzaStore { public Meal order(String mealName) { if (null == mealName) { throw new IllegalArgumentException("name of meal is null!"); } if ("Margherita".equals(mealName)) { return new MargheritaPizza(); } if ("Calzone".equals(mealName)) { return new CalzonePizza(); } if ("Tiramisu".equals(mealName)) { return new Tiramisu(); } throw new IllegalArgumentException("Unknown meal '" + mealName + "'"); } private static String readConsole() { Scanner scanner = new Scanner(System.in); String meal = scanner.nextLine(); scanner.close(); return meal; } public static void main(String[] args) { System.out.println("welcome to pizza store"); PizzaStore pizzaStore = new PizzaStore(); Meal meal = pizzaStore.order(readConsole()); System.out.println("Bill:$" + meal.getPrice()); } }
正如你所見,在order()方法中,我們有許多 if 條件判斷語句。并且,如果我們添加一種新的 pizza 的話,我們就得添加一個(gè)新的 if 條件判斷。但是等一下,使用注解處理器和工廠模式,我們可以讓一個(gè)注解處理器生成這些 if 語句。如此一來,我們想要的代碼就像這樣子:
public class PizzaStore { private MealFactory factory = new MealFactory(); public Meal order(String mealName) { return factory.create(mealName); } private static String readConsole() { Scanner scanner = new Scanner(System.in); String meal = scanner.nextLine(); scanner.close(); return meal; } public static void main(String[] args) { System.out.println("welcome to pizza store"); PizzaStore pizzaStore = new PizzaStore(); Meal meal = pizzaStore.order(readConsole()); System.out.println("Bill:$" + meal.getPrice()); } } public class MealFactory { public Meal create(String id) { if (id == null) { throw new IllegalArgumentException("id is null!"); } if ("Calzone".equals(id)) { return new CalzonePizza(); } if ("Tiramisu".equals(id)) { return new Tiramisu(); } if ("Margherita".equals(id)) { return new MargheritaPizza(); } throw new IllegalArgumentException("Unknown id = " + id); } }
5. @Factory Annotation
能猜到么,我們打算使用注解處理器生成MealFactory類。更一般的說,我們想要提供一個(gè)注解和一個(gè)處理器用來生成工廠類。
讓我們看一下@Factory注解:
@Target(ElementType.TYPE) @Retention(RetentionPolicy.CLASS) public @interface Factory { /** * The name of the factory */ Class<?> type(); /** * The identifier for determining which item should be instantiated */ String id(); }
思想是這樣的:我們注解那些食物類,使用type()表示這個(gè)類屬于哪個(gè)工廠,使用id()表示這個(gè)類的具體類型。讓我們將@Factory注解應(yīng)用到這些類上吧:
@Factory(type=MargheritaPizza.class, id="Margherita") public class MargheritaPizza implements Meal{ @Override public float getPrice() { return 6.0f; } } @Factory(type=CalzonePizza.class, id="Calzone") public class CalzonePizza implements Meal{ @Override public float getPrice() { return 8.5f; } } @Factory(type=Tiramisu.class, id="Tiramisu") public class Tiramisu implements Meal{ @Override public float getPrice() { return 4.5f; } }
你可能會(huì)問,我們是不是可以只將@Factory注解應(yīng)用到Meal接口上?答案是不行,因?yàn)樽⒔馐遣荒鼙焕^承的。即在class X上有注解,class Y extends X,那么class Y是不會(huì)繼承class X上的注解的。在我們編寫處理器之前,需要明確幾點(diǎn)規(guī)則:
注解處理器:
public class FactoryProcessor extends AbstractProcessor { private Types typeUtils; private Elements elementUtils; private Filer filer; private Messager messager; private Map<String, FactoryGroupedClasses> factoryClasses = new LinkedHashMap<String, FactoryGroupedClasses>(); @Override public synchronized void init(ProcessingEnvironment processingEnv) { super.init(processingEnv); typeUtils = processingEnv.getTypeUtils(); elementUtils = processingEnv.getElementUtils(); filer = processingEnv.getFiler(); messager = processingEnv.getMessager(); } @Override public boolean process(Set<? extends TypeElement> arg0, RoundEnvironment arg1) { ... return false; } @Override public Set<String> getSupportedAnnotationTypes() { Set<String> annotataions = new LinkedHashSet<String>(); annotataions.add(Factory.class.getCanonicalName()); return annotataions; } @Override public SourceVersion getSupportedSourceVersion() { return SourceVersion.latestSupported(); } }
在getSupportedAnnotationTypes()
方法中,我們指定@Factory注解將被這個(gè)處理器處理。
總結(jié)
以上就是這篇文章的全部?jī)?nèi)容了,希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,如果有疑問大家可以留言交流,謝謝大家對(duì)億速云的支持。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。