背景

在Android开发过程中难免会需要日志输出的，日志在开发调试、异常跟踪以及排查问题上都有很大的帮助，但是打印日志是一个损耗性能的动作，会占用程序执行资源，如果处理不好的话有可能会造成ANR等问题，前段时间在为公司整理基础开发库，其中涉及到日志记录库，遇到了一些坑，所以下面就日志相关的内容整理一些需要注意的关键点。

记录日志的方式

• System.out.println()

  这种方式一般是直接输出到控制台，通过logcat来捕获查看，通常用在临时打印值上，无法持久存储日志，而且打印的内存如果超过了logcat的缓存大小就会被清空，一般不建议使用。

• Log类

  这种方式是系统提供的专门记录日志的工具类，它的实现代码不多，逻辑也很简单，主要就是封装了一些静态的工具方法，调用native的输出流将内容输出到控制台，这种方式相比System.out.println()要好很多，支持按照tag、level来区分不同的日志内容等，但和System.out.println()一样，输出的内容没有办法持久化。

• 文件

  这种方式是通过写文件的方式将日志持久化，便于后续查看，这种方式在生产环境中使用较多，也是本文中主要介绍的方式。

什么时候使用文件记录日志?

读写文件是一个十分消耗性能的动作，尤其是在生产环境中，因此我们应该谨慎处理需要持久化的日志，并不是所有的日志都需要持久化，我们应该将那些能够帮助我们定位问题的日志、关键数据的日志记录下来，例如：网络请求的请求体、返回值，数据库增删的操作，关键业务流程的状态日志，程序异常的错误日志等。

使用文件记录日志有哪些问题与建议？

• 由于是文件保存日志文件，因此就会涉及到大量、频繁的IO操作，因此该部分建议放在native层来做，这样做读写效率高，且可以避免大量对象的创建与销毁造成的虚拟机频繁GC。

• 在开发板等设备上使用文件存储的时候，还需要考虑异常断电造成的日志丢失的问题，因为Android系统都是先将内容写入缓存，定时刷入到磁盘的，所以如果突然断电，是有可能造成数据丢失的，sharedpreference也同样会存在这个问题，在开发的过程中要格外注意，所以建议使用mmap的方式来记录，这种方式效率高，且不会让数据丢失。

• 由于日志文件有可能会包含敏感信息，所以建议日志文件要做加密处理。

• 程序产生日志的量是十分惊人的，所以要对日志文件做压缩处理，且需要考虑设置存储日志的最大容量，并且需要设计好当超出最大容量后的处理策略。

参考示例

• 其实如果让我们从零开始设计开发这样的一个日志记录库是十分繁琐的，我们可以基于别人已经做好的一些开源库，结合自己的业务需求来做适当的修改，从而实现一个可用的库，这里推荐使用腾讯开源的Mars基础组件中的xlog。当然这份开源库还存在很多缺陷，比如说：不支持按照日志的level来区分文件、不支持设置总日志文件大小限制、不支持长日志保存等。这些问题目前都还处于待解决的状态，需要后期完善，我们就可以简单的在上层自己写一些逻辑来完善。

• 长日志打印保存

private static synchronized void printLog(int type, String tag, String filename, String funcname, int line, int pid, long tid, long maintid, String log) {

        if (tag == null) {
            tag = "";
        }
        if (log == null) {
            log = "";
        }
        // Android单条log长度最大值为:4*1024字节,超过的话会被Log内核驱动截断.
        // 因为String的length是字符数量不是字节数量所以为了防止中文字符过多，
        // 把4*1024的MAX字节打印长度改为1024字符数
        int maxStrLength = 1024 - tag.length();
        if (log.length() > maxStrLength) {
            //大于4000时
            while (log.length() > maxStrLength) {
                doPrintLog(type, tag, filename, funcname, line, pid, tid, maintid, log.substring(0, maxStrLength));
                log = log.substring(maxStrLength);

                if (log.length() <= maxStrLength) {
                    doPrintLog(type, tag, filename, funcname, line, pid, tid, maintid, log);
                    break;
                }
            }
        } else {

            doPrintLog(type, tag, filename, funcname, line, pid, tid, maintid, log);
        }
    }

• 将json中内容过长的value省略

private Object iteratorJson(Object object) {

        if (object == null) {
            return null;
        }
        if (object instanceof Map) {
            try {
                Map<String, Object> objectMap = (Map<String, Object>) object;
                Iterator<Map.Entry<String, Object>> it = objectMap.entrySet().iterator();
                while (it.hasNext()) {
                    Map.Entry<String, Object> en = it.next();
                    if(en != null) {
                        en.setValue(iteratorJson(en.getValue()));
                    }
                }
            } catch (Exception e) {

            }
        } else if (object instanceof List) {
            List<Object> objectList = (List<Object>) object;
            ListIterator<Object> iterator = objectList.listIterator();
            while (iterator.hasNext()){
                Object next = iterator.next();
                iterator.set(iteratorJson(next));
            }
        } else {
            if (object != null && object.toString() != null && object.toString().length() > SINGLE_LOG_MAX_LENGTH) {
                return "value data too long";
            }
        }
        return object;
    }

最后

目前我们已经基于Mars/XLog封装了一套自己的日志记录库，这个库在之后整理好后悔开源出来，敬请期待。