【Android】註解框架(四) 一行程式碼注入微信支付

指間沙似流年發表於2017-12-23

目錄

  1. 【Android】註解框架(一)-- 基礎知識Java 反射
  2. 【Android】註解框架(二)-- 基礎知識(Java註解)& 執行時註解框架
  3. 【Android】註解框架(三)-- 編譯時註解,手寫ButterKnife
  4. 【Android】註解框架(四)-- 一行程式碼注入微信支付

微信一般處理方式

通常情況下當我們接入微信的時候,微信會蛋疼的讓我們在我們的包下侵入式的新增wxapi包,在這個包下面處理支付的相關業務邏輯。

【Android】註解框架(四)   一行程式碼注入微信支付

這個樣子就非常蛋疼了,不談看著難受,就連我們自己的專案規則都被他給打亂了,那麼有什麼好的辦法來解決這個問題呢?

其實用我們上次學到的AnnotationProcessor就可以解決這個問題。

我們通過apt來自動生成包名.wxapi.WXPAYEntryActivity並讓這個檔案繼承我們自己寫的WXPayActivity,我們在WXPayActivity中來處理微信支付的邏輯,這樣WXPayActivity就可以寫在我們自己定義的模組下面了,不僅僅侷限於app,元件化的module中都可以寫,當我們需要接入的時候直接飲用module並直接自動生成包名.wxapi.WXPAYEntryActivity就可以了。

實現

首先我們看下架構圖,大概就是下面這個樣子:

【Android】註解框架(四)   一行程式碼注入微信支付

  1. 生成各個module

    app - 主專案
    wx_pay - android lib
    wx_annotaion - java lib
    wx_compiler - java lib
    複製程式碼
  2. wx_annotaion

    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.CLASS)
    public @interface WXPayEntry {
    
        // 包名
        String packageName();
    
        // 類名
        Class<?> entryClass();
    }
    複製程式碼
  3. wx_pay

    這邊寫我們自己的微信支付相關的程式碼

    public class WXPayActivity extends AppCompatActivity implements IWXAPIEventHandler {
        @Override
        public void onReq(BaseReq baseReq) {
    
        }
    
        @Override
        public void onResp(BaseResp baseResp) {
    
        }
    }
    複製程式碼
  4. wx_compiler

    java api : http://www.yq1012.com/api/index.html-overview-summary.html

    visitor不懂的自定檢視:javax.lang.model.util.SimpleAnnotationValueVisitor6

    // WXEntryProcessor.class
    @AutoService(Processor.class)
    public class WXEntryProcessor extends AbstractProcessor {
    
        private Filer filer;
    
        @Override
        public synchronized void init(ProcessingEnvironment processingEnvironment) {
            super.init(processingEnvironment);
            filer = processingEnvironment.getFiler();
        }
    
        @Override
        public Set<String> getSupportedAnnotationTypes() {
            Set<String> types = new LinkedHashSet<>();
            Set<Class<? extends Annotation>> supportedAnnotations = getSupportedAnnotations();
            for (Class<? extends Annotation> supportedAnnotation : supportedAnnotations) {
                types.add(supportedAnnotation.getCanonicalName());
            }
            return types;
        }
    
        private Set<Class<? extends Annotation>> getSupportedAnnotations() {
            Set<Class<? extends Annotation>> annotations = new LinkedHashSet<>();
            annotations.add(WXPayEntry.class);
            return annotations;
        }
    
        @Override
        public SourceVersion getSupportedSourceVersion() {
            return SourceVersion.latestSupported();
        }
    
        @Override
        public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
            generateWXPayCode(roundEnvironment);
    
            return false;
        }
    
        private void generateWXPayCode(RoundEnvironment roundEnvironment) {
            WXPayEntryVisitor visitor = new WXPayEntryVisitor();
            visitor.setFiler(filer);
            scan(visitor, roundEnvironment, WXPayEntry.class);
        }
    
        private void scan(WXPayEntryVisitor visitor,
                          RoundEnvironment roundEnvironment,
                          Class<? extends Annotation> annotation) {
    
            Set<? extends Element> elementsAnnotatedWith = roundEnvironment.getElementsAnnotatedWith(annotation);
            for (Element element : elementsAnnotatedWith) {
                List<? extends AnnotationMirror> annotationMirrors = element.getAnnotationMirrors();
                for (AnnotationMirror annotationMirror : annotationMirrors) {
                    Map<? extends ExecutableElement, ? extends AnnotationValue>
                            elementValues = annotationMirror.getElementValues();
    
                    for (Map.Entry<? extends ExecutableElement, ? extends AnnotationValue> entry : elementValues.entrySet()) {
                        entry.getValue().accept(visitor, null);
                    }
                }
            }
    
        }
    }
    
    // WXPayEntryVisitor
    public class WXPayEntryVisitor extends SimpleAnnotationValueVisitor7<Void, Void> {
    
        private String packageName;
        private TypeMirror typeMirror;
        private Filer filer;
    
        public WXPayEntryVisitor setFiler(Filer filer) {
            this.filer = filer;
            return this;
        }
    
        @Override
        public Void visitString(String s, Void aVoid) {
            this.packageName = s;
            return aVoid;
        }
    
        @Override
        public Void visitType(TypeMirror typeMirror, Void aVoid) {
            this.typeMirror = typeMirror;
            generateWXPayCode();
            return aVoid;
        }
    
        private void generateWXPayCode() {
            // Class xxx.wxapi.WXPayEntryActivity extends WXPayActivity
            TypeSpec.Builder classSpecBuilder = TypeSpec.classBuilder("WXPayEntryActivity")
                    .addModifiers(Modifier.PUBLIC, Modifier.FINAL)
                    .superclass(TypeName.get(typeMirror));
    
            try {
                JavaFile.builder(packageName + ".wxpai", classSpecBuilder.build())
                        .build().writeTo(filer);
            } catch (IOException e) {
                e.printStackTrace();
                System.out.println(e);
            }
        }
    }
    複製程式碼
  5. 使用

    在baseApplication中使用註解

    @WXPayEntry(packageName = "com.fastaoe.wxannotationprocessordemo", 
        entryClass = WXPayActivity.class)
    public class BaseApplication extends Application {
    }
    複製程式碼

    此時重新build我們的工程就生成了符合要求的WXPayEntryActivity

    【Android】註解框架(四)   一行程式碼注入微信支付

相關文章