Java 获取小程序码的两种方式

桃扇骨 2023-09-29 20:26 34阅读 0赞

目前小程序推出了自己的识别码，小程序码，**圆形的码看起来比二维码好看。**

本文总结微信小程序的获取小程序二维码的接口开发。[官方地址][Link 1]

主要内容摘抄自微信小程序的API文档，java接口开发是自己总结开发。

### **一、简介** ###

通过后台接口可以获取小程序任意页面的二维码，扫描该二维码可以直接进入小程序对应的页面。

目前微信支持两种二维码，**小程序码（左），小程序二维码（右）**，如下所示：这篇文章主要讲解的是获取小程序码的两种方式。  
![这里写图片描述][SouthEast]

### 获取<小程序码>的前提 ###

### 必须获取小程序的TOKEN ###

获取 access\_token  
[详见文档][Link 2]

/**
      * 获取token
      * @param url
      * @param grantType
      * @param appid
      * @param secret
      * @return
      */
     public static String getAccessToken(String url,String grantType,String appid,String secret){
         String access_token = "";
         String tokenUrl = url+"?grant_type="+ grantType+"&appid="+ appid + "&secret="+ secret;
         Object result = HttpUtils.doGet(tokenUrl);
         JSONObject jsons = JSONObject.parseObject(result.toString());
         String expires_in = jsons.getString("expires_in");
         if(BL3Utils.isNotEmpty(expires_in)&&Integer.parseInt(expires_in)==7200){
             //ok
             access_token = jsons.getString("access_token");
         }else{
             System.out.println("出错获取token失败！");
         }
         return access_token;
     }

参数介绍：

1.url ：https://api.weixin.qq.com/cgi-bin/token  
2.grantType： client\_credential  
3.appid：小程序appid，微信公众平台注册小程序时自动生成的。  
4.secret：小程序secret，微信公众平台注册小程序时自动生成的。  
5.url 和grantType参数官网其实有介绍的。

### 获取小程序码的两种方式 ###

目前有两个接口可以生成小程序码，开发者可以根据自己的需要选择合适的接口

#### 第一种 ####

1.  适用于需要的码数量较少的业务场景
2.  是呢不带参数有限个小程序码接口
3.  总共生成的码数量限制为100,000，请谨慎调用。

**接口地址：**

> [https://api.weixin.qq.com/wxa/getwxacode?access\_token=ACCESS\_TOKEN][https_api.weixin.qq.com_wxa_getwxacode_access_token_ACCESS_TOKEN]

**（1）POST 参数说明**

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>类型</th> 
   <th>默认值</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>path</td> 
   <td>String</td> 
   <td></td> 
   <td>不能为空，最大长度 128 字节</td> 
  </tr> 
  <tr> 
   <td>width</td> 
   <td>Int</td> 
   <td>430</td> 
   <td>二维码的宽度</td> 
  </tr> 
  <tr> 
   <td>auto_color</td> 
   <td>Bool</td> 
   <td>false</td> 
   <td>自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调</td> 
  </tr> 
  <tr> 
   <td>line_color</td> 
   <td>Object</td> 
   <td>{“r”:”0”,”g”:”0”,”b”:”0”}</td> 
   <td>auth_color 为 false 时生效，使用 rgb</td> 
  </tr> 
  <tr> 
   <td>设置颜色 例如 {“r”:”xxx”,”g”:”xxx”,”b”:”xxx”}</td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

**注意：通过该接口生成的小程序码，永久有效，但数量有效，请谨慎使用。用户扫描该码进入小程序后，将直接进入 path 对应的页面。**

#### **（2）请求接口测试** ####

使用http请求插件postman或者RESTClient请求测试。

![è¿éåå¾çæè¿°][SouthEast 1]

请求测试结果返回一个小程序码图片，与微信公众平台生成二维码不同，小程序码直接返回文件流，不是微信公众平台的url和ticket。

#### **（3）java接口开发** ####

/**
         1. 带参数有限个数小程序码接口
         2. @param url
         3. @param access_token
         4. @param path
         5. @param width
         6. @return
         */
         public static InputStream getwxacode(String url,String access_token,String path,String width){
        
             url = url + "?access_token=" + access_token;
             JSONObject jsonParam = new JSONObject();
             jsonParam.put("path", path);
             jsonParam.put("width", Integer.parseInt(width));
             jsonParam.put("auto_color", false);
             Map<String,Object> line_color = new HashMap<>();
             line_color.put("r", 0);
             line_color.put("g", 0);
             line_color.put("b", 0);
             jsonParam.put("line_color", line_color);
             InputStream instreams = HttpUtils.doWXPost(url, jsonParam);
             if(BL3Utils.isEmpty(instreams)){
        
                 System.out.println("出错获取二维码失败！");
             }
             return instreams;
         }

参数说明

1.url ： https://api.weixin.qq.com/wxa/getwxacode

2.access\_token：上面有介绍（getAccessToken这个方法）

3.path：用户扫描该码进入小程序后，将直接进入 path 对应的页面；一般是首页地址：”pages/index/index”  
也可以带上参数：”pages/index/index?query=1”。

4.width：二维码的宽度 int类型 默认 430

#### 第二种 ####

1.  适用于需要的码数量极多的业务场景
2.  没有数量限制呢
3.  带参数

**接口地址：**

> [https://api.weixin.qq.com/wxa/getwxacodeunlimit?access\_token=ACCESS\_TOKEN][https_api.weixin.qq.com_wxa_getwxacodeunlimit_access_token_ACCESS_TOKEN]

#### **（1）POST 参数说明** ####

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>类型</th> 
   <th>默认值</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>scene</td> 
   <td>String</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>最大32个可见字符，只支持数字，大小写英文以及部分特殊字符：!#$&amp;’()*+,/:;=?@-._~，其它字符请自行编码为合法字符（因不支持%，中文无法使用</td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>urlencode 处理，请使用其他编码方式）</td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>page</td> 
   <td>String</td> 
   <td></td> 
   <td>必须是已经发布的小程序页面，例如 “pages/index/index” ,如果不填写这个字段，默认跳主页面</td> 
  </tr> 
  <tr> 
   <td>width</td> 
   <td>Int</td> 
   <td>430</td> 
   <td>二维码的宽度</td> 
  </tr> 
  <tr> 
   <td>auto_color</td> 
   <td>Bool</td> 
   <td>false</td> 
   <td>自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调</td> 
  </tr> 
  <tr> 
   <td>line_color</td> 
   <td>Object</td> 
   <td>{“r”:”0”,”g”:”0”,”b”:”0”}</td> 
   <td>auto_color 为 false 时生效，使用 rgb</td> 
  </tr> 
  <tr> 
   <td>设置颜色 例如 {“r”:”xxx”,”g”:”xxx”,”b”:”xxx”}</td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

注意：通过该接口生成的小程序码，永久有效，数量暂无限制。用户扫描该码进入小程序后，开发者需在对应页面获取的码中 scene  
字段的值，再做处理逻辑。使用如下代码可以获取到二维码中的 scene 字段的值。调试阶段可以使用开发工具的条件编译自定义参数 scene=xxxx  
进行模拟，开发工具模拟时的 scene 的参数值需要进行 urlencode。同时需要注意，此接口的page参数中不能带任何参数，参数都在scene  
参数中处理，切记！！！

// 这是首页的 js  
     Page({
          
     onLoad: function(options) {
          
     // options 中的 scene 需要使用 decodeURIComponent 才能获取到生成二维码时传入的 scene  
     var scene = decodeURIComponent(options.scene)  
     }  
     })

#### **（2）请求接口测试** ####

![这里写图片描述][SouthEast 2]

**（3）java接口开发**

/**
          * 带参数无限个数小程序码接口
          * @param url
          * @param access_token
          * @param path
          * @param width
          * @return
          */
          public static InputStream getwxacodeunlimit(String url,String access_token,String path,String width){
              String[] str = path.split("[?]");
              path = str[0];
              String scene = str[1];
              url = url + "?access_token=" + access_token;
              // 接收参数json列表
              JSONObject jsonParam = new JSONObject();
              jsonParam.put("scene", scene);
              jsonParam.put("page", path);
              jsonParam.put("width", Integer.parseInt(width));
              jsonParam.put("auto_color", false);
              Map<String,Object> line_color = new HashMap<>();
              line_color.put("r", 0);
              line_color.put("g", 0);
              line_color.put("b", 0);
              jsonParam.put("line_color", line_color);
              InputStream instreams = HttpUtils.doWXPost(url, jsonParam);
              if(BL3Utils.isEmpty(instreams)){
                  System.out.println("出错获取二维码失败！");
              }
              return instreams;
          }

参数说明

1.url ： https://api.weixin.qq.com/wxa/getwxacodeunlimit  
2.access\_token：上面有介绍（getAccessToken这个方法）  
3.path：用户扫描该码进入小程序后，将直接进入 path 对应的页面；一般是首页地址”pages/index/index”  
也可以带上参数：”pages/index/index?query=1”。  
4.width：二维码的宽度 int类型 默认 430

### 注意： ###

1.  第二种生成小程序码的情况 只有小程序上线后才能生成二维码。
2.  其他方法生成的码只有小程序上线后才会有权限访问 否则会提示小程序尚未发布

[Link 1]: https://developers.weixin.qq.com/miniprogram/dev/api/device/scan/wx.scanCode.html
[SouthEast]: https://img-blog.csdn.net/20170830095836075?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvdzQxMDU4OTUwMg==/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast
[Link 2]: https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140183
[https_api.weixin.qq.com_wxa_getwxacode_access_token_ACCESS_TOKEN]: https://api.weixin.qq.com/wxa/getwxacode?access_token=ACCESS_TOKEN
[SouthEast 1]: https://img-blog.csdn.net/20170830102022282?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvdzQxMDU4OTUwMg==/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast
[https_api.weixin.qq.com_wxa_getwxacodeunlimit_access_token_ACCESS_TOKEN]: https://api.weixin.qq.com/wxa/getwxacodeunlimit?access_token=ACCESS_TOKEN
[SouthEast 2]: https://img-blog.csdn.net/20170830110805670?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvdzQxMDU4OTUwMg==/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast