Skip to content

Commit d59dff2

Browse files
binarywangbinarywang
committed
binarywang#853 小程序模块获取二维码和小程序码接口增加对应返回byte数组的实现方法
1 parent 812de02 commit d59dff2

File tree

8 files changed

+307
-66
lines changed

8 files changed

+307
-66
lines changed

‎weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/RequestExecutor.java‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
package me.chanjar.weixin.common.util.http;
22

3-
import me.chanjar.weixin.common.error.WxErrorException;
4-
53
import java.io.IOException;
64

5+
import me.chanjar.weixin.common.error.WxErrorException;
6+
77
/**
8-
* http请求执行器
8+
* http请求执行器.
99
*
1010
* @param <T> 返回值类型
1111
* @param <E> 请求参数类型
@@ -14,6 +14,8 @@
1414
public interface RequestExecutor<T, E> {
1515

1616
/**
17+
* 执行http请求.
18+
*
1719
* @param uri uri
1820
* @param data 数据
1921
*/

‎weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/apache/InputStreamResponseHandler.java‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,29 @@
11
package me.chanjar.weixin.common.util.http.apache;
22

3+
import java.io.IOException;
4+
import java.io.InputStream;
5+
36
import org.apache.http.HttpEntity;
47
import org.apache.http.HttpResponse;
58
import org.apache.http.StatusLine;
69
import org.apache.http.client.HttpResponseException;
710
import org.apache.http.client.ResponseHandler;
811
import org.apache.http.util.EntityUtils;
912

10-
import java.io.IOException;
11-
import java.io.InputStream;
12-
13+
/**
14+
* 输入流响应处理器.
15+
*
16+
* @author Daniel Qian
17+
*/
1318
public class InputStreamResponseHandler implements ResponseHandler<InputStream> {
14-
1519
public static final ResponseHandler<InputStream> INSTANCE = new InputStreamResponseHandler();
20+
private static final int STATUS_CODE_300 = 300;
1621

1722
@Override
1823
public InputStream handleResponse(final HttpResponse response) throws IOException {
1924
final StatusLine statusLine = response.getStatusLine();
2025
final HttpEntity entity = response.getEntity();
21-
if (statusLine.getStatusCode() >= 300) {
26+
if (statusLine.getStatusCode() >= STATUS_CODE_300) {
2227
EntityUtils.consume(entity);
2328
throw new HttpResponseException(statusLine.getStatusCode(), statusLine.getReasonPhrase());
2429
}

‎weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaQrcodeService.java‎

Lines changed: 114 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
package cn.binarywang.wx.miniapp.api;
22

3+
import java.io.File;
4+
35
import cn.binarywang.wx.miniapp.bean.WxMaCodeLineColor;
46
import me.chanjar.weixin.common.error.WxErrorException;
57

6-
import java.io.File;
7-
88
/**
99
* <pre>
1010
* 二维码相关操作接口.
@@ -32,24 +32,87 @@ public interface WxMaQrcodeService {
3232
*
3333
* @param path 不能为空，最大长度 128 字节
3434
* @param width 默认430 二维码的宽度
35+
* @return 文件内容字节数组
36+
* @throws WxErrorException 异常
37+
*/
38+
byte[] createQrcodeBytes(String path, int width) throws WxErrorException;
39+
40+
/**
41+
* 接口C: 获取小程序页面二维码.
42+
* <pre>
43+
* 适用于需要的码数量较少的业务场景
44+
* 通过该接口，仅能生成已发布的小程序的二维码。
45+
* 可以在开发者工具预览时生成开发版的带参二维码。
46+
* 带参二维码只有 100000 个，请谨慎调用。
47+
* </pre>
48+
*
49+
* @param path 不能为空，最大长度 128 字节
50+
* @param width 默认430 二维码的宽度
51+
* @return 文件对象
52+
* @throws WxErrorException 异常
3553
*/
3654
File createQrcode(String path, int width) throws WxErrorException;
3755

56+
/**
57+
* 接口C: 获取小程序页面二维码.
58+
* <pre>
59+
* 适用于需要的码数量较少的业务场景
60+
* 通过该接口，仅能生成已发布的小程序的二维码。
61+
* 可以在开发者工具预览时生成开发版的带参二维码。
62+
* 带参二维码只有 100000 个，请谨慎调用。
63+
* </pre>
64+
*
65+
* @param path 不能为空，最大长度 128 字节
66+
* @return 文件对象
67+
* @throws WxErrorException 异常
68+
*/
3869
File createQrcode(String path) throws WxErrorException;
3970

4071
/**
4172
* 接口A: 获取小程序码.
4273
*
43-
* @param path 不能为空，最大长度 128 字节
44-
* @param width 默认430 二维码的宽度
45-
* @param autoColor 默认true 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
46-
* @param lineColor auth_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"}
47-
* @param is_hyaline 是否需要透明底色， is_hyaline 为true时，生成透明底色的小程序码
74+
* @param path 不能为空，最大长度 128 字节
75+
* @param width 默认430 二维码的宽度
76+
* @param autoColor 默认true 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
77+
* @param lineColor auth_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"}
78+
* @param isHyaline 是否需要透明底色， isHyaline 为true时，生成透明底色的小程序码
79+
* @return 文件内容字节数组
80+
* @throws WxErrorException 异常
81+
*/
82+
byte[] createWxaCodeBytes(String path, int width, boolean autoColor, WxMaCodeLineColor lineColor, boolean isHyaline)
83+
throws WxErrorException;
84+
85+
/**
86+
* 接口A: 获取小程序码.
87+
*
88+
* @param path 不能为空，最大长度 128 字节
89+
* @param width 默认430 二维码的宽度
90+
* @param autoColor 默认true 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
91+
* @param lineColor auth_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"}
92+
* @param isHyaline 是否需要透明底色， isHyaline 为true时，生成透明底色的小程序码
93+
* @return 文件对象
94+
* @throws WxErrorException 异常
4895
*/
49-
File createWxaCode(String path, int width, boolean autoColor, WxMaCodeLineColor lineColor, boolean is_hyaline) throws WxErrorException;
96+
File createWxaCode(String path, int width, boolean autoColor, WxMaCodeLineColor lineColor, boolean isHyaline)
97+
throws WxErrorException;
5098

99+
/**
100+
* 接口A: 获取小程序码.
101+
*
102+
* @param path 不能为空，最大长度 128 字节
103+
* @param width 默认430 二维码的宽度
104+
* @return 文件对象
105+
* @throws WxErrorException 异常
106+
*/
51107
File createWxaCode(String path, int width) throws WxErrorException;
52108

109+
/**
110+
* 接口A: 获取小程序码.
111+
*
112+
* @param path 不能为空，最大长度 128 字节
113+
* @return 文件对象
114+
* @throws WxErrorException 异常
115+
*/
53116
File createWxaCode(String path) throws WxErrorException;
54117

55118
/**
@@ -61,15 +124,56 @@ public interface WxMaQrcodeService {
61124
* 调试阶段可以使用开发工具的条件编译自定义参数 scene=xxxx 进行模拟，开发工具模拟时的 scene 的参数值需要进行 urlencode
62125
* </pre>
63126
*
64-
* @param scene 最大32个可见字符，只支持数字，大小写英文以及部分特殊字符：!#$&'()*+,/:;=?@-._~，其它字符请自行编码为合法字符（因不支持%，中文无法使用 urlencode 处理，请使用其他编码方式）
127+
* @param scene 最大32个可见字符，只支持数字，大小写英文以及部分特殊字符：!#$&'()*+,/:;=?@-._~，
128+
* 其它字符请自行编码为合法字符（因不支持%，中文无法使用 urlencode 处理，请使用其他编码方式）
129+
* @param page 必须是已经发布的小程序页面，例如 "pages/index/index" ,如果不填写这个字段，默认跳主页面
130+
* @param width 默认false 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
131+
* @param autoColor 默认true 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
132+
* @param lineColor auth_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"}
133+
* @param isHyaline 是否需要透明底色， is_hyaline 为true时，生成透明底色的小程序码
134+
* @return 文件内容字节数组
135+
* @throws WxErrorException 异常
136+
*/
137+
byte[] createWxaCodeUnlimitBytes(String scene, String page, int width, boolean autoColor,
138+
WxMaCodeLineColor lineColor, boolean isHyaline) throws WxErrorException;
139+
140+
/**
141+
* 接口B: 获取小程序码（永久有效、数量暂无限制）.
142+
* <pre>
143+
* 通过该接口生成的小程序码，永久有效，数量暂无限制。
144+
* 用户扫描该码进入小程序后，将统一打开首页，开发者需在对应页面根据获取的码中 scene 字段的值，再做处理逻辑。
145+
* 使用如下代码可以获取到二维码中的 scene 字段的值。
146+
* 调试阶段可以使用开发工具的条件编译自定义参数 scene=xxxx 进行模拟，开发工具模拟时的 scene 的参数值需要进行 urlencode
147+
* </pre>
148+
*
149+
* @param scene 最大32个可见字符，只支持数字，大小写英文以及部分特殊字符：!#$&'()*+,/:;=?@-._~，
150+
* 其它字符请自行编码为合法字符（因不支持%，中文无法使用 urlencode 处理，请使用其他编码方式）
65151
* @param page 必须是已经发布的小程序页面，例如 "pages/index/index" ,如果不填写这个字段，默认跳主页面
66152
* @param width 默认false 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
67153
* @param autoColor 默认true 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
68154
* @param lineColor auth_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"}
69155
* @param isHyaline 是否需要透明底色， is_hyaline 为true时，生成透明底色的小程序码
156+
* @return 文件对象
157+
* @throws WxErrorException 异常
70158
*/
71-
File createWxaCodeUnlimit(String scene, String page, int width, boolean autoColor, WxMaCodeLineColor lineColor, boolean isHyaline) throws WxErrorException;
159+
File createWxaCodeUnlimit(String scene, String page, int width, boolean autoColor,
160+
WxMaCodeLineColor lineColor, boolean isHyaline) throws WxErrorException;
72161

162+
/**
163+
* 接口B: 获取小程序码（永久有效、数量暂无限制）.
164+
* <pre>
165+
* 通过该接口生成的小程序码，永久有效，数量暂无限制。
166+
* 用户扫描该码进入小程序后，将统一打开首页，开发者需在对应页面根据获取的码中 scene 字段的值，再做处理逻辑。
167+
* 使用如下代码可以获取到二维码中的 scene 字段的值。
168+
* 调试阶段可以使用开发工具的条件编译自定义参数 scene=xxxx 进行模拟，开发工具模拟时的 scene 的参数值需要进行 urlencode
169+
* </pre>
170+
*
171+
* @param scene 最大32个可见字符，只支持数字，大小写英文以及部分特殊字符：!#$&'()*+,/:;=?@-._~，
172+
* 其它字符请自行编码为合法字符（因不支持%，中文无法使用 urlencode 处理，请使用其他编码方式）
173+
* @param page 必须是已经发布的小程序页面，例如 "pages/index/index" ,如果不填写这个字段，默认跳主页面
174+
* @return 文件对象
175+
* @throws WxErrorException 异常
176+
*/
73177
File createWxaCodeUnlimit(String scene, String page) throws WxErrorException;
74178

75179
}

‎weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/WxMaQrcodeServiceImpl.java‎

Lines changed: 56 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
package cn.binarywang.wx.miniapp.api.impl;
22

3+
import java.io.File;
4+
35
import cn.binarywang.wx.miniapp.api.WxMaQrcodeService;
46
import cn.binarywang.wx.miniapp.api.WxMaService;
57
import cn.binarywang.wx.miniapp.bean.WxMaCodeLineColor;
68
import cn.binarywang.wx.miniapp.bean.WxMaQrcode;
7-
import cn.binarywang.wx.miniapp.bean.WxMaWxcode;
9+
import cn.binarywang.wx.miniapp.bean.WxaCode;
810
import cn.binarywang.wx.miniapp.bean.WxaCodeUnlimit;
9-
import cn.binarywang.wx.miniapp.util.http.QrCodeRequestExecutor;
11+
import cn.binarywang.wx.miniapp.util.QrcodeBytesRequestExecutor;
12+
import cn.binarywang.wx.miniapp.util.QrcodeRequestExecutor;
1013
import me.chanjar.weixin.common.error.WxErrorException;
1114

12-
import java.io.File;
13-
1415
/**
1516
* @author <a href="https://github.com/binarywang">Binary Wang</a>
1617
*/
@@ -21,10 +22,16 @@ public WxMaQrcodeServiceImpl(WxMaService wxMaService) {
2122
this.wxMaService = wxMaService;
2223
}
2324

25+
@Override
26+
public byte[] createQrcodeBytes(String path, int width) throws WxErrorException {
27+
final QrcodeBytesRequestExecutor executor = new QrcodeBytesRequestExecutor(this.wxMaService.getRequestHttp());
28+
return this.wxMaService.execute(executor, CREATE_QRCODE_URL, new WxMaQrcode(path, width));
29+
}
30+
2431
@Override
2532
public File createQrcode(String path, int width) throws WxErrorException {
26-
return this.wxMaService.execute(new QrCodeRequestExecutor(this.wxMaService.getRequestHttp()),
27-
CREATE_QRCODE_URL, new WxMaQrcode(path, width));
33+
final QrcodeRequestExecutor executor = new QrcodeRequestExecutor(this.wxMaService.getRequestHttp());
34+
return this.wxMaService.execute(executor, CREATE_QRCODE_URL, new WxMaQrcode(path, width));
2835
}
2936

3037
@Override
@@ -33,15 +40,29 @@ public File createQrcode(String path) throws WxErrorException {
3340
}
3441

3542
@Override
36-
public File createWxaCode(String path, int width, boolean autoColor, WxMaCodeLineColor lineColor, boolean isHyaline) throws WxErrorException {
37-
WxMaWxcode wxMaWxcode = new WxMaWxcode();
38-
wxMaWxcode.setPath(path);
39-
wxMaWxcode.setWidth(width);
40-
wxMaWxcode.setAutoColor(autoColor);
41-
wxMaWxcode.setLineColor(lineColor);
42-
wxMaWxcode.setHyaline(isHyaline);
43-
return this.wxMaService.execute(new QrCodeRequestExecutor(this.wxMaService.getRequestHttp()),
44-
GET_WXACODE_URL, wxMaWxcode);
43+
public byte[] createWxaCodeBytes(String path, int width, boolean autoColor, WxMaCodeLineColor lineColor, boolean isHyaline)
44+
throws WxErrorException {
45+
final QrcodeBytesRequestExecutor executor = new QrcodeBytesRequestExecutor(this.wxMaService.getRequestHttp());
46+
return this.wxMaService.execute(executor, GET_WXACODE_URL, WxaCode.builder()
47+
.path(path)
48+
.width(width)
49+
.autoColor(autoColor)
50+
.lineColor(lineColor)
51+
.isHyaline(isHyaline)
52+
.build());
53+
}
54+
55+
@Override
56+
public File createWxaCode(String path, int width, boolean autoColor, WxMaCodeLineColor lineColor, boolean isHyaline)
57+
throws WxErrorException {
58+
final QrcodeRequestExecutor executor = new QrcodeRequestExecutor(this.wxMaService.getRequestHttp());
59+
return this.wxMaService.execute(executor, GET_WXACODE_URL, WxaCode.builder()
60+
.path(path)
61+
.width(width)
62+
.autoColor(autoColor)
63+
.lineColor(lineColor)
64+
.isHyaline(isHyaline)
65+
.build());
4566
}
4667

4768
@Override
@@ -51,21 +72,36 @@ public File createWxaCode(String path, int width) throws WxErrorException {
5172

5273
@Override
5374
public File createWxaCode(String path) throws WxErrorException {
54-
return this.createWxaCode(path, 430, true, null, false);
75+
return this.createWxaCode(path, 430);
5576
}
5677

5778
@Override
58-
public File createWxaCodeUnlimit(String scene, String page, int width, boolean autoColor, WxMaCodeLineColor lineColor, boolean isHyaline)
59-
throws WxErrorException {
79+
public byte[] createWxaCodeUnlimitBytes(String scene, String page, int width, boolean autoColor,
80+
WxMaCodeLineColor lineColor, boolean isHyaline) throws WxErrorException {
81+
return this.wxMaService.execute(new QrcodeBytesRequestExecutor(this.wxMaService.getRequestHttp()),
82+
GET_WXACODE_UNLIMIT_URL,
83+
this.buildWxaCodeUnlimit(scene, page, width, autoColor, lineColor, isHyaline));
84+
}
85+
86+
@Override
87+
public File createWxaCodeUnlimit(String scene, String page, int width, boolean autoColor,
88+
WxMaCodeLineColor lineColor, boolean isHyaline) throws WxErrorException {
89+
return this.wxMaService.execute(new QrcodeRequestExecutor(this.wxMaService.getRequestHttp()),
90+
GET_WXACODE_UNLIMIT_URL,
91+
this.buildWxaCodeUnlimit(scene, page, width, autoColor, lineColor, isHyaline));
92+
}
93+
94+
private WxaCodeUnlimit buildWxaCodeUnlimit(String scene, String page, int width, boolean autoColor,
95+
WxMaCodeLineColor lineColor, boolean isHyaline) {
6096
WxaCodeUnlimit wxaCodeUnlimit = new WxaCodeUnlimit();
6197
wxaCodeUnlimit.setScene(scene);
6298
wxaCodeUnlimit.setPage(page);
6399
wxaCodeUnlimit.setWidth(width);
64100
wxaCodeUnlimit.setAutoColor(autoColor);
65101
wxaCodeUnlimit.setLineColor(lineColor);
66102
wxaCodeUnlimit.setHyaline(isHyaline);
67-
return this.wxMaService.execute(new QrCodeRequestExecutor(this.wxMaService.getRequestHttp()),
68-
GET_WXACODE_UNLIMIT_URL, wxaCodeUnlimit);
103+
104+
return wxaCodeUnlimit;
69105
}
70106

71107
@Override

0 commit comments

Comments
 (0)