v2版本开始,项目的创建不再依赖远端获取,仓库模板已经通过资源管理的方式内置到了工具二进制文件中,因此项目创建速度非常迅速。

使用方式

  1. $ gf init -h
  2. USAGE
  3. gf init ARGUMENT [OPTION]
  4. ARGUMENT
  5. NAME name for the project. It will create a folder with NAME in current directory.The NAME will also be the
  6. module name for the project.
  7. OPTION
  8. -m, --mono initialize a mono-repo instead a single-repo
  9. -h, --help more information about this command
  10. EXAMPLE
  11. gf init my-project
  12. gf init my-mono-repo -m

我们可以使用init命令在当前目录生成一个示例的GoFrame空框架项目,并可给定项目名称参数。生成的项目目录结构仅供参考,根据业务项目具体情况可自行调整。生成的目录结构请参考 代码分层设计 章节。

GoFrame框架开发推荐统一使用官方的go module特性进行依赖包管理,因此空项目根目录下也有一个go.mod文件。

工程目录采用了通用化的设计,实际项目中可以根据项目需要适当增减模板给定的目录。例如,没有kubernetes部署需求的场景,直接删除对应deploy目录即可。

使用示例

在当前目录下初始化项目

  1. $ gf init .
  2. initializing...
  3. initialization done!
  4. you can now run 'gf run main.go' to start your journey, enjoy!

创建一个指定名称的项目

  1. $ gf init myapp
  2. initializing...
  3. initialization done!
  4. you can now run 'cd myapp && gf run main.go' to start your journey, enjoy!

创建一个MonoRepo项目

默认情况下创建的是SingleRepo项目,若有需要也可以创建一个MonoRepo(大仓)项目,通过使用-m选项即可。

  1. $ gf init mymono -m
  2. initializing...
  3. initialization done!

关于大仓的介绍请参考章节:微服务大仓管理模式