微信开发（四）对微信服务器消息的封装处理

浅浅的花香味﹌ 2022-05-22 06:41 280阅读 0赞

# 说明 #

微信公众号的开发并不是很难，看着开发文档调用接口就可以实现大部分功能，但是与微信服务器进行交互，有大量的信息需要处理，通过阅读[微信开发文档][Link 1]，发现消息的格式为XML或JSON，对于消息的处理，格式的转换是微信开发中比较重要的工作。公司的微信项目已经结束，对于项目中消息处理部分源码进行了学习，在这里记录总结下。

# 正文 #

本文主要是对微信服务器向后台发送的普通消息和事件推送消息进行处理，这两种消息都为XML格式，在处理时主要使用了[XStream][]类库。对于XML与javabean的互相转换，可以通过XStream的官方文档有tutorials进行学习。  
在技术验证时，对于消息的处理是使用了dom4j得到xml的每个节点名称和值，生成一个map，再对map的信息进行处理判断。在回复时又通过XStream将javabean转换为XML格式，这样处理有些麻烦。  
部分源码：  
对于微信的POST请求的处理：对于微信服务器的消息先转换成Map，再进行判断处理

@RequestMapping(value = "hello", method = RequestMethod.POST)
        public void message(HttpServletRequest request, HttpServletResponse response) throws IOException {
            System.out.println("进入方法");
            response.setCharacterEncoding("utf-8");
            PrintWriter out = null;
            Map<String, String> map = null;
            map  = MessageUtil.xmlToMap(request);
            String ToUserName = map.get("ToUserName");
            String FromUserName = map.get("FromUserName");
            String MsgType = map.get("MsgType");
    
            String message = null;
    
            // 文本消息
            if("text".equals(MsgType)){
                String Content = map.get("Content");
                System.out.println(Content);
                if("hello".equals(Content)){
                    TextMessageUtil textMessageUtil = new TextMessageUtil();
                    String content = "测试公众号";
                    message = textMessageUtil.initMessage(FromUserName,ToUserName, content);
                }
            }
             //事件推送
            if("event".equalsIgnoreCase(MsgType)){
    
                String Event = map.get("Event");
    
                if("subscribe".equalsIgnoreCase(Event)){
                    String EventKey = map.get("EventKey");
    
                    if(null != EventKey && !"".equals(EventKey)){
                        System.out.println(EventKey);
                        TextMessageUtil textMessageUtil = new TextMessageUtil();
                        String content = "欢迎关注！携带参数为:" + EventKey;
                        message = textMessageUtil.initMessage(FromUserName,ToUserName, content);
                    }
                }
    
                if("SCAN".equalsIgnoreCase(Event)){
                    String EventKey = map.get("EventKey");
    
                    if(null != EventKey && !"".equals(EventKey)){
                        System.out.println(EventKey);
                        TextMessageUtil textMessageUtil = new TextMessageUtil();
                        String content = "扫描二维码携带参数为：" + EventKey;
                        message = textMessageUtil.initMessage(FromUserName,ToUserName, content);
                    }
                }
            }
            try {
                out = response.getWriter();
                out.write(message);
            } catch (IOException e) {
                e.printStackTrace();
            }
    
            out.close();
    
        }

工具类，将XML转换成Map

public static Map<String, String> xmlToMap(HttpServletRequest request){
            Map<String, String> map = new HashMap<>();
            SAXReader reader = new SAXReader();
            InputStream in = null;
            try {
                in = request.getInputStream();
                Document doc = reader.read(in);
                Element root = doc.getRootElement();
                List<Element> list = root.elements();
                for(Element element : list){
                    map.put(element.getName(), element.getText());
                }
            } catch (IOException e) {
                e.printStackTrace();
            } catch (DocumentException e) {
                e.printStackTrace();
            } finally {
                try {
                    in.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
    
            return map;
        }

但是学习公司项目的源码时，发现这样处理消息有点麻烦，可以通过将信息的详细信息进行封装，直接通过XStream进行转换成javabean对象，这样更符合java面向对象的特点，通过对象得到字段值。  
通过阅读文档，普通消息主要有文本、图片、语音、视频、小视频、地理位置、链接消息，事件推送消息主要有关注/取关事件、扫描带参数二维码事件、上报地理位置事件、自定义菜单事件。  
这些XML格式的消息都有相同的字段的消息数据，可以抽象个基类，包含所有共同的字段。这里直接创建了一个WechatXMLMessage,包含普通消息和推送事件消息的所有字段，这里并没有包含所有消息。

@XStreamAlias("xml")
    public class WechatXMLMessage { 
    
        //接受普通消息
        //共有属性
        @XStreamAlias("FromUserName")
        @XStreamConverter(value = XStreamStringConverter.class)
        private String fromUserName;
    
        @XStreamAlias("ToUserName")
        @XStreamConverter(value = XStreamStringConverter.class)
        private String toUserName;
    
        @XStreamAlias("CreateTime")
        private Long createTime;
    
        @XStreamAlias("MsgType")
        @XStreamConverter(value = XStreamStringConverter.class)
        private String msgType;
    
        @XStreamAlias("MsgId")
        private Long msgId;
    
    
        //文本消息
        @XStreamAlias("Content")
        @XStreamConverter(value = XStreamStringConverter.class)
        private String content;
    
        //图片消息
        @XStreamAlias("PicUrl")
        @XStreamConverter(value = XStreamStringConverter.class)
        private String picUrl; 
    
        @XStreamAlias("MediaId")
        @XStreamConverter(value = XStreamStringConverter.class)
        private String mediaId;
    
        //语音消息
        @XStreamAlias("Format")
        @XStreamConverter(value = XStreamStringConverter.class)
        private String format; 
    
        @XStreamAlias("Recognition")
        @XStreamConverter(value = XStreamStringConverter.class)
        private String recognition;
    
        //视频消息
        @XStreamAlias("ThumbMediaId")
        @XStreamConverter(value = XStreamStringConverter.class)
        private String thumbMediaId;
    
        //地理位置消息
        @XStreamAlias("Location_X")
        private Double location_X;
    
        @XStreamAlias("Location_Y")
        private Double location_Y;
    
        @XStreamAlias("Scale")
        private Double scale;
    
        @XStreamAlias("Label")
        @XStreamConverter(value = XStreamStringConverter.class)
        private String label;
    
        //链接消息
        @XStreamAlias("Title")
        @XStreamConverter(value = XStreamStringConverter.class)
        private String title; 
    
        @XStreamAlias("Description")
        @XStreamConverter(value = XStreamStringConverter.class)
        private String description; 
    
        @XStreamAlias("Url")
        @XStreamConverter(value = XStreamStringConverter.class)
        private String url;
    
        //接受事件推送
        //关注取消事件
        @XStreamAlias("Event")
        @XStreamConverter(value = XStreamStringConverter.class)
        private String event;
    
        //扫描带参数的二维码事件
        @XStreamAlias("EventKey")
        @XStreamConverter(value = XStreamStringConverter.class)
        private String eventKey; 
    
        @XStreamAlias("Ticket")
        @XStreamConverter(value = XStreamStringConverter.class)
        private String ticket;
    
        //上报地理位置事件
    
        @XStreamAlias("Latitude")
        private Double latitude;
    
        @XStreamAlias("Longitude")
        private Double longitude;
    
        @XStreamAlias("Precision")
        private Double precision;
    
        //自定义菜单事件
        //省略了get set方法
    }

这里注意XStream注解的使用，在使用注解时一定不能忘记 xStream.processAnnotations(class);

创建了javabean后需要创建XStream，而对于不同的消息需要有不同的Converter，这里使用一个Map<Class,XStream>来存储不同类对应的XStream  
由于微信的XML格式数据中使用了”<！\[CDATA\[ \]\]>”,所以对StringConverter进行继承重写toString方法

public class XStreamStringConverter extends StringConverter { 
    
        @Override
        public String toString(Object obj) {
            return "<![CDATA[" + super.toString(obj) + "]]>";
        }
    }

为了方面构造回复XML格式的回复信息，所以对XStream的初始化也进行了重写

public class XStreamInitializer {
    
        private XStreamInitializer(){}
    
        public static XStream getInstance(){
            XStream xstream = new XStream(
                    new XppDriver(){
                        @Override
                        public HierarchicalStreamWriter createWriter(Writer out) {
                            return new PrettyPrintWriter(out,getNameCoder()){
                                protected String PREFIX_CDATA = "<![CDATA[";
                                protected String SUFFIX_CDATA = "]]>";
    
                                @Override
                                protected void writeText(QuickWriter writer, String text) {
                                    if(text.startsWith(PREFIX_CDATA) && text.endsWith(SUFFIX_CDATA)){
                                        writer.write(text);
                                    }else{
                                        super.writeText(writer, text);
                                    }
                                }
                            };
    
    
                        }
                    }
            );
            xstream.ignoreUnknownElements();
            xstream.setMode(XStream.NO_REFERENCES);
            xstream.addPermission(NullPermission.NULL);
            xstream.addPermission(PrimitiveTypePermission.PRIMITIVES);
            return xstream;
        }
    
    }

最后根据类得到不同的XStream实例

public class XStreamTransformer {
    
        private static Map<Class, XStream> COLLECTION_OF_XSTREAM = configXStreamInstance();
    
        private static Map<Class, XStream> configXStreamInstance(){
            Map<Class,XStream> map = new HashMap<>();
            map.put(WechatXMLMessage.class,xStream_WechatXMLMsg());
    
            return map;
        }
    
        private static XStream xStream_WechatXMLMsg(){
            XStream xStream = XStreamInitializer.getInstance();
            xStream.processAnnotations(WechatXMLMessage.class);
    
            return xStream;
        }
    
        public static <T> T fromXML(Class<T> clazz,InputStream inputStream){
            T obj = (T) COLLECTION_OF_XSTREAM.get(clazz).fromXML(inputStream);
    
            return obj;
        }
    }

最后在接受POST请求时，调用方法得到封装的数据

@RequestMapping(value = "hello", method = RequestMethod.POST)
     public void message(HttpServletRequest request, HttpServletResponse response) throws IOException {        
        WechatXMLMessage wechatXMLMessage = XStreamTransformer.fromXML(WechatXMLMessage.class, request.getInputStream());
        //省略对数据的后续处理
     }

项目中对于消息的处理基本就是以这种方式进行，主要是对XStream的灵活使用和对消息的封装处理，学习记录到这就基本结束了，但在看这部分内容时发现，对于不同的消息类型都对应一个XStream对象，那代码中会有很多XStream的对象，那能不能将XStream单例化?单例对象怎么对不同的消息类型进行转换？

[Link 1]: https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1445241432
[XStream]: http://x-stream.github.io/