Skip to content

Commit 3464f71

Browse files
committed
更新了说明文档
1 parent d63c80a commit 3464f71

1 file changed

Lines changed: 30 additions & 4 deletions

File tree

README.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,20 @@ dependencies {
3131
class App : Application(), ITrackerContext {
3232
override fun onCreate() {
3333
super.onCreate()
34-
// 初始化AndroidTracker
35-
Tracker.initialize(this)
3634
// 设定一些通用的属性,这些属性在每次统计事件中都会附带
3735
// 注意:如果此处的属性名与内置属性的名称相同,则内置属性会被覆盖
3836
Tracker.addProperty("附加的属性1", "附加的属性1")
3937
Tracker.addProperty("附加的属性2", "附加的属性2")
4038
// 设定上报数据的主机和接口
39+
// 注意:该方法一定要在Tracker.initialize()方法前调用
40+
// 否则会由于上报地址未初始化,在触发启动事件时导致崩溃
4141
Tracker.setService("https://www.demo.com", "report.php")
4242
// 设定上报数据的项目名称
4343
Tracker.setProjectName("android_tracker")
4444
// 设定上报数据的模式
4545
Tracker.setMode(TrackerMode.RELEASE)
46+
// 初始化AndroidTracker
47+
Tracker.initialize(this)
4648
}
4749
}
4850
```
@@ -197,6 +199,21 @@ Tracker.addProperty("附加的属性1", "附加的属性1")
197199
Tracker.addProperty("附加的属性2", "附加的属性2")
198200
```
199201

202+
## 自定义事件
203+
204+
该库提供了追踪自定义事件的方法,并且可以自定义属性。调用示例如下:
205+
206+
kotlin:
207+
208+
```kotlin
209+
Tracker.trackEvent("MainActivity的自定义追踪事件", null)
210+
```
211+
212+
java:
213+
214+
```java
215+
Tracker.INSTANCE.trackEvent("MainActivity的自定义追踪事件", null)
216+
```
200217

201218
## 上报模式
202219

@@ -249,10 +266,19 @@ Tracker.addProperty("附加的属性2", "附加的属性2")
249266
}
250267
```
251268

252-
## 注意事项
269+
## 忽略处理
253270

254-
由于对点击事件的统计使用到了反射,故集成了该库之后会对点击时的效率有所影响。
271+
### 对Activity/Fragment进行忽略
255272

273+
如果需要对`Activity`/`Fragment`进行忽略,则需要实现`ITrackerIgnore`接口,并手动将`isIgnore()`方法的返回值置为`true`
274+
如果要解除对`Activity`/`Fragment`的忽略,则根据情况将返回值置为`false`即可。
275+
276+
### 对点击事件进行忽略
277+
278+
如果要对点击事件进行忽略,则需要在点击事件触发时手动调用`Tracker.ignoreView(view)`方法即可。该方式针对普通的点击监听设置方式以及`ButterKnife`的注解方式都生效。
279+
280+
## 注意事项
281+
由于对点击事件的统计使用到了反射,故集成了该库之后会对点击时的效率有所影响。
256282

257283
## License
258284

0 commit comments

Comments
 (0)