FrameworkStatsLog

在阅读framework源码的时候经常会看到类似这种代码,比方说在发生crash事件的时候：

    FrameworkStatsLog.write(FrameworkStatsLog.APP_CRASH_OCCURRED,
                Binder.getCallingUid(),
                eventType,
                processName,
                Binder.getCallingPid(),
                (r != null && r.info != null) ? r.info.packageName : "",
                (r != null && r.info != null) ? (r.info.isInstantApp()
                        ? FrameworkStatsLog.APP_CRASH_OCCURRED__IS_INSTANT_APP__TRUE
                        : FrameworkStatsLog.APP_CRASH_OCCURRED__IS_INSTANT_APP__FALSE)
                        : FrameworkStatsLog.APP_CRASH_OCCURRED__IS_INSTANT_APP__UNAVAILABLE,
                r != null ? (r.isInterestingToUserLocked()
                        ? FrameworkStatsLog.APP_CRASH_OCCURRED__FOREGROUND_STATE__FOREGROUND
                        : FrameworkStatsLog.APP_CRASH_OCCURRED__FOREGROUND_STATE__BACKGROUND)
                        : FrameworkStatsLog.APP_CRASH_OCCURRED__FOREGROUND_STATE__UNKNOWN,
                processName.equals("system_server") ? ServerProtoEnums.SYSTEM_SERVER
                        : (r != null) ? r.getProcessClassEnum()
                                      : ServerProtoEnums.ERROR_SOURCE_UNKNOWN
        );

但是在源码里却找不到FrameworkStatsLog.java这个类。查找发现源码里有以下代码：

frameworks/base/Android.bp
genrule {
    name: "statslog-framework-java-gen",
    tools: ["stats-log-api-gen"],
    cmd: "$(location stats-log-api-gen) --java $(out) --module framework" +
         " --javaPackage com.android.internal.util --javaClass FrameworkStatsLog --worksource",
    out: ["com/android/internal/util/FrameworkStatsLog.java"],
}

genrule是用来生成文件的，当编译引用它的jar包时，会生成对应的文件，所以FrameworkStatsLog.java这个文件可能是按照某种编译规则生成的。

先看下上面例子里的语法含义：

（1）tools:表示可在命令行下运行的jar包，即指定main()入口的jar包，这里是stats-log-api-gen，路径在frameworks/base/tools/stats_log_api_gen/

（2）cmd:执行tools指定的jar包的cmd命令，使用这个命令可执行jar包。

        部分变量含义：

        $(location): tools指定的jar包路径

        $(in): srcs指定的输入文件

        $(out): out指定的输出文件

（3）out:输出的文件

所以，在编译framework的时候会按照规则生成FrameworkStatsLog.java文件，这个文件的路径在源码下的位置：

/out/soong/.intermediates/frameworks/base/statslog-framework-java-gen/gen/com/android/internal/util/FrameworkStatsLog.java

查看这个文件里的某一个event，比方说上文提到的crash事件:

    FrameworkStatsLog.java
     /**
     * AppCrashOccurred app_crash_occurred<br>
     * Usage: StatsLog.write(StatsLog.APP_CRASH_OCCURRED, int uid, java.lang.String event_type, java.lang.String process_name, int pid, java.lang.String package_name, int is_instant_app, int foreground_state, int error_source);<br>
     */
    public static final int APP_CRASH_OCCURRED = 78;

可以看出，本质上FrameworkStatsLog还是StatsLog，关于StatsLog，可以查看官网上的说明：StatsLog  |  Android Developers，它的主要功能就是为开发人员提供了将事件发送到 statsd 的 API。

所以FrameworkStatsLog本质上也是用于将数据传递到statsd上，我们可以通过调用FrameworkStatsLog.java里的write()方法来对事件进行打点。