💡 websocket 改为可配置手动开启的功能

Author: zhangyd-c

blog-admin/src/main/java/com/zyd/blog/core/websocket/server/ZydWebsocketServer.java

@@ -1,6 +1,8 @@
 package com.zyd.blog.core.websocket.server;
 
+import com.zyd.blog.business.service.SysConfigService;
 import com.zyd.blog.core.websocket.util.WebSocketUtil;
+import com.zyd.blog.framework.holder.SpringContextHolder;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Component;
 
@@ -38,9 +40,15 @@ public class ZydWebsocketServer {
  */
  @OnOpen
  public void onOpen(Session session) {
+ SysConfigService sysConfigService = SpringContextHolder.getBean(SysConfigService.class);
+ if (!sysConfigService.enabledWebSocket()) {
+ webSocketSet.clear();
+ onlineCount.set(0);
+ return;
+ }
  webSocketSet.add(session);
  int count = onlineCount.incrementAndGet();
- log.info("[Socket] 有链接加入，当前在线人数为: {}", count);
+ log.debug("[Socket] 有链接加入，当前在线人数为: {}", count);
 
  WebSocketUtil.sendOnlineMsg(Integer.toString(count), webSocketSet);
  }
@@ -50,8 +58,14 @@ public void onOpen(Session session) {
  */
  @OnClose
  public void onClose() {
+ SysConfigService sysConfigService = SpringContextHolder.getBean(SysConfigService.class);
+ if (!sysConfigService.enabledWebSocket()) {
+ webSocketSet.clear();
+ onlineCount.set(0);
+ return;
+ }
  int count = onlineCount.decrementAndGet();
- log.info("[Socket] 有链接关闭,当前在线人数为: {}", count);
+ log.debug("[Socket] 有链接关闭,当前在线人数为: {}", count);
  WebSocketUtil.sendOnlineMsg(Integer.toString(count), webSocketSet);
  }
 
@@ -63,7 +77,13 @@ public void onClose() {
  */
  @OnMessage
  public void onMessage(String message, Session session) {
- log.info("[Socket] {}来自客户端的消息:{}", session.getId(), message);
+ SysConfigService sysConfigService = SpringContextHolder.getBean(SysConfigService.class);
+ if (!sysConfigService.enabledWebSocket()) {
+ webSocketSet.clear();
+ onlineCount.set(0);
+ return;
+ }
+ log.debug("[Socket] {}来自客户端的消息:{}", session.getId(), message);
  }
 
  /**

blog-admin/src/main/resources/templates/config.ftl

@@ -649,6 +649,16 @@
  </ul>
  </div>
  </div>
+ <div class="item form-group">
+ <label class="control-label col-md-3 col-sm-3 col-xs-12" for="maintenance">启用 WebSocket 通知服务
+ <i class="fa fa-question-circle" title="当启用时，用户侧会自动链接到服务端的 Websocket 服务上，管理员可以在控制台通过“实验室-推送消息”向用户侧广播消息"></i> </label>
+ <div class="col-md-6 col-sm-6 col-xs-12 fixed-radio-checkbox">
+ <ul class="list-unstyled list-inline">
+ <li><label for="maintenance" class="pointer"> <input type="radio" class="square" checked name="enabledWebSocket" value="1"> 启用 </label> </li>
+ <li><label for="maintenance" class="pointer"> <input type="radio" class="square" name="enabledWebSocket" value="0"> 禁用 </label></li>
+ </ul>
+ </div>
+ </div>
  <div class="item form-group">
  <label class="control-label col-md-3 col-sm-3 col-xs-12" for="maintenance">维护通知
  <i class="fa fa-question-circle" title="网站在更新前， 可以通过开启该功能，通知用户"></i> </label>
@@ -700,13 +710,13 @@
  </div>
  </div>
  <div class="item form-group">
- <label class="control-label col-md-3 col-sm-3 col-xs-12" for="wxGzhAppId">公众号APP_ID <i class="fa fa-question-circle" title="配置微信公众号的appId"></i></label>
+ <label class="control-label col-md-3 col-sm-3 col-xs-12" for="wxGzhAppId">公众号APP_ID <i class="fa fa-question-circle" title="如果需要将文章分享到微信侧并要求显示封面，则必须配置"></i></label>
  <div class="col-md-6 col-sm-6 col-xs-12">
  <input type='text' class="form-control" id="wxGzhAppId" name="wxGzhAppId" placeholder="请输入信公众号的appId"/>
  </div>
  </div>
  <div class="item form-group">
- <label class="control-label col-md-3 col-sm-3 col-xs-12" for="wxGzhAppSecret">公众号APP_SECRET <i class="fa fa-question-circle" title="配置微信公众号的appSecret"></i></label>
+ <label class="control-label col-md-3 col-sm-3 col-xs-12" for="wxGzhAppSecret">公众号APP_SECRET <i class="fa fa-question-circle" title="如果需要将文章分享到微信侧并要求显示封面，则必须配置"></i></label>
  <div class="col-md-6 col-sm-6 col-xs-12">
  <input type='text' class="form-control" id="wxGzhAppSecret" name="wxGzhAppSecret" placeholder="请输入信公众号的appSecret"/>
  </div>

blog-core/src/main/java/com/zyd/blog/business/enums/ConfigKeyEnum.java

@@ -253,6 +253,10 @@ public enum ConfigKeyEnum {
  * 微信公众号AppSecret
  */
  WX_GZH_APP_SECRET("wxGzhAppSecret"),
+ /**
+ * 是否开启 webSocket
+ */
+ ENABLED_WEBSOCKET("enabledWebSocket"),
  ;
 
  private final String key;

blog-core/src/main/java/com/zyd/blog/business/service/SysConfigService.java

@@ -65,4 +65,10 @@ public interface SysConfigService {
  */
  List<String> getRandomUserAvatar();
 
+ /**
+ * 获取系统是否开启 WebSocket 的配置
+ * @return true: 开启，false: 关闭
+ */
+ boolean enabledWebSocket();
+
 }

blog-core/src/main/java/com/zyd/blog/business/service/impl/SysConfigServiceImpl.java

@@ -3,6 +3,7 @@
 import cn.hutool.core.date.DatePattern;
 import cn.hutool.core.date.DateUnit;
 import cn.hutool.core.date.DateUtil;
+import cn.hutool.core.util.BooleanUtil;
 import com.alibaba.fastjson.JSONArray;
 import com.zyd.blog.business.annotation.RedisCache;
 import com.zyd.blog.business.consts.DateConst;
@@ -174,4 +175,14 @@ public List<String> getRandomUserAvatar() {
  }
  return null;
  }
+
+ @Override
+ public boolean enabledWebSocket() {
+ SysConfig sysConfig = this.getByKey(ConfigKeyEnum.ENABLED_WEBSOCKET.getKey());
+ // 默认开启
+ if (null == sysConfig) {
+ return true;
+ }
+ return BooleanUtil.toBoolean(sysConfig.getConfigValue());
+ }
 }

blog-web/src/main/resources/static/js/zhyd.core.js

@@ -92,7 +92,7 @@
  _initialized: false,
  init: function (options) {
  if (!this.isSupported()) {
- // console.error('Not support websocket');
+ console.log('Not supported websocket');
  return;
  }
  var op = $.extend({
@@ -159,7 +159,7 @@
  }
  },
  isSupported: function () {
- return 'WebSocket' in window;
+ return '1' === appConfig.enabledWebSocket && 'WebSocket' in window;
  },
  send: function (message) {
  if (!this._this) {

blog-web/src/main/resources/templates/layout/footer.ftl

@@ -187,6 +187,7 @@
  editorAlert: "${config.editorAlert}",
  dynamicTitle: "${config.dynamicTitle}",
  bubbleWord: "${config.bubbleWord}",
+ enabledWebSocket: "${config.enabledWebSocket}"
  };
 
  var oauthConfig = {