如何在Keycloak SPI中集成Logback，通过SLF4J标记实现独立文件日志

核心原因分析 #

基于 Quarkus 构建的 Keycloak 默认使用 jboss-logging 作为 SLF4J 的底层绑定实现，即使你引入 Logback 依赖，Quarkus 的类加载优先级会优先加载自身的日志绑定，导致自定义的 logback.xml 无法生效。直接替换整个 Quarkus 日志系统风险极高，会破坏 Keycloak 原生日志逻辑，因此优先推荐使用 Quarkus 原生日志配置实现需求。

方案一：使用 Quarkus 原生日志配置（推荐） #

无需引入 Logback，直接通过 Quarkus 日志配置即可实现指定包/类的日志输出到独立文件，兼容性最好。

1. 修改 Keycloak 配置文件 #

在 Keycloak 的配置文件中（Quarkus 模式用 application.properties，传统模式用 standalone.xml）添加以下配置：

# 定义自定义日志文件处理器
quarkus.log.handler.custom-spi.type=file
quarkus.log.handler.custom-spi.path=${kc.log.dir:./logs}/custom-spi.log
quarkus.log.handler.custom-spi.format=%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n
quarkus.log.handler.custom-spi.level=INFO

# 将目标包的日志路由到自定义处理器
quarkus.log.category."com.example".level=INFO
quarkus.log.category."com.example".handlers=custom-spi
quarkus.log.category."com.example".use-parent-handlers=false # 可选：避免日志同时输出到默认日志文件

2. 调整 SPI 依赖 #

移除 build.gradle 中的 Logback 依赖，仅保留 SLF4J API（Quarkus 会提供底层绑定）：

plugins {
    id 'java'
}

repositories {
    mavenCentral()
}

dependencies {
    // Keycloak SPI 核心依赖
    implementation 'org.keycloak:keycloak-core:21.1.2'
    implementation 'org.keycloak:keycloak-server-spi:21.1.2'
    implementation 'org.keycloak:keycloak-server-spi-private:21.1.2'

    // 仅保留 SLF4J API
    implementation 'org.slf4j:slf4j-api:1.7.36'
}

jar {
    archiveFileName = 'my-custom-spi.jar'
}

3. SPI 代码中正常使用 SLF4J #

package com.example;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.keycloak.provider.Provider;

public class MyCustomProvider implements Provider {
    private static final Logger logger = LoggerFactory.getLogger(MyCustomProvider.class);

    @Override
    public void close() {}

    public void handleCustomEvent() {
        logger.info("SPI 自定义事件：用户触发了XXX操作");
    }
}

方案二：强制使用 Logback（不推荐，风险高） #

如果必须使用 Logback，需要替换 Quarkus 的日志绑定，但可能导致 Keycloak 原生日志异常，仅用于特殊场景。

1. 修改依赖排除冲突 #

在 build.gradle 中排除 Quarkus 自带的日志绑定，引入 Logback：

dependencies {
    // Keycloak SPI 依赖，排除 jboss-logging 相关组件
    implementation('org.keycloak:keycloak-core:21.1.2') {
        exclude group: 'org.jboss.logging', module: 'jboss-logging'
        exclude group: 'org.jboss.slf4j', module: 'jboss-slf4j-impl'
    }
    implementation('org.keycloak:keycloak-server-spi:21.1.2') {
        exclude group: 'org.jboss.logging', module: 'jboss-logging'
        exclude group: 'org.jboss.slf4j', module: 'jboss-slf4j-impl'
    }
    implementation('org.keycloak:keycloak-server-spi-private:21.1.2') {
        exclude group: 'org.jboss.logging', module: 'jboss-logging'
        exclude group: 'org.jboss.slf4j', module: 'jboss-slf4j-impl'
    }

    // Logback 依赖
    implementation 'ch.qos.logback:logback-classic:1.2.11'
    implementation 'org.slf4j:slf4j-api:1.7.36'
}

2. 配置 logback.xml #

确保文件在 src/main/resources/ 路径下，配置自定义日志输出：

<configuration>
    <!-- 自定义 SPI 日志文件输出 -->
    <appender name="CUSTOM_SPI_FILE" class="ch.qos.logback.core.FileAppender">
        <file>${LOG_DIR:-./logs}/custom-spi.log</file>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 路由指定包的日志到自定义文件 -->
    <logger name="com.example" level="INFO" additivity="false">
        <appender-ref ref="CUSTOM_SPI_FILE" />
    </logger>

    <!-- 保留 root 日志，避免 Keycloak 原生日志丢失 -->
    <root level="INFO">
        <appender-ref ref="CONSOLE" />
    </root>
</configuration>

总结 #

优先选择方案一，利用 Quarkus 原生日志配置实现需求，避免引入额外依赖和兼容性问题。方案二仅在特殊场景下使用，需承担 Keycloak 原生日志异常的风险。

内容的提问来源于stack exchange，提问作者Anderson