远程配置
为iOS应用提供远程配置。
工作原理
该模块在启动时从后端API获取JSON配置,并在负载签名验证成功的情况下将配置本地缓存。配置每60分钟获取和缓存一次。
入门教程
要求
此模块支持iOS 10.0及以上版本。已在iOS 10.0及以上版本上进行了测试。
它使用Swift 5.0编写,可用于兼容的Xcode版本。
文档
本模块的生成文档托管在rakutentech的GitHub网站上 https://rakutentech.github.io/ios-remote-config。
安装
要使用此模块,您的Podfile
文件应包含
source 'https://github.com/CocoaPods/Specs.git'
pod 'RRemoteConfig'
运行pod install
安装模块及其依赖项。
配置
目前我们没有托管任何公开的API,但您可以创建自己的API并配置SDK使用这些API。
要使用此模块,您必须在应用程序的Info.plist
中设置以下值。
键 | 值 |
---|---|
RASApplicationIdentifier |
your_app_id |
RASProjectSubscriptionKey |
your_subscription_key |
RRCConfigAPIEndpoint |
https://www.example.com |
获取配置值
- 注意:新获取到的配置值在下次应用程序启动之前不可用。这意味着在首次安装应用程序之后的第一个会话中,将使用备用值而不是获取的值。
代码示例
// Get a String value
let testString = RemoteConfig.getString(key: "stringKeyName", fallback: "string_fallback_value")
// Get a Boolean value
let testBoolean = RemoteConfig.getBoolean(key: "booleanKeyName", fallback: false)
// Get a NSNumber value
let testNumber = RemoteConfig.getNumber(key: "numberKeyName", fallback: 1)
// Get the entire config as a dictionary
let configDictionary = RemoteConfig.getConfig()
贡献
有关如何参与本模块的开发,请参阅CONTRIBUTING.md的详细信息。
运行示例应用程序和单元测试
- 克隆或分叉仓库
- 在仓库根目录中运行
bundle exec pod install
- 在 Xcode 中打开
RRemoteConfig.xcworkspace
- 选择
SampleApp
方案后进行构建/运行 - 要运行测试,请按快捷键 command-U
变更日志
查看 CHANGELOG.md 以了解模块版本的新的功能、更改和错误修复。