首頁  >  文章  >  後端開發  >  從入門到精通:掌握go-zero框架

從入門到精通:掌握go-zero框架

WBOY
WBOY原創
2023-06-23 11:37:372199瀏覽

Go-zero是一款優秀的Go語言框架,它提供了一整套解決方案,包括RPC、快取、定時任務等功能。事實上,使用go-zero建立一個高效能的服務非常簡單,甚至可以在幾個小時內從入門到精通。

本文旨在介紹使用go-zero框架建立高效能服務的流程,並幫助讀者快速掌握框架的核心概念。

一、安裝和設定

在開始使用go-zero之前,我們需要安裝它並設定一些必要的環境。

1.安裝

安裝go-zero非常簡單,只需要執行以下命令:

$ go get -u github.com/tal-tech/go-zero

這將自動從GitHub下載最新版本的go-zero 。但要注意的是,建議使用Go 1.13以上的版本。

2.設定

在使用go-zero之前,我們需要為其配置一些必要的環境。具體來說,我們需要安裝goctl命令列工具,以便使用go-zero建立服務。

$ GO111MODULE=on go get -u github.com/tal-tech/go-zero/tools/goctl

3.建立工程

接著,我們需要使用goctl建立一個新專案。我們假設專案名為blog,可以透過以下指令建立:

$ mkdir blog
$ cd blog
$ go mod init blog
$ goctl api new blog

以上指令將建立一個新的API工程,並產生一些必要的檔案和目錄。

二、建立服務

接下來,我們可以使用go-zero建立一個新的服務。我們假設服務名字為user-service,可以透過以下步驟建立:

1.產生service

使用goctl產生user-service的service程式碼:

$ goctl api go -api user.api -dir .

上述指令將在目前目錄下產生一個user目錄,其中包含一個名為user.go的文件,該文件包含了user-service的service程式碼。

2.實作handler

我們還要實作具體的業務邏輯,也就是handler。

首先,我們需要在user目錄下建立一個名為handler的新目錄,並在其中建立一個名為userhandler.go的檔案。該文件將包含我們的handler程式碼。

userhandler.go程式碼如下:

package handler

import (
    "net/http"

    "github.com/tal-tech/go-zero/rest/httpx"
    "blog/service/user/api/internal/logic"
    "blog/service/user/api/internal/svc"
)

func userHandler(ctx *svc.ServiceContext) http.HandlerFunc {
    return func(w http.ResponseWriter, r *http.Request) {
        req, err := httpx.NewRequest(r)
        if err != nil {
            httpx.WriteError(w, err)
            return
        }

        l := logic.NewUserLogic(r.Context(), ctx)
        resp, err := l.GetUser(req)
        if err != nil {
            httpx.WriteError(w, err)
            return
        }

        httpx.WriteJson(w, resp)
    }
}

上面的程式碼使用了go-zero提供的rest/httpx套件,它提供了一些方便的函數,如NewRequest、WriteError和WriteJSON等,簡化了HTTP服務編寫流程。

3.註冊handler

現在我們需要將上述handler程式註冊到服務中。

在user.go檔案中的init方法中,加入以下程式碼:

func (s *Service) InitHandlers() {
    s.UserHandler = http.HandlerFunc(handler.UserHandler(s.Context))
}

上述程式碼將userHandler函數註冊為HTTP服務,我們可以透過在API檔案中定義路由來存取此服務。

三、建立範本

我們可以透過goctl create api產生一個新的go-zero API,這將自動建立一個包含一些初始化配置的資料夾。我們可以按照goctl的要求在其中加入自己的controller和service。

這裡我們建立一個模板應用程序,以便更好地學習閱讀go-zero的源代碼。該應用程式將包含一個CRUD範例,示範如何使用go-zero的常用功能。

1.產生模板

我們可以使用goctl產生一個模板應用程序,以便更好地學習go-zero的源代碼。

$ goctl api template -o app.go

上述命令將建立一個名為app.go的文件,其中包含模板應用程式的所有原始程式碼。

2.實作資料存取

我們假設使用MySQL進行資料儲存。在開始之前,需要安裝和設定MySQL。在此基礎上,我們可以使用go-zero提供的go-sql來建立資料庫存取層。

具體來說,我們可以使用goctl產生資料存取層程式碼:

$ goctl model mysql datasource "root:123456@tcp(127.0.0.1:3306)/test" -table user -dir .

上述指令將產生一個userModel.go文件,其中包含用於資料存取的使用者資料模型。

3.實作業務邏輯

接著,我們需要實作業務邏輯,並將其與資料存取層結合使用。具體來說,我們可以建立一個名為userLogic.go的文件,其中包含用於使用者管理的業務邏輯。

userLogic.go程式碼如下:

package logic

import (
    "context"
    "github.com/tal-tech/go-zero/core/logx"
    "github.com/tal-tech/go-zero/core/stores/sqlx"
    "blog/service/user/model"
    "blog/service/user/api/internal/svc"
    "blog/service/user/api/internal/types"
)

type UserLogic struct {
    ctx context.Context
    svcCtx *svc.ServiceContext
    logx.Logger
}

func NewUserLogic(ctx context.Context, svcCtx *svc.ServiceContext) UserLogic {
    return UserLogic{
        ctx: ctx,
        svcCtx: svcCtx,
        Logger: logx.WithContext(ctx),
    }
}

func (l *UserLogic) GetUser(req types.GetUserRequest) (*types.GetUserResponse, error) {
    //Todo
}

在上面的程式碼中,我們引入了sqlx, stores和logx包,其中sqlx是go-zero框架的一部分,專門用於資料庫操作。 stores是go-zero框架的資料儲存層。 logx套件是go-zero框架提供的日誌庫,它可以幫助我們記錄重要事件。

四、整合ETCD等

使用go-zero框架,我們可以輕鬆地整合一些常用的工具和服務,如ETCD、Redis、ZooKeeper等。具體來說,我們可以在程式碼中透過import導入go-zero提供的相關函式庫,並在設定檔中配置相關資訊。

以下是一些常用的整合方法:

1.整合ETCD

#首先,在設定檔中加入以下資訊:

[etcd]
host = "localhost:2379"

然後,在要使用ETCD的程式碼中,使用clientv3.New函數建立一個新的etcd客戶端。

import (
    "go.etcd.io/etcd/clientv3"
)

client, err := clientv3.New(clientv3.Config{
    Endpoints:   []string{"localhost:2379"},
    DialTimeout: 5 * time.Second,
})
if err != nil {
    panic(err)
}

上述程式碼將建立一個名為client的ETCD用戶端,該用戶端將使用localhost:2379作為ETCD伺服器的位址。

2.整合Redis

要使用Redis,我們需要在設定檔中加入以下資訊:

[redis]
host = "localhost:6379"
password = ""
db = 0

然後,在要使用Redis的程式碼中,使用redis. NewClient函數建立一個新的Redis客戶端。

import (
    "github.com/go-redis/redis"
)

client := redis.NewClient(&redis.Options{
    Addr:     "localhost:6379",
    Password: "", // no password set
    DB:       0,  // use default DB
})

上述程式碼將建立一個新的Redis用戶端,它將使用localhost:6379作為Redis伺服器位址,無密碼,使用預設DB。

3.整合ZooKeeper

要使用ZooKeeper,我们需要在配置文件中添加以下信息:

[zookeeper]
host = "localhost:2181"

然后,在要使用ZooKeeper的代码中,使用zk.Connect函数创建一个新的ZooKeeper客户端。

import (
    "github.com/samuel/go-zookeeper/zk"
    "time"
)

conn, _, err := zk.Connect([]string{"localhost:2181"}, time.Second*5)
if err != nil {
    panic(err)
}

上述代码将创建一个名为conn的ZooKeeper客户端,它将使用localhost:2181作为ZooKeeper服务器的地址。

五、总结

到目前为止,我们已经深入了解了go-zero框架,并学到了如何使用它来构建高性能服务。

总结一下,要使用go-zero,请先安装和配置相关环境,然后创建一个新的项目,通过goctl命令行工具自动生成模板代码和配置文件。

接着,可以使用go-zero提供的各种功能和服务来逐步完善和扩展我们的应用程序,如集成数据库、ETCD、Redis等。

将go-zero框架用于您的下一个项目吧,它将使您能够构建出更加灵活、高效和可靠的服务!

以上是從入門到精通:掌握go-zero框架的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn