URLNavigator使用指南及扩展

来源：

简书地址：https://www.jianshu.com/p/3bbabe0e93b0

URLNavigator是devxoul发布在github上的一个开源库，他仓库下面还包括了(Then, SwiftyImage, ReactorKit)等很有名的开源库。

URLNavigator是什么:

devxoul 简单的写了一句话：Elegant URL Routing for Swift 其实就是优雅的路由跳转为了解耦模块。

我们平时怎么做跳转：

self.navigationController?.pushViewController(MineViewController(), animated: true)

这是我们平时的路由跳转的方式，看上去没什么不好的地方。其实我也觉得只要能完成项目都是好的，但是说句官方话：好处是移除 ViewController 中的依赖关系...

URLNavigator原理：

其实大多数的Router开源库原理都差不多，1.解析URL。2.根据解析好的URL去跳转，或是做其他的事情。

使用

使用起来也异常的简单明了，首先pod...这就不说了。

Appdelegate.swift
private var navigator: NavigatorType?

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
     let navigator = Navigator()
     NavigatorMap.initialize(navigator: navigator)
}

NavigatorMap.swift
navigator.register("navigator://mine/<mine>") { url , values, context in
    guard let userinfoString = values["mine"] as? String else { return nil }
    return MineViewController(navigator: navigator, userInfo: userinfoString.toObject(UserInfo.self))
}

当我要跳转到MineViewController我应该怎么做呢？***重点***来了 ↓↓↓↓↓↓↓

navigator.push("navigator://mine/abc")
// abc是我要传递给第二个页面的参数

好了，URLNavigator的主要功能已经演示完毕了，下面我们来看一个问题。

如果我传递过去的参数不止一个我该怎么办？？？？解答：URLNavigator提供的有path函数在(URLMatcher)的里面

但是！我想要传一个模型对象过去该怎么办？？？我看了一下源码还真的无法做到，平常比如说我们在A页面然后我们有个UserInfo类，当我们跳转到B页面要带UserInfo的实例过去，那我们用URLNavigator应该怎么做呢？

我的想法：吧UserInfo实例转化成JSON格式的字符串然后拼接在"navigator://mine/{json格式的字符串}"就可以了吧。实验：发现确实可以又一个想法：当我B页面拿到这个JSON格式的字符串总要换成模型吧，当然Decoable能帮我们解决，可是我们毕竟是为了解耦，swift又这么方便，如果我们有UserInfo实例，又有Dog实例，Person, User, Model等等都需要转换，我们怎么样写一个函数就把所有的都实现呢? 实验：泛型

扩展:

OK，现在我们回到上面的第一个问题，怎么把一个model转换为JSON格式的字符串.

model遵守Codable协议
用JSONEncoder进行解析

定义ConvertToStringable协议
protocol ConvertToStringable {
    associatedtype Result: Codable
    var valueString: String { get }
}

extension ConvertToStringable {
    func toString(result: Result) -> String {
        let data = try? JSONEncoder().encode(result)
        guard let da = data else { return "" }
        guard let st = String.init(data: da, encoding: .utf8) else { return "" }
        return st
    }
}

我们使用关联类型来匹配不同的模型实例,然后我们在每个需要model转为JSON格式字符串的model里扩展一下model：

struct UserInfo: Codable {
    var name: String
    var age: Int
    var avator: String
}

extension UserInfo: ConvertToStringable {
    typealias Result = UserInfo
    var valueString: String { return toString(result: self) }
}

OK! 这下可以了我们来做个试验:

let userinfo = UserInfo(name: "Hally", age: 2, avator: "333")
userinfo.valueString
//打印：navigator://mine/{"name":"Hally","age":2,"avator":"333"}

哦哟还不错哦。这个问题算是解决了，并且也用到了很swifty的方式，下面到第二个问题了，我们怎么在B页面把传递过来的JSON格式字符串反推回model -> 泛型怎么做？

// 因为JSON格式的字符串就是一个字符串，所以我们只要扩展一下String就OK啦。
extension String {
    func toObject<T>(_ : T.Type) -> T? where T: Codable {
        guard let data = self.data(using: .utf8) else { return nil }
        return try? JSONDecoder().decode(T.self, from: data)
    }
}

然后怎么使用嘞？

// 其实上面我已经使用过了（NavigatorMap)类里
// userinfoString = "{\"name\":\"Hally\",\"age\":2,\"avator\":\"333\"}"
let userInfo = userinfoString.toObject(UserInfo.self)
// 最后得到userInfo的实例对象

最后我们就可以在B页面愉快的使用userInfo了，这样传递模型的扩展就完成了。仅供小白参考，大神请狠狠的指教。 UseageURLNavigator 代码地址