add logger

lemon · lemon · commit f48114c8821f · 2018-04-20T10:16:43.000+08:00
diff --git a/README.md b/README.md
@@ -4,6 +4,8 @@
 
 # UPDATES
 
+* 2017/04/20 add Logger that will log the important information which is helpful for debug
+
 * 2017/04/09 adding the retry mechanism of injecting bridge
 
 * 2017/04/08  invoke Java synchornized from Javascript is now enable in `feature/sync`
@@ -125,7 +127,7 @@ You can set your policy according to the current page's url and the parameters y
 
 **因为JavaScript是单线程的，所以我们能确保同一个页面不会出现重复注入bridge的情况**
 
-####  使用apt技术注册handler
+#### ✔️ 使用apt技术注册handler
 
 支持使用apt技术，完成注册handler的功能，步骤如下：
 
diff --git a/app/src/main/java/tech/easily/easybridge/MainActivity.kt b/app/src/main/java/tech/easily/easybridge/MainActivity.kt
@@ -33,6 +33,7 @@ class MainActivity : AppCompatActivity() {
             })
         }
         EBHandlerManager.register(webView)
+        webView.setDebuggable(BuildConfig.DEBUG)
         webView.webViewClient = object : WebViewClient() {
             override fun shouldOverrideUrlLoading(view: WebView?, url: String?): Boolean {
                 return false
diff --git a/easybridge/src/main/java/tech/easily/easybridge/lib/EasyBridge.java b/easybridge/src/main/java/tech/easily/easybridge/lib/EasyBridge.java
@@ -54,6 +54,7 @@ final class EasyBridge {
      */
     @JavascriptInterface
     public void enqueue(String handlerName, String currentPageUrl, final String parameters, String callbackId) {
+        Logger.debug(String.format("receive call from JavaScript,[handlerName]:%s [currentPage]:%s [parameters]:%s [requestId]:%s", handlerName, currentPageUrl, parameters, callbackId));
         final Gson gson = new GsonBuilder().create();
         final ResultCallBack callBack = new ResultCallBack(callbackId) {
             @Override
@@ -62,22 +63,30 @@ public void onResult(Object result) {
             }
         };
         if (TextUtils.isEmpty(handlerName)) {
-            callBack.onResult(CallBackMessage.generateErrorMessage(CallBackMessage.CODE_INVALID_HANDLER, "the handlerName is not invalid"));
+            String errorMessage = "the [handlerName]:" + handlerName + " is not invalid";
+            callBack.onResult(CallBackMessage.generateErrorMessage(CallBackMessage.CODE_INVALID_HANDLER, errorMessage));
+            Logger.error(errorMessage);
             return;
         }
         final BridgeHandler handler = findTargetHandler(handlerName);
         if (handler == null) {
-            callBack.onResult(CallBackMessage.generateErrorMessage(CallBackMessage.CODE_NO_HANDLER, "handler with name " + handlerName + " is not registered in Java code"));
+            String errorMessage = "the [handlerName]:" + handlerName + " is not registered in Java code";
+            callBack.onResult(CallBackMessage.generateErrorMessage(CallBackMessage.CODE_NO_HANDLER, errorMessage));
+            Logger.error(errorMessage);
             return;
         }
         // global security check
         if (!checkGlobalSecurity(currentPageUrl, parameters)) {
-            callBack.onResult(CallBackMessage.generateErrorMessage(CODE_SECURITY_FORBIDDEN, "handler with name " + handlerName + " is not allowed to invoke in page:" + currentPageUrl + " by the global Security Checker"));
+            String errorMessage = "the [handlerName]:" + handlerName + " is not allowed to invoke in [page]:" + currentPageUrl + " by the global Security Checker,with [parameters]:" + parameters;
+            callBack.onResult(CallBackMessage.generateErrorMessage(CODE_SECURITY_FORBIDDEN, errorMessage));
+            Logger.error(errorMessage);
             return;
         }
         // handler security check
         if (handler.securityPolicyChecker() != null && !handler.securityPolicyChecker().check(currentPageUrl, parameters)) {
-            callBack.onResult(CallBackMessage.generateErrorMessage(CODE_SECURITY_FORBIDDEN, "handler with name " + handlerName + " is not allowed to invoke in page:" + currentPageUrl));
+            String errorMessage = "the [handlerName]:" + handlerName + " is not allowed to invoke in [page]:" + currentPageUrl + ",with [parameters]:" + parameters;
+            callBack.onResult(CallBackMessage.generateErrorMessage(CODE_SECURITY_FORBIDDEN, errorMessage));
+            Logger.error(errorMessage);
             return;
         }
         // invoke the handler in main thread
@@ -109,6 +118,7 @@ public void run() {
                     resultCallBack.onResult(result);
                 }
             });
+            Logger.debug(String.format("receive result from JavaScript,[callbackId]:%s [result]:%s", callbackId, result));
         }
     }
 
@@ -120,6 +130,7 @@ void callHandler(String handlerName, String parameters, ResultCallBack resultCal
         }
         String executeScript = String.format(EXECUTE_SCRIPT, bridgeName, handlerName, parameters, callbackId);
         executeScriptInMain(executeScript);
+        Logger.debug(String.format("call JavaScript in Java,[handlerName]:%s [parameters]:%s [requestId]:%s", handlerName, parameters, callbackId));
     }
 
 
@@ -136,6 +147,7 @@ private void dispatchResult(String callbackId, String parameters) {
         }
         final String callBackScript = String.format(CALLBACK_FUNCTION, bridgeName, callbackId, parameters);
         executeScriptInMain(callBackScript);
+        Logger.debug(String.format("dispatchResult to JavaScript,[callbackId]:%s [result]:%s", callbackId, parameters));
     }
 
     private void executeScriptInMain(final String script) {
diff --git a/easybridge/src/main/java/tech/easily/easybridge/lib/EasyBridgeWebChromeClient.java b/easybridge/src/main/java/tech/easily/easybridge/lib/EasyBridgeWebChromeClient.java
@@ -45,6 +45,7 @@ public void onProgressChanged(WebView view, int newProgress) {
             }
             // TODO: 2018/4/3 it seems that the url received here possibly not the same as the real page url we look forward to
             if (easyBridgeWebView.checkSecurityGlobally(view.getUrl(), SECURITY_CHECK_PARAMETERS)) {
+                Logger.debug("start to inject bridge at [page]:" + view.getUrl() + " [currentLoadingProgress]:" + newProgress);
                 injectBridgeTask.start();
             } else {
                 deleteBridge();
@@ -63,6 +64,9 @@ private void injectBridge() {
         easyBridgeWebView.evaluateJavascript(injectScript);
     }
 
+    private String getCurrentURL() {
+        return easyBridgeWebView == null ? "" : easyBridgeWebView.getUrl();
+    }
 
     private boolean isInjected() {
         return easyBridgeWebView != null && easyBridgeWebView.isInjected();
@@ -100,6 +104,9 @@ private static class InjectBridgeTask implements Runnable {
         @Override
         public void run() {
             if (!webChromeClient.isInjected() && retryCount <= RETRY_COUNT) {
+                if (retryCount > 0) {
+                    Logger.debug("retry to inject bridge at [page]:+" + webChromeClient.getCurrentURL() + ",retry time:" + retryCount);
+                }
                 webChromeClient.injectBridge();
                 retryCount++;
                 mainHandler.postDelayed(this, RETRY_DELAY_INTERVAL);
diff --git a/easybridge/src/main/java/tech/easily/easybridge/lib/EasyBridgeWebView.java b/easybridge/src/main/java/tech/easily/easybridge/lib/EasyBridgeWebView.java
@@ -76,6 +76,7 @@ private void initWebView() {
         registerHandler(new BaseBridgeHandler(REGISTER_INJECT_FINISHED, this) {
             @Override
             public void onCall(String parameters, ResultCallBack callBack) {
+                Logger.debug("inject bridge success in page:" + getUrl());
                 setInjected(true);
             }
         });
@@ -139,6 +140,11 @@ public void setPolicyChecker(SecurityPolicyChecker policyChecker) {
         this.policyChecker = policyChecker;
     }
 
+    public EasyBridgeWebView setDebuggable(boolean debuggable) {
+        Logger.setDebuggable(debuggable);
+        return this;
+    }
+
     public void evaluateJavascript(String script) {
         evaluateJavascript(script, new ValueCallback<String>() {
             @Override
diff --git a/easybridge/src/main/java/tech/easily/easybridge/lib/Logger.java b/easybridge/src/main/java/tech/easily/easybridge/lib/Logger.java
@@ -0,0 +1,30 @@
+package tech.easily.easybridge.lib;
+
+import android.util.Log;
+
+/**
+ * Created by hzyangjiehao on 2018/4/20.
+ */
+final class Logger {
+
+    static boolean debuggable;
+    private static final String TAG = "EasyBridge";
+
+    public static void setDebuggable(boolean debuggable) {
+        Logger.debuggable = debuggable;
+    }
+
+    static void debug(String message) {
+        if (!debuggable) {
+            return;
+        }
+        Log.d(TAG, message);
+    }
+
+    static void error(String message) {
+        if (!debuggable) {
+            return;
+        }
+        Log.e(TAG, message);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@ class MainActivity : AppCompatActivity() {`
`33`	`33`	`})`
`34`	`34`	`}`
`35`	`35`	`EBHandlerManager.register(webView)`
	`36`	`+ webView.setDebuggable(BuildConfig.DEBUG)`
`36`	`37`	`webView.webViewClient = object : WebViewClient() {`
`37`	`38`	`override fun shouldOverrideUrlLoading(view: WebView?, url: String?): Boolean {`
`38`	`39`	`return false`
Original file line number	Diff line number	Diff line change
`@@ -54,6 +54,7 @@ final class EasyBridge {`
`54`	`54`	`*/`
`55`	`55`	`@JavascriptInterface`
`56`	`56`	`public void enqueue(String handlerName, String currentPageUrl, final String parameters, String callbackId) {`
	`57`	`+ Logger.debug(String.format("receive call from JavaScript,[handlerName]:%s [currentPage]:%s [parameters]:%s [requestId]:%s", handlerName, currentPageUrl, parameters, callbackId));`
`57`	`58`	`final Gson gson = new GsonBuilder().create();`
`58`	`59`	`final ResultCallBack callBack = new ResultCallBack(callbackId) {`
`59`	`60`	`@Override`
`@@ -62,22 +63,30 @@ public void onResult(Object result) {`
`62`	`63`	`}`
`63`	`64`	`};`
`64`	`65`	`if (TextUtils.isEmpty(handlerName)) {`
`65`		`- callBack.onResult(CallBackMessage.generateErrorMessage(CallBackMessage.CODE_INVALID_HANDLER, "the handlerName is not invalid"));`
	`66`	`+ String errorMessage = "the [handlerName]:" + handlerName + " is not invalid";`
	`67`	`+ callBack.onResult(CallBackMessage.generateErrorMessage(CallBackMessage.CODE_INVALID_HANDLER, errorMessage));`
	`68`	`+ Logger.error(errorMessage);`
`66`	`69`	`return;`
`67`	`70`	`}`
`68`	`71`	`final BridgeHandler handler = findTargetHandler(handlerName);`
`69`	`72`	`if (handler == null) {`
`70`		`- callBack.onResult(CallBackMessage.generateErrorMessage(CallBackMessage.CODE_NO_HANDLER, "handler with name " + handlerName + " is not registered in Java code"));`
	`73`	`+ String errorMessage = "the [handlerName]:" + handlerName + " is not registered in Java code";`
	`74`	`+ callBack.onResult(CallBackMessage.generateErrorMessage(CallBackMessage.CODE_NO_HANDLER, errorMessage));`
	`75`	`+ Logger.error(errorMessage);`
`71`	`76`	`return;`
`72`	`77`	`}`
`73`	`78`	`// global security check`
`74`	`79`	`if (!checkGlobalSecurity(currentPageUrl, parameters)) {`
`75`		`- callBack.onResult(CallBackMessage.generateErrorMessage(CODE_SECURITY_FORBIDDEN, "handler with name " + handlerName + " is not allowed to invoke in page:" + currentPageUrl + " by the global Security Checker"));`
	`80`	`+ String errorMessage = "the [handlerName]:" + handlerName + " is not allowed to invoke in [page]:" + currentPageUrl + " by the global Security Checker,with [parameters]:" + parameters;`
	`81`	`+ callBack.onResult(CallBackMessage.generateErrorMessage(CODE_SECURITY_FORBIDDEN, errorMessage));`
	`82`	`+ Logger.error(errorMessage);`
`76`	`83`	`return;`
`77`	`84`	`}`
`78`	`85`	`// handler security check`
`79`	`86`	`if (handler.securityPolicyChecker() != null && !handler.securityPolicyChecker().check(currentPageUrl, parameters)) {`
`80`		`- callBack.onResult(CallBackMessage.generateErrorMessage(CODE_SECURITY_FORBIDDEN, "handler with name " + handlerName + " is not allowed to invoke in page:" + currentPageUrl));`
	`87`	`+ String errorMessage = "the [handlerName]:" + handlerName + " is not allowed to invoke in [page]:" + currentPageUrl + ",with [parameters]:" + parameters;`
	`88`	`+ callBack.onResult(CallBackMessage.generateErrorMessage(CODE_SECURITY_FORBIDDEN, errorMessage));`
	`89`	`+ Logger.error(errorMessage);`
`81`	`90`	`return;`
`82`	`91`	`}`
`83`	`92`	`// invoke the handler in main thread`
`@@ -109,6 +118,7 @@ public void run() {`
`109`	`118`	`resultCallBack.onResult(result);`
`110`	`119`	`}`
`111`	`120`	`});`
	`121`	`+ Logger.debug(String.format("receive result from JavaScript,[callbackId]:%s [result]:%s", callbackId, result));`
`112`	`122`	`}`
`113`	`123`	`}`
`114`	`124`
`@@ -120,6 +130,7 @@ void callHandler(String handlerName, String parameters, ResultCallBack resultCal`
`120`	`130`	`}`
`121`	`131`	`String executeScript = String.format(EXECUTE_SCRIPT, bridgeName, handlerName, parameters, callbackId);`
`122`	`132`	`executeScriptInMain(executeScript);`
	`133`	`+ Logger.debug(String.format("call JavaScript in Java,[handlerName]:%s [parameters]:%s [requestId]:%s", handlerName, parameters, callbackId));`
`123`	`134`	`}`
`124`	`135`
`125`	`136`
`@@ -136,6 +147,7 @@ private void dispatchResult(String callbackId, String parameters) {`
`136`	`147`	`}`
`137`	`148`	`final String callBackScript = String.format(CALLBACK_FUNCTION, bridgeName, callbackId, parameters);`
`138`	`149`	`executeScriptInMain(callBackScript);`
	`150`	`+ Logger.debug(String.format("dispatchResult to JavaScript,[callbackId]:%s [result]:%s", callbackId, parameters));`
`139`	`151`	`}`
`140`	`152`
`141`	`153`	`private void executeScriptInMain(final String script) {`