webSocket实现多人聊天功能

webSocket实现多人在线聊天

主要思路如下：

1.使用vue构建简单的聊天室界面

2.基于nodeJs 的webSocket开启一个socket后台服务，前端使用H5的webSocket来创建一个socket对象来链接后端的socket服务

3.后端开启一个socket服务后,可以监听到客户端的链接，以及客户端发送过来的消息；也可以主动给客户端发送消息，例如：当有新的客户端连接的时候，服务端主动给所有连接的客户发消息，让所有人都知道有新的用户加入聊天室

4.前端new一个webSocket实例，去连接socket服务，然后客户端和服务端就可以实现双向通讯了，连接到后端服务之后，我们就可以向服务端发送消息了，并且也可以监听到服务端发送过来的消息。

5.双向通讯建立起来之后，可以根据功能需求来进行相应的代码逻辑

一、使用vue构建一个简单的项目，并开发一个简单的聊天页面

聊天页面代码,前端的主要逻辑都在这里 chating/index.vue

<template>
  <div class="chating">
    <div class="chating-wrap">
      <div class="title">聊天页面</div>
      <div class="chating-content">
        <div class="chating-body">
          <div class="chating-list">
            <ul class="chating-records">
              <div :key="index" v-for="(item, index) in chatingRecords">
                <li class="other" v-show="item.nickName != myNickName">
                  <img alt="用户头像" src="../../assets/logo.png" />
                  <div class="record-text-wrap">
                    <div class="nick-name">{{item.nickName}}</div>
                    <div class="record-text">{{item.message}}</div>
                  </div>
                </li>
                <li class="my" v-show="item.nickName == myNickName">
                  <div class="record-text-wrap">
                    <!-- <div class="nick-name">迷离</div> -->
                    <div class="record-text">{{item.message}}</div>
                  </div>
                  <img alt="用户头像" src="../../assets/logo.png" />
                </li>
              </div>
            </ul>
          </div>
          <div class="chating-btns">
            <input class="input-text" placeholder="请输入聊天内容" type="text" v-model="text" />
            <button @click="sendData" class="send">发送</button>
          </div>
        </div>
        <div class="chating-online-number">
          <div class="online-num">在线用户{{userList.length}}</div>
          <ul v-if="userList.length > 0">
            <li :key="index" class="user" v-for="(item, index) in userList">
              <img alt="用户头像" src="../../assets/logo.png" />
              <span>{{item.userName}}</span>
            </li>
          </ul>
          <button @click="loginOutHandler">退出群聊</button>
        </div>
      </div>
    </div>

    <div class="login" v-if="showLogin">
      <div class="opacity-wrap">
        <div>
          用户名：
          <input class="user-name" v-model="userName" />
        </div>
        <button @click="loginHandler" class="login-btn">登录</button>
      </div>
    </div>
  </div>
</template>

<script>
export default {
  data () {
    return {
      text: '',
      socketUrl: 'ws://localhost:8888?userName=', // socket服务地址
      client: null, // webSocket实例
      chatingRecords: [], // 聊天记录
      myNickName: '', // 是否是自己
      userName: '',
      showLogin: false,
      userList: []
    }
  },
  created () {
    console.log('created')
    // this.initChaing()
  },
  mounted () {
    console.log('mounted')
  },
  methods: {
    /* 初始化聊天，连接socket */
    initChaing () {
      let that = this
      if (window.WebSocket) {
        /* webSocket 连接服务器 */
        this.client = new WebSocket(this.socketUrl + this.myNickName)

        /* 监听客户端连接 */
        this.client.onopen = function (ev) {
          if (ev.type === 'open') {
            console.log('客户端连接socket服务')
          }
        }

        /* 监听服务端发送的消息 */
        this.client.onmessage = function (ev) {
          let data = JSON.parse(ev.data)
          /* 用户在线信息接收的是一个jsony数组 */
          if (data instanceof Array === true) {
            that.userList = data // 在线用户数量变化
          } else {
            /* 聊天信息接收的是一个json对象 */
            that.chatingRecords.push(data) // 在线用户聊天
          }
        }

        /* 监听服务端关闭 */
        this.client.onclose = function (ev) {
          console.log('socket服务已关闭')
          that.client = null // 客户端或者是服务端断开后，将webSocket实例清除
        }

        /* 监听服务端异常 */
        this.client.onerror = function () {
          if (!that.client) {
            console.log('socket服务连接失败')
          }
          that.loginOutHandler()
        }
      } else {
        alert('该浏览器不支持webSocket，请使用主流浏览器，如chrome')
      }
    },
    loginHandler () {
      this.myNickName = this.userName
      this.showLogin = false
      /* 登录成功后再连接服务，是为了连接服务的时候把用户信息发过去 */
      this.initChaing()
    },
    loginOutHandler () {
      this.client.close()
      this.client = null // 客户端或者是服务端断开后，将webSocket实例清除
      this.$router.push('/')
    },
    sendData () {
      if (!this.myNickName) {
        alert('请登录')
        this.showLogin = true
        return
      }

      let data = {
        nickName: this.myNickName,
        uid: new Date().getTime(),
        message: this.text,
        date: new Date()
      }
      if (this.client) {
        this.client.send(JSON.stringify(data))
        this.text = ''
      } else {
        console.log('socket服务连接失败,正在重新连接服务..')
        this.initChaing()
      }
    }
  },
  beforeDestroy () {
    this.client.close()
  }
}
</script>

<style lang="">
.login {
  width: 100vw;
  height: 100vh;
  position: fixed;
  top: 0;
  left: 0;
  background: rgba(0, 0, 0, 0.6);
  display: flex;
  justify-content: center;
  align-items: center;
}
.opacity-wrap {
  width: 500px;
  height: 300px;
  background: #fff;
  display: flex;
  justify-content: center;
  align-items: center;
  flex-direction: column;
}
.user-name {
  font-size: 16px;
  padding: 5px;
  text-indent: 10px;
}
.login-btn {
  font-size: 20px;
  background: cornflowerblue;
  color: 20px;
  margin-top: 30px;
  color: #fff;
  border: none;
  outline: none;
  padding: 10px 20px;
  border-radius: 10px;
}
ul {
  list-style: none;
  margin: 0;
  padding: 0;
}
.chating {
  max-width: 800px;
  border: 20px solid lightcyan;
  border-radius: 20px;
  margin: 0 auto 0;
}
.title {
  background: cornflowerblue;
  color: #fff;
  padding: 5px 0 5px;
}
.chating-content {
  width: 100%;
  display: flex;
  justify-content: space-between;
}
.chating-body {
  flex: 1;
  display: flex;
  flex-direction: column;
  justify-content: space-between;
  background: #f3f3f3;
}
.chating-list {
  flex: 1;
  border: 1px solid cornflowerblue;
}
.chating-records {
  padding: 10px;
  min-height: 300px;
  max-height: 600px;
  overflow-y: auto;
}
.chating-records li {
  margin-bottom: 20px;
}
.chating-records .other {
  display: flex;
  justify-content: start;
  align-items: flex-start;
}
.chating-records .my {
  display: flex;
  justify-content: flex-end;
  align-items: center;
}

.chating-records img {
  width: 36px;
  height: 36px;
  /* border-radius: 50%; */
  margin-right: 15px;
  background: purple;
}
.chating-records .my img {
  margin-right: 0;
  margin-left: 15px;
}
.chating-records .other .record-text-wrap {
  display: flex;
  flex-direction: column;
  align-items: flex-start;
}
.chating-records .my .record-text-wrap {
  display: flex;
  flex-direction: column;
  align-items: flex-end;
}
.nick-name {
  font-size: 14px;
  margin-bottom: 5px;
  color: #666;
}
.record-text {
  max-width: 260px;
  text-align: left;
  font-size: 14px;
  padding: 5px;
  background: #fff;
  border-radius: 5px;
}

.chating-btns {
  background: burlywood;
  padding: 10px;
  display: flex;
  align-items: center;
  justify-content: center;
}
.input-text {
  font-size: 16px;
  border: none;
  outline: none;
  padding: 5px 0 5px 5px;
}
.send {
  font-size: 16px;
  border: none;
  outline: none;
  padding: 4px 15px;
  margin-left: 20px;
}

.online-num {
  font-size: 12px;
  padding-bottom: 15px;
}
.chating-online-number {
  padding: 15px;
  height: 100%;
}
.chating-online-number ul {
  list-style: none;
  margin: 0;
  padding: 0;
  min-width: 120px;
  max-height: 580px;
  overflow-y: auto;
}
.user {
  display: flex;
  justify-content: space-between;
  align-content: center;
  line-height: 20px;
  font-size: 12px;
  border-bottom: 1px solid aqua;
  padding: 10px;
  margin-bottom: 5px;
}
.user img {
  width: 20px;
  height: 20px;
  border-radius: 50%;
  margin-right: 5px;
  background: palevioletred;
}
</style>

二、使用nodeJs搭建一个webSocket服务

webSocket.js文件

/* 首先在根目录下安装nodeJs的ws模块：npm install ws */

/* 引入nodejs的webSocket模块 */
var WebSocket = require('ws').Server
var moment = require('moment')

/* 创建一个webSocket实例 */
var wss = new WebSocket({
  url: 'localhost', // webSocket服务的ip
  port: 8888 // webSocket服务的端口
})

/* socketId */
var id = 0
var onlineMemberList = []
var defaultUser = 'user'

/* 监听客户端连接 */
wss.on('connection', function (ws, req) {
  id++
  ws.id = id // 给每个连接的客户端绑定一个id
  let reqUser = req.url.split('?')[1]
  let name = reqUser && reqUser.split('=')[1]
  let userName
  if (name) {
    /* 因为传过来的名字可能是中文的，这里需要解码，否则前端接收到的是一堆编码后的字符串 */
    userName = decodeURIComponent(name)
  } else {
    userName = defaultUser + id
  }
  var userInfo = {
    userName: userName,
    socketId: id,
    date: moment().format('MMMM Do YYYY, h:mm:ss a')
  }
  /* 当用户名一样的时候，表示重新登录 */
  for (var i = 0; i < onlineMemberList.length; i++) {
    if (userInfo.userName === onlineMemberList[i].userName) {
      onlineMemberList[i] = userInfo
      wss.clients.forEach(itemWs => {
        itemWs.send(JSON.stringify(onlineMemberList))
      })
      return
    }
  }

  onlineMemberList.push(userInfo)
  wss.clients.forEach(itemWs => {
    itemWs.send(JSON.stringify(onlineMemberList))
  })

  /* 监听客户端发过来的信息 */
  ws.on('message', function (data) {
    console.log(data)
    let newData = JSON.parse(data)
    newData.serveDate = moment().format('MMMM Do YYYY, h:mm:ss a')
    /* 给所有连接的客户端发送数据 */
    wss.clients.forEach(itemWs => {
      itemWs.send(JSON.stringify(newData))
    })

    /* 给最后一个连接的客户端发送数据 */
    // ws.send(JSON.stringify(newData))
  })

  /* 监听客户端关闭 */
  ws.on('close', function (ev) {
    console.log('客户端断开连接')
    /* 监听到用户断开连接后，将在线的重新广播给所有有人 */
    onlineMemberList = onlineMemberList.filter(item => {
      return item.socketId !== ws.id
    })

    wss.clients.forEach(itemWs => {
      itemWs.send(JSON.stringify(onlineMemberList))
    })
    console.log(onlineMemberList, 'onlineMemberList')
    console.log(ws.id, 'ws.id')
  })

  /* 监听客户端发生异常 */
  ws.on('error', function (ve) {
    console.log('客户端异常')
  })
})

console.log('webSocket服务已开启，端口为：8888')

为了方便管理代码，我把webSocket服务的代码放到了vue项目根目录下的socketServe文件夹下面，在启动vue项目之前先要来到这个文件夹里面开启socket服务，才能在聊天界面连接到服务器

github地址：https://github.com/yanhuomili/chatingGroup