English

如果您需要的是快速集成多个调试功能,例如日志查看、网速测试、文件查看等功能,请使用 DamonHu/DDKitSwiftSwift

DDKitSwiftDDKitSwift插件的支撑框架,面向的对象是DDKitSwift插件的开发。该框架提供了插件显示、管理等功能,只需要实现对应的DDKitSwiftPluginProtocol协议,即可快速的开发出DDKitSwift插件并显示使用。该文档提供了插件开发教程和使用教程,开发者可以根据需要查看。

天地不仁,以万物为刍狗
-诛仙

开发一个DDKitSwift插件

如果需要开发自定义插件,只需要实现DDKitSwiftPluginProtocol即可。实现的方式很简单。

1、导入核心文件

项目导入DDKitSwift,可使用cocoapods快速导入核心文件

pod 'DDKitSwift'

2、实现协议

声明一个对象,遵守DDKitSwiftPluginProtocol协议即可。分别返回对应插件的唯一标识,对应的icon、插件名字、插件类型分组、启动函数

class PluginDemo: NSObject {
    var isPluginRunning = true
}

extension PluginDemo: DDKitSwiftPluginProtocol {
     //唯一标识
    var pluginIdentifier: String {
        return "com.DDKitSwift.pluginDemo"
    }
    
    var pluginIcon: UIImage? {
        return UIImage(named: "DDKitSwift")
    }

    var pluginTitle: String {
        return "插件标题"
    }

    var pluginType: DDKitSwiftPluginType {
        return .ui
    }

    func start() {
        print("点击启动该插件")
        isPluginRunning = true
    }
    
    var isRunning: Bool {
        return isPluginRunning
    }

    func stop() {
        print("插件停止运行")
        isPluginRunning = false
    }
}

可选协议

func willStart()
func willStop()

3、注册插件

之后注册插件即可,全局只需注册一次即可

DDKitSwift.regist(plugin: PluginDemo())

4、完成

cocoapods发布上线之后,当用户打开DDKitSwift时,调试集合页就会出现您的插件

5、自定义配置

5.1、可通过修改UIConfig修改窗口颜色等显示

DDKitSwift.UIConfig

5.2、调试文件夹,悬浮菜单分享时会将该文件夹打包分享

DDKitSwift.DebugFolderPath

5.3、显示输入框

DDKitSwift.show(.input(placeholder: "placeholder", text: nil, endEdit: { text in
      print(text)
}))

5.4、更新悬浮图标

let config = DDKitSwiftButtonConfig(title: "test\(i)")
DDKitSwift.updateFloatButton(config: config, plugin: PluginDemo())

5.5、输出调试数据到悬浮窗

printError("error")

消息通知

DDKitSwift提供了以下消息通知,您可以通过绑定以下通知获取框架显示、隐藏、关闭、注册新插件的时机

//注册新插件
NSNotification.Name.DDKitSwiftPluginRegist
//显示
NSNotification.Name.DDKitSwiftShow
//隐藏
NSNotification.Name.DDKitSwiftHide
//关闭
NSNotification.Name.DDKitSwiftClose

安装使用DDKitSwift插件

DDKitSwift插件使用很简单,只需要导入对应的库,在AppDelegate启动函数注册即可。例如安装日志插件DDKitSwiftLogger

首先pod安装对应插件

pod 'DDKitSwiftLogger/DDKitSwift'

注册插件

DDKitSwift.regist(plugin: DDKitSwiftLogger.shared)

打开插件列表

DDKitSwift.show()

隐藏插件列表

DDKitSwift.hide()

关闭插件列表

DDKitSwift.close()

DDKitSwiftSwift

我们发布了一个cocoaPods库,名字叫DDKitSwiftSwift,这是一个集成了多个DDKitSwift插件的工具库。可以帮助你快速使用多个调试功能。

License

DDKitSwift 基于 MIT license 发布。


☟☟可点击下方广告支持一下☟☟

最后修改:2024 年 05 月 27 日
请我喝杯可乐,请随意打赏: ☞已打赏列表