moul/grpcbin

grpcbin

类似httpbin的gRPC测试工具

!CircleCI !Docker Build Status !Go Report Card !GoDoc !License

!https://raw.githubusercontent.com/moul/grpcbin/master/.assets/overview.svg?sanitize=true

镜像概述和主要用途

grpcbin是一个类似httpbin的gRPC测试服务器，提供多种gRPC服务端点，支持安全和非安全连接方式。它允许开发者测试gRPC客户端与服务的交互，验证请求/响应处理、流传输等功能，是gRPC开发和调试的实用工具。

核心功能和特性

• 多服务支持：提供grpcbin.proto、hello.proto、addsvc.proto等多种服务定义
• 连接方式：支持非安全gRPC（HTTP）和安全gRPC（TLS加密）
• 交互模式：支持Unary、Server Stream、Client Stream、Bidirectional Stream等多种gRPC通信模式
• 公开测试服务器：提供公开的grpcb.in服务器，方便快速测试
• 本地部署：可通过Docker本地部署，满足私有化测试需求

使用场景和适用范围

• gRPC客户端开发时的功能测试
• gRPC协议实现验证
• gRPC流传输（Stream）功能调试
• 学习和演示gRPC使用方法
• CI/CD流程中的gRPC服务连通性测试

使用方法和配置说明

公开服务器信息

• 非安全gRPC（HTTP）：grpc://grpcb.in:9000
• 安全gRPC（TLS）：grpc://grpcb.in:443 和 grpc://grpcb.in:9001
• Web服务：https://grpcb.in

服务定义文件

• https://github.com/moul/pb/blob/master/grpcbin/grpcbin.proto
• https://github.com/moul/pb/blob/master/hello/hello.proto
• https://github.com/moul/pb/blob/master/addsvc/addsvc.proto

本地部署

通过Docker在本地运行grpcbin服务器：

console
$ docker run -it --rm -p 9000:9000 -p 9001:9001 moul/grpcbin
2017/12/18 14:48:01 listening on :9000 (insecure)
2017/12/18 14:48:01 listening on :9001 (secure)

示例

Golang客户端示例

go
package main

import (
	"fmt"
	"log"

	"golang.org/x/net/context"
	"google.golang.org/grpc"

	pb "github.com/moul/pb/grpcbin/go-grpc"
)

func main() {
	// 建立连接
	conn, _ := grpc.Dial("grpcb.in:9000", grpc.WithInsecure())
	defer conn.Close()

	// 创建客户端和上下文
	client := pb.NewGRPCBinClient(conn)
	ctx := context.Background()

	// 调用DummyUnary方法
	res, err := client.DummyUnary(ctx, &pb.DummyMessage{
		FString: "hello",
		FInt32:  42,
	})
	if err != nil {
		log.Fatalf("调用DummyUnary失败: %v", err)
	}
	fmt.Println(res)
}

使用grpcc工具示例

https://github.com/njpatel/grpcc%E6%98%AF%E4%B8%80%E4%B8%AAgRPC%E5%91%BD%E4%BB%A4%E8%A1%8C%E5%AE%A2%E6%88%B7%E7%AB%AF%E5%B7%A5%E5%85%B7%EF%BC%8C%E5%8F%AF%E7%94%A8%E4%BA%8E%E4%B8%8Egrpcbin%E4%BA%A4%E4%BA%92%EF%BC%9A

console
# 获取proto文件并安装工具
$ wget -qN https://github.com/moul/pb/raw/master/grpcbin/grpcbin.proto
$ npm install -g grpcc

# 交互式客户端
$ grpcc -i -p ./grpcbin.proto --address grpcb.in:9000
连接到grpcbin.GRPCBin (grpcb.in:9000)。可用全局变量:

  client - GRPCBin的客户端连接
    index (EmptyMessage, callback) 返回 IndexReply
    dummyUnary (DummyMessage, callback) 返回 DummyMessage
    dummyServerStream (DummyMessage, callback) 返回 DummyMessage
    dummyClientStream (DummyMessage, callback) 返回 DummyMessage
    dummyBidirectionalStreamStream (DummyMessage, callback) 返回 DummyMessage

  printReply - 用于打印Unary调用响应的函数 (别名: pr)
  streamReply - 用于打印Stream调用响应的函数 (别名: sr)
  createMetadata - 将JS对象转换为gRPC元数据实例 (别名: cm)

GRPCBin@grpcb.in:9000> ^C

# 调用index端点
$ grpcc -i -p ./grpcbin.proto --address grpcb.in:9000 --eval 'client.index({}, printReply)'
{
  "description": "gRPC测试服务器",
  "endpoints": [
    {
      "path": "index",
      "description": "此端点。"
    },
    {
      "path": "dummyUnary",
      "description": "返回接收到的DummyMessage的Unary端点。"
    },
    [...]
  ]
}

# 使用参数调用dummyUnary
$ grpcc -i -p ./grpcbin.proto --address grpcb.in:9000 --eval 'client.dummyUnary({f_string:"hello",f_int32:42}, printReply)'
{
  "f_string": "hello",
  "f_strings": [],
  "f_int32": 42,
  "f_int32s": [],
  "f_enum": "ENUM_0",
  "f_enums": [],
  "f_sub": null,
  "f_subs": [],
  "f_bool": false,
  "f_bools": [],
  "f_int64": "0",
  "f_int64s": [],
  "f_bytes": {
    "type": "Buffer",
    "data": []
  },
  "f_bytess": [],
  "f_float": 0,
  "f_floats": []
}

更多语言示例请参考专用仓库：https://github.com/moul/grpcbin-example