Swift：Thrift Java注解支持

Posted Future的博客

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Swift：Thrift Java注解支持相关的知识，希望对你有一定的参考价值。

Swift is an easy-to-use, annotation-based Java library for creating Thrift serializable types and services.

Facebook开源了Thrift相关的其他两个项目： Nifty 和 Swift ； 对于纯Java应用开发者来说，相对于编写Thrift IDL，我们可能更倾向于写Java Bean或者Service，Swift项目提供了Thrift Java注解支持，提高了开发效率；

Swift使用示例

下面以ThirdPartyCollectionService.thrift为例，编写完IDL文件还需要编译生成Java代码导入到项目中：

 
   
   
 
    
  
    
    
  
  1. struct ThirdPartyCollection {
    2. 
  
    
    
  
  2.     1: required i32 id;
    3. 
  
    
    
  
  3.     2: optional string data;
    4. 
  
    
    
  
  4. }
    5. 
  
    
    
  
    6. 
  
    
    
  
  6. service ThirdPartyCollectionService {
    7. 
  
    
    
  
  7.     string save(1: ThirdPartyCollection collection)
    8. 
  
    
    
  
  8. }
    9.

假如使用Swift注解，只需要在对应的Java Bean和Service打上相应的注解即可(具体的使用方法请参考官方文档)。参考如下：

 
   
   
 
    
  
    
    
  
  1. @ThriftStruct
    2. 
  
    
    
  
  2. public final class ThirdPartyCollection {
    3. 
  
    
    
  
  3.     public final long id; // required
    4. 
  
    
    
  
  4.     public final String date; // optional
    5. 
  
    
    
  
    6. 
  
    
    
  
  6.     @ThriftConstructor
    7. 
  
    
    
  
  7.     public ThirdPartyCollection(long id, String date) {
    8. 
  
    
    
  
  8.         this.id = id;
    9. 
  
    
    
  
  9.         this.date = date;
    10. 
  
    
    
  
  10.     }
    11. 
  
    
    
  
  11.     @ThriftField(1)
    12. 
  
    
    
  
  12.     public long getId() {
    13. 
  
    
    
  
  13.         return id;
    14. 
  
    
    
  
  14.     }
    15. 
  
    
    
  
  15.     @ThriftField(2)
    16. 
  
    
    
  
  16.     public String getDate() {
    17. 
  
    
    
  
  17.         return date;
    18. 
  
    
    
  
  18.     }
    19. 
  
    
    
  
  19. }
    20. 
  
    
    
  
    21. 
  
    
    
  
  21. @ThriftService("ThirdPartyCollectionService")
    22. 
  
    
    
  
  22. public interface ThirdPartyCollectionService {
    23. 
  
    
    
  
  23.     @ThriftMethod
    24. 
  
    
    
  
  24.     String save(@ThriftField(name = "collection") ThirdPartyCollection collection);
    25. 
  
    
    
  
  25. }
    26.

那么具体怎么使用Swift来编写RPC的Client和Server呢（其实Swift底层依赖了Nifty，扩展了Nifty来支持RPC调用），具体参考如下：

引入POM依赖

 
   
   
 
    
  
    
    
  
  1. <dependency>
    2. 
  
    
    
  
  2.     <groupId>com.facebook.swift</groupId>
    3. 
  
    
    
  
  3.     <artifactId>swift-service</artifactId>
    4. 
  
    
    
  
  4.     <version>0.18.0</version>
    5. 
  
    
    
  
  5. </dependency>
    6.

RPC Server

 
   
   
 
    
  
    
    
  
  1. public class ThirdPartyCollectionServiceImpl implements ThirdPartyCollectionService {
    2. 
  
    
    
  
  2.     public String save(@ThriftField(name = "collection") ThirdPartyCollection collection) {
    3. 
  
    
    
  
  3.         System.out.println(collection.toString());
    4. 
  
    
    
  
  4.         return "Success";
    5. 
  
    
    
  
  5.     }
    6. 
  
    
    
  
  6. }
    7. 
  
    
    
  
  7. public class ServerDemo {
    8. 
  
    
    
  
  8.     public static void main(String[] args) throws IOException, InterruptedException {
    9. 
  
    
    
  
  9.         ThriftServiceProcessor processor = new ThriftServiceProcessor(
    10. 
  
    
    
  
  10.                 new ThriftCodecManager(),
    11. 
  
    
    
  
  11.                 ImmutableList.<ThriftEventHandler>of(),
    12. 
  
    
    
  
  12.                 new ThirdPartyCollectionServiceImpl()
    13. 
  
    
    
  
  13.         );
    14. 
  
    
    
  
  14.         ExecutorService taskWorkerExecutor = Executors.newFixedThreadPool(1);
    15. 
  
    
    
  
  15.         ThriftServerDef serverDef = ThriftServerDef.newBuilder()
    16. 
  
    
    
  
  16.                 .listen(8899)
    17. 
  
    
    
  
  17.                 .withProcessor(processor)
    18. 
  
    
    
  
  18.                 .using(taskWorkerExecutor)
    19. 
  
    
    
  
  19.                 .build();
    20. 
  
    
    
  
    21. 
  
    
    
  
  21.         ExecutorService bossExecutor = Executors.newCachedThreadPool();
    22. 
  
    
    
  
  22.         ExecutorService ioWorkerExecutor = Executors.newCachedThreadPool();
    23. 
  
    
    
  
    24. 
  
    
    
  
  24.         NettyServerConfig serverConfig = NettyServerConfig.newBuilder()
    25. 
  
    
    
  
  25.                 .setBossThreadExecutor(bossExecutor)
    26. 
  
    
    
  
  26.                 .setWorkerThreadExecutor(ioWorkerExecutor)
    27. 
  
    
    
  
  27.                 .build();
    28. 
  
    
    
  
    29. 
  
    
    
  
  29.         ThriftServer server = new ThriftServer(serverConfig, serverDef);
    30. 
  
    
    
  
  30.         server.start();
    31. 
  
    
    
  
  31.     }
    32. 
  
    
    
  
  32. }
    33.

RPC Client

 
   
   
 
    
  
    
    
  
  1. public class ClientDemo {
    2. 
  
    
    
  
    3. 
  
    
    
  
  3.     public static void main(String[] args) throws ExecutionException, InterruptedException {
    4. 
  
    
    
  
  4.         ThriftClientManager clientManager = new ThriftClientManager();
    5. 
  
    
    
  
  5.         FramedClientConnector connector = new FramedClientConnector(new InetSocketAddress("localhost",8899));
    6. 
  
    
    
  
  6.         ThirdPartyCollectionService service = clientManager.createClient(connector, ThirdPartyCollectionService.class).get();
    7. 
  
    
    
  
  7.         String result = service.save(new ThirdPartyCollection(1001, "2014-08-29"));
    8. 
  
    
    
  
  8.         System.out.println(result);
    9. 
  
    
    
  
  9.     }
    10. 
  
    
    
  
  10. }
    11.

Swift进阶

有些RPC中间件基于Thrift进行了二次开发，那此时怎么在自己的组件里支持Thrift注解呢？ 首先引入swift-service依赖，改写ThriftMethodHandler和ThriftMethodProcessor两个类即可； 下面是用Swift模拟Client发送消息，Server接受消息处理并返回的关键代码：

 
   
   
 
    
  
    
    
  
  1. public class SerializeTest {
    2. 
  
    
    
  
    3. 
  
    
    
  
  3.     private static final AtomicInteger sequenceId = new AtomicInteger(1);
    4. 
  
    
    
  
  4.     private static Map<Method, ThriftMethodHandler> thriftMethodHandlerMap;
    5. 
  
    
    
  
  5.     private static Map<String, ThriftMethodProcessor> thriftMethodProcessorMap;
    6. 
  
    
    
  
    7. 
  
    
    
  
  7.     public static void main(String[] args) throws Throwable {
    8. 
  
    
    
  
    9. 
  
    
    
  
  9.         Class clazz = Class.forName("com.example.gs.ThirdPartyCollectionService");
    10. 
  
    
    
  
  10.         Object service = new ThirdPartyCollectionServiceImpl();
    11. 
  
    
    
  
  11.         Object arg = new ThirdPartyCollection(1001, "2014-08-29");
    12. 
  
    
    
  
    13. 
  
    
    
  
  13.         //初始化
    14. 
  
    
    
  
  14.         thriftMethodHandlerMap = createThriftMethodHandlerMap(clazz);
    15. 
  
    
    
  
  15.         thriftMethodProcessorMap = createThriftMethodProcessorMap(clazz, service);
    16. 
  
    
    
  
    17. 
  
    
    
  
  17.         //调用ThirdPartyCollectionService的save方法
    18. 
  
    
    
  
  18.         Method method = clazz.getMethod("save", ThirdPartyCollection.class);
    19. 
  
    
    
  
  19.         ThriftMethodHandler methodHandler = thriftMethodHandlerMap.get(method);
    20. 
  
    
    
  
    21. 
  
    
    
  
  21.         byte[] data;
    22. 
  
    
    
  
  22.         data = clientSend(methodHandler, arg);
    23. 
  
    
    
  
  23.         data = serverProcess(data);
    24. 
  
    
    
  
  24.         Object result = clientReceive(data, methodHandler);
    25. 
  
    
    
  
  25.         System.out.println("Response:" + result);
    26. 
  
    
    
  
  26.     }
    27. 
  
    
    
  
    28. 
  
    
    
  
  28.     /**
    29. 
  
    
    
  
  29.      * 创建client用到的ThriftMethodHandler
    30. 
  
    
    
  
  30.      * @return
    31. 
  
    
    
  
  31.      */
    32. 
  
    
    
  
  32.     public static Map<Method, ThriftMethodHandler> createThriftMethodHandlerMap(Class clazz) {
    33. 
  
    
    
  
  33.         ThriftCodecManager codecManager = new ThriftCodecManager();
    34. 
  
    
    
  
  34.         ThriftServiceMetadata thriftServiceMetadata = new ThriftServiceMetadata(clazz, codecManager.getCatalog());
    35. 
  
    
    
  
  35.         ImmutableMap.Builder<Method, ThriftMethodHandler> methods = ImmutableMap.builder();
    36. 
  
    
    
  
  36.         for (ThriftMethodMetadata methodMetadata : thriftServiceMetadata.getMethods().values()) {
    37. 
  
    
    
  
  37.             ThriftMethodHandler thriftMethodHandler = new ThriftMethodHandler(methodMetadata, codecManager);
    38. 
  
    
    
  
  38.             methods.put(methodMetadata.getMethod(), thriftMethodHandler);
    39. 
  
    
    
  
  39.         }
    40. 
  
    
    
  
  40.         Map<Method, ThriftMethodHandler> thriftMethodHandlerMap = methods.build();
    41. 
  
    
    
  
  41.         return thriftMethodHandlerMap;
    42. 
  
    
    
  
  42.     }
    43. 
  
    
    
  
    44. 
  
    
    
  
  44.     /**
    45. 
  
    
    
  
  45.      * 创建server用到的ThriftMethodProcessor
    46. 
  
    
    
  
  46.      * @return
    47. 
  
    
    
  
  47.      */
    48. 
  
    
    
  
  48.     public static Map<String, ThriftMethodProcessor> createThriftMethodProcessorMap(Class clazz, Object service) {
    49. 
  
    
    
  
  49.         ThriftCodecManager codecManager = new ThriftCodecManager();
    50. 
  
    
    
  
  50.         ThriftServiceMetadata thriftServiceMetadata = new ThriftServiceMetadata(clazz, codecManager.getCatalog());
    51. 
  
    
    
  
  51.         Map<String, ThriftMethodProcessor> processorMap = newHashMap();
    52. 
  
    
    
  
  52.         for (ThriftMethodMetadata methodMetadata : thriftServiceMetadata.getMethods().values()) {
    53. 
  
    
    
  
  53.             String methodName = methodMetadata.getName();
    54. 
  
    
    
  
  54.             ThriftMethodProcessor methodProcessor = new ThriftMethodProcessor(service, thriftServiceMetadata.getName(), methodMetadata, codecManager);
    55. 
  
    
    
  
  55.             if (processorMap.containsKey(methodName)) {
    56. 
  
    
    
  
  56.                 throw new IllegalArgumentException("Multiple @ThriftMethod-annotated methods named '" + methodName + "' found in the given services");
    57. 
  
    
    
  
  57.             }
    58. 
  
    
    
  
  58.             processorMap.put(methodName, methodProcessor);
    59. 
  
    
    
  
  59.         }
    60. 
  
    
    
  
  60.         Map<String, ThriftMethodProcessor> thriftMethodProcessorMap = ImmutableMap.copyOf(processorMap);
    61. 
  
    
    
  
  61.         return thriftMethodProcessorMap;
    62. 
  
    
    
  
  62.     }
    63. 
  
    
    
  
    64. 
  
    
    
  
  64.     public static byte[] clientSend(ThriftMethodHandler methodHandler, Object... args) {
    65. 
  
    
    
  
  65.         ByteArrayOutputStream out = new ByteArrayOutputStream(1024);
    66. 
  
    
    
  
  66.         TiostreamTransport transport = new TIOStreamTransport(out);
    67. 
  
    
    
  
  67.         TProtocol outProtocol = new TBinaryProtocol.Factory().getProtocol(transport);
    68. 
  
    
    
  
  68.         try {
    69. 
  
    
    
  
  69.             methodHandler.send(outProtocol, sequenceId.getAndIncrement(), args);
    70. 
  
    
    
  
  70.         } catch (Exception e) {
    71. 
  
    
    
  
  71.             e.printStackTrace();
    72. 
  
    
    
  
  72.         }
    73. 
  
    
    
  
  73.         return out.toByteArray();
    74. 
  
    
    
  
  74.     }
    75. 
  
    
    
  
    76. 
  
    
    
  
  76.     public static byte[] serverProcess(byte[] data) {
    77. 
  
    
    
  
  77.         TProtocol in = new TBinaryProtocol.Factory().getProtocol(new TIOStreamTransport(new ByteArrayInputStream(data)));
    78. 
  
    
    
  
  78.         TMessage message = null;
    79. 
  
    
    
  
  79.         try {
    80. 
  
    
    
  
  80.             message = in.readMessageBegin();
    81. 
  
    
    
  
  81.         } catch (TException e) {
    82. 
  
    
    
  
  82.             e.printStackTrace();
    83. 
  
    
    
  
  83.         }
    84. 
  
    
    
  
  84.         int sequenceId = message.seqid;
    85. 
  
    
    
  
  85.         String methodName = message.name;
    86. 
  
    
    
  
    87. 
  
    
    
  
  87.         ThriftMethodProcessor methodProcessor = thriftMethodProcessorMap.get(methodName);
    88. 
  
    
    
  
    89. 
  
    
    
  
  89.         ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream(1024);
    90. 
  
    
    
  
  90.         TIOStreamTransport transport = new TIOStreamTransport(byteArrayOutputStream);
    91. 
  
    
    
  
  91.         TProtocol out = new TBinaryProtocol.Factory().getProtocol(transport);
    92. 
  
    
    
  
    93. 
  
    
    
  
  93.         try {
    94. 
  
    
    
  
  94.             methodProcessor.process(in, out, sequenceId);
    95. 
  
    
    
  
  95.         } catch (Throwable t) {
    96. 
  
    
    
  
  96.             t.printStackTrace();
    97. 
  
    
    
  
  97.         }
    98. 
  
    
    
  
    99. 
  
    
    
  
  99.         return byteArrayOutputStream.toByteArray();
    100. 
  
    
    
  
  100.     }
    101. 
  
    
    
  
    102. 
  
    
    
  
  102.     public static Object clientReceive(byte[] data, ThriftMethodHandler methodHandler) {
    103. 
  
    
    
  
  103.         TProtocol in = new TBinaryProtocol.Factory().getProtocol(new TIOStreamTransport(new ByteArrayInputStream(data)));
    104. 
  
    
    
  
  104.         Object result = null;
    105. 
  
    
    
  
  105.         try {
    106. 
  
    
    
  
  106.             result = methodHandler.receive(in, sequenceId.get() - 1);
    107. 
  
    
    
  
  107.         } catch (Exception e) {
    108. 
  
    
    
  
  108.             e.printStackTrace();
    109. 
  
    
    
  
  109.         }
    110. 
  
    
    
  
  110.         return result;
    111. 
  
    
    
  
  111.     }
    112. 
  
    
    
  
  112. }
    113.

此外还有一点需要说明的是，swift-service依赖jdk8，如果自己的RPC组件暂不能升级到jdk8，那该怎么办呢？ 其实也很简单，只需要引入swift-codec和swift-annotations两个依赖（无需引入swift-service），同时把swift-service中的ThriftMethodMetadata和ThriftServiceMetadata拷贝到自己的项目里面，这样就可以不用升级jdk8也能使用Swift提供的注解功能； Swift本身还有很多组件，比如swift-idl-parser、swift-generator等，感兴趣的读者可以参考官方文档继续深入学习！ 本文完整示例代码可参考：https://github.com/gaosheng/ThriftWithSwiftDemo

以上是关于Swift：Thrift Java注解支持的主要内容，如果未能解决你的问题，请参考以下文章

Thrift 代码分析

Thrift安装介绍

Apache Thrift系列详解- 概述与入门

Thrift介绍以及Java中使用Thrift实现RPC示例

Thrift架构介绍

Apache Thrift 的使用