微信生成带参数二维码以及获取此二维码参数

微信开发 专栏收录该内容
16 篇文章 0 订阅

微信生成带参数二维码以及获取参数

废话不多说,先看一波文档:

生成带参数的二维码

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

目前有2种类型的二维码:

1、临时二维码,是有过期时间的,最长可以设置为在二维码生成后的30天(即2592000秒)后过期,但能够生成较多数量。临时二维码主要用于帐号绑定等不要求二维码永久保存的业务场景
2、永久二维码,是无过期时间的,但数量较少(目前为最多10万个)。永久二维码主要用于适用于帐号绑定、用户来源统计等场景。

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

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

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

获取带参数的二维码的过程包括两步,首先创建二维码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": 604800, "action_name": "QR_SCENE", "action_info": {"scene": {"scene_id": 123}}}

或者也可以使用以下POST数据创建字符串形式的二维码参数:
{"expire_seconds": 604800, "action_name": "QR_STR_SCENE", "action_info": {"scene": {"scene_str": "test"}}}

永久二维码请求说明

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": "test"}}}

参数说明

参数说明
expire_seconds该二维码有效时间,以秒为单位。 最大不超过2592000(即30天),此字段如果不填,则默认有效期为30秒。
action_name二维码类型,QR_SCENE为临时的整型参数值,QR_STR_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":"gQH47joAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL2taZ2Z3TVRtNzJXV1Brb3ZhYmJJAAIEZ23sUwMEmm
3sUw==","expire_seconds":60,"url":"http://weixin.qq.com/q/kZgfwMTm72WWPkovabbI"}
参数说明
ticket获取的二维码ticket,凭借此ticket可以在有效时间内换取二维码。
expire_seconds该二维码有效时间,以秒为单位。 最大不超过2592000(即30天)。
url二维码图片解析后的地址,开发者可根据该地址自行生成需要的二维码图片

通过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。

这里我生成的是临时的二维码,并且是字符串类型的。

//用于获取带参数的二维码
private static  String url1 = "https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=";
//换取二维码url
private static  final  String url2 = "https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=";

static Logger logger = LoggerFactory.getLogger(TicketServic.class);

/**
     * http请求方式: POST
     * URL: https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=TOKEN
     * POST数据格式:json
     * 此方法用于获取带参数的二维码 ticket
     * str : str 请按照指定格式拼接字符串 -------------------------- 待确定
     * @return
     */
    public static String getTicketData(String str){
        String token = AccessTokenService.getToken();
        if(StringUtils.isEmpty(str) || token==null){ return null; }
        if(str.length()<64 && str.length()>0){
            //临时字符二维码url
            String  url =  url1 + token;
            //二维码参数,以及过期时间
            String data = "{\"expire_seconds\": 600000000, \"action_name\": \"QR_STR_SCENE\", \"action_info\": {\"scene\": {\"scene_str\":"+ str +"}}}";
            String result = HttpUtil.sendHttpByPost(url, data);
            logger.info(" 带参数的二维码 : " + result);
            if (!StringUtils.isEmpty(result)){
                JSONObject jsonObject = JSONObject.parseObject(result);
                String string = jsonObject.getString("ticket");
                logger.info("ticket = " + string);
                return  string;
            }
        }else{
            try {
                throw new Exception("scene_str:字符串类型,长度限制为1到64");
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
        return null;
    }

然后根据用获取到的 ticket 取换取二维码,也可以通过 返回的json里面的url第三方生成二维码工具生成二维码

/**
 * 此方法通过 ticket换取二维码 , 返回一个二维码 url
 * 获取二维码ticket后,开发者可用ticket换取二维码图片。请注意,本接口无须登录态即可调用。
 * 请求说明
 * HTTP GET请求(请使用https协议)https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=TICKET
 * @param data
 * @return
 */
public static String getTicket(String data) {
    String url = "https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket="+data;
    String result = HttpUtil.sendHttpByGet(url);
    return result;
}

测试

<!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/html">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>

<script>

    var url_ticket = "https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=";
    var t ="gQF68DwAAAAAAAAAAS5odHRwOi8vd2VpeGluLnFxLmNvbS9xLzAyTFNNR1FRQS1lY2wxZktEU05zYzQAAgTuWg9cAwQAjScA";//获取到的ticket 
  window.location.href = url_ticket + t;
</script>

</body>
</html>

在这里插入图片描述

获取参数

工具类

public class HttpUtil {
    /**
     * @param url
     * @param data 生成字符二维码的数据包
     * @return
     *
     */
    public static String sendHttpByPost(String url ,String data ){

        try {
            URL urlPost = new URL(url);
            URLConnection urlConnection = urlPost.openConnection();
            //要发送数据出去,必须设置为可发送状态
            urlConnection.setDoOutput(true);
            //获取输出流
            OutputStream outputStream = urlConnection.getOutputStream();
            //写出数据
            outputStream.write(data.getBytes());
            outputStream.flush();
            outputStream.close();

            //获取输入流
            InputStream is = urlConnection.getInputStream();

            int size ;
            byte[] jsonBytes = new byte[1024];
            StringBuilder stringBuilder = new StringBuilder();
            while ((size=is.read(jsonBytes))!=-1){
                stringBuilder.append(new String(jsonBytes,0,size));
            }
            is.close();
            return stringBuilder.toString();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }


    /**
     * @param url
     * @param data 换取二维码的数据包
     * @return
     *
     */
    public static String sendHttpByGet(String url){

        try {
            URL urlGet = new URL(url);
            URLConnection urlConnection = urlGet.openConnection();
            InputStream is = urlConnection.getInputStream();
            int size ;
            byte[] jsonBytes = new byte[1024];
            StringBuilder stringBuilder = new StringBuilder();
            while ((size=is.read(jsonBytes))!=-1){
                stringBuilder.append(new String(jsonBytes,0,size));
            }
            is.close();
            return stringBuilder.toString();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }
}

扫描带参数二维码事件

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

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

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,可用来换取二维码图片

获取到数据

扫描后台获取,控制台打印出

//处理消息与事件推送
Map<String, String> xmlData = RequestParamType.getXmlData(request.getInputStream());//此处解析了xmL
  logger.info(xmlData.toString());//接受到的消息

map

{ Ticket=gQF68DwAAAAAAAAAAS5odHRwOi8vd2VpeGluLnFxLmNvbS9xLzAyTFNNR1FRQS1lY2wxZktEU05zYzQAAgTuWg9cAwQAjScA, CreateTime=1544539262, EventKey=123rt../jku0-7fg10.2544578, Event=SCAN, ToUserName=gh_275f186b7737, FromUserName=oZP6M1W239na_FwhBbVYk9Kwbkoc, MsgType=event

}

原xml

<xml>
  <ToUserName>oZP6M1W239na_FwhBbVYk9Kwbkoc</ToUserName>
  <FromUserName>gh_275f186b7737</FromUserName>
  <CreateTime>1544539129</CreateTime>
  <MsgType>event</MsgType>
  <Event>SCAN</Event>
  <EventKey>123rt../jku0-7fg10.2544578</EventKey>
  <Ticket>gQF68DwAAAAAAAAAAS5odHRwOi8vd2VpeGluLnFxLmNvbS9xLzAyTFNNR1FRQS1lY2wxZktEU05zYzQAAgTuWg9cAwQAjScA</Ticket>
</xml>

其中的EventKey便是我们生成二维码时候设置的字符串了。

github代码地址

Java技术交流群 Q 731690200 可以一起交流学习

  • 4
    点赞
  • 9
    评论
  • 19
    收藏
  • 一键三连
    一键三连
  • 扫一扫,分享海报

©️2021 CSDN 皮肤主题: 博客之星2020 设计师:CY__ 返回首页
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值