背景

由於後端採用 meteor.js 進行開發，移動端適配方案很容易讓人想到 web app 的開發模式。但這種直接適配的方法有很強的侷限性。雖然 hybrid 也已經不是什麼稀奇的方案，但 web 功能依舊和本地功能有一定的分離感。比如，meteor 監聽的某個資源想要和本地 API 獲取的其他資源在同一個列表中顯示。那單純的使用 web 是沒法解決的。唯一的辦法就是分別加載 meteor 和 API 資源，然後將他們整合在一起。那我們又該如何加載 meteor 的資源呢？

正文

我們先來看一下 SwiftDDP 的目錄結構

這裏面最重要的文件是 Meteor.swift 和 DDPClient.swift。客戶端與服務端連接以及數據交互的主要邏輯都在這裏。

二次封裝

對第三方庫進行二次封裝的好處在於：

根據業務需要過濾不需要的接口
如果後期需要更換第三方庫，可以減少對上層調用者的修改

以下是對 SwiftDDP 進行的簡單封裝

/// MeteorWrapper.swift 暴露所有與 Meteor 相關的接口。對上層使用者來說只需要知道這一個類即可。
/// 在 AppDelegate 中調用 initMeteor(:)。需要注意在調用 login(:) 之前必須先 connectServer(:) ，且要保證連接成功

public typealias InitCollectionCallback = () -> ()

class MeteorWrapper {
    
    // UI 界面需要實現 ContentLoading protocol
    var contentLoading: ContentLoading?
    
    // 用於管理 subscribers
    var subscriberLoader: SubscriberLoader = SubscriberLoader()
    
    // 單例
    class var shared: MeteorWrapper {
        struct Static {
            static let instance: MeteorWrapper = MeteorWrapper()
        }
        
        return Static.instance
    }
    
    func initMeteor(collections: InitCollectionCallback?) {
        Meteor.client.allowSelfSignedSSL = false
        Meteor.client.logLevel = .debug
        
        NotificationCenter.default.addObserver(self, selector: #selector(ddpUserDidLogin), name: NSNotification.Name(rawValue: DDP_USER_DID_LOGIN), object: nil)
        NotificationCenter.default.addObserver(self, selector: #selector(ddpUserDidLogout), name: NSNotification.Name(rawValue: DDP_USER_DID_LOGOUT), object: nil)
        NotificationCenter.default.addObserver(self, selector: #selector(ddpWebSocketClose), name: NSNotification.Name(rawValue: DDP_WEBSOCKET_CLOSE), object: nil)
        NotificationCenter.default.addObserver(self, selector: #selector(ddpWebSocketError), name: NSNotification.Name(rawValue: DDP_WEBSOCKET_ERROR), object: nil)
        NotificationCenter.default.addObserver(self, selector: #selector(ddpDisconnected), name: NSNotification.Name(rawValue: DDP_DISCONNECTED), object: nil)
        NotificationCenter.default.addObserver(self, selector: #selector(ddpFailed), name: NSNotification.Name(rawValue: DDP_FAILED), object: nil)
        
        collections?()
    }
    
    open func connectServer(callback: DDPCallback? = nil) {
        Meteor.connect(MeteorConfig.webSocketURL) {
            self.contentLoading?.contentLoadingState = .connected
            
            callback?()
        }
    }
    
    open func login(callback: DDPMethodCallback?) {
        guard let email = MeteorConfig.loginEmail, let password = MeteorConfig.loginPassword else {
            return
        }
        
        Meteor.loginWithPassword(email, password: password, callback: callback)
    }
    
    open func login() {
        guard let email = MeteorConfig.loginEmail, let password = MeteorConfig.loginPassword else {
            return
        }
        
        Meteor.loginWithPassword(email, password: password)
    }
    
    open func logout(callback: DDPMethodCallback? = nil) {
        Meteor.logout(callback)
    }
    
    open func getUserId() -> String? {
        return Meteor.client.userId()
    }
    
    /**
     獲取collection的results
     */
    open func getCollectionRealm<T: MeteorDocumentRealm>(_ name: String, className: T.Type) -> Results<T> {
        return (Meteor.collection(name) as! MeteorCollectionRealm<T>).getCollection()
    }
    

// MARK: - Websocket/DDP connection failure events
    @objc fileprivate func ddpUserDidLogin() {
    }
    
    @objc fileprivate func ddpUserDidLogout() {
    }
    
    @objc fileprivate func ddpWebSocketClose() {
        contentLoading?.contentLoadingState = .websocket_close
    }
    
    @objc fileprivate func ddpWebSocketError() {
        contentLoading?.contentLoadingState = .websocket_error
    }
    
    @objc fileprivate func ddpDisconnected() {
        contentLoading?.contentLoadingState = .disconnected
    }
    
    @objc fileprivate func ddpFailed() {
        contentLoading?.contentLoadingState = .failed
    }
    
}

客戶端監聽器的封裝，向服務端發起監聽請求和清除監聽。

/// SubscriberLoader.swift

/*
  SubscriberLoader 用於創建 collection 的監聽和管理
 */

class SubscriberLoader {
    
    // store subscriber id
    fileprivate var subscribers: [String] = []
    
    func addSubscribers(_ withName: String, params: [Any]?, readyCallback: DDPCallback?) -> String?{
        var ids:String? = nil
        if let params = params {
            ids = Meteor.subscribe(withName, params: params, callback: readyCallback)
        } else {
            ids = Meteor.subscribe(withName, callback: readyCallback)
        }
        
        guard ids != nil else {
            return nil
        }
        
        subscribers.append(ids!)
        return ids
    }
    
    func removeAllSubscribers() {
        for id in subscribers {
            Meteor.unsubscribe(withId: id)
        }
    }
    
    func removeSubscriber(withName name: String) {
        Meteor.unsubscribe(name, callback: nil)
    }
    
    func removeSubscriber(withId id: String) {
        Meteor.unsubscribe(withId: id)
    }
}

對應 DDP 的各種連接狀態。實現 ContentLoading 協議，向上層通知 DDP 的狀態

// 用於存儲 DDP WebSocket 狀態，並且更新狀態給 UI
protocol ContentLoading {
    var contentLoadingState: ContentLoadingState { get set }
    
    func loadContentIfNeeded()
}

enum ContentLoadingState: CustomStringConvertible {
    case initial
    case loading
    case loaded
    case error
    case offline
    case connected
    case disconnected
    case websocket_close
    case websocket_error
    case failed
    
    var description: String {
        switch self {
        case .initial:
            return "Initial"
        case .loading:
            return "Loading"
        case .loaded:
            return "Loaded"
        case .error:
            return "Error"
        case .offline:
            return "Offline"
        case .connected:
            return "Connected"
        case .disconnected:
            return "Disconnected"
        case .websocket_close:
            return "DDP Websocket Close"
        case .websocket_error:
            return "DDP Websocket Error"
        case .failed:
            return "DDP Failed"
        }
    }
}

如果你已經瞭解過 SwiftDDP 的使用方法，你一定知道她的數據都是存放在緩存裏的。那如果需要將數據持久化到本地該如何呢？沒錯，那就需要重寫 MeteorDocument 和 MeteorCollection。

/// 與 MeteorDocument 基本一致，唯一的區別就是繼承了 RealmSwift 的 Object，並配置 _id 爲 主鍵。
/// 她的使用方法和 MeteorDocument 也一樣。
/// 之所在字段前面加了下劃線，是因爲自己的項目中有一個字段和swift關鍵字產生衝突
class MeteorDocumentRealm: Object{
    
    dynamic var _id:String = ""
    
    open override class func primaryKey() -> String? {
        return "_id"
    }
    
    
// MARK: -- 借用 MeteorDecument 處理數據的方法
    open func initData(id: String, fields: NSDictionary?) {
        self._id = id
        if let properties = fields {
            for (key,value) in properties  {
                if !(value is NSNull) {
                    self.setValue(value, forKey: "_"+(key as! String))
                }
            }
        }
    }
    
    open func update(_ fields: NSDictionary?, cleared: [String]?) {
        if let properties = fields {
            for (key,value) in properties  {
                print("Key: \(key), Value: \(value)")
                self.setValue(value, forKey: "_"+(key as! String))
            }
        }
        
        if let deletions = cleared {
            for property in deletions {
                self.setNilValueForKey("_"+property)
            }
        }
    }
    
    /*
     Limitations to propertyNames:
     - Returns an empty array for Objective-C objects
     - Will not return computed properties, i.e.:
     - If self is an instance of a class (vs., say, a struct), this doesn't report its superclass's properties, i.e.:
     see http://stackoverflow.com/questions/24844681/list-of-classs-properties-in-swift
     */
    
    func propertyNames() -> [String] {
        return Mirror(reflecting: self).children.filter { $0.label != nil }.map { $0.label! }
    }
    
    
    /*
     This method should be public so users of this library can override it for parsing their variables in their MeteorDocument object when having structs and such in their Document.
     */
    open func fields() -> NSDictionary {
        let fieldsDict = NSMutableDictionary()
        let properties = propertyNames()
        
        for name in properties {
            if var value = self.value(forKey: name) {
                if value as? Date != nil {
                    value = EJSON.convertToEJSONDate(value as! Date)
                }
                
                fieldsDict.setValue(value, forKey: name)
            }
        }
        
        fieldsDict.setValue(self._id, forKey: "_id")
        print("fields \(fieldsDict)")
        return fieldsDict as NSDictionary
    }
}

MeteorCollectionRealm 看起來就精簡了很多。可能你會問這裏沒有了變更通知，上層該怎麼知道數據發生了變化呢？因爲我們用了 Realm。這裏先留個懸念~~

class MeteorCollectionRealm<T: MeteorDocumentRealm>: AbstractCollection{
   
    public override init(name: String) {
        super.init(name: name)
    }
    
    /**
     獲取 collection 的所有結果
     */
    var realm: Realm?
    open func getCollection() -> Results<T> {
        if realm == nil {
            realm = try! Realm()
        }
        return realm!.objects(T.self)
    }
    
    override func documentWasAdded(_ collection: String, id: String, fields: NSDictionary?) {
        let document = T()
        document.initData(id: id, fields: fields)
        
        let realm = try? Realm()
        try! realm?.write {
            realm?.add(document, update: true)
        }
        
    }
    
    override func documentWasChanged(_ collection: String, id: String, fields: NSDictionary?, cleared: [String]?) {
        let realm = try? Realm()
        let document = realm?.objects(T.self).filter(NSPredicate(format: "_id = %@", id))
        
        if document != nil && (document?.count)! > 0 {
            try! realm?.write {
                document?.first?.update(fields, cleared: cleared)
                realm?.add((document?.first)!, update: true)
            }
        }
        
    }
    
    override func documentWasRemoved(_ collection: String, id: String) {
        let realm = try? Realm()
        let document = realm?.objects(T.self).filter(NSPredicate(format: "_id = %@", id))
        
        if document != nil && (document?.count)! > 0 {
            try! realm?.write {
                realm?.delete((document?.first)!)
            }
        }
    }

 // todo : insert 、update、 remove 等本地請求更新數據到服務器端的方法
}

基本的封裝做完了，接下來舉個例子來說說該怎麼用吧。

/// AppDelegate.swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
...

      // 初始化 MeteorWarper 組件
        MeteorConfig.loginEmail = "[email protected]"
        MeteorConfig.loginPassword = "password"
        MeteorWrapper.shared.initMeteor { 
            // XXFields 繼承 MeteorDocumentRealm ，並遵循 Realm object 的構建即可
            _ = MeteorCollectionRealm<ThreadFields>(name: "threads")
            _ = MeteorCollectionRealm<MessageFields>(name: "messages")
            ....
            MeteorWrapper.shared.contentLoading = self
        }
...
}


/// login.swift 登陸相關的操作類，當然也可以根據具體的情況而定
// 登陸成功後的返回操作中
// meteor ddp
        MeteorWrapper.shared.connectServer {
            MeteorWrapper.shared.login() { (result , error) in
                if error == nil {
                    let listsPage = 4
                    TSProgressHUD.ts_showWithStatus("加載數據中.....")
                    // 這裏的參數是根據服務器需要給的，視情況而定
                    _ = MeteorWrapper.shared.subscriberLoader.addSubscribers("threads", params: [[:], ["limit":listsPage * 15,"sort":["lastMessageAt":-1]]], readyCallback: {
                        TSProgressHUD.ts_dismiss()
                    })
                }
            }
        }


// 合適的地方註銷監聽
_ = MeteorWrapper.shared.subscriberLoader.removeSubscriber(withName: "threads")

封裝的思路

看完代碼後，終於要說說封裝的思路了。其實二次封裝沒什麼可說的，就是一個類似 Helper 的單例類。更有意思的地方應該是 Realm 和 SwiftDDP 的結合。這種火花的摩擦很美妙，讓人欲罷不能。
我們將業務劃分成兩個方面，一個是寫（通過 Meteor DPP 獲取服務端的數據，並將之寫入數據庫），另一個是讀（上層展示只需要讀取數據庫，不關心數據怎麼來的）。寫和讀是獨立的相互之間並不關心。她們只關注自己對數據庫的操作。對於上層展示，Realm天生提供了數據更新的解決方案，一切都變的如此簡單。這讓人想起 Android 中的 ContentProvider。內容提供者不會關心誰用了數據，她只關注數據的存儲和數據更新後的廣播通知。任務分離後，寫和讀也就隔離開來。
MeteorCollectionRealm 的角色就是寫入者，代碼也很簡單。唯一的問題就是要注意 Realm 操作線程的問題。

最後

項目結構的設計是一件很有意思的事情，不同的人有不同的方法和技巧。殊途同歸都是爲了能更清晰的劃分結構。
ps：最近狀態不佳，寫的有點亂。

iOS 接入 Meteor DDP

背景

相關知識

正文

二次封裝

封裝的思路

最後

換一種思路實現 - 九宮格羣頭像前言思路結束語

RESTful API 優化設計（Swift 版）背景 API 設計思考參考

iOS 接入 Meteor DDP 背景相關知識正文最後

RESTful API 優化設計（Swift 版）

iOS Application Extension 初體驗

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結