README_CN.md

Apis

       

基于URLNavigator 抽象的路由组件, 灵感来自 Moya.

Features

• 支持基于插件机制的不同处理 如登录拦截等.
• 配置独立且易于管理.
• 良好的业务可扩展性.
• 安全的页面管理.
• 支持异步完成结果回调.

安装

Apis 仅支持CocoaPods.

CocoaPods - Podfile

pod 'Apis'

使用

首先导入framework:

import Apis

下面是一些简单示例. 支持所有设备和模拟器:

创建 Apis

let router = Apis.Provider<RouterTarget>(
    [RouterXXXXXXPlugin(),
     RouterXXXXXXPlugin(),
     RouterXXXXXXPlugin()]
)

TargetType

// 可以通过枚举声明所有类型 
enum RouterTarget {
    case open_http(url: URL)
    case open_https(url: URL)
    case open_none
    case open_live(id: String)
    case open_some
}

extension RouterTarget: Apis.TargetType {
    
    var task: Task {
        switch(self) {
        case let .open_http(url):
            return .controller(SFSafariViewController(url: url))
            
        case let .open_https(url):
            return .controller(SFSafariViewController(url: url))
            
        case .open_none:
            return .controller(NoneViewController())
            
        case let .open_live(id):
            let controller = LiveViewController()
            controller.id = id
            return .controller(controller)
            
        case .open_some:
            return .handle { completion in
                // 处理一些其他事情, 结束后务必调用completion回调
                DispatchQueue.main.asyncAfter(deadline: .now() + 2) {
                    // 巴拉巴拉..
                    completion(true)
                }
            }
        }
    }
}

// 每个支持路由的视图控制器需要实现 Routerable 协议
extension XXXXViewController: Routerable { }
extension SFSafariViewController: Routerable { }

URLTargetType

private let schemes = "router"

extension RouterTarget: URLTargetType {
    // URL模板绑定 不同的模板返回不同的Target
    static var bindings: [URLPatternBinding<RouterTarget>] {
        return [
            .init("http://<path:_>") { source in
                guard let url = source.url.value else { return .none }
                return .open_http(url: url)
            },
            .init("https://<path:_>") { source in
                guard let url = source.url.value else { return .none }
                return .open_https(url: url)
            },
            .init(schemes + "://open/none") {
                return .open_none
            },
            .init(schemes + "://open/live") { source in
                guard let id = source.url.queryParameters["id"] else { return nil }
                return .open_live(id: id)
            },
            .init(schemes + "://open/some") {
                return .open_some
            }
        ]
    }
}

自定义插件

// 实现需要的方法 你可以在整个打开过程中做一切你想做的事情
class RouterXXXXPlugin: Apis.PluginType {
    
    // 能否打开
    func should(open target: TargetType) -> Bool {
        /* ... */
        return true
    }
    
    // 准备打开时
    func prepare(open target: TargetType, completion: @escaping (Bool) -> Void) {
        /* ... */
        completion(true)
    }
    
    // 即将打开
    func will(open target: TargetType, controller: Routerable) {
        /* ... */
    }
    
    // 已经打开
    func did(open target: TargetType, controller: Routerable) {
        /* ... */
    }
}

打开

// 根据目标类型打开页面
router.open(.open_xxxx)

// 根据URL打开页面
router.open("http://xxxxxxxx")

// 打开结果回调  打开过程中可能由于各种原因导致打开失败 例如: 这个页面需要登录 但是当前没有登录之类的
router.open("http://xxxxxxxx") { (result) in
    // 成功或失败
}

贡献

如果你需要实现特定功能或遇到错误，请打开issue。 如果你自己扩展了Apis的功能并希望其他人也使用它，请提交拉取请求。

协议

Apis 使用 MIT 协议. 有关更多信息，请参阅 LICENSE 文件.