我们推荐使用go.mod来管理项目依赖,这也是Golang官方推荐的包管理方式。

go.mod

https://github.com/gogf/gf-demos/blob/master/go.mod

  1. module github.com/gogf/gf-demos
  2. require github.com/gogf/gf latest
  3. go 1.12

其中注意module名称设置为github.com/gogf/gf-demos。这里我们只需要依赖GF框架即可。其中的go 1.12表示运行该项目所需的最低Go版本,这里也可以不设置。Goland会自动帮我们设置为当前使用的Go版本。

配置文件

GF框架的核心组件均实现了便捷的文件配置管理方式,包括Server、日志组件、数据库ORM、模板引擎等等,非常强大便捷。具体的配置项可以查看后续对应的章节介绍。GF框架大部分的核心组件配置项是不区分大小写的,但是为保证规范统一,我们建议在配置文件中统一使用小驼峰形式。

https://github.com/gogf/gf-demos/blob/master/config/config.example.toml

需要注意哦,仓库中提供的config.example.toml为配置文件示例,如果想要正常运行示例程序,你可以将其拷贝或者重命名为config.toml

配置文件中如果存在文件路径相关的配置,建议统一使用绝对路径配置,会少踩很多坑。如果使用了相对路径,你得清楚知道该配置的路径相对的是哪个路径(不同的部署方式,工作目录可能不可预知)。

  1. # HTTP Server.
  2. [server]
  3. address = ":8199"
  4. serverRoot = "public"
  5. serverAgent = "gf-demos"
  6. logPath = "/tmp/log/gf-demos/server"
  7. nameToUriType = 2
  8. routeOverWrite = true
  9. # Logger configurations.
  10. [logger]
  11. path = "/tmp/log/gf-demos"
  12. level = "all"
  13. stdout = true
  14. # Template view configurations.
  15. [viewer]
  16. path = "template"
  17. defaultFile = "index.html"
  18. # Database configurations.
  19. [database]
  20. link = "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
  21. debug = true
  22. # 数据库日志对象配置
  23. [database.logger]
  24. Path = "/tmp/log/gf-demos/sql"
  25. Level = "all"
  26. Stdout = true
  27. # GF-CLI工具配置
  28. [gfcli]
  29. # 自定义DAO生成配置(默认是读取database配置)
  30. [[gfcli.gen.dao]]
  31. link = "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
  32. tables = "user"

启动设置

boot包中执行代码层级的初始化,比如一些组件模块的设置。

https://github.com/gogf/gf-demos/blob/master/boot/boot.go

  1. package boot
  2. import (
  3. _ "github.com/gogf/gf-demos/packed"
  4. "github.com/gogf/gf/frame/g"
  5. "github.com/gogf/swagger"
  6. )
  7. // 用于应用初始化。
  8. func init() {
  9. s := g.Server()
  10. s.Plugin(&swagger.Swagger{})
  11. }

可以看到,我们的包初始化管理使用了包初始化方法init来做隐式初始化,这样做的好处是可以在boot目录中使用不同的go文件注册不同的init来分别实现不同的初始化配置管理,在业务比较复杂的项目中比较实用。

Content Menu