Skip to main content
Version: v4

Android 原生集成

本文介绍如何在 Android 项目中快速接入 TapSDK 。

环境要求

Android 5.0(API level 21)或更高版本, 当使用 Kotlin 时,需确保使用 1.7.21 或更高版本

编译工具链

Android 一般通过 Gradle & AGP 进行构建,所以对于 Android 项目,需要确保 Gradle 和 AGP 的版本与 SDK 兼容,SDK 对应版本要求如下:

  • GRADLE_VERSION: 6.1.1+
  • AGP_VERSION: 4.0.1+

SDK 获取

  1. 项目根目录的 build.gradle 添加仓库地址:
allprojects {
repositories {
google()
mavenCentral()
}
}
  1. app module 的 build.gradle 添加对应模块依赖(如:登录以及内嵌动态):
dependencies {
implementation 'com.taptap.sdk:tap-core:4.9.3'
}
  1. AndroidManifest.xml 添加网络权限:
<uses-permission android:name="android.permission.INTERNET"></uses-permission>
  1. 旧版 Android 额外配置

    如果 targetSdkVersion < 29,还需要添加如下配置:

    • manifest 节点添加 xmlns:tools="http://schemas.android.com/tools"
    • application 节点添加 tools:remove="android:requestLegacyExternalStorage"

初始化

info

游戏 适用地区 在开启应用配置时选定。

新版 SDK 采用统一初始化机制,初始化时需设置 Client ID、clientToken、区域等应用配置信息,完成后即可直接使用所有业务模块(如登录、成就等),无需对各模块分别初始化。

import com.taptap.sdk.core.TapTapRegion;
import com.taptap.sdk.core.TapTapSdk;
import com.taptap.sdk.core.TapTapSdkOptions;

TapTapSdkOptions tapSdkOptions = new TapTapSdkOptions(
"clientId", // 开发者中心对应的游戏 Client ID
"clientToken", // 开发者中心对应 游戏 Client Token
TapTapRegion.CN // 游戏可玩区域: [TapTapRegion.CN]=国内 [TapTapRegion.GLOBAL]=海外
);
// 设置屏幕方向,ScreenOrientation.LANDSCAPE 或 1 横屏, ScreenOrientation.PORTRAIT 或 0 竖屏
tapSdkOptions.setScreenOrientation(ScreenOrientation.LANDSCAPE);
// 是否开启 log,建议 Debug 开启,Release 关闭,默认关闭 log
tapSdkOptions.setEnableLog(BuildConfig.DEBUG);
// 初始化 TapSDK
TapTapSdk.init(context, tapSdkOptions);

初始化具体参数如下:

参数名是否必填说明
clientId客户端 ID,开发者后台获取
clientToken客户端令牌,开发者后台获取
region地区
screenOrientation屏幕方向:0-竖屏 1-横屏,默认为横屏
enableLog是否开启日志,默认关闭,建议开发阶段开启,上线前关闭
preferredLanguage语言,默认自动获取系统语言
gameVersion应用版本号,默认读取应用的版本号

常见问题

编译报错 mergeJavaResource task

如图:

这类编译错误通常是由于开发者使用的 AGP(com.android.tools.build:gradle:${agp_version})版本过低,无法正确处理 Kotlin Multiplatform 构建生成的 AAR 中特有的文件。 解决方案: 将 Gradle 升级到 6.1.1 或更高版本,同时将 AGP 升级到 4.0.1 或更高版本。

运行时报错签名不匹配或 signature not match

检查 TapTap 开发者后台配置的应用包名和签名信息 是否和当前工程设置一致