在使用編譯時註解時,需要在編譯期間對註解進行處理,在這裏我們沒辦法影響程序的運行邏輯,但我們可以進行一些需處理,比如生成一些功能性代碼來輔助程序的開發,最常見的是生成.java 源文件,並在程序中可以調用到生成的文件。這樣我們就可以用註解來幫助我們處理一些固定邏輯的重複性代碼(如butterknife),提高開發的效率。
通過註解處理器來生成 .java 源文件基本上都會使用javapoet 這個庫,JavaPoet一個是用於產生 .java 源文件的輔助庫,它可以很方便地幫助我們生成需要的.java 源文件,下面來看下具體使用方法。
JavaPoet
在使用前需要先引入這個庫,和 AutoService一樣可以通過AndroidStudio 直接添加,如下:
下面以最簡單的 HelloWorld 例子來看下怎麼使用JavaPoet。
先定義一個註解:
/**
* JavaPoet HelloWorld 例子
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface JPHelloWorld {
}
在定義個註解處理器來處理這個註解:
/**
* 處理HelloWorld註解.
*/
@AutoService(Processor.class)
public class HelloWorldProcess extends AbstractProcessor {
private Filer filer;
@Override
public synchronized void init(ProcessingEnvironment processingEnv) {
super.init(processingEnv);
// Filer是個接口,支持通過註解處理器創建新文件
filer = processingEnv.getFiler();
}
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
for (TypeElement element : annotations) {
if (element.getQualifiedName().toString().equals(JPHelloWorld.class.getCanonicalName())) {
// 創建main方法
MethodSpec main = MethodSpec.methodBuilder("main")
.addModifiers(Modifier.PUBLIC, Modifier.STATIC)
.returns(void.class)
.addParameter(String[].class, "args")
.addStatement("$T.out.println($S)", System.class, "Hello, JavaPoet!")
.build();
// 創建HelloWorld類
TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")
.addModifiers(Modifier.PUBLIC, Modifier.FINAL)
.addMethod(main)
.build();
try {
// 生成 com.example.HelloWorld.java
JavaFile javaFile = JavaFile.builder("com.example", helloWorld)
.addFileComment(" This codes are generated automatically. Do not modify!")
.build();
// 生成文件
javaFile.writeTo(filer);
} catch (IOException e) {
e.printStackTrace();
}
}
}
return true;
}
@Override
public Set<String> getSupportedAnnotationTypes() {
Set<String> annotations = new LinkedHashSet<>();
annotations.add(JPHelloWorld.class.getCanonicalName());
return annotations;
}
@Override
public SourceVersion getSupportedSourceVersion() {
return SourceVersion.latestSupported();
}
}
在用 JavaPoet 來生成一個HelloWorld.java文件之前,我們還必須在 init()方法裏獲取到 Filer,這是一個用來輔助創建文件的接口,我們生成文件都通過它來處理。在 process()方法先創建了個 MethodSpec 表示一個方法,再創建一個 TypeSpec 表示一個類並添加上前面創建的方法,最後用 JavaFile 來生成對應的HelloWorld.java 並寫入文件。
這是最簡單的例子,整個語法結構也很清晰,相信做編程的看到這些使用方法都能猜到是做什麼用的,我就沒詳細說了。除了這個例子,Github上還有很多其它示例,如果你想很好地瞭解編譯時註解的使用的話,還是很有必要把每個例子都過一遍,如果不想自己敲粘貼複製下很容易的。
在代碼中使用定義的註解:
@JPHelloWorld
public class MainActivity extends AppCompatActivity{
// ...
}
重新 Make 下工程就可以看到生成的 HelloWorld.java 文件了,目錄如下:
可以看到已經成功生成了 HelloWorld.java 文件,注意生成文件所在的目錄,現在我們就可以在項目中直接使用這個 java 類了。當然了,這個例子沒有什麼實際的使用價值,你可以參考其它例子來生成你想要的代碼,用法是很多的。
這裏只寫了個最簡單的例子,沒有深入更詳細的使用方法,等後面有時間再來整理個更詳細的介紹。