當(dāng)前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

基于Go/Grpc/kubernetes/Istio开发微服务的最佳实践尝试 - 1/3

發(fā)布時間：2023/10/11 编程问答 67 如意码农

生活随笔收集整理的這篇文章主要介紹了基于Go/Grpc/kubernetes/Istio开发微服务的最佳实践尝试 - 1/3 小編覺得挺不錯的,現(xiàn)在分享給大家,幫大家做個參考.

基于Go/Grpc/kubernetes/Istio開發(fā)微服務(wù)的最佳實踐嘗試 - 1/3

基于Go/Grpc/kubernetes/Istio開發(fā)微服務(wù)的最佳實踐嘗試 - 2/3

基于Go/Grpc/kubernetes/Istio開發(fā)微服務(wù)的最佳實踐嘗試 - 3/3

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

轉(zhuǎn)載請注明來源：https://janrs.com/br6f

Jgrpc

本項目為基于 Go/Grpc/kubernetes/Istio 開發(fā)微服務(wù)的最佳實踐提供參考。

并基于 Jenkins/Gitlab/Harbor 實現(xiàn)了CICD。

并使用 grpc-gateway 作為網(wǎng)關(guān)代理。

本最佳實踐分為三個部分：

創(chuàng)建一個 pingservice 的微服務(wù)
創(chuàng)建一個 pongservice 的微服務(wù)
基于Jenkins/Gitlab/Harbor 創(chuàng)建 CICD 部署流程并部署到 k8s/istio

在這一部分中，我們將創(chuàng)建 pongservice 微服務(wù)。

前提

假設(shè)已經(jīng)安裝了以下工具：

protoc-gen-grpc-gateway
protoc-gen-openapiv2
protoc-gen-go
protoc-gen-go-grpc
buf
wire

下面是安裝這些工具的教程地址：

protoc-gen-grpc-gateway & protoc-gen-openapiv2 & protoc-gen-go & protoc-gen-go-grpc

這四個工具的安裝教程請查看:install protoc-gen* tools

wire

wire 工具的安裝教程請查看:install wire tool

buf

buf 工具的安裝教程請查看:install buf tool

項目結(jié)構(gòu)

這部分最終的目錄結(jié)構(gòu)如下：

Jgrpc

├── devops

├── istio-manifests

├── kubernetes-manifests

└── src

    └── pongservice

        ├── buf.gen.yaml

        ├── cmd

        │   ├── main.go

        │   └── server

        │       ├── grpc.go

        │       ├── http.go

        │       ├── run.go

        │       ├── wire.go

        │       └── wire_gen.go

        ├── config

        │   ├── config.go

        │   └── config.yaml

        ├── genproto

        │   └── v1

        │       ├── gw

        │       │   └── pongservice.pb.gw.go

        │       ├── pongservice.pb.go

        │       └── pongservice_grpc.pb.go

        ├── go.mod

        ├── go.sum

        ├── proto

        │   ├── buf.lock

        │   ├── buf.yaml

        │   └── v1

        │       ├── pongservice.proto

        │       └── pongservice.yaml

        └── service

            ├── client.go

            └── server.go

14 directories, 20 files

開始

創(chuàng)建項目的整體目錄結(jié)構(gòu)如下：

Jgrpc

├── devops

├── istio-manifests

├── kubernetes-manifests

├── src

創(chuàng)建 pongservice 微服務(wù)

創(chuàng)建基本目錄

在src目錄下創(chuàng)建名為pongservice的微服務(wù)，目錄結(jié)構(gòu)如下：

pongservice

├── cmd

│   └── server

├── config

├── proto

│   └── v1

└── service

6 directories, 0 files

生成代碼和文件

生成 buf.yaml

在 pongservice/proto 目錄下執(zhí)行以下命令：

buf mod init

此命令創(chuàng)建一個名為 buf.yaml 的文件，位于 ponservice/proto 目錄中。

buf.yaml的代碼如下：

version: v1

breaking:

  use:

    - FILE

lint:

  use:

    - DEFAULT

在 version 和 breaking 之間添加如下依賴代碼：

deps:

  - buf.build/googleapis/googleapis

請查看添加此依賴代碼的原因:https://github.com/grpc-ecosystem/grpc-gateway#3-external-configuration

添加依賴代碼后完整的 buf.yaml 文件如下：

version: v1

deps:

  - buf.build/googleapis/googleapis

breaking:

  use:

    - FILE

lint:

  use:

    - DEFAULT

然后在pongservice/proto目錄下執(zhí)行如下命令：

buf mod update

執(zhí)行命令后會生成一個buf.lock文件，代碼如下：

# Generated by buf. DO NOT EDIT.

version: v1

deps:

  - remote: buf.build

    owner: googleapis

    repository: googleapis

    commit: 463926e7ee924d46ad0a726e1cf4eacd

生成 pongservice.proto

在 pongservice/proto/v1 目錄中使用以下代碼創(chuàng)建一個名為 pongservice.proto 的原型文件：

syntax = "proto3";

package proto.v1;

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

service PongService {

  rpc Pong(PongRequest) returns(PongResponse){}

}

message PongRequest {

  string msg = 1 ;

}

message PongResponse {

  string msg = 1;

}

生成 pongservice.yaml

在 pongservice/proto/v1 目錄中使用以下代碼創(chuàng)建一個名為 pongservice.yaml 的原型文件：

type: google.api.Service

config_version: 3

http:

  rules:

    - selector: proto.v1.PongService.Pong

      get: /pong.v1.pong

生成 buf.gen.yaml

在 pongservice 目錄中使用以下代碼創(chuàng)建一個名為 buf.gen.yaml 的 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/pongservice.yaml

      - standalone=true

在 pongservice 目錄中，執(zhí)行以下命令：

buf generate proto/v1

執(zhí)行命令后，會在pongservice目錄下自動創(chuàng)建一個genproto目錄，該目錄下有以下文件：

genproto

└── v1

    ├── gw

    │   └── ponservice.pb.gw.go

    ├── ponservice.pb.go

    └── ponservice_grpc.pb.go

2 directories, 3 files

生成 go.mod

在 pongservice 目錄中創(chuàng)建 go.mod：

go mod init github.com/janrs-io/Jgrpc/src/pongservice && go mod tidy

生成 config.yaml

在 pongservice/config 目錄下，創(chuàng)建 config.yaml 文件并添加以下代碼：

# grpc config

grpc:

  host: ""

  port: ":50051"

  name: "pong-grpc"

# http config

http:

  host: ""

  port: ":9001"

  name: "pong-http"

生成 config.go

在 pongservice/config 目錄下，創(chuàng)建 config.go 文件并添加以下代碼：

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"`

}

// 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

}

然后在 pongservice 目錄中再次運行 go mod tidy。

生成 client.go

在 pongservice/service 目錄下，創(chuàng)建 client.go 文件并添加以下代碼：

package service

import (

	"context"

	"time"

	"google.golang.org/grpc"

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

	"github.com/janrs-io/Jgrpc/src/pongservice/config"

	v1 "github.com/janrs-io/Jgrpc/src/pongservice/genproto/v1"

)

// NewClient New service's client

func NewClient(conf *config.Config) (v1.PongServiceClient, 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.NewPongServiceClient(conn)

	return client, nil

}

在 pongservice/service 目錄下，創(chuàng)建 server.go 文件并添加以下代碼：

package service

import (

	"context"

	"github.com/janrs-io/Jgrpc/src/pongservice/config"

	v1 "github.com/janrs-io/Jgrpc/src/pongservice/genproto/v1"

)

// Server Server struct

type Server struct {

	v1.UnimplementedPongServiceServer

	pongClient v1.PongServiceClient

	conf       *config.Config

}

// NewServer New service grpc server

func NewServer(conf *config.Config, pongClient v1.PongServiceClient) v1.PongServiceServer {

	return &Server{

		pongClient: pongClient,

		conf:       conf,

	}

}

func (s *Server) Pong(ctx context.Context, req *v1.PongRequest) (*v1.PongResponse, error) {

	return &v1.PongResponse{Msg: "response pong msg:" + req.Msg}, nil

}

生成 run server 文件

在pongservice/cmd/server目錄下，創(chuàng)建以下四個文件：

grpc.go
http.go
run.go
wire.go

將以下代碼添加到 grpc.go 文件中：

package server

import (

	"fmt"

	"log"

	"net"

	"google.golang.org/grpc"

	"github.com/janrs-io/Jgrpc/src/pongservice/config"

	v1 "github.com/janrs-io/Jgrpc/src/pongservice/genproto/v1"

)

// RunGrpcServer Run grpc server

func RunGrpcServer(server v1.PongServiceServer, conf *config.Config) {

	grpcServer := grpc.NewServer()

	v1.RegisterPongServiceServer(grpcServer, server)

	fmt.Println("Listening grpc server on port" + conf.Grpc.Port)

	listen, err := net.Listen("tcp", conf.Grpc.Port)

	if err != nil {

		panic("listen grpc tcp failed.[ERROR]=>" + err.Error())

	}

	go func() {

		if err = grpcServer.Serve(listen); err != nil {

			log.Fatal("grpc serve failed", err)

		}

	}()

	conf.Grpc.Server = grpcServer

}

將以下代碼添加到 http.go 文件中：

package server

import (

	"context"

	"fmt"

	"net/http"

	"github.com/grpc-ecosystem/grpc-gateway/v2/runtime"

	"google.golang.org/grpc"

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

	"github.com/janrs-io/Jgrpc/src/pongservice/config"

	v1 "github.com/janrs-io/Jgrpc/src/pongservice/genproto/v1/gw"

)

// RunHttpServer Run http server

func RunHttpServer(conf *config.Config) {

	mux := runtime.NewServeMux()

	opts := []grpc.DialOption{

		grpc.WithTransportCredentials(insecure.NewCredentials()),

	}

	if err := v1.RegisterPongServiceHandlerFromEndpoint(

		context.Background(),

		mux,

		conf.Grpc.Port,

		opts,

	); err != nil {

		panic("register service handler failed.[ERROR]=>" + err.Error())

	}

	httpServer := &http.Server{

		Addr:    conf.Http.Port,

		Handler: mux,

	}

	fmt.Println("Listening http server on port" + conf.Http.Port)

	go func() {

		if err := httpServer.ListenAndServe(); err != nil {

			fmt.Println("listen http server failed.[ERROR]=>" + err.Error())

		}

	}()

	conf.Http.Server = httpServer

}

將以下代碼添加到 run.go 文件中：

package server

import (

	"context"

	"fmt"

	"os"

	"os/signal"

	"syscall"

	"time"

	"github.com/janrs-io/Jgrpc/src/pongservice/config"

	v1 "github.com/janrs-io/Jgrpc/src/pongservice/genproto/v1"

)

// Run Run service server

func Run(cfg string) {

	conf := config.NewConfig(cfg)

	// run grpc server

	RunGrpcServer(initServer(conf), conf)

	// run http server

	RunHttpServer(conf)

	// listen exit server event

	HandleExitServer(conf)

}

// SetServer Wire inject service's component

func initServer(conf *config.Config) v1.PongServiceServer {

	server, err := InitServer(conf)

	if err != nil {

		panic("run server failed.[ERROR]=>" + err.Error())

	}

	return server

}

// HandleExitServer Handle service exit event

func HandleExitServer(conf *config.Config) {

	ch := make(chan os.Signal, 1)

	signal.Notify(ch, syscall.SIGINT, syscall.SIGTERM)

	<-ch

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

	defer cancel()

	conf.Grpc.Server.GracefulStop()

	if err := conf.Http.Server.Shutdown(ctx); err != nil {

		panic("shutdown service failed.[ERROR]=>" + err.Error())

	}

	<-ctx.Done()

	close(ch)

	fmt.Println("Graceful shutdown http & grpc server.")

}

將以下代碼添加到 wire.go 文件中：

//go:build wireinject

// +build wireinject

package server

import (

	"github.com/google/wire"

	"github.com/janrs-io/Jgrpc/src/pongservice/config"

	v1 "github.com/janrs-io/Jgrpc/src/pongservice/genproto/v1"

	"github.com/janrs-io/Jgrpc/src/pongservice/service"

)

// InitServer Inject service's component

func InitServer(conf *config.Config) (v1.PongServiceServer, error) {

	wire.Build(

		service.NewClient,

		service.NewServer,

	)

	return &service.Server{}, nil

}

在 pongservice 目錄中再次運行 go mod tidy ：

go mod tidy

然后在 pongservice 目錄中執(zhí)行以下 wire 命令：

wire ./...

執(zhí)行 wire 命令后，將在 pongsevice/cmd/server 目錄中自動創(chuàng)建 wire_gen.go 文件。

生成 main.go

最后一步，在 pongservice/cmd 目錄下創(chuàng)建 main.go 文件.

package main

import (

	"flag"

	"github.com/janrs-io/Jgrpc/src/pongservice/cmd/server"

)

var cfg = flag.String("config", "config/config.yaml", "config file location")

// main main

func main() {

	server.Run(*cfg)

}

啟動 service

在 pongservice 目錄下執(zhí)行以下命令啟動微服務(wù)：

注意

在 pongservice 目錄而不是 pongservice/cmd 目錄中執(zhí)行命令

go run cmd/main.go

啟動服務(wù)后，會顯示如下信息：

Listening grpc server on port:50051

Listening http server on port:9001

在瀏覽器中輸入以下地址即可訪問該服務(wù)：

127.0.01:9001/pong.v1.pong?msg=best practice

如果成功，將返回以下數(shù)據(jù)：

{

    "msg": "response pong msg:best practice"

}

總結(jié)

現(xiàn)在，我們已經(jīng)了解了如何創(chuàng)建可以開發(fā)基本功能微服務(wù)的項目結(jié)構(gòu)。

在接下來的部分中，我們繼續(xù)創(chuàng)建一個名為 pingservice 的微服務(wù)，并訪問我們在這部分中創(chuàng)建的 pongservice。

轉(zhuǎn)載請注明來源：https://janrs.com/br6f

總結(jié)

以上是生活随笔為你收集整理的基于Go/Grpc/kubernetes/Istio开发微服务的最佳实践尝试 - 1/3的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。

上一篇： (admin.E104) 'XX
下一篇：【代码笔记】iOS-自定义选择框（高底强

日韩av黄I国产麻豆传媒I国产91av视频在线观看I日韩一区二区三区在线看I美女国产在线I麻豆视频国产在线观看I成人黄色短片

编程问答

基于Go/Grpc/kubernetes/Istio开发微服务的最佳实践尝试 - 1/3

Jgrpc

前提

項目結(jié)構(gòu)

開始

創(chuàng)建 pongservice 微服務(wù)

創(chuàng)建基本目錄

生成代碼和文件

生成 buf.yaml

生成 pongservice.proto

生成 pongservice.yaml

生成 buf.gen.yaml

生成 go.mod

生成 config.yaml

生成 config.go

生成 client.go

生成 run server 文件

生成 main.go

啟動 service

總結(jié)

總結(jié)