要使用微信支付、分享等功能，必須制定在包名下的wxapi創(chuàng)建一個(gè)名為 wxapi 的文件，然后在 wxapi 文件下創(chuàng)建一個(gè)名為 WXEntryActivity 或者 WXPayEntryActivity 的 Activity 類，并實(shí)現(xiàn) IWXAPIEventHandler 接口。有做個(gè)微信相關(guān)功能的同志都知道不就是在知道位置創(chuàng)建一個(gè)Activity嘛，so easy 啦。
為什么需要使用到 APT 呢？
由于我開發(fā)并維護(hù)著一個(gè)比較特別的項(xiàng)目，這個(gè)項(xiàng)目可以用同一份代碼根據(jù)配置更改，使用不同的資源文件打包出三個(gè)類似的 APK，這三個(gè) APK 使用不同的皮膚、不一樣的后臺(tái) API。說(shuō)的可能有點(diǎn)抽象，其實(shí)就是三個(gè)風(fēng)格一樣的應(yīng)用，皮膚不同，后臺(tái)數(shù)據(jù)也不同，自然三個(gè) APK 的包名也不一致。不同的包名導(dǎo)致這個(gè)微信回調(diào)類需要 APT 動(dòng)態(tài)生成。
何為 APT
是 Annotation Processing Toold 的縮寫，就是注解處理器的意思，該處理器可以在編譯期在制定位置生成想要的Java類、文檔、HTML等。如果不了解注解的話可以到前文了解一番《Java注解知識(shí)》，不然可能看不太懂這篇內(nèi)容。
實(shí)現(xiàn)思路
1.最任意一個(gè)文件下面創(chuàng)建一個(gè) WXEntryActivity ，實(shí)現(xiàn)邏輯跟往常一樣。
2.利用 APT 在制定路徑下生成一個(gè)空白 WXEntryActivity ，該類繼承步驟1的 WXEntryActivity ，不需要任何屬性與方法。
3.編寫注解 @CustomPackage，該注解包含一個(gè)包名屬性 packageName，將該注解標(biāo)記到步驟1中創(chuàng)建的 WXEntryActivity ，注解屬性賦值為應(yīng)用包名。
4.編寫注解器 CustomPackageProcessor ，利用該注解器在編譯期生成步驟2的 WXEntryActivity 。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface CustomPackage {
String packageName() default "com"; //包名
}
@CustomPackage(packageName = BuildConfig.applicationId + ".wxapi")
public class WXEntryActivity extends AppCompatActivity implements IWXAPIEventHandler {
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// 通過(guò)WXAPIFactory工廠，獲取IWXAPI的實(shí)例
IWXAPI api = WXAPIFactory.createWXAPI(this, "WXAppId", false);
api.handleIntent(getIntent(), this);
}
@Override
public void onReq(BaseReq baseReq) {
}
@Override
public void onResp(BaseResp resp) {
}
}
@SupportedAnnotationTypes("com.amazing.wechat_annotation.CustomPackage")
public class CustomPackageProcessor extends AbstractProcessor {
private Elements elementUtils;
@Override
public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
Set<? extends Element> elememts = roundEnvironment.getElementsAnnotatedWith(CustomPackage.class);
if (elememts != null) {
for (Element element : elememts) {
CustomPackage customPackage = element.getAnnotation(CustomPackage.class);
String packageName = customPackage.packageName();
//some check
if (packageName.isEmpty()) {
throw new IllegalArgumentException("packageName can't be null or empty");
}
TypeElement typeElement;
if (element instanceof TypeElement) {
typeElement = (TypeElement) element;
} else {
typeElement = (TypeElement) element.getEnclosingElement();
}
Set<Modifier> modifiers = typeElement.getModifiers();
if (modifiers.contains(Modifier.FINAL)) {
throw new IllegalArgumentException(typeElement.getQualifiedName() + " must be not final class");
}
if (!modifiers.contains(Modifier.PUBLIC)) {
throw new IllegalArgumentException(typeElement.getQualifiedName() + " must be public class");
}
if (typeElement.getKind() == ElementKind.INTERFACE) {
throw new IllegalArgumentException(typeElement.getQualifiedName() + " must be class not interface");
}
if (typeElement.getSimpleName().equals(typeElement.getQualifiedName())) {
throw new IllegalArgumentException(typeElement.getQualifiedName() + " must be have package");
}
for (Element field : elementUtils.getAllMembers(typeElement)) {
if (field.getModifiers().contains(Modifier.ABSTRACT) && field.getKind() == ElementKind.METHOD) {
throw new IllegalArgumentException(typeElement.getQualifiedName() + " must don't have abstract method , but find " + field.toString());
}
}
//create class which named WXEntryActivity
TypeSpec WXEntryActivity = TypeSpec.classBuilder(typeElement.getSimpleName().toString())
.addModifiers(Modifier.PUBLIC)
.superclass(ParameterizedTypeName.get(typeElement.asType())) //set superclass
.build();
//create file
JavaFile javaFile = JavaFile.builder(packageName, WXEntryActivity)
.build();
try {
//write to file
javaFile.writeTo(processingEnv.getFiler());
} catch (IOException e) {
e.printStackTrace();
}
}
return true;
} else {
return false;
}
}
public synchronized void init(ProcessingEnvironment processingEnv) {
super.init(processingEnv);
this.elementUtils = processingEnv.getElementUtils();
this.processingEnv = processingEnv;
}
}
CustomPackageProcessor 注解器如何在指定位置生成 一個(gè)空白 WXEntryActivity 并繼承步驟1的 WXEntryActivity ？
1.注冊(cè)注解器
在 complier 模塊下的 main 目錄下生成 resource/META-INF/service，并在 service 文件下創(chuàng)建一個(gè) File,內(nèi)容為注解器的路徑加注解器名稱，如：
com.amazing.wechat_compiler.CustomPackageProcessor
2.在注解器上添加@SupportedAnnotationTypes注解，指定支持的注解，有點(diǎn)繞的感覺，意思就是這個(gè)注解器可以為哪些注解工作的意思
@SupportedAnnotationTypes("com.amazing.wechat_annotation.CustomPackage")
public class CustomPackageProcessor extends AbstractProcessor {
@SupportedAnnotationTypes 接收拜支持注解的全路徑
需要注意的是：設(shè)置了上面兩個(gè)步驟之后注解器才能在編譯期進(jìn)行工作
整個(gè)項(xiàng)目的目錄結(jié)構(gòu)是這樣的：
兩個(gè) java 模塊，分別是 annotation 和 complier，complier 依賴 annotation； 一個(gè)Android主模塊，該模塊的 gradle 配置
dependencies {
...
implementation 'com.tencent.mm.opensdk:wechat-sdk-android-with-mta:5.4.0'
implementation project(':annotation')
annotationProcessor project(':compiler')
}
項(xiàng)目的setting.gradle配置
include ':app'
include ':annotation'
include ':compiler'
注解器的核心方法是：
public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {}
編譯期在該方法拿到應(yīng)用中所有 @CustomPackage 注解過(guò)的類：
Set<? extends Element> elememts = roundEnvironment.getElementsAnnotatedWith(CustomPackage.class);
通過(guò)獲取到的類提取 @CustomPackage 注解的屬性 packageName 作為包名，并通過(guò) javapoet 生成 WXEntryActivity ：
//create class which named WXEntryActivity
TypeSpec WXEntryActivity = TypeSpec.classBuilder(typeElement.getSimpleName().toString())
.addModifiers(Modifier.PUBLIC)
.superclass(ParameterizedTypeName.get(typeElement.asType())) //set superclass
.build();
//create file
JavaFile javaFile = JavaFile.builder(packageName, WXEntryActivity)
.build();
try {
//write to file
javaFile.writeTo(processingEnv.getFiler());
} catch (IOException e) {
e.printStackTrace();
}
javapoet 的使用可以查閱其 github 地址： https://github.com/square/javapoet
