Javaロギング・フレームワーク--Log4jログ

A、Log4jのプロフィール

ApacheのLog4Jのは、オープンソースプロジェクト（公式サイトで  http://jakarta.apache.org/log4j）、プロジェクトでLog4Jのを使用することにより、我々は、コンソール、ファイル、GUIコンポーネント、あるいはデータベースにログ情報を制御することができます。我々は、より柔軟な制御ログ出力処理することができるログが出力レベルによって定義され、各ログの出力形式を制御することができます。プロジェクトをデバッグするための簡単。

1. Log4jのコンポーネント：

log4jは、主に以下のコンポーネントで構成されます。

ロガーは（ロガー）である：ログ出力レベルを制御し、出力ログするかどうか;

アペンダ（出力）： （コンソール、ファイルなどへの）ログの出力形式を指定します。

レイアウト（ログ形式の出力デバイス）：コントロールログ情報の出力形式。

Log4jのは「ルート」と呼ばれる特別なロガーを持って、彼は他のすべてのロガーがルートから直接または間接的に継承することを意味し、すべてのロガーのルートです。

ルートロガーは、取得するLogger.getRootLogger（）メソッドを呼び出すことができます。

2.Appendersは：どの場所にログ出力を指定するには、ログの出力先を指定することができ、Log4jに一般的に使用される出力先には、いくつかの程度があります。

出力端子タイプ	効果
ConsoleAppender	コンソールへのログ出力
FileAppender	ファイルへのログ出力
DailyRollingFileAppender	新しいファイルへのログログファイルに出力し、出力毎日
RollingFileAppender	新しいファイルを生成しながら、ファイルサイズは、自動的に指定されたサイズ、ドキュメント名に達したログファイルに出力ログ情報、および指定されたファイルのサイズ、
JDBCAppender	データベースにログ情報を保存

3.Layouts：ログ出力制御内容についてプレーサーレイアウト形式なので、我々は、出力ログのニーズの形式を使用することができ、Log4jの共通レイアウト：

フォーマットタイプ	効果
HTMLLayout	ログ出力は、HTMLテーブル形式としてフォーマット
SimpleLayout	ログフォーマットを印刷するためのシンプルなログ出力形式（情報メッセージ）
PatternLayoutは	最も強力な書式設定期間、カスタムフォーマットの出力ログによると、あなたは、フォーマット変換を指定しない場合、デフォルトのフォーマット変換を使用することです
xml.XMLLayout	XMLエクスポート

4.Layout形式：Log4j.propertiesは、設定ファイルには、我々は、ログ出力レベルと出力端子を定義します。ログの出力形式の出力に配置されています。

（1）のLog4jは、フォーマットC状レイアウトログ情報printf関数、特定のプレースホルダを使用し、その意味は次のとおりです。

プレースホルダ	意味
％mを	コード内で指定された出力ログ情報
％pを	出力優先度、およびDEBUG、INFO、など
％nを	改行
％rを	費やしたミリ秒数のログ情報の開始から出力への出力
％のC	フルネーム印刷出力文はクラスに属し
％トン	ログ出力生成スレッドフルネーム
％dの	％のD {YYYY、MM-DD日HH：MM：SS}サーバー現在時刻出力は、デフォルトはまたなど、フォーマットを指定することができ、ISO8601であります
％のL	時間のクラス名を含む出力ログの位置、スレッド、コードの行数
％F	ときにログメッセージが生成された出力ファイル名を
％のL	コードの行番号の出力
%%	出力「％」文字

（2）％、最小幅、その実施形態の最大幅とテキストを制御するために、文字修飾剤との間に追加することができます

プレースホルダ	意味
％5cと	出力カテゴリ名、最小幅は5で、デフォルトカテゴリ別に5下右、<整列
％-5℃	出力カテゴリ名、最小幅は、5カテゴリー<5である、「_」左揃え、スペースがあるだろうが指定されています
％.5c	出力カテゴリ名、最大幅が5で、カテゴリ> 5.複数文字から除外されます5には、スペースを持っていない<、切り捨て
％の20.30c	出力カテゴリ名<20塗りつぶしスペース、右寄せ、出力カテゴリ名>文字30個の文字が、それははるかに切断さの左から出力され、

第二に、クイックスタート

首先在 maven 中引入 log4j 的依赖:

<!-- log日志 -->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>

创建 Log4jTest 类，测试 Log4j 的使用：

  @Test
    public void testQuick() throws Exception{
//        开启log4j内置日志记录
        LogLog.setInternalDebugging(true);


//        初始化配置信息，在入门案例中暂不使用配置文件
        BasicConfigurator.configure();
//        获取日志记录器对象
        Logger logger = Logger.getLogger(Log4jDemo.class);
//        日志记录输出
        logger.info("hello log4j");

//        日志级别



        //设置日志输出级别为WARN，这将覆盖配置文件中设置的级别，只有日志级别高于WARN的日志才输出
            logger.setLevel(Level.WARN);
            logger.fatal("fatal");//严重错误，一般会造成系统崩溃并终止运行

            logger.error("error");//错误信息，不会影响系统运行
            logger.warn("warn");  //警告信息，可能会发生问题
            logger.info("info");  //运行信息，数据连接、网络连接、IO操作等等
            logger.debug("debug");//调试信息，一般在开发中使用，记录程序变量参数传递信息等等

            logger.trace("trace");//追踪信息，记录程序所有的流程信息



//        在获取一个日志记录器对象
        Logger logger1 = Logger.getLogger(Logger.class);

        logger1.fatal("fatal  logger1");//严重错误，一般会造成系统崩溃并终止运行

        logger1.error("error  logger1");//错误信息，不会影响系统运行
        logger1.warn("warn  logger1");  //警告信息，可能会发生问题
        logger1.info("info  logger1");  //运行信息，数据连接、网络连接、IO操作等等
        logger1.debug("debug  logger1");//调试信息，一般在开发中使用，记录程序变量参数传递信息等等

        logger1.trace("trace  logger1");//追踪信息，记录程序所有的流程信息

    }

这里首先通过 Logger.getLogger(Log4Test.class) 创建 Logger 实例，然后调用 BasicConfigurator.configure() 方法指定该 Logger 使用默认的配置信息，接着调用 looger.setLevel(Level.WARN) 设置 Logger 的日志输出级别为 WARN 。运行 main 函数，控制台将会输出 warn 以上的错误信息。控制台输出如下：

0 [main] INFO LoggerDemo.Log4jDemo  - hello log4j
5 [main] FATAL LoggerDemo.Log4jDemo  - fatal
5 [main] ERROR LoggerDemo.Log4jDemo  - error
5 [main] WARN LoggerDemo.Log4jDemo  - warn
6 [main] FATAL org.apache.log4j.Logger  - fatal  logger1
6 [main] ERROR org.apache.log4j.Logger  - error  logger1
6 [main] WARN org.apache.log4j.Logger  - warn  logger1
7 [main] INFO org.apache.log4j.Logger  - info  logger1
7 [main] DEBUG org.apache.log4j.Logger  - debug  logger1
7 [main] TRACE org.apache.log4j.Logger  - trace  logger1

注：如果没有调用 BasicConfigurator.configure() 方法，则运行 main 函数的时候则会报错，因为 Log4j 框架在运行的时候会加载项目路径下的 log4j.properties 配置文件（关于配置文件的使用，会在后面讲解）。而我们此时的项目中是没有该文件的。如果配置文件的名称不是 log4j.properties，则可以通过 PropertyConfigurator.configure(String configFilename) 指定配置文件的名称。

格式化器的使用

修改 Log4JTest 中的代码：

public class Log4JTest {
 
    public static void main(String[] args) {
        Logger logger = Logger.getLogger(Log4JTest.class);
        BasicConfigurator.configure();
        HTMLLayout layout = new HTMLLayout();
        // SimpleLayout layout = new SimpleLayout();
        try {
            FileAppender appender = new FileAppender(layout, "D:\\out.html", false);
            logger.addAppender(appender);
            //设置日志输出级别为info，这将覆盖配置文件中设置的级别，只有日志级别高于WARN的日志才输出
            logger.setLevel(Level.WARN);
            logger.debug("这是debug");
            logger.info("这是info");
            logger.warn("这是warn");
            logger.error("这是error");
            logger.fatal("这是fatal");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
 
}

首先创建一个HTML格式的格式化器（HTMLLayout），然后创建文件输出端（FileAppender）指定输出端的格式为 HTML 格式，这里我指定输出路径为 D 盘下的 out.html 文件。然后通过 logger.addAppender(appender) 将文件输出端加载到 Logger 中。运行 main 函数，在 D 盘下会生成一个 out.html 文件，打开文件，里面的信息就是代码中输出的日志信息：

log4j.properties 配置文件的使用

上面使用代码的方式设置 Logger 的输出格式，这样在我们每个要输出日志的类上都得设置一遍配置未免也太麻烦了吧。有一种更加方便的方法，我们只需要在项目路径下新建 log4j.properties 配置文件，并配置日志的输出格式等信息，Log4J 框架会自动的加载配置文件，并将配置信息设置到 Logger 中。最简单的配置文件如下：

#配置根  Loggers控制日志的输出级别与日志是否输出
log4j.rootLogger=trace,console

#自定义logger对象设置
log4j.logger.LoggerDemo = info,file

#配置输出到控制台  Appenders是指定日志的输出方式
log4j.appender.console=org.apache.log4j.ConsoleAppender
#指定输出控制台
log4j.appender.console.Target = System.out
#指定布局,输出日志的格式
log4j.appender.console.layout=org.apache.log4j.PatternLayout
#指定布局的参数
log4j.appender.console.layout.ConversionPattern=[%-10p] %r %l %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n


#配置输出到控制台  Appenders是指定日志的输出方式
log4j.appender.file=org.apache.log4j.FileAppender
#指定布局,输出日志的格式
log4j.appender.file.layout=org.apache.log4j.PatternLayout
#指定布局的参数
log4j.appender.file.layout.ConversionPattern=[%-10p] %r %l %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n
#指定日志文件保存路径
log4j.appender.file.file = /logs/log4j.log
#指定日志文件字符集
log4j.appender.file.encoding = UTF-8

#配置输出到控制台  Appenders是指定日志的输出方式
log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender
#指定布局,输出日志的格式
log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout
#指定布局的参数
log4j.appender.rollingFile.layout.ConversionPattern=[%-10p] %r %l %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n
#指定日志文件保存路径
log4j.appender.rollingFile.file = /logs/log4j.log
#指定日志文件字符集
log4j.appender.rollingFile.encoding = UTF-8
#指定日志文件内容的大小
log4j.appender.rollingFile.maxFileSize = 1MB
#指定日志文件的数量
log4j.appender.rollingFile.maxBackupIndex = 10

#配置输出到控制台  Appenders是指定日志的输出方式
log4j.appender.dailyRollingFile=org.apache.log4j.DailyRollingFileAppender
#指定布局,输出日志的格式
log4j.appender.dailyRollingFile.layout=org.apache.log4j.PatternLayout
#指定布局的参数
log4j.appender.dailyRollingFile.layout.ConversionPattern=[%-10p] %r %l %d{yyyy-MM-dd HH:mm:ss.SSS} %m%n
#指定日志文件保存路径
log4j.appender.dailyRollingFile.file = /logs/log4j.log
#指定日志文件字符集
log4j.appender.dailyRollingFile.encoding = UTF-8
#指定日志输出规则
log4j.appender.dailyRollingFile.datePattern = '.'yyyy-MM-dd-HH-mm-ss


#mysql
log4j.appender.logDB=org.apache.log4j.jdbc.JDBCAppender
#指定布局,输出日志的格式
log4j.appender.logDB.layout=org.apache.log4j.PatternLayout

log4j.appender.logDB.Driver = com.mysql.jdbc.Driver
log4j.appender.logDB.URL = jdbc:mysql://localhost:3306/logs
log4j.appender.logDB.User = root
log4j.appender.logDB.Password = root
log4j.appender.logDB.Sql = INSERT INTO log(project_name,create_date,level,category,file_name,thread_name,line,all_category,message) values('itcast','%d{yyyy-MM-dd HH:mm:ss}','%p','%c','%F','%t','%L','%l','%m')

使用JDBCAppender导出日志格式时，数据库设计如下： 

DROP TABLE IF EXISTS `log`;
CREATE TABLE `log` (
  `log_id` int(11) NOT NULL AUTO_INCREMENT,
  `project_name` varchar(255) COLLATE utf8_general_mysql500_ci DEFAULT NULL COMMENT '项目名',
  `create_date` varchar(255) COLLATE utf8_general_mysql500_ci DEFAULT NULL COMMENT '创建时间',
  `level` varchar(255) COLLATE utf8_general_mysql500_ci DEFAULT NULL COMMENT '优先级',
  `category` varchar(255) COLLATE utf8_general_mysql500_ci DEFAULT NULL COMMENT '所在类的全名',
  `file_name` varchar(255) COLLATE utf8_general_mysql500_ci DEFAULT NULL COMMENT '输出日志消息产生时所在的文件名称',
  `thread_name` varchar(255) COLLATE utf8_general_mysql500_ci DEFAULT NULL COMMENT '日志事件的线程名',
  `line` varchar(255) COLLATE utf8_general_mysql500_ci DEFAULT NULL COMMENT '行号',
  `all_category` varchar(255) COLLATE utf8_general_mysql500_ci DEFAULT NULL COMMENT '日志事件的发生位置',
  `message` varchar(4000) COLLATE utf8_general_mysql500_ci DEFAULT NULL COMMENT '输出代码中指定的消息',
  PRIMARY KEY (`log_id`)
) ENGINE=InnoDB AUTO_INCREMENT=30013 DEFAULT CHARSET=utf8 COLLATE=utf8_general_mysql500_ci;