如何在故事板管理的 UIViewController 中进行依赖注入？

Question

大家好，我正在尝试测试我的项目的 ViewControllers 之一。 这个类依赖于另一个像这样的辅助类：

private let dispatcher: Dispatcher = Dispatcher.sharedInstance
private var loginSync = LoginSync.sharedInstance
private var metadataSync = MetadataSync.sharedInstance

这些辅助类在 UIViewController 生命周期中使用，如 viewDidLoad 或 viewWillAppear。 在我的测试中，我使用 UIStoryboard 类实例化 ViewController 类，如下所示：

func testSearchBarAddedIntoNavigationViewForiOS11OrMore() {
    // Given a YourFlow ViewController embedded in a navigation controller
    let mockLoginSync = MockLoginSync()
    let storyboard = UIStoryboard(name: "Main", bundle: nil)

    // Here is too early and view controller is not instantiated yet and I can't assign the mock.
    let vc = storyboard.instantiateViewController(withIdentifier: "YourFlow")
    // Here is too late and viewDidLoad has already been called so assigning the mock at this point is pointless.
    let navigationController = UINavigationController(rootViewController: vc)

    // Assertion code
}

所以我的问题是我需要能够模拟 LoginSync 类。 在正常情况下，我会通过将这些助手作为参数传递给类构造函数来使用常规依赖注入。 在那种情况下我不能这样做，因为我没有管理视图控制器生命周期。 所以一旦我实例化它，助手就已经被使用了。

我的问题是：“有没有办法为其生命周期无法控制或至少是解决方法的视图控制器进行依赖注入？

谢谢你。

编辑：所以调用 viewDidLoad 是因为我在 didSet 覆盖方法中使用了 IBOutlets，而不是因为调用了 instantiateViewController。 因此，我可以在正确实例化视图控制器后将该代码移开并进行注入。

Answer 1

您可以像这样包装UIVIewControllerCreation ：

class func createWith(injection: YourInjection) -> YourViewController {
    let storyboard = UIStoryboard(name: "Main", bundle: nil)
    let vc = storyboard.instantiateViewController(withIdentifier: "YourVCId") as? YourViewController
    vc.injected = injection
    return vc
}

并像这样使用它：

let vc = YourViewController.createWith(<your injection>)

这是一个例子：

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
    }

    override func viewDidAppear(_ animated: Bool) {
        super.viewDidAppear(animated)

        let vc = RedViewController.createWith(injection: "some")
        navigationController?.pushViewController(vc, animated: true)
    }
}


class RedViewController: UIViewController {
    var injected: String = "" {
        didSet {
            print(#function)
        }
    }

    override func viewDidLoad() {
        super.viewDidLoad()
        view.backgroundColor = .red
        print(#function)
    }

    class func createWith(injection: String) -> RedViewController {
        let storyboard = UIStoryboard(name: "Main", bundle: nil)
        let vc = storyboard.instantiateViewController(withIdentifier: "Red") as! RedViewController
        vc.injected = injection
        return vc
    }
}

故事板设置：

代码运行结果打印：

injected
viewDidLoad()

如您所见，注入发生在viewDidLoad（）之前

Answer 2

情节init?(coder aDecoder: NSCoder)视图控制器始终使用init?(coder aDecoder: NSCoder)进行init?(coder aDecoder: NSCoder) ，因此无法在初始化时设置任何属性。

我发现以下是很好的解决方法……

而不是使用

let loginSync: LoginSync

声明为

private (set) var loginSync: LoginSync!

宣布

func configure(loginSync: LoginSync) {
    self.loginSync = loginSync
}

然后

let vc = storyboard.instantiateViewController(withIdentifier: "YourFlow")
vc.configure(loginSync: MockLoginSync())

您也可以在segues中使用它…

override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
    switch segue.destination) {
    case let vc as MyViewController:
        vc.configure(loginSync: MockLoginSync())
    default:
        break
    }
}

它不是完美的，但是将属性private (set)可确保不能从另一个类进行修改，并且隐式解包（ ! ）意味着如果未设置，则会崩溃。

在每个UIView / UIViewController中都使用configure()方法-一旦习惯了这种模式，它就会成为第二本性。

Answer 3

您需要使用segues导航到视图控制器，以便可以在prepareForSegue期间注入依赖项，如下所示：

override func prepareForSegue(segue: UIStoryboardSegue!, sender: AnyObject!) {
    if (segue.identifier == "SomeSegueToYourFlow") {
        if let yourFlowVC = segue.destination as? YourFlowController {
            let mockLoginSync = MockLoginSync()
            yourFlowVC.loginSync = mockLoginSync
        }
    }
}

Answer 4

iOS 13、Xcode 11 解决方案

您可以利用instantiateViewController(identifier:creator:)来实现您想要实现的目标。 只需在init?命名所有依赖项init? 初始化器，并使用instantiateViewController方法来初始化您的ViewController，如下所示：

class MyViewController: UIViewController {
    private let networkManager: MyNetworkManager

    // Name your dependencies here
    init?(coder: NSCoder, networkManager: MyNetworkManager) {
        self.networkManager = networkManager
        super.init(coder: coder)
    }

    required init?(coder: NSCoder) {
        fatalError("NetworkManager is missing")
    }
    
    /// Returns an instance of the MyViewController with dependency injection
    static func createFromStoryBoardWith(
        networkManager: MyNetworkManager)
        -> MyViewController
    {
        let storyboard = UIStoryboard(name: "MyViewControllerStoryboard", bundle: nil)
        let viewController = storyboard.instantiateViewController(identifier: "MyViewControllerStoryboardID", creator: { coder in
            MyViewController(coder: coder, networkManager: networkManager) // The magic happens here
        })
        return viewController
    }
}

其中NetworkManager是一个简单的结构：

struct MyNetworkManager {
    var id: String
}

你可以像这样使用它：

let networkManager = MyNetworkManager(id: "ABCDE")
let myViewController = MyViewController.createFromStoryBoardWith(networkManager: networkManager)