如何为SmartFox服务器接入并配置Logback日志框架

冲突核心原因 #

SmartFox 2.x版本默认内置Log4j 1.x的SLF4J绑定，直接引入Logback会触发多SLF4J绑定冲突，也就是你遇到的类加载报错问题。

操作步骤 #

1. 移除默认冲突依赖 #

进入SmartFox安装目录下的/SFS2X/lib/文件夹，删除以下jar包（删除前建议先备份整个lib目录，方便后续回滚）：

• log4j-1.x.x.jar
• commons-logging-x.x.jar
• slf4j-log4j12-x.x.x.jar

2. 引入Logback所需依赖 #

将以下兼容版本的jar包放入/SFS2X/lib/目录：

• slf4j-api-x.x.x.jar
• logback-core-x.x.x.jar
• logback-classic-x.x.x.jar
• （可选）如需桥接SmartFox原有Log4j日志调用，额外添加log4j-over-slf4j-x.x.x.jar，无需修改SmartFox源码即可将原有Log4j日志全部输出到Logback体系。

3. 新增Logback配置文件 #

在/SFS2X/config/目录下创建logback.xml配置文件，基础配置示例如下：

<configuration>
    <!-- 控制台输出Appender -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 滚动文件输出Appender，对应SmartFox原有日志路径 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logs/smartfox.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>logs/smartfox.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <maxFileSize>100MB</maxFileSize>
            <maxHistory>30</maxHistory>
            <totalSizeCap>1GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 全局日志级别配置 -->
    <root level="INFO">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="FILE" />
    </root>

    <!-- 自定义扩展专属日志级别配置，替换为你自己的扩展包路径 -->
    <logger name="com.your.extension.package" level="DEBUG" additivity="false">
        <appender-ref ref="FILE" />
    </logger>
</configuration>

4. 修改启动参数指定配置路径 #

编辑SmartFox启动脚本：

• Linux环境修改/SFS2X/start.sh
• Windows环境修改/SFS2X/start.bat
  在JVM启动参数中添加如下配置，指定Logback配置文件路径：
  -Dlogback.configurationFile=config/logback.xml

5. 自定义扩展适配 #

你的自定义扩展中无需单独引入任何日志实现依赖，直接使用SLF4J接口打印日志即可，所有日志会统一输出到Logback配置的对应路径中。如果你的扩展打包时自带了slf4j-log4j12、旧版Log4j相关依赖，需要在构建脚本中排除，避免二次冲突。

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