本项目服务端基于node.js技术,使用了koa框架,所有数据存储在mongodb中。客户端使用react框架,使用redux和immutable.js管理状态,APP端基于react-native和expo开发。本文需要对JavaScript较为熟悉,讲解核心功能点的设计思路。服务端架构服务端负责两件事:1.提供基于WebSocket的接口2.提供index.html响应服务端使用了koa-socket这个包,它集成了socket.io并实现了socket中间件机制,服务端基于该中间件机制,自己实现了一套接口路由每个接口都是一个async函数,函数名即接口名,同时也是socket事件名async login(ctx) { return ’login success’}然后写了个route中间件,用来完成路由匹配,当判断路由匹配时,以ctx对象作为参数执行路由方法,并将方法返回值作为接口返回值function noop() {}/** * 路由处理 * @param {IO} io koa socket io实例 * @param {Object} routes 路由 /module.exports = function (io, _io, routes) { Object.keys(routes).forEach((route) => { io.on(route, noop); // 注册事件 }); return async (ctx) => { // 判断路由是否存在 if (routes[ctx.event]) { const { event, data, socket } = ctx; // 执行路由并获取返回数据 ctx.res = await routes[ctx.event]({ event, // 事件名 data, // 请求数据 socket, // 用户socket实例 io, // koa-socket实例 _io, // socket.io实例 }); } };};还有一个重要catchError中间件是,它负责捕获全局异常,业务流程中大量使用assert判断业务逻辑,不满足条件时会中断流程并返回错误消息,catchError将捕获业务逻辑异常,并取出错误消息返回给客户端const assert = require(‘assert’);/* * 全局异常捕获 /module.exports = function () { return async (ctx, next) => { try { await next(); } catch (err) { if (err instanceof assert.AssertionError) { ctx.res = err.message; return; } ctx.res = Server Error: ${err.message}; console.error(‘Unhandled Error\n’, err); } };};这些就是服务端的核心逻辑,基于该架构下定义接口组成业务逻辑另外,服务端还负责提供index.html响应,即客户端首页。客户端的其他资源是放在CDN上的,这样可以缓解服务端带宽压力,但是index.html不能使用强缓存,因为会使得客户端更新不可控,因此index.html放在服务端客户端架构客户端使用socket.io-client连接服务端,连接成功后请求接口尝试登录,如果localStorage没有令牌或者接口返回令牌过期,将会以游客身份登录,登录成功会返回用户信息以及群组,好友列表,接着去请求各群组,好友的历史消息客户端需要监听connect / disconnect / message三个消息1.connect:socket连接成功2.disconnect socket连接断开3.message 接收到新消息客户端使用redux管理数据,需要被组件共享的数据放在redux中,只有自身使用的数据还是放在组件的state中,客户端存储的redux数据结构如下:用户用户信息_id用户id用户名用户名linkmans联系人列表,包括群组,好友以及临时会话isAdmin是否是管理员焦点当前聚焦的联系人id,既对话中的目标连接连接状态ui客户端UI相关和功能开关客户端的数据流,主要有两条线路1.用户操作=>请求接口=>返回数据=>更新redux =>视图重新渲染2.监听新消息=>处理数据=>更新redux =>视图重新渲染用户系统用户架构定义:const UserSchema = new Schema({ createTime: { type: Date, default: Date.now }, lastLoginTime: { type: Date, default: Date.now }, username: { type: String, trim: true, unique: true, match: /^([0-9a-zA-Z]{1,2}|[\u4e00-\u9eff]){1,8}$/, index: true, }, salt: String, password: String, avatar: { type: String, },});createTime:创建时间lastLoginTime:最后一次登录时间,用来清理僵尸号用username:用户昵称,同时也是账号salt:加密盐password:用户密码avatar:用户头像URL地址用户注册注册接口需要username/ password两个参数,首先做判空处理const { username, password} = ctx.data;assert(username, ‘用户名不能为空’);assert(password, ‘密码不能为空’);然后判断用户名是否已存在,同时获取默认群组,新注册用户要加入到默认群组const user = await User.findOne({ username });assert(!user, ‘该用户名已存在’);const defaultGroup = await Group.findOne({ isDefault: true });assert(defaultGroup, ‘默认群组不存在’);存密码明文肯定是不行的,生成随机盐,并使用盐加密密码const salt = await bcrypt.genSalt$(saltRounds);const hash = await bcrypt.hash$(password, salt);给用户一个随机默认头像,保存用户信息到数据库let newUser = null;try { newUser = await User.create({ username, salt, password: hash, avatar: getRandomAvatar(), });} catch (err) { if (err.name === ‘ValidationError’) { return ‘用户名包含不支持的字符或者长度超过限制’; } throw err;}将用户添加到默认群组,然后生成用户令牌令是用来免费码登录的凭证,存储在客户端localStorage,令牌里带带用户id,过期时间,客户端信息三个数据,用户id和过期时间容易理解,客户端信息是为了防止令牌盗用,之前也试过验证客户端ip一致性,但是ip可能会有经常改变的情况,搞得用户每次自动登录都被判定为盗用了……defaultGroup.members.push(newUser);await defaultGroup.save();const token = generateToken(newUser._id, environment);将用户id与当前 socket 连接关联, 服务端是以 ctx.socket.user 是否为 undefined 来判断登录态的 更新 Socket 表中当前 socket 连接信息, 后面获取在线用户会取 Socket 表数据ctx.socket.user = newUser._id;await Socket.update({ id: ctx.socket.id }, { user: newUser._id, os, // 客户端系统 browser, // 客户端浏览器 environment, // 客户端环境信息});最后将数据返回客户端return { _id: newUser._id, avatar: newUser.avatar, username: newUser.username, groups: [{ _id: defaultGroup._id, name: defaultGroup.name, avatar: defaultGroup.avatar, creator: defaultGroup.creator, createTime: defaultGroup.createTime, messages: [], }], friends: [], token,}用户登录fiora是不限制多登陆的,每个用户都可以在无限个终端登录登录有三种情况:游客登录令牌登录用户名/密码登录游客登录仅能查看默认群组消息,并且不能发消息,主要是为了降低第一次来的用户的体验成本令牌登录是最常用的,客户端首先从localStorage取令牌,令牌存在就会使用令牌登录首先对令牌解码取出负载数据,判断令牌是否过期以及客户端信息是否匹配let payload = null;try { payload = jwt.decode(token, config.jwtSecret);} catch (err) { return ‘非法token’;}assert(Date.now() < payload.expires, ’token已过期’);assert.equal(environment, payload.environment, ‘非法登录’);从数据库查找用户信息,更新最后登录时间,查找用户所在的群组,并将socket添加到该群组,然后查找用户的好友const user = await User.findOne({ _id: payload.user }, { _id: 1, avatar: 1, username: 1 });assert(user, ‘用户不存在’);user.lastLoginTime = Date.now();await user.save();const groups = await Group.find({ members: user }, { _id: 1, name: 1, avatar: 1, creator: 1, createTime: 1 });groups.forEach((group) => { ctx.socket.socket.join(group._id); return group;});const friends = await Friend .find({ from: user._id }) .populate(’to’, { avatar: 1, username: 1 });更新socket信息,与注册相同ctx.socket.user = user._id;await Socket.update({ id: ctx.socket.id }, { user: user._id, os, browser, environment,});最后返回数据用户名/密码与令牌登录仅一开始的逻辑不同,没有解码令牌验证数据这步先验证用户名是否存在,然后验证密码是否匹配const user = await User.findOne({ username });assert(user, ‘该用户不存在’);const isPasswordCorrect = bcrypt.compareSync(password, user.password);assert(isPasswordCorrect, ‘密码错误’);接下来逻辑就与令牌登录一致了消息系统发送消息sendMessage接口有三个参数:to:发送的对象,群组或者用户type:消息类型content:消息内容因为群聊和私聊共用这一个接口,所以首先需要判断是群聊还是私聊,获取群组id或者用户户ID,群聊/私聊通过参数区分群聊时到是相应的群组id,然后获取群组信息私聊时到是发送者和接收者二人id拼接的结果,去掉发送者id就得到了接收者id,然后获取接收者信息let groupId = ‘’;let userId = ‘’;if (isValid(to)) { const group = await Group.findOne({ _id: to }); assert(group, ‘群组不存在’);} else { userId = to.replace(ctx.socket.user, ‘’); assert(isValid(userId), ‘无效的用户ID’); const user = await User.findOne({ _id: userId }); assert(user, ‘用户不存在’);}部分消息类型需要做些处理,文本消息判断长度并做xss处理,邀请消息判断邀请的群组是否存在,然后将邀请人,群组id,群组名等信息存储到消息体中let messageContent = content;if (type === ’text’) { assert(messageContent.length <= 2048, ‘消息长度过长’); messageContent = xss(content);} else if (type === ‘invite’) { const group = await Group.findOne({ name: content }); assert(group, ‘目标群组不存在’); const user = await User.findOne({ _id: ctx.socket.user }); messageContent = JSON.stringify({ inviter: user.username, groupId: group._id, groupName: group.name, });}将新消息存入数据库let message;try { message = await Message.create({ from: ctx.socket.user, to, type, content: messageContent, });} catch (err) { throw err;}接下来构造一个不包含敏感信息的消息数据, 数据中包含发送者的id、用户名、头像, 其中用户名和头像是比较冗余的数据, 以后考虑会优化成只传一个id, 客户端维护用户信息, 通过id匹配出用户名和头像, 能节约很多流量 如果是群聊消息, 直接把消息推送到对应群组即可 私聊消息更复杂一些, 因为 fiora 是允许多登录的, 首先需要推送给接收者的所有在线 socket, 然后还要推送给自身的其余在线 socketconst user = await User.findOne({ _id: ctx.socket.user }, { username: 1, avatar: 1 });const messageData = { _id: message._id, createTime: message.createTime, from: user.toObject(), to, type, content: messageContent,};if (groupId) { ctx.socket.socket.to(groupId).emit(‘message’, messageData);} else { const sockets = await Socket.find({ user: userId }); sockets.forEach((socket) => { ctx._io.to(socket.id).emit(‘message’, messageData); }); const selfSockets = await Socket.find({ user: ctx.socket.user }); selfSockets.forEach((socket) => { if (socket.id !== ctx.socket.id) { ctx._io.to(socket.id).emit(‘message’, messageData); } });}最后把消息数据返回给客户端,表示消息发送成功。客户端为了优化用户体验,发送消息时会立即在页面上显示新信息,同时请求接口发送消息。如果消息发送失败,就删掉该条消息获取历史消息getLinkmanHistoryMessages接口有两个参数:linkmanId:联系人id,群组或者俩用户id拼接existCount:已有的消息个数详细逻辑比较简单,按创建时间倒序查找已有个数+每次获取个数数量的消息,然后去掉已有个数的消息再反转一下,就是按时间排序的新消息const messages = await Message .find( { to: linkmanId }, { type: 1, content: 1, from: 1, createTime: 1 }, { sort: { createTime: -1 }, limit: EachFetchMessagesCount + existCount }, ) .populate(‘from’, { username: 1, avatar: 1 });const result = messages.slice(existCount).reverse();返回给客户端接收推送消息客户端订阅消息事件接收新消息 socket.on(‘message’)接收到新消息时,先判断状态中是否存在该联系人,如果存在则将消息存到对应的联系人下,如果不存在则是一条临时会话的消息,构造一个临时联系人并获取历史消息,然后将临时联系人添加到州中。如果是来自自己其它终端的消息,则不需要创建联系人const state = store.getState();const isSelfMessage = message.from._id === state.getIn([‘user’, ‘_id’]);const linkman = state.getIn([‘user’, ’linkmans’]).find(l => l.get(’_id’) === message.to);let title = ‘’;if (linkman) { action.addLinkmanMessage(message.to, message); if (linkman.get(’type’) === ‘group’) { title = ${message.from.username} 在 ${linkman.get('name')} 对大家说:; } else { title = ${message.from.username} 对你说:; }} else { // 联系人不存在并且是自己发的消息, 不创建新联系人 if (isSelfMessage) { return; } const newLinkman = { _id: getFriendId( state.getIn([‘user’, ‘_id’]), message.from._id, ), type: ’temporary’, createTime: Date.now(), avatar: message.from.avatar, name: message.from.username, messages: [], unread: 1, }; action.addLinkman(newLinkman); title = ${message.from.username} 对你说:; fetch(‘getLinkmanHistoryMessages’, { linkmanId: newLinkman.id }).then(([err, res]) => { if (!err) { action.addLinkmanMessages(newLinkman.id, res); } });}如果当前聊天页是在后台的,并且打开了消息通知开关,则会弹出桌面提醒if (windowStatus === ‘blur’ && state.getIn([‘ui’, ’notificationSwitch’])) { notification( title, message.from.avatar, message.type === ’text’ ? message.content : [${message.type}], Math.random(), );}如果打开了声音开关,则响一声新消息提示音if (state.getIn([‘ui’, ‘soundSwitch’])) { const soundType = state.getIn([‘ui’, ‘sound’]); sound(soundType);}如果打开了语言播报开关并且是文本消息,将消息内的url和#过滤掉,排除长度大于200的消息,然后推送到消息朗读队列中if (message.type === ’text’ && state.getIn([‘ui’, ‘voiceSwitch’])) { const text = message.content .replace(/https?://(www.)?[-a-zA-Z0-9@:%.+~#=]{2,256}.[a-z]{2,6}\b([-a-zA-Z0-9@:%+.~#?&//=])/g, ‘’) .replace(/#/g, ‘’); // The maximum number of words is 200 if (text.length > 200) { return; } const from = linkman && linkman.get(’type’) === ‘group’ ? ${message.from.username}在${linkman.get('name')}说 : ${message.from.username}对你说; if (text) { voice.push(from !== prevFrom ? from + text : text, message.from.username); } prevFrom = from;}更多中间件限制未登录请求大多数接口是只允许已登录用户访问的,如果接口需要登录且socket连接没有用户信息,则返回“未登录”错误/** * 拦截未登录请求 /module.exports = function () { const noUseLoginEvent = { register: true, login: true, loginByToken: true, guest: true, getDefalutGroupHistoryMessages: true, getDefaultGroupOnlineMembers: true, }; return async (ctx, next) => { if (!noUseLoginEvent[ctx.event] && !ctx.socket.user) { ctx.res = ‘请登录后再试’; return; } await next(); };};限制调用频率为了防止刷接口的情况,减轻服务器压力,限制同一插座连接每分钟内最多请求30次接口const MaxCallPerMinutes = 30;/* * Limiting the frequency of interface calls */module.exports = function () { let callTimes = {}; setInterval(() => callTimes = {}, 60000); // Emptying every 60 seconds return async (ctx, next) => { const socketId = ctx.socket.id; const count = callTimes[socketId] || 0; if (count >= MaxCallPerMinutes) { return ctx.res = ‘接口调用频繁’; } callTimes[socketId] = count + 1; await next(); };};小黑屋管理员账号可以将用户添加到小黑屋,被添加到小黑屋的用户无法请求任何接口,10分钟后自动解禁/ / * Refusing to seal user requests */module.exports = function () { return async (ctx, next) => { const sealList = global.mdb.get(‘sealList’); if (ctx.socket.user && sealList.has(ctx.socket.user.toString())) { return ctx.res = ‘你已经被关进小黑屋中, 请反思后再试’; } await next(); };};其它表情表情是一张雪碧图,点击表情会向输入框插入格式为#(xx)的文本,例如#(滑稽)。在渲染消息时,通过正则匹配将这些文本替换为<img>,并计算出该表情在雪碧图中的位置,然后渲染到页面上不设置src会显示一个边框,需要将src设置为一张透明图function convertExpression(txt) { return txt.replace( /#(([\u4e00-\u9fa5a-z]+))/g, (r, e) => { const index = expressions.default.indexOf(e); if (index !== -1) { return class="expression-baidu" src="${transparentImage}" style="background-position: left ${-30 * index}px;" onerror="this.style.display='none'" alt="${r}">; } return r; }, );}表情包搜索的爬https://www.doutula.com上的搜…const res = await axios.get(https://www.doutula.com/search?keyword=${encodeURIComponent(keywords)});assert(res.status === 200, ‘搜索表情包失败, 请重试’);const images = res.data.match(/data-original="[^ “]+"/g) || [];return images.map(i => i.substring(15, i.length - 1));桌面消息通知效果如上图,不同系统/浏览器在样式上会有区别经常有人问到这个是怎么实现的,其实是HTML5增加的功能Notification粘贴发图监听paste事件,获取粘贴内容,如果包含Files类型内容,则读取内容并生成Image对象。注意:通过该方式拿到的图片,会比原图片体积大很多,因此最好压缩一下再使用@autobindhandlePaste(e) { const { items, types } = (e.clipboardData || e.originalEvent.clipboardData); // 如果包含文件内容 if (types.indexOf(‘Files’) > -1) { for (let index = 0; index < items.length; index++) { const item = items[index]; if (item.kind === ‘file’) { const file = item.getAsFile(); if (file) { const that = this; const reader = new FileReader(); reader.onloadend = function () { const image = new Image(); image.onload = () => { // 获取到 image 图片对象 }; image.src = this.result; }; reader.readAsDataURL(file); } } } e.preventDefault(); }}后话想把前端学好,js真的真的很重要!!!我的web前端学习q.u.n【731771211】,学习资源免费分享,五年资深前端攻城狮在线课堂讲解实战技术。欢迎新手,进阶点击:加入
...