【quickhybrid】Android端的項目實現

時間  2019-12-09
標籤 quickhybrid android 端的 項目 實現 欄目 Android 简体版
原文   原文鏈接

前言

前文中就有提到，Hybrid模式的核心就是在原生，而本文就以此項目的Android部分爲例介紹Android部分的實現。javascript

提示，因爲各類各樣的緣由，本項目中的Android容器確保核心交互以及部分重要API實現，關於底層容器優化等機制後續再考慮完善。html

大體內容以下：前端

  • JSBridge核心交互部分java

  • ui、page、navigator等部分經常使用API的實現android

  • 組件（自定義）API拓展的實現git

  • 容器h5支撐的部分完善（如支持fileinput文件選擇，地理定位等-默認不生效的）github

  • API的權限校驗僅預留了一個入口，模擬最簡單的實現web

  • 其它如離線資源加載更新，底層優化等機制暫時不提供chrome

項目的結構

基於AndroidStudio的項目，爲了便於管理，稍微分紅了幾個模塊，
並且因爲主要精力已經偏移到了JS前端，已經不想再花大力氣重構Android代碼了，
所以僅僅是將代碼從業務中抽取出來，留下了一些稍微精簡的代碼（也不是特別精簡）。api

因此若是發現代碼風格，規範等不太合適，請先將就着。

總體目錄結構以下：

quickhybrid-android
    |- app                  // application，應用主程序
    |   |- api/PayApi       // 拓展了一個組件API
    |   |- MainActivity     // 入口頁面
    |- core                 // library，核心工具類模塊，放一些通用工具類
    |   |- baseapp
    |   |- net
    |   |- ui
    |   |- util
    |- jsbridge             // library，JSBridge模塊，混合開發的核心實現
    |   |- api
    |   |- bean
    |   |- bridge
    |   |- control
    |   |- view

代碼架構

簡單的三次架構：底層核心工具類->JSBridge橋接實現->app應用實現

core
    |- application                  // 應用流程控制，Activity管理，崩潰日誌等
    |- baseapp                      // 一些基礎Activity，Fragment的定義
    |- net                          // 網絡請求相關
    |- ui                           // 一些UI效果的定義與實現
    |- util                         // 通用工具類
    
jsbridge
    |- api                          // 定義API，開放原生功能給H5
    |- bean                         // 放一些實體類
    |- bridge                       // 橋接的定義以及核心實現
    |- control                      // 控制類，包括回調控制，頁面加載控制，文件選擇控制等
    |- view                         // 定義混合開發須要的webview和fragment實現
    
app
    |- api                          // 拓展項目須要的自定義組件API
    |- AppApplication.java          // 應用的控制
    |- MainActivity.java            // 入口界面的控制

權限配置

原生應用中，不可逃避的就是打包後的權限問題，沒有權限，不少功能都使用不了，
簡單起見，這裏將應用中用的權限都列了出來（基於多種考慮，並無遵循最小原則）

<!-- ===============================權限配置聲明=============================== -->
    <uses-permission android:name="android.permission.READ_PHONE_STATE" />
    <uses-permission android:name="android.permission.CAMERA" />
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
    <uses-permission android:name="android.permission.CALL_PHONE" />
    <uses-permission android:name="android.permission.READ_CALL_LOG" />
    <uses-permission android:name="android.permission.SEND_SMS" />
    <uses-permission android:name="android.permission.VIBRATE" />
    <uses-permission android:name="android.permission.READ_LOGS" />
    <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS" />
    <uses-permission android:name="android.permission.WAKE_LOCK" />
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
    <uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.WRITE_SETTINGS" />
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
    <uses-permission android:name="android.permission.RECORD_AUDIO" />
    <uses-permission android:name="android.permission.READ_OWNER_DATA" />
    <uses-permission android:name="android.permission.READ_CONTACTS" />
    <uses-permission android:name="android.permission.WRITE_CONTACTS" />
    <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
    <uses-permission android:name="android.permission.DISABLE_KEYGUARD" />
    <uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />
    <uses-permission android:name="com.android.launcher.permission.READ_SETTINGS" />
    <uses-permission android:name="android.permission.GET_ACCOUNTS" />
    <uses-permission android:name="android.permission.READ_PROFILE" />

注意，6.0之上須要動態權限，請確保已經給應用開了對應的權限

Gradle配置

AndroidStudio中項目要正確運行起來，須要有一個正確的Gradle配置。

這裏也就幾個關鍵性的配置做說明，其他的能夠參考源碼

gradle-wrapper.properties

distributionUrl=https\://services.gradle.org/distributions/gradle-4.2.1-all.zip

若是遇到gradle編譯不動，能夠像上述同樣，把這個文件的gradle版本修改成本地用的版本
（不然的話，沒有***就頗有可能卡住）

setting.gradle

include ':app', ':jsbridge', ':core'

裏面很簡單，就是一行代碼，將三個用到的模塊都引用進來

build.gradle（core）

僅挑選了部分進行說明

apply plugin: 'com.android.library'

android {
    compileSdkVersion 25

    defaultConfig {
        minSdkVersion 16
        targetSdkVersion 22
        versionCode 1
        versionName "1.0"
        ...
    }
    ...
}

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])

    compile 'com.android.support:appcompat-v7:25.3.1'
    compile 'com.android.support:support-v4:25.3.1'
    compile 'com.android.support:design:25.3.1'
    compile 'com.android.support:recyclerview-v7:25.3.1'
    compile 'com.android.support.constraint:constraint-layout:1.0.2'
    compile 'com.jakewharton:butterknife:8.6.0'
    compile 'com.google.code.gson:gson:2.8.0'
    compile 'com.journeyapps:zxing-android-embedded:3.5.0'
    compile 'com.liulishuo.filedownloader:library:1.5.5'
    compile 'com.nostra13.universalimageloader:universal-image-loader:1.9.5'
    compile 'me.iwf.photopicker:PhotoPicker:0.9.10@aar'
    compile 'com.github.bumptech.glide:glide:4.1.1'
    ...
}

上述的關鍵信息有幾點：

  • apply plugin: 'com.android.library'表明是模塊而不是主應用

  • minSdkVersion 16表明最低兼容4.1的版本

  • targetSdkVersion 25是編譯版本，targetSdkVersion 22提供向前兼容的做用，22時不須要動態權限，
    主要做用是某些API在不一樣版本中使用不同，或者根本就在低版本中沒有。

  • versionName和versionCode進行版本控制

  • dependencies中是依賴信息，首先compile fileTree添加了libs下的全部離線依賴（裏面有離線依賴包），
    而後compile一些必須的依賴（譬如用到了gson，自動註解，文件下載等等）

爲何這裏沒用implementation添加依賴，而是用compile？由於implementation不具備傳遞性，這樣引用core的jsbridge就用不到了，
而咱們須要確保jsbridge中也用到，因此就用了compile。

build.gradle（jsbridge）

一部分相似的代碼就沒有貼出來了

apply plugin: 'com.android.library'

...

dependencies {
    implementation project(':core')
    ...
}

這裏和core不一樣之處在於，內部依賴於core模塊，使用了implementation project，
這樣在jsbridge內部就能使用core的源碼了。

須要注意的是，implementation不具備傳遞性（core只會暴露給jsbridge，不會傳遞下去）

build.gradle（app）

一部分相似的代碼就沒有貼出來了

apply plugin: 'com.android.application'

android {
    defaultConfig {
        applicationId "com.quick.quickhybrid"
        versionCode 1
        versionName "1.0"
    }
   ...
}

dependencies {
    implementation project(':core')
    implementation project(':jsbridge')
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    // butterknife8.0+版本支持控件註解必須在可運行的model加上
    annotationProcessor 'com.jakewharton:butterknife-compiler:8.6.0'
    ...
}

與以前相比，有幾點關鍵信息

  • apply plugin: 'com.android.application'表明是主應用而不是模塊

  • applicationId定義了應用id

  • 一樣有本身的版本控制，可是注意，這裏是容器版本號，前面的如jsbridge中是quick的版本號，有區別的

  • implementation依賴了前面兩個模塊，同時，後面引入了應用中可能須要的依賴

  • annotationProcessor 'com.jakewharton:butterknife-compiler:8.6.0'，這行代碼是爲了使得butterknife自動註解生效的配置

targetSdkVersion說明

配置中使用的版本是22，由於在這個版本以上會有動態權限問題，比較麻煩，須要更改部分邏輯。所以就暫時未修改了。

譬如操做私有文件的權限問題等等

一些關鍵代碼

代碼方面，也沒法一一所有說明，這裏僅列舉一些比較重要的步驟實現，其他可參考源碼

UA約定

前面的JS項目中就已經有提到UA約定，就是在加載對於webview時，統一在webview中加上以下UA標識

WebSettings settings = getSettings();
String ua = settings.getUserAgentString();
// 設置瀏覽器UA,JS端經過UA判斷是否屬於Quick環境
settings.setUserAgentString(ua + " QuickHybridJs/" + BuildConfig.VERSION_NAME);

一些關鍵的webview設置

// 設置支持JS
settings.setJavaScriptEnabled(true);
// 設置是否支持meta標籤來控制縮放
settings.setUseWideViewPort(true);
// 縮放至屏幕的大小
settings.setLoadWithOverviewMode(true);
// 設置內置的縮放控件（若SupportZoom爲false，該設置項無效）
settings.setBuiltInZoomControls(true);
// 設置緩存模式
// LOAD_DEFAULT 根據HTTP協議header中設置的cache-control屬性來執行加載策略
// LOAD_CACHE_ELSE_NETWORK 只要本地有不管是否過時都從本地獲取
settings.setCacheMode(WebSettings.LOAD_DEFAULT);
settings.setDomStorageEnabled(true);
// 設置AppCache 須要H5頁面配置manifest文件(官方已不推介使用)
String appCachePath = getContext().getCacheDir().getAbsolutePath();
settings.setAppCachePath(appCachePath);
settings.setAppCacheEnabled(true);
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
    // 強制開啓android webview debug模式使用Chrome inspect(https://developers.google.com/web/tools/chrome-devtools/remote-debugging/)
    WebView.setWebContentsDebuggingEnabled(true);
}
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
    CookieManager.getInstance().setAcceptThirdPartyCookies(this, true);
}

上述的一系列配置下去才能讓H5頁面的大部分功能正常開啓，如localstorage，cookie，viewport，javascript等

支持H5地理定位

在繼承WebChromeClient的QuickWebChromeClient中

@Override
    public void onGeolocationPermissionsShowPrompt(String origin, GeolocationPermissions.Callback callback) {
        callback.invoke(origin, true, false);
        super.onGeolocationPermissionsShowPrompt(origin, callback);
    }

須要從新才支持地理定位，不然純h5定位沒法獲取地理位置（或者被迫使用了網絡定位）

支持文件選擇

一樣在繼承WebChromeClient的QuickWebChromeClient中

/**
     * Android 4.1+適用
     *
     * @param uploadMsg
     * @param acceptType
     * @param capture
     */
    public void openFileChooser(ValueCallback<Uri> uploadMsg, String acceptType, String capture) {
        loadPage.getFileChooser().showFileChooser(uploadMsg, acceptType, capture);
    }

    /**
     * Android 5.0+適用
     *
     * @param webView
     * @param filePathCallback
     * @param fileChooserParams
     * @return
     */
    @RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
    @Override
    public boolean onShowFileChooser(WebView webView, ValueCallback<Uri[]> filePathCallback, FileChooserParams fileChooserParams) {
        loadPage.getFileChooser().showFileChooser(webView, filePathCallback, fileChooserParams);
        return true;
    }

上述的操做是主動監聽文件的選擇，而後自動調用原生中的處理方案，譬如彈出一個通用的選擇框，進行選擇等。
若是不實現，沒法正常經過FileInput選擇文件，而實際上，FileInput又是一個很經常使用的功能。

監聽JSBridge的觸發

一樣在繼承WebChromeClient的QuickWebChromeClient中

@Override
    public boolean onJsPrompt(WebView view, String url, String message, String defaultValue, JsPromptResult result) {
        result.confirm(JSBridge.callJava(loadPage.getFragment(), message,loadPage.hasConfig()));
        return true;
    }

爲了方便，直接使用onJsPrompt來做爲交互通道，前文中也相應提到過

其它

在直接提供API前，還有不少須要作的基礎工做，譬如瀏覽歷史記錄管理，監聽附件下載，頁面加載報錯處理等等，這裏再也不贅述，能夠直接參考源碼

最後，關於一些JSBridge實現，API實現，因爲本系列的其它文中或多或少都已經提到，這裏就再也不贅述了，能夠直接參考源碼

另外，後續若是繼續有容器優化等操做，也會單獨整理，加入本系列。

前端頁面示例

爲了方便，直接集成到了app/assets/中，入口頁面默認會加載它，也能夠直接看源碼

返回根目錄

源碼

github上這個框架的實現

quickhybrid/quickhybrid

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程