加入apt注解处理器注册handle的功能

lemon · lemon · commit 2caede246e44 · 2018-04-04T10:20:32.000+08:00
diff --git a/.idea/caches/build_file_checksums.ser b/.idea/caches/build_file_checksums.ser
diff --git a/.idea/gradle.xml b/.idea/gradle.xml
diff --git a/README.md b/README.md
@@ -1,5 +1,24 @@
 # FEATURE
 
+#### :heavy_check_mark: 使用apt技术注册handler
+
+支持使用apt技术，完成注册handler的功能，步骤如下：
+
+1. 添加下面的依赖
+
+   ```Gradle
+   implementation project(':easybridge-annotation')
+   kapt project(':easybridge-processor') // in kotlin
+   ```
+
+2. 使用注解`@EasyBridgeHandler`
+
+3. 项目编译之后会生成工具类`EBHandlerManager`
+
+4. 在页面初始化webview的时候，调用步骤三得到的`EBHandlerManager`的静态方法`register(webview)`
+
+**目前仅支持构造`BaseBridgeHandler` 的子类实例（具体与之一致的构造方法），后续会对这一点改进，使其适应具备不同构造方法对handler实例**
+
 #### :heavy_check_mark: JavaScript调用Java功能
 
 **支持同步和异步两种方式的调用（目前仅开放异步调用，但实现原理本身支持同步调用）**
diff --git a/app/build.gradle b/app/build.gradle
@@ -4,6 +4,8 @@ apply plugin: 'kotlin-android'
 
 apply plugin: 'kotlin-android-extensions'
 
+apply plugin: 'kotlin-kapt'
+
 android {
     compileSdkVersion 27
     defaultConfig {
@@ -31,4 +33,6 @@ dependencies {
     androidTestImplementation 'com.android.support.test:runner:1.0.1'
     androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.1'
     implementation project(':easybridge')
+    implementation project(':easybridge-annotation')
+    kapt project(':easybridge-processor')
 }
diff --git a/app/src/main/java/easily/tech/easybridge/MainActivity.kt b/app/src/main/java/easily/tech/easybridge/MainActivity.kt
@@ -6,7 +6,7 @@ import android.support.v7.app.AppCompatActivity
 import android.os.Bundle
 import android.webkit.*
 import android.widget.Toast
-import easily.tech.easybridge.handler.ToastHandler
+import easily.tech.easybridge.lib.EBHandlerManager
 import easily.tech.easybridge.lib.EasyBridgeWebChromeClient
 import easily.tech.easybridge.lib.ResultCallBack
 import kotlinx.android.synthetic.main.activity_main.*
@@ -19,6 +19,13 @@ class MainActivity : AppCompatActivity() {
             WebView.setWebContentsDebuggingEnabled(true)
         }
         setContentView(R.layout.activity_main)
+        init()
+        webView.loadUrl("file:///android_asset/demo.html")
+
+    }
+
+    private fun init() {
+        EBHandlerManager.register(webView)
         webView.webViewClient = object : WebViewClient() {
             override fun shouldOverrideUrlLoading(view: WebView?, url: String?): Boolean {
                 return false
@@ -37,10 +44,6 @@ class MainActivity : AppCompatActivity() {
                 else -> true
             }
         }))
-
-        webView.registerHandler(ToastHandler(this))
-
-        webView.loadUrl("file:///android_asset/demo.html")
         // call JavaScript From Java
         webView.postDelayed({
             webView.callHandler("resultBack", "this is the value pass from Java", object : ResultCallBack() {
diff --git a/app/src/main/java/easily/tech/easybridge/handler/ToastHandler.kt b/app/src/main/java/easily/tech/easybridge/handler/ToastHandler.kt
@@ -1,18 +1,18 @@
 package easily.tech.easybridge.handler
 
-import android.content.Context
-import android.util.Log
 import android.widget.Toast
+import easily.tech.easybridge.annotation.EasyBridgeHandler
+import easily.tech.easybridge.lib.EasyBridgeWebView
 import easily.tech.easybridge.lib.ResultCallBack
 import easily.tech.easybridge.lib.handler.BaseBridgeHandler
 
 /**
  * Created by lemon on 30/03/2018.
  */
-class ToastHandler(private val context: Context) : BaseBridgeHandler("toast") {
+@EasyBridgeHandler(name = "toast")
+class ToastHandler(handlerName:String,webView: EasyBridgeWebView) : BaseBridgeHandler(handlerName,webView) {
     override fun onCall(parameters: String?, callBack: ResultCallBack?) {
-        Log.d("Toast",parameters)
-        Toast.makeText(context, parameters, Toast.LENGTH_SHORT).show()
+        Toast.makeText(webView.context, parameters, Toast.LENGTH_SHORT).show()
         callBack?.onResult(null)
     }
 }
diff --git a/easybridge-annotation/.gitignore b/easybridge-annotation/.gitignore
@@ -0,0 +1 @@
+/build
diff --git a/easybridge-annotation/build.gradle b/easybridge-annotation/build.gradle
@@ -0,0 +1,8 @@
+apply plugin: 'java-library'
+
+dependencies {
+    implementation fileTree(include: ['*.jar'], dir: 'libs')
+}
+
+sourceCompatibility = "1.7"
+targetCompatibility = "1.7"
diff --git a/easybridge-annotation/src/main/java/easily/tech/easybridge/annotation/EasyBridgeHandler.java b/easybridge-annotation/src/main/java/easily/tech/easybridge/annotation/EasyBridgeHandler.java
@@ -0,0 +1,15 @@
+package easily.tech.easybridge.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.SOURCE)
+public @interface EasyBridgeHandler {
+
+    // TODO: 2018/4/4 maybe we should collect the info about the constructor,for building all the instance with different constructor
+
+    String name() default "";
+}
diff --git a/easybridge-processor/.gitignore b/easybridge-processor/.gitignore
@@ -0,0 +1 @@
+/build
diff --git a/easybridge-processor/build.gradle b/easybridge-processor/build.gradle
@@ -0,0 +1,11 @@
+apply plugin: 'java-library'
+
+dependencies {
+    implementation fileTree(include: ['*.jar'], dir: 'libs')
+    implementation 'com.squareup:javapoet:1.9.0'
+    implementation 'com.google.auto.service:auto-service:1.0-rc3'
+    implementation project(':easybridge-annotation')
+}
+
+sourceCompatibility = "1.7"
+targetCompatibility = "1.7"
diff --git a/easybridge-processor/src/main/java/easily/tech/easybridge/processor/BridgeHandlerModel.java b/easybridge-processor/src/main/java/easily/tech/easybridge/processor/BridgeHandlerModel.java
@@ -0,0 +1,16 @@
+package easily.tech.easybridge.processor;
+
+/**
+ * Created by lemon on 04/04/2018.
+ */
+
+final class BridgeHandlerModel {
+    String handlerName;
+    // the class name of the handler,using it to construct an instance
+    String className;
+
+    BridgeHandlerModel(String handlerName, String className) {
+        this.handlerName = handlerName;
+        this.className = className;
+    }
+}
diff --git a/easybridge-processor/src/main/java/easily/tech/easybridge/processor/EBHandlerManagerGenerator.java b/easybridge-processor/src/main/java/easily/tech/easybridge/processor/EBHandlerManagerGenerator.java
@@ -0,0 +1,66 @@
+package easily.tech.easybridge.processor;
+
+import com.squareup.javapoet.ClassName;
+import com.squareup.javapoet.FieldSpec;
+import com.squareup.javapoet.JavaFile;
+import com.squareup.javapoet.MethodSpec;
+import com.squareup.javapoet.ParameterizedTypeName;
+import com.squareup.javapoet.TypeName;
+import com.squareup.javapoet.TypeSpec;
+
+import java.util.HashMap;
+import java.util.List;
+
+import static com.squareup.javapoet.MethodSpec.methodBuilder;
+import static com.squareup.javapoet.TypeSpec.classBuilder;
+import static javax.lang.model.element.Modifier.FINAL;
+import static javax.lang.model.element.Modifier.PUBLIC;
+import static javax.lang.model.element.Modifier.STATIC;
+
+/**
+ * Created by lemon on 04/04/2018.
+ */
+
+public class EBHandlerManagerGenerator {
+
+    private static final String CLASS_NAME = "EBHandlerManager";
+    private static final String PACKAGE_NAME = "easily.tech.easybridge.lib";
+    private static final String REGISTER_METHOD_NAME = "register";
+    private static final String WEB_VIEW_PARAMETER = "webview";
+    private static final String BRIDGE_WEB_VIEW_CLASS = PACKAGE_NAME + ".EasyBridgeWebView";
+
+    public static JavaFile brewJava(List<BridgeHandlerModel> handlerModelList) {
+
+        TypeSpec.Builder typeBuilder = classBuilder(CLASS_NAME).addModifiers(PUBLIC, FINAL);
+
+        ClassName bridgeWebView = ClassName.bestGuess(BRIDGE_WEB_VIEW_CLASS);
+
+
+        MethodSpec.Builder registerMethodBuilder = methodBuilder(REGISTER_METHOD_NAME)
+                .addModifiers(PUBLIC, STATIC)
+                .addParameter(bridgeWebView, WEB_VIEW_PARAMETER)
+                .returns(TypeName.VOID);
+
+        registerMethodBuilder.addCode("\n");
+        if (handlerModelList != null && !handlerModelList.isEmpty()) {
+            for (BridgeHandlerModel model : handlerModelList) {
+                if (model == null) {
+                    continue;
+                }
+                ClassName handlerClass = ClassName.bestGuess(model.className);
+                String tempName = model.handlerName + "Handler";
+                registerMethodBuilder.addStatement("$T $L = new $T($S,$L)", handlerClass, tempName, handlerClass, model.handlerName, WEB_VIEW_PARAMETER);
+                registerMethodBuilder.addStatement("$L.registerHandler($L)", WEB_VIEW_PARAMETER, tempName);
+                registerMethodBuilder.addCode("\n");
+            }
+        }
+
+        typeBuilder.addJavadoc("using {@link #register(BridgeWebView)}to register the instance of BridgeHandler when init the webview of the page\n");
+
+        typeBuilder.addMethod(registerMethodBuilder.build());
+
+        return JavaFile.builder(PACKAGE_NAME, typeBuilder.build())
+                .addFileComment("Generated code from EBHandlerManagerGenerator. Do not modify!")
+                .build();
+    }
+}
diff --git a/easybridge-processor/src/main/java/easily/tech/easybridge/processor/EasyBridgeProcessor.java b/easybridge-processor/src/main/java/easily/tech/easybridge/processor/EasyBridgeProcessor.java
@@ -0,0 +1,53 @@
+package easily.tech.easybridge.processor;
+
+import com.google.auto.service.AutoService;
+import com.squareup.javapoet.JavaFile;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Set;
+
+import javax.annotation.processing.AbstractProcessor;
+import javax.annotation.processing.Filer;
+import javax.annotation.processing.ProcessingEnvironment;
+import javax.annotation.processing.Processor;
+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.Element;
+import javax.lang.model.element.TypeElement;
+
+import easily.tech.easybridge.annotation.EasyBridgeHandler;
+
+@AutoService(Processor.class)
+@SupportedSourceVersion(SourceVersion.RELEASE_8)
+@SupportedAnnotationTypes({"easily.tech.easybridge.annotation.EasyBridgeHandler"})
+public class EasyBridgeProcessor extends AbstractProcessor {
+
+    private Filer filer;
+
+    @Override
+    public synchronized void init(ProcessingEnvironment processingEnv) {
+        super.init(processingEnv);
+        filer = processingEnv.getFiler();
+    }
+
+    @Override
+    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
+        List<BridgeHandlerModel> handlerModelList = new ArrayList<>();
+        for (Element annotatedElement : roundEnvironment.getElementsAnnotatedWith(EasyBridgeHandler.class)) {
+            TypeElement annotatedClass = (TypeElement) annotatedElement;
+            EasyBridgeHandler jsHandler = annotatedElement.getAnnotation(EasyBridgeHandler.class);
+            handlerModelList.add(new BridgeHandlerModel(jsHandler.name(), annotatedClass.getQualifiedName().toString()));
+        }
+        JavaFile javaFile = EBHandlerManagerGenerator.brewJava(handlerModelList);
+        try {
+            javaFile.writeTo(filer);
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+        return false;
+    }
+}
diff --git a/easybridge/src/main/java/easily/tech/easybridge/lib/EasyBridge.java b/easybridge/src/main/java/easily/tech/easybridge/lib/EasyBridge.java
@@ -207,6 +207,13 @@ void clear() {
         }
     }
 
+    Map<String, BridgeHandler> getRegisterHandlerMap() {
+        if (registerHandlerMap == null) {
+            return new HashMap<>();
+        }
+        return registerHandlerMap;
+    }
+
     void destroy() {
         if (registerHandlerMap != null) {
             registerHandlerMap.clear();
diff --git a/easybridge/src/main/java/easily/tech/easybridge/lib/EasyBridgeWebView.java b/easybridge/src/main/java/easily/tech/easybridge/lib/EasyBridgeWebView.java
@@ -7,17 +7,20 @@
 import android.webkit.WebSettings;
 import android.webkit.WebView;
 
+import java.util.HashMap;
+import java.util.Map;
+
 import easily.tech.easybridge.lib.handler.BridgeHandler;
 
 /**
  * this class is the main entrance of the library,you are supposed to do things as bellow:
  * 1. register handler that to be call by JavaScript:{@link #registerHandler(BridgeHandler)}
  * 2. set a global security checker:{@link #setPolicyChecker(SecurityPolicyChecker)}
- *    before inject a bridge,you will receive a check request with the parameters:{@link EasyBridgeWebChromeClient#SECURITY_CHECK_PARAMETERS},make your idea about it;
+ * before inject a bridge,you will receive a check request with the parameters:{@link EasyBridgeWebChromeClient#SECURITY_CHECK_PARAMETERS},make your idea about it;
  * 3. you can make a global security check by:{@link #checkSecurityGlobally(String, String)}
  * 4. you can call the JavaScript function with:{@link #callHandler(String, String, ResultCallBack)},
- *    but make sure before:you had register a JavaScript handler using the bridge,the code is like below:
- *    "window.easyBridge.registerHandler(handlerName,realFunction)"
+ * but make sure before:you had register a JavaScript handler using the bridge,the code is like below:
+ * "window.easyBridge.registerHandler(handlerName,realFunction)"
  * <p>
  * Created by lemon on 29/03/2018.
  */
@@ -78,6 +81,13 @@ public void callHandler(String handlerName, String parameters, ResultCallBack re
         }
     }
 
+    public Map<String, BridgeHandler> getAllRegisterHandlers() {
+        if (easyBridge == null) {
+            return new HashMap<>();
+        }
+        return easyBridge.getRegisterHandlerMap();
+    }
+
     public void clear() {
         if (easyBridge != null) {
             easyBridge.clear();
diff --git a/easybridge/src/main/java/easily/tech/easybridge/lib/handler/BaseBridgeHandler.java b/easybridge/src/main/java/easily/tech/easybridge/lib/handler/BaseBridgeHandler.java
@@ -2,6 +2,7 @@
 
 import android.support.annotation.NonNull;
 
+import easily.tech.easybridge.lib.EasyBridgeWebView;
 import easily.tech.easybridge.lib.SecurityPolicyChecker;
 
 /**
@@ -11,13 +12,15 @@ public abstract class BaseBridgeHandler implements BridgeHandler {
 
     protected String name;
     protected SecurityPolicyChecker checker;
+    protected EasyBridgeWebView webView;
 
-    public BaseBridgeHandler(String name) {
-        this(name, null);
+    public BaseBridgeHandler(String name, EasyBridgeWebView webView) {
+        this(name, webView, null);
     }
 
-    public BaseBridgeHandler(String name, SecurityPolicyChecker securityPolicyChecker) {
+    public BaseBridgeHandler(String name, EasyBridgeWebView webView, SecurityPolicyChecker securityPolicyChecker) {
         this.name = name;
+        this.webView = webView;
         this.checker = securityPolicyChecker;
     }
 
@@ -35,4 +38,8 @@ public SecurityPolicyChecker securityPolicyChecker() {
     public void setSecurityPolicyChecker(SecurityPolicyChecker securityPolicyChecker) {
         this.checker = securityPolicyChecker;
     }
+
+    public void destroy() {
+        webView = null;
+    }
 }
diff --git a/settings.gradle b/settings.gradle
@@ -1 +1 @@
-include ':app', ':easybridge'
+include ':app', ':easybridge', ':easybridge-annotation', ':easybridge-processor'
