1
2
3
4
5

mkdir -p ~/projects/gomall/hello_world
cd ~/projects/gomall/hello_world
go mod init gomall/hello_world
go get -u github.com/cloudwego/hertz
touch main.go

1
2

go mod tidy
go run main.go

1

GOPROXY=https://goproxy.cn/,direct go install github.com/cloudwego/cwgo@latest

1
2
3
4
5
6
7
8
9

# 打开 .bashrc 或 .zshrc 文件
vi ~/.zshrc

# 添加到文件末尾
export PATH=$PATH:~/go/bin
# 保存并关闭文件

# 立即生效
source ~/.zshrc

1
2
3
4
5

# 在 Zsh 中临时支持补全
cd
mkdir autocomplete # You can choose any location you like
cwgo completion zsh > ./autocomplete/zsh_autocomplete
source ./autocomplete/zsh_autocomplete

1

GOPROXY=https://goproxy.cn/,direct GO111MODULE=on go install github.com/cloudwego/thriftgo@latest

1
2
3

sudo apt-get update
sudo apt-get install protobuf-compiler
protoc --version

1
2
3

mkdir -p ~/projects/gomall/idl
cd ~/projects/gomall/idl
touch echo.thrift

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

namespace go api

struct Request {
    1: string message
}

struct Response {
    1: string message
}

service Echo {
    Response echo(1: Request req)
}

1
2
3
4

cd ~/projects/gomall
mkdir -p demo/demo_thrift
cd demo/demo_thrift
cwgo server --type RPC --module gomall/demo/demo_thrift --service demo_thrift --idl ../../idl/echo.thrift

1

return &api.Response{Message: req.Message},nil

1
2
3
4
5
6

go mod tidy
cd ~/projects/gomall
go work init
cd ~/projects/gomall/demo/demo_thrift
go work use .
go run .

1
2

cd ~/projects/gomall/idl
touch echo.proto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

syntax = "proto3";

package pbapi;

option go_package = "/pbapi";

message Request {
    string message = 1;
}
message Response {
    string message = 1;
}

service Echo {
    rpc Echo (Request) returns (Response) {}
}

1
2
3
4

cd ~/projects/gomall
mkdir -p demo/demo_proto
cd demo/demo_proto
cwgo server -I ../../idl --type RPC --module gomall/demo/demo_proto --service demo_proto --idl ../../idl/echo.proto

1

return &pbapi.Response{Message: req.Message},nil

1
2
3
4
5
6
7
8
9

go mod tidy
# 上面初始化过工作区的话此处不必重新初始化
# ---
cd ~/projects/gomall
go work init
cd ~/projects/gomall/demo/demo_proto
# ---
go work use .
go run .

1
2

cd ~/projects/gomall/demo/demo_proto
go get github.com/kitex-contrib/registry-consul

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

consul "github.com/kitex-contrib/registry-consul"

// 初始化console注册中心组件
r, err := consul.NewConsulRegister("127.0.0.1:8500")
if err != nil {
    log.Fatal(err)
}

// 设置服务启动参数
opts = append(opts, server.WithRegistry(r))

// klog

1
2
3
4
5

registry:
  registry_address:
    - 127.0.0.1:8500
  username: ""
  password: ""

1
2

cd ~/projects/gomall
touch docker-compose.yaml

1
2
3
4
5

services:
  consul:
    image: 'hashicorp/consul'
    ports:
      - 8500:8500

1

docker compose up -d

1
2

cd ~/projects/gomall/demo/demo_proto
go run .

1
2
3
4

cd ~/projects/gomall/demo/demo_proto
mkdir -p cmd/client
cd cmd/client 
touch client.go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

package main

import (
    "context"
    "fmt"
    "log"

    "gomall/demo/demo_proto/kitex_gen/pbapi"
    "gomall/demo/demo_proto/kitex_gen/pbapi/echo"

    "github.com/cloudwego/kitex/client"
    consul "github.com/kitex-contrib/registry-consul"
)

func main() {
    r, err := consul.NewConsulResolver("127.0.0.1:8500")
    if err != nil {
        log.Fatal(err)
    }
    client, err := echo.NewClient("demo_proto", client.WithResolver(r))
    if err != nil {
        log.Fatal(err)
    }
    res, err := client.Echo(context.TODO(), &pbapi.Request{Message: "hello"})
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("%v", res)
}

1

go run .

1
2
3

mysql:
  # dsn: "gorm:gorm@tcp(127.0.0.1:3306)/gorm?charset=utf8mb4&parseTime=True&loc=Local"
  dsn: "%s:%s@tcp(%s:3306)/%s?charset=utf8mb4&parseTime=True&loc=Local"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

func Init() {

	// 设置配置文件的读取：从系统环境变量中获取配置填充 dsn
	dsn := fmt.Sprintf(conf.GetConf().MySQL.DSN,
		os.Getenv("MYSQL_USER"),
		os.Getenv("MYSQL_PASSWORD"),
		os.Getenv("MYSQL_HOST"),
		os.Getenv("MYSQL_DATABASE"),
	)

	DB, err = gorm.Open(mysql.Open(dsn),
		...
	)
	...
}

1
2
3
4

MYSQL_USER=root
MYSQL_PASSWORD=wyatt123
MYSQL_HOST=localhost
MYSQL_DATABASE=demo_proto

1
2

cd ~/projects/gomall/demo/demo_proto
go get github.com/joho/godotenv

1
2
3
4
5
6
7

// 项目启动时加载 .env文件内容到系统环境中
err := godotenv.Load()
if err != nil {
    panic(err)
}
// 连接数据库
dal.Init()

1
2
3
4

func Init() {
	// redis.Init()
	mysql.Init()
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

services:
  ...
  mysql:
    # 实际使用时最好锁定版本号, latest不是一个最佳实践
    image: "mysql:latest"
    ports:
      - 3306:3306
    environment:
      # mysql镜像要求必须设置密码
      - MYSQL_ROOT_PASSWORD=wyatt123
      # 容器启动时初始化一个数据库demo_proto
      - MYSQL_DATABASE=demo_proto

1
2

cd ~/projects/gomall
docker compose up

1
2
3

cd ~/projects/gomall/demo/demo_proto
go mod tidy
go run .

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

type Version struct {
    Version string
}

var v Version

err = DB.Raw("select version() as version").Scan(&v).Error

if err != nil {
    panic(err)
}

fmt.Println("当前mysql版本为：" + v.Version)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

package model

import "gorm.io/gorm"

type User struct {
    gorm.Model
    Email    string `gorm:"uniqueIndex;type:varchar(128) not null"`
    Password string `gorm:"type:varchar(64) not null"`
}

// 指定表明为user，默认为users
func (User) TableName() string {
    return "user"
}

1

DB.AutoMigrate(&model.User{})

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

package main

func main() {
    // 加载 .env文件内容到系统环境中
    err := godotenv.Load()
    if err != nil {
        panic(err)
    }
    // 连接数据库
    dal.Init()

    // test CURD

    // 增
    mysql.DB.Create(&model.User{Email: "demo@example.com", Password: "*******"})

    // 改
    mysql.DB.Model(&model.User{}).Where("email = ?", "demo@example.com").Update("password", "123")

    // 查
    var row model.User
    mysql.DB.Model(&model.User{}).Where("email = ?", "demo@example.com").First(&row)
    fmt.Printf("row: %+v\n", row)

    // 软删
    mysql.DB.Where("email = ?", "demo@example.com").Delete(&model.User{})
    // 硬删
    mysql.DB.Unscoped().Where("email = ?", "demo@example.com").Delete(&model.User{})
}

1
2

cd ~/projects/gomall/demo/demo_proto/
go run cmd/dbop/db.go

1
2
3

"gopls": {
    "formatting.gofumpt": true
}

1
2
3
4
5

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

1
2
3
4
5
6
7
8
9

func (s *EchoService) Run(req *api.Request) (resp *api.Response, err error) {
    // GetRPCInfo：kitex提供的一个从 context上下文中获取rpc info 的方法
    info := rpcinfo.GetRPCInfo(s.ctx)

    // 打印客户端传来的service name
    fmt.Println(info.From().ServiceName())

    return &api.Response{Message: req.Message}, nil
}

1
2

cd ~/projects/gomall/demo/demo_thrift
go run .

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

package main

import (
	"context"
	"fmt"

	"gomall/demo/demo_thrift/kitex_gen/api"
	"gomall/demo/demo_thrift/kitex_gen/api/echo"

	"github.com/cloudwego/kitex/client"
	"github.com/cloudwego/kitex/pkg/rpcinfo"
	"github.com/cloudwego/kitex/pkg/transmeta"
	"github.com/cloudwego/kitex/transport"
)

func main() {
	cli, err := echo.NewClient("demo_thrift", client.WithHostPorts("localhost:8888"),
		client.WithMetaHandler(transmeta.ClientTTHeaderHandler),
		client.WithTransportProtocol(transport.TTHeader),
		client.WithClientBasicInfo(&rpcinfo.EndpointBasicInfo{
			ServiceName: "demo_thrift_client",
		}),
	)
	if err != nil {
		panic(err)
	}
	res, err := cli.Echo(context.Background(), &api.Request{
		Message: "hello",
	})
	if err != nil {
		fmt.Println("call failed:", err)
	}
	fmt.Printf("%v", res)
}

1
2

cd ~/projects/gomall/demo/demo_thrift
go run cmd/client/client.go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

func (s *EchoService) Run(req *pbapi.Request) (resp *pbapi.Response, err error) {
	clientName, ok := metainfo.GetPersistentValue(s.ctx, "CLIENT_NAME")
	fmt.Println(clientName, ok)

	if req.Message == "error" {
		return nil, kerrors.NewGRPCBizStatusError(1004001, "client param error")
	}

	return &pbapi.Response{Message: req.Message}, nil
}

1
2

cd ~/projects/gomall
docker compose up

1
2

cd ~/projects/gomall/demo/demo_proto
go run .

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

func main() {
	r, err := consul.NewConsulResolver(conf.GetConf().Registry.RegistryAddress[0])
	if err != nil {
		panic(err)
	}

	c, err := echo.NewClient("demo_proto", client.WithResolver(r),
		client.WithTransportProtocol(transport.GRPC),
		client.WithMetaHandler(transmeta.ClientHTTP2Handler),
	)
	if err != nil {
		panic(err)
	}

	// 用 metainfo 构造一个带元信息的上下文
	ctx := metainfo.WithPersistentValue(context.Background(), "CLIENT_NAME", "demo_proto_client")
	res, err := c.Echo(ctx, &pbapi.Request{Message: "hello"})
	if err != nil {
		klog.Fatal(err)
	}
	fmt.Printf("%v", res)
}

1
2

cd ~/projects/gomall/demo/demo_proto
go run cmd/client/client.go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

func (s *EchoService) Run(req *pbapi.Request) (resp *pbapi.Response, err error) {
	clientName, ok := metainfo.GetPersistentValue(s.ctx, "CLIENT_NAME")
	fmt.Println(clientName, ok)

	if req.Message == "error" {
		return nil, kerrors.NewGRPCBizStatusError(1004001, "client param error")
	}

	return &pbapi.Response{Message: req.Message}, nil
}

1
2

cd ~/projects/gomall/demo/demo_proto
go run .

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

func main() {
	r, err := consul.NewConsulResolver(conf.GetConf().Registry.RegistryAddress[0])
	if err != nil {
		panic(err)
	}

	c, err := echo.NewClient("demo_proto", client.WithResolver(r),
		client.WithTransportProtocol(transport.GRPC),
		client.WithMetaHandler(transmeta.ClientHTTP2Handler),
	)
	if err != nil {
		panic(err)
	}

	// 用 metainfo 构造一个带元信息的上下文
	ctx := metainfo.WithPersistentValue(context.Background(), "CLIENT_NAME", "demo_proto_client")
	res, err := c.Echo(ctx, &pbapi.Request{Message: "error"})

	var bizErr *kerrors.GRPCBizStatusError
	if err != nil {
		ok := errors.As(err, &bizErr)
		if ok {
			fmt.Printf("%#v", bizErr)
		}
		klog.Fatal(err)
	}

	fmt.Printf("%v", res)
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

package middleware

import (
    "context"
    "fmt"
    "time"

    "github.com/cloudwego/kitex/pkg/endpoint"
)

func Middleware(next endpoint.Endpoint) endpoint.Endpoint {
    return func(ctx context.Context, req, resp interface{}) (err error) {
        begin := time.Now()
        err = next(ctx, req, resp)
        fmt.Println(time.Since(begin))
        return err
    }
}

1
2
3
4
5
6
7
8
9

func kitexInit() (opts []server.Option) {
    // address
    addr, err := net.ResolveTCPAddr("tcp", conf.GetConf().Kitex.Address)
    if err != nil {
        panic(err)
    }
    opts = append(opts, server.WithServiceAddr(addr), server.WithMiddleware(middleware.Middleware))
    ...
}

1
2

cd ~/projects/gomall/demo/demo_proto
go run .

1
2
3
4
5

	c, err := echo.NewClient("demo_proto", client.WithResolver(r),
		client.WithTransportProtocol(transport.GRPC),
		client.WithMetaHandler(transmeta.ClientHTTP2Handler),
		client.WithMiddleware(middleware.Middleware),
	)

1
2

cd ~/projects/gomall/demo/demo_proto
go run cmd/client/client.go

1
2
3
4

// 注意此处改成3，其余代码参考官网即可
syntax = "proto3";

...

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

syntax = "proto3";

package frontend.home;

option go_package = "frontend/home";

import "api.proto";

message Empty {}

// service名字后面会用做生成的`biz/handler/home/home_service`
service HomeService {
   rpc Home(Empty) returns(Empty) {
      option (api.get) = "/";
   }
}

1
2
3
4
5

# cwgo 命令会在当前目录下生成代码
cd ~/projects/gomall/app/frontend
# -I ：指定 IDL 搜索路径
# module：指定 go mod 名
cwgo server --type HTTP --idl ../../idl/frontend/home.proto --service frontend -module gomall/app/frontend -I ../../idl

1

Hello

1
2
3

router.GeneratedRegister(h)
// 加载模板文件
h.LoadHTMLGlob("template/*")

1
2

// utils.SendSuccessResponse(ctx, c, consts.StatusOK, resp)
c.HTML(consts.StatusOK, "home.tmpl", resp)

1
2
3

cd ~/projects/gomall/app/frontend
go mod tidy
go run .

1
2
3
4
5
6
7
8
9

go install github.com/air-verse/air@latest

cd ~/projects/gomall/app/frontend

# 优先在当前路径查找 `.air.toml` 后缀的文件，如果没有找到，则使用默认的
air -c .air.toml

# 在这之后，只需执行 air 命令，无需额外参数，它就能使用 .air.toml 文件中的配置了。
air

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

<!doctype html>
<html lang="en">

    <head>
        <meta charset="utf-8">
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <title>Bootstrap demo</title>
        <link href="/static/css/bootstrap.min.css" rel="stylesheet"
              integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH" crossorigin="anonymous">
    </head>

    <body>
        <h1>Hello, world!</h1>
        <script src="/static/js/bootstrap.bundle.min.js"
                integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz"
                crossorigin="anonymous"></script>
    </body>
</html>

1
2
3
4
5

// 加载模板文件
h.LoadHTMLGlob("template/*")

// 加载静态目录
h.Static("/static", "./")

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

{{define "header"}}
<!doctype html>
<html lang="en">

<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>{{$.Title}} | Gomall</title>
    <link href="/static/css/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous">
    <script src="https://kit.fontawesome.com/ca4befac0f.js" crossorigin="anonymous"></script>
</head>

<body>

    <header>
        <nav class="navbar navbar-expand-lg bg-body-tertiary">
            <div class="container-fluid">
                <img class="navbar-brand" href="#" src="/static/img/logo.png" alt="gomall" style="height: 2.5em;"></a>
                <button class="navbar-toggler" type="button" data-bs-toggle="collapse"
                    data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent"
                    aria-expanded="false" aria-label="Toggle navigation">
                    <span class="navbar-toggler-icon"></span>
                </button>
                <div class="collapse navbar-collapse" id="navbarSupportedContent">
                    <ul class="navbar-nav me-auto mb-2 mb-lg-0">
                        <li class="nav-item">
                            <a class="nav-link active" aria-current="page" href="#">Home</a>
                        </li>
                        <li class="nav-item">
                            <a class="nav-link" href="#">Link</a>
                        </li>
                        <li class="nav-item dropdown">
                            <a class="nav-link dropdown-toggle" href="#" role="button" data-bs-toggle="dropdown"
                                aria-expanded="false">
                                Categories
                            </a>
                            <ul class="dropdown-menu">
                                <li><a class="dropdown-item" href="#">T-shirt</a></li>
                                <li><a class="dropdown-item" href="#">Sticker</a></li>
                            </ul>
                        </li>
                        <li class="nav-item">
                            <a class="nav-link">About</a>
                        </li>
                    </ul>
                    <form class="d-flex" role="search">
                        <input class="form-control me-2" type="search" placeholder="Search" aria-label="Search">
                        <button class="btn btn-outline-success" type="submit">Search</button>
                    </form>

                    <div class="ms-3">
                        <i class="fa-solid fa-cart-shopping fa-xl"></i>
                    </div>

                    <div class="ms-3">
                        <i class="fa-solid fa-user fa-xl"></i>
                    </div>
                    <div class="ms-3">
                        <button type="button" class="btn btn-primary">Sign in</button>
                    </div>
                </div>
            </div>
        </nav>
    </header>
    <main>
        <div class="container-fluid">
            {{end}}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

{{template "header" .}}

<div class="row">
    {{range .Items}}
    <div class="card col-xl-3 col-xl-4 col-md-6 col-sm-12 p-5 border-0">
        <img src="{{.Picture}}" class="card-img-top" alt="...">
        <div class="card-body">
            <p class="card-text">{{.Name}}</p>
            <h5 class="card-title">{{.Price}}</h5>
        </div>
    </div>
    {{end}}
</div>


{{template "footer" .}}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{{define "footer"}}
</div>
</main>
<footer>
    <p class="text-center py-5">&copy; 2025 Gomall </a> </p>
</footer>
<script src="/static/js/bootstrap.bundle.min.js" crossorigin="anonymous"></script>

</body>

</html>
{{end}}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

func (h *HomeService) Run(req *home.Empty) (map[string]any, error) {
	//defer func() {
	// hlog.CtxInfof(h.Context, "req = %+v", req)
	// hlog.CtxInfof(h.Context, "resp = %+v", resp)
	//}()
	resp := make(map[string]any)
	items := []map[string]any{
		{"Name": "T-shirt1", "Price": 100, "Picture": "/static/img/t-shirt.jpg"},
		{"Name": "T-shirt2", "Price": 200, "Picture": "/static/img/t-shirt.jpg"},
		{"Name": "T-shirt3", "Price": 300, "Picture": "/static/img/t-shirt.jpg"},
	}
	resp["Title"] = "Hot Sales"
	resp["Items"] = items
	return resp, nil
}

1
2

// var resp *home.Empty
resp, err := service.NewHomeService(ctx, c).Run(&req)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

syntax = "proto3";

package user;

option go_package = "/user";

message RegisterReq {
    string email = 1;
    string password = 2;
    string password_confirm = 3;
}

message RegisterResp {
    int32 user_id = 1;
}

message LoginReq {
    string email = 1;
    string password = 2;
}
message LoginResp {
    int32 user_id = 1;
}
service UserService {
    rpc Register(RegisterReq) returns(RegisterResp) {}
    rpc Login(LoginReq) returns(LoginResp) {}
}

1
2
3
4

cd ~/projects/gomall
mkdir -p app/user
cd app/user
cwgo server --type RPC --service user --module gomall/app/user -I ../../idl --idl user.proto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

func Init() {
	dsn := fmt.Sprintf(conf.GetConf().MySQL.DSN, os.Getenv("MYSQL_USER"), os.Getenv("MYSQL_PASSWORD"), os.Getenv("MYSQL_HOST"), os.Getenv("MYSQL_DATABASE"))
	DB, err = gorm.Open(mysql.Open(dsn),
		&gorm.Config{
			PrepareStmt:            true,
			SkipDefaultTransaction: true,
		},
	)
	err := DB.AutoMigrate(&model.User{})
	if err != nil {
		panic(err)
	}
}

1
2

mysql:
  dsn: "%s:%s@tcp(%s:3306)/%s?charset=utf8mb4&parseTime=True&loc=Local"

1
2
3
4

MYSQL_USER=root
MYSQL_PASSWORD=wyatt123
MYSQL_HOST=localhost
MYSQL_DATABASE=user_service

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

func main() {
    // 引入godotenv加载环境配置文件
    err := godotenv.Load()
    if err != nil {
        klog.Error(err.Error())
    }
    
    // 初始化数据库连接
    dal.Init()

    ...
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

  mysql:
    # 实际使用时最好锁定版本号, latest不是一个最佳实践
    image: "mysql:latest"
    ports:
      - 3306:3306
    environment:
      # mysql镜像要求必须设置密码
      - MYSQL_ROOT_PASSWORD=wyatt123
      # 容器启动时初始化一个数据库user_service
      - MYSQL_DATABASE=user_service

1
2
3

# 下载`kitex`配置注册中心的`sdk`
cd ~/projects/gomall/app/user
go get github.com/kitex-contrib/registry-consul

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

consul "github.com/kitex-contrib/registry-consul"

// 初始化console注册中心组件 用户服务通过`ip`找到注册中心去注册本服务
r, err := consul.NewConsulRegister(conf.GetConf().Registry.RegistryAddress[0])
if err != nil {
    log.Fatal(err)
}

// 设置服务启动参数
opts = append(opts, server.WithRegistry(r))

// klog

1
2
3
4
5
6
7
8
9

kitex:
  service: "user"
  address: ":8881"
  ...
registry:
  registry_address:
    - 127.0.0.1:8500
  username: ""
  password: ""

1
2
3
4
5
6
7

services:
  consul:
    # demo用的consul：1.15.4
    image: 'hashicorp/consul'
    ports:
      - 8500:8500
...

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

package model

import "gorm.io/gorm"

type User struct {
    gorm.Model
    Email    string `gorm:"uniqueIndex;type:varchar(255) not null"`
    Password string `gorm:"type:varchar(255) not null"`
}

func (User) TableName() string {
    return "user"
}

func Create(db *gorm.DB, user *User) error {
    return db.Create(user).Error
}

func GetByEmail(db *gorm.DB, email string) (*User, error) {
    var user User
    err := db.Where("email = ?", email).First(&user).Error
    return &user, err
}

1
2

# 下载密码库 用于加密密码
go get golang.org/x/crypto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

func (s *RegisterService) Run(req *user.RegisterReq) (resp *user.RegisterResp, err error) {
    // Finish your business logic.

    if req.Email == "" || req.Password == "" || req.PasswordConfirm == "" {
        // 返回错误
        return nil, errors.New("邮箱或密码不能为空")
    }

    if req.Password != req.PasswordConfirm {
        // 返回错误
        return nil, errors.New("两次密码不一致")
    }

    // hash password
    passwordHashed, err := bcrypt.GenerateFromPassword([]byte(req.Password), bcrypt.DefaultCost)
    if err != nil {
        return nil, err
    }

    // 创建用户
    newUser := &model.User{
        Email:    req.Email,
        Password: string(passwordHashed),
    }
    // 写入数据库
    err = model.Create(mysql.DB, newUser)
    if err != nil {
        return nil, err
    }
    return &user.RegisterResp{UserId: string(rune(newUser.ID))}, nil
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

package service

import (
    "context"
    "testing"

    "gomall/app/user/biz/dal/mysql"
    user "gomall/app/user/kitex_gen/user"

    "github.com/joho/godotenv"
)

func TestRegister_Run(t *testing.T) {
    // init env
    godotenv.Load("../../.env")

    // init db
    mysql.Init()

    ctx := context.Background()
    s := NewRegisterService(ctx)

    // init req and assert value
    req := &user.RegisterReq{
        Email:           "demo1@mail.com",
        Password:        "123456",
        PasswordConfirm: "123456",
    }

    resp, err := s.Run(req)

    t.Logf("err: %v", err)
    t.Logf("resp: %v", resp)

    // todo: edit your unit test
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

func (s *LoginService) Run(req *user.LoginReq) (resp *user.LoginResp, err error) {
    // Finish your business logic.

    // 判断邮箱和密码是否为空
    if req.Email == "" || req.Password == "" {
        // 返回错误
        return nil, errors.New("邮箱或密码不能为空")
    }
    // 查询用户
    row, err := model.GetByEmail(mysql.DB, req.Email)
    if err != nil {
        return nil, err
    }
    // 验证密码
    err = bcrypt.CompareHashAndPassword([]byte(row.Password), []byte(req.Password))
    if err != nil {
        return nil, err
    }

    return &user.LoginResp{
        UserId: string(rune(row.ID)),
    }, nil
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

func TestLogin_Run(t *testing.T) {
    // init env
    godotenv.Load("../../.env")

    // init db
    mysql.Init()

    ctx := context.Background()
    s := NewLoginService(ctx)
    // init req and assert value

    req := &user.LoginReq{
        Email:    "demo1@mail.com",
        Password: "123456",
    }
    resp, err := s.Run(req)
    t.Logf("err: %v", err)
    t.Logf("resp: %v", resp)

    // todo: edit your unit test
}

1
2

cd ~/projects/gomall
docker compose up

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

cd ~/projects/gomall/app/user
go mod tidy
# 初始化过工作区的话此处不必重新初始化
# ---
cd ~/projects/gomall
go work init
cd ~/projects/gomall/app/user
# ---
go work use .
go run .

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

syntax = "proto3";

package product;

option go_package ="/product";

service ProductCatalogService {
	// 列出产品
    rpc ListProducts(ListProductsReq) returns (ListProductsResp) {} ;
    // 根据产品 ID 获取单个产品
    rpc GetProduct(GetProductReq) returns (GetProductResp) {};
    // 根据查询字符串进行产品搜索
    rpc SearchProducts (SearchProductsReq) returns (SearchProductsResp) {} ;
}

message ListProductsReq {
    int32 page = 1;
    int32 page_size = 2;
    string category_name = 3;
}

message Product {
    uint32 id = 1;
    string name = 2;
    string description = 3;
    string picture = 4;
    float price = 5;
	// repeated 关键字表示该字段可以包含多个 Product 消息
    repeated string categories = 6;
}

message ListProductsResp {
    repeated Product products = 1;
}

message GetProductReq {
    uint32 id = 1;
}

message GetProductResp {
    Product product = 1;
}

message SearchProductsReq {
    string query = 1;
}

message SearchProductsResp {
    repeated Product results = 1;
}

1
2
3
4

cd ~/projects/gomall
mkdir -p app/product
cd app/product
cwgo server --type RPC --service product --module gomall/app/product -I ../../idl --idl product.proto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

func Init() {
    dsn := fmt.Sprintf(conf.GetConf().MySQL.DSN, os.Getenv("MYSQL_USER"), os.Getenv("MYSQL_PASSWORD"), os.Getenv("MYSQL_HOST"), os.Getenv("MYSQL_DATABASE"))
    DB, err = gorm.Open(mysql.Open(dsn),
                        &gorm.Config{
                            PrepareStmt:            true,
                            SkipDefaultTransaction: true,
                        },
                       )
    if err != nil {
        panic(err)
    }
    // 非线上环境下，初始化数据库表结构和数据
    if os.Getenv("GO_ENV") != "online" {
        needDemoData := !DB.Migrator().HasTable(&model.Product{})
        DB.AutoMigrate( //nolint:errcheck
            &model.Product{},
            &model.Category{},
        )
        if needDemoData {
            DB.Exec("INSERT INTO `product_service`.`category` VALUES (1,'2023-12-06 15:05:06','2023-12-06 15:05:06','T-Shirt','T-Shirt'),(2,'2023-12-06 15:05:06','2023-12-06 15:05:06','Sticker','Sticker')")
            DB.Exec("INSERT INTO `product_service`.`product` VALUES ( 1, '2023-12-06 15:26:19', '2023-12-09 22:29:10', 'Notebook', 'The cloudwego notebook is a highly efficient and feature-rich notebook designed to meet all your note-taking needs. ', '/static/image/notebook.jpeg', 9.90 ), ( 2, '2023-12-06 15:26:19', '2023-12-09 22:29:10', 'Mouse-Pad', 'The cloudwego mouse pad is a premium-grade accessory designed to enhance your computer usage experience. ', '/static/image/mouse-pad.jpeg', 8.80 ), ( 3, '2023-12-06 15:26:19', '2023-12-09 22:31:20', 'T-Shirt', 'The cloudwego t-shirt is a stylish and comfortable clothing item that allows you to showcase your fashion sense while enjoying maximum comfort.', '/static/image/t-shirt.jpeg', 6.60 ), ( 4, '2023-12-06 15:26:19', '2023-12-09 22:31:20', 'T-Shirt', 'The cloudwego t-shirt is a stylish and comfortable clothing item that allows you to showcase your fashion sense while enjoying maximum comfort.', '/static/image/t-shirt-1.jpeg', 2.20 ), ( 5, '2023-12-06 15:26:19', '2023-12-09 22:32:35', 'Sweatshirt', 'The cloudwego Sweatshirt is a cozy and fashionable garment that provides warmth and style during colder weather.', '/static/image/sweatshirt.jpeg', 1.10 ), ( 6, '2023-12-06 15:26:19', '2023-12-09 22:31:20', 'T-Shirt', 'The cloudwego t-shirt is a stylish and comfortable clothing item that allows you to showcase your fashion sense while enjoying maximum comfort.', '/static/image/t-shirt-2.jpeg', 1.80 ), ( 7, '2023-12-06 15:26:19', '2023-12-09 22:31:20', 'mascot', 'The cloudwego mascot is a charming and captivating representation of the brand, designed to bring joy and a playful spirit to any environment.', '/static/image/logo.jpg', 4.80 )")
            DB.Exec("INSERT INTO `product_service`.`product_category` (product_id,category_id) VALUES ( 1, 2 ), ( 2, 2 ), ( 3, 1 ), ( 4, 1 ), ( 5, 1 ), ( 6, 1 ),( 7, 2 )")
        }
    }
}

1
2

mysql:
  dsn: "%s:%s@tcp(%s:3306)/%s?charset=utf8mb4&parseTime=True&loc=Local"

1
2
3
4

MYSQL_USER=root
MYSQL_PASSWORD=wyatt123
MYSQL_HOST=localhost
MYSQL_DATABASE=product_service

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

func main() {
    // 引入godotenv加载环境配置文件
    err := godotenv.Load()
    if err != nil {
        klog.Error(err.Error())
    }
    
    // 初始化数据库连接
    dal.Init()

    ...
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

  mysql:
    # 实际使用时最好锁定版本号, latest不是一个最佳实践
    image: "mysql:latest"
    ports:
      - 3306:3306
    environment:
      # mysql镜像要求必须设置密码
      - MYSQL_ROOT_PASSWORD=wyatt123
      # 容器启动时初始化数据库
      - MYSQL_DATABASE=product_service

1
2
3

# 下载`kitex`配置注册中心的`sdk`
cd ~/projects/gomall/app/product
go get github.com/kitex-contrib/registry-consul

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

consul "github.com/kitex-contrib/registry-consul"

// 初始化console注册中心组件 用户服务通过`ip`找到注册中心去注册本服务
r, err := consul.NewConsulRegister(conf.GetConf().Registry.RegistryAddress[0])
if err != nil {
    log.Fatal(err)
}

// 设置服务启动参数
opts = append(opts, server.WithRegistry(r))

// klog

1
2
3
4
5
6
7
8
9

kitex:
  service: "product"
  address: ":8882"
  ...
registry:
  registry_address:
    - 127.0.0.1:8500
  username: ""
  password: ""

1
2
3
4
5
6
7

services:
  consul:
    # demo用的consul：1.15.4
    image: 'hashicorp/consul'
    ports:
      - 8500:8500
...

1
2
3
4
5
6
7
8
9

package model

import "time"

type Base struct {
	ID        int `gorm:"primarykey"`
	CreatedAt time.Time
	UpdatedAt time.Time
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

package model

import (
	"context"

	"gorm.io/gorm"
)

type Product struct {
	Base
	Name        string  `json:"name"`
	Description string  `json:"description"`
	Picture     string  `json:"picture"`
	Price       float32 `json:"price"`

	Categories []Category `json:"categories" gorm:"many2many:product_category"`
}

func (p Product) TableName() string {
	return "product"
}

type ProductQuery struct {
	ctx context.Context
	db  *gorm.DB
}

func (p ProductQuery) GetById(productId int) (product Product, err error) {
	err = p.db.WithContext(p.ctx).Model(&Product{}).First(&product, productId).Error
	return
}

func (p ProductQuery) SearchProducts(q string) (products []*Product, err error) {
	err = p.db.WithContext(p.ctx).Model(&Product{}).Find(&products, "name like ? or description like ?",
		"%"+q+"%", "%"+q+"%",
	).Error
	return
}

// 用于创建 ProductQuery 实例
func NewProductQuery(ctx context.Context, db *gorm.DB) *ProductQuery {
	return &ProductQuery{
		ctx: ctx,
		db:  db,
	}
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

package model

import (
    "context"

    "gorm.io/gorm"
)

type Category struct {
    Base
    Name        string `json:"name"`
    Description string `json:"description"`

    Products []Product `json:"product" gorm:"many2many:product_category"`
}

func (c Category) TableName() string {
    return "category"
}

type CategoryQuery struct {
    ctx context.Context
    db  *gorm.DB
}

func (c CategoryQuery) GetProductsByCategoryName(name string) (categories []Category, err error) {
    err = c.db.WithContext(c.ctx).Model(&Category{}).Where(&Category{Name: name}).Preload("Products").Find(&categories).Error
    return
}

// 用于创建 CategoryQuery 实例
func NewCategoryQuery(ctx context.Context, db *gorm.DB) *CategoryQuery {
    return &CategoryQuery{
        ctx: ctx,
        db:  db,
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

func (s *GetProductService) Run(req *product.GetProductReq) (resp *product.GetProductResp, err error) {
	if req.Id == 0 {
		return nil, kerrors.NewGRPCBizStatusError(2004001, "product id is required")
	}
	productQuery := model.NewProductQuery(s.ctx, mysql.DB)

	p, err := productQuery.GetById(int(req.Id))
	if err != nil {
		return nil, err
	}

	return &product.GetProductResp{
		Product: &product.Product{
			Id:          uint32(p.ID),
			Picture:     p.Picture,
			Price:       p.Price,
			Description: p.Description,
			Name:        p.Name,
		},
	}, nil
}

1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

func (s *ListProductsService) Run(req *product.ListProductsReq) (resp *product.ListProductsResp, err error) {
	// Finish your business logic.
	categoryQuery := model.NewCategoryQuery(s.ctx, mysql.DB)

	c, _ := categoryQuery.GetProductsByCategoryName(req.CategoryName)
	resp = &product.ListProductsResp{}
	for _, v1 := range c {
		for _, v := range v1.Products {
			resp.Products = append(resp.Products, &product.Product{
				Id:          uint32(v.ID),
				Name:        v.Name,
				Description: v.Description,
				Picture:     v.Picture,
				Price:       v.Price,
			})
		}
	}
	return resp, nil
}