goframe gf-cli的使用

目录

• 1.视频教程
• 2.官方文档
• 3.下载
  • linux系统安装环境
  • windows系统安装环境
• 4.创建项目
• 5.启动项目
• 6.交叉编译
• 7.gen命令的使用
• 8.orm的操作

https://www.bilibili.com/video/BV1YK4y1b7W8?p=1

2.官方文档

https://goframe.org/toolchain/cli

3.下载

工具开源项目地址：https://github.com/gogf/gf-cli

linux系统安装环境

aima@haima-PC:~/Desktop$ uname -a
Linux haima-PC 4.15.0-30deepin-generic #31 SMP Fri Nov 30 04:29:02 UTC 2018 x86_64 GNU/Linux
haima@haima-PC:~/Desktop$ lsb_release -a
No LSB modules are available.
Distributor ID:	Deepin
Description:	Deepin 15.11
Release:	15.11
Codename:	stable

打开下载连接页面

https://github.com/gogf/gf/releases

这里我选择gf_linux_amd64,大家根据自己的系统下载.

wget https://github.com/gogf/gf/releases/download/v2.1.0-rc4/gf_linux_amd64

root@haima-PC:/home/haima/opt$ wget https://github.com/gogf/gf/releases/download/v2.1.0-rc4/gf_linux_amd64 #下载
root@haima-PC:/home/haima/opt# ./gf_linux_amd64 install #执行安装命令
I found some installable paths for you(from $PATH): 
  Id | Writable | Installed | Path
   0 |     true |     false | /usr/local/sbin
   1 |     true |     false | /usr/local/bin
   2 |     true |     false | /usr/sbin
   3 |     true |     false | /usr/bin
   4 |     true |     false | /sbin
   5 |     true |     false | /bin
please choose one installation destination [default 1]: 1  #选择安装的位置,这里选择1
gf binary is successfully installed to: /usr/local/bin

haima@haima-PC:~/opt$ ll /usr/local/bin/
-rwxrwxrwx 1 root staff 18921081 6月   5 16:44 gf #已经在目标下生成gf工具


root@haima-PC:/home/haima/opt# gf -v #查看版本
GoFrame CLI Tool v2.1.0-rc4, https://goframe.org
GoFrame Version: cannot find go.mod
CLI Installed At: /usr/local/bin/gf
CLI Built Detail:
  Go Version:  go1.17.10
  GF Version:  v2.1.0-rc4
  Git Commit:  2022-06-01 16:36:40 0639becccc486fda179b81e7a685f67c91b173a4
  Build Time:  2022-06-01 16:34:52


root@haima-PC:/home/haima/opt# gf -h #查看帮助
root@haima-PC:/home/haima/opt# gf gen -h #查看gen帮助

windows系统安装环境

从 https://github.com/gogf/gf-cli 下载gf.exe

Windows (amd64): https://goframe.org/cli/windows_amd64/gf.exe

双击 gf.exe 安装 D:\Go\bin
选择go的安装目录,完成安装

D:\work\golang\src\test\goframe\gf_dome01>gf -v
GoFrame CLI Tool v1.14.4, https://goframe.org
Install Path: D:\Go\bin\gf.exe
Build Detail:
  Go Version:  go1.14
  GF Version:  v1.14.3
  Git Commit:  74adfde9bd047491e10872d96679c35c3879050c
  Build Time:  2020-11-25 19:22:34

建议创建项目的时候，把当前最新适配的 gf 工具也创建一份到当前的项目目录，避免后续工具升级后，新的工具操作项目造成代码不兼容，1.15、1.16在这个问题上吃了不少亏了。不管系统的 gf 工具是哪个版本，都可以使用项目里面保存的 gf 工具来操作这个项目，这样就不会乱了

4.创建项目

haima@haima-PC:/media/haima/34E401CC64DD0E28/site/go/src/haimait/learn/gf/gf-demos02$ gf init gf01 #在当前目录里创建项目名为gf01的项目
current folder is not empty, files might be overwrote, continue? [y/n]: y
initializing...
initialization done! 
you can now run 'gf run main.go' to start your journey, enjoy!

5.启动项目

haima@haima-PC:/media/haima/34E401CC64DD0E28/site/go/src/haimait/learn/gf/gf-demos02$ gf run main.go

些命令支持热编译（自动编译）

浏览器访问http://localhost:8199/已经可以正常输出

Hello World!

6.交叉编译

a.在config/config.toml文件里加入下面的编译配置信息

# 编译配置文件
[compiler]
     name     = "gf01" #编译后的文件名称
     version  = "1.0.0" #编译后的文件会生成到/bin/1.0.0目录里
     arch     = "386,amd64"
     system   = "linux,windows,darwin"
     output   = ""
     path     = "./bin"  #输出到bin目录
     extra    = "-ldflags \"-s -w\""
     # 自定义编译时内置变量
     [compiler.VarMap]
         author = "john"
         email  = "john@goframe.org"

b.执行编译命令

haima@haima-PC:/media/haima/34E401CC64DD0E28/site/go/src/haimait/learn/gf/gf-demos02$ gf build main.go
2020-06-04 06:41:12.542 start building...
2020-06-04 06:41:12.542 go build -o ./bin/1.0.0/darwin_386/gf01 -ldflags "-s -w" main.go
2020-06-04 06:41:38.765 go build -o ./bin/1.0.0/darwin_amd64/gf01 -ldflags "-s -w" main.go
2020-06-04 06:42:19.657 go build -o ./bin/1.0.0/linux_386/gf01 -ldflags "-s -w" main.go
2020-06-04 06:43:01.497 go build -o ./bin/1.0.0/linux_amd64/gf01 -ldflags "-s -w" main.go
2020-06-04 06:43:17.780 go build -o ./bin/1.0.0/windows_386/gf01.exe -ldflags "-s -w" main.go
2020-06-04 06:43:55.577 go build -o ./bin/1.0.0/windows_amd64/gf01.exe -ldflags "-s -w" main.go
2020-06-04 06:44:33.453 done!

c.打包好之后的文件

├── bin
│   └── 1.0.0
│       ├── darwin_386
│       │   └── gf01
│       ├── darwin_amd64
│       │   └── gf01
│       ├── linux_386
│       │   └── gf01
│       ├── linux_amd64
│       │   └── gf01
│       ├── windows_386
│       │   └── gf01.exe
│       └── windows_amd64
│           └── gf01.exe

d.运行编译后的文件

这里本人的系统是linux_amd64，

所以运行./bin/1.0.0/linux_amd64/gf01

haima@haima-PC:/media/haima/34E401CC64DD0E28/site/go/src/haimait/learn/gf/gf-demos02$ ./bin/1.0.0/linux_amd64/gf01 
2020-06-04 06:52:58.568 [DEBU] [ghttp] SetServerRoot path: /media/haima/34E401CC64DD0E28/site/go/src/haimait/learn/gf/gf-demos02/public

  SERVER  | DOMAIN  | ADDRESS | METHOD | ROUTE |         HANDLER          | MIDDLEWARE  
|---------|---------|---------|--------|-------|--------------------------|------------|
  default | default | :8199   | ALL    | /     | gf01/app/api/hello.Hello |             
|---------|---------|---------|--------|-------|--------------------------|------------|

2020-06-04 06:52:58.570 26600: http server started listening on [:8199]

浏览器访问http://localhost:8199/已经可以正常输出

Hello World!

7.gen命令的使用

gen命令用以自动化从数据库直接生成模型文件。

该命令将会根据数据表名(注意：所以要先在数据里建好表)生成对应的目录，该目录名称即数据表包名。目录下自动生成3个文件：

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

数据表模型生成支持的数据库类型为：MySQL/MariaDB、PostgreSQL、SQLite、SQLServer。目前暂不支持Oracle，若有需求请联系作者。

注意：所以要先在数据里建好表

操作步骤

a.新建表sys_users表

CREATE TABLE `sys_users` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `created_at` timestamp NULL DEFAULT NULL,
  `updated_at` timestamp NULL DEFAULT NULL,
  `deleted_at` timestamp NULL DEFAULT NULL,
  `uuid` varbinary(255) DEFAULT NULL,
  `user_name` varchar(255) DEFAULT NULL,
  `pass_word` varchar(255) DEFAULT NULL,
  `nick_name` varchar(255) DEFAULT 'QMPlusUser',
  `header_img` varchar(255) DEFAULT 'http://www.henrongyi.top/avatar/lufu.jpg',
  `authority_id` varchar(255) DEFAULT '888',
  `authority_name` varchar(255) DEFAULT NULL,
  `username` varchar(255) DEFAULT NULL,
  `password` varchar(255) DEFAULT NULL,
  `phone_data` varchar(255) DEFAULT NULL,
  `manager` varchar(255) DEFAULT NULL,
  `substation_sn` varchar(255) NOT NULL DEFAULT '' COMMENT '变电站sn',
  `power_supply_stations_sn` varchar(255) NOT NULL DEFAULT '' COMMENT '所属部门sn',
  `company_id` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '所属公司',
  PRIMARY KEY (`id`),
  KEY `idx_users_deleted_at` (`deleted_at`) USING BTREE,
  KEY `idx_sys_users_deleted_at` (`deleted_at`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=13 DEFAULT CHARSET=utf8;

CREATE TABLE `user` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT COMMENT 'User ID',
  `passport` varchar(45) NOT NULL COMMENT 'User Passport',
  `password` varchar(45) NOT NULL COMMENT 'User Password',
  `nickname` varchar(45) NOT NULL COMMENT 'User Nickname',
  `create_at` datetime DEFAULT NULL COMMENT 'Created Time',
  `update_at` datetime DEFAULT NULL COMMENT 'Updated Time',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;

CREATE TABLE `sys_category` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `created_at` timestamp NULL DEFAULT NULL,
  `updated_at` timestamp NULL DEFAULT NULL,
  `deleted_at` timestamp NULL DEFAULT NULL,
  `name` varchar(255) DEFAULT NULL COMMENT '所属公司',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=13 DEFAULT CHARSET=utf8;

b.重建配置
新建配置文件:

hack/config.yaml

# GoFrame CLI tool configuration.
gfcli:
  gen:
    dao:
    - link:            "mysql:root:123456@tcp(127.0.0.1:3306)/goframe_user_demo"
      tables:          "user"
      removePrefix:    "gf_"
      descriptionTag:  true
      noModelComment:  true

    - link:            "mysql:root:123456@tcp(127.0.0.1:3306)/goframe_user_demo"
      tables:          "sys_category"
      removePrefix:    "sys_"
      descriptionTag:  true
      noModelComment:  true

b.生成model

查看帮助命令:
gf gen dao -h

执行命令:
gf gen dao

/myapp$ gf gen dao
generated: internal/dao/user.go
generated: internal/dao/internal/user.go
generated: internal/model/do/user.go
generated: internal/model/entity/user.go
generated: internal/dao/category.go
generated: internal/dao/internal/category.go
generated: internal/model/do/category.go
generated: internal/model/entity/category.go
done!

命令说明
会
./app/model #在model生成的路径
-c config/config.toml #在这个配置里找database数据库连接配置 需要写好mysql的配置信息

config/config.toml文件

# Database.
[database]
    link  = "mysql:root:123456@tcp(127.0.0.1:3306)/gf01"
    debug = true
    # Database logger.
    [database.logger]
        Path   = "/tmp/log/gf-app/sql"
        Level  = "all"
        Stdout = true

-p sys_ #去除生成文件目录的sys前缀 如果不加这个参数就会按数据库名生成目录和文件名 如：sys_users
-t sys_users #要生成model的数据表文件名

实操：

haima@haima-PC:/media/haima/34E401CC64DD0E28/site/go/src/haimait/learn/gf/gf-demos02$ gf gen -h #查看帮助
haima@haima-PC:/media/haima/34E401CC64DD0E28/site/go/src/haimait/learn/gf/gf-demos02$ gf gen model ./app/model -c config/config.toml -p sys_ -t sys_users
path './app/model' is not empty, files might be overwrote, continue? [y/n]: y
2020-06-04 07:41:50.296 [DEBU] [  1 ms] SHOW FULL COLUMNS FROM `sys_users`
generated: ./app/model/users/users.go
generated: ./app/model/users/users_entity.go
generated: ./app/model/users/users_model.go
done!

此时 在./app/model目录里生成users文件

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

c.调用生成的users model

修改 app/api/hello/hello.go文件

// Hello is a demonstration route handler for output "Hello World!".
func Hello(r *ghttp.Request) {
    r.Response.Writeln("Hello World!")
    userInfo, err := users.FindOne("username = ?", "admin")
    if err !=nil {
        //glog.Error(err)
        fmt.Println(err)
        r.Response.Writefln("err")
        r.Exit()
    }
    r.Response.Writefln(userInfo.NickName)
}

运行 gf run main.go

浏览器访问http://localhost:8199/已经可以正常输出

Hello World!
超级管理员

8.orm的操作

package main

import (
    "fmt"
    "github.com/gogf/gf/frame/g"
    "p3/app/model/mytable"
)


func main() {
    // 查询所有数据
    result, err := mytable.FindAll()
    if err != nil {
        panic(err)
    }

    // 遍历数据
    for _, val := range result{
        fmt.Printf("id: %d  name:%s\n", val.Id, val.Name)
    }

    // 查询单条数据
    data, err := mytable.FindOne()
    if err != nil {
        panic(err)
    }
    fmt.Printf("id: %d  name:%s\n", data.Id, data.Name)


    // 条件查询, 查询name为王哈哈的
    dataList, err := mytable.FindAll(g.Map{
        "name": "王哈哈",
    })
    if err != nil {
        panic(err)
    }

    for _, val := range dataList {
        fmt.Printf("id: %d  name:%s\n", val.Id, val.Name)
    }

    // 查询数据总条数
    num, err := mytable.FindCount()
    if err != nil {
        panic(err)
    }
    fmt.Printf("共有 %d 条数据\n", num)


    // 插入数据
    _, err = mytable.Insert(g.Map{
        "name": "王哈哈",
    })

    if err != nil {
        panic(err)
    } else {
        fmt.Println("插入数据成功")
    }

    // 删除数据
    _, err  = mytable.Delete(g.Map{
        "id": 3,
    })
    if err != nil {
        panic(err)
    } else {
        fmt.Println("删除数据成功")
    }

    // 修改数据, 把id为8的name改为王大炮
    mytable.Update(g.Map{"name": "王大炮"}, "id", 8)

    // 修改多个字段, 把id为9的数据name改为小可爱，id改为10000
    mytable.Update(g.Map{"name": "小可爱", "id": 10000}, "id", 9)
}