iOS全埋點解決方案-控件點擊事件

前言

​ 我們主要介紹如何實現控件點擊事件（$AppClick）的全埋點。在介紹如何實現之前，我們需要先了解一下，在 UIKit 框架下，處理點擊或拖動事件的 Target-Action 設計模式。

一、 Target-Action

​ Target-Action，也叫目標-動作模式，即當某個事件發生的時候，調用特定對象的特定方法。

​ 比如，在 LoginViewController 頁面，有一個按鈕，點擊按鈕時，會調用 LoginViewController 里的 - loginBtnOnClick 方法，“特定對象”就是 Target，“特定方法”就是 Action。也即 Target 是 LoginViewController， Action 是 - loginBtnOnClick 方法。

Target-Action 設計模式主要包含兩個部分：

• Target 對象：接收消息的對象
• Action 方法：用於表示需要調用的方法

​ Target 對象可以是任意類型的對象。但是在 iOS 應用程序中，通常情況下會是一個控制器，而觸發事件的對象和 Target 對象一樣，也可以是任意對象。例如，手勢識別器 UIGestureRecognizer 就可以在識別到手勢后，將消息發送給另一個對象。Target-Action 設計模式，最常見的應用場景還是在控件中。iOS 中的控件都是 UIControl 類或者其子類，當用戶在操作這些控件時，會將消息發送到指定的對象（Target），而對應的 Action 方法必須符合以下幾種形式之一 ：

- (void)doSomething;
- (void)doSomething:(id)sender;
- (void)doSomething:(id)sender forEvent:(UIEvent *)event;
- (IBAction)doSomething;
- (IBAction)doSomething:(id)sender;
- (IBAction)doSomething:(id)sender forEvent:(UIEvent *)event;

​ 其中以 IBAction 作為返回值類型的形式，是為了讓該方法能在 Interface Builder 中被看到；sender 參數就是觸發事件的控件本身；第二個參數 event 是 UIEvent 的對象，封裝了觸摸事件的相關信息。我們可以通過代碼或者 Interface Builder 為一個控件添加一個 Target 對象以及相對應的 Action 方法。

​ 若想使用代碼方式添加 Target-Action（我們也會用 Target-Action 表示：一個 Target 對象以及相對應的 Action 方法），可以直接調用控件對象的如下方法：

- (void)addTarget:(nullable id)target action:(SEL)action forControlEvents:(UIControlEvents)controlEvents;

我們也可以多次調用 - addTarget:action:forControlEvents: 方法給控件添加多個 Target-Action，即使多次調用- addTarget:action:forControlEvents: 添加相同的 Target 但是不同的 Action，也不會出現相互覆蓋的問題。另外，在添加 Target-Action 的時候，Target 對象也可以為 nil（默認會先在 self 里查找 Action）。

當我們為一個控件添加 Target-Action 后，控件又是如何找到 Target 對象並執行對應的 Action 方法的呢？

在 UIControl 類中有一個方法：

- (void)sendAction:(SEL)action to:(nullable id)target forEvent:(nullable UIEvent *)event;

如果控件被用戶操作（比如點擊），首先會調用這個方法，並將事件轉發給應用程序的 UIApplication 對象。

同時，在 UIApplication 類中也有一個類似的實例方法：

- (BOOL)sendAction:(SEL)action to:(nullable id)target from:(nullable id)sender forEvent:(nullable UIEvent *)event;

如果 Target 對象不為 nil，應用程序會讓該 Target 對象調用對應的 Action 方法響應事件；如果 Target 對象為 nil，應用程序會在響應者鏈中搜索定義了該方法的對象，然后執行 Action 方法。

基於 Target-Action 設計模式，我們有兩種方案可以實現 $AppClick 事件的全埋點。

二、實現方案

​ 通過 Target-Action 執行模式可知，在執行 Action 方法之前，會先后通過控件和 UIApplication 對象發送事件相關的信息。因此，我們可以通過 Method Swizzling 交換 UIApplication 的 - sendAction:to:from:forEvent: 方法，然后在交換后的方法中觸發 $AppClick 事件，並根據 target 和 sender 采集相關的屬性，即可實現 $AppClick 事件的全埋點 。

​ 對於 UIApplication 類中的 - sendAction:to:from:forEvent: 方法，我們以給 UIButton 設置 action 為例，詳細介紹一下。

[button addTarget:person action:@selector(btnAction) forControlEvents:UIControlEventTouchUpInside];

參數：

• action：Action 方法對應的 selector，即示例中的 btnAction。
• target：Target 對象，即示例中的 person。如果 Target 為 nil，應用程序會將消息發送給第一個響應者，並從第一個響應者沿着響應鏈向上發送消息，直到消息被處理為止。
• sender：被用戶點擊或拖動的控件，即發送 Action 消息的對象，即示例中的 button。
• event：UIEvent 對象，它封裝了觸發事件的相關信息。

返回值：

如果有 responder 對象處理了此消息，返回 YES，否則返回 NO。

2.1 實現步驟

​ 通過 Method Swizzling 交換 UIApplication 類中的 -sendAction:to:from:forEvent: 方法來實現 $AppClick 事件的全埋點。

第一步：創建 UIApplication 分類 UIApplication+SensorsData

第二步：實現交換方法 -sensorsdata_sendAction:to:from:forEvent:

z#import "SensorsAnalyticsSDK.h"

- (BOOL)sensorsdata_sendAction:(SEL)action to:(id)target from:(id)sender forEvent:(UIEvent *)event{
    // 觸發 $AppClick 事件
    NSMutableDictionary *properties = [NSMutableDictionary dictionary];
    [[SensorsAnalyticsSDK sharedInstance] track:@"$AppClick" properties:properties];
    
    // 調用原有的實現 即 sendAction:to:from:forEvent:
    return [self sensorsdata_sendAction:action to:target from:sender forEvent:event];
}

第三步：實現 load 類方法，並在類方法中實現 - sendAction:to:from:forEvent: 方法交換

#import "NSObject+SASwizzler.h"

+ (void)load {
    [UIApplication sensorsdata_swizzleMethod:@selector(sendAction:to:from:forEvent:) withMethod:@selector(sensorsdata_sendAction:to:from:forEvent:)];
}

第四步：測試驗證，在Demo 中添加 button 按鈕，點擊按鈕

{
  "event" : "$AppClick",
  "time" : 1648696085563,
  "propeerties" : {
    "$model" : "x86_64",
    "$manufacturer" : "Apple",
    "$lib_version" : "1.0.0",
    "$os" : "iOS",
    "$app_version" : "1.0",
    "$os_version" : "15.2",
    "$lib" : "iOS"
  }
}

2.2 優化 $AppClick 事件

一般情況下，對於一個控件的點擊事件，我們至少還需要采集如下信息（屬性）：

• 控件類型（$element_type）
• 控件上顯示的文本（$element_content）
• 控件所屬頁面，即 UIViewController（$screen_name）

基於目前的方案，我們來看如何實現采集以上三個屬性。

1、獲取控件類型

​ 獲取控件類型相對比較簡單，我們可以直接使用控件的 class 名稱來代表當前控件的類型，比如可通過如下方式獲取控件的 class 名稱：

NSString *elementType = NSStringFromClass([sender class])；

2、獲取顯示屬性

​ 需要根據特定的控件調用相應的方法。

第一步：在 UIView 的類別 SensorsData 中新增 sensorsdata_elementContent 屬性。

@interface UIView (SensorsData)

@property (nonatomic, copy, readonly) NSString *sensorsdata_elementType;

@property (nonatomic, copy, readonly) NSString *sensorsdata_elementContent;

@end

- (NSString *)sensorsdata_elementContent {
    return nil;
}

第二步：在 UIView+SensorsData 分類中新增 UIButton 的類別 SensorsData，並實現 -sensorsdata_elementContent 方法

#pragma mark - UIButton
@interface UIButton (SensorsData)

@end

@implementation UIButton (SensorsData)

- (NSString *)sensorsdata_elementContent {
    return self.titleLabel.text;
}

@end

第三步：修改 SensorsAnalyticsSDK+Track 中 - trackAppClickWithView: properties: 方法

- (void)trackAppClickWithView:(UIView *)view properties:(nullable NSDictionary <NSString*, id> *)properties {
    // 觸發 $AppClick 事件
    NSMutableDictionary *eventProperties = [NSMutableDictionary dictionary];
    // 獲取控件類型
    [eventProperties setValue:view.sensorsdata_elementType forKey:@"$element_type"];
    // 獲取控件文本
    [eventProperties setValue:view.sensorsdata_elementContent forKey:@"$element_content"];
    [eventProperties addEntriesFromDictionary:properties];
    [[SensorsAnalyticsSDK sharedInstance] track:@"$AppClick" properties:eventProperties];    
}

第四步：測試驗證

{
  "event" : "$AppClick",
  "time" : 1648708284842,
  "propeerties" : {
    "$model" : "x86_64",
    "$manufacturer" : "Apple",
    "$element_type" : "UIButton",
    "$lib_version" : "1.0.0",
    "$os" : "iOS",
    "$element_content" : "eeeeeee",
    "$app_version" : "1.0",
    "$os_version" : "15.2",
    "$lib" : "iOS"
  }
}

3、獲取控件所屬的界面

如何知道一個 UIView 所屬哪個 UIViewController 呢？

這就需要借助 UIResponder 了！

大家都知道，UIResponder 類是 iOS 應用程序中專門用來響應用戶操作事件的，比如：

• Touch Events：即觸摸事件
• Motion Events：即運動事件
• Remote Control Events：即遠程控制事件

​ UIApplication、UIViewController、UIView 類都是 UIResponder 的子類，所以它們都具有響應以上事件的能力。另外，自定義的 UIView 和自定義視圖控制器也都可以響應以上事件。在 iOS 應用程序中，UIApplication、UIViewController、UIView 類的對象也都是一個個響應者，這些響應者會形成一個響應者鏈。一個完整的響應者鏈傳遞規則（順序）大概如下：UIView → UIViewController → RootViewController → Window → UIApplication → UIApplicationDelegate，可參考下圖所示（此圖來源於蘋果官方網站） 。

​ 注意：對於 iOS 應用程序里實現了 UIApplicationDelegate 協議的類（通常為 AppDelegate），如果它是繼承自 UIResponder，那么也會參與響應者鏈的傳遞；如果不是繼承自 UIResponder（例如 NSObject），那么它就不會參與響應者鏈的傳遞。

​ 通過圖可以知道，對於任意一個視圖來說，都能通過響應者鏈找到它所在的視圖控制器，也就是其所屬的頁面，從而可以達到獲取它所屬頁面信息的目的。

第一步：新增 sensorsdata_viewController 屬性

@interface UIView (SensorsData)

@property (nonatomic, copy, readonly) NSString *sensorsdata_elementType;

@property (nonatomic, copy, readonly) NSString *sensorsdata_elementContent;

@property (nonatomic, copy, readonly) NSString *sensorsdata_viewController;

@end

第二步：實現 實現 -sensorsdata_viewController 方法

- (NSString *)sensorsdata_viewController {
    UIResponder *responder = self;
    while ((responder = [responder nextResponder])) {
        if ([responder isKindOfClass:[UIViewController class]]) {
            return (UIViewController *)responder.class;
        }
    }
    return nil;
}

第三步：修改 - trackAppClickWithView: properties: 方法

- (void)trackAppClickWithView:(UIView *)view properties:(nullable NSDictionary <NSString*, id> *)properties {
    // 觸發 $AppClick 事件
    NSMutableDictionary *eventProperties = [NSMutableDictionary dictionary];
    // 獲取控件類型
    [eventProperties setValue:view.sensorsdata_elementType forKey:@"$element_type"];
    // 獲取控件文本
    [eventProperties setValue:view.sensorsdata_elementContent forKey:@"$element_content"];
    // 獲取控件所在的控制器
    UIViewController *vc = view.sensorsdata_viewController;
    [eventProperties setValue:NSStringFromClass(vc.class) forKey:@"$screen_name"];
    [eventProperties addEntriesFromDictionary:properties];
    [[SensorsAnalyticsSDK sharedInstance] track:@"$AppClick" properties:eventProperties];    
}

第四步：測試驗證

{
  "event" : "$AppClick",
  "time" : 1648711998403,
  "propeerties" : {
    "$model" : "x86_64",
    "$manufacturer" : "Apple",
    "$element_type" : "UIButton",
    "$lib_version" : "1.0.0",
    "$os" : "iOS",
    "$element_content" : "eeeeeee",
    "$app_version" : "1.0",
    "$screen_name" : "ViewController",
    "$os_version" : "15.2",
    "$lib" : "iOS"
  }
}

三、遺留問題

如果，一個控件添加了多個 Target-Action，會導致多次觸發 $AppClick 事件。