Version v2.2 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.

ロギング

概要

KomapperはSQLやトランザクションに関するログを出力します。

出力先のデフォルトは標準出力ですが変更可能です。

ログカテゴリ

Komapperが出力するログのカテゴリは以下に示す4つです。

  • org.komapper.Sql
  • org.komapper.SqlWithArgs
  • org.komapper.Transaction
  • org.komapper.Other

org.komapper.Sql

このカテゴリでは、バインド変数付きのSQLがDEBUGレベルで出力されます。

insert into ADDRESS (STREET, VERSION, CREATED_AT, UPDATED_AT) values (?, ?, ?, ?)
select t0_.ADDRESS_ID, t0_.STREET, t0_.VERSION, t0_.CREATED_AT, t0_.UPDATED_AT from ADDRESS as t0_ where t0_.ADDRESS_ID = ?

org.komapper.SqlWithArgs

このカテゴリでは、バインド変数が引数によって解決された形式のSQLがTRACEレベルで出力されます。

insert into ADDRESS (STREET, VERSION, CREATED_AT, UPDATED_AT) values ('street A', 0, '2021-07-31T21:23:24.511', '2021-07-31T21:23:24.511')
select t0_.ADDRESS_ID, t0_.STREET, t0_.VERSION, t0_.CREATED_AT, t0_.UPDATED_AT from ADDRESS as t0_ where t0_.ADDRESS_ID = 1

org.komapper.Transaction

このカテゴリでは、トランザクションの開始、コミット、ロールバックを示すメッセージがTRACEレベルで出力されます。

Begin:    JdbcTransaction(id=032d9623-919f-43d4-ad00-f7d4c1518393, name=null)
Rollback: JdbcTransaction(id=032d9623-919f-43d4-ad00-f7d4c1518393, name=null)
Begin:    JdbcTransaction(id=a108b824-3353-475c-a29b-cb1575951803, name=null)
Commit:   JdbcTransaction(id=a108b824-3353-475c-a29b-cb1575951803, name=null)

org.komapper.Other

このカテゴリは他のどのカテゴリにも属さないログを表します。 任意のログレベルで出力されます。

LoggerFacadeの利用

LoggerFacadeを使えば、ログメッセージやログレベルの変更ができます。

SQLのログレベルを変更する場合の設定例

例えば、SQLのログレベルをDEBUGからINFOに変更したい場合は、以下のようなLoggerFacadeの実装とそのファクトリを作成します。

package example

import org.komapper.core.DefaultLoggerFacade
import org.komapper.core.LogCategory
import org.komapper.core.Logger
import org.komapper.core.LoggerFacade
import org.komapper.core.Statement
import org.komapper.core.StatementPart
import org.komapper.core.spi.LoggerFacadeFactory

class MyLoggerFacade(private val logger: Logger) : LoggerFacade by DefaultLoggerFacade(logger) {
    override fun sql(statement: Statement, format: (Int, StatementPart.Value) -> CharSequence) {
        logger.info(LogCategory.SQL) {
            statement.toSql(format)
        }
    }
}

class MyLoggerFacadeFactory : LoggerFacadeFactory {
    override fun create(logger: Logger): LoggerFacade {
        return MyLoggerFacade(logger)
    }
}

src/main/resource/META-INF/servicesディレクトリの下に org.komapper.core.spi.LoggerFacadeFactoryという名前のファイルを作成し、 このファイルにファクトリの完全修飾名を記載してください。

SLF4Jの利用

SLF4J を利用してログ出力するにはkomapper-slf4jモジュールをGradleの依存関係の宣言に含めます。

val komapperVersion: String by project

dependencies {
    runtimeOnly("org.komapper:komapper-slf4j:$komapperVersion")
}

また、SLF4Jの実装として Logback を使う場合はlogback-classicモジュールも依存関係の宣言に含めます。

val komapperVersion: String by project

dependencies {
    runtimeOnly("org.komapper:komapper-slf4j:$komapperVersion")
    runtimeOnly("ch.qos.logback:logback-classic:1.2.5")
}

LogbackでSQLのログ出力をする場合の設定例

次のようなlogback.xmlをsrc/main/resourcesの下に配置すると、バインド変数?が含まれた形式のSQLがコンソールに出力されます。

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    
    <logger name="org.komapper.Sql" level="debug"/>

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

バインド変数を引数で置換した形式のSQLをコンソールに出力したい場合は以下のように設定してください。

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    
    <logger name="org.komapper.SqlWithArgs" level="trace"/>

    <root level="info">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>
最終更新 March 19, 2022: Fix the use of LoggerFacade (aa87d69)