facebook/swift:构建thrift http server(3)--CORS跨域

╰半夏微凉° 2022-02-05 03:55 221阅读 0赞

[《facebook/swift:构建thrift http server(1)》][facebook_swift_thrift http server_1]  
[《facebook/swift:构建thrift http server(2)–HttpServerCodec》][facebook_swift_thrift http server_2_HttpServerCodec]  
接续前面的文章

# 测试 #

在上一篇文章中我已经通过替换`frameCodec`为`HttpServerCodec`将`ThriftServer`改造为可以接收HTTP响应的netty server。完成代码修改后，赶紧用浏览器测试一下:  
test\_js.html代码如下：

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
    <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    <head>
      <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
      <title>Thrift Javascript Test</title>
    
      <script src="build/js/thrift.js"         type="text/javascript" charset="utf-8"></script>
      <script src="gen-js/IFaceLog_types.js" type="text/javascript" charset="utf-8"></script>
      <script src="gen-js/IFaceLog.js"       type="text/javascript" charset="utf-8"></script>
    
      
      <script src="https://cdn.bootcss.com/jquery/1.10.0/jquery.min.js"></script>
    
    
      <script>
        // 连接facelog XHR服务
        var transport = new Thrift.Transport("http://localhost:26412");
        var protocol  = new Thrift.Protocol(transport);
        var client    = new IFaceLogClient(protocol);
    
      </script>
    </head>
    <body>
      <h1 id="qunit-header">Thrift Javascript Test: </h1>
      <script>
        // 调用version接口方法
        client.version((res)=>{
         
          $('.hint-version').append('version:' + res ) 
      </script>
      <div>
        RESPONSE:
        <p class="hint-version"></p>
      </div>
    </body>
    </html>

打开测试页面后，发出XHR请求后，服务端却没有响应，也没有报错。测试页面一直处于pending状态。

通过在服务端添加断点，拦截到了前端发出的第一个http请求，找到了原因，如下图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0LzEwa20_size_16_color_FFFFFF_t_70]  
通过拦截到的这个已经解码成`DefaultHttpRequest`对象的HTTP请求，至少可以判断替换的`HttpServerCodec`编解码器已经生效了，但这第一个HTTP请求居然不是浏览器端发出的`POST`,而是我不认识的`OPTIONS`，何解？这就引出了XHR请求的另一个问题CORS  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0LzEwa20_size_16_color_FFFFFF_t_70 1]

# CORS跨域问题 #

对于HTTP协议，我们最熟悉的最常用HTTP 请求是POST,GET这些，`OPTIONS`是啥，没见过，唉学艺不精啊。  
赶紧去百度查，原来是跨域资源共享(CORS) 。

> 关于CORS,参见  
> [《HTTP访问控制（CORS）》][HTTP_CORS]  
> [《HTTP的请求方法OPTIONS》][HTTP_OPTIONS]  
> [《http请求，多一次OPTIONS请求(CORS跨域)》][http_OPTIONS_CORS]

看了上面这些文章，我大概明白了，因为test\_js.html网页文件与`http://localhost:26412`不同源，所以Preflighted Requests(预检请求)机制被激活。  
Preflighted Requests是CORS中一种透明服务器验证机制。预检请求首先需要向另外一个域名的资源发送一个 HTTP OPTIONS 请求头，其目的就是为了判断实际发送的请求是否是安全的。  
而我的netty http server并没有响应CORS的机制，所以没有响应这个OPTIONS请求。

## CorsHandler ##

那么现在的问题变成了如何响应OPTIONS请求?或者说是如何解决CORS跨域问题？

下面这篇文章提供了思路，  
[《Netty HTTP 请求允许跨域》][Netty HTTP]

但是我还是觉得好麻烦，要自己根据CORS的原理写代码。就没有现成的解决方案嘛？

有，[io.netty.handler.codec.http.cors.CorsHandler][]这个`ChannelHandler`接口实例就是用于响应CORS请求的。

> 更详细的说明参见[io.netty.handler.codec.http.cors][]

关于`CorsHandler`的使用示例也找到了，只要`CorsHandler`添加到ChannelPipeline中，就可以了：  
[《Java Code Examples for io.netty.handler.codec.http.cors.CorsHandler》][Java Code Examples for io.netty.handler.codec.http.cors.CorsHandler]

看到这个代码，好激动，不用写太多代码就能解决问题。  
然而再深入了解，发现问题不简单：netty的版本问题

## Netty3CorsHandler ##

`io.netty.handler.codec.http.cors.CorsHandler`是netty 4.0以后的版本提供的类，在netty 3中并不存在。而`facebook/swift`框架是基于netty3的，更重要的是netty3和netty4并不兼容(package都不一样了)，所以不能升级`facebook/swift`框架依赖的netty版本，也不可以简单的将`CorsHandler`的相关源码复制出来使用。

看到吃不到，好恼火，要把netty4的`CorsHandler`实现移植到netty3，需要对netty4和netty3都非常了解才行。这方面我是小白，完全不能胜任啊。  
就没有现成的解决方案么？我又在google上一通找，居然让我找到了这个  
[org.elasticsearch.http.netty3.cors.Netty3CorsHandler][],天助我也，原来有人已经实现了。

这个`Netty3CorsHandler`已经实现了对OPTIONS请求的响应，已经比较完备，只是用JAVA 8写的，我改成了适合JDK1.7编译的版本，

> 参见我修改的JDK 1.7版本：[org.jboss.netty3.handler.codec.http.cors][]

# 改造NettyServerTransport #

解决CORS问题的`Netty3CorsHandler`现在有了，但怎么将`Netty3CorsHandler`添加到`NettyServerTransport`的`ChannelPipeline`中呢？  
[facebook/swift/swift-service][facebook_swift_swift-service]的[com.facebook.swift.service.ThriftServer][]类的作用是将thrift服务实例(封装为`NiftyProcessor`接口实例,thrift实现类为`ThriftServiceProcessor`)进一步封装为一个可以启动的Netty server。

下面是eclipse中以大纲模式看到的`ThriftServer`类的全貌，可以看到关键的`NettyServerTransport`实例作为私有成员常量`transport`，且并没有提供可供外部读取的方法。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0LzEwa20_size_16_color_FFFFFF_t_70 2]  
看到这些，我们发现`ThriftServer`并没有向外部提供可以获取成员`transport`，也就无法通过常规方法获取`NettyServerTransport`实例。  
同样在`NettyServerTransport`类中负责定义`ChannelPipeline`的`pipelineFactory`也是一个私有成员，没有提供外部访问的方法。如下图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0LzEwa20_size_16_color_FFFFFF_t_70 3]  
现在问题来了，如何在外部修改`ChannelPipeline`的`ChannelHandler`队列呢？  
我不想把`ThriftServer`和`NettyServerTransport`类重写一遍，那样加增加日后的维护工作量，我的办法就是用java反射(reflect)技术把`NettyServerTransport`的`pipelineFactory`的实例偷出来，修改后再把它放回去。

/**
    	 * 反射获取{@code object}的私有成员
    	 * @param object
    	 * @param name
    	 * @return 成员对象
    	 */
    	@SuppressWarnings("unchecked")
    	public static <T> T valueOfField(Object object,String name){
        
    		try {
        
    			Field field = checkNotNull(object,"object is null").getClass().getDeclaredField(checkNotNull(name,"name is null"));
    			field.setAccessible(true);
    			return (T) field.get(object);
    		} catch (Exception e) {
        
    			Throwables.throwIfUnchecked(e);
    			throw new RuntimeException(e);
    		}
    	}
    	/**
    	 * 添加CORS handler
    	 */
    	protected void addCorsHandlerIfHttp(){
        
    		if(HTTP_TRANSPORT.equals(thriftServerConfig.getTransportName())){
        
    			try {
        
    				// 反射获取私有的成员NettyServerTransport
    				final NettyServerTransport nettyServerTransport = valueOfField(thriftServer, "transport");
    				// 反射获取私有的成员ChannelPipelineFactory
    				Field pipelineFactory = NettyServerTransport.class.getDeclaredField("pipelineFactory");
    				{
        
    					Field modifiersField = Field.class.getDeclaredField("modifiers");
    					modifiersField.setAccessible(true); //Field 的 modifiers 是私有的
    					modifiersField.setInt(pipelineFactory, pipelineFactory.getModifiers() & ~Modifier.FINAL);
    				}
    				pipelineFactory.setAccessible(true);
    				final ChannelPipelineFactory channelPipelineFactory = (ChannelPipelineFactory) pipelineFactory.get(nettyServerTransport);
    				// 设置CORS 参数
    				final Netty3CorsConfig corsConfig = Netty3CorsConfigBuilder.forAnyOrigin()
    					.allowedRequestMethods(POST,GET,OPTIONS)
    					.allowedRequestHeaders("Origin","Content-Type","Accept","application","x-requested-with")
    					.build();
    				ChannelPipelineFactory factoryWithCORS = new ChannelPipelineFactory(){
        
    
    					@Override
    					public ChannelPipeline getPipeline() throws Exception {
        
    						// 修改 ChannelPipeline,在frameCodec后(顺序)增加CORS handler
    						ChannelPipeline cp = channelPipelineFactory.getPipeline();
    						cp.addAfter("frameCodec", "cors", new Netty3CorsHandler(corsConfig));
    						return cp;
    					}};
    				// 修改nettyServerTransport的私有常量pipelineFactory
    				pipelineFactory.set(nettyServerTransport, factoryWithCORS);
    			} catch (Exception e) {
        
    				Throwables.throwIfUnchecked(e);
    				throw new RuntimeException(e);
    			}
    		}
    	}

修改完成后再次测试，已经可以正常响应OPTION请求了。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0LzEwa20_size_16_color_FFFFFF_t_70 4]  
然而真正的POST请求还是没有响应  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0LzEwa20_size_16_color_FFFFFF_t_70 5]

看来问题还是没有彻底解决，下一篇文章继续。

[《facebook/swift:构建thrift http server(4)–ThriftXHRDecoder,ThriftXHREncoder》][facebook_swift_thrift http server_4_ThriftXHRDecoder_ThriftXHREncoder]

[facebook_swift_thrift http server_1]: https://blog.csdn.net/10km/article/details/89792184
[facebook_swift_thrift http server_2_HttpServerCodec]: https://blog.csdn.net/10km/article/details/89810011
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0LzEwa20_size_16_color_FFFFFF_t_70]: /images/20220205/11ce47ead4734eeab27ccad6160f5bf1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0LzEwa20_size_16_color_FFFFFF_t_70 1]: /images/20220205/494b1d9b57834a3bbb8b10c53eea8bab.png
[HTTP_CORS]: https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Access_control_CORS
[HTTP_OPTIONS]: https://blog.csdn.net/leikezhu1981/article/details/7402272
[http_OPTIONS_CORS]: https://blog.csdn.net/qq_20473985/article/details/86478391
[Netty HTTP]: https://blog.csdn.net/chy2z/article/details/80104161
[io.netty.handler.codec.http.cors.CorsHandler]: https://netty.io/4.1/api/io/netty/handler/codec/http/cors/CorsHandler.html
[io.netty.handler.codec.http.cors]: https://netty.io/4.1/api/io/netty/handler/codec/http/cors/package-summary.html
[Java Code Examples for io.netty.handler.codec.http.cors.CorsHandler]: https://www.programcreek.com/java-api-examples/index.php?api=io.netty.handler.codec.http.cors.CorsHandler
[org.elasticsearch.http.netty3.cors.Netty3CorsHandler]: https://github.com/coding0011/elasticsearch/tree/master/modules/transport-netty3/src/main/java/org/elasticsearch/http/netty3/cors
[org.jboss.netty3.handler.codec.http.cors]: https://gitee.com/l0km/common-java/tree/master/common-thrift/src/main/java/org/jboss/netty3/handler/codec/http/cors
[facebook_swift_swift-service]: https://github.com/facebookarchive/swift/tree/swift-root-0.14.2/swift-service
[com.facebook.swift.service.ThriftServer]: https://github.com/facebookarchive/swift/blob/swift-root-0.14.2/swift-service/src/main/java/com/facebook/swift/service/ThriftServer.java
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0LzEwa20_size_16_color_FFFFFF_t_70 2]: /images/20220205/9e0d9f074dab48eebcaf8747c8d3cd39.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0LzEwa20_size_16_color_FFFFFF_t_70 3]: /images/20220205/431c8d5e448a4086a585a50ca04316bc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0LzEwa20_size_16_color_FFFFFF_t_70 4]: /images/20220205/8d9f33b8a82847bfbe9b61c394346eba.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0LzEwa20_size_16_color_FFFFFF_t_70 5]: /images/20220205/286e0be6a91c466ebb44e4fa6c3ebda7.png
[facebook_swift_thrift http server_4_ThriftXHRDecoder_ThriftXHREncoder]: https://blog.csdn.net/10km/article/details/89819201