netty系列之:在netty中处理CORS
[toc]
简介
CORS的全称是跨域资源共享,他是一个基于HTTP-header检测的机制,通过对HTTP-header进行控制,可以实现对跨域资源的权限管理功能。在之前的CORS详解文章中,我们已经对CORS有了基本的解释。
本文将会从netty的实现角度,讲解如何在netty中实现CORS。
服务端的CORS配置
熟悉CORS的朋友应该知道,CORS所有的操作都是在HTTP协议之上通过控制HTTP头来实现的。所以说如果要在服务器端实现CORS的支持,事实上也是对HTTP协议的头进行各种设置完成的。
为了方便大家的使用,netty提供了一个CorsConfig类,来统一CORS的头设置。
先看下CorsConfig类中定义的属性:
private final Set<String> origins; private final boolean anyOrigin; private final boolean enabled; private final Set<String> exposeHeaders; private final boolean allowCredentials; private final long maxAge; private final Set<HttpMethod> allowedRequestMethods; private final Set<String> allowedRequestHeaders; private final boolean allowNullOrigin; private final Map<CharSequence, Callable<?>> preflightHeaders; private final boolean shortCircuit;
这些属性和CORS的HTTP头设置是一一对应的。比如说origins表示的是允许的源,anyOrigin表示允许所有的源。
是和下面的设置对应的:
Origin: <origin>
exposeHeaders是和Access-Control-Expose-Headers一一对应的,表示服务器端允许客户端获取CORS资源的同时能够访问到的header信息。其格式如下:
Access-Control-Expose-Headers: <header-name>[, <header-name>]*
allowCredentials表示是否开启CORS的权限认证。表示服务器端是否接受客户端带有credentials字段的请求。如果用在preflight请求中,则表示后续的真实请求是否支持credentials,其格式如下:
Access-Control-Allow-Credentials: true
allowedRequestMethods表示访问资源允许的方法,主要用在preflight request中。其格式如下:
Access-Control-Allow-Methods: <method>[, <method>]*
allowedRequestHeaders用在preflight request中,表示真正能够被用来做请求的header字段,其格式如下:
Access-Control-Allow-Headers: <header-name>[, <header-name>]*
当客户端发送OPTIONS方法给服务器的时候,为了安全起见,因为服务器并不一定能够接受这些OPTIONS的方法,所以客户端需要首先发送一个 preflighted requests,等待服务器响应,等服务器确认之后,再发送真实的请求。我们举一个例子。preflightHeaders表示的就是服务器允许额preflight的请求头。
shortCircuit表示请求是否是一个有效的CORS请求,如果请求被拒绝之后,就会返回一个true。
CorsConfigBuilder
CorsConfig使用来表示Cors的配置类,那么怎么去构造这个配置类呢?我们看下CorsConfig的构造函数:
CorsConfig(final CorsConfigBuilder builder) { origins = new LinkedHashSet<String>(builder.origins); anyOrigin = builder.anyOrigin; enabled = builder.enabled; exposeHeaders = builder.exposeHeaders; allowCredentials = builder.allowCredentials; maxAge = builder.maxAge; allowedRequestMethods = builder.requestMethods; allowedRequestHeaders = builder.requestHeaders; allowNullOrigin = builder.allowNullOrigin; preflightHeaders = builder.preflightHeaders; shortCircuit = builder.shortCircuit; }
可以看到CorsConfig是通过CorsConfigBuilder来构造的。通过设置CorsConfigBuilder中的各种属性即可。CorsConfigBuilder中提供了多种设置属性的方法。
可以使用这样的方法来构造CorsConfig如下:
CorsConfig corsConfig = CorsConfigBuilder.forAnyOrigin().allowNullOrigin().allowCredentials().build();
CorsHandler
有了corsConfig,我们还需要将这个config配置在netty的handler中,netty提供了一个CorsHandler类来专门处理corsConfig,这个类就叫CorsHandler。
首先看下CorsHandler的构造函数:
public CorsHandler(final CorsConfig config) { this(Collections.singletonList(checkNotNull(config, "config")), config.isShortCircuit()); } public CorsHandler(final List<CorsConfig> configList, boolean isShortCircuit) { checkNonEmpty(configList, "configList"); this.configList = configList; this.isShortCircuit = isShortCircuit; }
CorsHandler有两个构造函数,一个是传入CorsConfig,一个是传入一个CorsConfig的列表。
CorsHandler的主要工作原理就是在channelRead的时候,对responseHeader进行处理,设置CORS头。
netty对cors的支持
上面我们已经讲过了netty中cors的核心类和方法,最后一步就是把cors的支持类加入到netty的pipeline中,其核心代码如下:
public void initChannel(SocketChannel ch) { ChannelPipeline pipeline = ch.pipeline(); pipeline.addLast(new HttpResponseEncoder()); pipeline.addLast(new HttpRequestDecoder()); pipeline.addLast(new HttpObjectAggregator(65536)); pipeline.addLast(new ChunkedWriteHandler()); CorsConfig corsConfig = CorsConfigBuilder.forAnyOrigin().allowNullOrigin().allowCredentials().build();pipeline.addLast(new CorsHandler(corsConfig)); pipeline.addLast(new CustResponseHandler()); }
总结
cors比较简单,netty也为其提供了住够的方法支持。大家可以直接使用。
本文的例子可以参考:learn-netty4
本文已收录于 http://www.flydean.com/22-netty-cors/
最通俗的解读,最深刻的干货,最简洁的教程,众多你不知道的小技巧等你来发现!
欢迎关注我的公众号:「程序那些事」,懂技术,更懂你!
- 搭建服务器处理系统(基于netty)-我们到底能走多远系列(25)
- SpringBoot2.x系列:整合SpringMVC之CORS跨域访问处理(下)
- SpringBoot2.x系列:整合SpringMVC之CORS跨域访问处理(上)
- Kafka源码系列之Broker的IO服务及业务处理
- 数学之美 系列十八 - 矩阵运算和文本处理中的分类问题
- 网页加速系列(一)、 网页加速之图形处理篇
- TCP的核心系列 — ACK的处理(一)
- 深入Atlas系列:Web Sevices Access in Atlas示例(7) - 编写JavaScriptConverter处理含有循环引用的类型
- 自定义View系列教程06--详解View的Touch事件处理
- SpringBoot2.x系列:整合SpringMVC之错误处理深度定制实现
- Linux 系列(二) - 文本处理 [ 光影人像 东海陈光剑 的博客 ]
- php基础系列----8php中错误和异常的处理
- 【云星数据---Apache Flink实战系列(精品版)】:Apache Flink实战基础002--flink特性:流处理特性介绍
- .NET互操作性入门系列(三):平台调用中的数据封送处理
- 《Flash建站技术》系列5-数据提交与表单处理
- C#进阶系列——WebApi 跨域问题解决方案:CORS
- 数据库分库分表(sharding)系列(四) 多数据源的事务处理
- 图像处理算法系列 第三章 图像模糊处理 (平滑处理)
- netty处理粘包问题用特殊字符分割——3
- 数学之美 系列三 -- 隐含马尔可夫模型在语言处理中的应用(转载) 发表者:吴军,Google 研究员