spring boot集成WebSocket日志實時輸出到web頁面

Posted on 2022-03-05 by WalkonNet

前言
首先瞭解下stomp
一.引入springbootwebsocket依賴
二.新增日志消息實體
三.創建一個阻塞隊列
四.獲取logback的日志，塞入日志隊列中
五.配置WebSocket消息代理端點，即stomp服務端
六.啟動類，開啟webSocket消息代理功能，並推送日志信息
七.html頁面，連接stomp服務端，訂閱/topic/pullLogger的消息，展示日志信息

前言

今天來做個有趣的東西，就是實時將系統日志輸出的前端web頁面，因為是實時輸出，所有第一時間就想到瞭使用webSocket,而且在spring boot中，使用websocket超級方便，閱讀本文，你會接觸到以下關鍵詞相關技術，WebSocket（stopmp服務端），stomp協議，sockjs.min.js，stomp.min.js（stomp客戶端），本文使用到的其實就是使用spring boot自帶的webSocket模塊提供stomp的服務端，前端使用stomp.min.js做stomp的客戶端，使用sockjs來鏈接，前端訂閱後端日志端點的消息，後端實時推送，達到日志實時輸出到web頁面的目的，效果如下圖

首先瞭解下stomp

STOMP即Simple (or Streaming) Text Orientated Messaging Protocol，簡單(流)文本定向消息協議，它提供瞭一個可互操作的連接格式，允許STOMP客戶端與任意STOMP消息代理（Broker）進行交互。STOMP協議由於設計簡單，易於開發客戶端，因此在多種語言和多種平臺上得到廣泛地應用。

STOMP協議的前身是TTMP協議（一個簡單的基於文本的協議），專為消息中間件設計。
STOMP是一個非常簡單和容易實現的協議，其設計靈感源自於HTTP的簡單性。盡管STOMP協議在服務器端的實現可能有一定的難度，但客戶端的實現卻很容易。例如，可以使用Telnet登錄到任何的STOMP代理，並與STOMP代理進行交互。

下面是具體的步驟，主要是日志信息的獲取和日志信息的推送，不多說，上代碼

一.引入spring boot websocket依賴

<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

二.新增日志消息實體

/**
 * Created by kl on 2017/10/9.
 * Content :日志消息實體，註意，這裡為瞭減少篇幅，省略瞭get,set代碼
 */
public class LoggerMessage{
    private String body;
    private String timestamp;
    private String threadName;
    private String className;
    private String level;
    public LoggerMessage(String body, String timestamp, String threadName, String className, String level) {
        this.body = body;
        this.timestamp = timestamp;
        this.threadName = threadName;
        this.className = className;
        this.level = level;
    }
    public LoggerMessage() {
    }
}

三. 創建一個阻塞隊列

作為日志系統輸出的日志的一個臨時載體

public class LoggerQueue {
    //隊列大小
    public static final int QUEUE_MAX_SIZE = 10000;
    private static LoggerQueue alarmMessageQueue = new LoggerQueue();
    //阻塞隊列
    private BlockingQueueblockingQueue = new LinkedBlockingQueue<>(QUEUE_MAX_SIZE);

    private LoggerQueue() {
    }
    public static LoggerQueue getInstance() {
        return alarmMessageQueue;
    }
    /**
     * 消息入隊
     * @param log
     * @return
     */
    public boolean push(LoggerMessage log) {
        return this.blockingQueue.add(log);//隊列滿瞭就拋出異常，不阻塞
    }
    /**
     * 消息出隊
     * @return
     */
    public LoggerMessage poll() {
        LoggerMessage result = null;
        try {
            result = this.blockingQueue.take();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return result;
    }
}

四.獲取logback的日志，塞入日志隊列中

1.定義Logfilter攔截輸出日志

public class LogFilter extends Filter{
    @Override
    public FilterReply decide(ILoggingEvent event) {
        LoggerMessage loggerMessage = new LoggerMessage(
                event.getMessage()
                , DateFormat.getDateTimeInstance().format(new Date(event.getTimeStamp())),
                event.getThreadName(),
                event.getLoggerName(),
                event.getLevel().levelStr
        );
        LoggerQueue.getInstance().push(loggerMessage);
        return FilterReply.ACCEPT;
    }
}

2.配置logback.xml,添加我們自定義的filter

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true">
    <include resource="org/springframework/boot/logging/logback/defaults.xml" />
    <property name="LOG_FILE"
              value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}/}spring.log}" />
    <include resource="org/springframework/boot/logging/logback/file-appender.xml" />
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>utf8</charset>
        </encoder>
        <filter class="com.example.websocket.LogFilter"></filter>
    </appender>
    <root level="INFO">
        <appender-ref ref="FILE" />
        <appender-ref ref="CONSOLE" />
    </root>
</configuration>

五.配置WebSocket消息代理端點，即stomp服務端

@Configuration
public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer{
    @Override
    public void registerStompEndpoints(StompEndpointRegistry registry) {
        registry.addEndpoint("/websocket")
                .setAllowedOrigins("http://localhost:8976")
                .withSockJS();
    }
}

註意：為瞭連接安全，setAllowedOrigins設置的允許連接的源地址，如果在非這個配置的地址下發起連接會報403，進一步還可以使用addInterceptors設置攔截器，來做相關的鑒權操作

六.啟動類，開啟webSocket消息代理功能，並推送日志信息

@SpringBootApplication
@EnableScheduling
@EnableWebSocketMessageBroker
public class WebsocketApplication {
	private Logger logger = LoggerFactory.getLogger(WebsocketApplication.class);
	public static void main(String[] args) {
		SpringApplication.run(WebsocketApplication.class, args);
	}
	@Autowired
	private SimpMessagingTemplate messagingTemplate;
    int info=1;
	@Scheduled(fixedRate = 1000)
	public void outputLogger(){
      logger.info("測試日志輸出"+info++);
	}
	/**
	 * 推送日志到/topic/pullLogger
	 */
	@PostConstruct
	public void pushLogger(){
		ExecutorService executorService=Executors.newFixedThreadPool(2);
		Runnable runnable=new Runnable() {
			@Override
			public void run() {
				while (true) {
					try {
						LoggerMessage log = LoggerQueue.getInstance().poll();
						if(log!=null){
							if(messagingTemplate!=null)
							messagingTemplate.convertAndSend("/topic/pullLogger",log);
						}
					} catch (Exception e) {
						e.printStackTrace();
					}
				}
			}
		};
		executorService.submit(runnable);
		executorService.submit(runnable);
	}
}

七.html頁面，連接stomp服務端，訂閱/topic/pullLogger的消息，展示日志信息

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>WebSocket Logger</title>
    <script src="https://cdn.bootcss.com/jquery/2.1.4/jquery.js"></script>
    <script src="https://cdn.bootcss.com/sockjs-client/1.1.4/sockjs.min.js"></script>
    <script src="https://cdn.bootcss.com/stomp.js/2.3.3/stomp.min.js"></script>
</head>
<body>
<button onclick="openSocket()">開啟日志</button><button onclick="closeSocket()">關閉日志</button>
<div id="log-container" style="height: 450px; overflow-y: scroll; background: #333; color: #aaa; padding: 10px;">
    <div></div>
</div>
</body>
<script>
    var stompClient = null;
    $(document).ready(function() {openSocket();});
    function openSocket() {
        if(stompClient==null){
            var socket = new SockJS('http://localhost:8084/websocket?token=kl');
            stompClient = Stomp.over(socket);
            stompClient.connect({token:"kl"}, function(frame) {
                stompClient.subscribe('/topic/pullLogger', function(event) {
                    var content=JSON.parse(event.body);
                    $("#log-container div").append(content.timestamp +" "+ content.level+" --- ["+ content.threadName+"] "+ content.className+"   :"+content.body).append("<br/>");
                    $("#log-container").scrollTop($("#log-container div").height() - $("#log-container").height());
                },{
                    token:"kltoen"
                });
            });
        }
    }
    function closeSocket() {
        if (stompClient != null) {
            stompClient.disconnect();
            stompClient=null;
        }
    }
</script>
</body>
</html>

參考地址：

stomp.js客戶端：http://jmesnil.net/stomp-websocket/doc/

scok.js客戶端：https://github.com/sockjs/sockjs-client

spring webSocket：https://docs.spring.io/spring/docs/

以上就是spring boot集成WebSocket到web頁面實時輸出的詳細內容，更多關於spring boot集成WebSocket實時輸出到web的資料請關註WalkonNet其它相關文章！

spring boot集成WebSocket日志實時輸出到web頁面

目錄

前言

首先瞭解下stomp

一.引入spring boot websocket依賴

二.新增日志消息實體

三. 創建一個阻塞隊列

四.獲取logback的日志，塞入日志隊列中

五.配置WebSocket消息代理端點，即stomp服務端

六.啟動類，開啟webSocket消息代理功能，並推送日志信息

七.html頁面，連接stomp服務端，訂閱/topic/pullLogger的消息，展示日志信息

推薦閱讀：

發佈留言取消回覆

近期文章

目錄

前言

首先瞭解下stomp

一.引入spring boot websocket依賴

二.新增日志消息實體

三. 創建一個阻塞隊列

四.獲取logback的日志，塞入日志隊列中

五.配置WebSocket消息代理端點，即stomp服務端

六.啟動類，開啟webSocket消息代理功能，並推送日志信息

七.html頁面，連接stomp服務端，訂閱/topic/pullLogger的消息，展示日志信息

推薦閱讀：

發佈留言 取消回覆

近期文章

標籤

發佈留言取消回覆