feat(All): 路由时支持附加一个对象

Author: wxlpp

.jazzy.yaml

@@ -2,6 +2,6 @@ module: UIRouter
 sdk: iphone
 swift_build_tool: xcodebuild
 podspec: UIRouter.podspec
-module_version: 1.0
+module_version: 0.2.0.alpha
 clean: true
 theme: theme/fullwidth

Example/Podfile.lock

@@ -1,8 +1,11 @@
 PODS:
   - Submodule (0.1.0):
     - UIRouter
-  - UIRouter (0.2.0.alpha)
-  - UIRouter/Web (0.2.0.alpha)
+  - UIRouter (0.2.0.alpha):
+    - UIRouter/Core (= 0.2.0.alpha)
+  - UIRouter/Core (0.2.0.alpha)
+  - UIRouter/Web (0.2.0.alpha):
+    - UIRouter/Core
 
 DEPENDENCIES:
   - Submodule (from `Submodule/`)
@@ -16,7 +19,7 @@ EXTERNAL SOURCES:
 
 SPEC CHECKSUMS:
   Submodule: 4d6c30b294c43d33503985e348909fd7c4c02353
-  UIRouter: 57c6fd4e66a174927134a6d962a9452c6e17fc12
+  UIRouter: f0fadcc043f620b846aa1feee97ea8803127f27f
 
 PODFILE CHECKSUM: 5387537adb0879783c29a9e30e3acc9630837f78
 

Example/Submodule/Source/SubViewController.swift

@@ -23,7 +23,8 @@ public final class SubViewController: UIViewController {
 // MARK: 路由
 
 extension SubViewController: Routable {
-    public static func route(parameters: RouterParameters, completion: @escaping RouteCompletionHandler<SubViewController>) {
+
+    public static func route(parameters: RouterParameters, object: Any?, completion: @escaping RouteCompletionHandler<SubViewController>) {
         completion(.success(SubViewController()))
     }
 

Example/Submodule/UserProfileViewController.swift

@@ -13,11 +13,12 @@ public final class UserProfileViewController: UIViewController {}
 // MARK: 路由
 
 extension UserProfileViewController: Routable {
+
     public static var paths: [String] {
         ["user/profile/:id"]
     }
-    
-    public static func route(parameters: RouterParameters, completion: @escaping RouteCompletionHandler<UserProfileViewController>) {
+
+    public static func route(parameters: RouterParameters, object: Any?, completion: @escaping RouteCompletionHandler<UserProfileViewController>) {
         if let userID: String = parameters.get("userID") {
             completion(.success(UserProfileViewController()))
         } else {

Example/shell.xcodeproj/project.pbxproj

@@ -27,7 +27,7 @@
 		926010144793C5C8C345B1D4 /* Pods_ExampleTests.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_ExampleTests.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		A3B75E7330C33D887776A83C /* Pods-ExampleTests.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-ExampleTests.release.xcconfig"; path = "Target Support Files/Pods-ExampleTests/Pods-ExampleTests.release.xcconfig"; sourceTree = "<group>"; };
 		A4119074813D4DEC57006AEB /* Pods_Example_ExampleUITests.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Example_ExampleUITests.framework; sourceTree = BUILT_PRODUCTS_DIR; };
-		AFB4C5D2264003490018229B /* UIRouter.podspec */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; name = UIRouter.podspec; path = ../UIRouter.podspec; sourceTree = "<group>"; };
+		AFB4C5D2264003490018229B /* UIRouter.podspec */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; name = UIRouter.podspec; path = ../UIRouter.podspec; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = xcode.lang.ruby; };
 		AFF87535263D28E000234826 /* shell.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = shell.app; sourceTree = BUILT_PRODUCTS_DIR; };
 		AFF87538263D28E000234826 /* AppDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = "<group>"; };
 		AFF8753A263D28E000234826 /* SceneDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SceneDelegate.swift; sourceTree = "<group>"; };

Example/shell/ErrorDetailsViewController.swift

@@ -9,43 +9,41 @@ import UIKit
 
 class ErrorDetailsViewController: UITableViewController {
     let error: Error
-    let errorDetails: [(key: String,value: String)]
+    let errorDetails: [(key: String, value: String)]
 
     init(error: Error) {
         self.error = error
         if let localizedError = error as? LocalizedError {
-            var list: [(key: String,value: String)] = []
+            var list: [(key: String, value: String)] = []
             if let errorDescription = localizedError.errorDescription {
-                list.append(("简述",errorDescription))
+                list.append(("简述", errorDescription))
             }
             if let failureReason = localizedError.failureReason {
-                list.append(("原因",failureReason))
-
+                list.append(("原因", failureReason))
             }
             if let helpAnchor = localizedError.helpAnchor {
-                list.append(("解决",helpAnchor))
-
+                list.append(("解决", helpAnchor))
             }
             if let recoverySuggestion = localizedError.recoverySuggestion {
-                list.append(("恢复",recoverySuggestion))
-
+                list.append(("恢复", recoverySuggestion))
             }
-            errorDetails = list
-        }else {
-            errorDetails = [("错误",error.localizedDescription)]
+            self.errorDetails = list
+        } else {
+            self.errorDetails = [("错误", error.localizedDescription)]
         }
         super.init(style: .insetGrouped)
     }
 
+    @available(*, unavailable)
     required init?(coder: NSCoder) {
         fatalError("init(coder:) has not been implemented")
     }
-    
+
     override func viewWillAppear(_ animated: Bool) {
         super.viewWillAppear(animated)
-        self.title = "错误信息"
+        title = "错误信息"
     }
-    
+
     override func viewDidLoad() {
         super.viewDidLoad()
         tableView.allowsSelection = false

Example/shell/MainViewController.swift

@@ -8,9 +8,11 @@
 import UIKit
 import UIRouter
 class MainViewController: UITableViewController {
-    let routes = [(name: "SubModule", path: "sub"),
-                  (name: "Baidu", path: "https://www.baidu.com"),
-                  (name: "用户简介", path: "user/profile")]
+    let routes = [
+        (name: "SubModule", path: "sub"),
+        (name: "Baidu", path: "https://www.baidu.com"),
+        (name: "用户简介", path: "user/profile")
+    ]
 
     override func viewDidLoad() {
         super.viewDidLoad()

Example/shell/RouteErrorHandler.swift

@@ -17,7 +17,5 @@ class RouteErrorHandler: RouteErrorHandling {
         #endif
     }
 
-    func handleCustomError(_ error: Error) {
-        
-    }
+    func handleCustomError(_ error: Error) {}
 }

README.md

@@ -54,19 +54,17 @@ public final class UserProfileViewController: UIViewController {}
 // MARK: 路由
 
 extension UserProfileViewController: Routable {
-    public static func route(parameters: RouterParameters, completion: @escaping RouteCompletionHandler<UserProfileViewController>) {
-        // 对参数进行验证，成功返回 ViewController,失败则返回错误，
-        // 这里返回的是参数验证错误，也可以返回业务自定义错误。
-        if let userID: String = parameters.get("name") {
+    public static var paths: [String] {
+        ["user/profile/:id"]
+    }
+
+    public static func route(parameters: RouterParameters, object: Any?, completion: @escaping RouteCompletionHandler<UserProfileViewController>) {
+        if let userID: String = parameters.get("userID") {
             completion(.success(UserProfileViewController()))
         } else {
-            completion(.failure(RouteError.parameterValidationFailed(url: path, name: "name")))
+            completion(.failure(RouteError.parameterValidationFailed(vcType: Self.self, name: "userID")))
         }
     }
-
-    public static var path: String {
-        "user/profile/:id"
-    }
 }
 ```
 ### 页面路由

Source/Core/Routable.swift

@@ -10,7 +10,7 @@ import UIKit
 
 public protocol RouteBase: UIViewController {
     static var paths: [String] { get }
-    static func routeVC(parameters: RouterParameters, completion: @escaping RouteCompletionHandler<UIViewController>)
+    static func routeVC(parameters: RouterParameters, object: Any?, completion: @escaping RouteCompletionHandler<UIViewController>)
 }
 
 /// 需要通过路由解耦的 `UIViewController` 实现此协议后,路由中心将会自动完成组件的注册
@@ -19,13 +19,14 @@ public protocol Routable: RouteBase {
     /// 路由中心通过路由链接到指定 `UIViewController` 后由此回调进行页面构造
     /// - Parameters:
     ///   - parameters: 由路由 `URL` 解析后传递的参数
+    ///   - object: 业务对象
     ///   - completion: 验证参数后构造页面通过回调返回结果
-    static func route(parameters: RouterParameters, completion: @escaping RouteCompletionHandler<Self>)
+    static func route(parameters: RouterParameters, object: Any?, completion: @escaping RouteCompletionHandler<Self>)
 }
 
 public extension Routable {
-    static func routeVC(parameters: RouterParameters, completion: @escaping RouteCompletionHandler<UIViewController>) {
-        route(parameters: parameters) { result in
+    static func routeVC(parameters: RouterParameters, object: Any?, completion: @escaping RouteCompletionHandler<UIViewController>) {
+        route(parameters: parameters, object: object) { result in
             completion(result.map { $0 as UIViewController })
         }
     }