开源框架MGJRouter_Swift

老渔翁

iOS开发工程师

前言

组件化开发很重要的一点就是组件与组件之间的解耦， MGJRouter_Swift 主要作用就在于此。 MGJRouter_Swift 是一个高效/灵活的 iOS Swift 版 URL Router，完全实现了蘑菇街 Object-C 版 MGJRouter 的所有功能。虽然 github 上也有一款参照 MGJRouter 仿写的 Swift 版框架，但是却去掉了 MGJRouter 的很多功能，不实用。

为什么要写 MGJRouter_Swift ？

看了几款不错的 Object-C 版的 Router，比如： JLRoutes 、 HHRouter 、 MGJRouter ，还是觉得 Object-C 版 MGJRouter 查找 URL 更高效。

虽然 Object-C 版 MGJRouter 在 Swift 中也可以使用，但是也存在问题，比如 block 调用这块。所以说基于这个缺点，MGJRouter_Swift就诞生了。

安装

pod 'MGJRouter_Swift'

使用姿势

最基本的使用

MGJRouter.registerWithHandler("mgj://foo/bar") { (routerParameters) in
   print("routerParameters:\(routerParameters ?? [:])")
MGJRouter.open("mgj://foo/bar")

当匹配到 URL 后， routerParameters 会自带几个 key

public let MGJRouterParameterURL = "MGJRouterParameterURL"
public let MGJRouterParameterCompletion = "MGJRouterParameterCompletion"
public let MGJRouterParameterUserInfo = "MGJRouterParameterUserInfo"

处理中文也没有问题

MGJRouter.registerWithHandler("mgj://category/家居") { (routerParameters) in
   print("routerParameters:\(routerParameters ?? [:])")
MGJRouter.open("mgj://category/家居")

Open 时，可以传一些 userinfo 过去

MGJRouter.registerWithHandler("mgj://category/travel") { (routerParameters) in
    print("routerParameters:\(routerParameters ?? [:])")
MGJRouter.open("mgj://category/travel", ["user_id": "1900"], nil)

如果有可变参数（包括 URL Query Parameter）会被自动解析

MGJRouter.registerWithHandler("mgj://search/:query") { (routerParameters) in
    print("routerParameters:\(routerParameters ?? [:])")
MGJRouter.open("mgj://search/bicycle?color=red")

定义一个全局的 URL Pattern 作为 Fallback

MGJRouter.registerWithHandler("mgj://") { (routerParameters) in
    print("没有人处理该 URL，就只能 fallback 到这里了")
MGJRouter.open("mgj://search/travel/china?has_travelled=0")

当 Open 结束时，执行 Completion Block

MGJRouter.registerWithHandler("mgj://detail") { [weak self] (routerParameters) in
    print("匹配到了 url, 一会会执行 Completion 闭包")
    // 模拟 push 一个 VC
    DispatchQueue.main.asyncAfter(deadline: .now() + 1, execute: {
       let completion = routerParameters?[MGJRouterParameterCompletion] as? ((Any?)->())
       completion?(nil)
MGJRouter.open("mgj://detail", nil) { [weak self] (obj) in
    self?.appendLog("Open 结束，我是 Completion Block")
}

生成 URL

URL 的处理一不小心，就容易散落在项目的各个角落，不容易管理。比如注册时的 pattern 是 mgj://beauty/:id ，然后 open 时就是 mgj://beauty/123 ，这样到时候 url 有改动，处理起来就会很麻烦，不好统一管理。

所以 MGJRouter_Swift 提供了一个类方法来处理这个问题。

class func generateURL(_ pattern: String, _ parameters: [String]) -> String?

使用方式

let TEMPLATE_URL = "mgj://search/:keyword"