快速开始
安装Gframe
框架工具
执行gf -v
验证是否安装成功
创建项目模板
执行下面命令可以创建名为demo
的模板项目,参数-u
表示是否更新goframe
框架为最新版本
gf init demo -u
运行项目模板
gf run
是框架的动态编译命令,可以在代码变动并保存时自动编译。也可以使用go run
命令替代
cd demo & gf run main.go
浏览器访问
网址栏输入 127.0.0.1:8000/hello 访问api
接口文档地址 http://127.0.0.1:8000/swagger/
工程目录
目录结构
/ ├── api ├── hack ├── internal │ ├── cmd │ ├── consts │ ├── controller │ ├── dao │ ├── logic │ ├── model │ | ├── do │ │ └── entity │ └── service ├── manifest ├── resource ├── utility ├── go.mod └── main.go
重点关注的目录/文件:
目录/文件 | 说明 | 描述 |
---|---|---|
api | 对外接口 | 对外提供服务的输入/输出数据结构定义。 |
internal | 内部逻辑 | 业务逻辑存放目录。通过Golang internal 特性对外部隐藏可见性。 |
- cmd | 入口指令 | 命令行管理目录。可以管理维护多个命令行。 |
- controller | 接口处理 | 接收/解析用户输入参数的入口/接口层。 |
- dao | 数据访问 | 数据访问对象,用于获取数据库model对象进行CURD操作 |
- logic | 业务封装 | 对service中定义的接口进行具体实现 |
- service | 业务接口 | 定义业务逻辑的接口。 |
manifest | 交付清单 | 包含程序编译、部署、运行、配置的文件。 |
-- config | 配置管理 | 配置文件存放目录。 |
main.go | 入口文件 | 程序入口文件。 |
程序启动
程序入口为main.go
,该文件调用internal/cmd
包的Main
对象中的Run
命令引导程序启动。