gRPC框架学习

安装Protobuf

下载安装:https://github.com/protocolbuffers/protobuf/releases
配置环境变量:$GOPATH/bin(解压后的程序文件放到goPath目录,否则会出现protoc命令不存在或者protoc-gen-go不存在等问题)

安装gRPC核心库

# 安装protocol编译器
go get google.golang.org/grpc
# 安装各语言的代码生成工具
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest

编写proto文件

// 声明使用的是proto3语法
syntax = "proto3";

// 表示最后生成的go文件处于哪个目录哪个包中,【.】代表当前目录生成,service代表了生成的go文件的包名是service
option go_package = ".;service";

// 定义了一个服务,服务中需要一个方法,这个方法可以接收客户端的参数,再返回服务端的响应
// 这里定义了一个名为SayHello的service,这个服务中有一个rpc方法,名为SayHello,这个方法会发送一个HelloRequest,返回HelloResponse
service SayHello {
  rpc SayHello(HelloRequest) returns (HelloResponse) {}
}

message HelloRequest {
  string requestName = 1;
  int64 age = 2;
}

message HelloResponse {
  string responseMsg = 1;
}

生成对应文件

protoc --go_out=. test.proto # 对应文件名
protoc --go-grpc_out=. test.proto # 对应文件名

服务端编写

1. 创建gRPC Server对象,可以理解为它是Server端的抽象对象
2. 将server(其包含需要被调用的服务端接口)注册到gRPC Server的内部注册中心,这样可以在接受到请求时,通过内部的服务发现,发现该端口并转接进行逻辑处理
3. 创建Listen,监听TCP端口
4. gRPC Server开始lis.Accept,直到Stop

package main

import (
    "context"
    "fmt"
    "google.golang.org/grpc"
    pb "grpc/server/proto"
    "net"
)

// hello server
type server struct {
    pb.UnimplementedSayHelloServer
}

func (s *server) SayHello(ctx context.Context,req *pb.HelloRequest) (*pb.HelloResponse, error) {
    fmt.Println("打印:" + req.RequestName)
    return &pb.HelloResponse{ResponseMsg: "hello" + req.RequestName}, nil
}

func main() {
    // 开启端口
    listen,_  := net.Listen("tcp", ":9090")
    // 创建grpc服务
    grpcServer := grpc.NewServer()
    // 在grpc服务端中去注册我们自己编写的服务
    pb.RegisterSayHelloServer(grpcServer, &server{})

    // 启动服务
    err := grpcServer.Serve(listen)
    if err != nil {
        fmt.Printf("启动失败:%v", err)
        return
    }
}

客户端编写

package main

import (
    "context"
    "fmt"
    "google.golang.org/grpc"
    "google.golang.org/grpc/credentials/insecure"
    pb "grpc/server/proto"
)

func main() {
    conn, err := grpc.Dial("127.0.0.1:9090", grpc.WithTransportCredentials(insecure.NewCredentials()))
    if err != nil {
        fmt.Printf("连接失败:%v", err)
        return
    }
    defer conn.Close()

    // 建立连接
    client := pb.NewSayHelloClient(conn)

    resp, _ := client.SayHello(context.Background(), &pb.HelloRequest{RequestName: "张三"})
    fmt.Println(resp.GetResponseMsg())
}

TLS认证

## 服务端
    // TLS认证
    creds, _ := credentials.NewServerTLSFromFile("pem file path","key file path")
    // 开启端口
    listen,_  := net.Listen("tcp", ":9090")
    // 创建grpc服务
    grpcServer := grpc.NewServer(grpc.Creds(creds))

## 客户端
    // TLS认证
    creds, _ := credentials.NewClientTLSFromFile("pem file path","*.test.com")
    conn, err := grpc.Dial("127.0.0.1:9090", grpc.WithTransportCredentials(creds))

Token认证

gRPC提供了一个接口,这个接口有2个方法,接口位于credentials包下,这个接口需要客户端来实现

type PerRPCCredentials interface {
    // 第一个方法用于获取元数据,也就是客户端提供的key-value对,context用于控制超时和取消,uri是请求入口处的uri
    GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error)
    // 第二个定义是否需要基于TLS认证进行安全传输,返回true则必须加上TLS验证,false则不用
    RequireTransportSecurity() bool
}

示例代码

## 客户端
type ClientTokenAuth struct {}

func (c ClientTokenAuth) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error) {
    return map[string]string{
        "appId":  "zhangsan",
        "appKey": "123123",
    }, nil
}

func (c ClientTokenAuth) RequireTransportSecurity() bool {
    return false
}

// 连接到server端代码,此处禁用安全传输,没有加密和验证
var opts []grpc.DialOption
opts = append(opts,grpc.WithTransportCredentials(insecure.NewCredentials()))
opts = append(opts,grpc.WithPerRPCCredentials(new(ClientTokenAuth)))

conn, err := grpc.Dial("127.0.0.1:9090", opts...)

#-------------------------------------------------------------------------------------#
## 服务端
func (s *server) SayHello(ctx context.Context,req *pb.HelloRequest) (*pb.HelloResponse, error) {
    // 获取元数据的信息
    md, ok := metadata.FromIncomingContext(ctx)
    if !ok {
        return nil,errors.New("未传输token")
    }
    
    var appId string
    var appKey string
    if val, ok := md["appId"];ok{
        appId = val[0]
    }
    if val, ok := md["appKey"];ok{
        appKey = val[0]
    }
    
    if appId != "zhangsan" || appKey != "123123" {
        return nil,errors.New("token异常")
    }
    
    return &pb.HelloResponse{ResponseMsg: "hello" + req.RequestName}, nil
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 222,183评论 6 516
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,850评论 3 399
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 168,766评论 0 361
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,854评论 1 299
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,871评论 6 398
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,457评论 1 311
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,999评论 3 422
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,914评论 0 277
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,465评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,543评论 3 342
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,675评论 1 353
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,354评论 5 351
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 42,029评论 3 335
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,514评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,616评论 1 274
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 49,091评论 3 378
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,685评论 2 360

推荐阅读更多精彩内容