Android Gradle插件2.2版本發(fā)布后,Android 官方提供了annotationProcessor來(lái)代替android-apt筐赔,annotationProcessor同時(shí)支持 javac 和 jack 編譯方式铣猩,而android-apt只支持 javac 方式。同時(shí)android-apt作者宣布不在維護(hù)茴丰,當(dāng)然目前android-apt仍然可以正常運(yùn)行达皿,如果你沒有想支持 jack 編譯方式的話,可以繼續(xù)使用android-apt贿肩。
android-apt切換annotationProcessor步驟
1.Android Gradle 插件版本升級(jí)到 2.2 及以上
當(dāng)前Android Studio已經(jīng)升級(jí)到2.2版本
repositories {
jcenter()
}
dependencies {
classpath'com.android.tools.build:gradle:2.2.2'
classpath'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7'
classpath'com.github.dcendents:android-maven-gradle-plugin:1.5'
classpath'com.hujiang.aspectjx:gradle-android-plugin-aspectjx:1.0.10'
}
}```
2.刪除build.gradle文件中android-apt的相關(guān)配置
buildscript{repositories{ jcenter() }dependencies{classpath'com.neenbedankt.gradle.plugins:android-apt:1.8'} } apply plugin:'com.neenbedankt.android-apt'
3.改成新的依賴峦椰,build.gradle文件中使用android-apt引入的依賴修改為使用annotationProcessor,修改前配置如下:
dependencies{compile'com.google.dagger:dagger:2.0'apt'com.google.dagger:dagger-compiler:2.0'}
修改后配置如下:
dependencies{compile'com.google.dagger:dagger:2.0'annotationProcessor'com.google.dagger:dagger-compiler:2.0'}
配置完成后annotationProcessor的使用:
1.自定義注解
public @interface 注解名{注解體}汰规。注解體中注解元素可以被public修飾汤功,也可以什么也不寫,元素類型可以是:
所有基本數(shù)據(jù)類型(int,float,boolean等)
String類型
Class類型
enum類型
Annotation類型(說明注解可以嵌套)
以上所有類型的數(shù)組
沒有元素的標(biāo)記注解
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.CLASS)
public@interfaceRequestCode{
}
單值注解:
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.CLASS)
public @interface Uri {
String value();
}
2.使用注解:
@Uri("gank://androidwing.net/about/")
voidstartAbout();
3.自定義注解處理類庫(kù):
如果沒有用來(lái)讀取注解的工具溜哮,那注解也不會(huì)比注釋更有用滔金。使用注解的過程中很重要的一個(gè)部分就是創(chuàng)建與使用注解處理器:
public final class ServiceElement {
ClassName serviceClassName;
String packageName;
ClassName providerClassName;
List enclosedElements;
Element element;
public ServiceElement(Element serviceElement) {
element = serviceElement;
//獲取類名
String className = serviceElement.getSimpleName().toString();
//獲取包
PackageElement packageElement = (PackageElement) serviceElement.getEnclosingElement();
packageName = packageElement.getQualifiedName().toString();
serviceClassName = ClassName.get(packageName, className);
enclosedElements = serviceElement.getEnclosedElements();
String serviceProviderName = className +"$$Provider";
providerClassName = ClassName.get(packageName, serviceProviderName);
}
public String getPackageName() {
return packageName;
}
public ClassName getProviderClassName() {
return providerClassName;
}
public ClassName getClassName() {
return serviceClassName;
}
public List getEnclosedElements() {
return enclosedElements;
}
public Element getElement() {
return element;
}
}
該類用來(lái)儲(chǔ)存注解類的信息,包括類茂嗓,構(gòu)造方法餐茵,成員變量,方法等
接下來(lái)就是注解生成類(注解處理器):
@Override
public booleanprocess(Set annotations, RoundEnvironment roundEnv) {
//數(shù)據(jù)處理
List addressElements = generateAddressElements(roundEnv);
//非空判斷
if(ElementUtils.isEmpty(addressElements)) {
return false;
}
Map> serviceElements = findServiceElements(addressElements);
if(ElementUtils.isEmpty(serviceElements)) {
return false;
}
for(Map.Entry> serviceElementEntrySet : serviceElements.entrySet()) {
TypeElement serviceElement = serviceElementEntrySet.getKey();
ListserviceAddressElements= serviceElementEntrySet.getValue();
if(ElementUtils.isEmpty(serviceAddressElements)) {
break;
}
try{
//處理生成類
generateDeepLinkService(serviceElement,serviceAddressElements);
}catch(IOException e) {
logger.error("Error creating matcher file", serviceElement);
}
}
return true;
}
數(shù)據(jù)處理方法:
generateAddressElements(roundEnv)
privateList generateAddressElements(RoundEnvironment roundEnv) {
List annotationElements =newArrayList<>();
//注解類型數(shù)據(jù)處理
for(String annotationType : getSupportedAnnotationTypes()) {
TypeElement typeElement =processingEnv.getElementUtils().getTypeElement(annotationType);
Set annotatedElements = roundEnv.getElementsAnnotatedWith(typeElement);
for(Element annotatedElement : annotatedElements) {
if(!annotationElements.contains(annotatedElement)) {
annotationElements.add(annotatedElement);
}
}
}
List serviceElements =newArrayList<>();
for(Element element : annotationElements) {
ElementKind kind = element.getKind();
if(kind != ElementKind.METHOD) {
logger.error("Only classes and methods can be with "+ getSupportedAnnotationTypes(), element);
}
if(!isSupportReturnType((ExecutableElement) element)) {
logger.error("method only support return type is "+SUPPORT_RETURN_TYPE.toString(), element);
}
Element enclosingElement = element.getEnclosingElement();
String name = enclosingElement.getSimpleName().toString();
if(!name.endsWith("Service")) {
logger.error(name +"this class must be in end with Service", enclosingElement);
}
if(enclosingElement.getKind() != ElementKind.INTERFACE) {
logger.error(name +"this class must be interface", enclosingElement);
}
serviceElements.add(newAddressElement(element));
}
returnserviceElements;
}
數(shù)據(jù)處理好之后就是代碼生成:
private voidgenerateDeepLinkService(TypeElement serviceElements,
List deepLinkMatchElements)
throwsIOException {
ClassName providerClassName = getServiceProviderClassName(serviceElements);
MethodSpec initMethod = generateInitMethod(deepLinkMatchElements);
//成員變量
FieldSpec activity = FieldSpec
.builder(DEEP_LINK_CLIENT,"deepLinkClient",
Modifier.PUBLIC)
.build();
//構(gòu)造器定義
MethodSpec activityConstructor = MethodSpec.constructorBuilder()
.addModifiers(Modifier.PUBLIC)
.addParameter(DEEP_LINK_CLIENT,"deepLinkClient")
.addCode("this.deepLinkClient= deepLinkClient;\n")
.build();
//類定義
TypeSpec.Builder serviceProviderBuilder = TypeSpec.classBuilder(providerClassName)
.addModifiers(Modifier.PUBLIC, Modifier.FINAL)
.addAnnotation(AnnotationSpec.builder(Aspect.class).build())
.addSuperinterface(ClassName.get(serviceElements))
.addField(activity)
.addMethod(activityConstructor)
.addMethod(initMethod);
//函數(shù)定義
for(AddressElement matchElement : deepLinkMatchElements) {
ExecutableElement element = (ExecutableElement) matchElement.getElement();
serviceProviderBuilder.addMethod(geneOverServiceMethod(element));
}
//構(gòu)造注冊(cè)
MethodSpec buildMethodSpec = generateBuildMethod(serviceElements);
serviceProviderBuilder.addMethod(buildMethodSpec);
//完成APT類的注解生成
JavaFile.builder(ClassName.get(serviceElements).packageName(), serviceProviderBuilder.build())
.build()
.writeTo(filer);
}
最后得到生成的類:
@Aspect
public final classSampleService$$ProviderimplementsSampleService {
publicDeepLinkClient deepLinkClient;
publicSampleService$$Provider(DeepLinkClient deepLinkClient) {
this.deepLinkClient = deepLinkClient;
}
public voidstartSecondActivity(String value1,intvalue2) {
Intent intent =newIntent();
intent.putExtra("key1", value1);
intent.putExtra("key2", value2);
intent.setData(Uri.parse("app://deeplink/second"));
Request request =this.deepLinkClient.buildRequest(intent);
if(request !=null) {
request.start();
}
}
}
總結(jié):使用注解標(biāo)簽是非常方便一勞永逸述吸,尤其是做些重復(fù)性且類似的處理忿族,比如使用ButterKnife就不用重復(fù)寫太多的控件find,雖然注解處理器處理起來(lái)比較麻煩蝌矛,但想想接下來(lái)一大堆蛋疼的重復(fù)代碼道批,所以還是值得一試。
本文借用了sunshine8大神的android組件化-路由器OkDeepLink代碼入撒。從中抽取了其中注解標(biāo)簽使用部分隆豹。
**參考文獻(xiàn):**
****
**[http://www.reibang.com/p/8a3eeeaf01e8](http://www.reibang.com/p/8a3eeeaf01e8)Android 組件化 —— 路由設(shè)計(jì)最佳實(shí)踐**
[http://www.reibang.com/p/c1666a947692](http://www.reibang.com/p/c1666a947692)android-apt切換為官方annotationProcessor