使用java实现日志工具类分享

下面就为大家详细讲解使用Java实现日志工具类的攻略。实现日志工具类是为了方便我们进行程序的调试和排错，让我们可以更好地了解程序执行过程中的各种信息和异常情况。下面我们来逐步实现这个日志工具类：

1. 思路分析

我们需要实现的日志工具类需要具备以下基本功能：

1. 设置日志级别：可以设置不同的日志级别，包括 debug、info、warning、error、fatal 等级别；
2. 输出日志信息：可以输出包括日期、时间、线程、类名、方法名、日志级别、日志内容等信息；
3. 支持日志输出到文件或控制台等不同的目标。

2. 实现步骤

2.1. 定义枚举类型 LogLevel

我们需要定义一个LogLevel的枚举类型，来表示日志的级别。

public enum LogLevel {

    DEBUG, INFO, WARNING, ERROR, FATAL
}

2.2. 定义 LogMessage 类

我们需要定义一个 LogMessage 类，包含以下属性：

• level：日志级别；
• logTime：日志时间；
• logThread：执行线程名称；
• logClass：产生日志的类；
• logMethod：产生日志的方法；
• logContent：日志内容。

public class LogMessage {
    private LogLevel level;
    private Date logTime;
    private String logThread;
    private String logClass;
    private String logMethod;
    private String logContent;

    // 省略 getter 和 setter 方法
}

2.3. 定义 LogFormat 类

LogFormat 类定义了日志的格式，包括日期格式、时间格式、线程格式、类名格式、方法名格式等信息。

public class LogFormat {
    private String dateFormat = "yyyy-MM-dd";
    private String timeFormat = "HH:mm:ss";
    private String threadFormat = "[%t]";
    private String classFormat = "[%c]";
    private String methodFormat = "[%m]";

    // 省略 setter 和 getter 方法
}

2.4. 定义 LogWriter 接口

我们需要定义一个 LogWriter 接口来规范日志的输出方式，定义一个 write() 方法来输出日志信息。

public interface LogWriter {

    void write(LogMessage message);
}

2.5. 实现 ConsoleWriter 类和 FileWriter 类

ConsoleWriter 类用来将日志输出到控制台。

public class ConsoleWriter implements LogWriter {

    @Override
    public void write(LogMessage message) {
        // 将日志信息输出到控制台
        System.out.println(message.toString());
    }
}

FileWriter 类用来将日志输出到指定文件中。

public class FileWriter implements LogWriter {

    private String filePath;

    public FileWriter(String filePath) {
        this.filePath = filePath;
    }

    @Override
    public void write(LogMessage message) {
        try (PrintWriter writer = new PrintWriter(new FileWriter(filePath, true))) {
            // 将日志信息输出到指定文件中
            writer.println(message.toString());
        } catch (IOException ex) {
            // 输出错误信息
            ex.printStackTrace();
        }
    }
}

2.6. 定义 LogManager 类

LogManager 类是实现日志的核心，它实现了日志的级别控制和日志输出。

public class LogManager {

    private static LogLevel level = LogLevel.INFO;// 默认日志级别为 INFO
    private static List<LogWriter> writers = new ArrayList<>();

    static {
        // 默认输出到控制台
        writers.add(new ConsoleWriter());
    }

    public static void setLevel(LogLevel level) {
        LogManager.level = level;
    }

    public static void addWriter(LogWriter writer) {
        writers.add(writer);
    }

    public static void removeWriter(LogWriter writer) {
        writers.remove(writer);
    }

    public static void debug(String content) {
        log(LogLevel.DEBUG, content);
    }

    public static void info(String content) {
        log(LogLevel.INFO, content);
    }

    public static void warn(String content) {
        log(LogLevel.WARNING, content);
    }

    public static void error(String content) {
        log(LogLevel.ERROR, content);
    }

    public static void fatal(String content) {
        log(LogLevel.FATAL, content);
    }

    private static void log(LogLevel level, String content) {
        if (level.ordinal() < LogManager.level.ordinal()) {
            return;
        }
        LogMessage message = new LogMessage();
        message.setLevel(level);
        message.setLogTime(new Date());
        message.setLogThread(String.format(LogFormat.getThreadFormat(), Thread.currentThread().getId()));
        message.setLogClass(LogManager.class.getName());
        message.setLogMethod(getMethodName());
        message.setLogContent(content);

        for (LogWriter writer : writers) {
            writer.write(message);
        }
    }

    private static String getMethodName() {
        StackTraceElement[] stackTraceElements = Thread.currentThread().getStackTrace();
        for (StackTraceElement stackTraceElement : stackTraceElements) {
            if (!stackTraceElement.getClassName().equals(LogManager.class.getName()) &&
                    !stackTraceElement.getClassName().startsWith(Thread.class.getName())) {
                return String.format(LogFormat.getMethodFormat(), stackTraceElement.getMethodName());
            }
        }
        return null;
    }
}

3. 示例代码

3.1. 控制台输出

LogManager.info("这是一条普通的日志信息");
LogManager.warn("这是一条警告信息");
LogManager.error("这是一条错误信息");

输出结果如下：

[INFO][2022-01-07 22:28:48][Thread-0][com.example.LogManager][getMethodName] 这是一条普通的日志信息
[WARNING][2022-01-07 22:28:48][Thread-0][com.example.LogManager][getMethodName] 这是一条警告信息
[ERROR][2022-01-07 22:28:48][Thread-0][com.example.LogManager][getMethodName] 这是一条错误信息

3.2. 输出到文件

LogManager.addWriter(new FileWriter("log.txt"));
LogManager.error("这是一条错误信息2");

4. 总结

以上就是使用 Java 实现日志工具类的完整攻略。通过分析和学习，我们可以掌握如何设计和实现一个日志工具类。实现的代码可自由扩展，比如可以增加更多的日志输出方式或者自定义日志格式等。在实际应用中，日志工具类是一种非常常用和基础的工具，可以帮助我们更快速、更准确地定位问题，提高开发效率。