grpc实践-学会grpc就是这么简单

vlambda
2020-07-30

grpc实践-学会grpc就是这么简单

前言

内容描述

hello，我是asong，这是我的第七篇原创文章。上一篇我们使用go的标准库rpc进行实践，使用起来还是很方便的，这一篇我们来学习一grpc。

GRPC

gRPC是Google开发的高性能、通用的开源RPC框架，其由Google主要面向移动应用开发并基于HTTP/2协议标准而设计，基于ProtoBuf（Protocol Buffers）序列化协议开发，且支持众多开发语言。他的目标是跨语言开发，支持多种语言。

在gRPC里客户端应用可以像调用本地对象一样直接调用另一台不同的机器上服务端应用的方法，使得您能够更容易地创建分布式应用和服务。

gRPC基于以下理念：定义一个服务，指定其能够被远程调用的方法（包含参数和返回类型）。在服务端实现这个接口，并运行一个gRPC服务器来处理客户端调用。在客户端拥有一个存根能够像服务端一样的方法。

gRPC支持多种语言，所以我们可以用自己的喜欢的语言来进行开发，官网都有相关介绍。

protocol buffers

gRPC默认使用protocol buffers，这是Google开源的一套成熟的结构数据序列化机制，也可以使用其他数据格式，比如json。现在protocol buffers版本已经到proto3了，他拥有轻量简化的语法，一些有用的新功能，并支持多种语言。这里就不介绍protocol buffers的具体使用了，详细学习点击这里：https://developers.google.com/protocol-buffers。下面讲一个简单的例子来看看一gRPC的具体使用。

gRPC实践

语言：golang

功能：一个用户登陆接口，两个server，一个webserver用来和前端进行交互、一个tcpserver用来处理登陆逻辑，两个server通过rpc进行请求调用。因为这个主要是演示gRPC的使用，登陆逻辑就不操作数据库了，简单写个返回示例。

首先我们来编写proto文件，因为是登陆接口，所以我们可以设计登陆请求参数、返回参数如下所示：

syntax = "proto3";

package proto;

option go_package = "proto/user.proto;user_proto";


//the request message containing the user's name password
message LoginRequest {
  //user name
  string username = 1;
  //password
  string password = 2;
}
//the response message containing the user's information
message LoginResponse {
  //user name
  string username = 1;
  string nickname = 2;

  //token
  string token = 3;
  //result code
  uint32 code = 4;
  //result msg
  string msg = 5;
}


service UserService {
    rpc login (LoginRequest) returns (LoginResponse){

  }

}

gRPC提供代码生成工具，使用protoc-gen-go-grpc即可生成代码，具体操作如下：

$ export GO111MODULE=on  # Enable module mode

$ go get github.com/golang/protobuf/protoc-gen-go

执行以上操作后，会在你的GOPATH/bin目录下生成可执行文件，把这个路径加入到环境变量即可。

现在就可以使用protoc命令进行代码生成，进入项目根目录，创建proto文件，将.proto文件放到这个文件下，执行以下命令

$ protoc \   --go_out=Mgrpc/service_config/service_config.proto=/internal/proto/grpc_service_config:. \   --go-grpc_out=Mgrpc/service_config/service_config.proto=/internal/proto/grpc_service_config:. \   --go_opt=paths=source_relative \   --go-grpc_opt=paths=source_relative \   proto/user.proto

此时会在proto目录下生成user_pb.go、user_grpc.pb.go两个。现在协议部分已经完事了，开始编写server、client部分代码如下：

//server

package main

import (
   "context"
   "log"
   "net"

   "google.golang.org/grpc"

   pb "asong.cloud/Golang_Dream/code_demo/grpc_demo/proto"
)

type Server struct {
   pb.UnimplementedUserServiceServer
}

func (s *Server)Login(ctx context.Context,in *pb.LoginRequest) (*pb.LoginResponse,error) {
   log.Printf("Received username: %s", in.Username)
   log.Printf("Received password: %s",in.Password)
   return &pb.LoginResponse{Username: in.Username,Nickname: "Golang梦工厂",Token: "asong_grpc",Code: 0,Msg: "登陆成功"},nil
}

func main()  {
   lis, err := net.Listen("tcp",":8080")
   if err != nil{
      log.Fatalf("failed to listen :%v",err)
   }
   grpc := grpc.NewServer()
   pb.RegisterUserServiceServer(grpc, &Server{})
   if err := grpc.Serve(lis); err != nil {
      log.Fatalf("failed to serve: %v", err)
   }
}

//client

package main

import (
   "context"
   "log"
   "time"

   "google.golang.org/grpc"

   pb "asong.cloud/Golang_Dream/code_demo/grpc_demo/proto"
)

const (
   address = "localhost:8080"
)


func main()  {
   conn,err := grpc.Dial(address,grpc.WithInsecure(),grpc.WithBlock())
   if err != nil{
      log.Fatalf("did not connect: %v",err)
   }

   defer conn.Close()
   c := pb.NewUserServiceClient(conn)

   ctx,cannel := context.WithTimeout(context.Background(),time.Second * 10)
   defer cannel()
   rsp ,err := c.Login(ctx,&pb.LoginRequest{Username: "asong",Password: "123"})
   if err != nil{
      log.Fatalf("could not login request: %v",err)
   }
   log.Printf("Username: %s  Code: %d   Msg: %s", rsp.GetUsername(),rsp.Code,rsp.Msg)
}

代码部分写完了，执行go run *.go，控制台将会有如下输出：

grpc实践-学会grpc就是这么简单

总结

好啦，这一篇介绍到这里就结束了。这只是一个简单的应用，可以作为入门观看，具体深入，还是要看官方文档，根据项目进行深入思考。

vlambda博客
学习文章列表