原文地址:https://developer.android.com/studio/projects/android-library.html
一個(gè)Android Library 與一個(gè)Android App模塊的結(jié)構(gòu)相同.它可以包含創(chuàng)建一個(gè)App所需要的一切,包括源代碼,資源文件,和一個(gè)Android manifest.然而不同的是,一個(gè)app編譯成一個(gè)運(yùn)行在設(shè)備上的APK, 一個(gè)Android Library編譯成一個(gè)Android Archive (AAR),作為Android App模塊依賴(lài).
一個(gè)Library模塊在下面情況下有用:
1. 當(dāng)你創(chuàng)建多個(gè)APP時(shí),用到一些相同的組件,如activities, sevices或者UI layouts.
2. 當(dāng)你創(chuàng)建的一個(gè)APP存在多個(gè)APK版本,例如一個(gè)免費(fèi)的和付費(fèi)的版本,都需要相同的核心組件.
在這些情況下,簡(jiǎn)單地移動(dòng)你想再利用的文件到一個(gè)Library模塊,然后添加這個(gè)library作為App模塊的依賴(lài).這篇文章教你怎樣做:
創(chuàng)建一個(gè)Library模塊
1. 點(diǎn)擊File > New > New Module.
2.在Create New Module窗口中,點(diǎn)擊Android Library,然后點(diǎn)擊Next.
創(chuàng)建一個(gè)Java Library, 它構(gòu)建了一個(gè)傳統(tǒng)的JAR文件. 一個(gè)JAR文件對(duì)許多工程有用,特別當(dāng)你想在不同的平臺(tái)分享代碼,它不讓你劊子手Android資源和manifest文件,這個(gè)對(duì)Android工程中的代碼復(fù)用非常有用.所以這個(gè)引導(dǎo)注重創(chuàng)建Android Libraries.
3. 給你的Library命名并選擇一個(gè)最小的SDK版本, 然后點(diǎn)擊Finish.
一旦Gradle 工程同步完成, library模塊將出現(xiàn)在左邊的工程面板中.如果你不想看到新的模塊文件,確保它在顯示Android view.
將App模塊轉(zhuǎn)換成Library模塊
1.打開(kāi)一個(gè)存在的App模塊的build.gradle文件,在文件的上面,你可以看到:
apply plugin:'com.android.application'
2. 改變?nèi)缦?
apply plugin:'com.android.library'
3. 點(diǎn)擊Sync Project with Gradle Files.
這樣就好了.這個(gè)模塊的整個(gè)結(jié)構(gòu)保持相同, 但它現(xiàn)在作為一個(gè)Android library, 編譯將會(huì)創(chuàng)建一個(gè)AAR文件而不是一個(gè)APK文件.
添加你的Library作為一個(gè)依賴(lài)
將你的Android Library代碼用到另外一個(gè)App模塊,過(guò)程如下:
1. 將Library添加到工程有2種方法(如果Library模塊在同一個(gè)工程中,你可以跳過(guò)這步)
方法1: 添加編譯的AAR(或者JAR)文件:
點(diǎn)擊File > New Module.
點(diǎn)擊Import .JAR/.AAR Package, 然后點(diǎn)擊Next.
寫(xiě)入AAR或者JAR文件的位置,然后點(diǎn)擊Finish.
方法2: 工程中導(dǎo)入Library模塊
點(diǎn)擊File > New > Import Module.
寫(xiě)入Library模塊文件的位置,然后點(diǎn)擊Finish.
Library模塊已經(jīng)挎入到你的工程, 你能夠編輯Library的代碼.如果你相保持Library代碼一個(gè)版本,那么這個(gè)可能不是你想要的,你應(yīng)該導(dǎo)入編譯好的AAR文件.
2. 確保你的Library列在settings.gradle文件的上面.如這兒如示,一個(gè)Library名字為?"my-library-module":
include':app',':my-library-module'
3. 打開(kāi)app模塊的build.gradle文件, 在dependencies中添加:
dependencies{
compile project(":my-library-module")
}
4. 點(diǎn)擊Sync Project with Gradle Files.
在上面的這個(gè)例子中,Android library模塊命名為my-library-module,成為了build.gradle文件所在模塊的依賴(lài).
現(xiàn)在可以在你的App模塊中獲得任何Android library的代碼和資源, 在編譯的時(shí)候AAR文件綁定到你的APK.
然而,如果你想單獨(dú)地分享你的AAR文件,你能在project-name/module-name/build/outputs/aar/找到它, 你可以重新產(chǎn)生它通過(guò)點(diǎn)擊Build > Make Project.
開(kāi)發(fā)考慮
當(dāng)你開(kāi)發(fā)你的library模塊和依賴(lài)的App,你應(yīng)該意識(shí)到下面這些行為和限制:
一旦你將library模塊引用到你的Android app模塊,你能設(shè)置它們相關(guān)的優(yōu)先權(quán).在創(chuàng)建的時(shí)候,library同時(shí)與App的內(nèi)容合并,開(kāi)始從最低優(yōu)先級(jí)到最高.
1. 資源合并沖突
構(gòu)建工具從一個(gè)library模塊和這些依賴(lài)的app模塊中合并資源.如果給定的資源ID在這兩個(gè)模塊中定義, app的資源將會(huì)被利用.
如果沖突發(fā)生在多個(gè)AAR library中,則使用從依賴(lài)列表中先列出的library的資源.
為了避免相同ID資源的沖突,考慮用一個(gè)前綴或者其它一致的命名方案,該方案是唯一的模塊(或者在所有項(xiàng)目中是唯一的)
2.一個(gè)library模塊可以包含一個(gè)JAR library
你可以開(kāi)發(fā)一個(gè)library模塊它自身包含一個(gè)JAR library; 然而，你需要手動(dòng)編輯相關(guān)的應(yīng)用模塊的構(gòu)建路徑，并添加到JAR文件的路徑。
3. 一個(gè)library模塊可以依賴(lài)一個(gè)外部的JAR library
你可以開(kāi)發(fā)一個(gè)library模塊依賴(lài)一個(gè)外部library.(例如, Maps外部library).這種情況下,依賴(lài)應(yīng)用程序必須建立針對(duì)外部library的目標(biāo)(例如,Google APIs Add-On). library模塊和依賴(lài)的app必須在它們的manifest文件中聲明外部library, 在<uses-library>元素中.
4. library模塊不能包括原始的assets
這些工具在library模塊中不支持原始的asset文件的用法(保存在assets/文件夾中).任何asset資源都被一個(gè)app存儲(chǔ)在自己模塊的assets/文件夾中.
5. app模塊的最小sdk版本必須等于或者大于library中定義的版本.
一個(gè)library作為依賴(lài)的app模塊的一部分被編譯, 所以library模塊所用的APIs必須和app模塊所支持的平臺(tái)版本相匹配.
6.每個(gè)library模塊創(chuàng)建它自己的R類(lèi)
當(dāng)你創(chuàng)建一個(gè)依賴(lài)的app模塊, library模塊被編譯成一個(gè)AAR文件然后添加到app模塊.因此,每個(gè)library有它自己的R類(lèi),通過(guò)library的包名來(lái)命名.從主模塊生成R類(lèi)和需要包括主模塊包和libraries包的所有包所創(chuàng)建的library模塊.
