【jeecg学习记录】spring websocket配置——可移植到自己的springboot系统，后台采用redis做消息推送（轻巧适合小型系统，大型系统建议使用其他方式）

🌸 websocket配置 🌸

• 首先2022-06-10下载下来的源码心跳模块的日志打印都是关掉的，所以咱们看不出来心跳传送，这里记录下怎么把日志放开调试的步骤
  
• 到官方源码看websocket配置代码，位置在这：
  • ant-design-vue-jeecg/src/components/tools/HeaderNotice.vue
    
• 注意这几个被注释的地方
  
  
  
  
• 看后端websocket配置
  • jeecg-boot/jeecg-boot-module-system/src/main/java/org/jeecg/modules/message/websocket/WebSocket.java
• 后端无需改什么代码，可以启动调试下，多在前后端进行debugger即可，如有疑问可留言交流哈，附上前端改动及弹窗代码

<template>
  <a-popover
    trigger="click"
    placement="bottomRight"
    :autoAdjustOverflow="true"
    :arrowPointAtCenter="true"
    overlayClassName="header-notice-wrapper"
    @visibleChange="handleHoverChange"
    :overlayStyle="{ width: '300px', top: '50px' }"
  >
    <template slot="content">
      <a-spin :spinning="loadding">
        <a-tabs>
          <a-tab-pane :tab="msg1Title" key="1">
            <!-- <a-list>
              <a-list-item>
                <a-list-item-meta title="你收到了 14 份新周报" description="一年前">
                  <a-avatar style="background-color: white" slot="avatar" src="https://gw.alipayobjects.com/zos/rmsportal/ThXAXghbEsBCCSDihZxY.png"/>
                </a-list-item-meta>
              </a-list-item>
              <a-list-item>
                <a-list-item-meta title="你推荐的 IT大牛 已通过第三轮面试" description="一年前">
                  <a-avatar style="background-color: white" slot="avatar" src="https://gw.alipayobjects.com/zos/rmsportal/OKJXDXrmkNshAMvwtvhu.png"/>
                </a-list-item-meta>
              </a-list-item>
              <a-list-item>
                <a-list-item-meta title="这种模板可以区分多种通知类型" description="一年前">
                  <a-avatar style="background-color: white" slot="avatar" src="https://gw.alipayobjects.com/zos/rmsportal/kISTdvpyTAhtGxpovNWd.png"/>
                </a-list-item-meta>
              </a-list-item>
            </a-list> -->
            <a-list>
              <a-list-item :key="index" v-for="(record, index) in announcement1">
                <div style="margin-left: 5%; width: 80%">
                  <p>
                    <a @click="showAnnouncement(record)">{{ record.titile }}</a>
                  </p>
                  <p style="color: rgba(0, 0, 0, 0.45); margin-bottom: 0px">{{ record.createTime }} 发布</p>
                </div>
                <div style="text-align: right">
                  <a-tag @click="showAnnouncement(record)" v-if="record.priority === 'L'" color="blue">一般消息</a-tag>
                  <a-tag @click="showAnnouncement(record)" v-if="record.priority === 'M'" color="orange"
                    >重要消息</a-tag
                  >
                  <a-tag @click="showAnnouncement(record)" v-if="record.priority === 'H'" color="red">紧急消息</a-tag>
                </div>
              </a-list-item>
              <div style="margin-top: 5px; text-align: center">
                <a-button @click="toMyAnnouncement()" type="dashed" block>查看更多</a-button>
              </div>
            </a-list>
          </a-tab-pane>
          <a-tab-pane :tab="msg2Title" key="2">
            <a-list>
              <a-list-item :key="index" v-for="(record, index) in announcement2">
                <div style="margin-left: 5%; width: 80%">
                  <p>
                    <a @click="showAnnouncement(record)">{{ record.titile }}</a>
                  </p>
                  <p style="color: rgba(0, 0, 0, 0.45); margin-bottom: 0px">{{ record.createTime }} 发布</p>
                </div>
                <div style="text-align: right">
                  <a-tag @click="showAnnouncement(record)" v-if="record.priority === 'L'" color="blue">一般消息</a-tag>
                  <a-tag @click="showAnnouncement(record)" v-if="record.priority === 'M'" color="orange"
                    >重要消息</a-tag
                  >
                  <a-tag @click="showAnnouncement(record)" v-if="record.priority === 'H'" color="red">紧急消息</a-tag>
                </div>
              </a-list-item>
              <div style="margin-top: 5px; text-align: center">
                <a-button @click="toMyAnnouncement()" type="dashed" block>查看更多</a-button>
              </div>
            </a-list>
          </a-tab-pane>
        </a-tabs>
      </a-spin>
    </template>
    <span @click="fetchNotice" class="header-notice">
      <a-badge :count="msgTotal">
        <a-icon style="font-size: 16px; padding: 4px" type="bell" />
      </a-badge>
    </span>
    <show-announcement ref="ShowAnnouncement" @ok="modalFormOk"></show-announcement>
    <dynamic-notice ref="showDynamNotice" :path="openPath" :formData="formData" />
  </a-popover>
</template>

<script>
import { getAction, putAction } from '@/api/manage'
import ShowAnnouncement from './ShowAnnouncement'
import store from '@/store/'
import DynamicNotice from './DynamicNotice'

export default {
  name: 'HeaderNotice',
  components: {
    DynamicNotice,
    ShowAnnouncement,
  },
  data() {
    return {
      loadding: false,
      url: {
        listCementByUser: '/sys/annountCement/listByUser',
        editCementSend: '/sys/sysAnnouncementSend/editByAnntIdAndUserId',
        queryById: '/sys/annountCement/queryById',
      },
      hovered: false,
      announcement1: [],
      announcement2: [],
      msg1Count: '0',
      msg2Count: '0',
      msg1Title: '通知(0)',
      msg2Title: '',
      stopTimer: false,
      websock: null,
      lockReconnect: false, //避免重复连接
      heartCheck: null,
      formData: {},
      openPath: '',
    }
  },
  computed: {
    msgTotal() {
      return parseInt(this.msg1Count) + parseInt(this.msg2Count)
    },
  },
  mounted() {
    this.loadData()
    this.timerFun()
    this.initWebSocket()
    this.heartCheckFun()
  },
  destroyed: function () {
    // 离开页面生命周期函数
    this.websocketOnclose()
  },
  methods: {
    timerFun() {
      this.stopTimer = false
      let myTimer = setInterval(() => {
        // 停止定时器
        if (this.stopTimer == true) {
          clearInterval(myTimer)
          return
        }
        // debugger
        // this.loadData()
      }, 10000)
    },
    loadData() {
      try {
        // debugger
        // 获取系统消息
        getAction(this.url.listCementByUser)
          .then((res) => {
            if (res.success) {
              this.announcement1 = res.result.anntMsgList
              this.msg1Count = res.result.anntMsgTotal
              this.msg1Title = '通知(' + res.result.anntMsgTotal + ')'
              this.announcement2 = res.result.sysMsgList
              this.msg2Count = res.result.sysMsgTotal
              this.msg2Title = '系统消息(' + res.result.sysMsgTotal + ')'
            }
          })
          .catch((error) => {
            console.log('系统消息通知异常', error) //这行打印permissionName is undefined
            this.stopTimer = true
            console.log('清理timer')
          })
      } catch (err) {
        this.stopTimer = true
        console.log('通知异常', err)
      }
    },
    fetchNotice() {
      if (this.loadding) {
        this.loadding = false
        return
      }
      this.loadding = true
      setTimeout(() => {
        this.loadding = false
      }, 2000)
    },
    /**
     * 显示公告
     * @param {*} record
     */
    showAnnouncement(record) {
      putAction(this.url.editCementSend, { anntId: record.id }).then((res) => {
        if (res.success) {
          // debugger
          this.loadData()
        }
      })
      this.hovered = false
      if (record.openType === 'component') {
        this.openPath = record.openPage
        this.formData = { id: record.busId }
        this.$refs.showDynamNotice.detail(record.openPage)
      } else {
        this.$refs.ShowAnnouncement.detail(record)
      }
    },
    toMyAnnouncement() {
      this.$router.push({
        path: '/isps/userAnnouncement',
      })
    },
    modalFormOk() {},
    handleHoverChange(visible) {
      this.hovered = visible
    },
    /**
     * socket初始化
     */
    initWebSocket: function () {
      // WebSocket与普通的请求所用协议有所不同，ws等同于http，wss等同于https
      var userId = store.getters.userInfo.id
      var url =
        window._CONFIG['domianURL'].replace('https://', 'wss://').replace('http://', 'ws://') + '/websocket/' + userId
      console.log(url);
      this.websock = new WebSocket(url)
      this.websock.onopen = this.websocketOnopen
      this.websock.onerror = this.websocketOnerror
      this.websock.onmessage = this.websocketOnmessage
      this.websock.onclose = this.websocketOnclose
    },
    /**
     * WebSocket连接成功
     */
    websocketOnopen: function () {
      console.log('WebSocket连接成功')
      //心跳检测重置
      this.heartCheck.reset().start()
    },
    /**
     * WebSocket连接发生错误
     */
    websocketOnerror: function (e) {
      console.log('WebSocket连接发生错误')
      this.reconnect()
    },
    /**
     * 接收消息
     * @param {*} e
     */
    websocketOnmessage: function (e) {
      this.loadData()
      console.log('-----接收消息-------', e.data)
      this.openNotification(e.data)
      var data = eval('(' + e.data + ')') //解析对象
      // debugger
      if (data.cmd == 'topic') {
        //系统通知
        this.loadData()
      } else if (data.cmd == 'user') {
        //用户消息
        this.loadData()
      }
      //心跳检测重置
      this.heartCheck.reset().start()
    },
    /**
     * 关闭socket
     * @param {*} e
     */
    websocketOnclose: function (e) {
      console.log('connection closed (' + e + ')')
      if (e) {
        console.log('connection closed (' + e.code + ')')
      }
      this.reconnect()
    },
    /**
     * 数据发送
     * @param {*} text
     */
    websocketSend(text) {
      // 数据发送
      try {
        this.websock.send(text)
      } catch (err) {
        console.log('send failed (' + err.code + ')')
      }
    },
    /**
     * 消息弹窗
     * @param {*} data
     */
    openNotification(data) {
      var text = data.msgTxt
      const key = `open${Date.now()}`
      this.$notification.open({
        message: '消息提醒（收到返回心跳）',
        placement: 'bottomRight',
        description: text,
        key,
        btn: (h) => {
          return h(
            'a-button',
            {
              props: {
                type: 'primary',
                size: 'small',
              },
              on: {
                click: () => this.showDetail(key, data),
              },
            },
            '查看详情'
          )
        },
      })
    },
    /**
     * 重连
     */
    reconnect() {
      var that = this
      if (that.lockReconnect) return
      that.lockReconnect = true
      //没连接上会一直重连，设置延迟避免请求过多
      setTimeout(function () {
        console.info('尝试重连...')
        that.initWebSocket()
        that.lockReconnect = false
      }, 5000)
    },
    /**
     * 心跳检测
     */
    heartCheckFun() {
      var that = this
      //心跳检测,每20s心跳一次
      that.heartCheck = {
        timeout: 20000,
        timeoutObj: null,
        serverTimeoutObj: null,
        reset: function () {
          clearTimeout(this.timeoutObj)
          clearTimeout(this.serverTimeoutObj)
          return this
        },
        start: function () {
          var self = this
          this.timeoutObj = setTimeout(function () {
            //这里发送一个心跳，后端收到后，返回一个心跳消息，
            //onmessage拿到返回的心跳就说明连接正常
            that.websocketSend('HeartBeat')
            console.info('客户端发送心跳')
            self.serverTimeoutObj = setTimeout(function () {
              //如果超过一定时间还没重置，说明后端主动断开了
              that.websock.close() //如果onclose会执行reconnect，我们执行ws.close()就行了.如果直接执行reconnect 会触发onclose导致重连两次
            }, self.timeout)
          }, this.timeout)
        },
      }
    },
    /**
     * 获取信息详情
     * @param {*} key
     * @param {*} data
     */
    showDetail(key, data) {
      this.$notification.close(key)
      var id = data.msgId
      getAction(this.url.queryById, { id: id }).then((res) => {
        if (res.success) {
          var record = res.result
          this.showAnnouncement(record)
        }
      })
    },
  },
}
</script>

<style lang="css">
.header-notice-wrapper {
  top: 50px !important;
}
</style>
<style lang="less" scoped>
.header-notice {
  display: inline-block;
  transition: all 0.3s;

  span {
    vertical-align: initial;
  }
}
</style>