搜文章
推荐 原创 视频 Java开发 iOS开发 前端开发 JavaScript开发 Android开发 PHP开发 数据库 开发工具 Python开发 Kotlin开发 Ruby开发 .NET开发 服务器运维 开放平台 架构师 大数据 云计算 人工智能 开发语言 其它开发
Lambda在线 > CNCF > gRPC-Web中的拦截器

gRPC-Web中的拦截器

CNCF 2020-06-30


我们很高兴地宣布从1.1.0版开始支持gRPC-web中的拦截器(interceptor)。虽然当前的设计基于其他gRPC语言提供的gRPC客户端拦截器,但它也包括gRPC特定于Web的特性,这些特性应该会使拦截器易于采用,并与现代Web框架一起使用。


介绍

与其他gRPC语言类似,gRPC-web支持unary和server-streaming拦截器。对于每种拦截器,我们都定义了一个包含单个intercept()方法的接口:

  • UnaryInterceptor

  • StreamInterceptor


UnaryInterceptor接口的声明方式如下:


/** @interface*/const UnaryInterceptor = function() {};

/** * @template REQUEST, RESPONSE * @param {!Request<REQUEST, RESPONSE>} request * @param {function(!Request<REQUEST,RESPONSE>):!Promise<!UnaryResponse<RESPONSE>>} * invoker * @return {!Promise<!UnaryResponse<RESPONSE>>} */UnaryInterceptor.prototype.intercept = function(request, invoker) {};

intercept()方法接受两个参数:

  • 类型为gRPC.web.Request的request。

  • invoker,它在被调用时执行实际的RPC。


StreamInterceptor接口声明类似,只是调用器返回类型是ClientReadablaStream而不是Promise。有关实现的详细信息,请参阅interceptor.js

https://github.com/grpc/grpc-web/blob/master/javascript/net/grpc/web/interceptor.js


注:StreamInteceptor可以应用于任何具有ClientReadableStream返回类型的RPC,无论它是unary还是server-streaming RPC。


我能用拦截器做什么?

拦截器允许你执行以下操作:

  • 在传递原始gRPC请求之前更新它-例如,你可能会注入额外的信息,如auth标头。

  • 操作原始调用程序函数的行为,例如绕过调用,以便你可以改用缓存结果。

  • 在响应返回到客户端之前更新响应。

接下来你将看到一些示例。


Unary拦截器示例

下面给出的代码说明了执行以下操作的unary拦截器:

  • 它在RPC之前为gRPC请求消息添加一个字符串。

  • 收到gRPC响应消息后,它会在消息前面加上一个字符串。


这个简单的一元拦截器被定义为实现UnaryInterceptor接口的类:

/** * @constructor * @implements {UnaryInterceptor} */const SimpleUnaryInterceptor = function() {};

/** @override */SimpleUnaryInterceptor.prototype.intercept = function(request, invoker) { // Update the request message before the RPC. const reqMsg = request.getRequestMessage(); reqMsg.setMessage('[Intercept request]' + reqMsg.getMessage());

// After the RPC returns successfully, update the response. return invoker(request).then((response) => { // You can also do something with response metadata here. console.log(response.getMetadata());

// Update the response message. const responseMsg = response.getResponseMessage(); responseMsg.setMessage('[Intercept response]' + responseMsg.getMessage());

return response; });};


Stream截取器示例

在使用StreamInterceptor拦截来自ClientReadableStream的服务器流响应时需要更加小心。以下是要遵循的主要步骤:

  1. 创建一个ClientReadableStream-wrapper类,并使用它拦截流事件,比如接收服务器响应。

  2. 创建一个实现StreamInterceptor并使用stream wrapper的类。


下面的示例stream-wrapper类截取响应,并在响应消息前面附加一个字符串:


/** * A ClientReadableStream wrapper. * * @template RESPONSE * @implements {ClientReadableStream} * @constructor * @param {!ClientReadableStream<RESPONSE>} stream */const InterceptedStream = function(stream) { this.stream = stream;};

/** @override */InterceptedStream.prototype.on = function(eventType, callback) { if (eventType == 'data') { const newCallback = (response) => { // Update the response message. const msg = response.getMessage(); response.setMessage('[Intercept response]' + msg); // Pass along the updated response. callback(response); }; // Register the new callback. this.stream.on(eventType, newCallback); } else { // You can also override 'status', 'end', and 'error' eventTypes. this.stream.on(eventType, callback); } return this;};

/** @override */InterceptedStream.prototype.cancel = function() { this.stream.cancel(); return this;};

示例拦截器的intercept()方法返回一个wrapped stream:


/** * @constructor * @implements {StreamInterceptor} */const TestStreamInterceptor = function() {};

/** @override */TestStreamInterceptor.prototype.intercept = function(request, invoker) { return new InterceptedStream(invoker(request));};


绑定拦截器

通过使用适当的Option键传递拦截器实例数组,可以在实例化客户端时将拦截器绑定到客户端:


const promiseClient = new MyServicePromiseClient( host, creds, {'unaryInterceptors': [interceptor1, interceptor2, interceptor3]});

const client = new MyServiceClient( host, creds, {'streamInterceptors': [interceptor1, interceptor2, interceptor3]});

注:拦截器的执行顺序与请求处理和响应处理的顺序相反,如下所示:



反馈

发现grpc-web有问题还是需要功能?通过grpc-web仓库提交问题。如果你有一般性的问题或意见,请考虑发布到gRPC邮件列表或向我们发送电子邮件至gRPC-web-team@google.com

https://github.com/grpc/grpc-web/issues/new

https://groups.google.com/forum/#!forum/grpc-io


点击【阅读原文】阅读英文原文。




gRPC-Web中的拦截器

2020年7月30日-8月1日


gRPC-Web中的拦截器

gRPC-Web中的拦截器

gRPC-Web中的拦截器


gRPC-Web中的拦截器

扫码免费注册


gRPC-Web中的拦截器大会网站,https://cncf.lfasiallc.cn/


扫描二维码联系我们!




CNCF (Cloud Native Computing Foundation)成立于2015年12月,隶属于Linux  Foundation,是非营利性组织。 

CNCF云原生计算基金会)致力于培育和维护一个厂商中立的开源生态系统,来推广云原生技术。我们通过将最前沿的模式民主化,让这些创新为大众所用。请长按以下二维码进行关注。

版权声明:本站内容全部来自于腾讯微信公众号,属第三方自助推荐收录。《gRPC-Web中的拦截器》的版权归原作者「CNCF」所有,文章言论观点不代表Lambda在线的观点, Lambda在线不承担任何法律责任。如需删除可联系QQ:516101458

文章来源: 阅读原文

相关阅读

关注CNCF微信公众号

CNCF微信公众号:lf_cncf

CNCF

手机扫描上方二维码即可关注CNCF微信公众号

CNCF最新文章

精品公众号随机推荐

上一篇 >>

Flask网页记账

下一篇 >>

死啃Zabbix系列