1. 创建AppGallery Connect项目及应用
在华为开发者联盟的AppGallery Connect控制台,创建项目及应用。
- 登录AppGallery Connect网站,点击"我的项目"。
- 进入项目管理页,并点击"+ 添加项目"。
- 在"创建项目"页面中输入项目名称,并点击"确认"。
- 在"项目设置"的"常规"页签中,点击"添加应用"。
- 在"添加应用"页面,根据应用实际情况"选择平台"、"支持设备",填写"应用名称"、"应用包名"、选择"应用分类"(应用、游戏)和"默认语言"。
- 应用创建成功后,可在"常规"页面"应用"信息下查看到系统分发给此应用的"APP ID"和"Client Secret"等信息。
2. 创建Android Studio工程
开发者通过Android Studio为应用创建一个新的工程,应用的名称和包名需和AppGallery Connect上填写的应用的名称和包名保持一致。
- 打开Android Studio工具,在Android Studio菜单栏,选择"File > New > New Project"创建一个新的工程。
- 在"Choose your project"中选"Empty Activity",然后点击"Next"。
- 在“Configure your project”中填写对应“Name”(应用名称与在AppGallery Connect上创建应用的名称一致)、“Package name”(包名与AppGallery Connect上创建应用的包名一致)、“Save location”(本地保存位置)、“Minimum API level”,然后点击“Finish”,完成应用的创建。
3. 生成签名证书
开发者通过Android Studio创建一个新的签名文件并使用其对APK进行签名。此签名文件后续会用于生成SHA256指纹。
- 在新建的Android Studio工程的菜单栏中选择"Build > Generate Signed Bundle/APK..."。
- 在"Generate Signed Bundle or APK"页面,选择"APK"签名,并点击"Next"。
- 在填写签名文件信息页面,如果已经存在签名文件,则点击"Choose existing..."选择签名文件,并填写对应签名文件的"Key store password"、"Key alias"、"Key password",然后点击"Next"。
如果不存在签名文件,则选择"Create new...",创建一个新的签名文件。
在创建新的签名文件页面,填写签名文件的保存地址以及保存文件名称、签名文件的密码、Alias等信息。
完成新签名文件创建后,在"Generate Signed Bundle or APK"弹出框页面上会显示对应签名文件的信息,然后点击"Next"。
- 在填写完签名信息页面点击"Next"后,出现选择签名方式页面,在此页面勾选"V1"和"V2"签名选项,并点击"Finish",生成一个签名APK(此APK可上传至AppGallery Connect用于自动获取应用包名)。
4. 生成签名证书指纹
开发者通过JDK的Keytool工具以及签名文件,导出SHA256指纹。
- Windows
a) 执行CMD命令打开命令行工具,执行cd命令进入keytool.exe所在的目录(以下样例为JDK安装在C盘的Program Files目录)。cd C:\Program Files\Java\jdk\bin
b) 执行命令keytool -list -v -keystore <keystore-file>,按命令行提示进行操作。<keystore-file>为应用签名证书的完整路径。
例如:keytool -list -v -keystore C:\TestApp.jks
c) 根据结果获取对应的SHA256指纹。
- macOS
a) 打开Terminal终端。
b) 执行命令keytool -list -v -keystore <keystore-file>,按命令行提示进行操作。<keystore-file>为应用签名证书的完整路径。
例如:
keytool -list -v -keystore /Users/admin/Downloads/HmsDemo.jks
c) 根据结果获取对应的SHA256指纹。
5. AppGallery Connect上添加指纹证书
开发者将生成的SHA256指纹配置到AppGallery Connect上。
- 登录AppGallery Connect网站,点击"我的项目"。
- 在项目列表中找到您的项目,在项目中点击需要配置签名证书指纹的应用。
- 在"项目设置 > 常规"页面的"应用"区域,点击"SHA256证书指纹"后的"添加证书指纹",输入生成的SHA256指纹。
- 配置完成后,点击"保存"。
6. AppGallery Connect上开通API服务
- 在项目的"应用"信息页面,选择"API管理"页签。
- 在"API管理"页签中,找到想要开通的服务,打开该服务所在行的开关。
7. 添加配置
添加当前应用的AppGallery Connect配置文件
- 登录AppGallery Connect网站,在“项目设置 > 常规”页面的“应用”区域,点击“agconnect-services.json”下载配置文件。
- 将“agconnect-services.json”文件拷贝到应用级根目录下。
配置HMS Core SDK的Maven仓地址
Android Studio的代码库配置在Gradle 插件7.0以下版本、7.0版本和7.1及以上版本有所不同。请根据您当前的Gradle 插件版本,选择对应的配置过程。7.0以下版本 | 7.0版本 | 7.1及以上版本 |
- 7.0以下版本
- 打开Android Studio项目级“build.gradle”文件。
- 添加HUAWEI agcp插件以及Maven代码库。
- 在“buildscript > repositories”中配置HMS Core SDK的Maven仓地址。
- 在“allprojects > repositories”中配置HMS Core SDK的Maven仓地址。
- 如果App中添加了“agconnect-services.json”文件则需要在“buildscript > dependencies”中增加agcp插件配置。
buildscript { repositories { google() jcenter() // 配置HMS Core SDK的Maven仓地址。 maven {url 'https://developer.huawei.com/repo/'} } dependencies { ... // 增加agcp插件配置,推荐您使用最新版本的agcp插件。 classpath 'com.huawei.agconnect:agcp:1.6.0.300' } } allprojects { repositories { google() jcenter() // 配置HMS Core SDK的Maven仓地址。 maven {url 'https://developer.huawei.com/repo/'} } }
- 打开Android Studio项目级“build.gradle”文件。
- 7.0版本
- 打开Android Studio项目级“build.gradle”文件。
- 添加HUAWEI agcp插件以及Maven代码库。
- 在“buildscript > repositories”中配置HMS Core SDK的Maven仓地址。
- 如果App中添加了“agconnect-services.json”文件则需要在“buildscript > dependencies”中增加agcp插件配置。
buildscript { repositories { google() jcenter() // 配置HMS Core SDK的Maven仓地址。 maven {url 'https://developer.huawei.com/repo/'} } dependencies { ... // 增加agcp插件配置,推荐您使用最新版本的agcp插件。 classpath 'com.huawei.agconnect:agcp:1.6.0.300' } }
- 打开项目级“settings.gradle”文件,配置HMS Core SDK的Maven仓地址。
dependencyResolutionManagement { ... repositories { google() jcenter() // 配置HMS Core SDK的Maven仓地址。 maven {url 'https://developer.huawei.com/repo/'} } }
- 打开Android Studio项目级“build.gradle”文件。
- 7.1及以上版本
- 打开Android Studio项目级“build.gradle”文件。
- 如果App中添加了“agconnect-services.json”文件则需要在“buildscript > dependencies”中增加agcp插件配置。
buildscript { dependencies { ... // 增加agcp插件配置,推荐您使用最新版本的agcp插件。 classpath 'com.huawei.agconnect:agcp:1.6.0.300' } }
- 打开项目级“settings.gradle”文件,配置HMS Core SDK的Maven仓地址。
pluginManagement { repositories { gradlePluginPortal() google() mavenCentral() // 配置HMS Core SDK的Maven仓地址。 maven { url 'https://developer.huawei.com/repo/' } } } dependencyResolutionManagement { ... repositories { google() mavenCentral() // 配置HMS Core SDK的Maven仓地址。 maven { url 'https://developer.huawei.com/repo/' } } }
- 打开Android Studio项目级“build.gradle”文件。
添加agcp插件配置
- 打开应用级的“build.gradle”文件(通常是 app/build.gradle)。
- 添加agcp插件配置。请根据实际情况选择:
- 方式一:在文件头部声明下一行添加如下配置。
apply plugin: 'com.huawei.agconnect'
- 方式二:在plugins中添加如下配置。
plugins { id 'com.android.application' // 添加如下配置 id 'com.huawei.agconnect' }
- 方式一:在文件头部声明下一行添加如下配置。
8. 配置项目签名
- 将已经生成的签名文件HmsDemo.jks拷贝到app文件夹下,并打开应用级build.gradle文件(通常是 app/build.gradle)。
- 在build.gradle文件的android闭包中添加签名配置信息。
signingConfigs { release { storeFile file('HmsDemo.jks') keyAlias 'hmsdemo' keyPassword '123456' storePassword '123456' v1SigningEnabled true v2SigningEnabled true } } buildTypes { release { signingConfig signingConfigs.release minifyEnabled false proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' } debug { signingConfig signingConfigs.release debuggable true } }
9. 同步工程
点击"Sync Now"同步工程。
completed successfully即代表同步成功,至此完成了集成准备工作。