自定义logback日志输出

---

前言

hello！大家好啊，好久不见！最近公司的需求，要做一款产品，把后端的实时日志输出到前端。我首先想到的是通过websocket方式。下面我们结合springboot默认集成的logback组件实现低侵入式的日志实时输入到前端界面。

---

一、方案

创建一个自定义Logback Appender，通过WebSocket将日志输出到前端，涉及到几个关键步骤：设置WebSocket服务端、实现Logback的Appender接口、以及在Logback配置中使用该Appender。以下是一个简化的示例，用Java和Spring Boot框架展示如何实现这一功能。

二、实现步骤

1.添加依赖

确保你的项目中包含了Spring Boot、WebSocket以及Logback的依赖。对于WebSocket，Spring Boot已经提供了自动配置支持，你可能只需要添加Spring Boot Starter Web依赖。

<!-- Spring Boot Starter Web 包含了WebSocket的支持 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

2. 配置WebSocket

创建一个WebSocket配置类，用于设置WebSocket端点和处理消息。

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new LogWebSocketHandler(), "/log").setAllowedOrigins("*");
    }

    @Bean
    public LogWebSocketHandler logWebSocketHandler() {
        return new LogWebSocketHandler();
    }
}

3.创建WebSocket服务端

首先，创建一个WebSocketHandler来处理客户端的连接和消息发送。

import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

public class LogWebSocketHandler extends TextWebSocketHandler {

    private List<WebSocketSession> sessions = new CopyOnWriteArrayList<>();

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        sessions.add(session);
    }

    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        // 处理接收到的消息，如果需要的话
    }

    public void sendMessageToAll(String message) {
        for (WebSocketSession session : sessions) {
            try {
                session.sendMessage(new TextMessage(message));
            } catch (Exception e) {
                // 处理异常
                sessions.remove(session);
            }
        }
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        sessions.remove(session);
    }
}

3.实现Logback Appender

接着，实现自定义的Logback Appender，它将使用上面创建的WebSocketHandler将日志消息推送到前端。

import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.AppenderBase;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class WebSocketLogAppender extends AppenderBase<ILoggingEvent> {

    @Autowired
    private LogWebSocketHandler webSocketHandler;

    @Override
    protected void append(ILoggingEvent eventObject) {
        String formattedMessage = eventObject.getFormattedMessage(); // 格式化日志消息
        webSocketHandler.sendMessageToAll(formattedMessage); // 发送消息到WebSocket客户端
    }
}

4.配置Logback

最后，在Logback的配置文件（logback.xml）中使用你的自定义Appender。

<configuration>
    <appender name="WEBSOCKET" class="com.tg.logging.WebSocketLogAppender"/>

    <root level="INFO">
        <appender-ref ref="WEBSOCKET"/>
    </root>
</configuration>

---

5.前端定义日志

前端使用JavaScript（可能配合如Socket.IO或Stomp.js等库）订阅WebSocket消息。

var socket = new SockJS('/ws-log');
var stompClient = Stomp.over(socket);
stompClient.connect({}, function(frame) {
    stompClient.subscribe('/topic/logs', function(logMessage) {
        // 处理并显示日志消息
        console.log(logMessage.body);
    });
});