概要

Logback は log4j の後継となる Java のロガーです。作者は log4j と同じです。log4j と同様に SLF4J (Simple Logging Facade for Java) というインターフェースを実装しています。JAR ファイルを直接利用する方法と Maven から利用する方法について最も初歩的な例を紹介します。

JAR ファイルをダウンロードして利用

Download links から最新の logback (2015/04/19 現在 logback-1.1.3.zip) をダウンロードして解凍します。作業用ディレクトリに以下のファイルをコピーします。バージョンはダウンロードした logback のバージョンに依存します。

logback-classic-1.1.3.jar
logback-core-1.1.3.jar
logback-examples/lib/slf4j-api-1.7.7.jar

Main.java

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Main {
    public static void main(String args[]) {
        Logger logger = LoggerFactory.getLogger("Main");
        logger.info("info: {}", 1);
        logger.warn("warn: {}", 2);
        logger.error("error: {}", 3);
    }
}

コンパイル (Main.class の生成)

$ javac -cp './logback-classic-1.1.3.jar;./logback-core-1.1.3.jar;./slf4j-api-1.7.7.jar' Main.java

logback.xml

<configuration>
  <property name="LOG_DIR" value="./logs" />

  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${LOG_DIR}/myapp.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <!-- daily rollover  -->
      <fileNamePattern>${LOG_DIR}/myapp.%d{yyyy-MM-dd}.log</fileNamePattern>

      <!-- keep 30 days' worth of history -->
      <maxHistory>30</maxHistory>
    </rollingPolicy>
    <encoder>
      <pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n</pattern>
    </encoder>
  </appender>

  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>%msg%n</pattern>
    </encoder>
  </appender>

  <root level="info">
    <appender-ref ref="FILE" />
    <appender-ref ref="STDOUT" />
  </root>
</configuration>

実行例

$ java -cp '.;./logback-classic-1.1.3.jar;./logback-core-1.1.3.jar;./slf4j-api-1.7.7.jar' Main
info: 1
warn: 2
error: 3

$ cat logs/myapp.log
2015-04-19 13:44:16,396 INFO [main] Main [Main.java:7] info: 1
2015-04-19 13:44:16,401 WARN [main] Main [Main.java:8] warn: 2
2015-04-19 13:44:16,401 ERROR [main] Main [Main.java:9] error: 3

Maven から利用

事前に Maven のインストールを行っておいてください。

テンプレートの生成

$ mvn archetype:generate -DgroupId=com.mycompany.app -DartifactId=my-logback-app \
-DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

src/main/java/com/mycompany/app/App.java

package com.mycompany.app;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class App {
    public static void main( String[] args ) {
        Logger logger = LoggerFactory.getLogger("Main");
        logger.info("info: {}", 1);
        logger.warn("warn: {}", 2);
        logger.error("error: {}", 3);
    }
}

src/main/resources/logback.xml ← はまりポイントです。ここに作成します。あるいは、こちらを参考に以下のように POM の resource を設定すると任意の場所に配置できます。

(内容は同上)

pom.xml (Apache Maven Assembly Plugin を利用して全部入りの実行可能な JAR を作ります)

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-logback-app</artifactId>
  <packaging>jar</packaging>
  <version>1.0-SNAPSHOT</version>
  <name>my-logback-app</name>
  <url>http://maven.apache.org</url>
  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
    <!-- これを追加↓ -->
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.1.3</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.12</version>
    </dependency>
    <!-- ↑これを追加 -->
  </dependencies>

  <!-- これを追加↓ -->
  <build>
    <!-- logback.xml の場所を変更するためにはこれを追加↓ -->
    <resources>
      <resource>
        <directory>${basedir}/src</directory>
        <includes>
          <include>**/*.xml</include>
        </includes>
      </resource>
    </resources>
    <!-- ↑logback.xml の場所を変更するためにはこれを追加 -->
    <plugins>
      <plugin>
        <!-- NOTE: We don't need a groupId specification because the group is
             org.apache.maven.plugins ...which is assumed by default.
        -->
        <artifactId>maven-assembly-plugin</artifactId>
        <version>2.5.3</version>
        <configuration>
          <descriptorRefs>
            <descriptorRef>jar-with-dependencies</descriptorRef>
          </descriptorRefs>
          <archive>
            <manifest>
              <mainClass>com.mycompany.app.App</mainClass>
            </manifest>
          </archive>
        </configuration>
        <executions>
          <execution>
            <id>make-assembly</id> <!-- this is used for inheritance merges -->
            <phase>package</phase> <!-- bind to the packaging phase -->
            <goals>
              <goal>single</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
  <!-- ↑これを追加 -->
</project>

dependencies に記述する内容はこちらから検索できます。

ビルド例

$ mvn package
$ jar tf target/my-logback-app-1.0-SNAPSHOT-jar-with-dependencies.jar
...(全部入り)

実行例

$ java -jar target/my-logback-app-1.0-SNAPSHOT-jar-with-dependencies.jar
info: 1
warn: 2
error: 3

$ cat logs/myapp.log
2015-04-19 14:46:14,366 INFO [main] Main [App.java:9] info: 1
2015-04-19 14:46:14,369 WARN [main] Main [App.java:10] warn: 2
2015-04-19 14:46:14,369 ERROR [main] Main [App.java:11] error: 3