借助Gradle Plugin解決模塊化開發中模塊如何對外暴露接口
接口由誰來維護?
這個問題簡單,由提供服務的模塊來維護。
接口怎麽暴露?
打成jar包,發布到maven。
接口在哪裏維護?
現在可以參考的方案有三種:一. 所有相關模塊的接口統一在一個模塊中維護;二. 各個模塊的接口分別在自建一個新的模塊中維護,通過命名規則一一對應;三. 像微信的.api方案,使用特殊的規則混雜在各自的模塊中。
如果接著第一個問題,方案一好像就有點難確定接口對應的來源模塊。方案二會出現接口模塊成倍增加,極易出現一個模塊只含一個接口類的現象。方案三需要自定義相關插件,在創建接口時會有點不便,不夠靈活。
MIS登場!!!接下來先介紹mis的簡單使用以及背後的原理。
MIS
模塊接口服務(Module Interface Service)
MIS是從微信的.api方案演變而來,主要解決的問題是如何在一個模塊內維護其對外暴露的接口(包括打包發布),而不是把接口和接口實現分離到兩個不同的模塊。
Usage
引用 mis 插件
在根項目的build.gradle中添加mis插件的classpath:
在根項目的build.gradle中添加mis插件的classpath:
在模塊的build.gradle中添加mis插件:
...
apply plugin: ‘mis‘
創建 mis 目錄
Gradle Sync後,在java同級目錄創建mis文件夾
定義接口,並實現接口服務
直接在mis文件夾下,創建對應的包名、接口類和數據Model。並在java文件夾下實現接口服務。
配置mis相對應的publication
mis { publications { main { groupId ‘com.eastwood.demo‘ artifactId ‘library-sdk‘ // version ‘1.0.0-SNAPSHOT‘ dependencies { compileOnly ‘com.google.code.gson:gson:2.8.1‘ } } } ... }
main指的是src/main/java中的main,除了main之外,其值還可以為 build types和product flavors對應的值,即對應目錄下的mis。比如與src/debug/java對應的src/debug/mis。
groupId、artifactId、version對應的是Maven的GAV。初次配置時不設置version,發布至maven時設置version。
在dependencies中可聲明該mis編譯和運行時需用到的第三方庫,僅支持compileOnly和implementation。
發布至Maven
mis {
publications {
main {
groupId ‘com.eastwood.demo‘
artifactId ‘library-sdk‘
version ‘1.0.0-SNAPSHOT‘
...
}
}
repositories {
maven {
url "http://***"
credentials {
username ‘***‘
password ‘***‘
}
}
}
...
}
發布時需設置version。
發布時內部用到的插件是maven-publish
Gradle Sync後,打開Gradle Tasks View,選擇publishMis[...]PublicationToMavenRepository執行發布任務。
其中publishMis[...]PublicationToMavenLocal 是發布至本地maven。如果使用本地maven,請將mavenLocal()添加至根項目的build.gradle中,比如:
allprojects {
repositories {
google()
jcenter()
mavenLocal()
}
}
Q&A
1.mis目錄下的類會參與編譯嗎?
不會。雖然mis目錄下的類能被java目錄下的類直接引用,但不會參與編譯,真正參與編譯的是該mis目錄生成的jar包,其位於當前工程.gradle/mis下。在當前工程Sync&Build的時候,mis插件會對這些配置了publication的mis目錄進行編譯打包生成jar包,並且依賴該jar包。
mis目錄下的類之所以能被java目錄下的類直接引用,是因為mis目錄被設置為sourceSets aidl的src目錄,而Android Studio對sourceSets aidl的src目錄有特別支持。
2.沒有Maven私服,所有模塊都在一個工程下,其他模塊怎麽引用接口?
不設置publication的version。通過misPublication聲明依賴,比如:
dependencies {
...
implementation misPublication(‘com.eastwood.demo:library-sdk‘)
}
misPublication運行機理是會自動在當前工程.gradle/mis下查找是否有對應的mis提供的jar包。如果有,就使用對應的mis提供的jar包;如果沒有且指定了version,就使用maven上的jar包。
3.將接口發布到maven後,其他模塊通過misPublication聲明依賴,那jar包用的是.gradle/mis下的還是maven上的?
接口被發布到maven後,其.gradle/mis下的jar包會被刪除,接口所在的模塊根據publication中設置的GAV使用maven上的jar包。如果其他模塊通過misPublication聲明對其依賴,比如:
dependencies {
...
implementation misPublication(‘com.eastwood.demo:library-sdk‘)
// 或 implementation misPublication(‘com.eastwood.demo:library-sdk:1.0.0-SNAPSHOT‘)
}
不管misPublication中是否設置了的version,都會使用maven上的jar包,其版本同接口所在的模塊publication中的GAV。
當mis目錄下類發生實質性的修改後(生成不同的jar包),在當前工程Sync&Build的時,會在.gradle/mis下的重新生成jar包,接口所在的模塊不管publication中是否設置version,都使用.gradle/mis下的jar包。如果其他模塊通過misPublication聲明對其依賴,不管misPublication中是否設置的version,都會使用.gradle/mis下的jar包。
4.為什麽在Gradle Tasks View中找不到publishing相關發布Task?
初次發布時,請檢查對應的publication是否已經設置的version,以及是否添加相關repositories。
借助Gradle Plugin解決模塊化開發中模塊如何對外暴露接口