iOS：管理 REST 端点的简单方法

我们基于 REST 的应用程序可用于在多个内部环境上进行测试，每个内部环境都有不同的 REST 端点。有没有一种简单的方法可以在 iOS (Swift 3) 应用程序中设置环境级别配置？我见过一些方法，但它们似乎都非常复杂。

这是当我们有多个端点时我的做事方法。我曾经做过一个ConfigurationManager类是这样的

斯威夫特 3.0 代码

import Foundation
import UIKit

let kEnvironmentsPlist:NSString? = "Environments"
let kConfigurationKey:NSString? = "ActiveConfiguration"
let kAPIEndpointKey:NSString? = "APIEndPoint"
let kLoggingEnabledKey:NSString? = "LoggingEnabled"
let kAnalyticsTrackingEnabled:NSString? = "AnalyticsTrackingEnabled"

class ConfigurationManager:NSObject {

    var environment : NSDictionary?

    //Singleton Method

    static let sharedInstance: ConfigurationManager = {
        let instance = ConfigurationManager()
        // setup code
        return instance
    }()

    override init() {
        super.init()
        initialize()
    }

    // Private method

    func initialize ()   {

        var environments: NSDictionary?
        if let envsPlistPath = Bundle.main.path(forResource: "Environments", ofType: "plist") {
            environments = NSDictionary(contentsOfFile: envsPlistPath)
        }
        self.environment = environments!.object(forKey: currentConfiguration()) as? NSDictionary
        if self.environment == nil {
            assertionFailure(NSLocalizedString("Unable to load application configuration", comment: "Unable to load application configuration"))
        }
    }

    // CurrentConfiguration

    func currentConfiguration () -> String   {
        let configuration = Bundle.main.infoDictionary?[kConfigurationKey! as String] as? String
        return configuration!
    }

    // APIEndpoint

    func APIEndpoint () -> String  {
        let configuration = self.environment![kAPIEndpointKey!]
        return (configuration)! as! String
    }

    // isLoggingEnabled

    func isLoggingEnabled () -> Bool  {

        let configuration = self.environment![kLoggingEnabledKey!]
        return (configuration)! as! Bool
    }

    // isAnalyticsTrackingEnabled

    func isAnalyticsTrackingEnabled () -> String  {

        let configuration = self.environment![kAnalyticsTrackingEnabled!]
        return (configuration)! as! String
    }

    func applicationName()->String{
        let bundleDict = Bundle.main.infoDictionary! as NSDictionary
        return bundleDict.object(forKey: "CFBundleName") as! String
    }
}

In Project--> Info根据您的需要添加一些新配置。

我已经添加了Staging and QA作为额外的端点。通常我用来将暂存设置为发布配置，并将 QA 设置为调试。所以它看起来像：

现在去Targets -> 构建设置并添加一个用户定义的设置

给出用户定义的名称，例如活动配置.

添加一个名为ActiveConfiguration in info.plist变量名称为$(ACTIVE_CONFIGURATION)与给出的相同用户定义的设置 with a $在一开始的时候。我们将键的名称命名为ActiveConfiguration因为我们在我们的应用程序中使用相同的名称ConfigurationManager.swift类为kConfigurationKey.

let kConfigurationKey:NSString? = "ActiveConfiguration"

您可以根据您的命名约定进行定义。

它看起来像：

现在在ConfigurationManager我正在寻找一条路径Environments.plist file.

我只会做一个Environments.plist像这样的文件：

该文件的实际描述来源是

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>Development</key>
    <dict>
        <key>APIEndPoint</key>
        <string>https://dev</string>
        <key>LoggingEnabled</key>
        <true/>
        <key>AnalyticsTrackingEnabled</key>
        <true/>
        <key>Flurry</key>
        <dict>
            <key>FlurryApplicationID</key>
            <string></string>
            <key>FlurryApplicationSecret</key>
            <string></string>
        </dict>
        <key>Facebook</key>
        <dict>
            <key>FacebookAppID</key>
            <string></string>
            <key>FacebookAppSecret</key>
            <string></string>
        </dict>
    </dict>
    <key>QA</key>
    <dict>
        <key>APIEndPoint</key>
        <string>https://qa</string>
        <key>LoggingEnabled</key>
        <true/>
        <key>AnalyticsTrackingEnabled</key>
        <true/>
        <key>Flurry</key>
        <dict>
            <key>FlurryApplicationID</key>
            <string></string>
            <key>FlurryApplicationSecret</key>
            <string></string>
        </dict>
        <key>Facebook</key>
        <dict>
            <key>FacebookAppID</key>
            <string></string>
            <key>FacebookAppSecret</key>
            <string></string>
        </dict>
    </dict>
    <key>Staging</key>
    <dict>
        <key>APIEndPoint</key>
        <string>https://staging</string>
        <key>LoggingEnabled</key>
        <false/>
        <key>AnalyticsTrackingEnabled</key>
        <true/>
        <key>Flurry</key>
        <dict>
            <key>FlurryApplicationID</key>
            <string></string>
            <key>FlurryApplicationSecret</key>
            <string></string>
        </dict>
        <key>Facebook</key>
        <dict>
            <key>FacebookAppID</key>
            <string>840474532726958</string>
            <key>FacebookAppSecret</key>
            <string></string>
        </dict>
    </dict>
    <key>Production</key>
    <dict>
        <key>APIEndPoint</key>
        <string>https://production</string>
        <key>LoggingEnabled</key>
        <true/>
        <key>AnalyticsTrackingEnabled</key>
        <true/>
        <key>Flurry</key>
        <dict>
            <key>FlurryApplicationID</key>
            <string></string>
            <key>FlurryApplicationSecret</key>
            <string></string>
        </dict>
        <key>Facebook</key>
        <dict>
            <key>FacebookAppID</key>
            <string></string>
            <key>FacebookAppSecret</key>
            <string></string>
        </dict>
    </dict>
</dict>
</plist>

现在我们可以出发了。现在你只需打电话

ConfigurationManager.sharedInstance.APIEndpoint()

为您各自的终点。

现在您只需从编辑方案中更改方案即可完成并更改构建配置 in info.

这不仅管理API端点还包括其他事项，例如是否为相应端点或不同端点的 Facebook 不同 ID 启用分析或跟踪。