gf tool chain

    我们推荐通过下载安装预编译的二进制使用。工具安装成功后，可以通过gf或者gf -h查看所有支持的命令。复杂的命令可以通过gf help COMMAND或者gf COMMAND -h查看更详细的使用帮助信息，例如：gf help gen、gf gen -h。

    使用方式：./gf install

    该命令往往是在gf命令行工具下载到本地后执行（注意执行权限），用于将gf命令安装到系统环境变量默认支持的目录路径中，以便于在系统任何的地方直接可以使用gf工具。

    部分系统需要管理员权限支持。

    如果是MacOS下使用zsh的小伙伴可能会遇到别名冲突问题，可以通过alias gf=gf来解决。

    version 工具版本查看

    使用方式：

    • gf -i
    • gf version

    用以查看当前gf命令行工具编译时的版本信息。例如：

    init 项目初始化

    使用方式：gf init [NAME]

    我们可以使用init命令在当前目录生成一个示例的GF空框架项目，并可给定可选的项目名称参数。生成的项目目录结构仅供参考，根据业务项目具体情况可自行调整。

    使用方式：gf build FILE [OPTION]

    仅限于交叉编译使用到GF框架的项目，支持绝大部分常见系统的直接交叉编译。并且支持配置文件管理编译选项、嵌入编译时变量，默认嵌入的编译时变量包括（参考gf -v）：

    1. 当前Go版本。
    2. 当前编译时间。
    3. 当前Git Commit（如果存在）。

    编译配置文件选项示例（默认读取config.toml）：

    配置选项的释义同命令行同名选项。

    编译时的内置变量可以在运行时通过gbuild包获取。

    gen 代码生成命令

    使用方式：gf gen model [PATH] [OPTION]

    gen命令用以自动化从数据库直接生成模型文件。可以参考gf-demos示例项目中的模型文件即是通过该命令生成的：

    模型生成采用了Active Record设计模式。该命令将会根据数据表名生成对应的目录，该目录名称即数据表包名。目录下自动生成3个文件：

    1. 数据表名.go 自定义文件，开发者可以自由定义填充的代码文件，仅会生成一次，每一次模型生成不会覆盖。
    2. 数据表名_entity.go 表结构文件，根据数据表结构生成的结构体定义文件，包含字段注释。数据表在外部变更后，可使用gen命令重复生成更新该文件。
    3. 数据表名_model.go 表模型文件，为数据表提供了许多便捷的CURD操作方法，并可直接查询返回该表的结构体对象。数据表在外部变更后，可使用gen命令重复生成更新该文件。

    run 热编译（自动编译）

    使用方式：gf run FILE

    由于Go是不支持热编译特性的，每一次代码变更后都要重新手动停止、编译、运行代码文件。run命令也不是实现热编译功能，而是提供了自动编译功能，当开发者修改了项目中的go文件时，该命令将会自动编译当前程序，并停止原有程序，运行新版的程序。

    使用方式：gf get PACKAGE

    gf get命令和go get命令类似，内部自动提供了代理设置功能，并智能识别并设置最快的下载代理地址。

    docker 镜像编译

    使用方式：gf docker [FILE] [OPTIONS]

    自动编译并生成docker镜像。非必需FILE参数为编译文件路径，默认为main.go。非必需参数OPTIONS为docker build命令相同参数及选项。

    update 工具更新

    使用方式：gf update

    该命令用以检测gf命令行工具的版本，并自动执行版本更新。

    使用方式：gf pack SRC DST

    该命令用以将任意的文件打包为二进制文件，或者Go代码文件，可将任意文件打包后随着可执行文件一同发布。此外，在build命令中支持打包+编译一步进行，具体请查看build命令帮助信息。

    help 命令行帮助

    使用方式：

    • gf -h
    • gf -?

    任何不懂的，就用help看看吧。