博客 / 詳情

返回

基於Go/Grpc/kubernetes/Istio開發微服務的最佳實踐嘗試 - 2/3

基於Go/Grpc/kubernetes/Istio開發微服務的最佳實踐嘗試 - 1/3

基於Go/Grpc/kubernetes/Istio開發微服務的最佳實踐嘗試 - 2/3

基於Go/Grpc/kubernetes/Istio開發微服務的最佳實踐嘗試 - 3/3

項目地址：https://github.com/janrs-io/Jgrpc

轉載請註明來源：https://janrs.com/ugj7

在上一部分中，我們創建了微服務的目錄結構並實現了微服務pongservice。

這部分我們繼續實現一個名為pingservice的微服務，訪問上一節已經部署好的pongservice微服務。

創建一個新的微服務非常簡單，只需複製之前創建的pongservice微服務，然後做一些小改動。

項目結構

這部分最終的目錄結構如下：

pingservice
├── buf.gen.yaml
├── cmd
│   ├── main.go
│   └── server
│       ├── grpc.go
│       ├── http.go
│       ├── run.go
│       ├── wire.go
│       └── wire_gen.go
├── config
│   ├── client.go
│   ├── config.go
│   └── config.yaml
├── genproto
│   └── v1
│       ├── gw
│       │   └── pingservice.pb.gw.go
│       ├── pingservice.pb.go
│       └── pingservice_grpc.pb.go
├── go.mod
├── go.sum
├── proto
│   ├── buf.lock
│   ├── buf.yaml
│   └── v1
│       ├── pingservice.proto
│       └── pingservice.yaml
└── service
    ├── client.go
    └── server.go

9 directories, 21 files

開始

複製

在 src 目錄下執行如下複製命令：

cp -R pongservice pingservice

刪除 wire_gen.go

刪除 pingservice/cmd/server 目錄中的 wire_gen.go 文件。

修改 go.mod module

修改go.mod文件的模塊，如下代碼所示：

module github.com/janrs-io/Jgrpc/src/pingservice

生成 proto

刪除pingservice/proto/v1目錄下的pongservice.proto和pongservice.yaml文件以及整個genproto文件夾。

然後重新創建pingservice.proto和pingservice.yaml文件，代碼如下：

pingservice.proto code:

syntax = "proto3";

package proto.v1;

option go_package = "github.com/janrs-io/Jgrpc/src/pingservice/genproto/v1";

service PingService {
  rpc Ping(PingRequest) returns(PingResponse){}
}

message PingRequest {
  string msg = 1 ;
}

message PingResponse {
  string msg = 1;
}

pingservice.yaml code:

type: google.api.Service
config_version: 3

http:
  rules:
    - selector: proto.v1.PingService.Ping
      get: /ping.v1.ping

修改 pingservice 目錄下的 buf.gen.yaml 文件。 修改後的完整代碼如下：

version: v1
plugins:
  - plugin: go
    out: genproto/v1
    opt:
      - paths=source_relative
  - plugin: go-grpc
    out: genproto/v1
    opt:
      - paths=source_relative
  - plugin: grpc-gateway
    out: genproto/v1/gw
    opt:
      - paths=source_relative
      - grpc_api_configuration=proto/v1/pingservice.yaml
      - standalone=true

在pingservice目錄下執行以下命令生成 proto 文件：

buf generate proto/v1

執行命令後，將重新生成genproto目錄，並自動創建*pb.go文件。

修改 import 路徑和所有代碼

檢查所有文件的導入，將導入路徑的pongservice修改為pingservice。

將所有代碼的Pong/pong改為Ping/ping，直到沒有錯誤為止。

修改 config.yaml

修改 config 目錄下的config.yaml文件。
將 grpc 的服務器端口更改為 50052，將 http 的服務器端口更改為 9002。
將 grpc 的服務名改為ping-grpc，將 http 的服務名改為ping-http。

修改後的完整代碼如下：

# grpc config
grpc:
  host: ""
  port: ":50052"
  name: "ping-grpc"

# http config
http:
  host: ""
  port: ":9002"
  name: "ping-http"

生成 generate inject

在 pingservice 目錄中執行以下 wire 命令以重新生成依賴注入文件：

wire ./...

引入 pongservier 服務的 go.mod

我們要在 pingservice 這個微服務中訪問 pongservice 的 grpc 服務，所以需要導入 pongservice 的 go.mod。

修改pingservice目錄下的go.mod文件，添加導入pongservice的代碼，如下：

module github.com/janrs-io/Jgrpc/src/pingservice

go 1.19

replace (
    pongservice => ../pongservice
)

require (
    pongservice v0.0.0
    github.com/google/wire v0.5.0
    github.com/grpc-ecosystem/grpc-gateway/v2 v2.15.2
    github.com/spf13/viper v1.15.0
    google.golang.org/grpc v1.54.0
    google.golang.org/protobuf v1.30.0
)

// the other required package...

修改 config.yaml

修改pingservice/config目錄下的config.yaml文件，添加如下代碼：

# service client
client:
  pong: ":50051"

修改後的完整代碼如下：

# grpc config
grpc:
  host: ""
  port: ":50052"
  name: "ping-grpc"

# http config
http:
  host: ""
  port: ":9002"
  name: "ping-http"

# service client
client:
  pong: ":50051"

生成 client.go

在pingservice/config目錄下生成client.go文件，添加如下代碼：

package config

// Client Client service config
type Client struct {
    Pong string `json:"pong" yaml:"pong"`
}

修改 config.go

在 Config 結構體中添加一個 Client 字段，代碼如下：

Client Client `json:"client" yaml:"client"`

修改後的完整代碼如下：

package config

import (
    "net/http"

    "github.com/spf13/viper"
    "google.golang.org/grpc"
)

// Config Service config
type Config struct {
    Grpc   Grpc   `json:"grpc" yaml:"grpc"`
    Http   Http   `json:"http" yaml:"http"`
    Client Client `json:"client" yaml:"client"`
}

// NewConfig Initial service's config
func NewConfig(cfg string) *Config {

    if cfg == "" {
        panic("load config file failed.config file can not be empty.")
    }

    viper.SetConfigFile(cfg)

    // Read config file
    if err := viper.ReadInConfig(); err != nil {
        panic("read config failed.[ERROR]=>" + err.Error())
    }
    conf := &Config{}
    // Assign the overloaded configuration to the global
    if err := viper.Unmarshal(conf); err != nil {
        panic("assign config failed.[ERROR]=>" + err.Error())
    }

    return conf

}

// Grpc Grpc server config
type Grpc struct {
    Host   string `json:"host" yaml:"host"`
    Port   string `json:"port" yaml:"port"`
    Name   string `json:"name" yaml:"name"`
    Server *grpc.Server
}

// Http Http server config
type Http struct {
    Host   string `json:"host" yaml:"host"`
    Port   string `json:"port" yaml:"port"`
    Name   string `json:"name" yaml:"name"`
    Server *http.Server
}

修改 client.go

修改pingservice/service目錄下的client.go文件，添加如下代碼：

// NewPongClient New pong service client
func NewPongClient(conf *config.Config) (pongclientv1.PongServiceClient, error) {

    ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
    defer cancel()

    conn, err := grpc.DialContext(ctx, conf.Client.Pong, grpc.WithTransportCredentials(insecure.NewCredentials()))
    if err != nil {
        fmt.Println("dial auth server failed.[ERROR]=>" + err.Error())
        return nil, err
    }
    client := pongclientv1.NewPongServiceClient(conn)
    return client, nil

}

修改後的完整代碼如下：

package service

import (
    "context"
    "fmt"
    "time"

    "google.golang.org/grpc"
    "google.golang.org/grpc/credentials/insecure"

    "github.com/janrs-io/Jgrpc/src/pingservice/config"
    v1 "github.com/janrs-io/Jgrpc/src/pingservice/genproto/v1"
    pongclientv1 "github.com/janrs-io/Jgrpc/src/pongservice/genproto/v1"
)

// NewClient New service's client
func NewClient(conf *config.Config) (v1.PingServiceClient, error) {

    serverAddress := conf.Grpc.Host + conf.Grpc.Port
    ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
    defer cancel()

    conn, err := grpc.DialContext(ctx, serverAddress, grpc.WithTransportCredentials(insecure.NewCredentials()))
    if err != nil {
        return nil, err
    }
    client := v1.NewPingServiceClient(conn)
    return client, nil

}

// NewPongClient New pong service client
func NewPongClient(conf *config.Config) (pongclientv1.PongServiceClient, error) {

    ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
    defer cancel()

    conn, err := grpc.DialContext(ctx, conf.Client.Pong, grpc.WithTransportCredentials(insecure.NewCredentials()))
    if err != nil {
        fmt.Println("dial auth server failed.[ERROR]=>" + err.Error())
        return nil, err
    }
    client := pongclientv1.NewPongServiceClient(conn)
    return client, nil

}

修改 server.go

修改pingservice/service目錄下的server.go文件，修改後的完整代碼如下：

package service

import (
    "context"
    "google.golang.org/grpc/grpclog"

    "github.com/janrs-io/Jgrpc/src/pingservice/config"
    v1 "github.com/janrs-io/Jgrpc/src/pingservice/genproto/v1"
    pongclientv1 "github.com/janrs-io/Jgrpc/src/pongservice/genproto/v1"
)

// Server Server struct
type Server struct {
    v1.UnimplementedPingServiceServer
    pingClient v1.PingServiceClient
    pongClient pongclientv1.PongServiceClient
    conf       *config.Config
}

// NewServer New service grpc server
func NewServer(
    conf *config.Config,
    pingClient v1.PingServiceClient,
    pongClient pongclientv1.PongServiceClient,
) v1.PingServiceServer {
    return &Server{
        pingClient: pingClient,
        pongClient: pongClient,
        conf:       conf,
    }
}

func (s *Server) Ping(ctx context.Context, req *v1.PingRequest) (*v1.PingResponse, error) {
    pongReq := &pongclientv1.PongRequest{Msg: "request from ping service"}
    pongResp, err := s.pongClient.Pong(ctx, pongReq)
    if err != nil {
        grpclog.Error("connect pong failed.[ERROR]=>" + err.Error())
        return nil, err
    }

    return &v1.PingResponse{
        Msg: "response ping msg:" + req.Msg + " and msg from pong service is: " + pongResp.Msg,
    }, nil
}

修改 wire.go

修改pingservice/cmd/server的wire.go文件，添加service.NewPongClient依賴注入。 代碼如下：

service.NewPongClient

修改後的完整代碼如下：

//go:build wireinject
// +build wireinject

package server

import (
    "github.com/google/wire"

    "github.com/janrs-io/Jgrpc/src/pingservice/config"
    v1 "github.com/janrs-io/Jgrpc/src/pingservice/genproto/v1"
    "github.com/janrs-io/Jgrpc/src/pingservice/service"
)

// InitServer Inject service's component
func InitServer(conf *config.Config) (v1.PingServiceServer, error) {

    wire.Build(
        service.NewPongClient,
        service.NewClient,
        service.NewServer,
    )

    return &service.Server{}, nil

}

在 pingservice 目錄下執行以下 wire 命令重新生成依賴注入文件：

如果出現 go.mod 引入錯誤，只需在 pingservice 目錄中再次運行 go mod tidy。 
wire ./...

啓動 service

分別在pongservice目錄和pingservice目錄下執行go run命令。

go run cmd/main.go

在瀏覽器中輸入以下請求地址：

127.0.01:9002/ping.v1.ping?msg=best practice

一切正確的情況下返回以下 json 數據：

{
    "msg": "response ping msg:best practice and msg from pong service is: response pong msg:request from ping service"
}

總結

這部分我們新建一個 pingservice 微服務，實現訪問 pongservice 的 grpc 服務。

相信通過這兩次創建微服務的簡單嘗試，你一定覺得基於Go和Grpc開發微服務並不難。

在下一部分中，我們將利用 Jenkins/Gitlab/Harbor 和 Kubernets/Istio 進行 devops 的 CICD 部署。

轉載請註明來源：https://janrs.com/ugj7
grpc , kubernetes , microservice , istio , go
user avatar venmos 頭像 guyan0319 頭像 shockerli 頭像 boywus 頭像 rancher 頭像 sdttttt 頭像 zhuoooo 頭像 mex 頭像
8 位用戶收藏了這個故事！

發佈 評論

Some HTML is okay.