Android日志文件生成及记录

一、日志文件的作用

在Android App开发过程中，日志文件是非常重要的调试工具。通过查看Log日志，可以了解到应用程序的运行状态、用户行为等关键信息。还可以根据日志文件快速定位程序错误，从而提高开发效率。

然而，默认情况下，Android系统只能保留非常短的日志记录，而且还会被其他应用程序的日志所覆盖，这对于开发者来说是非常困扰的。因此，我们需要通过代码来实现生成日志文件，并将记录的日志信息保存到该文件中。

二、生成日志文件的步骤

1、添加权限

在AndroidManifest.xml文件中添加如下权限：

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

该权限允许我们将文件写入到外部存储中。

2、创建Log日志类

我们需要根据自己的需求，在项目中自定义一个Log日志类，将要打印的日志信息写入到该类中的静态变量中，并提供一个静态方法用于将这些日志信息写入到我们创建的日志文件中。下面是一个示例Log日志类：

public class LogUtil {

    private static final String TAG = "LogUtil";
    private static final String LOG_FILE_DIR = Environment.getExternalStorageDirectory() + "/log/";
    private static final String LOG_FILE_NAME = "log.txt";
    private static StringBuilder logBuilder = new StringBuilder();

    public static void appendLog(String log) {
        logBuilder.append(log).append("\n");

        // 如果日志缓存达到一定的大小，那么就将日志写入到文件中
        if (logBuilder.length() >= 1024 * 1024) {
            writeLogToFile();
        }
    }

    private static void writeLogToFile() {
        FileUtils.writeToFile(LOG_FILE_DIR, LOG_FILE_NAME, logBuilder.toString(), true);
        logBuilder = new StringBuilder();
    }
}

上述代码中，我们将日志文件保存在外部存储设备的根目录下的“/log/”目录中，并将文件命名为“log.txt”。

3、写入日志信息到日志文件中

在App的代码中，需要调用我们自定义的Log日志类的静态方法，将日志信息写入到日志文件中。下面是一段示例代码：

LogUtil.appendLog("Login activity started.");

上述代码会将“Login activity started.”这条日志记录写入到我们创建的日志文件中。

三、代码示例

下面是一个完整的示例代码，用于生成日志文件，并将记录的日志信息保存到文件中：

import android.os.Environment;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;

/**
 * 自定义Log日志类，用于记录应用程序的运行状态、用户行为等关键信息
 */
public class LogUtil {

    private static final String TAG = "LogUtil";
    private static final String LOG_FILE_DIR = Environment.getExternalStorageDirectory() + "/log/";
    private static final String LOG_FILE_NAME = "log.txt";
    private static SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss", Locale.getDefault());
    private static StringBuilder logBuilder = new StringBuilder();

    /**
     * 将日志信息追加到缓存中
     *
     * @param log         需要记录的日志信息
     */
    public static void appendLog(String log) {
        String timeStr = sdf.format(new Date());
        logBuilder.append(timeStr).append("\n").append(log).append("\n").append("\n");

        //如果日志缓存达到一定的大小，那么就将日志写入到文件中
        if (logBuilder.length() >= 1024 * 1024) {
            writeLogToFile();
        }
    }

    /**
     * 将日志信息写入到文件中
     */
    private static void writeLogToFile() {
        File fileDir = new File(LOG_FILE_DIR);
        if (!fileDir.exists()) {
            if (!fileDir.mkdirs()) {
                Log.e(TAG, "create log dir failed: " + LOG_FILE_DIR);
                return;
            }
        }

        File logFile = new File(LOG_FILE_DIR + LOG_FILE_NAME);
        if (!logFile.exists()) {
            try {
                if (!logFile.createNewFile()) {
                    Log.e(TAG, "create log file failed: " + LOG_FILE_NAME);
                    return;
                }
            } catch (IOException e) {
                e.printStackTrace();
                Log.e(TAG, "create log file failed: " + e.getMessage());
                return;
            }
        }

        try {
            FileOutputStream fos = new FileOutputStream(logFile, true);
            fos.write(logBuilder.toString().getBytes());
            fos.flush();
            fos.close();
            logBuilder = new StringBuilder();
        } catch (IOException e) {
            e.printStackTrace();
            Log.e(TAG, "write log file failed: " + e.getMessage());
        }
    }
}