Android开发必知的maven-publish插件知识
1.背景
作为Android开发，在我们开发到一定阶段总会接触SDK开发、组件化开发，这样就会有组件发布Aar的需求。Gradle提供了maven-publish插件供我们完成组件发布需求，但是大多数人可能只是简单的使用，见葫芦画瓢，并没有完整的了解插件的作用。这里本着复习完善的想法，带大家一起好好学习下。
2. 发布过程
大量的软件产品编译都是为了以某种方式消费掉，比如Library库为了其他软件工程使用或者应用提供给其他终端使用。发布Publishing就是为了实现并使这个过程更简单。
在Gradle看来，这个过程可以分为三个部分：
1.发布什么（WHAT to publish）
定义一个或多个artifacts（译：人工制品），一般是工程编译产品
Gradle需要的模块元数据，表明发布组件的参数，如group、version
2.发布到哪（Publish to WHERE)
当然就是仓库repositories了。
3.如何发布（how to publish）
Gradle自动生成可能组合的发布任务和仓库，允许你发布任何制品到任何仓库。如果使用的是Maven仓库，则task是类似PublishToMavenRepository
2.1 使用示例
plugins {
id 'maven-publish'
}
group = 'org.example'
version = '1.0'
publishing {
publications {
myLibrary(MavenPublication) {//MyLibray是可更改的，根据自己需要
from components.java
}
}
repositories {
maven { //这里不可更改
name = 'myRepo'
url = layout.buildDirectory.dir("repo")
}
}
}
2.2. 引入插件
plugins {
id ‘maven-publish’
}
或者apply plugin: ‘maven-publish’
2.3. 实现原理
Maven-publish插件也是Gradle插件，什么闭包、Extenstion扩展类型的知识我就不讲了，大家都应该了解，不了解的可以自己查阅学习。总之，maven-publish插件使用了PublishingExtension类型的extension，即上述使用例子的“publishing”，其又提供了一个叫做“publications”的容器和一个叫“repository”的容器，maven-publish插件使用MavenPublication 类型的publications 和MavenArtifactRepository 类型的仓库，所以上述例子的publications 里的myLibrary带参数MavenPublish，repository闭包里有maven属性。
2.4. publicaions
配置maven-publishing插件的输出物， 例子中有名为“myLibrary” 的输出，而且名字可以自定义，而且还可以添加其他的输出物。
主要包含四种类型的配置项：
- 一个component
-通过 MavenPublication.from(org.gradle.api.component.SoftwareComponent).
示例 ：from components.java 所有java文件的jar包
from components.release 工程release生成的包，一般是aar包
- Custom artifacts
— 通过 MavenPublication.artifact(java.lang.Object) 方法. 查看MavenArtifact 获取所有可配置选项。artifact 可以设置一系列的输入。
artifact(tasks.getByName("bundleReleaseAar"))同 from components.release 如果有渠道，则使用“bundle(Flavor)ReleaseAar”，需将（Flavor）替换为正常渠道名
artifact sourceJar // Publish the output of the sourceJar task
artifact 'my-file-name.jar' // Publish a file created outside of the build
artifact source: sourceJar, classifier: 'src', extension: 'zip'
- 标准元数据
例如artifactId, groupId and version.
groupId - project.group
artifactId - project.name
version - project.version
- POM文件的其他内容 — 通过 MavenPublication.pom(org.gradle.api.Action).
2.5. repositiories
顾名思义，就是用来配置maven-publishing仓库的信息，即输出目的地
仓库的配置相对简单，只需要两项：
URL (必填)
Name (可选)
3. 任务解读
最终，maven-publish会生成publicaions 名字对应的Task任务，如果有多个publicaions设置则会对应数量的发布任务。
- generatePomFileForPubNamePublication
为名为PubName的发布创建一个POM文件，填充已知元数据，如项目名称、项目版本和依赖项。生成的POM文件默认放在build/publications/$pubName/pom-default.xml.
- publishPubNamePublicationToRepoNameRepository
将名为PubName的发布发布到名为RepoName的存储库中。如果您有一个没有显式名称的存储库定义，那么RepoName将是Maven。
- publishPubNamePublicationToMavenLocal
将PubName发布复制到本地Maven缓存—通常是*$USER_HOME/.m2/repository*——连同发布的POM文件和其他元数据一起。
- publish
依赖于所有publishPubNamePublicationToRepoNameRepository任务
将所有已定义的发布发布到所有已定义存储库的聚合任务。它不包括将发布复制到本地Maven缓存。
- publishToMavenLocal
依赖于所有publishPubNamePublicationToMavenLocal任务
将所有已定义的发布复制到本地Maven缓存，包括它们的元数据(POM文件等)。
4. Pom知识
Maven 是一个项目管理和自动构建工具。Maven 包是由 POM（Project Object Model）所定义的文件包格式。Maven 包集中存放的地方，就是 Maven 仓库。这些仓库，可以是放在本地，也可以放在某个远程服务器上。 可以是私有仓库，也可以是公开的。pom.xml为项目模型对象的描述文件。
项目信息，也称作坐标
<groupId>项目所属组织groupId>
<artifactId>项目或模块名称artifactId>
<version>项目版本version>
通常我们的项目需要引入第三方库，我们只需要添加第三方库的坐标即可。今天我们讲的内容，比如我们输出我们的SDK，但是我们依赖了其他如okhttp等版本，SDK接入方直接依赖我们的SDK的地址就可以，并没有显示的依赖okhttp。就是因为pom的作用。类推，我们依赖okhttp，但是okhttp又依赖okio等这些又都在okhttp组件的pom文件中定义。
当多个组件模块使用了不同的依赖版本的时候，最终编译的应用会使用最新版本的依赖。
笔者工作中曾遇到这样的问题，要生成SDK的module要打包为中英文两个版本，但是生成Aar中代码完全相同，只是有个依赖包A区分中英文版本，为了减少编译次数，设置一个任务，同时执行两个publish任务，第一个publish任务先使用bundleReleaseAar任务作为pulications输入，然后更改pom文件依赖中文版A包。然后第二个publish任务将输入设为工程build/output/…***.aar，即减少了再次编译的时间，直接更改pom依赖为A的英文版本。则实现了一个任务同时发布中英文版本SDK，而且减少了一次编译耗时。更改pom依赖的方式是在publications 里当前发布任务（2.1示例中是“myLibray”)内部添加如下代码，改为自己需要的依赖坐标。
pom.withXml {
def dependenciesNode = asNode().appendNode('dependencies')
def dependencyNode = dependenciesNode.appendNode('dependency')
dependencyNode.appendNode('groupId', 'com.squareup.okhttp3')
dependencyNode.appendNode('artifactId', 'okhttp')
dependencyNode.appendNode('version', '4.9.0')
}
pom文件中通过dependencyManagement来声明依赖，通过dependencies元素来管理依赖。dependencyManagement下的子元素只有一个直接的子元素dependencice，其配置和dependencies子元素是完全一致的；而dependencies下只有一类直接的子元素：dependency。一个dependency子元素表示一个依赖项目。
pom.xml各种标签含义如下：
Maven 提供了大量的原型插件来创建工程，包括工程结构和 pom.xml。
POM 标签大全详解
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0http://maven.apache.org/maven-v4_0_0.xsd">
<parent>
<artifactId />
<groupId />
<version />
<relativePath />
parent>
<modelVersion>4.0.0modelVersion>
<groupId>asia.banseongroupId>
<artifactId>banseon-maven2artifactId>
<packaging>jarpackaging>
<version>1.0-SNAPSHOTversion>
<name>banseon-mavenname>
<url>http://www.baidu.com/banseonurl>
<description>A maven project to study maven.description>
<prerequisites>
<maven />
prerequisites>
<issueManagement>
<system>jirasystem>
<url>http://jira.baidu.com/banseonurl>
issueManagement>
<ciManagement>
<system />
<url />
<notifiers>
<notifier>
<type />
<sendOnError />
<sendOnFailure />
<sendOnSuccess />
<sendOnWarning />
<address />
<configuration />
notifier>
notifiers>
ciManagement>
<inceptionYear />
<mailingLists>
<mailingList>
<name>Demoname>
<post>[email protected]post>
<subscribe>[email protected]subscribe>
<unsubscribe>[email protected]unsubscribe>
<archive>http:/hi.baidu.com/banseon/demo/dev/archive>
mailingList>
mailingLists>
<developers>
<developer>
<id>HELLO WORLDid>
<name>banseonname>
<email>[email protected]email>
<url />
<roles>
<role>Project Managerrole>
<role>Architectrole>
roles>
<organization>demoorganization>
<organizationUrl>http://hi.baidu.com/banseonorganizationUrl>
<properties>
<dept>Nodept>
properties>
<timezone>-5timezone>
developer>
developers>
<contributors>
<contributor>
<name />
<email />
<url />
<organization />
<organizationUrl />
<roles />
<timezone />
<properties />
contributor>
contributors>
<licenses>
<license>
<name>Apache 2name>
<url>http://www.baidu.com/banseon/LICENSE-2.0.txturl>
<distribution>repodistribution>
<comments>A business-friendly OSS licensecomments>
license>
licenses>
<scm>
<connection>
scm:svn:http://svn.baidu.com/banseon/maven/banseon/banseon-maven2-trunk(dao-trunk)
connection>
<developerConnection>
scm:svn:http://svn.baidu.com/banseon/maven/banseon/dao-trunk
developerConnection>
<tag />
<url>http://svn.baidu.com/banseonurl>
scm>
<organization>
<name>demoname>
<url>http://www.baidu.com/banseonurl>
organization>
<build>
<sourceDirectory />
<scriptSourceDirectory />
<testSourceDirectory />
<outputDirectory />
<testOutputDirectory />
<extensions>
<extension>
<groupId />
<artifactId />
<version />
extension>
extensions>
<defaultGoal />
<resources>
<resource>
<targetPath />
<filtering />
<directory />
<includes />
<excludes />
resource>
resources>
<testResources>
<testResource>
<targetPath />
<filtering />
<directory />
<includes />
<excludes />
testResource>
testResources>
<directory />
<finalName />
<filters />
<pluginManagement>
<plugins>
<plugin>
<groupId />
<artifactId />
<version />
<extensions />
<executions>
<execution>
<id />
<phase />
<goals />
<inherited />
<configuration />
execution>
executions>
<dependencies>
<dependency>
......
dependency>
dependencies>
<inherited />
<configuration />
plugin>
plugins>
pluginManagement>
<plugins>
<plugin>
<groupId />
<artifactId />
<version />
<extensions />
<executions>
<execution>
<id />
<phase />
<goals />
<inherited />
<configuration />
execution>
executions>
<dependencies>
<dependency>
......
dependency>
dependencies>
<goals />
<inherited />
<configuration />
plugin>
plugins>
build>
<profiles>
<profile>
<id />
<activation>
<activeByDefault />
<jdk />
<os>
<name>Windows XPname>
<family>Windowsfamily>
<arch>x86arch>
<version>5.1.2600version>
os>
<property>
<name>mavenVersionname>
<value>2.0.3value>
property>
<file>
<exists>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/
exists>
<missing>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/
missing>
file>
activation>
<build>
<defaultGoal />
<resources>
<resource>
<targetPath />
<filtering />
<directory />
<includes />
<excludes />
resource>
resources>
<testResources>
<testResource>
<targetPath />
<filtering />
<directory />
<includes />
<excludes />
testResource>
testResources>
<directory />
<finalName />
<filters />
<pluginManagement>
<plugins>
<plugin>
<groupId />
<artifactId />
<version />
<extensions />
<executions>
<execution>
<id />
<phase />
<goals />
<inherited />
<configuration />
execution>
executions>
<dependencies>
<dependency>
......
dependency>
dependencies>
<goals />
<inherited />
<configuration />
plugin>
plugins>
pluginManagement>
<plugins>
<plugin>
<groupId />
<artifactId />
<version />
<extensions />
<executions>
<execution>
<id />
<phase />
<goals />
<inherited />
<configuration />
execution>
executions>
<dependencies>
<dependency>
......
dependency>
dependencies>
<goals />
<inherited />
<configuration />
plugin>
plugins>
build>
<modules />
<repositories>
<repository>
<releases>
<enabled />
<updatePolicy />
<checksumPolicy />
releases>
<snapshots>
<enabled />
<updatePolicy />
<checksumPolicy />
snapshots>
<id />
<name />
<url />
<layout />
repository>
repositories>
<pluginRepositories>
<pluginRepository>
<releases>
<enabled />
<updatePolicy />
<checksumPolicy />
releases>
<snapshots>
<enabled />
<updatePolicy />
<checksumPolicy />
snapshots>
<id />
<name />
<url />
<layout />
pluginRepository>
pluginRepositories>
<dependencies>
<dependency>
......
dependency>
dependencies>
<reports />
<reporting>
......
reporting>
<dependencyManagement>
<dependencies>
<dependency>
......
dependency>
dependencies>
dependencyManagement>
<distributionManagement>
......
distributionManagement>
<properties />
profile>
profiles>
<modules />
<repositories>
<repository>
<releases>
<enabled />
<updatePolicy />
<checksumPolicy />
releases>
<snapshots>
<enabled />
<updatePolicy />
<checksumPolicy />
snapshots>
<id>banseon-repository-proxyid>
<name>banseon-repository-proxyname>
<url>http://192.168.1.169:9999/repository/url>
<layout>defaultlayout>
repository>
repositories>
<pluginRepositories>
<pluginRepository>
......
pluginRepository>
pluginRepositories>
<dependencies>
<dependency>
<groupId>org.apache.mavengroupId>
<artifactId>maven-artifactartifactId>
<version>3.8.1version>
<type>jartype>
<classifier>classifier>
<scope>testscope>
<systemPath>systemPath>
<exclusions>
<exclusion>
<artifactId>spring-coreartifactId>
<groupId>org.springframeworkgroupId>
exclusion>
exclusions>
<optional>trueoptional>
dependency>
dependencies>
<reports>reports>
<reporting>
<excludeDefaults />
<outputDirectory />
<plugins>
<plugin>
<groupId />
<artifactId />
<version />
<inherited />
<configuration />
<reportSets>
<reportSet>
<id />
<configuration />
<inherited />
<reports />
reportSet>
reportSets>
plugin>
plugins>
reporting>
<dependencyManagement>
<dependencies>
<dependency>
......
dependency>
dependencies>
dependencyManagement>
<distributionManagement>
<repository>
<uniqueVersion />
<id>banseon-maven2id>
<name>banseon maven2name>
<url>file://${basedir}/target/deployurl>
<layout />
repository>
<snapshotRepository>
<uniqueVersion />
<id>banseon-maven2id>
<name>Banseon-maven2 Snapshot Repositoryname>
<url>scp://svn.baidu.com/banseon:/usr/local/maven-snapshoturl>
<layout />
snapshotRepository>
<site>
<id>banseon-siteid>
<name>business api websitename>
<url>
scp://svn.baidu.com/banseon:/var/www/localhost/banseon-web
url>
site>
<downloadUrl />
<relocation>
<groupId />
<artifactId />
<version />
<message />
relocation>
<status />
distributionManagement>
<properties />
project>
5.使用优化
很多大团队都是组件化开发，虽然maven-publish作为插件设计较完善了，但是仍然可以进行一下包装，规范所有组件开发者的使用。
简单的，将在module的目录下新建一个gradle文件，命名为mavenpublish.gradle,该文件与module中的build.gradle文件同级。在新建的mavenpublish.gradle文件中将maven-publish的各项配置按2.1使用示例配置好。 各组件或新增组件在当前组件的build.gradle中可以apply from: 'mavenpublish.gradle’直接使用到发布特性。适用于多个开发人员使用一个大工程开发各自module的情况。
如果项目较大，组件较多，当然也可以把maven-publish包装为自己的gradle插件，自定义插件里包含工程必须配置的各种属性，如果repository都相同，可以设置默认值。可自定义自己的publishextension名字，简化到开发人员只需依赖插件，设置版本号等就好，能设置的默认配置都不需要更改，当然也提供复写默认配置的extention。
.