微信公众平台开发教程第22篇-SAE不支持XStream框架的解决方案

时间：2022-09-14 15:43:31

问题分析

如果Java Web项目中使用了日志工具log4j或者slf4j，并且设置了将日志输出到控制台（console），那么在项目部署到SAE之后，可以在SAE网站的“日志中心”看到应用的相关日志。查看HTTP服务error级别的日志，能够看到如下图所示的错误日志：

微信公众平台开发教程第22篇-SAE不支持XStream框架的解决方案

为了方便查看和讲解，我对上述错误日志进行了格式化处理，结果如下：

[java] view plain copy
  1. 101.226.62.83 [27/Aug/2014:17:23:10 +0800] JAVA_SAE_Fatal_error:   
  2. Error for /coreServletjava.lang.NoClassDefFoundError: Could not initialize class org.liufeng.weixin.util.MessageUtil      
  3. at org.liufeng.gywodejia.service.CoreService.processRequest(CoreService.java:40)      
  4. at org.liufeng.gywodejia.servlet.CoreServlet.doPost(CoreServlet.java:54)      
  5. at javax.servlet.http.HttpServlet.service(HttpServlet.java:727)   
  6. at javax.servlet.http.HttpServlet.service(HttpServlet.java:820)   
  7. at org.eclipse.jetty.servlet.ServletHolder.handle(ServletHolder.java:538)     
  8. at org.eclipse.jetty.servlet.ServletHandler.doHandle(ServletHandler.java:478)     
  9. at com.sina.sae.servlet.SaeServletHandler.doHandle(SaeServletHandler.java:49)     
  10. at org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:119)      
  11. at org.eclipse.jetty.security.SecurityHandler.handle(SecurityHandler.java:517)    
  12. at org.eclipse.jetty.server.session.SessionHandler.doHandle(SessionHandler.java:225)      
  13. at org.eclipse.jetty.server.handler.ContextHandler.doHandle(ContextHandler.java:937)      
  14. at org.eclipse.jetty.servlet.ServletHandler.doScope(ServletHandler.java:406)      
  15. at org.eclipse.jetty.server.session.SessionHandler.doScope(SessionHandler.java:183)   
  16. at org.eclipse.jetty.server.handler.ContextHandler.doScope(ContextHandler.java:871)   
  17. at com.sina.sae.webapp.SaeWebAppContext.doScope(SaeWebAppContext.java:166)    
  18. at org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:117)      
  19. at org.eclipse.jetty.server.handler.ContextHandlerCollection.handle(ContextHandlerCollection.java:259)    
  20. at org.eclipse.jetty.server.handler.HandlerCollection.handle(HandlerCollection.java:149)      
  21. at com.sina.sae.handler.SaeUserInfoHandler.handle(SaeUserInfoHandler.java:105)    
  22. at org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:110)    
  23. at org.eclipse.jetty.rewrite.handler.RewriteHandler.handle(RewriteHandler.java:305)   
  24. at org.eclipse.jetty.server.handler.HandlerW yq36.javaruntime   
 从日志中的第二行可以看出，在访问/coreServlet时报了一个错误NoClassDefFoundError（类找不到），并且提示org.liufeng.weixin.util.MessageUtil类不能被实例化。在部署的WAR中，MessageUtil.class明明存在，为什么会找不到类呢？我们来看看，MessageUtil.java中到底都写了些什么，源代码如下：

[java] view plain copy
  1. package org.liufeng.course.util;  
  2.   
  3. import java.io.InputStream;  
  4. import java.io.Writer;  
  5. import java.util.HashMap;  
  6. import java.util.List;  
  7. import java.util.Map;  
  8.   
  9. import javax.servlet.http.HttpServletRequest;  
  10.   
  11. import org.dom4j.Document;  
  12. import org.dom4j.Element;  
  13. import org.dom4j.io.SAXReader;  
  14. import org.liufeng.course.message.resp.Article;  
  15. import org.liufeng.course.message.resp.MusicMessage;  
  16. import org.liufeng.course.message.resp.NewsMessage;  
  17. import org.liufeng.course.message.resp.TextMessage;  
  18.   
  19. import com.thoughtworks.xstream.XStream;  
  20. import com.thoughtworks.xstream.core.util.QuickWriter;  
  21. import com.thoughtworks.xstream.io.HierarchicalStreamWriter;  
  22. import com.thoughtworks.xstream.io.xml.PrettyPrintWriter;  
  23. import com.thoughtworks.xstream.io.xml.XppDriver;  
  24.   
  25. /** 
  26.  * 消息工具类 
  27.  *  
  28.  * @author liufeng 
  29.  * @date 2013-05-19 
  30.  */  
  31. public class MessageUtil {  
  32.   
  33.     /** 
  34.      * 返回消息类型：文本 
  35.      */  
  36.     public static final String RESP_MESSAGE_TYPE_TEXT = "text";  
  37.   
  38.     /** 
  39.      * 返回消息类型：音乐 
  40.      */  
  41.     public static final String RESP_MESSAGE_TYPE_MUSIC = "music";  
  42.   
  43.     /** 
  44.      * 返回消息类型：图文 
  45.      */  
  46.     public static final String RESP_MESSAGE_TYPE_NEWS = "news";  
  47.   
  48.     /** 
  49.      * 请求消息类型：文本 
  50.      */  
  51.     public static final String REQ_MESSAGE_TYPE_TEXT = "text";  
  52.   
  53.     /** 
  54.      * 请求消息类型：图片 
  55.      */  
  56.     public static final String REQ_MESSAGE_TYPE_IMAGE = "image";  
  57.   
  58.     /** 
  59.      * 请求消息类型：链接 
  60.      */  
  61.     public static final String REQ_MESSAGE_TYPE_LINK = "link";  
  62.   
  63.     /** 
  64.      * 请求消息类型：地理位置 
  65.      */  
  66.     public static final String REQ_MESSAGE_TYPE_LOCATION = "location";  
  67.   
  68.     /** 
  69.      * 请求消息类型：音频 
  70.      */  
  71.     public static final String REQ_MESSAGE_TYPE_VOICE = "voice";  
  72.   
  73.     /** 
  74.      * 请求消息类型：推送 
  75.      */  
  76.     public static final String REQ_MESSAGE_TYPE_EVENT = "event";  
  77.   
  78.     /** 
  79.      * 事件类型：subscribe(订阅) 
  80.      */  
  81.     public static final String EVENT_TYPE_SUBSCRIBE = "subscribe";  
  82.   
  83.     /** 
  84.      * 事件类型：unsubscribe(取消订阅) 
  85.      */  
  86.     public static final String EVENT_TYPE_UNSUBSCRIBE = "unsubscribe";  
  87.   
  88.     /** 
  89.      * 事件类型：CLICK(自定义菜单点击事件) 
  90.      */  
  91.     public static final String EVENT_TYPE_CLICK = "CLICK";  
  92.   
  93.     /** 
  94.      * 解析微信发来的请求（XML） 
  95.      *  
  96.      * @param request 
  97.      * @return 
  98.      * @throws Exception 
  99.      */  
  100.     @SuppressWarnings("unchecked")  
  101.     public static Map<String, String> parseXml(HttpServletRequest request) throws Exception {  
  102.         // 将解析结果存储在HashMap中  
  103.         Map<String, String> map = new HashMap<String, String>();  
  104.   
  105.         // 从request中取得输入流  
  106.         InputStream inputStream = request.getInputStream();  
  107.         // 读取输入流  
  108.         SAXReader reader = new SAXReader();  
  109.         Document document = reader.read(inputStream);  
  110.         // 得到xml根元素  
  111.         Element root = document.getRootElement();  
  112.         // 得到根元素的所有子节点  
  113.         List<Element> elementList = root.elements();  
  114.   
  115.         // 遍历所有子节点  
  116.         for (Element e : elementList)  
  117.             map.put(e.getName(), e.getText());  
  118.   
  119.         // 释放资源  
  120.         inputStream.close();  
  121.         inputStream = null;  
  122.   
  123.         return map;  
  124.     }  
  125.   
  126.     /** 
  127.      * 文本消息对象转换成xml 
  128.      *  
  129.      * @param textMessage 文本消息对象 
  130.      * @return xml 
  131.      */  
  132.     public static String textMessageToXml(TextMessage textMessage) {  
  133.         xstream.alias("xml", textMessage.getClass());  
  134.         return xstream.toXML(textMessage);  
  135.     }  
  136.   
  137.     /** 
  138.      * 音乐消息对象转换成xml 
  139.      *  
  140.      * @param musicMessage 音乐消息对象 
  141.      * @return xml 
  142.      */  
  143.     public static String musicMessageToXml(MusicMessage musicMessage) {  
  144.         xstream.alias("xml", musicMessage.getClass());  
  145.         return xstream.toXML(musicMessage);  
  146.     }  
  147.   
  148.     /** 
  149.      * 图文消息对象转换成xml 
  150.      *  
  151.      * @param newsMessage 图文消息对象 
  152.      * @return xml 
  153.      */  
  154.     public static String newsMessageToXml(NewsMessage newsMessage) {  
  155.         xstream.alias("xml", newsMessage.getClass());  
  156.         xstream.alias("item", new Article().getClass());  
  157.         return xstream.toXML(newsMessage);  
  158.     }  
  159.   
  160.     /** 
  161.      * 扩展xstream，使其支持CDATA块 
  162.      *  
  163.      * @date 2013-05-19 
  164.      */  
  165.     private static XStream xstream = new XStream(new XppDriver() {  
  166.         public HierarchicalStreamWriter createWriter(Writer out) {  
  167.             return new PrettyPrintWriter(out) {  
  168.                 // 对所有xml节点的转换都增加CDATA标记  
  169.                 boolean cdata = true;  
  170.   
  171.                 @SuppressWarnings("unchecked")  
  172.                 public void startNode(String name, Class clazz) {  
  173.                     super.startNode(name, clazz);  
  174.                 }  
  175.   
  176.                 protected void writeText(QuickWriter writer, String text) {  
  177.                     if (cdata) {  
  178.                         writer.write("<![CDATA[");  
  179.                         writer.write(text);  
  180.                         writer.write("]]>");  
  181.                     } else {  
  182.                         writer.write(text);  
  183.                     }  
  184.                 }  
  185.             };  
  186.         }  
  187.     });  
  188. }  
 MessageUtil是消息处理工具类，该类的代码大致可以分为以下3部分：

1）第33~91行：定义了若干常量，用于表示请求消息类型、事件类型和响应消息类型。

2）第93-124行：定义了一个parseXml()方法，通过dom4j工具解析微信服务器发来的xml格式的消息。

3）第126~187行：通过XStream工具将Java消息对象转换成xml。

很明显，问题应该不会出现在第1部分代码中，因为这段代码太平常不过了。我猜想，问题可能与第2、3部分代码中引用的第三方工具dom4j或XStream有关，会不会是SAE做了什么更新不支持dom4j或XStream了呢？要想证明也不难，写一个最简单的Java web工程，其中只用到dom4j或者只用到XStream工具，就能知道是哪里出了问题。好在我认识一个SAE官方的运营人员，就偷了个懒，直接咨询他，他帮忙问过SAE研发人员之后给出的答复是：XStream源码中通过反射机制使用到了sun.misc.Unsafe类，而该类因为安全原因被SAE禁用掉了，这就是为什么用到XStream的项目部署到SAE会报NoClassDefFoundError的原因。噢，原来是这么回事，知道原因了就总能找到解决方案。


问题解决

XStream框架的作用是实现Java对象与XML的互相转换，SAE研发人员建议用其他有类似功能的框架替代，如Xerces、jdom或者dom4j，当然，这是一个很不错的建议，如果是在新的项目中，我肯定会这样做。但现在的问题是，如果真的用其他框架来替换XStream，可能要修改的不仅仅是MessageUtil一个类，这样的改动太大了，我也很难向这么多读者交待。正是出于这种考虑，让我想到了有没有可能通过修改XStream框架的源码来解决问题。

我在XStream官方网站http://xstream.codehaus.org/上找到了xstream-1.3.1.jar对应的源码，导入到Eclipse，然后借助Eclipse强大的搜索功能，很快找到了使用sun.misc.Unsafe的类，我尝试将这些类删除或者修改它们的实现，避免使用sun.misc.Unsafe类，最终得到了一个新的jar包，我将其命名为xstream-1.3.1-sae-liufeng.jar，用它替换以前项目中使用的xstream-1.3.1.jar，最终项目再次顺利地运行在SAE上。

可能很多看到标题进来的读者，就是想知道这个问题是如何解决的，并不想听我哆嗦半天。授人鱼不如授人以渔，我之所以将问题的发现、分析和解决整个过程写出来，也是希望能够帮助更多初学者逐渐掌握自行解决问题的方法。

xstream-1.3.1-sae-liufeng.jar的下载地址：http://download.csdn.net/download/lyq8479/7830911。

标签：

相关文章