go Grpc 入门

前言

网上很多文章不是新版的，有问题，自己尝试了一把，在此记录。

grpc安装:

//protobuf的安装
 PB_REL="https://github.com/protocolbuffers/protobuf/releases" && curl -LO $PB_REL/download/v3.11.4/protoc-3.11.4-linux-x86_64.zip

//protoc-gen-go proto生成go的代码工具
 go get github.com/golang/protobuf/protoc-gen-go

//注意设置环境变量即可

参考文档：https://www.grpc.io/docs/quickstart/go/

proto书写:

syntax = "proto3"; //版本
option go_package = ".;hello"; //生成包名hello
service Greeter {  //定义service
    rpc SayHello(HelloRequest)returns(HelloReply){}
    rpc SayHelloAgain(HelloRequest) returns(HelloReply){}
}

message HelloRequest{ //定义请求
    string name = 1;
}

message HelloReply{ //定义返回
    string message = 1;
}

参考文档:
https://developers.google.com/protocol-buffers

proto文件生成go代码

//gprc使用
 protoc --proto_path=proto --go_out=plugins=grpc:hello --go_opt=paths=source_relative proto/hello.proto

//仅包含proto生成为go代码
 protoc --proto_path=proto --go_out=hello --go_opt=paths=source_relative proto/hello.proto

参考文档:https://www.grpc.io/docs/quickstart/go/#whats-next

代码书写

服务端:

package main

import (
    "context"
    "fmt"
    "google.golang.org/grpc"
    "grpc_demo/hello"
    "net"
)

type Server struct {
}

func main()  {
    g := grpc.NewServer()
    s := Server{}
    hello.RegisterGreeterServer(g,&s)
    lis, err := net.Listen("tcp", fmt.Sprintf(":8080"))
    if err != nil {
        panic("failed to listen: "+err.Error())
    }
    g.Serve(lis)

}

func (s *Server)  SayHello(ctx context.Context,request *hello.HelloRequest)(*hello.HelloReply,error){
    return &hello.HelloReply{Message:"Hello "+request.Name},nil
}

func (s *Server)  SayHelloAgain(ctx context.Context,request *hello.HelloRequest)(*hello.HelloReply,error){
    return &hello.HelloReply{Message:"Hello Again "+request.Name},nil
}

客户端:

package main

import (
    "context"
    "fmt"
    "google.golang.org/grpc"
    "grpc_demo/hello"
)

func main()  {
    conn,err := grpc.Dial("127.0.0.1:8080",grpc.WithInsecure())
    if err!=nil{
        panic(err)
    }
    defer conn.Close()
    c := hello.NewGreeterClient(conn)
    r,err := c.SayHello(context.Background(),&hello.HelloRequest{Name:"ucan"})
    if err!=nil{
        panic(err)
    }
    fmt.Println(r.Message)
}

demo地址：http://gitee.com/ucanme/grpc_demo

带证书版本代码
util.go

package util

import (
    "crypto/tls"
    "golang.org/x/net/http2"
    "io/ioutil"
    "log"
)

func GetTLSConfig(certPemPath, certKeyPath string) *tls.Config {
    var certKeyPair *tls.Certificate
    cert, _ := ioutil.ReadFile(certPemPath)
    key, _ := ioutil.ReadFile(certKeyPath)

    pair, err := tls.X509KeyPair(cert, key)
    if err != nil {
        log.Println("TLS KeyPair err: %v\n", err)
    }

    certKeyPair = &pair

    return &tls.Config{
        Certificates: []tls.Certificate{*certKeyPair},
        NextProtos:   []string{http2.NextProtoTLS},
    }
}

server.go

package main

import (
    "context"
    "crypto/tls"
    "fmt"
    "google.golang.org/grpc"
    "grpc_demo/hello"
    "grpc_demo/util"
    "net"
)

type Server struct {
}

func main() {
    g := grpc.NewServer()
    s := Server{}
    hello.RegisterGreeterServer(g, &s)
    conn, err := net.Listen("tcp", fmt.Sprintf(":8080"))
    if err != nil {
        panic("failed to listen: " + err.Error())
    }
    //tls
    g.Serve(tls.NewListener(conn, util.GetTLSConfig("./cert/server.pem", "./cert/server.key")))

}

func (s *Server) SayHello(ctx context.Context, request *hello.HelloRequest) (*hello.HelloReply, error) {
    return &hello.HelloReply{Message: "Hello " + request.Name}, nil
}

func (s *Server) SayHelloAgain(ctx context.Context, request *hello.HelloRequest) (*hello.HelloReply, error) {
    return &hello.HelloReply{Message: "Hello Again " + request.Name}, nil
}

client.go

/**
 * @author: wuji
 * @file:  main
 * @desc:
 * @date: 2020/4/23 7:31 下午
 */

package main

import (
    "context"
    "fmt"
    "google.golang.org/grpc"
    "google.golang.org/grpc/credentials"
    "grpc_demo/hello"
)

func main()  {
    //证书
    creds,err := credentials.NewClientTLSFromFile("../cert/server.pem","ucan")
    if err!=nil{
        panic(err)
    }

    conn,err := grpc.Dial("127.0.0.1:8080",grpc.WithTransportCredentials(creds))
    if err!=nil{
        panic(err)
    }
    defer conn.Close()
    c := hello.NewGreeterClient(conn)


    r,err := c.SayHello(context.Background(),&hello.HelloRequest{Name:"ucan"})
    if err!=nil{
        panic(err)
    }
    fmt.Println(r.Message)
}

proto编译参考

编译器使用
使用protoc命令编译.proto文件,不同语言支持需要指定输出参数，如：

protoc --proto_path=IMPORT_PATH --cpp_out=DST_DIR --java_out=DST_DIR --python_out=DST_DIR --go_out=DST_DIR --ruby_out=DST_DIR --javanano_out=DST_DIR --objc_out=DST_DIR --csharp_out=DST_DIR path/to/file.proto
这里详细介绍golang的编译姿势:

-I 参数：指定import路径，可以指定多个-I参数，编译时按顺序查找，不指定时默认查找当前目录

--go_out ：golang编译支持，支持以下参数

plugins=plugin1+plugin2 - 指定插件，目前只支持grpc，即：plugins=grpc

M 参数 - 指定导入的.proto文件路径编译后对应的golang包名(不指定本参数默认就是.proto文件中import语句的路径)

import_prefix=xxx - 为所有import路径添加前缀，主要用于编译子目录内的多个proto文件，这个参数按理说很有用，尤其适用替代一些情况时的M参数，但是实际使用时有个蛋疼的问题导致并不能达到我们预想的效果，自己尝试看看吧

import_path=foo/bar - 用于指定未声明package或go_package的文件的包名，最右面的斜线前的字符会被忽略

末尾 :编译文件路径 .proto文件路径(支持通配符)

完整示例：

protoc -I . --go_out=plugins=grpc,Mfoo/bar.proto=bar,import_prefix=foo/,import_path=foo/bar:. ./*.proto