Android開發中怎麼快速創建Android庫?

Android開發中怎麼快速創建Android庫?Android 庫在結構上與 Android 應用模塊相同。它可以提供構建應用所需的一切內容,包括源代碼、資源文件和 Android 清單。不過,Android 庫將編譯到您可以用作 Android 應用模塊依賴項的 Android 歸檔 (AAR) 文件,而不是在設備上運行的 APK。與 JAR 文件不同,AAR 文件可以包含 Android 資源和一個清單文件,這樣,除瞭 Java 類與方法外,您還可以捆綁佈局和可繪制對象等共享資源。

庫模塊在以下情況下非常有用:

構建使用某些相同組件(例如 Activity、服務或 UI 佈局)的多個應用。
構建存在多個 APK 變體(例如免費版本和付費版本)的應用並且需要在兩種版本中使用相同的核心組件。

在任何一種情況下,隻需要將您希望重用的文件移動到庫模塊中,然後以依賴項的形式為每個應用模塊添加庫。本頁面將說明如何執行這兩個操作。

創建庫模塊


要在您的項目中創建一個新的庫模塊,請按以下步驟操作:

點擊File > New > New Module。
在出現的Create New Module窗口中,依次點擊Android Library和Next。

還存在一個用於創建Java 庫的選項,可以構建傳統的 JAR 文件。盡管 JAR 文件在大多數項目中都非常實用(尤其在您希望與其他平臺共享代碼時),但這種文件不允許您包含 Android 資源或清單文件,而後者對於 Android 項目中的代碼重用非常有用。因此,本指南將側重論述創建 Android 庫。

為您的庫命名,並為庫中代碼選擇一個最低的 SDK 版本,然後點擊Finish。

在 Gradle 項目同步完成後,庫模塊將顯示左側的Project面板中。如果您未看到新模塊文件夾,請確保將視圖切換為Android 視圖。

將應用模塊轉換為庫模塊

如果您現有的應用模塊包含您希望重用的所有代碼,則可以按照以下步驟將其轉換為庫模塊:

打開現有應用模塊的build.gradle文件。您應在頂部看到以下內容:

apply plugin: 'com.android.application'

按照下面所示更改插件分配:

 

apply plugin: 'com.android.library'

點擊Sync Project with Gradle Files。

就這麼簡單。模塊的整個結構仍然相同,但是現在它將作為 Android 庫運行,構建也將創建一個 AAR 文件,而不是 APK。

以依賴項形式添加您的庫


要在另一個應用模塊中使用您的 Android 庫的代碼,請按以下步驟操作:

通過兩種方式之一將庫添加到您的項目(如果您是在相同項目中創建的庫模塊,則該模塊已經存在,您可以跳過此步驟):
添加已編譯的 AAR(或 JAR)文件:
點擊File > New Module。
依次點擊Import .JAR/.AAR Package和Next。
輸入 AAR 或 JAR 文件的位置,然後點擊Finish。
將庫模塊導入到您的項目中:
點擊File > New > Import Module。
輸入庫模塊目錄的位置,然後點擊Finish。

庫模塊將復制到您的項目中,因此您可以盡管編輯庫代碼。如果您希望維護一個版本的庫代碼,則此方法可能不是您想要的,您應按照上文所述導入編譯的 AAR 文件。

確保庫列在您settings.gradle文件的頂部,如下面名為“my-library-module”的庫所示:

include ':app', ':my-library-module'

打開應用模塊的build.gradle文件,並向dependencies塊中添加一行新代碼,如下面的片段所示:

dependencies {
  compile project(":my-library-module")
}

點擊Sync Project with Gradle Files。

在上面的示例中,名為my-library- module的 Android 庫模塊成為build.gradle文件所在模塊的構建依賴項。

您的應用模塊現在可以訪問 Android 庫中的任何代碼和資源,庫 AAR 文件在構建時已捆綁到您的 APK 中。

不過,如果希望單獨共享 AAR 文件,則可以在項目名稱/模塊名稱/build/outputs/aar/中找到它,也可以通過點擊Build > Make Project的方式重新生成此文件。

選擇要設為公開的資源


庫中的所有資源在默認情況下均處於公開狀態。要將所有資源隱式設為私有,您必須至少將一個特定的屬性定義為公開。資源包括您項目的res/目錄中的所有文件,例如圖像。要阻止您的庫用戶訪問僅供內部使用的資源,您應通過聲明一個或多個公開資源的方式來使用這種自動私有標識機制。

要刪除某個公開資源,請將一個聲明添加到您的庫的public.xml文件中。如果您之前尚未添加公開資源,則需要在您的庫的res/values/目錄中創建public.xml文件。

下面的示例代碼可以創建兩個名稱分別為mylib_app_name和mylib_public_string的公開字符串資源:


  
  

如果希望任何資源保持對使用您的庫的開發者可見,您應當將其設為公開。例如,盡管v7 appcompat 庫中的大多數資源都是私有資源,但是為瞭支持Material Design,控制工具欄小部件的屬性應當公開。

將屬性隱式設為私有不僅可以阻止您的庫用戶從內部庫資源獲得代碼自動完成建議,還讓您能夠在不中斷您的庫客戶端的情況下重命名或移除私有資源。私有資源不在代碼自動完成和Theme Editor的作用范圍內,並且如果您嘗試引用私有資源,Lint將顯示警告。

開發註意事項


在開發您的庫模塊和相關應用時,請註意以下行為和限制。

將庫模塊引用添加至您的 Android 應用模塊後,您可以設置它們的相對優先級。構建時,庫會按照一次一個的方式與應用合並,並按照從低到高的優先級順序。

資源合並沖突

構建工具會將庫模塊中的資源與相關應用模塊的資源合並。如果在兩個模塊中均定義瞭給定資源 ID,將使用應用中的資源。

如果多個 AAR 庫之間發生沖突,將使用依賴項列表首先列出(位於dependencies塊頂部)的庫中的資源。

為瞭避免常用資源 ID 的資源沖突,請使用在模塊(或在所有項目模塊)中具有唯一性的前綴或其他一致的命名方案。

庫模塊可以包含 JAR 庫

您可以開發一個自身包含 JAR 庫的庫模塊;不過,您需要手動編輯相關應用模塊的構建路徑,並添加 JAR 文件的路徑。

庫模塊可以依賴外部 JAR 庫

您可以開發一個依賴於外部庫(例如 Maps 外部庫)的庫模塊。在這種情況下,相關應用必須針對包含外部庫(例如 Google API 插件)的目標構建。另外也要註意,庫模塊和相關應用都必須在其清單文件的元素中聲明外部庫。

庫模塊不得包含原始資源

工具不支持在庫模塊中使用原始資源文件(保存在assets/目錄中)。應用使用的任何原始資源都必須存儲在應用模塊自身的assets/目錄中。

應用模塊的minSdkVersion必須大於或等於庫定義的版本

庫作為相關應用模塊的一部分編譯,因此,庫模塊中使用的 API 必須與應用模塊支持的平臺版本兼容。

每個庫模塊都會創建自己的 R 類

在您構建相關應用模塊時,庫模塊將先編譯到 AAR 文件中,然後再添加到應用模塊中。因此,每個庫都有其自己的R類,並根據庫的軟件包名稱命名。從主模塊和庫模塊生成的R類會在所需的所有軟件包(包括主模塊的軟件包和庫的軟件包)中創建。

庫模塊可能包含自己的 ProGuard 配置文件

通過將ProGuard配置文件添加到包含其 ProGuard 指令的庫,您可以在自己的庫上啟用代碼壓縮。構建工具會為庫模塊將此文件嵌入到生成的 AAR 文件中。在您將庫添加到應用模塊時,庫的 ProGuard 文件將附加至應用模塊的 ProGuard 配置文件 (proguard.txt)。

通過將 ProGuard 文件嵌入到您的庫模塊中,您可以確保依賴於此庫的應用模塊不必手動更新其 ProGuard 文件即可使用庫。當 ProGuard 在 Android 應用模塊上運行時,它會同時使用來自應用模塊和庫的指令,因此您不應當隻在庫上運行 ProGuard。

要指定您的庫的配置文件名稱,請將其添加到consumerProguardFiles方法中,此方法位於您的庫的build.gradle文件的defaultConfig塊內。例如,以下片段會將lib-proguard-rules.txt設置為庫的 ProGuard 配置文件:

android {
    defaultConfig {
        consumerProguardFiles 'lib-proguard-rules.txt'
    }
    ...
}

默認情況下,應用模塊會使用庫的發佈構建,即使在使用應用模塊的調試構建類型時亦是如此。要使用庫中不同的構建類型,您必須將依賴項添加到應用的build.gradle文件的dependencies塊中,並在庫的build.gradle文件中將publishNonDefault設置為true。例如,您應用的build.gradle文件中的以下代碼段會使應用在應用模塊於調試模式下構建時使用庫的調試構建類型,以及在應用模塊於發佈模式下構建時使用庫的發佈構建類型:

dependencies {
  debugCompile project(path: ':library', configuration: 'debug')
  releaseCompile project(path: ':library', configuration: 'release')
}

您還必須在自己庫的build.gradle文件的android塊內添加以下代碼行,以便將此庫的非發佈配置展示給使用它的項目:

android {
  ...
  publishNonDefault true
}

不過請註意,設置publishNonDefault會增加構建時間。

為瞭確保您的庫的 ProGuard 規則不會將意外的壓縮副作用施加到應用模塊,請僅包含適當規則,停用不適用於此庫的 ProGuard 功能。嘗試協助開發者的規則可能會與應用模塊或它的其他庫中的現有代碼沖突,因此不應包含這些規則。例如,您的庫的 ProGuard 文件可以指定在應用模塊的壓縮期間需要保留的代碼。

註:Jack 工具鏈僅支持 ProGuard 的部分壓縮和模糊選項。

AAR 文件詳解


AAR 文件的文件擴展名為.aar,Maven 工件類型也應當是aar。文件本身是一個包含以下強制性條目的zip文件:

/AndroidManifest.xml
/classes.jar
/res/
/R.txt

此外,AAR 文件可能包含以下可選條目中的一個或多個:

/assets/
/libs/名稱.jar
/jni/abi 名稱/名稱.so(其中abi 名稱是 Android支持的 ABI之一)
/proguard.txt

發佈留言

發佈留言必須填寫的電子郵件地址不會公開。 必填欄位標示為 *