【golang】iris项目示例，基于AJAX的简易聊天室

demo-chatroom

项目地址 https://github.com/JabinGP/demo-chatroom，对你有帮助的话请多多star

go+iris+jwt+mysql+gorm+viper，iris项目实战简易聊天室，登录、注册、私聊、群聊。

项目启动

git clone https://github.com/JabinGP/demo-chatroom.git
cd demo-chatroom
// 复制config.toml.example 为 config.toml 并填写数据库信息，或者可选修改端口号
go run demo-chatroom.go

默认为8888端口，启动后访问http://localhost:8888即可，或者访问演示地址http://mike.jabingp.cn:8888

前端

用了react，但是没用ui框架，很多的小细节上表现并不好，凑合着看吧，重点放在后端。

聊天框设置了窗口自动滚动到底端，但是api是react提供的，发现在许多浏览器上并不兼容，使用chrome浏览器可以解决这个问题。

注册后手动返回选择登陆，消息框里面的红色名称为公共发言，灰色名称为私聊发言、可以在红色的框里面指定接收者的名称，如果不指定的话，默认是公共发言，指定后只有对应的用户能看到信息。

蓝色框内显示自己的用户名，点击即直接退出登录。

后端

api格式基于restful设计，登录功能使用jwt完成，许多接口需要登录状态，请求的时候需要携带JWT，具体请看golang iris的jwt实践，另外便于测试，JWT签发有效时间只设置了20分钟，过期需要重新登录。

功能	请求方式	地址
获取登录token	POST	http://localhost:8888/v1/login
查找用户	GET	http://localhost:8888/v1/user
注册	POST	http://localhost:8888/v1/user
用户自己修改信息	PUT	http://localhost:8888/v1/user
用户发送信息	POST	http://localhost:8888/v1/message
用户获取信息	GET	http://localhost:8888/v1/message
用户获取token信息	GET	http://localhost:8888/v1/token/info

详细请求参数可以在demo-chatroom的postman-api文档里查看。

或者查看源码，请求参数在model/reqo里面查看，响应参数可以在model/reso里查看

前言

聊天功能AJAX不是最好的选择，WebSocket比较好，但是被要求使用了AJAX所以没有选择后者。

项目的前端比较简陋，因为只是作为demo使用。

英语不是很好，代码注释用英语只是因为懒得切换输入法。

第一次用go开发web项目，也是第一次用react写前端，由于前端没怎么注重项目结构（xjbx），就不放源码了，把项目编译后放在了assets文件夹下，可读性很差，但是可以和后端一起启动，不需要单独启动前端，比较方便查看效果。如果还有时间会考虑用原生写一个极简版的供大家参考原理。

第一次用ORM操作数据库，感觉好难用，我还是宁愿手写sql，好多想要的效果翻半天文档都找不到解决方案，后期有机会考虑用sqlx重构。

项目来源

最近对Go比较有兴趣，又接到任务编写一个简易聊天室，发现目前iris的项目实践比较少，只有一些HelloWorld级别的示例，于是决定用Go来做，然后开源出来供大互相参考借鉴，当然项目结构如何设计完全基于我有限的开发经验，对于不合理的地方，请给出你宝贵的意见。

项目要点

这个项目有如下要求

1. 基于AJAX
2. 前端页面需要无刷新（自动更新数据）
3. 登录功能
4. 注册功能（要求用户有用户名、密码、性别、年龄、兴趣爱好）

实现思路

登陆功能

登陆功能这次选用JWT来实现，JWT和Session各自的优劣就不再赘述。

基于AJAX，且无刷新

基于AJAX是所有前后端分离项目的必备，因此这个功能不过多讨论，这里重点在于无刷新，难点在哪？

用户操作需求

用户的操作逻辑是，在聊天室里面发送数据，然后数据就被发出去，聊天界面要显示出自己发送的数据，以及要实时更新别人发出来的数据。

前端的操作逻辑

前端和后端之间是通过AJAX来交流的，前端发送数据和后端发送数据可以表现为

• 发送数据：前端将需要发送的数据以JSON格式携带在请求里，请求对于结构
• 获取数据：前端请求后台获取消息的接口，获取最新消息

这里有什么问题？问就在前端永远只能主动发起请求，而后端永远只能接受请求。这意味着最新的消息永远无法实时地从后端主动发送给前端，最新的消息只能先存放在后端，然后等待前端发起请求，后端才能返回数据。

由于后端是没有能力主动推送消息给前端的，因此用户获取最新数据的解决方法是前端设置一个定时器每隔一段比较短的时间就请求一次后台接口（轮询），这样就能不断更新数据。

后端的操作逻辑

前端已经确定使用AJAX定时轮询后台接口来获取最新数据，为了数据实时性，轮询间隔会小于1s，这样又会带来另个问题，后端在如此频繁的请求下，一定不能每次都将所有数据都传输出去，一是数据大小导致的网路传输效率、流量成本问题，二是数据大小导致的前端判断新数据的效率问题，那么后端每次必须都返回前端还没有接收过的数据，而问题在于--后端怎么知道前端已经接收了哪些信息？

这个就要利用到消息的自增主键，只需要前端每次请求的时候都携带上前端已经接收的最后的消息的主键，由于主键是不重复且自增的，我们可以很轻松的找出比该主键大的数据，也就是前端还没接收到的数据。

项目技术栈

• 语言

  • Golang
  • HTML
  • CSS
  • JavaScript

• 框架

  • Iris 后端框架
  • React 前端框架
  • Gorm 数据库ORM框架
  • Viper 多类型配置文件读取支持

• 数据存储

  • Mysql 经典数据库

• 技术

  • JWT 签发登陆令牌
  • AJAX 异步请求后端数据

数据库设计结构

由于使用了Gorm数据库ORM框架，以下表都是自动生成的，自带了 xxxxxx_at字段

基于如上的需求，设计了users和messages两个表

users

关键字段

• id
• username
• passwd
• gender
• age
• interest

数据库表结构

Field	Type	Null	Key	Default	Extra
id	int(10) unsigned	NO	PRI	NULL	auto_increment
created_at	timestamp	YES		NULL
updated_at	timestamp	YES		NULL
deleted_at	timestamp	YES	MUL	NULL
username	varchar(255)	YES		NULL
passwd	varchar(255)	YES		NULL
gender	bigint(20)	YES		NULL
age	bigint(20)	YES		NULL
interest	varchar(255)	YES		NULL

messages

关键字段

• id
• sender_id -> 对应消息发送者
• receiver_id -> 对应消息接受者
• content
• send_time

数据库表结构

Field	Type	Null	Key	Default	Extra
id	int(10) unsigned	NO	PRI	NULL	auto_increment
created_at	timestamp	YES		NULL
updated_at	timestamp	YES		NULL
deleted_at	timestamp	YES	MUL	NULL
sender_id	int(10) unsigned	YES		NULL
receiver_id	int(10) unsigned	YES		NULL
content	varchar(255)	YES		NULL
send_time	timestamp	YES		NULL

项目结构

以下结构出于个人经验，有不当之处请给出宝贵意见

• route 路由层，负责将"xxxxxx"请求映射到对应的函数
• middleware 中间件层，可以在执行函数前后进行拦截并处理，如登陆拦截
• controller 控制层，存放与"xxxxxx"请求对应的函数，根据请求，调用业务层，并将数据进行格式封装返回
• service 业务层，调用持久层完成业务逻辑
• dao 持久层，可以理解为sql执行到函数执行的封装，由于使用了ORM，本项目没有dao层目录
• database 提供数据库连接

• model 定义一系列结构体

  • pojo 业务逻辑实体，如User，Message
  • reqo 请求数据实体，对应controller中的每个方法
  • reso 响应数据实体，对应controller中的每个方法
• config 读取配置，并提供单实例的配置文件实体供外访问
• tool 工具层
• assets 静态资源目录，存放静态资源（前端文件）

pojo、reqo、reso都是什么

• pojo

  很好理解，就是数据库对应的实体，但不要求与数据库字段一一对应

• reqo(request object)、reso(response object)

  不同接口请求的时候，可以携带的参数以及响应的数据也不同，所以为每一个接口设计一个对应的请求实体和响应实体

controller、service、dao到底有什么区别

以下为个人理解

• Controller

  主要职责是，接受请求的请求参数，转换为reqo，进行简单的请求参数验证（我个人的定义与数据库无关的验证，如非空、非零），调用Service层的函数获取pojo结果，并将pojo结果转换封装为reso返回。

• Service

  主要职责是，对Dao层的接口进一步封装，提供通用的接口给Controller调用，返回数据可以是pojo，在Service内需要进行数据的验证，如（新增用户，校验用户名是否重复）。

• Dao

  这里基本上一个方法直接对应一条sql语句，不做任何的验证，认为接收到的数据是可靠的（已经经过了Controller和Service两层的参数验证了），返回数据可以是pojo。

项目地址 https://github.com/JabinGP/demo-chatroom，对你有帮助的话请多多star