@addrobots/grpc-web 中文文档教程

Question

@improbable-eng/grpc-web

用于从浏览器发出 gRPC-Web 请求的

库此库适用于从 Web 浏览器或 NodeJS 使用 JavaScript 和 TypeScript（请参阅NodeJS 的用法）。

注意：这仅在服务器支持 gRPC-Web 时有效/em>

Golang gRPC-Web 中间件和基于 Golang 的 gRPC-Web 代理可在此处获取。

请参阅完整的 gRPC-Web README 了解已知限制。

Installation

@improbable-eng/grpc-web 具有 google-protobuf 和 @types/google-protobuf 的对等依赖项。

npm install google-protobuf @types/google-protobuf @improbable-eng/grpc-web --save

Example Project

有一个 example project available here

Usage Overview

• Use ts-protoc-gen with protoc to generate .js and .d.ts files for your request and response classes. ts-protoc-gen can also generate gRPC service definitions with the service=true argument.
• Go to code generation docs
• Make a request using unary(), invoke() or client()

import {grpc} from "@improbable-eng/grpc-web";

// Import code-generated data structures.
import {BookService} from "./generated/proto/examplecom/library/book_service_pb_service";
import {GetBookRequest} from "./generated/proto/examplecom/library/book_service_pb";

const getBookRequest = new GetBookRequest();
getBookRequest.setIsbn(60929871);
grpc.unary(BookService.GetBook, {
  request: getBookRequest,
  host: host,
  onEnd: res => {
    const { status, statusMessage, headers, message, trailers } = res;
    if (status === grpc.Code.OK && message) {
      console.log("all ok. got book: ", message.toObject());
    }
  }
});

• Requests can be aborted/cancelled before they complete:

const request = grpc.unary(BookService.GetBook, { ... });
request.cancel();

Available Request Functions

发出 gRPC 请求的三个函数：

grpc.unary

这是一个方便的函数，用于发出由单个请求消息组成的请求和单个响应消息。 它只能与一元方法一起使用。

rpc GetBook(GetBookRequest) returns (Book) {}

grpc.invoke

这是一个方便的函数，用于发出由单个请求消息和响应消息流（服务器流）组成的请求。 它也可以与一元方法一起使用。

rpc GetBook(GetBookRequest) returns (Book) {}
rpc QueryBooks(QueryBooksRequest) returns (stream Book) {}

grpc.client

grpc.client 返回一个客户端。 根据传输兼容性，此客户端能够发送多个请求消息（客户端流）并接收多个响应消息（服务器流）。 它可以与任何类型的方法一起使用，但会强制限制一元方法的消息发送。

rpc GetBook(GetBookRequest) returns (Book) {}
rpc QueryBooks(QueryBooksRequest) returns (stream Book) {}
rpc LogReadPages(stream PageRead) returns (google.protobuf.Empty) {}
rpc ListenForBooks(stream QueryBooksRequest) returns (stream Book) {}

Usage with NodeJS

参考 grpc-web-node-http-transport。

All Docs

• unary()
• invoke()
• client()
• Code Generation
• Concepts
• Transport