Vest-SDK

最新版本：1.2.6
这是一个可以用于控制游戏跳转的三方依赖库，工程提供开源代码，可自行修改。

SDK总共四个依赖库：
vest-core: 项目运行所必须的核心库（必须引入）
vest-sdk: 运行B面游戏的平台
vest-shf: 用于切换A/B面的远程开关 vest-firebase: 用于切换A/B面的远程开关

开发环境

JdkVersion: 11
GradleVersion: 7.4
GradlePluginVersion: 7.3.0
minSdkVersion : 24
targetSdkVersion : 34
compileSdkVersion: 34

工程说明

app-core是核心库
app-sdk用于构建游戏运行的平台
app-shf用于构建审核服开关功能，用于切换A/B面
app-firebase用于构建Firebase开关功能，用于切换A/B面
app是用于测试sdk的测试工程
开源sdk使用者可以使用以下构建命令构建出aar，再自行导入自己的工程。（总共四个aar文件，分别输出到sdk目录和app/libs目录）
```
./gradlew clean app-core:assembleRelease app-sdk:assembleRelease app-shf:assembleRelease app-firebase:assembleRelease
```

SDK集成步骤

集成插件（Kotlin或者Google Service插件）

项目根目录build.gradle或者setting.gradle

buildscript {
    repositories {
        mavenCentral()
        google()
    }
}

plugins {
    id 'com.android.application' version '7.3.0' apply false
    id 'org.jetbrains.kotlin.android' version '1.9.22' apply false
}

app/build.gradle

plugins {
    id 'org.jetbrains.kotlin.android'
    //如果用Firebase控制需要引入这个版本的插件，不要随便更换版本
    id 'com.google.gms.google-services' version "4.3.15"
}

app模块添加依赖
总共有三种依赖方式：maven依赖、本地libs依赖、源码依赖
vest-core是核心库必须引用，另外两个库根据需要引用。 vest-sdk则是B面游戏运行平台。 vest-shf只提供审核服控制的A/B面切换开关功能。
vest-firebase只提供Firebase控制的A/B面切换开关功能。
注意：vest-shf和vest-firebase两种控制方式二选一，不要同时引入

(1) maven依赖方式

dependencies {
    //核心库（必须引入）
    implementation 'io.github.bumptechlab:vest-core:1.2.6'
    //B面游戏运行平台
    implementation 'io.github.bumptechlab:vest-sdk:1.2.6'
    //A/B面切换开关
    implementation 'io.github.bumptechlab:vest-shf:1.2.6'
    //vest-shf和vest-firebase 二选一
    //implementation 'io.github.bumptechlab:vest-firebase:1.2.6'
}

(2) 本地依赖方式

a.拷贝sdk目录下的aar文件，包括vest-core、vest-sdk、（vest-shf和vest-firebase二选一）到app/libs文件夹，然后在app/build.gradle添加如下配置：

//三方依赖必须引入
dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar', '*.aar'])
    implementation "androidx.appcompat:appcompat:1.6.1"
    implementation "androidx.multidex:multidex:2.0.1"
    implementation "androidx.annotation:annotation:1.7.0"
    implementation "com.android.installreferrer:installreferrer:2.2"
    implementation "com.google.android.gms:play-services-ads-identifier:18.0.1"
    implementation "com.squareup.okhttp3:okhttp:4.10.0"
    implementation "com.squareup.okhttp3:logging-interceptor:4.10.0"
    implementation "com.adjust.sdk:adjust-android:4.33.0"
    implementation "io.reactivex.rxjava3:rxjava:3.0.0"
    implementation "io.reactivex.rxjava3:rxandroid:3.0.2"
    implementation "com.squareup.retrofit2:retrofit:2.9.0"
    implementation "com.squareup.retrofit2:adapter-rxjava3:2.9.0"
    implementation "com.squareup.retrofit2:converter-gson:2.9.0"
    implementation "org.greenrobot:eventbus:3.3.1"
    implementation "androidx.activity:activity-compose:1.8.2"
    implementation "androidx.compose.material3:material3:1.1.2"
    implementation "androidx.compose.ui:ui:1.6.0"
    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.7.3"
    //使用firebase控制才需要引入这个库
    //implementation "com.google.firebase:firebase-config-ktx:21.4.1"
}

b.添加混淆配置proguard-rules.md

(3) 源码依赖方式（适用于使用开源工程的开发者）

a.把模块app-core, app-sdk, app-shf, app-firebase导入到你的工程中（注意还有其他依赖模块，统一以lib-开头）

b.在app模块build.gradle中添加如下依赖：

dependencies {
    implementation project(":app-core")
    implementation project(":app-sdk")
    //vest-shf和vest-firebase 二选一
    implementation project(":app-shf")
    implementation project(":app-firebase")
}

在Application中初始化VestSDK
(1) VestSDK.init() 方法中传入配置文件名称，请把该配置文件放在assets根目录，配置文件来源将在第4点说明。
(2) VestSDK.setReleaseMode() 方法设置发布模式，发布模式跟出包的用途有关，会影响到VestSHF.getInstance().inspect()方法的返回值。
- MODE_VEST表示当前发布的是马甲包，也就是用于上架的包，该模式是默认值
- MODE_CHANNEL表示当前发布的是渠道包，放在落地页用于推广的包
```
class AppApplication : MussltiDexApplication()  {

   override fun onCreate() {
       super.onCreate()
       VestSDK.setLoggable(true)
       VestSDK.setReleaseMode(VestReleaseMode.MODE_VEST)
       VestSDK.init(baseContext, "config")
   }

}
```

实现A/B面切换
(1) 审核服方式实现开关：在闪屏页实现方法VestSHF.getInstance().inspect() 获取A/B面切换开关，参照例子vest/com/example/vest/sdk/app/SplashActivity

VestSHF.getInstance().apply {
        /**
         * setup the date of apk build
         * time format: yyyy-MM-dd HH:mm:ss
         */
        setReleaseTime("2023-11-29 10:23:20")

        /**
         * setup duration of silent period for requesting A/B switching starting from the date of apk build
         */
        setInspectDelayTime(5, TimeUnit.DAYS)

        /**
         * set true to check the remote and local url, this could make effect on A/B switching
         */
        setCheckUrl(true)

        /**
         * trying to request A/B switching, depends on setReleaseTime & setInspectDelayTime & backend config
         */
    }.inspect(this, object : VestInspectCallback {
        /**
         * showing A-side
         */
        override fun onShowASide(reason: Int) {
            Log.d(TAG, "show A-side activity")
            gotoASide()
            finish()
        }

        /**
         * showing B-side
         */
        override fun onShowBSide(url: String, launchResult: Boolean) {
            Log.d(TAG, "show B-side activity: $url, result: $launchResult")
            if (!launchResult) {
                gotoASide()
            }
            finish()
        }

        private fun gotoASide() {
            val intent = Intent(baseContext, ASideActivity::class.java)
            intent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
            startActivity(intent)
        }
    })

(2) Firebase方式实现开关：在闪屏页实现方法VestFirebase.getInstance().inspect() 获取A/B面切换开关，参照例子firebase/com/example/vest/sdk/app/SplashActivity

     VestFirebase.getInstance().apply {
         /**
          * setup the date of apk build
          * time format: yyyy-MM-dd HH:mm:ss
          */
         setReleaseTime("2023-11-29 10:23:20")

         /**
          * setup duration of silent period for requesting A/B switching starting from the date of apk build
          */
         setInspectDelayTime(0, TimeUnit.DAYS)

         /**
          * 「Optional」If there is no need, you can skip calling this method
          * 
          * set up a device whitelist for Firebase, where devices in the whitelist can bypass the interception of Install Referrer in the Release environment
          * only effective in Release package, Debug package will not be intercepted due to attribution being a natural quantity
          */
         setFirebaseDeviceWhiteList(listOf("xxxx",...))

     }.inspect(this, object : VestInspectCallback {

         /**
          * showing A-side
          */
         override fun onShowASide(reason: Int) {
             Log.d(TAG, "show A-side activity")
             gotoASide()
             finish()
         }

         /**
          * showing B-side
          */
         override fun onShowBSide(url: String, launchResult: Boolean) {
             Log.d(TAG, "show B-side activity: $url, result: $launchResult")
             if (!launchResult) {
                 gotoASide()
             }
             finish()
         }

     })

(3) 在上面的示例中，提供了方法setInspectDelayTime()和setReleaseTime() 控制A/B面开关的请求静默期，目的是为了在审核期间不访问服务器暴露行为，默认延迟1天，可自行修改系统时间进行测试。

  VestSHF.getInstance().setReleaseTime("2023-11-29 10:23:20");

  VestFirebase.getInstance().setReleaseTime("2023-11-29 10:23:20");

(4) 在Activity中实现vest-sdk生命周期

  override fun onPause() {
      super.onPause()
      VestSDK.onPause()
  }

  override fun onResume() {
      super.onResume()
      VestSDK.onResume()
  }

  override fun onDestroy() {
      super.onDestroy()
      VestSDK.onDestroy()
  }

把厂商提供的配置文件config，放到工程的assets根目录。为避免出包之间文件关联，请自行更改config文件名（config文件内容按控制方式选择不同的数据格式，见文件示例：config-firebase.json、config-vest.json）
使用vest-firebase的控制方式，还需要从Firebase控制台下载google-services.json文件，放到app模块根目录下。
至此Vest-SDK集成完毕。

使用快照

上面集成的是release版本，稳定可靠，但是代码特征一成不变。为了及时更改SDK代码特征，我们会每天更新一个快照版本到快照仓库。快照版本是在每个稳定版本的基础上增加混淆代码，不影响正常功能使用。使用方法如下：

添加快照仓库

setting.gradle（Gradle Plugin版本7.x及以上）

dependencyResolutionManagement {
  repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
  repositories {
     google()
     mavenCentral()
     #添加快照仓库
     maven { url("https://s01.oss.sonatype.org/content/repositories/snapshots/") }
  }
}

或者build.gradle（Gradle Plugin版本7.x以下）

allprojects {
    repositories {
      google()
      mavenCentral()
      #添加快照仓库
      maven { url("https://s01.oss.sonatype.org/content/repositories/snapshots/") }
    }
}

在sdk的依赖版本号后面加上-SNAPSHOT，则可以使用release版本的快照版本，从0.10.3开始才有快照版本。

 dependencies {
    implementation 'io.github.bumptechlab:vest-core:1.2.6-SNAPSHOT'
    implementation 'io.github.bumptechlab:vest-sdk:1.2.6-SNAPSHOT'
    implementation 'io.github.bumptechlab:vest-shf:1.2.6-SNAPSHOT'
    //vest-shf和vest-firebase 二选一
    //implementation 'io.github.bumptechlab:vest-firebase:1.2.6-SNAPSHOT'
 }

在build.gradle android节点下添加以下代码，可以帮助及时更新sdk版本依赖缓存。

    android {
      ...
      //gradle依赖默认缓存24小时，在此期间内相同版本只会使用本地资源
      configurations.all {
        //修改缓存周期
        resolutionStrategy.cacheDynamicVersionsFor 0, 'seconds' // 动态版本
        resolutionStrategy.cacheChangingModulesFor 0, 'seconds' // 变化模块
      }
      ...
    }

测试说明

游戏切换开关由厂商后台配置，测试时请联系厂商修改配置。
获取到正式游戏地址后，会一直使用缓存的正式游戏链接，后台关闭开关不会跳转回马甲游戏，清除缓存后再次进入游戏获取。

版本说明

0.9.1

初始版本

0.9.2

增加SDK日志开关：VestSDK.setLoggable()
增加生命周期方法：VestSDK.getInstance().onDestroy()
修复Bug：跳转马甲游戏之前没有结束闪屏界面
合并最新代码

0.9.3

更新proguard

0.9.4

恢复0.9.2bug修复，SDK不结束闪屏界面。

0.9.5

添加推送功能

0.9.5.hotfix03

修复一个Cursor为空错误
升级compileSDK，targetSDK版本为33
修复CoreComponentFactory加载错误

0.9.7

实现HttpDns解析，解决域名劫持问题

0.9.8

添加代码混淆

0.9.8.fix01

暂停使用HttpDns解析

0.9.10

重新启用HttpDns解析
加入HttpDns开关
修复Ip直连的握手问题
拆分SDK功能模块

0.9.11

JsBridge增加模拟器判断接口
从服务器获取TD/OneSignal目标国家
实现保命域名
SDK去特征化

0.9.12

修复Adjust数据问题
修复Google提审警告

0.9.14

修复Adjust数据问题
修复Google提审警告
Preference数据加密
捕获异常上报

0.9.15

修复Android13+手机保存图片失败问题
混淆异常问题

0.10.0

通过反射断言自动区分精简版
项目需要兼容kotlin

0.10.1

升级app-core，app-sdk,app-shf模块
去除相关lib

0.10.2

简化JsBridge接口
移除HttpDns/OneSignal功能
审核服请求接口动态变化
实现延迟请求A/B面开关
升级了一些依赖库版本
修改代码结构

0.10.3

使用代码实现布局、图片资源生成
重构网络请求模块，使用retrofit实现
使用app构建时间作为延迟请求A/B面开关的基准时间
修复Adjust上报问题（兼容游戏2.0框架）

0.10.5

隐藏静默起始时间

0.10.6

升级/隐藏js引擎

0.10.7

vest-plugin插件可以作为可选项引入

0.10.8

增加检查url开关

0.10.9

实现一包通投
增加备用游戏地址
降低appcompat和material版本
修复客服界面悬浮窗在右边显示不完整问题
修复FileProvider缺失导致whatsapp分享失败问题

0.10.10

实现sdk生命周期
退出WebView杀进程
升级js引擎（vest-plugin升级到1.0.14）

0.10.11

修复退出客服页面导致整个程序退出的问题
修复审核服备用跳转地址的逻辑问题
加密审核服返回内容中的字段
优先使用游戏链接中的品牌作为Adjust统计的品牌
优化sdk生命周期方法

0.10.12

项目转kotlin开发语言
接入PG_GetLaunchHTML

0.10.14

使用mmkv替换SharedPreferences
升级code-plugin
使用compose重写WebActivity页面
修复切换链接不能进入游客模式
修复JsBridge命名空间出现纯数字字符串的问题

0.10.15

优化java语言调用vest-sdk方法

0.10.16

使用stringfog插件加密项目中的字符串
保持屏幕常亮
修复客服页面白屏问题

1.0.0

重构代码
VestSHF接口优化，支持流式调用
DeviceId获取规则去掉了Android ID，按以下顺序获取
- Google Service Framework ID
- Google Ad ID
- UUID
支持三方游戏通过isThirdGame参数退出游戏

1.1.0

WebView默认不拦截js引擎文件
实现B面外部跳转
A/B开关请求区分马甲包和渠道包

1.2.4

增加firebase控制A/B开关
移除风险代码
deviceId都为0的时候使用UUID
修复子品牌缓存问题

1.2.5

firebase增加一包通投

1.2.6

firebase增加本地归因判断拦截，并新增加接口setFirebaseDeviceWhiteList来跳过该限制
将静默截止时间改为中国时间来做判断
支持新市场PBR/PID

Name		Name	Last commit message	Last commit date
Latest commit History 67 Commits
app-core		app-core
app-firebase		app-firebase
app-sdk		app-sdk
app-shf		app-shf
app		app
docs		docs
gradle/wrapper		gradle/wrapper
lib-util		lib-util
plugins		plugins
proguard		proguard
sdk		sdk
tools		tools
.gitignore		.gitignore
README.md		README.md
build.gradle		build.gradle
config-firebase.json		config-firebase.json
config-vest.json		config-vest.json
config.gradle		config.gradle
gradle.properties		gradle.properties
gradlew		gradlew
gradlew.bat		gradlew.bat
settings.gradle		settings.gradle

bumptechlab/vest-sdk

Folders and files

Latest commit

History

Repository files navigation