找回密码
当前位置：Mikel > 开发笔记 > Java > 正文

springMVC项目中实现Protocol Buffers对象自动转换 - fangzhangsc2006的专栏 - CSDN博客

2017-07-10 分类：Java 阅读(957) 评论(0)

本文旨在向读者分享springMVC项目中Protocol Buffers的一个使用技巧，前提是需要具备对springMVC和Protocol Buffers的基本了解。Protocol Buffers（以下简称PB）是谷歌推出的一种数据交换格式，高效、易扩展、跨语言（C++, Java, Python）。将它用于网络传输是一个不错的选择。我们服务器与客户端的通讯就是使用它来做序列化与反序

来源： springMVC项目中实现Protocol Buffers对象自动转换 – fangzhangsc2006的专栏 – CSDN博客

本文旨在向读者分享springMVC项目中Protocol Buffers的一个使用技巧，前提是需要具备对springMVC和Protocol Buffers的基本了解。

Protocol Buffers（以下简称PB）是谷歌推出的一种数据交换格式，高效、易扩展、跨语言（C++, Java, Python）。将它用于网络传输是一个不错的选择。我们服务器与客户端的通讯就是使用它来做序列化与反序列化的。

PB的使用方法大致是这样的：

1.服务器与客户端约定要交换的数据格式，然后用PB的语法将其定义为.proto文件。

2.用PB自带的编译器编译.proto文件，生成对应语言的代码文件，比如java的类文件。

3.生成好的代码包含了对象定义、对象的序列化与反序列化等功能。

PB的详细使用方法不是本文的讨论范畴，如需学习请移步【PB官网】和【博客A】

我曾使用过一款与PB类似的开源项目Hessian，spring中集成了Hessian的服务出口类，相当于一个特殊的servlet，需要配置Web.xml和对应的-servlet.xml文件，它可以完成方法参数和返回值的自动转换。客户端通过代理工厂HessianProxyFactory访问服务器上的接口，就像访问本地方法一样方便，是货真价实的RPC（远程过程调用）。详细参考【Hessian官网】和【博客B】。

受惯性思想影响，我在初次使用PB时到处寻找其与springMVC结合的配置方法。几经折腾后才发现，PB的用法与Hessian很不一样。PB的用法更像是使用工具类，我们需要调用它的parseFrom、writeTo、toByteArray等方法实现对象与流的转换。因此有这些方法就够了，我们无需任何配置。在controller中的使用举例如下：

 view plain copy

  1.         InputStream in = request.getInputStream();
  2.         UseClientInfo useClientInfo = UseClientInfo.parseFrom(in);

说明：这是从输入流中反序列化一个PB对象UseClientInfo

 view plain copy

  1. byte[] content = useClientInfoBuilder.build().toByteArray();
  2. response.setContentType(“application/x-protobuf”);
  3. response.setContentLength(content.length);
  4. response.setCharacterEncoding(“utf-8”);
  5. OutputStream out = response.getOutputStream();
  6. out.write(content);
  7. out.flush();
  8. out.close();

说明：这是往输出流中写序列化后的对象

客户端也是类似的用法，从这里可以看出PB算不上是一个完整的RPC，它只是提供了序列化与反序列化的方法。与Hessian相比的优势是无需配置、易用、易扩展，劣势是集成度不够高，需要用户参与序列化/反序列化工作，在各个controller的各个接口中频繁重复这个工作着实让人厌烦。有没有一种方式可以让controller从这些工作中脱离，接口的入参和返回值直接使用PB对象就可以了呢？

答案是肯定的，接下来讲解通过扩展springMVC的AbstractHttpMessageConverter完成PB对象和流之间的自动转换。（ps：终于到重点了，我也知道有点啰嗦，不过我希望讲清楚一件事的来龙去脉^_^）。

【首先】扩展AbstractHttpMessageConverter，实现我们自己的转换器PBMessageConverter。

 view plain copy

  1. package ……保密……;
  3. import java.io.IOException;
  4. import java.io.InputStream;
  5. import java.io.OutputStream;
  6. import java.lang.reflect.InvocationTargetException;
  7. import java.lang.reflect.Method;
  8. import java.nio.charset.Charset;
  10. import org.springframework.http.HttpInputMessage;
  11. import org.springframework.http.HttpOutputMessage;
  12. import org.springframework.http.MediaType;
  13. import org.springframework.http.converter.AbstractHttpMessageConverter;
  14. import org.springframework.http.converter.HttpMessageNotReadableException;
  15. import org.springframework.http.converter.HttpMessageNotWritableException;
  16. import com.google.protobuf.GeneratedMessage;
  18. /**
  19.  * pb对象转换，自动完成pb对象的序列化与反序列化，让controller的接口脱离这些重复工作
  20.  * @author shannon
  21.  * @time Dec 6, 2012 12:16:11 PM
  22.  * @email shannonchou@126.com
  23.  */
  24. public class PBMessageConverter extends AbstractHttpMessageConverter<GeneratedMessage> {
  27.     public PBMessageConverter() {
  28.         //设置该转换器支持的媒体类型
  29.         super(new MediaType(“application”, “x-protobuf”, Charset.forName(“UTF-8”)));
  30.     }
  32.     @Override
  33.     protected GeneratedMessage readInternal(
  34.             Class<? extends GeneratedMessage> arg0, HttpInputMessage arg1)
  35.             throws IOException, HttpMessageNotReadableException {
  36.         Method parseMethod;
  37.         try {
  38.             //利用反射机制获得parseFrom方法
  39.             parseMethod = arg0.getDeclaredMethod(“parseFrom”, InputStream.class);
  40.         } catch (SecurityException e) {
  41.             e.printStackTrace();
  42.             return null;
  43.         } catch (NoSuchMethodException e) {
  44.             e.printStackTrace();
  45.             return null;
  46.         }
  47.         try {
  48.             //调用parseFrom方法从InputStream中反序列化PB对象
  49.             return (GeneratedMessage) parseMethod.invoke(arg0, arg1.getBody());
  50.         } catch (IllegalArgumentException e) {
  51.             e.printStackTrace();
  52.             return null;
  53.         } catch (IllegalAccessException e) {
  54.             e.printStackTrace();
  55.             return null;
  56.         } catch (InvocationTargetException e) {
  57.             e.printStackTrace();
  58.             return null;
  59.         }
  60.     }
  62.     @Override
  63.     protected boolean supports(Class<?> arg0) {
  64.         //如果是GeneratedMessage的子类则支持
  65.         return GeneratedMessage.class.isAssignableFrom(arg0);
  66.     }
  68.     @Override
  69.     protected void writeInternal(GeneratedMessage arg0, HttpOutputMessage arg1)
  70.             throws IOException, HttpMessageNotWritableException {
  71.         //不用自己设置type，父类会根据构造函数中给的type设置
  72.         //arg1.getHeaders().setContentType(new MediaType(“application”,”x-protobuf”, Charset.forName(“UTF-8”)));
  73.         OutputStream outputStream = arg1.getBody();
  75.         //自己直接设置contentLength会导致异常，覆盖父类的getContentLength（）方法才是标准做法
  76.         //arg1.getHeaders().setContentLength(bytes.length);
  77.         arg0.writeTo(outputStream);
  78.         outputStream.flush();
  79.         outputStream.close();
  80.     }
  82.     @Override
  83.     protected Long getContentLength(GeneratedMessage t, MediaType contentType) {
  84.         return Long.valueOf(t.toByteArray().length);
  85.     }
  86. }

说明：

1.我们给AbstractHttpMessageConverter的泛型变量是GeneratedMessage，而它是所有生成的PB对象的父类，我们可以通过它来识别PB对象。

2.覆盖父类构造函数的同时需要给出支持的媒体类型，我这里设定的是”application/x-protobuf”，这要求客户端在建立连接时设置同样的类型。如下：

 view plain copy

  1. URL target = new URL(url);
  2. HttpURLConnection conn = (HttpURLConnection) target.openConnection();
  3. conn.setRequestMethod(“GET”);
  4. conn.setRequestProperty(“Content-Type”, “application/x-protobuf”);
  5. conn.setRequestProperty(“Accept”, “application/x-protobuf”);

3.我的PBMessageConverter利用了泛型和反射机制，已经实现了所有PB对象的转换，没有与项目耦合的任何代码，如果需要的话可以直接copy去用，不用重写。

【其次】配置*-servlet.xml文件

 view plain copy

  1. <mvc:annotation-driven>
  2.     <mvc:message-converters>
  3.         <bean class=“com.example.…保密….common.converter.PBMessageConverter” />
  4.     </mvc:message-converters>
  5. </mvc:annotation-driven>

说明：这样就将PBMessageConverter注册到了springMVC的转换器列表中。注意这里需要引入springMVC的“mvc”命名空间。

【最后】controller中通过如下方式使用

 view plain copy

  1. @RequestMapping(“connected”)
  2. public void connected(@RequestBody UseClientInfo useClientInfo, HttpServletRequest request, HttpServletResponse response) throws IOException {
  3.     log.info(useClientInfo);
  4. }
  6. @ResponseBody
  7. @RequestMapping(“get_useclientinfo”)
  8. public UseClientInfo getUseClientInfo(HttpServletResponse response) throws IOException{
  9.     UseClientInfo.Builder useClientInfoBuilder = UseClientInfo.newBuilder();
  10.     ……业务逻辑略……
  11.     return useClientInfoBuilder.build();
  12. }

说明：

1.PB参数前加上@RequestBody注解，如果返回值是PB对象则加上@ResponseBody注解。

至此，我们的controller直接操作对象，再也不需要重复的进行流与对象的转换了。

【PB官网】：http://code.google.com/p/protobuf/

【博客A】：http://blog.csdn.NET/farmmer/article/details/2689049

【Hessian官网】：http://hessian.caucho.com/

【博客B】：http://blog.csdn.net/chenweitang123/article/details/6334097

赞(0) 打赏
分享到： 更多 (0)
标签：

相关推荐

热门标签

C# (810)ASP.NET MVC (618)Android (587)ASP.NET (447)数据库 (299)JavaScript (285)JQuery (221)PHP (209)SQLServer (197)程序开发 (156)架构设计 (155)源价值 (155)SQL (128)Java (111)EasyUi (85)教程 (76)网站 (67)Debug (63)互联网 (63)MySQL (59)Flash (56)搜索优化 (54)创意 (53)SEO (51)ASP.NET MVC3 (51)电子商务 (50)建站经验 (49)实例代码 (49)源码下载 (47)原创 (45)

分类目录

链接表

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

微信扫一扫打赏