Skip to content

Commit 06f9eb3

Browse files
author
yixiang
committed
更新iOS接入文档适应1.1.4
1 parent 0ca0cdc commit 06f9eb3

File tree

1 file changed

+13
-21
lines changed

1 file changed

+13
-21
lines changed

Doc/iOS_cn_guide.md

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,35 @@
11
## DoraemonKit如何使用
22

3-
### 3.1: cocoapods依赖
4-
包含两个subspec,一个是包含“日志显示”的“WithLogger” subspec
3+
### 1、cocoapods依赖
54

65
```
7-
pod 'DoraemonKit/WithLogger', '1.1.3', :configurations => ['Debug']
6+
pod 'DoraemonKit/Core', '~> 1.1.4', :configurations => ['Debug']
7+
pod 'DoraemonKit/WithLogger', '~> 1.1.4', :configurations => ['Debug']
8+
pod 'DoraemonKit/WithGPS', '~> 1.1.4', :configurations => ['Debug']
89
```
10+
Core subspec作为核心,必须引入。
911

10-
一个是不包含“日志显示”的“Core” subspec
12+
如果你的日志是基于CocoaLumberjack,那你也可以引入WithLogger subspec
1113

12-
```
13-
pod 'DoraemonKit/Core', '1.1.3', :configurations => ['Debug']
14-
```
14+
MockGPS存在一些兼容性问题(绝大部分情况是好的,问题详见[https://github.com/didi/DoraemonKit/issues/35](https://github.com/didi/DoraemonKit/issues/35)), 如果你的app接入MockGPS存在问题的话,可以不用引入WithGPS subspec。
1515

16-
默认引入“Core” subspec。
1716

18-
tip1:为什么要分区subspec呢?
19-
因为日志显示模块是基于CocoaLumberjack这个三方库,如果你的项目日志不是基于CocoaLumberjack,那你就没有必要引入DoraemonKit中日志显示模块了。
17+
**tip**:只在Debug环境中进行集成,不要带到线上。有一些hook操作会污染线上代码。
2018

21-
tip2:只在Debug环境中进行集成,不要带到线上。有一些hook操作会污染线上代码。
22-
23-
### 3.2: 使用DoraemonKit内置工具集的接入方式
19+
### 2、使用DoraemonKit内置工具集的接入方式
2420
在App启动的时候添加一下代码
2521

2622
```
2723
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
2824
#ifdef DEBUG
29-
[[DoraemonManager shareInstance] addH5DoorBlock:^(NSString *h5Url) {
30-
//使用自己的H5容器打开这个链接
31-
}];
32-
3325
[[DoraemonManager shareInstance] install];
3426
#endif
3527
}
3628
```
3729

38-
通过以上步骤你就可以使用DorameonKit所有的内置工具集合。如果你想把自己与业务相关的一些工具代码加入到DoraemonKit中做统一管理的话,你可以按照3.3的步骤来做
30+
通过以上步骤你就可以使用DorameonKit所有的内置工具集合。如果你想把自己与业务相关的一些工具代码加入到DoraemonKit中做统一管理的话,你可以按照3的步骤来做
3931

40-
### 3.3: 添加自定义测试模块到Doraemon面板中(非必要)
32+
### 3添加自定义测试模块到Doraemon面板中(非必要)
4133
比如我们要在Doraemon面板中添加一个环境切换的功能。
4234

4335
第一步:新建一个类,实现KDDoraemonPluginProtocol协议中的pluginDidLoad方法,该方法就是以后点击Doraemon工具面板中“环境切换”按钮触发的事件。
@@ -59,7 +51,7 @@ tip2:只在Debug环境中进行集成,不要带到线上。有一些hook操
5951
调用DoraemonManager的以下方法:
6052

6153
```
62-
[[DoraemonManager shareInstance] addPluginWithTitle:@"环境切换" icon:@"qiehuang" desc:@"用于app内部环境切换功能" pluginName:@"KDDoraemonEnvPlugin" atModule:@"业务专区"];
54+
[[DoraemonManager shareInstance] addPluginWithTitle:@"环境切换" icon:@"doraemon_default" desc:@"用于app内部环境切换功能" pluginName:@"KDDoraemonEnvPlugin" atModule:@"业务专区"];
6355
```
6456

6557
依次代表 集成到DoraemonKit面板中的标题,图标,描述,插件名称,和所属于的模块。
@@ -74,7 +66,7 @@ tip2:只在Debug环境中进行集成,不要带到线上。有一些hook操
7466
}
7567
//配置Doraemon工具集
7668
- (void)configDoraemonKit{
77-
[[DoraemonManager shareInstance] addPluginWithTitle:@"环境切换" icon:@"qiehuang" desc:@"用于app内部环境切换功能" pluginName:@"KDDoraemonEnvPlugin" atModule:@"业务专区"];
69+
[[DoraemonManager shareInstance] addPluginWithTitle:@"环境切换" icon:@"doraemon_default" desc:@"用于app内部环境切换功能" pluginName:@"KDDoraemonEnvPlugin" atModule:@"业务专区"];
7870
[[DoraemonManager shareInstance] addH5DoorBlock:^(NSString *h5Url) {
7971
[APP_INTERACOTR.rootNav openURL:@"KDSJ://KDWebViewController" withQuery:@{@"urlString":h5Url}];
8072
}];

0 commit comments

Comments
 (0)