创建和发布 Android 开发库的终极指南

相关术语介绍

在我们开始之前，还有一些术语，需要熟悉下。

项目Project  –  在 Android Studio 中，一个 项目 就是一个完整的 Android app。Android Studio 项目包含了一个或多个模块。 在 Android Studio 中，一个 项目 类似于在 Eclipse 的一个工作区间workspace。

模块Module – 一个 模块 是 app 中的一个组件，它可以单独的进行构建、测试和调试。模块包含了 app 的源代码和资源文件。在 Android Studio 中，一个 模块 类似于在 Eclipse 的一个项目。

AAR – ‘aar’ 套件是 Android 开发库项目的二进制的分发形式。（AAR 格式）开发库项目的主要产出就是 .aar 包（意思是 Android 压缩包）。它是由编译后的代码（如 jar 文件或者 .so 文件）和资源文件（如 manifest 文件、res 文件、asset 文件）组合而成的。

Maven 中央仓库 – 由 Maven 社区提供的仓库。它包含了很多我们常用的开发库。 Search Maven 网站可用来浏览 maven 中央仓库的内容。Gradle, Please 网站是另一个可用来搜索中央仓库的工具。如果你在项目配置文件的仓库配置部分添加了 jCenter() ，那么 Gradle 将使用 jCenter 仓库( jCenter 的说明)。Maven 中央仓库也经常被称作 Maven 中心或者中央仓库。

Sonatype — Sonatype的开源软件仓库托管（OSSRH）服务是项目作者和贡献者们发布他们的组件到中央仓库的主要途径。它是 Sonatype Nexus Professional 组织利用 Nexus Staging Suite 工具，对开源项目提供部署托管服务，该服务主要用来处理部署和验证操作，也提供同步操作将内容通过网络投递到中央仓库。

GPG – GNU 隐私保护组织 （也称为 GPG 或者 GnuPG），这个 GNU 项目是一个加密软件，遵循 OpenPGP （RFC4880）标准，是 PGP 的免费替代品。使用 GPG 你可以加密（解密）包含敏感数据的文件，比如那些由健康保险携带和责任法案 （HIPAA） 制定的受保护的隐私和安全方面的电子健康信息。想了解 GPG 的更多信息，请访问 GNU Privacy Guard website。

准备好你的 Android 开发库

我将使用我的 Trestle 开发库作例子来讲解。在你的项目中，需要修改一些地方，来准备作为一个开发库发布到 Maven 中央仓库中。

将开发库的核心代码和示例代码区分开来。在我的项目中，我将他们分成 library 和 sample 两个模块。请仔细阅读关于创建一个开发库模块的技巧。你也可能需要重命名你的模块。

在 sample 模块的 build.gradle 文件中，请确保包含以下内容：



    

  1. apply plugin: 'com.android.application'
    2. 

  2. dependencies {
    3. 

  3.     compile project(':library')
    4. 

  4. }
    5. 



在 library 模块的 build.gradle 文件中，请确保包含以下内容： 




    

  1. apply plugin: 'com.android.library'
    2. 

  2. apply from: 'maven-push.gradle'
    3. 



在 library 模块中，增加 gradle.properties 文件，请确保在该文件中包含以下内容：




    

  1. POM_NAME=ProjectName
    2. 

  2. POM_ARTIFACT_ID=projectname
    3. 

  3. POM_PACKAGING=aar
    4. 



在 library 模块中，增加 maven-push.gradle 文件，请确保在该文件中包含以下内容： 




    

  1. /*
    2. 

  2.  * Copyright 2013 Chris Banes
    3. 

  3.  *
    4. 

  4.  * Licensed under the Apache License, Version 2.0 (the "License");
    5. 

  5.  * you may not use this file except in compliance with the License.
    6. 

  6.  * You may obtain a copy of the License at
    7. 

  7.  *
    8. 

  8.  *     http://www.apache.org/licenses/LICENSE-2.0
    9. 

  9.  *
    10. 

  10.  * Unless required by applicable law or agreed to in writing, software
    11. 

  11.  * distributed under the License is distributed on an "AS IS" BASIS,
    12. 

  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13. 

  13.  * See the License for the specific language governing permissions and
    14. 

  14.  * limitations under the License.
    15. 

  15.  */
    16. 

  16.  
    17. 

  17. apply plugin: 'maven'
    18. 

  18. apply plugin: 'signing'
    19. 

  19.  
    20. 

  20. def isReleaseBuild() {
    21. 

  21.     return VERSION_NAME.contains("SNAPSHOT") == false
    22. 

  22. }
    23. 

  23.  
    24. 

  24. def getReleaseRepositoryUrl() {
    25. 

  25.     return hasProperty('RELEASE_REPOSITORY_URL') ? RELEASE_REPOSITORY_URL
    26. 

  26.             : "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
    27. 

  27. }
    28. 

  28.  
    29. 

  29. def getSnapshotRepositoryUrl() {
    30. 

  30.     return hasProperty('SNAPSHOT_REPOSITORY_URL') ? SNAPSHOT_REPOSITORY_URL
    31. 

  31.             : "https://oss.sonatype.org/content/repositories/snapshots/"
    32. 

  32. }
    33. 

  33.  
    34. 

  34. def getRepositoryUsername() {
    35. 

  35.     return hasProperty('NEXUS_USERNAME') ? NEXUS_USERNAME : ""
    36. 

  36. }
    37. 

  37.  
    38. 

  38. def getRepositoryPassword() {
    39. 

  39.     return hasProperty('NEXUS_PASSWORD') ? NEXUS_PASSWORD : ""
    40. 

  40. }
    41. 

  41.  
    42. 

  42. afterEvaluate { project ->
    43. 

  43.     uploadArchives {
    44. 

  44.         repositories {
    45. 

  45.             mavenDeployer {
    46. 

  46.                 beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }
    47. 

  47.  
    48. 

  48.                 pom.groupId = GROUP
    49. 

  49.                 pom.artifactId = POM_ARTIFACT_ID
    50. 

  50.                 pom.version = VERSION_NAME
    51. 

  51.  
    52. 

  52.                 repository(url: getReleaseRepositoryUrl()) {
    53. 

  53.                     authentication(userName: getRepositoryUsername(), password: getRepositoryPassword())
    54. 

  54.                 }
    55. 

  55.                 snapshotRepository(url: getSnapshotRepositoryUrl()) {
    56. 

  56.                     authentication(userName: getRepositoryUsername(), password: getRepositoryPassword())
    57. 

  57.                 }
    58. 

  58.  
    59. 

  59.                 pom.project {
    60. 

  60.                     name POM_NAME
    61. 

  61.                     packaging POM_PACKAGING
    62. 

  62.                     description POM_DESCRIPTION
    63. 

  63.                     url POM_URL
    64. 

  64.  
    65. 

  65.                     scm {
    66. 

  66.                         url POM_SCM_URL
    67. 

  67.                         connection POM_SCM_CONNECTION
    68. 

  68.                         developerConnection POM_SCM_DEV_CONNECTION
    69. 

  69.                     }
    70. 

  70.  
    71. 

  71.                     licenses {
    72. 

  72.                         license {
    73. 

  73.                             name POM_LICENCE_NAME
    74. 

  74.                             url POM_LICENCE_URL
    75. 

  75.                             distribution POM_LICENCE_DIST
    76. 

  76.                         }
    77. 

  77.                     }
    78. 

  78.  
    79. 

  79.                     developers {
    80. 

  80.                         developer {
    81. 

  81.                             id POM_DEVELOPER_ID
    82. 

  82.                             name POM_DEVELOPER_NAME
    83. 

  83.                         }
    84. 

  84.                     }
    85. 

  85.                 }
    86. 

  86.             }
    87. 

  87.         }
    88. 

  88.     }
    89. 

  89.  
    90. 

  90.     signing {
    91. 

  91.         required { isReleaseBuild() && gradle.taskGraph.hasTask("uploadArchives") }
    92. 

  92.         sign configurations.archives
    93. 

  93.     }
    94. 

  94.  
    95. 

  95.     //task androidJavadocs(type: Javadoc) {
    96. 

  96.     //source = android.sourceSets.main.allJava
    97. 

  97.     //}
    98. 

  98.  
    99. 

  99.     //task androidJavadocsJar(type: Jar, dependsOn: androidJavadocs) {
    100. 

  100.     //classifier = 'javadoc'
    101. 

  101.     //from androidJavadocs.destinationDir
    102. 

  102.     //}
    103. 

  103.  
    104. 

  104.     task androidSourcesJar(type: Jar) {
    105. 

  105.         classifier = 'sources'
    106. 

  106.         from android.sourceSets.main.java.sourceFiles
    107. 

  107.     }
    108. 

  108.  
    109. 

  109.     artifacts {
    110. 

  110.         archives androidSourcesJar
    111. 

  111.     }
    112. 

  112. }
    113. 



修改在项目根目录的 .gitignore 文件 




    

  1. # [Android] ========================
    2. 

  2. # Built application files
    3. 

  3. *.apk
    4. 

  4. *.ap_
    5. 

  5.  
    6. 

  6. # Files for the Dalvik VM
    7. 

  7. *.dex
    8. 

  8.  
    9. 

  9. # Java class files
    10. 

  10. *.class
    11. 

  11.  
    12. 

  12. # Generated files
    13. 

  13. bin/
    14. 

  14. gen/
    15. 

  15.  
    16. 

  16. # Gradle files
    17. 

  17. .gradle/
    18. 

  18. build/
    19. 

  19.  
    20. 

  20. # Local configuration file (sdk path, etc)
    21. 

  21. local.properties
    22. 

  22.  
    23. 

  23. # Proguard folder generated by Eclipse
    24. 

  24. proguard/
    25. 

  25.  
    26. 

  26. # Log Files
    27. 

  27. *.log
    28. 

  28.  
    29. 

  29. ## Directory-based project format:
    30. 

  30. .idea/
    31. 

  31.  
    32. 

  32. ## File-based project format:
    33. 

  33. *.ipr
    34. 

  34. *.iws
    35. 

  35.  
    36. 

  36. ## Plugin-specific files:
    37. 

  37.  
    38. 

  38. # IntelliJ
    39. 

  39. out/
    40. 

  40.  
    41. 

  41. # mpeltonen/sbt-idea plugin
    42. 

  42. .idea_modules/
    43. 

  43.  
    44. 

  44. # JIRA plugin
    45. 

  45. atlassian-ide-plugin.xml
    46. 

  46.  
    47. 

  47. # Crashlytics plugin (for Android Studio and IntelliJ)
    48. 

  48. com_crashlytics_export_strings.xml
    49. 

  49.  
    50. 

  50. # [Maven] ========================
    51. 

  51. target/
    52. 

  52. pom.xml.tag
    53. 

  53. pom.xml.releaseBackup
    54. 

  54. pom.xml.versionsBackup
    55. 

  55. pom.xml.next
    56. 

  56. release.properties
    57. 

  57.  
    58. 

  58. # [Gradle-Android] ========================
    59. 

  59.  
    60. 

  60. # Ignore Gradle GUI config
    61. 

  61. gradle-app.setting
    62. 

  62.  
    63. 

  63. # Gradle Signing
    64. 

  64. signing.properties
    65. 

  65. trestle.keystore
    66. 

  66.  
    67. 

  67. # Mobile Tools for Java (J2ME)
    68. 

  68. .mtj.tmp/
    69. 

  69.  
    70. 

  70. # Package Files #
    71. 

  71. *.jar
    72. 

  72. *.war
    73. 

  73. *.ear
    74. 

  74.  
    75. 

  75. # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
    76. 

  76. hs_err_pid*
    77. 

  77.  
    78. 

  78. # Misc
    79. 

  79. /.idea/workspace.xml
    80. 

  80. .DS_Store
    81. 

  81. /captures
    82. 

  82. **/*.iml
    83. 

  83. *.class
    84. 



修改在项目根目录的 settings.gradle 文件 




    

  1. include ':sample', ':library'
    2. 



修改在项目根目录的 gradle.properties 文件




    

  1. # Project-wide Gradle settings.
    2. 

  2.  
    3. 

  3. # IDE (e.g. Android Studio) users:
    4. 

  4. # Gradle settings configured through the IDE *will override*
    5. 

  5. # any settings specified in this file.
    6. 

  6.  
    7. 

  7. # For more details on how to configure your build environment visit
    8. 

  8. # http://www.gradle.org/docs/current/userguide/build_environment.html
    9. 

  9.  
    10. 

  10. # Specifies the JVM arguments used for the daemon process.
    11. 

  11. # The setting is particularly useful for tweaking memory settings.
    12. 

  12. # Default value: -Xmx10248m -XX:MaxPermSize=256m
    13. 

  13. # org.gradle.jvmargs=-Xmx2048m -XX:MaxPermSize=512m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8
    14. 

  14.  
    15. 

  15. # When configured, Gradle will run in incubating parallel mode.
    16. 

  16. # This option should only be used with decoupled projects. More details, visit
    17. 

  17. # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
    18. 

  18. # org.gradle.parallel=true
    19. 

  19.  
    20. 

  20. VERSION_NAME=0.0.1
    21. 

  21. VERSION_CODE=1
    22. 

  22. GROUP=com.github.github_username
    23. 

  23.  
    24. 

  24. POM_DESCRIPTION=A library that does X, Y, and Z
    25. 

  25. POM_URL=https://github.com/github_username/ProjectName
    26. 

  26. POM_SCM_URL=https://github.com/github_username/ProjectName
    27. 

  27. POM_SCM_CONNECTION=scm:git@github.com:github_username/ProjectName.git
    28. 

  28. POM_SCM_DEV_CONNECTION=scm:git@github.com:github_username/ProjectName.git
    29. 

  29. POM_LICENCE_NAME=The Apache Software License, Version 2.0
    30. 

  30. POM_LICENCE_URL=http://www.apache.org/licenses/LICENSE-2.0.txt
    31. 

  31. POM_LICENCE_DIST=repo
    32. 

  32. POM_DEVELOPER_ID=github_username
    33. 

  33. POM_DEVELOPER_NAME=GitHub FullName
    34. 



增加 README.md 文件，向其他开发者介绍你的开发库以及如何使用它。如果你想在你的 README.md 文件中增加些截图，我极力推荐一款叫做Screenr的app。 


安装 GPG


如果你的机器上还没安装 GPG，你需要下载安装它。如果你是 MacOSX 系统，安装手册在这里。


如果你从未使用过 GPG – 首先，请创建 GPG 密钥：




    

  1. $ gpg --gen-key
    2. 



接下来，找到你的密钥 ID：在你创建 GPG 密钥的时候，如果你不确定该如何回答问题， 这篇指南（Creating an encryption key）可以帮上忙。




    

  1. $ gpg --list-keys
    2. 



现在，发布你的密钥：第一行像是 pub XXXXX/YYYYYYYY <日期>的。切记，’YYYYYYYY’ 部分，就是你的密钥 ID。




    

  1. $ gpg --keyserver hkp://keyserver.ubuntu.com --send-keys YYYYYYYY
    2. 

  2. $ gpg --keyserver hkp://pgp.mit.edu --send-keys YYYYYYYY
    3. 



你当然也可以使用其他密钥服务器，你也可以通过如下命令确认你的密钥是否已经发布：




    

  1. $ gpg --keyserver hkp://pgp.mit.edu --search-keys johndoe@example.com # 使用你的邮箱
    2. 



为了使你的开发库在 Gradle, Please网站上列出（也为了其他人方便的引用你的开发库），请上传你的项目到 Maven Central。 最简单的上传项目的方法是使用 Sonatype。


Sonatype


    

  1. 在Sonatype 创建一个 JIRA 帐号。
    2. 

  2. 登录成功后，创建一个 new issue。
    3. 





我为我的 Trestle 项目创建了一个 GitHub 仓库。所以我在 new issue 上填写的字段大概如此：


Group Id : com.github.<github_username>


Project URL : https://github.com/<github_username>/<project_name>


SCM url : https://github.com/<github_username>/<project_name>.git


Username : <sonatype_username>


Already Synced to Central : No


注意：我在你需要填写的字段上增加了括号作为占位符。你需要将它们替换成合适的值。


当你准备提交 issue 的时候，issue 的细节应该要和上面的截图差不多。当你提交完成后，Sonatype 将用 2 个工作日来处理你的 issue。接着，你将收到一份确认邮件，告知你的配置已经准备好了，你可以发布你的开源库了。


不要部署你的开源库，直到你接收到一封表明你的票据已经 OK 了的邮件。 对新项目来说，一个通病就是过早的部署。这将会误使你的构件（artifacts）变成一个人人都能获得的仓库。


最后，如果你的组件已经在中央仓库中了，请在你的票据中添加以下信息，并参考这篇文章，如何迁移到 OSSRH。


修改你本机上的 ~/.gradle/gradle.properties 文件，包含以下内容：




    

  1. NEXUS_USERNAME=sonatype_username
    2. 

  2. NEXUS_PASSWORD=sonatype_password
    3. 

  3. signing.keyId=gpg_key_id 
    4. 

  4. signing.password=gpg_password
    5. 

  5. signing.secretKeyRingFile=/Users/username/.gnupg/secring.gpg
    6. 

  6. org.gradle.daemon=true
    7. 



当你发布开发库的时候，身份认证信息已经在 gradle.properties 文件中提供了。请确保提供了正确的 nexus 用户名和密码（也就是 Sonatype 的用户名和密码），否则你将得到未授权的 401 错误。


注意：如果你之前已经发布过一个开发库，那么你不需要在 JIRA（Sonatype） 上创建一个新的 issue。每个顶级的 groupId 对应一个 JIRA issue。你应该已经有了部署任何新构件到你的 groupId 或者下属 group 应需要的所有权限。中央仓库的同步操作遵循从上到下的过程，所以任何下属组的发布版本都将会自动同步。当你发布新组件，你不需要告诉 Sonatype，因为当你进行仓库同步工作的时候，没有什么需要 Sonatype 去配置或者检查的， Sonatype 仅仅会在第一次进行同步操作的时候，发布一条 twitter。


发布


一旦你准备发布你的开发库，在 Android Studio 中， 打开右侧的 Gradle 视图，在 Tasks> upload 下，点击 uploadArchives，将会上传你的开发库到 Sonatype Staging Repositories。




在 Sonatype Staging Repositories 网页上，登陆你的 Sonatype 账号，查找你的 “staging” 开发库，它应该在列表的最后，选中它，并按下 “关闭” 按钮。关闭一个开发库实际上意味着你准备发布它。如果关闭操作一切顺利 – 你应该会看到一个激活了的 ‘发布’ 按钮。你可能需要刷新下页面。请按下发布按钮。请阅读关于使用 Nexus 管理仓库的帮助文档。如果这是你发布的第一个开发库，返回到 JIRA，在 JIRA 上发表一条你已经改进了你的开发库的评论，如果不是第一个，就没必要告诉 Sonatype 你改进了你的开发库。然后，你应该会收到来自 Sonatype 的一条回复信息，信息上说你的开发库在 10 分钟内能准备好，将会在接下来的几个小时同步到 Maven 中央仓库。几个小时之后，它将展示在 Gradle, Please 网站上。


原文发布时间为：2016-05-28


本文来自合作伙伴“Linux中国”
				


				
时间： 2024-08-03 23:42:58

		
		


		


	

	
	

		


		
创建和发布 Android 开发库的终极指南的相关文章


								

		

			

                【我的Android进阶之旅】快速创建和根据不同的版本类型（Dev、Beta、Release）发布Android 开发库到Maven私服
			

		

		

									
				
							
						

				前言 由于项目越来越多,有很多公共的代码都可以抽取出一个开发库出来传到公司搭建好的Maven私服,以供大家使用. 之前搭建的Maven仓库只有Release和Snapshot两个仓库,最近由于开发库有时候不稳定有bug,不便于测试.因此领导说要搭建三个版本的仓库,分别为Release版本.Beta版本.Dev版本,Snapshot版本废弃掉,下面来分别介绍下这三个版本仓库的意义. Dev版本:是用于开发库维护人员能够很快的新增代码并上传到Maven仓库,这样其他开发人员就能够很快的获取该Dev版			

		

	

				

		

			

                OpenGL ES 在 Android 开发库中 - 能不能再牛点儿
			

		

		

									

				OpenGL ES 在 Android 开发库中 - 能不能再牛点儿 太阳火神的美丽人生 (http://blog.csdn.net/opengl_es) 本文遵循"署名-非商业用途-保持一致"创作公用协议 转载请保留此句:太阳火神的美丽人生 -  本博客专注于 敏捷开发及移动和物联设备研究:iOS.Android.Html5.Arduino.pcDuino,否则,出自本博客的文章拒绝转载或再转载,谢谢合作. Android 开发库中突然发现这些个东西,原来和原生的函数名一模一样,而且			

		

	

				

		

			

                我的Android进阶之旅】GitHub 上排名前 100 的 Android 开源库进行简单的介绍
			

		

		

									

				GitHub Android Libraries Top 100 简介 本文转载于:https://github.com/Freelander/Android_Data/blob/master/Android-Librarys-Top-100.md 本项目主要对目前 GitHub 上排名前 100 的 Android 开源库进行简单的介绍, 至于排名完全是根据 GitHub 搜索 Java 语言选择 (Best Match) 得到的结果, 然后过滤了跟 Android 不相关的项目, 所以排名并			

		

	

				

		

			

                Android开发入门系列
			

		

		

									

				Android开发入门(二十)内容提供者 20.3 经过预定义的查询字符 Android开发入门(二十)内容提供者 20.2 ContentProvider的使用 Android开发入门(二十)内容提供者 20.1 数据共享 Android开发入门(十九)数据库 19.3 预创建数据库 Android开发入门(十九)数据库 19.2 使用数据库 Android开发入门(十九)数据库 19.1创建数据库辅助类 Android开发入门(十八)文件 18.4使用静态资源 Android开发入门(十八)			

		

	

				

		

			

                【Java编码规范】《阿里巴巴Java开发手册》终极版更新，在线代码检测及IDE插件发布
			

		

		

									

				        -------------- 2017.10.14更新 -------------- <阿里巴巴Java开发手册(终极版)>正式发布,这是史上内容最全.修正最为彻底的一个版本,并且增加了单元测试规约内容,这也是阿里官方对外发布的最后一个PDF版本,值得收藏.   <阿里巴巴Java开发手册>是阿里内部Java工程师所遵循的开发规范,涵盖编程规约.单元测试规约.异常日志规约.MySQL规约.工程规约.安全规约等,这是近万名阿里Java技术精英的经验总结,并经历了多次大			

		

	

				

		

			

                Android开发之常用开源库直接拿来用
			

		

		

									

				1.from  代码家 整理比较好的源码连接 *************************************************************************************************************************************************************************** http://blog.zhan-dui.com/?page_id=60 感谢 "代码家"整理 一.			

		

	

				

		

			

                《Android应用开发从入门到精通》——第2章，第2.3节创建第一个Android项目
			

		

		

									

				2.3 创建第一个Android项目 Android应用开发从入门到精通 2.3.1 创建新项目 打开Eclipse,选择 File→New→Android Application Project.如果没有Android Application Project这一条,这时可以选择Other找到Android Application Project. 进入New Project对话框,分别进行如下设置,如图2.7所示. 词条解释如下. Project Name 包含这个项目的资料夹的名称. App			

		

	

				

		

			

                Android开发权威指南（第2版）新书发布（免费下载随书光盘内容，包括Android源代码）
			

		

		

									

				光盘内容下载 光盘内容下载(新浪微盘) Android4.2.2(CM ROM)源代码下载 如果需要虚拟环境的,这里提供了ubuntu10.04 LTS版本,不需要CPU支持虚拟化(VirtualBox版[VirtualBox-4.2.10-84105]) Ubuntu10.04 VirtualBox版 分卷1 分卷2 分卷3 分卷4 分卷5 分卷6   用户名:root 秘密:12345678   <Android开发权威指南(第二版)>是畅销书<Android开发权威指南>的升			

		

	

				

		

			

                android开发问题-搭建好Android开发环境后创建helloworld出错，求帮助
			

		

		

									

				问题描述 搭建好Android开发环境后创建helloworld出错,求帮助 解决方案 上面appcompat_v7是附带的不用改 等等就可以了,主项目有 红色感叹号,可以先右键项目,选择Build path,再选最后一项Configure Build path...弹出个框后 选择Libraries 下面应该有个是打了叉的 点击那条,remove掉