藉助Gradle Plugin解決模塊化開發中模塊如何對外暴露接口

時間 2019-11-16

標籤藉助 gradle plugin 解決模塊化開發模塊如何對外暴露接口欄目 Gradle 简体版

原文原文鏈接

直奔主題，在模塊化開發中，模塊間的數據交流大多數同窗會採用以接口做爲通訊協議的方式。須要面對的問題有如下幾點：html

接口由誰來維護？java

這個問題簡單，由提供服務的模塊來維護。git
接口怎麼暴露？github

打成jar包，發佈到maven。apache
接口在哪裏維護？api

如今能夠參考的方案有三種：一. 全部相關模塊的接口統一在一個模塊中維護；二. 各個模塊的接口分別在自建一個新的模塊中維護，經過命名規則一一對應；三. 像微信的.api方案，使用特殊的規則混雜在各自的模塊中。bash

若是接着第一個問題，方案一好像就有點難肯定接口對應的來源模塊。方案二會出現接口模塊成倍增長，極易出現一個模塊只含一個接口類的現象。方案三須要自定義相關插件，在建立接口時會有點不便，不夠靈活。微信

MIS登場！！！接下來先介紹mis的簡單使用以及背後的原理。app

MIS

模塊接口服務（Module Interface Service）maven

MIS是從微信的.api方案演變而來，主要解決的問題是如何在一個模塊內維護其對外暴露的接口（包括打包發佈），而不是把接口和接口實現分離到兩個不一樣的模塊。

Usage

引用 mis 插件

在根項目的build.gradle中添加mis插件的classpath：

buildscript {
    dependencies {
        ...
        classpath 'com.eastwood.tools.plugins:mis:1.3.5'
    }
}
複製代碼

在模塊的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，其中repositories相關設置請查閱# Maven Publish Plugin

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包。