简易Java日志(Log)输出工具的封装

忘是亡心i 2021-09-22 06:10 337阅读 0赞

本文链接: [http://blog.csdn.net/xietansheng/article/details/70478082][http_blog.csdn.net_xietansheng_article_details_70478082]

平时 Java 项目的开发通常需要统一管理日志（Log）的输出，例如控制日志信息输送的目的地（控制台、文件等），控制每一条日志的输出格式，把日志分为不同的级别等。常用的比较成熟的 Java 日志管理工具有 Apache 的 Log4j 等。但有时我们平时一时兴趣想写个小Dmeo或小工具，想较好的控制日志的输出，引入专业的日志管理库又显得比较繁琐，下面我就自己封装一个简单的日志工具类（`LogUtils.java`），需要用时拷贝即用。

该`LogUtils`工具类支持 4 种日志级别（debug、info、warn、error），可以把日志信息格式化输出到 控制台 或 文件。

使用方法如下:

package com.xiets.log;
    
    import java.io.File;
    
    public class Main { 
    
        private static final String TAG = "Main";
    
        public static void main(String[] args) throws Exception { 
            // (可选) 设置日志输出级别, 默认为 INFO 级别
            LogUtils.setLogOutLevel(LogUtils.Level.DEBUG);
    
            // (可选) 设置日志输出文件(追加到文件尾部)
            LogUtils.setLogOutFile(new File("MyLog.log"));
    
            // (可选) 设置日志输出位置(是否输出到控制台 和 是否输出到文件), 默认只输出到控制台, 不输出到文件
            LogUtils.setLogOutTarget(true, true);
    
            // 输出日志
            LogUtils.debug(TAG, "The debug log.");
            LogUtils.info(TAG, "The info log.");
            LogUtils.warn(TAG, "The warn log.");
            LogUtils.error(TAG, "The error log.");
        }
    
    }

`LogUtils.java`日志工具类的封装:

package com.xiets.log;
 
 import java.io.ByteArrayOutputStream;
 import java.io.Closeable;
 import java.io.File;
 import java.io.IOException;
 import java.io.PrintStream;
 import java.io.RandomAccessFile;
 import java.text.SimpleDateFormat;
 import java.util.Date;
 
 /** * 日志输出工具 * * 可以输出到控制台和指定的文件中, 分为4个级别, 由低到高分别为: debug, info, warn, error * * * * 输出级别: * * <ul> * <li> debug: 输出 debug, info, warn, error </li> * <li> info: 输出 info, warn, error </li> * <li> warn: 输出 warn, error </li> * <li> error: 输出 error </li> * </ul> * * 默认为 info 输出级别 * * * * Demo: * * <pre>{@code * // (可选) 设置日志输出级别, 默认为 INFO 级别 * LogUtils.setLogOutLevel(LogUtils.Level.DEBUG); * * // (可选) 设置日志输出文件(追加到文件尾部) * LogUtils.setLogOutFile(new File("MyLog.log")); * * // (可选) 设置日志输出位置(是否输出到控制台 和 是否输出到文件), 默认只输出到控制台, 不输出到文件 * LogUtils.setLogOutTarget(true, true); * * // 输出日志 * LogUtils.debug("TAG", "The debug log."); * LogUtils.info("TAG", "The info log."); * LogUtils.warn("TAG", "The warn log."); * LogUtils.error("TAG", "The error log."); * }</pre> * * @author xietansheng */
 public class LogUtils { 
 
 /** 每条 Log 的 tag 输出的最大长度, 超过部分将被截断 */
 private static final int TAG_MAX_LENGTH = 20;
 
 /** 每条 Log 的 message 输出的最大长度, 超过部分将被截断 */
 private static final int MESSAGE_MAX_LENGTH = 1024;
 
 /** 日期前缀格式化 */
 private static final SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("MM/dd HH:mm:ss.SSS");
 
 /** 日志当前的输出级别, 默认为 INFO 级别 */
 private static Level logOutLevel = Level.INFO;
 
 /** 是否输出到控制台, 默认输出 */
 private static boolean isOutToConsole = true;
 
 /** 是否输出到文件 */
 private static boolean isOutToFile = false;
 
 /** 日志输出文件, 追加到文件尾 */
 private static File logOutFile;
 
 /** 日志文件输出流, 追加到文件尾 */
 private static RandomAccessFile logOutFileStream;
 
 public static void setLogOutLevel(Level currentLevel) { 
 if (currentLevel == null) { 
 currentLevel = Level.INFO;
 }
 LogUtils.logOutLevel = currentLevel;
 }
 
 public static synchronized void setLogOutFile(File logOutFile) throws IOException { 
 LogUtils.logOutFile = logOutFile;
 
 if (logOutFileStream != null) { 
 closeStream(logOutFileStream);
 logOutFileStream = null;
 }
 
 if (LogUtils.logOutFile != null) { 
 try { 
 logOutFileStream = new RandomAccessFile(LogUtils.logOutFile, "rw");
 logOutFileStream.seek(LogUtils.logOutFile.length());
 } catch (IOException e) { 
 closeStream(logOutFileStream);
 logOutFileStream = null;
 throw e;
 }
 }
 }
 
 public static void setLogOutTarget(boolean isOutToConsole, boolean isOutToFile) { 
 LogUtils.isOutToConsole = isOutToConsole;
 LogUtils.isOutToFile = isOutToFile;
 }
 
 public static void debug(String tag, String message) { 
 printLog(Level.DEBUG, tag, message, false);
 }
 
 public static void info(String tag, String message) { 
 printLog(Level.INFO, tag, message, false);
 }
 
 public static void warn(String tag, String message) { 
 printLog(Level.WARN, tag, message, false);
 }
 
 public static void error(String tag, String message) { 
 printLog(Level.ERROR, tag, message, true);
 }
 
 public static void error(String tag, Exception e) { 
 if (e == null) { 
 error(tag, (String) null);
 return;
 }
 
 PrintStream printOut = null;
 
 try { 
 ByteArrayOutputStream bytesBufOut = new ByteArrayOutputStream();
 printOut = new PrintStream(bytesBufOut);
 e.printStackTrace(printOut);
 printOut.flush();
 error(tag, new String(bytesBufOut.toByteArray(), "UTF-8"));
 
 } catch (Exception e1) { 
 e1.printStackTrace();
 
 } finally { 
 closeStream(printOut);
 }
 }
 
 private static void printLog(Level level, String tag, String message, boolean isOutToErr) { 
 if (level.getLevelValue() >= logOutLevel.getLevelValue()) { 
 String log = DATE_FORMAT.format(new Date()) +
 " " +
 level.getTag() +
 "/" +
 checkTextLengthLimit(tag, TAG_MAX_LENGTH) +
 ": " +
 checkTextLengthLimit(message, MESSAGE_MAX_LENGTH);
 
 if (isOutToConsole) { 
 outLogToConsole(isOutToErr, log);
 }
 if (isOutToFile) { 
 outLogToFile(log);
 }
 }
 }
 
 private static void outLogToConsole(boolean isOutToErr, String log) { 
 if (isOutToErr) { 
 // System.err 和 System.out 是两个不同的输出流通道, 如果极短时间内连
 // 续输出 log 到 err 和 out, 控制台上的打印顺序可能会不完全按时序打印.
 System.err.println(log);
 } else { 
 System.out.println(log);
 }
 }
 
 private static synchronized void outLogToFile(String log) { 
 if (logOutFileStream != null) { 
 try { 
 logOutFileStream.write((log + "\n").getBytes("UTF-8"));
 } catch (IOException e) { 
 e.printStackTrace();
 }
 }
 }
 
 private static String checkTextLengthLimit(String text, int maxLength) { 
 if ((text != null) && (text.length() > maxLength)) { 
 text = text.substring(0, maxLength - 3) + "...";
 }
 return text;
 }
 
 private static void closeStream(Closeable stream) { 
 if (stream != null) { 
 try { 
 stream.close();
 } catch (Exception e) { 
 // nothing
 }
 }
 }
 
 public static enum Level { 
 DEBUG("D", 1), INFO("I", 2), WARN("W", 3), ERROR("E", 4);
 
 private String tag;
 
 private int levelValue;
 
 private Level(String tag, int levelValue) { 
 this.tag = tag;
 this.levelValue = levelValue;
 }
 
 public String getTag() { 
 return tag;
 }
 
 public int getLevelValue() { 
 return levelValue;
 }
 }
 
 }

控制台输出结果:

![result.png][]

日志文件输出结果:

![result-file.png][]

--------------------

![18975746.asp][]

[http_blog.csdn.net_xietansheng_article_details_70478082]: http://blog.csdn.net/xietansheng/article/details/70478082
[result.png]: /images/20210920/5158db5965b546749ed7cdf8313208fd.png
[result-file.png]: /images/20210920/aee72e3566a24ff584ec4fd959498ea9.png
[18975746.asp]: http://img.users.51.la/18975746.asp