Android SDK
一、功能概述
应用的文案或者运营策略更新经常需要通过发版解决，为了减少开发者频繁更新应用版本，热力引擎推出参数下发功能，通过参数下发可以随时远程调整应用中的参数值实现应用内容更新
二、获取SDK
1.gradle
如果您是国内的开发者，请使用：
implementation 'com.reyun.solar.engine.china:solar-remote-config:1.3.1.0'如果您是海外开发者，请使用：
implementation 'com.reyun.solar.engine.oversea:solar-remote-config:1.3.1.0'注意：如果使用gradle方式拉取代码失败，需要在项目根目录的build.gradle文件中添加maven仓库配置，具体配置如下：
maven {
url "https://dl-maven-android.mintegral.com/repository/se_sdk_for_android/"
}注：参数下发SDK对外不区分AndroidX与Android Support版本
三、初始化
由于参数下发SDK属于热力引擎SDK的一个插件，所以参数下发SDK的初始化是依赖于热力引擎SDK的,具体参考客户端Android SDK集成文档。开发者可以通过热力引擎SDK的配置方法来控制是否启用参数下发SDK并使用参数下发SDK的相关功能，如果在调试过程中先初始化了热力引擎SDK，后增加了参数下发SDK，需要将调试设备的应用卸载重装
方法示例
RemoteConfig remoteConfig = new RemoteConfig(true, RemoteConfig.MergeType.WITH_CACHE, customIdProperties, customIDEventProperties, customIDUserProperties);
SolarEngineConfig.Builder config = new SolarEngineConfig.Builder()
.withRemoteConfig(remoteConfig); //参数下发SDK参数配置
.build();RemoteConfig参数介绍
| 参数名称 | 参数含义 | 参数类型 | 是否必传 |
| enable | 是否初始化参数下发SDK，默认为false | boolean | 是 |
| mergeType | 服务端跟SDK配置合并策略（具体含义参考下方解释） | enum | 否 |
| customIDProperties | 自定义ID，跟用户在后台设置的使用自定义ID匹配 | JSONObject | 否 |
| customIDEventProperties | 自定义ID事件属性值，跟用户在后台设置的使用自定义ID事件属性值匹配 | JSONObject | 否 |
| customIDUserProperties | 自定义ID用户属性值，跟用户在后台设置的使用自定义ID用户属性值匹配 | JSONObject | 否 |
mergeType(合并策略)介绍
| 参数名称 | 参数含义 |
| MergeType.WITH_USER | app首次启动或版本更新时, 使用服务端配置跟用户默认配置合并，此方法可以清除本地缓存配置 |
| MergeType.WITH_CACHE | 使用服务端配置跟用户本地已有缓存配置合并，参数下发SDK默认合并策略 |
注：开发者使用参数下发SDK需要通过API预置一份默认配置配置到App中，SDK使用该默认配置用来兜底
四、设置默认配置
参数下发SDK需要开发者预置一份默认配置到用户app中，方便参数下发SDK使用此默认配置进行兜底操作。
方法示例
public synchronized void setRemoteDefaultConfig(JSONArray defaultConfig);参数相关
| 参数名称 | 参数含义 | 参数类型 | 是否必传 |
| defaultConfig | 开发者传入的默认配置 | JSONArray | 是 |
调用示例
import com.reyun.remote.config.RemoteConfigManager;
JSONArray dcJsonArray = new JSONArray();
JSONObject defaultConfigO = new JSONObject();
defaultConfigO.put("name", "key1");
defaultConfigO.put("value", "value1");
defaultConfigO.put("type", 1);// 1 string、2 integer、3 boolean、4 json
dcJsonArray.put(defaultConfigO);
JSONObject defaultConfigT = new JSONObject();
defaultConfigT.put("name", "key2");
defaultConfigT.put("value", "value2");
defaultConfigT.put("type", 1);
dcJsonArray.put(defaultConfigT);
RemoteConfigManager.getInstance().setRemoteDefaultConfig(dcJsonArray);五、设置事件自定义属性
开发者可以为事件设置自定义属性，参数下发SDK在请求服务端配置时会带上该属性，用于服务端参数匹配。
方法示例
public synchronized void setRemoteConfigEventProperties(JSONObject eventProperties);参数相关
| 参数名称 | 参数含义 | 参数类型 | 是否必传 |
| eventProperties | 事件自定义属性 | JSONObject | 是 |
调用示例
import com.reyun.remote.config.RemoteConfigManager;
JSONObject eventProperties = new JSONObject();
eventProperties.put("event_key1", "event_value1");
eventProperties.put("event_key2", "event_value2");
RemoteConfigManager.getInstance().setRemoteConfigEventProperties(eventProperties);
注：给事件设置的自定义属性不支持开发者传入"_"下划线开头的key值，SDK会默认丢弃该条属性
六、设置用户自定义属性
开发者可以为用户设置自定义属性，参数下发SDK在请求服务端配置时会带上该属性，用于服务端参数匹配
方法示例
public synchronized void setRemoteConfigUserProperties(JSONObject userProperties);参数相关
| 参数名称 | 参数含义 | 参数类型 | 是否必传 |
| userProperties | 用户自定义属性 | JSONObject | 是 |
调用示例
import com.reyun.remote.config.RemoteConfigManager;
JSONObject userProperties = new JSONObject();
userProperties.put("user_key1", "user_value1");
userProperties.put("user_key2", "user_value2");
RemoteConfigManager.getInstance().setRemoteConfigUserProperties(userProperties);
注：给用户设置的自定义属性不支持开发者传入"_"下划线开头的key值，SDK会默认丢弃该条属性
七、获取参数下发配置
参数下发SDK获取参数下发配置分为两种情况，一种是同步获取方法，通过此方法开发者可以直接获取返回结果。另一种是异步获取方法，返回结果需要等待回调完成才可以获取
注：通过同步或异步方式获取参数时，sdk 会触发上报用户命中试验的事件，所以获取参数的时机应该在用户到达试验场景时读取（获取参数代表用户到达试验场景，用户命中该参数对应的试验），请勿提前读取参数
1.同步获取参数下发配置
方法示例
public synchronized Object fastFetchRemoteConfig(String paramKey);参数相关
| 参数名称 | 参数含义 | 参数类型 | 是否必传 |
| paramKey | 参数下发key，跟用户在后台配置参数key对应 | String | 是 |
返回值: Object
调用示例
import com.reyun.remote.config.RemoteConfigManager;
Object result = RemoteConfigManager.getInstance().fastFetchRemoteConfig("key1");
if (result instanceof String) {
String realResult = (String) result;
}
2. 异步获取参数下发配置
方法示例
public synchronized void asyncFetchRemoteConfig(String paramKey, OnRemoteConfigReceivedData callBack);参数相关
| 参数名称 | 参数含义 | 参数类型 | 是否必传 |
| paramKey | 参数下发key，跟用户在后台配置参数key对应 | String | 是 |
| callBack | 参数下发异步回调 | OnRemoteConfigReceivedData | 是 |
调用示例
import com.reyun.remote.config.RemoteConfigManager;
RemoteConfigManager.getInstance().asyncFetchRemoteConfig("test1", new OnRemoteConfigReceivedData() {
@Override
public void onResult(Object result) {
if (result instanceof String) {
String realResult = (String) result;
}
}
});3. 同步获取所有参数下发配置
方法示例
public synchronized JSONObject fastFetchRemoteConfig()调用示例
import com.reyun.remote.config.RemoteConfigManager;
JSONObject result = RemoteConfigManager.getInstance().fastFetchRemoteConfig();4. 异步获取所有参数下发配置
方法示例
public synchronized void asyncFetchRemoteConfig(OnRemoteConfigReceivedGenericsData<JSONObject> callBack)参数相关
| 参数名称 | 参数含义 | 参数类型 | 是否必传 |
| callBack | 参数下发异步回调 | OnRemoteConfigReceivedGenericsData | 是 |
调用示例
import com.reyun.remote.config.RemoteConfigManager;
RemoteConfigManager.getInstance().asyncFetchRemoteConfig(new OnRemoteConfigReceivedGenericsData<JSONObject>() {
@Override
public void onResult(JSONObject result) {
//result：异步获取到的所有在线参数配置
}
});八、混淆配置
如果打包时需要增加混淆，请将下方代码增加到配置中
-keep class com.reyun.** {*; }
-keep class route.**{*;}
-keep interface com.reyun.** {*; }
-keep interface route.**{*;}
-dontwarn com.reyun.**————————————
SDK 更新记录
2025-08-12 1.3.1.0
•与主SDK版本对齐
2025-07-28 1.3.0.6
•优化分流事件
2025-07-22 1.3.0.5
•与主SDK版本对齐
2025-07-04 1.3.0.3
•与主SDK版本对齐
2025-06-26 1.3.0.2
•与主SDK版本对齐
2025-06-23 1.3.0.1
•与主SDK版本对齐
2025-06-11 1.3.0.0
- 性能优化
2025-02-28 1.2.9.6
•与主SDK版本对齐
2024-12-03 1.2.9.2
•与主SDK版本对齐
2024-11-04 1.2.8.3
•与主SDK版本对齐
2024-9-23 1.2.8.3
•优化在线参数逻辑
2024-8-23 1.2.8.1
•与主SDK版本对齐
2024-8-16 1.2.8.0
•与主SDK版本对齐
2024-6-6 1.2.7.6
•与主SDK版本对齐
2024-5-11 1.2.7.5
•与主SDK版本对齐
2024-2-4 1.2.7.0
•优化在线参数分流逻辑
2023-12-28 1.2.6.1
•优化在线参数SDK获取所有参数回调方法
2023-12-14 1.2.6.0
•在线参数SDK支持同步获取所有在线参数配置
•在线参数SDK支持异步获取所有在线参数配置
2023-12-01 1.2.4.2-1.2.5.3
•与主SDK版本对齐
2023-10-16 1.2.4.2
•与主SDK版本对齐
•优化调试日志
2023-09-14 1.1.1.1
•与主SDK版本对齐
2023-09-01 1.1.1.0
•参数下发模块区分国内海外版本
2023-08-21 1.1.0.2
•优化参数获取
2023-08-04 1.1.0.1
•统一埋点公共参数
2023-05-25 1.1.0.0
•支持setting服务下发的部分参数
2023-04-26 1.0.3.0
- SDK日志功能优化
2023-03-30 1.0.2.0
- 优化、兼容debug模式
2023-03-29 1.0.1.2
- 参数下发模块功能优化
2023-03-23 1.0.1.1
- 优化参数下发模块数据格式
2023-03-20 1.0.1.0
- 参数下发模块支持AB测试功能
2023-03-10 1.0.0.1
- 参数下发添加日志打点
2023-02-08 1.0.0.0
- 参数下发Android SDK初版
;}.cls-2{fill:%230868f7;}.cls-3{fill:url(%23未命名的渐变_44);}.cls-4{fill:%23333;}%3c/style%3e%3clinearGradient%20id='未命名的渐变_8'%20x1='33.73'%20y1='100.61'%20x2='-0.03'%20y2='-1.06'%20gradientUnits='userSpaceOnUse'%3e%3cstop%20offset='0'%20stop-color='%237ae9fb'/%3e%3cstop%20offset='0.67'%20stop-color='%232b90f8'/%3e%3cstop%20offset='1'%20stop-color='%230868f7'/%3e%3c/linearGradient%3e%3clinearGradient%20id='未命名的渐变_44'%20x1='27.86'%20y1='18.67'%20x2='68.36'%20y2='22.22'%20gradientUnits='userSpaceOnUse'%3e%3cstop%20offset='0'%20stop-color='%235ac7f2'/%3e%3cstop%20offset='1'%20stop-color='%230868f7'/%3e%3c/linearGradient%3e%3c/defs%3e%3cpath%20class='cls-1'%20d='M29,28.74V81.91l-9.51-3.68v0L8.52,74A7.17,7.17,0,0,1,4,67.32V24.54A3.76,3.76,0,0,1,9.08,21Z'/%3e%3cpath%20class='cls-2'%20d='M68.09,78.07a13.15,13.15,0,0,1-17.9,12.06L29,81.91h0V28.74L50.19,37A13.17,13.17,0,0,0,68.08,25.3h0Z'/%3e%3cpath%20class='cls-3'%20d='M68.08,25.3a13.19,13.19,0,0,1-6.73,10.87A13.09,13.09,0,0,1,50.19,37L29,28.74V6A3.76,3.76,0,0,1,34.1,2.52l25.59,9.91A13.22,13.22,0,0,1,68.08,25.3Z'/%3e%3cpath%20class='cls-4'%20d='M129.06,81.76a4.33,4.33,0,0,1-3.19-1.31,4.4,4.4,0,0,1-1.31-3.24V56.86H97.65V77.21a4.36,4.36,0,0,1-1.35,3.2A4.68,4.68,0,0,1,93,81.76a4.32,4.32,0,0,1-3.19-1.31,4.37,4.37,0,0,1-1.32-3.24V27.27A4.58,4.58,0,0,1,89.83,24a4.59,4.59,0,0,1,7.82,3.27V48.15h26.91V27.27A4.58,4.58,0,0,1,125.91,24a4.59,4.59,0,0,1,7.82,3.27V77.21a4.37,4.37,0,0,1-1.36,3.2A4.65,4.65,0,0,1,129.06,81.76Z'/%3e%3cpath%20class='cls-4'%20d='M163.77,81.66c-6.57,0-11.76-1.92-15.44-5.7s-5.54-9.07-5.54-15.74a26.76,26.76,0,0,1,2.09-10.43,17.72,17.72,0,0,1,6.67-8.06,19.15,19.15,0,0,1,10.68-2.95,19,19,0,0,1,10.46,2.8,18.7,18.7,0,0,1,6.55,7.36,22.53,22.53,0,0,1,2.36,10.28A4.51,4.51,0,0,1,177,63.77H152.23a10.8,10.8,0,0,0,3.49,6.65c2,1.68,4.88,2.52,8.66,2.52a22.25,22.25,0,0,0,7.54-1.21c.74-.3,1.55-.67,2.37-1.07a3.75,3.75,0,0,1,1.84-.4,4.09,4.09,0,0,1,3,1.15,4,4,0,0,1,1.12,3,4.38,4.38,0,0,1-2.58,3.82,32.34,32.34,0,0,1-6.36,2.61A28.67,28.67,0,0,1,163.77,81.66ZM172.4,55.9a9.72,9.72,0,0,0-1.63-4.56A9.9,9.9,0,0,0,167,48a10.38,10.38,0,0,0-4.64-1.14,12,12,0,0,0-4.77,1.06,9.54,9.54,0,0,0-4.89,5.66,11.78,11.78,0,0,0-.51,2.3Z'/%3e%3cpath%20class='cls-4'%20d='M193,81.64a4.49,4.49,0,0,1-4.51-4.55V27.28A4.58,4.58,0,0,1,189.84,24a4.48,4.48,0,0,1,3.28-1.36A4.36,4.36,0,0,1,196.35,24a4.46,4.46,0,0,1,1.31,3.31V77.09a4.34,4.34,0,0,1-1.35,3.2A4.67,4.67,0,0,1,193,81.64Z'/%3e%3cpath%20class='cls-4'%20d='M263.79,81.71a5.7,5.7,0,0,1-4.2-1.74,5.76,5.76,0,0,1-1.73-4.19V27.37a4.58,4.58,0,0,1,1.35-3.27A4.59,4.59,0,0,1,267,27.37V72.53h24a4.58,4.58,0,0,1,3.27,7.82A4.66,4.66,0,0,1,291,81.71Z'/%3e%3cpath%20class='cls-4'%20d='M424.48,81.74a4.71,4.71,0,0,1-2.71-.88,5.43,5.43,0,0,1-1-1l-.07-.09-12.41-17-5.41,5v9.44a4.31,4.31,0,0,1-1.36,3.19,4.66,4.66,0,0,1-3.3,1.36A4.29,4.29,0,0,1,395,80.42a4.36,4.36,0,0,1-1.32-3.23V27.37A4.58,4.58,0,0,1,395,24.1a4.52,4.52,0,0,1,6.58.12,4.54,4.54,0,0,1,1.24,3.15V56.31l17.72-16.38.05,0a4.8,4.8,0,0,1,2.94-1.11,4.4,4.4,0,0,1,3.27,1.2,4.57,4.57,0,0,1,1.2,3.27,4.44,4.44,0,0,1-.77,2.33,7.45,7.45,0,0,1-1.43,1.65l-11,9.64,13.34,17.68a5,5,0,0,1,1,2.71,4.12,4.12,0,0,1-1.36,3.24A4.64,4.64,0,0,1,424.48,81.74Z'/%3e%3cpath%20class='cls-4'%20d='M317.93,81.76a21.5,21.5,0,1,1,21.17-21.5A21.37,21.37,0,0,1,317.93,81.76Zm0-34.1a12.61,12.61,0,1,0,12.42,12.6A12.52,12.52,0,0,0,317.93,47.66Z'/%3e%3cpath%20class='cls-4'%20d='M212.18,101.22a4.12,4.12,0,0,1-3.05-1.26,4.17,4.17,0,0,1-1.26-3.1V43.34a4.37,4.37,0,0,1,1.3-3.14,4.26,4.26,0,0,1,3.13-1.3,4.19,4.19,0,0,1,3.1,1.26,4.32,4.32,0,0,1,1.26,3.16,20.77,20.77,0,0,1,13-4.54,21.51,21.51,0,0,1,0,43,20.51,20.51,0,0,1-13-4.57V96.86a4.15,4.15,0,0,1-1.3,3.06A4.5,4.5,0,0,1,212.18,101.22Zm17.43-53.63c-6.23,0-12.93,4.11-12.93,12.72a12.73,12.73,0,0,0,25.46,0A12.71,12.71,0,0,0,229.61,47.59Z'/%3e%3cpath%20class='cls-4'%20d='M365.76,81.76a21.5,21.5,0,1,1,21.18-21.5A21.37,21.37,0,0,1,365.76,81.76Zm0-34.1a12.61,12.61,0,1,0,12.42,12.6A12.52,12.52,0,0,0,365.76,47.66Z'/%3e%3c/svg%3e)