go-server

Golang 实现的基础服务

这是我在闲暇时间写的一些基础服务, 基本上大多数后端服务都需要用到的。

它用来帮助我快速开始一个项目，而不是重头开始写，浪费大量时间和精力。

想到哪里写哪里, 我会不断的完善它。

为什么不写成微服务形式，模块分离? 项目体量没有达到。

技术栈

• Web 框架 iris
• 数据库 Postgres
• 缓存 Redis
• 身份认证机制 JWT/oAuth2
• 数据库操作 GORM
• 消息队列 nsq
• RBAC 的鉴权模型
• Docker 一键启动应用

包含哪些模块?

如何使用?

首先搭建项目需要的依赖数据库/服务, 这里推荐使用 Docker。

在 docker 目录中提供了 2 个 配置文件，方便一键搭建。

然后获取构建好的可执行文件, 找到对应的平台，并且下载。或者自行构建。

你需要使用 5 个文件

1. message_queue_server

启用消息队列消费服务器，用于消费在队列里面的事物。

1. resource_server

静态文件服务器。用于静态文件的上传/下载/缩略图等

1. user_server

监听用户相关的接口服务

1. admin_server

监听管理员相关的接口服务

5。scheduled

定时任务

然后复制 .env 到可执行文件目录下，运行可执行文件即可。例如 ./user_server start

快速下载可执行文件

curl -fsSL https://raw.githubusercontent.com/axetroy/go-server/master/install.sh | bash -s v0.4.1

如何进行本地开发?

首选确保你安装有:

• Golang >= 1.11.x
• Docker
• Docker Compose

再根据以下命令运行

# 克隆项目
$ go get -v github.com/axetroy/go-server # 拉取项目

# 启用项目依赖(数据库，消息队列等)
$ cd $GOPATH/github/axetroy/go-server # 切换到项目目录
$ cd docker
$ ./start.sh

# 启动接口服务
$ cd $GOPATH/github/axetroy/go-server # 切换到项目目录
$ go run ./cmd/admin/main.go migrate # 同步数据库表
$ go run ./cmd/message_queue/main.go # 启动消息队列
$ go run ./cmd/user/main.go # 运行用户端的接口服务
$ go run ./cmd/admin/main.go # 运行管理员端的接口服务
$ go run ./cmd/resource/main.go # 运行资源类的接口服务
$ go run ./cmd/scheduled/main.go # 运行定时任务

可以通过 .env 文件进行配置

如何构建?

$ make build

在生成的 bin 目录下查找对应平台的可执行文件运行即可

如何测试?

make test

License

The MIT License