gRPC
- 一、gRPC
- 二、proto-buf
- 三、gRPC-Web
一、gRPC
官方指南 由 google 开发,是一款语言中立、平台中立、开源的远程过程调用(RPC)系统。
- 优势 gRPC 客户端和服务端可以在多种环境中运行和交互,例如从 google 内部的服务器到你自己的笔记本,并且可以用任何 gRPC 支持的语言来编写。所以,你可以很容易地用 Java 创建一个 gRPC 服务端,用 Go、Python、Ruby 来创建客户端。
- 生成 gRPC 代码——Node.js Node.js库从运行时加载的 .proto 文件动态生成服务描述和客户端存根的定义,所以使用此语言时没必要生成任何特殊代码。而是在例子客户端和服务端里,我们 require gRPC 库,然后用它的 load() 方法:
var grpc = require('grpc');
var hello_proto = grpc.load(PROTO_PATH).helloworld;
二、proto-buf
Google 开源的一套成熟的结构数据序列化机制(也可以使用其他数据格式如 JSON),推荐版本:proto3 。 用 proto files 创建 gRPC 服务,用 protocol buffers 消息类型来定义方法参数和返回类型。 protobuf 规范参考
代码语言:javascript复制syntax = "proto3";
package admin;
// 用户信息类型
message User {
int64 id = 1;
string name = 4;
string email = 5;
string phone = 6;
int64 create_at = 7;
int64 update_at = 8;
int64 last_login_at = 9;
}
// 约定服务getUser
service Admin {
rpc getUser (getUserRequest) returns (getUserReply) {}
}
// 约定服务入参
message getUserRequest {
}
// 约定服务出参
message getUserReply {
User user = 1;
}
[Protocol Buffers安装]教程(https://zhuanlan.zhihu.com/p/42379354)
三、gRPC-Web
云原生计算基金会(CNCF)正式发布 GA 版本的 gRPC-Web,这是一个 JavaScript 客户端库,使 Web 应用程序能够直接与后端 gRPC 服务通信,不需要 HTTP 服务器充当中介。
- 与 REST 的区别 gRPC:一个客户端应用程序通过 Protocol Buffers 与一个 gRPC 后端服务器通信,然后这个服务器也通过 Protocol Buffers 与其他的 gRPC 后端服务器通信。 REST:Web 应用程序通过 HTTP 与后端 REST API 服务器通信,然后这个服务器又通过 Protocol Buffers 与其他后端服务通信。
- 产生的原因 gRPC是一个基于HTTP/2实现的高性能远程过程调用框架,但是由于浏览器没有直接暴露HTTP/2,所以Web应用程序不能直接使用gRPC。gRPC-Web是一个标准化协议,它解决了这个问题,可以在浏览器中使用gRPC。
- JS中使用gRPC
Windows系统在JS中使用
.proto
文件需要有.protoc-gen-grpc-web.exe
(生成web js文件的工具)、protoc.exe
(Protocol Buffers工具)和.proto
文件,在使用时需要npm
安装grpc-web
。之后执行如下命令即可:
// 会生成{proto_name}_pb.js和{proto_name}_grpc_pb.js
{路径}protoc -I=./ {路径下的proto文件} --js_out=import_style=commonjs:./ --plugin=protoc-gen-grpc={路径}/protoc-gen-grpc-web.exe --grpc-web_out=import_style=commonjs,mode=grpcwebtext:./
在Vue中使用gRPC Client示例如下,向后台发起register的gRPC请求:
代码语言:javascript复制import * as grpc_web from '../proto/admin_grpc_web_pb'
import {AdminClient} from '../proto/admin_grpc_web_pb'
export const rpcWeb = grpc_web
export const client = new AdminClient('http://127.0.0.1:8081')
----------------------------------------
let send = new rpcWeb.registerRequest()
send.setName('huang')
...
const metaData = {authorization: '...'}
// client.register(registerRequest, metadata, (err,response)=>{})
client[register](send, metaData, (err, resp) => {
...
}
// service端代码参考:https://github.com/grpc/grpc-web/blob/master/net/grpc/gateway/examples/echo/node-server/server.js
JS中使用.proto文件教程