关于golang:使用

原文链接： 应用 grpcurl 通过命令行拜访 gRPC 服务

个别状况下测试 gRPC 服务，都是通过客户端来间接申请服务端。如果客户端还没筹备好的话，也能够应用 BloomRPC 这样的 GUI 客户端。

curl

grpcurl

gRPC Server

首先来写一个简略的 gRPC Server：

helloworld.proto：

syntax = "proto3";

package proto;

// The greeting service definition.
service Greeter {
    // Sends a greeting
    rpc SayHello (HelloRequest) returns (HelloReply) {}
}

// The request message containing the user's name.
message HelloRequest {
    string name = 1;
}

// The response message containing the greetings
message HelloReply {
    string message = 1;
}

main.go

package main

import (
    "context"
    "fmt"
    "grpc-hello/proto"
    "log"
    "net"

    "google.golang.org/grpc"
    "google.golang.org/grpc/reflection"
)

func main() {
    lis, err := net.Listen("tcp", ":50051")
    if err != nil {
        log.Fatalf("failed to listen: %v", err)
    }

    server := grpc.NewServer()
    // 注册 grpcurl 所需的 reflection 服务
    reflection.Register(server)
    // 注册业务服务
    proto.RegisterGreeterServer(server, &greeter{})

    fmt.Println("grpc server start ...")
    if err := server.Serve(lis); err != nil {
        log.Fatalf("failed to serve: %v", err)
    }
}

type greeter struct {
}

func (*greeter) SayHello(ctx context.Context, req *proto.HelloRequest) (*proto.HelloReply, error) {
    fmt.Println(req)
    reply := &proto.HelloReply{Message: "hello"}
    return reply, nil
}

运行服务：

go run main.go

server start ...

grpcurl 装置

这里我介绍三种形式：

Mac

brew install grpcurl

Docker

# Download image
docker pull fullstorydev/grpcurl:latest
# Run the tool
docker run fullstorydev/grpcurl api.grpc.me:443 list

go tool

如果有 Go 环境的话，能够通过 go tool 来装置：

go install github.com/fullstorydev/grpcurl/cmd/grpcurl@latest

grpcurl 应用

-cert-key

-plaintext

-unix

查看服务列表：

grpcurl -plaintext 127.0.0.1:50051 list

输入：

grpc.reflection.v1alpha.ServerReflection
proto.Greeter

查看某个服务的办法列表：

grpcurl -plaintext 127.0.0.1:50051 list proto.Greeter

输入：

proto.Greeter.SayHello

查看办法定义：

grpcurl -plaintext 127.0.0.1:50051 describe proto.Greeter.SayHello

输入：

proto.Greeter.SayHello is a method:
rpc SayHello ( .proto.HelloRequest ) returns ( .proto.HelloReply );

查看申请参数：

grpcurl -plaintext 127.0.0.1:50051 describe proto.HelloRequest

输入：

proto.HelloRequest is a message:
message HelloRequest {
  string name = 1;
}

申请服务：

grpcurl -d '{"name": "zhangsan"}' -plaintext 127.0.0.1:50051 proto.Greeter.SayHello

输入：

{
  "message": "hello"
}

-d@

grpcurl -d @ -plaintext 127.0.0.1:50051 proto.Greeter.SayHello

可能遇到的谬误

可能会遇到三个报错：

1、gRPC Server 未启用 TLS：

报错信息：

Failed to dial target host "127.0.0.1:50051": tls: first record does not look like a TLS handshake

解决：

-plaintext

2、服务没有启动 reflection 反射服务

报错信息：

Failed to list services: server does not support the reflection API

解决：

这行代码是要害，肯定要蕴含：

// 注册 grpcurl 所需的 reflection 服务
reflection.Register(server)

3、参数格局谬误：

报错信息：

Error invoking method "greet.Greeter/SayHello": error getting request data: invalid character 'n' looking for beginning of object key string

解决：

-d''

总结：

用这个工具做一些简略的测试还是相当不便的，上手也简略。只有把握文中提到的几条命令，根本能够涵盖大部分的测试需要了。

扩大浏览：

1. https://appimage.github.io/BloomRPC/
2. https://github.com/fullstorydev/grpcurl

文章中的脑图和源码都上传到了 GitHub，有须要的同学可自行下载。

地址： https://github.com/yongxinz/gopher/tree/main/blog

往期文章列表：

1. 被 Docker 日志坑惨了
2. 举荐三个实用的 Go 开发工具
3. 这个 TCP 问题你得懂：Cannot assign requested address

Go 专栏文章列表：

1. Go 专栏｜开发环境搭建以及开发工具 VS Code 配置
2. Go 专栏｜变量和常量的申明与赋值
3. Go 专栏｜根底数据类型：整数、浮点数、复数、布尔值和字符串
4. Go 专栏｜复合数据类型：数组和切片 slice
5. Go 专栏｜复合数据类型：字典 map 和 构造体 struct
6. Go 专栏｜流程管制，一网打尽
7. Go 专栏｜函数那些事
8. Go 专栏｜错误处理：defer，panic 和 recover
9. Go 专栏｜说说办法
10. Go 专栏｜接口 interface
11. Go 专栏｜并发编程：goroutine，channel 和 sync