微信java版本之扫码关注公众号(带参数的临时二维码)

最新推荐文章于 2024-10-09 22:20:36 发布

心乐利

最新推荐文章于 2024-10-09 22:20:36 发布

阅读量1.1w

点赞数 2

1.生成带参数的二维码接口介绍

为了满足用户渠道推广分析的需要，公众平台提供了生成带参数二维码的接口。使用该接口可以获得多个带不同场景值的二维码，用户扫描后，公众号可以接收到事件推送。

目前有2种类型的二维码，分别是临时二维码和永久二维码，前者有过期时间，最大为1800秒，但能够生成较多数量，后者无过期时间，数量较少（目前参数只支持1--100000）。两种二维码分别适用于帐号绑定、用户来源统计等场景。

用户扫描带场景值二维码时，可能推送以下两种事件：

如果用户还未关注公众号，则用户可以关注公众号，关注后微信会将带场景值关注事件推送给开发者。
如果用户已经关注公众号，在用户扫描后会自动进入会话，微信也会将带场景值扫描事件推送给开发者。

获取带参数的二维码的过程包括两步，首先创建二维码ticket，然后凭借ticket到指定URL换取二维码。

创建二维码ticket

每次创建二维码ticket需要提供一个开发者自行设定的参数（scene_id），分别介绍临时二维码和永久二维码的创建二维码ticket过程。

临时二维码请求说明

http请求方式: POST
URL: https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=TOKEN
POST数据格式：json
POST数据例子：{"expire_seconds": 1800, "action_name": "QR_SCENE", "action_info": {"scene": {"scene_id": 123}}}

永久二维码请求说明

http请求方式: POST
URL: https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=TOKEN
POST数据格式：json
POST数据例子：{"action_name": "QR_LIMIT_SCENE", "action_info": {"scene": {"scene_id": 123}}}
或者也可以使用以下POST数据创建字符串形式的二维码参数：
{"action_name": "QR_LIMIT_STR_SCENE", "action_info": {"scene": {"scene_str": "123"}}}

参数说明

参数	说明
expire_seconds	该二维码有效时间，以秒为单位。最大不超过1800。
action_name	二维码类型，QR_SCENE为临时,QR_LIMIT_SCENE为永久,QR_LIMIT_STR_SCENE为永久的字符串参数值
action_info	二维码详细信息
scene_id	场景值ID，临时二维码时为32位非0整型，永久二维码时最大值为100000（目前参数只支持1--100000）
scene_str	场景值ID（字符串形式的ID），字符串类型，长度限制为1到64，仅永久二维码支持此字段

返回说明

正确的Json返回结果:

{"ticket":"gQH47joAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL2taZ2Z3TVRtNzJXV1Brb3ZhYmJJAAIEZ23sUwMEmm3sUw==","expire_seconds":60,"url":"http:\/\/weixin.qq.com\/q\/kZgfwMTm72WWPkovabbI"}

参数	说明
ticket	获取的二维码ticket，凭借此ticket可以在有效时间内换取二维码。
expire_seconds	二维码的有效时间，以秒为单位。最大不超过1800。
url	二维码图片解析后的地址，开发者可根据该地址自行生成需要的二维码图片

错误的Json返回示例:

{"errcode":40013,"errmsg":"invalid appid"}

全局返回码说明

使用网页调试工具调试该接口

通过ticket换取二维码

获取二维码ticket后，开发者可用ticket换取二维码图片。请注意，本接口无须登录态即可调用。

请求说明

HTTP GET请求（请使用https协议）
https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=TICKET
提醒：TICKET记得进行UrlEncode

返回说明

ticket正确情况下，http 返回码是200，是一张图片，可以直接展示或者下载。

HTTP头（示例）如下：
Accept-Ranges:bytes
Cache-control:max-age=604800
Connection:keep-alive
Content-Length:28026
Content-Type:image/jpg
Date:Wed, 16 Oct 2013 06:37:10 GMT
Expires:Wed, 23 Oct 2013 14:37:10 +0800
Server:nginx/1.4.1

错误情况下（如ticket非法）返回HTTP错误码404

扫描带参数二维码事件

用户扫描带场景值二维码时，可能推送以下两种事件：

如果用户还未关注公众号，则用户可以关注公众号，关注后微信会将带场景值关注事件推送给开发者。
如果用户已经关注公众号，则微信会将带场景值扫描事件推送给开发者。

1. 用户未关注时，进行关注后的事件推送

推送XML数据包示例：

<xml><ToUserName><![CDATA[toUser]]></ToUserName>
<FromUserName><![CDATA[FromUser]]></FromUserName>
<CreateTime>123456789</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[subscribe]]></Event>
<EventKey><![CDATA[qrscene_123123]]></EventKey>
<Ticket><![CDATA[TICKET]]></Ticket>
</xml>

参数说明：

参数	描述
ToUserName	开发者微信号
FromUserName	发送方帐号（一个OpenID）
CreateTime	消息创建时间（整型）
MsgType	消息类型，event
Event	事件类型，subscribe
EventKey	事件KEY值，qrscene_为前缀，后面为二维码的参数值
Ticket	二维码的ticket，可用来换取二维码图片

2. 用户已关注时的事件推送

推送XML数据包示例：

<xml>
<ToUserName><![CDATA[toUser]]></ToUserName>
<FromUserName><![CDATA[FromUser]]></FromUserName>
<CreateTime>123456789</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[SCAN]]></Event>
<EventKey><![CDATA[SCENE_VALUE]]></EventKey>
<Ticket><![CDATA[TICKET]]></Ticket>
</xml>

参数说明：

参数	描述
ToUserName	开发者微信号
FromUserName	发送方帐号（一个OpenID）
CreateTime	消息创建时间（整型）
MsgType	消息类型，event
Event	事件类型，SCAN
EventKey	事件KEY值，是一个32位无符号整数，即创建二维码时的二维码scene_id
Ticket	二维码的ticket，可用来换取二维码图片

2.公众号设置

设置url服务器为微信推送的地址

3.代码实现

3.1微信推送

[java]view plaincopy 
    
print?
 @Controller  
 @RequestMapping("/weixin/callback")  
 public class WeiXinCallBackAttentionController {  
       
     /** 
      * 微信验证回调 
      * @param request 
      * @param response 
      *  
      *  
      * <xml><ToUserName><![CDATA[gh_2a5540516edb]]></ToUserName> 
         <FromUserName><![CDATA[odwP2jt6aTBu_Dl1ypoUJ8pN9UOs]]></FromUserName> 
         <CreateTime>1425633941</CreateTime> 
         <MsgType><![CDATA[event]]></MsgType> 
         <Event><![CDATA[SCAN]]></Event> 
         <EventKey><![CDATA[0]]></EventKey> 
         <Ticket><![CDATA[gQGK8DoAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL2RIVlBsRVBsdEhITk9jQzRaMXV6AAIEgXL5VAMECAcAAA==]]></Ticket> 
         </xml> 
      */  
     @RequestMapping(value="/init",method={RequestMethod.GET,RequestMethod.POST} )  
     public void init(@RequestBody(required=false) String body,HttpServletRequest request,HttpServletResponse response){  
           
         System.out.println(body.toString());  
         System.out.println("================================微信URL回调测试=========================");  
         SAXReader saxReader = new SAXReader();  
         Document document;  
         try {  
             try {  
                 document = saxReader.read(new ByteArrayInputStream(body.toString().getBytes("UTF-8")));  
                 Element rootElt = document.getRootElement();  
                 System.out.println("FromUserName==="+rootElt.elementText("FromUserName"));  
             } catch (UnsupportedEncodingException e) {  
                 // TODO Auto-generated catch block  
                 e.printStackTrace();  
             }  
               
         } catch (DocumentException e) {  
             // TODO Auto-generated catch block  
             e.printStackTrace();  
         }  
     /*   
      * 微信回调验证 
      *  
      * String signature = request.getParameter("signature"); 
         String timestamp = request.getParameter("timestamp"); 
         String nonce = request.getParameter("nonce"); 
         String echostr = request.getParameter("echostr"); 
          
         String token = "dmx"; 
          
         PrintWriter out; 
         try { 
             out = response.getWriter(); 
             out.println(echostr); 
             out.close(); 
             response.flushBuffer(); 
         } catch (IOException e) { 
             // TODO Auto-generated catch block 
             e.printStackTrace(); 
         }*/  
           
           
 }  
           
 }  

3.2微信生成带参数的临时二维码，用于扫码关注公众账号

[java]view plaincopy 
     
print?
 @Controller  
 @RequestMapping("/attention")  
 public class WeiXinAttentionController {  
       
       
   
   
     @RequestMapping(value = "/weixinAttention", method = RequestMethod.POST)  
     @ResponseBody  
     public Object init(@RequestBody String body, HttpServletRequest request,HttpServletResponse response) {  
         try{  
               
             KeyStore keyStore = KeyStore.getInstance("PKCS12");  
             FileInputStream instream = new FileInputStream(new File(  
                     CustomizedPropertyPlaceholderConfigurer.getContextProperty("wx.cert").toString()));  
             try {  
                 keyStore.load(instream, "见邮件".toCharArray());  
             }finally {  
                 instream.close();  
             }  
   
             // Trust own CA and all self-signed certs  
             SSLContext sslcontext = SSLContexts.custom().loadKeyMaterial(keyStore,  
                     "<span style="font-family: Arial, Helvetica, sans-serif;">见邮件</span><span style="font-family: Arial, Helvetica, sans-serif;">".toCharArray()).build();</span>  
             // Allow TLSv1 protocol only  
             SSLConnectionSocketFactory sslsf = new SSLConnectionSocketFactory(  
                     sslcontext, new String[] { "TLSv1" }, null,  
                     SSLConnectionSocketFactory.ALLOW_ALL_HOSTNAME_VERIFIER);  
             CloseableHttpClient httpclient = HttpClients.custom()  
                     .setSSLSocketFactory(sslsf).build();  
             // HttpGet httpget = new  
             // HttpGet("https://api.mch.weixin.qq.com/secapi/pay/refund");  
             JSONObject bodyXml = JSONObject.fromObject(body);  
             HttpPost httppost = new HttpPost("https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token="+bodyXml.get("accessToken"));  
               
             Map<String,Map<String,Integer>> sceneMap = new HashMap<String,Map<String,Integer>>();  
             Map<String,Integer> sceneIdMap = new HashMap<String, Integer>();  
             sceneIdMap.put("scene_id", (Integer) bodyXml.get("sceneId"));  
             sceneMap.put("scene", sceneIdMap);  
               
             JSONObject attentionXml = new JSONObject();  
             attentionXml.put("expire_seconds", Integer.valueOf(bodyXml.get("expireSeconds").toString()));  
             attentionXml.put("action_name", weixinActionName.ACTION_NAME_TEMPORARY);  
             attentionXml.put("action_info", sceneMap);  
             System.out.println("atten====="+attentionXml.toString());  
             try {  
   
                 StringEntity se = new StringEntity(attentionXml.toString());  
                   
                 httppost.setEntity(se);  
   
                 System.out.println("executing request" + httppost.getRequestLine());  
   
                 CloseableHttpResponse responseEntry = httpclient.execute(httppost);  
                 try {  
                     HttpEntity entity = responseEntry.getEntity();  
   
                     System.out.println("----------------------------------------");  
                     System.out.println(responseEntry.getStatusLine());  
                     if (entity != null) {  
                         System.out.println("Response content length: "  
                                 + entity.getContentLength());  
                         JSONObject result = null ;  
                         System.out.println("Response content length: "  
                                 + entity.getContentLength());  
                     BufferedReader bufferedReader = new BufferedReader(  
                                 new InputStreamReader(entity.getContent()));  
                         String text;  
                         while ((text = bufferedReader.readLine()) != null) {  
                             System.out.println("text======="+text);  
                             result = JSONObject.fromObject(text);  
                         }  
 //此url位生成临时二维码url,扫码后可进行公众账号关注  
                         String resultUrl = result.getString("url");  
 //                      JSONObject result = new JSONObject();  
                         if(!StringUtils.isEmpty(resultUrl)){  
                             result.put("attentionUrl", resultUrl);  
                             result.put("expireSeconds", result.getString("expire_seconds"));  
                         }else{  
                             result.put("status", "error");  
                             result.put("errcode", result.getString("errcode"));  
                             result.put("errmsg", result.getString("errmsg"));  
                         }  
                           
                         return result;  
   
                     }  
                     EntityUtils.consume(entity);  
                 }  
                 finally {  
                     responseEntry.close();  
                 }  
             }  
             finally {  
                 httpclient.close();  
             }  
             return null;          
         }catch(Exception e){  
             e.printStackTrace();  
             JSONObject result = new JSONObject();  
             result.put("status","error");  
             result.put("msg",e.getMessage());  
             return result;  
         }  
     }  
 }  