albedo

README

Albedo: Gin Api Project Skeleton

基于 Gin 的 API 开发框架

使用的包

• web 框架：Gin
• db：gorm
• json 序列化库：json-iterator/go
• 配置管理：viper
• 日志记录：beego logger
• 命令行：cobra
• 平滑重启：endless
• Redis：go-redis/redis
• 任务调度：robfig/cron

辅助库/组件

• 包依赖管理：govendor
• Makefile：内置快速使用的命令

安装

$ cd $GOPATH/src/github.com/your_name

# 打开 [albedo-installer](https://gitee.com/zqhong/albedo-installer)，下载对应操作系统的安装器

# 以 macOS 系统为例，这里的项目名为 demo
$ chmod +x installer-darwin
$ ./installer-darwin -project-name=demo

$ cd demo

# 请确保 $GOPATH/bin 目录在环境变量 PATH 下
$ make install

# 修改配置文件 conf/config.yaml

# 测试
$ ./build/web
$ ./build/cli

# 如果启动失败，检查 runtime/albedo.log 日志文件

新建命令

# 新产生的文件在 cmd 目录下
# 重新编译 cli 之后，使用 ./build/albedo-cli 即可看到新命令的帮助提示
$ cobra add [command name]

Makefile 内置命令

# 同时编译 web 和 cli
$ make build

$ make build-web
$ make build-cli

$ make run-web
$ make -run-cli

$ make test

$ make clean

# 安装依赖
$ make deps

admin.sh 内置命令

$ bash admin.sh start

$ bash admin.sh stop

# 利用 endless 实现平滑重启
$ bash admin.sh restart

$ bash admin.sh status

目录结构

├── admin.sh                     # 进程管理脚本（start/stop/restart/status）
├── app                          # 进程启动 && 服务初始化代码
│   ├── boot.go                  # 进程启动代码
│   ├── config.go                # 配置服务初始化
│   ├── db.go                    # db 服务初始化
│   ├── gin.go                   # gin 服务初始化
│   ├── logger.go                # logger 服务初始化
├── build                        # 存放编译后的二进制文件
├── conf                         # 配置文件存储目录
│   ├── config.yaml              # 配置文件
├── cronjob                      # 任务调度相关
├── handler                      # MVC 架构中的 C
│   ├── handler.go
│   ├── sd                       # 健康检查handler
│   │   └── check.go
├── model                        # MVC 架构中的 M
├── pkg                          # 引用的包
├── router                       # 路由相关处理
├── runtime                      # 存放临时文件，如日志、pid 文件
├── util                         # 工具类函数存放目录
└── vendor                       # vendor目录用来管理依赖包

logger 的使用

参考：https://beego.me/docs/module/logs.md

缓存模块的使用

参考：https://beego.me/docs/module/cache.md

任务调度的使用

import (
	"github.com/robfig/cron"
	"fmt"
)

c := cron.New()

c.AddFunc("@hourly", func() {
    fmt.Println("hourly call")
})

c.Start()

待完成

• 添加测试
• 文档支持（Swagger）
• 多数据库驱动支持
• 进程级缓存（MemCache）
• 任务调度（crontab）

参考

• lexkong/apiserver
• chenhg5/morningo
• cg33/morningo-installer
• inhere/go-gin-skeleton