浅谈Android系统开发中LOG的使用

转自：http://blog.csdn.net/luoshengyang/article/details/6581828

在程序开发过程中，LOG是广泛使用的用来记录程序执行过程的机制，它既可以用于程序调试，也可以用于产品运营中的事件记录。在Android系统中，提供了简单、便利的LOG机制，开发人员可以方便地使用。在这一篇文章中，我们简单介绍在Android内核空间和用户空间中LOG的使用和查看方法。

        一. 内核开发时LOG的使用。Android内核是基于Linux Kerne 2.36的，因此，Linux Kernel的LOG机制同样适合于Android内核，它就是有名的printk，与C语言的printf齐名。与printf类似，printk提供格式化输入功能，同时，它也具有所有LOG机制的特点--提供日志级别过虑功能。printk提供了8种日志级别（<linux/kernel.h>）：

[cpp] view plaincopy

1. #define KERN_EMERG  "<0>"     /* system is unusable           */  
2. #define KERN_ALERT  "<1>"     /* action must be taken immediately */  
3. #define KERN_CRIT   "<2>"     /* critical conditions          */  
4. #deinfe KERN_ERR    "<3>"     /* error conditions         */  
5. #deinfe KERN_WARNING    "<4>"     /* warning conditions           */  
6. #deinfe KERN_NOTICE "<5>"     /* normal but significant condition */  
7. #deinfe KERN_INFO   "<6>"     /* informational            */  
8. #deinfe KERN_DEBUG  "<7>"     /* debug-level messages         */  

       printk的使用方法：

       printk(KERN_ALERT"This is the log printed by printk in linux kernel space.");

       KERN_ALERT表示日志级别，后面紧跟着要格式化字符串。

       在Android系统中，printk输出的日志信息保存在/proc/kmsg中，要查看/proc/kmsg的内容，参照在Ubuntu上下载、编译和安装Android最新内核源代码（Linux Kernel）一文，在后台中运行模拟器：

       USER-NAME@MACHINE-NAME:~/Android$ emulator &

       启动adb shell工具：

       USER-NAME@MACHINE-NAME:~/Android$ adb shell

       查看/proc/kmsg文件：

       root@android:/ # cat  /proc/kmsg

       二. 用户空间程序开发时LOG的使用。Android系统在用户空间中提供了轻量级的logger日志系统，它是在内核中实现的一种设备驱动，与用户空间的logcat工具配合使用能够方便地跟踪调试程序。在Android系统中，分别为C/C++ 和Java语言提供两种不同的logger访问接口。C/C++日志接口一般是在编写硬件抽象层模块或者编写JNI方法时使用，而Java接口一般是在应用层编写APP时使用。

       Android系统中的C/C++日志接口是通过宏来使用的。在system/core/include/android/log.h定义了日志的级别：

[cpp] view plaincopy

1. /* 
2.  * Android log priority values, in ascending priority order. 
3.  */  
4. typedef enum android_LogPriority {  
5.     ANDROID_LOG_UNKNOWN = 0,  
6.     ANDROID_LOG_DEFAULT,    /* only for SetMinPriority() */  
7.     ANDROID_LOG_VERBOSE,  
8.     ANDROID_LOG_DEBUG,  
9.     ANDROID_LOG_INFO,  
10.     ANDROID_LOG_WARN,  
11.     ANDROID_LOG_ERROR,  
12.     ANDROID_LOG_FATAL,  
13.     ANDROID_LOG_SILENT, /* only for SetMinPriority(); must be last */  
14. } android_LogPriority;  

       在system/core/include/cutils/log.h中，定义了对应的宏，如对应于ANDROID_LOG_VERBOSE的宏LOGV：

[cpp] view plaincopy

1. /* 
2.  * This is the local tag used for the following simplified 
3.  * logging macros. You can change this preprocessor definition 
4.  * before using the other macros to change the tag. 
5.  */  
6. #ifndef LOG_TAG  
7. #define LOG_TAG NULL  
8. #endif  
9.   
10. /* 
11.  * Simplified macro to send a verbose log message using the current LOG_TAG. 
12.  */  
13. #ifndef LOGV  
14. #if LOG_NDEBUG  
15. #define LOGV(...)   ((void)0)  
16. #else  
17. #define LOGV(...)   ((void)LOG(LOG_VERBOSE, LOG_TAG, __VA_ARGS__))  
18. #endif  
19. #endif  
20.   
21. /* 
22.  * Basic log message macro. 
23.  * 
24.  * Example: 
25.  *  LOG(LOG_WARN, NULL, "Failed with error %d", errno); 
26.  * 
27.  * The second argument may be NULL or "" to indicate the "global" tag. 
28.  */  
29. #ifndef LOG  
30. #define LOG(priority, tag, ...) \  
31.      LOG_PRI(ANDROID_##priority, tag, __VA_ARGS__)  
32. #endif  
33.   
34. /* 
35.  * Log macro that allows you to specify a number for priority. 
36.  */  
37. #ifndef LOG_PRI  
38. #define LOG_PRI(priority, tag, ...) \  
39.      android_printLog(priority, tag, __VA_ARGS__)  
40. #endif  
41.   
42. /* 
43.  * ================================================================ 
44.  * 
45.  * The stuff in the rest of this file should not be used directly. 
46.  */  
47. #define android_printLog(prio, tag, fmt...) \  
48.      __android_log_print(prio, tag, fmt)  

         因此，如果要使用C/C++日志接口，只要定义自己的LOG_TAG宏和包含头文件system/core/include/cutils/log.h就可以了：

         #define LOG_TAG "MY LOG TAG"

         #define LOG_NDEBUG 0

         #include <cutils/log.h>

         就可以了，例如使用LOGV：

         LOGV("This is the log printed by LOGV in android user space.");

         需要定义LOG_NDEBUG的原因是：/system/core/include/cutils/log.h 

1. /* 
2.  * Normally we strip LOGV (VERBOSE messages) from release builds. 
3.  * You can modify this (for example with "#define LOG_NDEBUG 0" 
4.  * at the top of your source file) to change that behavior. 
5.  */  
6. #ifndef LOG_NDEBUG  
7. #ifdef NDEBUG  
8. #define LOG_NDEBUG 1  
9. #else  
10. #define LOG_NDEBUG 0  
11. #endif  
12. #endif  

         再来看Android系统中的Java日志接口。Android系统在Frameworks层中定义了Log接口（frameworks/base/core/java/android/util/Log.java）：

[java] view plaincopy

1. ................................................  
2.   
3. public final class Log {  
4.   
5. ................................................  
6.   
7.     /** 
8.      * Priority constant for the println method; use Log.v. 
9.          */  
10.     public static final int VERBOSE = 2;  
11.   
12.     /** 
13.      * Priority constant for the println method; use Log.d. 
14.          */  
15.     public static final int DEBUG = 3;  
16.   
17.     /** 
18.      * Priority constant for the println method; use Log.i. 
19.          */  
20.     public static final int INFO = 4;  
21.   
22.     /** 
23.      * Priority constant for the println method; use Log.w. 
24.          */  
25.     public static final int WARN = 5;  
26.   
27.     /** 
28.      * Priority constant for the println method; use Log.e. 
29.          */  
30.     public static final int ERROR = 6;  
31.   
32.     /** 
33.      * Priority constant for the println method. 
34.          */  
35.     public static final int ASSERT = 7;  
36.   
37. .....................................................  
38.   
39.     public static int v(String tag, String msg) {  
40.         return println_native(LOG_ID_MAIN, VERBOSE, tag, msg);  
41.     }  
42.   
43.     public static int v(String tag, String msg, Throwable tr) {  
44.         return println_native(LOG_ID_MAIN, VERBOSE, tag, msg + '\n' + getStackTraceString(tr));  
45.     }  
46.   
47.     public static int d(String tag, String msg) {  
48.         return println_native(LOG_ID_MAIN, DEBUG, tag, msg);  
49.     }  
50.   
51.     public static int d(String tag, String msg, Throwable tr) {  
52.         return println_native(LOG_ID_MAIN, DEBUG, tag, msg + '\n' + getStackTraceString(tr));  
53.     }  
54.   
55.     public static int i(String tag, String msg) {  
56.         return println_native(LOG_ID_MAIN, INFO, tag, msg);  
57.     }  
58.   
59.     public static int i(String tag, String msg, Throwable tr) {  
60.         return println_native(LOG_ID_MAIN, INFO, tag, msg + '\n' + getStackTraceString(tr));  
61.     }  
62.   
63.     public static int w(String tag, String msg) {  
64.         return println_native(LOG_ID_MAIN, WARN, tag, msg);  
65.     }  
66.   
67.     public static int w(String tag, String msg, Throwable tr) {  
68.         return println_native(LOG_ID_MAIN, WARN, tag, msg + '\n' + getStackTraceString(tr));  
69.     }  
70.   
71.     public static int w(String tag, Throwable tr) {  
72.         return println_native(LOG_ID_MAIN, WARN, tag, getStackTraceString(tr));  
73.     }  
74.       
75.     public static int e(String tag, String msg) {  
76.         return println_native(LOG_ID_MAIN, ERROR, tag, msg);  
77.     }  
78.   
79.     public static int e(String tag, String msg, Throwable tr) {  
80.         return println_native(LOG_ID_MAIN, ERROR, tag, msg + '\n' + getStackTraceString(tr));  
81.     }  
82.   
83. ..................................................................  
84.   
85.     /**@hide */ public static native int println_native(int bufID,  
86.         int priority, String tag, String msg);  
87. }  

        因此，如果要使用Java日志接口，只要在类中定义的LOG_TAG常量和引用android.util.Log就可以了：

        private static final String LOG_TAG = "MY_LOG_TAG";

        Log.i(LOG_TAG, "This is the log printed by Log.i in android user space.");

        要查看这些LOG的输出，可以配合logcat工具。如果是在Eclipse环境下运行模拟器，并且安装了Android插件，那么，很简单，直接在Eclipse就可以查看了：

        

        如果是在自己编译的Android源代码工程中使用，则在后台中运行模拟器：

       USER-NAME@MACHINE-NAME:~/Android$ emulator &

       启动adb shell工具：

       USER-NAME@MACHINE-NAME:~/Android$ adb shell

       使用logcat命令查看日志：

       root@android:/ # logcat

       这样就可以看到输出的日志了。