wanggang316 / routerman Goto Github PK

RouterMan is a protocol-oriented url router, base on regular expressions. RouterMan is simple and extensible.

• iOS 10 or later
• Swift 5

##Features

• Regular expressions support
• Storyboard controller support，you can open a storyboard based controller easily
• Mutable source urls to a target behavior
• Mutable transitions support
• RouterDelegate support

pod 'RouterMan'

github "wanggang316/RouterMan"

It's simple to use RouterMan, implement RoutableType based protocol for your controller or other types, then registe it to RouteMan, done.

RoutableType is routable base protocol, it derivative three protocols

• RoutableControllerType
• RoutableStoryboardControllerType
• RoutableActionType

• RoutableControllerType

class CityViewController: UIViewController: RoutableControllerType {
    
    static var patterns: [String] {
        return ["abc://page/cities/\\d+\\?name=\\w+"]
    }
    
    required convenience init(_ url: URLConvertible) {
        self.init()
        let params = url.urlValue?.queryParameters
        let title = params?["name"]
        self.title = title
    }
}

• RoutableStoryboardControllerType

extension StoryViewController: RoutableStoryboardControllerType {
    
    static var patterns: [String] {
        return ["abc://page/stories/\\d+\\?name=\\S+",
                "http://www.xxx.com/stories/\\d+\\?name=\\w+"]
    }
    
    static var storyboardName: String {
        return "Main"
    }
    
    static var identifier: String {
        return "StoryViewController"
    }
    
    func initViewController(_ url: URLConvertible) {
        self.storyId = url.urlValue?.pathComponents.last
        self.storyName = url.urlValue?.queryParameters["name"]
    }
}

• RoutableActionType

class AlertActionRouter: RoutableActionType {
    static func handle(_ url: URLConvertible) -> Bool {
        let title = url.urlValue?.queryParameters["title"]
        let message = url.urlValue?.queryParameters["message"]

        let alert = UIAlertController(title: title, message: message, preferredStyle: .alert)
        alert.addAction(UIAlertAction(title: "Yes", style: .cancel, handler: nil))

        let appdelegate = UIApplication.shared.delegate as? AppDelegate
        appdelegate?.window?.rootViewController?.present(alert, animated: true, completion: nil)

        return true
    }
    
    static var patterns: [String] {
        return ["abc://alert\\?title=\\w+&message=\\w+"]
    }
}

• RouterDelegate

  • You can implement RouterDelegate globally

    Router.default.delegate = AClass()
    
    extension AClass: RouterDelegate {
        func shouldShowController(_ controller: UIViewController, fromViewController: UIViewController, segueKind: SegueKind, shouldShow: @escaping (Bool) -> Void) {
          // do something
            shouldShow(true)
        }
        func willShowController(_ controller: UIViewController, fromViewController: UIViewController, segueKind: SegueKind) {
            // do something
        }
        
        func didShownController(_ controller: UIViewController, fromViewController: UIViewController, segueKind: SegueKind) {
            // do something
        }
    }

  • Also, you can implement RouterDelegate locally in a RoutableType

    extension AViewController: RoutableTypeDelegate {
        func shouldShowController(_ controller: UIViewController, fromViewController: UIViewController, segueKind: SegueKind, shouldShow: @escaping (Bool) -> Void) {
          	let isAuthorized = ...
          	shouldShow(isAuthorized)
        }
        
        func willShowController(_ controller: UIViewController, fromViewController: UIViewController, segueKind: SegueKind) {
            // do something
        }
        
        func didShownController(_ controller: UIViewController, fromViewController: UIViewController, segueKind: SegueKind) {
            // do something
        }
    }

Router.default.registe(CityViewController.self)
Router.default.registe(StoryViewController.self)
Router.default.registe(AlertActionRouter.self)

try? Router.default.handle(url)

RouterMan is released under the MIT license.