keyauth

README

keyauth

用户中心

MongoDB

1. 如何连接MongoDB，以及MongoDB的配置
2. 基于MongoDB的CRUD
   • bson struct tag：用于MongoDB保存数据时，完成Object -> BSON的映射
   • "_id"：内置的bson tag，类似于MySQL中的主键 _:代表倒序索引 ， 不需要额外多创建一个Index，直接使用_id即可
   • 通过DB对象的Collection对象来进行数据的CRUD

架构图

项目说明

├── protocol                       # 脚手架功能: rpc / http 功能加载
│   ├── grpc.go
│   └── http.go
├── client                         # 脚手架功能: grpc 客户端实现
│   ├── client.go
│   └── config.go
├── cmd                            # 脚手架功能: 处理程序启停参数，加载系统配置文件
│   ├── root.go
│   └── start.go
├── conf                           # 脚手架功能: 配置文件加载
│   ├── config.go                  # 配置文件定义
│   ├── load.go                    # 不同的配置加载方式
│   └── log.go                     # 日志配置文件
├── dist                           # 脚手架功能: 构建产物
├── etc                            # 配置文件
│   ├── xxx.env
│   └── xxx.toml
├── apps                            # 具体业务场景的领域包
│   ├── all
│   │   |-- grpc.go                # 注册所有GRPC服务模块, 暴露给框架GRPC服务器加载, 注意 导入有先后顺序。
│   │   |-- http.go                # 注册所有HTTP服务模块, 暴露给框架HTTP服务器加载。
│   │   └── internal.go            #  注册所有内部服务模块, 无须对外暴露的服务, 用于内部依赖。
│   ├── book                       # 具体业务场景领域服务 book
│   │   ├── http                   # http
│   │   │    ├── book.go           # book 服务的http方法实现，请求参数处理、权限处理、数据响应等
│   │   │    └── http.go           # 领域模块内的 http 路由处理，向系统层注册http服务
│   │   ├── impl                   # rpc
│   │   │    ├── book.go          # book 服务的rpc方法实现，请求参数处理、权限处理、数据响应等
│   │   │    └── impl.go           # 领域模块内的 rpc 服务注册 ，向系统层注册rpc服务
│   │   ├──  pb                    # protobuf 定义
│   │   │     └── book.proto       # book proto 定义文件
│   │   ├── app.go                 # book app 只定义扩展
│   │   ├── book.pb.go             # protobuf 生成的文件
│   │   └── book_grpc.pb.go        # pb/book.proto 生成方法定义
├── version                        # 程序版本信息
│   └── version.go
├── README.md
├── main.go                        # Go程序唯一入口
├── Makefile                       # make 命令定义
└── go.mod                         # go mod 依赖定义

快速开发

make脚手架

➜  keyauth git:(master) ✗ make help
dep                            Get the dependencies
lint                           Lint Golang files
vet                            Run go vet
test                           Run unittests
test-coverage                  Run tests with coverage
build                          Local build
linux                          Linux build
run                            Run Server
clean                          Remove previous build
help                           Display this help screen

1. 使用安装依赖的Protobuf库(文件)

# 把依赖的probuf文件复制到/usr/local/include

# 创建protobuf文件目录
$ make -pv /usr/local/include/github.com/infraboard/mcube/pb

# 找到最新的mcube protobuf文件
$ ls `go env GOPATH`/pkg/mod/github.com/infraboard/

# 复制到/usr/local/include
$ cp -rf pb  /usr/local/include/github.com/infraboard/mcube/pb

1. 添加配置文件(默认读取位置: etc/keyauth.toml)

$ 编辑样例配置文件 etc/keyauth.toml.book
$ mv etc/keyauth.toml.book etc/keyauth.toml

1. 启动服务

# 创建protobuf存放目录
$ make pb
# 编译protobuf文件, 生成代码
$ make gen
# 如果是MySQL, 执行SQL语句(docs/schema/tables.sql)
$ make init
# 下载项目的依赖
$ make dep
# 运行程序
$ make run

相关文档