NNModule-swift 用于 Swift 项目的模块管理，主要用于业务模块之间的解耦（以协议的方式进行解耦）， 希望通过 NNModule 向大家提供一种思路，对遇到类似问题的同学能有所启发。
NNModule-swift 提供的功能如下：
Swift 与 OC 通用功能
- 组件化管理器：ModuleManager
- 路由：URLRouter
- 带黏连值的 Notification：StickyNotification
仅 Swift 支持的功能
- 事件传输：EventTransfer
| 版本号 | 备注 |
|---|---|
| v1.0.5 | 正式版 |
| v1.0.6 | ModuleManager，URLRouter，StickyNotification 支持 OC |
在使用 NNModule-swift 之前建议阅读ModuleManager设计介绍来理解服务解耦以及如何注册服务。另外提供了一个Example App来方便更好地理解。
使用以下代码替换AppDelegate文件中的代码：
@main
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
override init() {
super.init()
// Ensure that `ModuleManager.shared` is created first
_ = ModuleManager.shared
}
func application(
_ application: UIApplication,
willFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil
) -> Bool {
ModuleManager.shared.application(application, willFinishLaunchingWithOptions: launchOptions)
}
func application(
_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
) -> Bool {
ModuleManager.shared.application(application, didFinishLaunchingWithOptions: launchOptions)
}
override func forwardingTarget(for aSelector: Selector!) -> Any? { Module.applicationService }
override func responds(to aSelector: Selector!) -> Bool {
super.responds(to: aSelector) || Module.applicationService.responds(to: aSelector)
}
}ModuleRouteService 提供了路由功能，具体定义可以查看ModuleRouteService。
ModuleRouteService的 Impl 类是内部的 URLRouter，路由完整的使用方式可以查看URLRouter。
在你需要的业务组件创建 Module.Awake（用于为功能类服务添加注册类服务）分类并添加类方法，在类方法中完成路由的注册。这里要注意添加的类方法必须是带 @objc 标记的，至于方法名字可以随意写，甚至你不怕项目警告多的话可以使用同一个函数名比如 awake（即使存在同名函数的类方法在调用过程中也不会被覆盖），具体原因可以阅读方案2：调用指定类方法列表中的所有方法。
extension Module.Awake {
@objc static func aModuleAwake() {
Module.routeService.registerRoute("A2Page") { url, navigator in
print(url.parameters)
navigator.push(A2ViewController())
return true
}
}
}Module.routeService.openRoute("A2Page", parameters: ["model": self])ModuleTabService 用于获取项目中 TabBar 相关的功能，具体定义可以查看ModuleTabService。
extension Module.Awake {
@objc static func applicationModule() {
if let cls = NSClassFromString("TabBarController.TabBarController"),
let tabBarType = cls as? UITabBarController.Type {
Module.tabService.tabBarControllerType = tabBarType
}
}
}RegisterTabItemService 提供为 ModuleTabService 注册 tabBarItem 的功能，具体定义可以查看RegisterTabItemService。
注册 tabBar item 示例代码如下：
extension Module.Awake {
@objc static func bModuleAwake() {
// 为 tabService 添加 BModuleImpl
Module.tabService.addRegister(BModuleImpl.self)
Module.launchTaskService.addRegister(ModuleLaunchTaskTest.self)
}
}
class BModuleImpl: NSObject, RegisterTabItemService {
func registerTabBarItems() -> [TabBarItemMeta] {
let bundle = resourceBundle(of: "BModule")
let nav = UINavigationController(rootViewController: UserViewController())
let image = UIImage(named: "tabbar_user_normal", in: bundle, compatibleWith: nil)
let selectedImage = UIImage(named: "tabbar_user_normal", in: bundle, compatibleWith: nil)
nav.tabBarItem = ESTabBarItem(NormalTabBarItemContentView(), title: "user", image: image, selectedImage: selectedImage)
let meta = TabBarItemMeta(viewController: nav, tabIndex: 2)
return [meta]
}
override required init() {
super.init()
}
}除了上面提到的基础服务外还有ModuleNotificationService（通知）、、ModuleLaunchTaskService(启动任务)，用法和上面类似这里就不一一介绍了。
其他可以查看
项目中除了上面提到的基础服务外，还有很多关于业务的服务，这些是要我们自己创建并注册的。 以登录为例演示如何创建自定义的服务，这里的服务指的是功能类服务。
定义LoginService用于提供登录相关的功能
// Login service
public protocol LoginService: ModuleFunctionalService {
/// the main viewController of LoginModule
var loginMain: UIViewController { get }
var isLogin: Bool { get }
func logout()
}
/// The notification of Login
public extension Notification.Name {
static var didLoginSuccess: Notification.Name { .init("didLoginSuccess") }
static var didLogoutSuccess: Notification.Name { .init("didLogoutSuccess") }
}我们会使用一个组件存放所有需要跨模块通信的服务，所有的业务组件都会依赖这个组件。
定义LoginService impl
一般登录相关的逻辑与相关页面我们会放在一个叫 LoginModule的组件中，其中就包含了LoginService的Impl，我们就叫做LoginManager吧。
LoginManager的实现如下：
extension Module.RegisterService {
@objc static func registerLoginService() {
Module.register(service: LoginService.self, used: LoginManager.self)
}
}
internal final class LoginManager: LoginService {
static let shared = LoginManager()
static var implInstance: ModuleBasicService { shared }
var isLogin: Bool = false
required init() {}
var loginMain: UIViewController {
UINavigationController(rootViewController: LoginViewController())
}
func logout() { updateLoginStatus(false) }
private func updateLoginStatus(_ loginStatus: Bool) {
isLogin = loginStatus
let notification: Notification.Name = loginStatus ? .didLoginSuccess : .didLogoutSuccess
Module.notificationService.post(name: notification)
}
}由于ModuleApplicationService通常作为第一个被加载的service，其默认Impl内没有任何逻辑，而在项目中该服务的Impl是一定需要替换，所以我们就以ModuleApplicationService作为例子来演示如何替换已有服务的Impl。
我们可以创建一个 ApplicationModule 的组件，该组件内部有一个ApplicationModuleImpl 类作为 ModuleApplicationService 的实现类。
代码如下：
extension Module.RegisterService {
// 注册服务，注册服务时不会创建 Impl 对应的实例，实例创建发生在第一次使用service 时
@objc static func applicationModule() {
// 替换 ModuleApplicationService 的 Impl
Module.register(service: ModuleApplicationService.self, used: ApplicationModuleImpl.self)
// 使用自定义 router 替换 ModuleRouteService 的 Impl
Module.register(service: ModuleRouteService.self, used: ApplicationRouter.self)
// 应用的配置内容
Module.register(service: ModuleConfigService.self, used: ModuleConfigServiceImpl.self)
}
}
class ApplicationModuleImpl: NSObject, ModuleApplicationService {
// 提高 implPriority 的值用于替换原有的impl
static var implPriority: Int { 100 }
var window: UIWindow?
required override init() {
super.init()
// 项目初始化的相关代码，可以放在 applicationWillAwake() 函数中执行
}
// 在调用 Module.Awake 的类方法列表前调用该方法，确保调用 Module.Awake 的类方法时相关的服务能正确使用
func applicationWillAwake() {
let config = Module.service(of: ModuleConfigService.self)
Module.tabService.tabBarControllerType = config.tabBarControllerType
}
func application(
_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]?
) -> Bool {
requestRedirectRoutes()
setupAppearance()
addNotification()
reloadMainViewController()
return true
}
func reloadMainViewController() {}
private func addNotification() {
let notificationImpl = Module.notificationService
notificationImpl.addObserver(forName: .didLogoutSuccess) { [weak self] _ in
self?.reloadMainViewController()
}.disposed(by: self)
notificationImpl.addObserver(forName: .didLoginSuccess) { [weak self] _ in
self?.reloadMainViewController()
}.disposed(by: self)
}
private func requestRedirectRoutes() { }
private func setupAppearance() {}
}iOS 10+
NNModule-swift 支持对单个功能的单独引用
# 全量安装
pod 'NNModule-swift'
# ModuleManager 安装
pod 'NNModule-swift/ModuleManager'
# URLRouter 安装
pod 'NNModule-swift/URLRouter'
# EventTransfer 安装
pod 'NNModule-swift/EventTransfer'
# StickyNotification 安装
pod 'NNModule-swift/StickyNotification'这里提供了一个Example App来方便更好地理解。
- 下载 Example App
- 运行
pod install或者pod update - 编译并运行 App
NeroXie, [email protected]
NNBox 基于 MIT 许可证，查看 LICENSE 文件了解更多信息。