springboot控制台实时日志获取

技术实现sse

sse简介

SSE （ Server-sent Events ）是 WebSocket 的一种轻量代替方案，使用 HTTP 协议。

严格地说，HTTP 协议是没有办法做服务器推送的，但是当服务器向客户端声明接下来要发送流信息时，客户端就会保持连接打开，SSE 使用的就是这种原理。

SSE 是 Server-Sent Events 的简称， 是一种服务器端到客户端(浏览器)的单项消息推送。

相比于 WebSocket，SSE 简单不少，服务器端和客户端工做量都要小不少、简单不少，同时实现的功能也有局限。

代码:

package com.ruoyi.teamline.controller;

import org.bouncycastle.util.io.TeeOutputStream;
import org.jetbrains.annotations.NotNull;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.http.MediaType;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;

import java.io.*;
import java.util.concurrent.CopyOnWriteArrayList;

@RestController
@RequestMapping("log")
public class LogController {
    
    private final CopyOnWriteArrayList<SseEmitter> emitters = new CopyOnWriteArrayList<>();

    private final CustomOutputStream customOutputStream;
    private final PrintStream originalSystemOut;

    public LogController() {
        customOutputStream = new CustomOutputStream();
        originalSystemOut = System.out;
        //TeeOutputStream 会将输出同时发送到两个不同的输出流，一个用于控制台输出，另一个用于SSE
        System.setOut(new PrintStream(new TeeOutputStream(originalSystemOut, customOutputStream)));
    }

    /**
     * sse控制器
     * @return
     */
    @GetMapping(value = "/stream", produces = MediaType.TEXT_EVENT_STREAM_VALUE)
    public SseEmitter streamConsoleLogs() {
        //timeout超时时间，超过该时间会自动断开，单位ms,0表示永不断开
        SseEmitter emitter = new SseEmitter(10*60*1000l);
        emitters.add(emitter);
        emitter.onCompletion(() -> emitters.remove(emitter));
        return emitter;
    }

    /**
     * 发送消息
     * @param message
     */
    public void pushConsoleLogMessage(String message) {
        for (SseEmitter emitter : emitters) {
            try {
                emitter.send(SseEmitter.event()
                        .data(message));
            } catch (IOException e) {
                emitters.remove(emitter);
            }
        }
    }

    /**
     * 创建一个自定义的OutputStream，其中的write 方法用于捕获标准输出流的内容，并执行自定义操作
     */
    private class CustomOutputStream extends OutputStream {

        @Override
        public void write(int b) throws IOException {

        }

        @Override
        public void write(@NotNull byte[] b, int off, int len) throws IOException {
            //使用sse推送消息
            pushConsoleLogMessage(new String(b));
        }
    }
}