文档管理中心

集成HMS Core SDK

针对Android Studio开发环境,华为提供了Maven仓集成方式的HMS Core SDK包。在开始开发前,您需要将HMS Core SDK集成到您的Android Studio开发环境中。

添加当前应用的AppGallery Connect配置文件

如果在AppGallery Connect中开通了相关服务则需要将“agconnect-services.json”文件添加到您的App中。

  1. 登录AppGallery Connect网站,点击“我的项目”
  2. 在项目列表中找到您的项目,在项目中点击需要集成HMS Core SDK的应用。
  3. 项目设置 > 常规页面的“应用”区域,点击“agconnect-services.json”下载配置文件。

  4. “agconnect-services.json”文件拷贝到应用级根目录下。

配置HMS Core SDK的Maven仓地址

Android Studio的代码库配置在Gradle插件7.0以下版本、7.0版本和7.1及以上版本有所不同。请根据您当前的Gradle插件版本,选择对应的配置过程。

说明

Maven仓地址无法直接在浏览器中打开访问,只能在IDE中配置。如需添加多个Maven代码库,请将华为公司的Maven仓地址配置在最后。

  • 7.0以下版本
    1. 打开Android Studio项目级“build.gradle”文件。

    2. 添加HUAWEI AGC插件以及Maven代码库。
      • buildscript > repositories中配置HMS Core SDK的Maven仓地址。
      • allprojects > repositories中配置HMS Core SDK的Maven仓地址。
      • 如果App中添加了“agconnect-services.json”文件则需要在buildscript > dependencies中增加AGC插件配置。
      收起
      自动换行
      深色代码主题
      复制
      1. buildscript {
      2. repositories {
      3. google()
      4. jcenter()
      5. // 配置HMS Core SDK的Maven仓地址。
      6. maven {url 'https://developer.huawei.com/repo/'}
      7. }
      8. dependencies {
      9. ...
      10. // 增加AGC插件配置,请您参见AGC插件依赖关系选择合适的AGC插件版本。
      11. classpath 'com.huawei.agconnect:agcp:
        1.6.0.300
        '
      12. }
      13. }
      14. allprojects {
      15. repositories {
      16. google()
      17. jcenter()
      18. // 配置HMS Core SDK的Maven仓地址。
      19. maven {url 'https://developer.huawei.com/repo/'}
      20. }
      21. }
  • 7.0版本
    1. 打开Android Studio项目级“build.gradle”文件。

    2. 添加HUAWEI AGC插件以及Maven代码库。
      • buildscript > repositories中配置HMS Core SDK的Maven仓地址。
      • 如果App中添加了“agconnect-services.json”文件则需要在buildscript > dependencies中增加AGC插件和Android Gradle插件配置。
      收起
      自动换行
      深色代码主题
      复制
      1. buildscript {
      2. repositories {
      3. google()
      4. jcenter()
      5. // 配置HMS Core SDK的Maven仓地址。
      6. maven {url 'https://developer.huawei.com/repo/'}
      7. }
      8. dependencies {
      9. ...
      10. // 增加Android Gradle插件版本号配置,{version}为实际的Gradle插件版本号,例如7.0.1。
      11. classpath 'com.android.tools.build:gradle:
        {version}
        '
      12. // 增加AGC插件配置,请您参见AGC插件依赖关系选择合适的AGC插件版本。
      13. classpath 'com.huawei.agconnect:agcp:
        1.6.0.300
        '
      14. }
      15. }
    3. 打开项目级“settings.gradle”文件,配置HMS Core SDK的Maven仓地址。
      收起
      自动换行
      深色代码主题
      复制
      1. dependencyResolutionManagement {
      2. ...
      3. repositories {
      4. google()
      5. jcenter()
      6. // 配置HMS Core SDK的Maven仓地址。
      7. maven {url 'https://developer.huawei.com/repo/'}
      8. }
      9. }
  • 7.1及以上版本
    1. 打开Android Studio项目级“build.gradle”文件。

    2. 如果App中添加了“agconnect-services.json”文件则需要在buildscript > dependencies中增加AGC插件和Android Gradle插件配置。
      收起
      自动换行
      深色代码主题
      复制
      1. buildscript {
      2. dependencies {
      3. ...
      4. // 增加Android Gradle插件版本号配置,{version}为实际的Gradle插件版本号,例如7.1.1。
      5. classpath 'com.android.tools.build:gradle:
        {version}
        '
      6. // 增加AGC插件配置,请您参见AGC插件依赖关系选择合适的AGC插件版本。
      7. classpath 'com.huawei.agconnect:agcp:
        1.6.0.300
        '
      8. }
      9. }
      10. plugins {
      11. ...
      12. }
    3. 打开项目级“settings.gradle”文件,配置HMS Core SDK的Maven仓地址。
      收起
      自动换行
      深色代码主题
      复制
      1. pluginManagement {
      2. repositories {
      3. gradlePluginPortal()
      4. google()
      5. mavenCentral()
      6. // 配置HMS Core SDK的Maven仓地址。
      7. maven { url 'https://developer.huawei.com/repo/' }
      8. }
      9. }
      10. dependencyResolutionManagement {
      11. ...
      12. repositories {
      13. google()
      14. mavenCentral()
      15. // 配置HMS Core SDK的Maven仓地址。
      16. maven { url 'https://developer.huawei.com/repo/' }
      17. }
      18. }

添加编译依赖

  1. 打开应用级的“build.gradle”文件。

  2. 在build.gradle文件中增加如下配置。
    收起
    自动换行
    深色代码主题
    复制
    1. compileOptions {
    2. sourceCompatibility = 1.8
    3. targetCompatibility = 1.8
    4. }
  3. 在“dependencies”中添加如下编译依赖,{version}需要替换为实际的SDK版本号,版本号索引请参见版本更新说明。如当前版本:implementation 'com.huawei.hms:awareness:3.1.0.300'。
    收起
    自动换行
    深色代码主题
    复制
    1. dependencies{
    2. implementation 'com.huawei.hms:awareness:{version}'
    3. }
    说明

    Awareness SDK 1.0.2及之前的版本已经下架,填写实际的SDK版本号时请不要填写已经下架的版本号。

  4. 添加AGC插件配置。请根据实际情况选择:
    • 方式一:在文件头部声明下一行添加如下配置。
      收起
      自动换行
      深色代码主题
      复制
      1. apply plugin: 'com.huawei.agconnect'
    • 方式二:在plugins中添加如下配置。
      收起
      自动换行
      深色代码主题
      复制
      1. plugins {
      2. id 'com.android.application'
      3. // 添加如下配置
      4. id 'com.huawei.agconnect'
      5. }

同步工程

在完成以上的配置后,点击工具栏中的gradle同步图标,完成“build.gradle”文件的同步,将相关依赖下载到本地。

说明

如果出现错误,请检查网络连接是否正常,以及检查“build.gradle”文件是否正确。

在 指南 中进行搜索
请输入您想要搜索的关键词