一、简介

在数据分析领域，埋点是一种收集数据的技术手段，主要用于记录用户在应用程序、网站或其他数字平台上的行为信息。

埋点 SDK 是一种软件开发工具包，用于帮助开发人员在应用程序中实现埋点功能，以收集用户行为数据。

功能：
数据采集：能够收集各种与用户行为相关的数据，如用户点击按钮、浏览页面、滑动屏幕、输入文本等操作。
例如：电商应用，埋点 SDK 可以采集用户查看商品详情、加入购物车、下单购买等行为数据。

数据发送：将采集到的数据发送到指定的数据分析平台或服务器。通常会在用户触发特定事件或在特定的时间间隔内，将数据进行打包和发送，以便后续的分析和处理。

事件定义与跟踪：允许开发人员定义各种自定义事件，并跟踪这些事件的发生。
例如，在社交应用中，可以定义 “用户发布动态”“用户点赞”“用户评论” 等事件，通过埋点 SDK 来记录这些事件的发生时间、相关参数等信息。

优势：
简化开发流程：提供了一系列的 API 和工具，能够轻松地在应用程序中添加埋点代码，无需从头编写复杂的数据采集和发送逻辑。
提高数据准确性：能够准确地采集和记录用户行为数据，减少数据误差和丢失的情况。
支持多种平台：通常会提供针对不同操作系统和开发平台的版本，如 iOS、Android、Web 等，方便开发人员在不同的应用场景中使用。

常见的埋点 SDK：
百度统计 SDK、友盟统计 SDK、GrowingIO SDK 等，不同的埋点 SDK 在功能和使用方式上可能会有所差异。

二、GrowingIO 埋点

1、添加依赖

<dependency>
    <groupId>com.growingio</groupId>
    <artifactId>growingio-sdk</artifactId>
    <version>3.3.5</version>
</dependency>

2、配置信息

在application.yml 中配置 GrowingIO 账户信息：

growingio:
  project-id: your_project_id
  app-id: your_app_id
  auth-token: your_auth_token
  tracker-host: https://collector.growingio.com

3、初始化 SDK

@Configuration
public class GrowingIOConfig {

    @Value("${growingio.project-id}")
    private String projectId;

    @Bean
    public GrowingAPI growingAPI() {
        Configuration config = new Configuration()
                .setProjectId(projectId)
                .setAppId(appId)
                .setAuthenticationToken(authToken)
                .setTrackerHost(trackerHost);

        GrowingAPI.initialize(config);
        return GrowingAPI.get();
    }
}

4、埋点代码

@Service
public class UserAuthService {

    @Autowired
    private GrowingAPI growingAPI; // 注入 GrowingIO 客户端

    public boolean login(String userId, String loginMethod) {
        // 业务逻辑：验证用户身份
        boolean isSuccess = checkUserCredentials(userId, loginMethod);

        // 埋点：记录用户登录事件（无论成功或失败）
        Event loginEvent = new Event("user_login")
                .setUserId(userId)
                .setProperty("login_method", loginMethod)
                .setProperty("is_success", isSuccess)
                .setProperty("login_time", System.currentTimeMillis());

        growingAPI.send(loginEvent); // 发送到 GrowingIO

        return isSuccess;
    }

    private boolean checkUserCredentials(String userId, String method) {
        // 实际业务逻辑...
        return true;
    }
}

5、调用

@RestController
@RequestMapping("/auth")
public class AuthController {

    @Autowired
    private UserAuthService userAuthService;

    @PostMapping("/login")
    public ResponseEntity<Map<String, Object>> login(
            @RequestParam String userId,
            @RequestParam String method) {

        boolean isSuccess = userAuthService.login(userId, method);
        Map<String, Object> response = new HashMap<>();
        response.put("success", isSuccess);
        return ResponseEntity.ok(response);
    }
}

三、自定义埋点

1、定义埋点注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface TrackEvent {
    String eventName();          // 事件名称
    String[] params() default {}; // 需要记录的参数名（从方法参数中提取）
}

2、实现 AOP 埋点逻辑

使用 Spring AOP 拦截注解方法并记录埋点数据：

@Aspect
@Component
public class TrackingAspect {

    @Autowired
    private KafkaTemplate<String, String> kafkaTemplate; // 示例：发送到 Kafka

    @Around("@annotation(trackEvent)")
    public Object track(ProceedingJoinPoint joinPoint, TrackEvent trackEvent) throws Throwable {
        Object result = joinPoint.proceed(); // 执行原方法

        // 构建埋点数据
        Map<String, Object> eventData = new HashMap<>();
        eventData.put("event", trackEvent.eventName());
        eventData.put("timestamp", System.currentTimeMillis());

        // 提取用户ID和参数
        for (int i = 0; i < parameters.length; i++) {
            String paramName = parameters[i].getName();
            Object paramValue = args[i];
            
            // 记录注解中指定的参数
            if (Arrays.asList(trackEvent.params()).contains(paramName)) {
                eventData.put(paramName, paramValue);
            }

            // 提取用户ID（支持从对象中获取字段）
            if (paramName.equals(trackEvent.userIdField())) {
                if (paramValue instanceof String) {
                    eventData.put("user_id", paramValue);
                } else {
                    // 假设参数是 User 对象，反射获取 userId 字段
                    try {
                        Field userIdField = paramValue.getClass().getDeclaredField("userId");
                        userIdField.setAccessible(true);
                        eventData.put("user_id", userIdField.get(paramValue));
                    } catch (Exception e) {
                        // 异常处理
                    }
                }
            }
        }

        // 发送埋点数据（示例：发送到 Kafka）
        kafkaTemplate.send("user_events", new JSONObject(eventData).toString());

        return result;
    }
}

3、OrderRequest 对象

public class OrderRequest {
    private String userId;  // 用户ID
    private String orderId;
    private double amount;
    // Getters & Setters
}

4. 使用埋点注解

在 Controller 或 Service 中标记需要埋点的方法：

@RestController
@RequestMapping("/order")
public class OrderController {

    @TrackEvent(
        eventName = "order_create",
        params = {"orderId", "amount"},
        userIdField = "user"  // 从 user 对象中提取 userId
    )
    @PostMapping("/create")
    public ResponseEntity<Order> createOrder(@RequestBody OrderRequest request) {
        // 业务逻辑：创建订单
        Order order = orderService.create(request);
        return ResponseEntity.ok(order);
    }
}