Android开发必知的maven-publish插件知识

最新推荐文章于 2024-08-31 07:22:51 发布

Zephyr Cai

最新推荐文章于 2024-08-31 07:22:51 发布

阅读量3.7k

点赞数

分类专栏： android工具文章标签： android maven gradle

本文链接：https://blog.csdn.net/caizehui/article/details/125956142

版权

本文详细介绍了Android开发中maven-publish插件的使用，包括发布过程、任务解读、Pom知识及优化策略。通过实例演示了如何配置插件，解析了发布任务和仓库设置，强调了POM文件在组件发布中的作用，以及如何优化组件发布的流程。

摘要由CSDN通过智能技术生成

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">
    <!--父项目的坐标。如果项目中没有规定某个元素的值，那么父项目中的对应值即为项目的默认值。 坐标包括group ID，artifact ID和 
        version。 -->
    <parent>
        <!--被继承的父项目的构件标识符 -->
        <artifactId />
        <!--被继承的父项目的全球唯一标识符 -->
        <groupId />
        <!--被继承的父项目的版本 -->
        <version />
        <!-- 父项目的pom.xml文件的相对路径。相对路径允许你选择一个不同的路径。默认值是../pom.xml。Maven首先在构建当前项目的地方寻找父项 
            目的pom，其次在文件系统的这个位置（relativePath位置），然后在本地仓库，最后在远程仓库寻找父项目的pom。 -->
        <relativePath />
    </parent>
    <!--声明项目描述符遵循哪一个POM模型版本。模型本身的版本很少改变，虽然如此，但它仍然是必不可少的，这是为了当Maven引入了新的特性或者其他模型变更的时候，确保稳定性。 -->
    <modelVersion>4.0.0</modelVersion>
    <!--项目的全球唯一标识符，通常使用全限定的包名区分该项目和其他项目。并且构建时生成的路径也是由此生成， 如com.mycompany.app生成的相对路径为：/com/mycompany/app -->
    <groupId>asia.banseon</groupId>
    <!-- 构件的标识符，它和group ID一起唯一标识一个构件。换句话说，你不能有两个不同的项目拥有同样的artifact ID和groupID；在某个 
        特定的group ID下，artifact ID也必须是唯一的。构件是项目产生的或使用的一个东西，Maven为项目产生的构件包括：JARs，源 码，二进制发布和WARs等。 -->
    <artifactId>banseon-maven2</artifactId>
    <!--项目产生的构件类型，例如jar、war、ear、pom。插件可以创建他们自己的构件类型，所以前面列的不是全部构件类型 -->
    <packaging>jar</packaging>
    <!--项目当前版本，格式为:主版本.次版本.增量版本-限定版本号 -->
    <version>1.0-SNAPSHOT</version>
    <!--项目的名称, Maven产生的文档用 -->
    <name>banseon-maven</name>
    <!--项目主页的URL, Maven产生的文档用 -->
    <url>http://www.baidu.com/banseon</url>
    <!-- 项目的详细描述, Maven 产生的文档用。 当这个元素能够用HTML格式描述时（例如，CDATA中的文本会被解析器忽略，就可以包含HTML标 
        签）， 不鼓励使用纯文本描述。如果你需要修改产生的web站点的索引页面，你应该修改你自己的索引页文件，而不是调整这里的文档。 -->
    <description>A maven project to study maven.</description>
    <!--描述了这个项目构建环境中的前提条件。 -->
    <prerequisites>
        <!--构建该项目或使用该插件所需要的Maven的最低版本 -->
        <maven />
    </prerequisites>
    <!--项目的问题管理系统(Bugzilla, Jira, Scarab,或任何你喜欢的问题管理系统)的名称和URL，本例为 jira -->
    <issueManagement>
        <!--问题管理系统（例如jira）的名字， -->
        <system>jira</system>
        <!--该项目使用的问题管理系统的URL -->
        <url>http://jira.baidu.com/banseon</url>
    </issueManagement>
    <!--项目持续集成信息 -->
    <ciManagement>
        <!--持续集成系统的名字，例如continuum -->
        <system />
        <!--该项目使用的持续集成系统的URL（如果持续集成系统有web接口的话）。 -->
        <url />
        <!--构建完成时，需要通知的开发者/用户的配置项。包括被通知者信息和通知条件（错误，失败，成功，警告） -->
        <notifiers>
            <!--配置一种方式，当构建中断时，以该方式通知用户/开发者 -->
            <notifier>
                <!--传送通知的途径 -->
                <type />
                <!--发生错误时是否通知 -->
                <sendOnError />
                <!--构建失败时是否通知 -->
                <sendOnFailure />
                <!--构建成功时是否通知 -->
                <sendOnSuccess />
                <!--发生警告时是否通知 -->
                <sendOnWarning />
                <!--不赞成使用。通知发送到哪里 -->
                <address />
                <!--扩展配置项 -->
                <configuration />
            </notifier>
        </notifiers>
    </ciManagement>
    <!--项目创建年份，4位数字。当产生版权信息时需要使用这个值。 -->
    <inceptionYear />
    <!--项目相关邮件列表信息 -->
    <mailingLists>
        <!--该元素描述了项目相关的所有邮件列表。自动产生的网站引用这些信息。 -->
        <mailingList>
            <!--邮件的名称 -->
            <name>Demo</name>
            <!--发送邮件的地址或链接，如果是邮件地址，创建文档时，mailto: 链接会被自动创建 -->
            <post>banseon@126.com</post>
            <!--订阅邮件的地址或链接，如果是邮件地址，创建文档时，mailto: 链接会被自动创建 -->
            <subscribe>banseon@126.com</subscribe>
            <!--取消订阅邮件的地址或链接，如果是邮件地址，创建文档时，mailto: 链接会被自动创建 -->
            <unsubscribe>banseon@126.com</unsubscribe>
            <!--你可以浏览邮件信息的URL -->
            <archive>http:/hi.baidu.com/banseon/demo/dev/</archive>
        </mailingList>
    </mailingLists>
    <!--项目开发者列