日志工具類

package com.zhihua.file;

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintWriter;
import java.util.Date;
import java.util.Properties;

/**
 * 日志工具類
 * 使用了單例模式，保證隻有一個執行個體
 * 為了更友善的配置日志檔案名，使用屬性檔案配置。
 * 也可以在程式中指定日志檔案名
 * <請替換成功能描述> <br>
 * <請替換成較長的描述>
 * @author caizh
 * @since [1.0.0]
 * @version [1.0.0,2017年2月16日]
 */
public class LogWriterUtils {

    //日志的配置檔案
    public static final String LOG_CONFIGFILE_NAME = "log.properties";
    //日志檔案名在配置檔案中的标簽
    public static final String LOGFILE_TAG_NAME = "logfile";

    //預設的日志檔案的路徑和檔案名稱
    private static final String DEFAULT_LOG_FILE_NAME = "./logtext.log";
    //該類的唯一的執行個體
    private static LogWriterUtils logWriter;
    //檔案輸出流
    private PrintWriter writer;
    //日志檔案名
    private String logFileName;

    /**
     * 預設構造函數
     * @throws Exception
     */
    private LogWriterUtils()throws Exception{
        this.init();
    }
    private LogWriterUtils(String fileName)throws Exception{
        this.logFileName = fileName;
        this.init();
    }

    /**
     * 初始化LogWriterUtils
     * <請替換成功能描述> <br>
     * <請替換成較長的描述>
     * @author caizh
     * @since [1.0.0]
     * @version [1.0.0,2017年2月16日]
     * @throws Exception 
     */
    private void init() throws Exception {
        //如果使用者沒有在參數中指定日志檔案名，則從配置檔案中擷取
        if(this.logFileName == null){
            this.logFileName = this.getLogFileNameFromConfigFile();
            //如果配置檔案不存在或者沒有指定日志檔案名，則用預設的日志檔案名
            if(logFileName == null){
                this.logFileName = DEFAULT_LOG_FILE_NAME;
            }
        }
        File logFile = new File(this.logFileName);
        try{
            /**
             * 其中的FileWriter()中的第二個參數的含義是：是否在檔案中追加内容
             * PrintWriter()中的第二個參數的含義是：自動将資料flush到檔案中
             */
            writer = new PrintWriter(new FileWriter(logFile, true), true);
            System.out.println("日志檔案的位置：" + logFile.getAbsolutePath());
        }catch (IOException ex) {
            String errmsg = "無法打開日志檔案:" + logFile.getAbsolutePath();
            throw new Exception(errmsg);
        }
    }

    /**
     * 從配置檔案名中取日志檔案名
     * <請替換成功能描述> <br>
     * <請替換成較長的描述>
     * @return
     * @author caizh
     * @since [1.0.0]
     * @version [1.0.0,2017年2月16日]
     */
    private String getLogFileNameFromConfigFile() {
        try {
            Properties pro = new Properties();
            //在類的目前位置，查找屬性配置檔案log.properties
            InputStream fin = getClass().getResourceAsStream(LOG_CONFIGFILE_NAME);
            if(fin!=null){
                pro.load(fin);//載入配置檔案
                fin.close();
                return pro.getProperty(LOGFILE_TAG_NAME);
            }else{
                System.out.println("無法打開屬性配置檔案：log.properties");
            }
        } catch (IOException e) {
            System.out.println("無法打開屬性配合檔案：log.properties");
            e.printStackTrace();
        }     
        return null;
    }

    /**
     * 擷取LogWriterUtils的唯一執行個體
     * <請替換成功能描述> <br>
     * <請替換成較長的描述>
     * @return
     * @throws Exception
     * @author caizh
     * @since [1.0.0]
     * @version [1.0.0,2017年2月16日]
     */
    public synchronized static LogWriterUtils getLogWriter()throws Exception{
        if (logWriter == null){
            logWriter = new LogWriterUtils();
        }
        return logWriter;
    }
    public synchronized static LogWriterUtils getLogWriter(String logFileName)throws Exception{
        if (logWriter == null){
            logWriter = new LogWriterUtils(logFileName);
        }
        return logWriter;
    }

    /**
     * 往日志檔案中寫一條日志資訊
     * 為了防止多線程同時記錄檔檔案，造成檔案“死鎖”。使用synchronized關鍵字
     * <請替換成功能描述> <br>
     * <請替換成較長的描述>
     * @param logMsg
     * @author caizh
     * @since [1.0.0]
     * @version [1.0.0,2017年2月16日]
     */
    public synchronized void log(String logMsg){
        this.writer.println(new Date()+": "+logMsg);
    }

    /**
     * 往日志檔案中寫一條異常資訊
     * <請替換成功能描述> <br>
     * <請替換成較長的描述>
     * @param e
     * @author caizh
     * @since [1.0.0]
     * @version [1.0.0,2017年2月16日]
     */
    public synchronized void log(Exception e){
        writer.println(new Date()+": ");
        e.printStackTrace(writer);
    }

    /**
     * 關閉LogWriter
     * <請替換成功能描述> <br>
     * <請替換成較長的描述>
     * @author caizh
     * @since [1.0.0]
     * @version [1.0.0,2017年2月16日]
     */
    public void close(){
        logWriter = null;
        if(writer!=null){
            writer.close();
        }
    }
}
           

測試類：

package com.zhihua.file.test;

import org.junit.Test;

import com.zhihua.file.LogWriterUtils;

public class LogWriterUtilsTest {

    /**
     * 
     * <請替換成功能描述> <br>
     * <請替換成較長的描述>
     * @author caizh
     * @since [1.0.0]
     * @version [1.0.0,2017年2月16日]
     * @throws Exception 
     */
    @Test
    public void log() throws Exception{
        LogWriterUtils log = null;
        String fileName = "E:/log.log";
        log = LogWriterUtils.getLogWriter(fileName);
        log.log("first log!");
        log.log("First log!");
        log.log("第二個日志資訊");
        log.log("Third log");
        log.log("第四個日志資訊");
        log.close();
    }
}