Skip to content

Commit abaec2f

Browse files
binarywangbinarywang
committed
🎨 【小程序】获取小程序码的createWxaCode相关接口支持envVersion参数
1 parent 533ea25 commit abaec2f

6 files changed

Lines changed: 71 additions & 50 deletions

File tree

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

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -101,45 +101,48 @@ public interface WxMaQrcodeService {
101101
/**
102102
* 接口A: 获取小程序码.
103103
*
104-
* @param path 不能为空，最大长度 128 字节
105-
* @param width 默认430 二维码的宽度
106-
* @param autoColor 默认true 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
107-
* @param lineColor autoColor 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"}
108-
* @param isHyaline 是否需要透明底色， isHyaline 为true时，生成透明底色的小程序码
104+
* @param path 不能为空，最大长度 128 字节
105+
* @param envVersion 默认"release" 要打开的小程序版本。正式版为 "release"，体验版为 "trial"，开发版为 "develop"
106+
* @param width 默认430 二维码的宽度
107+
* @param autoColor 默认true 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
108+
* @param lineColor autoColor 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"}
109+
* @param isHyaline 是否需要透明底色， isHyaline 为true时，生成透明底色的小程序码
109110
* @return 文件内容字节数组
110111
* @throws WxErrorException 异常
111112
*/
112-
byte[] createWxaCodeBytes(String path, int width, boolean autoColor, WxMaCodeLineColor lineColor, boolean isHyaline)
113-
throws WxErrorException;
113+
byte[] createWxaCodeBytes(String path, String envVersion, int width, boolean autoColor, WxMaCodeLineColor lineColor,
114+
boolean isHyaline) throws WxErrorException;
114115

115116
/**
116117
* 接口A: 获取小程序码.
117118
*
118-
* @param path 不能为空，最大长度 128 字节
119-
* @param width 默认430 二维码的宽度
120-
* @param filePath 二维码生成的文件路径，例如: /var/temp
121-
* @param autoColor 默认true 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
122-
* @param lineColor autoColor 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"}
123-
* @param isHyaline 是否需要透明底色， isHyaline 为true时，生成透明底色的小程序码
119+
* @param path 不能为空，最大长度 128 字节
120+
* @param envVersion 默认"release" 要打开的小程序版本。正式版为 "release"，体验版为 "trial"，开发版为 "develop"
121+
* @param width 默认430 二维码的宽度
122+
* @param filePath 二维码生成的文件路径，例如: /var/temp
123+
* @param autoColor 默认true 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
124+
* @param lineColor autoColor 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"}
125+
* @param isHyaline 是否需要透明底色， isHyaline 为true时，生成透明底色的小程序码
124126
* @return 文件对象
125127
* @throws WxErrorException 异常
126128
*/
127-
File createWxaCode(String path, int width, String filePath, boolean autoColor, WxMaCodeLineColor lineColor, boolean isHyaline)
128-
throws WxErrorException;
129+
File createWxaCode(String path, String envVersion, int width, String filePath, boolean autoColor,
130+
WxMaCodeLineColor lineColor, boolean isHyaline) throws WxErrorException;
129131

130132
/**
131133
* 接口A: 获取小程序码.
132134
*
133-
* @param path 不能为空，最大长度 128 字节
134-
* @param width 默认430 二维码的宽度
135-
* @param autoColor 默认true 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
136-
* @param lineColor autoColor 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"}
137-
* @param isHyaline 是否需要透明底色， isHyaline 为true时，生成透明底色的小程序码
135+
* @param path 不能为空，最大长度 128 字节
136+
* @param envVersion 默认"release" 要打开的小程序版本。正式版为 "release"，体验版为 "trial"，开发版为 "develop"
137+
* @param width 默认430 二维码的宽度
138+
* @param autoColor 默认true 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
139+
* @param lineColor autoColor 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"}
140+
* @param isHyaline 是否需要透明底色， isHyaline 为true时，生成透明底色的小程序码
138141
* @return 文件对象
139142
* @throws WxErrorException 异常
140143
*/
141-
File createWxaCode(String path, int width, boolean autoColor, WxMaCodeLineColor lineColor, boolean isHyaline)
142-
throws WxErrorException;
144+
File createWxaCode(String path, String envVersion, int width, boolean autoColor, WxMaCodeLineColor lineColor,
145+
boolean isHyaline) throws WxErrorException;
143146

144147
/**
145148
* 接口A: 获取小程序码.
@@ -229,8 +232,8 @@ byte[] createWxaCodeUnlimitBytes(String scene, String page, boolean checkPath, S
229232
* @return 文件对象
230233
* @throws WxErrorException 异常
231234
*/
232-
File createWxaCodeUnlimit(String scene, String page, String filePath, boolean checkPath, String envVersion, int width, boolean autoColor,
233-
WxMaCodeLineColor lineColor, boolean isHyaline) throws WxErrorException;
235+
File createWxaCodeUnlimit(String scene, String page, String filePath, boolean checkPath, String envVersion, int width,
236+
boolean autoColor, WxMaCodeLineColor lineColor, boolean isHyaline) throws WxErrorException;
234237

235238
/**
236239
* 接口B: 获取小程序码（永久有效、数量暂无限制）.

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

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,12 @@
1010
import cn.binarywang.wx.miniapp.executor.QrcodeRequestExecutor;
1111
import lombok.RequiredArgsConstructor;
1212
import me.chanjar.weixin.common.error.WxErrorException;
13+
import org.apache.commons.lang3.StringUtils;
1314

1415
import java.io.File;
1516

1617
import static cn.binarywang.wx.miniapp.constant.WxMaApiUrlConstants.Qrcode.*;
18+
import static cn.binarywang.wx.miniapp.constant.WxMaConstants.DEFAULT_ENV_VERSION;
1719

1820
/**
1921
* @author <a href="https://github.com/binarywang">Binary Wang</a>
@@ -40,11 +42,12 @@ public File createQrcode(String path) throws WxErrorException {
4042
}
4143

4244
@Override
43-
public byte[] createWxaCodeBytes(String path, int width, boolean autoColor, WxMaCodeLineColor lineColor, boolean isHyaline)
44-
throws WxErrorException {
45+
public byte[] createWxaCodeBytes(String path, String envVersion, int width, boolean autoColor,
46+
WxMaCodeLineColor lineColor, boolean isHyaline) throws WxErrorException {
4547
return this.service.execute(QrcodeBytesRequestExecutor.create(this.service.getRequestHttp()), GET_WXACODE_URL,
4648
WxaCode.builder()
4749
.path(path)
50+
.envVersion(StringUtils.defaultIfEmpty(envVersion, DEFAULT_ENV_VERSION))
4851
.width(width)
4952
.autoColor(autoColor)
5053
.lineColor(lineColor)
@@ -53,11 +56,12 @@ public byte[] createWxaCodeBytes(String path, int width, boolean autoColor, WxMa
5356
}
5457

5558
@Override
56-
public File createWxaCode(String path, int width, boolean autoColor, WxMaCodeLineColor lineColor, boolean isHyaline)
57-
throws WxErrorException {
59+
public File createWxaCode(String path, String envVersion, int width, boolean autoColor, WxMaCodeLineColor lineColor,
60+
boolean isHyaline) throws WxErrorException {
5861
return this.service.execute(QrcodeRequestExecutor.create(this.service.getRequestHttp()), GET_WXACODE_URL,
5962
WxaCode.builder()
6063
.path(path)
64+
.envVersion(StringUtils.defaultIfEmpty(envVersion, DEFAULT_ENV_VERSION))
6165
.width(width)
6266
.autoColor(autoColor)
6367
.lineColor(lineColor)
@@ -67,7 +71,7 @@ public File createWxaCode(String path, int width, boolean autoColor, WxMaCodeLin
6771

6872
@Override
6973
public File createWxaCode(String path, int width) throws WxErrorException {
70-
return this.createWxaCode(path, width, true, null, false);
74+
return this.createWxaCode(path, null, width, true, null, false);
7175
}
7276

7377
@Override
@@ -76,21 +80,22 @@ public File createWxaCode(String path) throws WxErrorException {
7680
}
7781

7882
@Override
79-
public byte[] createWxaCodeUnlimitBytes(String scene, String page, boolean checkPath, String envVersion, int width, boolean autoColor,
80-
WxMaCodeLineColor lineColor, boolean isHyaline) throws WxErrorException {
83+
public byte[] createWxaCodeUnlimitBytes(String scene, String page, boolean checkPath, String envVersion, int width,
84+
boolean autoColor, WxMaCodeLineColor lineColor, boolean isHyaline)
85+
throws WxErrorException {
8186
return this.service.execute(QrcodeBytesRequestExecutor.create(this.service.getRequestHttp()),
8287
GET_WXACODE_UNLIMIT_URL, this.buildWxaCodeUnlimit(scene, page, checkPath, envVersion, width, autoColor, lineColor, isHyaline));
8388
}
8489

8590
@Override
86-
public File createWxaCodeUnlimit(String scene, String page, boolean checkPath, String envVersion, int width, boolean autoColor,
87-
WxMaCodeLineColor lineColor, boolean isHyaline) throws WxErrorException {
91+
public File createWxaCodeUnlimit(String scene, String page, boolean checkPath, String envVersion, int width,
92+
boolean autoColor, WxMaCodeLineColor lineColor, boolean isHyaline) throws WxErrorException {
8893
return this.service.execute(QrcodeRequestExecutor.create(this.service.getRequestHttp()),
8994
GET_WXACODE_UNLIMIT_URL, this.buildWxaCodeUnlimit(scene, page, checkPath, envVersion, width, autoColor, lineColor, isHyaline));
9095
}
9196

92-
private WxaCodeUnlimit buildWxaCodeUnlimit(String scene, String page, boolean checkPath, String envVersion, int width, boolean autoColor,
93-
WxMaCodeLineColor lineColor, boolean isHyaline) {
97+
private WxaCodeUnlimit buildWxaCodeUnlimit(String scene, String page, boolean checkPath, String envVersion, int width,
98+
boolean autoColor, WxMaCodeLineColor lineColor, boolean isHyaline) {
9499
WxaCodeUnlimit wxaCodeUnlimit = new WxaCodeUnlimit();
95100
wxaCodeUnlimit.setScene(scene);
96101
wxaCodeUnlimit.setPage(page);
@@ -106,7 +111,7 @@ private WxaCodeUnlimit buildWxaCodeUnlimit(String scene, String page, boolean ch
106111

107112
@Override
108113
public File createWxaCodeUnlimit(String scene, String page) throws WxErrorException {
109-
return this.createWxaCodeUnlimit(scene, page, true, "release", 430, true, null, false);
114+
return this.createWxaCodeUnlimit(scene, page, true, DEFAULT_ENV_VERSION, 430, true, null, false);
110115
}
111116

112117
@Override
@@ -121,12 +126,12 @@ public File createQrcode(String path, String filePath) throws WxErrorException {
121126
}
122127

123128
@Override
124-
public File createWxaCode(String path, int width, String filePath, boolean autoColor, WxMaCodeLineColor lineColor,
125-
boolean isHyaline)
126-
throws WxErrorException {
129+
public File createWxaCode(String path, String envVersion, int width, String filePath, boolean autoColor,
130+
WxMaCodeLineColor lineColor, boolean isHyaline) throws WxErrorException {
127131
return this.service.execute(QrcodeRequestExecutor.create(this.service.getRequestHttp(), filePath), GET_WXACODE_URL,
128132
WxaCode.builder()
129133
.path(path)
134+
.envVersion(StringUtils.defaultIfEmpty(envVersion, DEFAULT_ENV_VERSION))
130135
.width(width)
131136
.autoColor(autoColor)
132137
.lineColor(lineColor)
@@ -136,7 +141,7 @@ public File createWxaCode(String path, int width, String filePath, boolean autoC
136141

137142
@Override
138143
public File createWxaCode(String path, int width, String filePath) throws WxErrorException {
139-
return this.createWxaCode(path, width, filePath, true, null, false);
144+
return this.createWxaCode(path, null, width, filePath, true, null, false);
140145
}
141146

142147
@Override
@@ -145,15 +150,16 @@ public File createWxaCode(String path, String filePath) throws WxErrorException
145150
}
146151

147152
@Override
148-
public File createWxaCodeUnlimit(String scene, String page, String filePath, boolean checkPath, String envVersion, int width, boolean autoColor,
149-
WxMaCodeLineColor lineColor, boolean isHyaline) throws WxErrorException {
153+
public File createWxaCodeUnlimit(String scene, String page, String filePath, boolean checkPath, String envVersion,
154+
int width, boolean autoColor, WxMaCodeLineColor lineColor, boolean isHyaline)
155+
throws WxErrorException {
150156
return this.service.execute(QrcodeRequestExecutor.create(this.service.getRequestHttp(), filePath),
151157
GET_WXACODE_UNLIMIT_URL, this.buildWxaCodeUnlimit(scene, page, checkPath, envVersion, width, autoColor, lineColor, isHyaline));
152158
}
153159

154160
@Override
155161
public File createWxaCodeUnlimit(String scene, String page, String filePath) throws WxErrorException {
156-
return this.createWxaCodeUnlimit(scene, page, filePath, true, "release", 430, true, null, false);
162+
return this.createWxaCodeUnlimit(scene, page, filePath, true, DEFAULT_ENV_VERSION, 430, true, null, false);
157163
}
158164

159165
}

‎weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/WxaCode.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
import lombok.EqualsAndHashCode;
1111
import lombok.NoArgsConstructor;
1212

13+
import static cn.binarywang.wx.miniapp.constant.WxMaConstants.DEFAULT_ENV_VERSION;
14+
1315
/**
1416
* 小程序码.
1517
*
@@ -26,6 +28,9 @@ public class WxaCode extends AbstractWxMaQrcodeWrapper implements Serializable {
2628

2729
private String path;
2830

31+
@SerializedName("env_version")
32+
private String envVersion = DEFAULT_ENV_VERSION;
33+
2934
@Builder.Default
3035
private int width = 430;
3136

‎weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/WxaCodeUnlimit.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
import java.io.Serializable;
99

10+
import static cn.binarywang.wx.miniapp.constant.WxMaConstants.DEFAULT_ENV_VERSION;
11+
1012
/**
1113
* 小程序码接口B.
1214
*
@@ -24,7 +26,7 @@ public class WxaCodeUnlimit extends AbstractWxMaQrcodeWrapper implements Seriali
2426
private boolean checkPath = true;
2527

2628
@SerializedName("env_version")
27-
private String envVersion = "release";
29+
private String envVersion = DEFAULT_ENV_VERSION;
2830

2931
private int width = 430;
3032

‎weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/constant/WxMaConstants.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ public abstract class WxMaConstants {
1111
private WxMaConstants() {
1212
}
1313

14+
/**
15+
* 默认的env_version值
16+
*/
17+
public static final String DEFAULT_ENV_VERSION = "release";
18+
1419
/**
1520
* 微信接口返回的参数errcode.
1621
*/

‎weixin-java-miniapp/src/test/java/cn/binarywang/wx/miniapp/api/impl/WxMaQrcodeServiceImplTest.java‎

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

3-
import java.io.File;
4-
5-
import org.testng.annotations.*;
6-
73
import cn.binarywang.wx.miniapp.api.WxMaService;
84
import cn.binarywang.wx.miniapp.test.ApiTestModule;
95
import com.google.inject.Inject;
106
import me.chanjar.weixin.common.error.WxErrorException;
7+
import org.testng.annotations.Guice;
8+
import org.testng.annotations.Test;
9+
10+
import java.io.File;
1111

1212
import static org.assertj.core.api.Assertions.assertThat;
1313

@@ -46,7 +46,7 @@ public void testCreateQrcodeBytes() throws WxErrorException {
4646

4747
@Test
4848
public void testCreateWxaCodeBytes() throws WxErrorException {
49-
final byte[] wxCode = this.wxService.getQrcodeService().createWxaCodeBytes("111", 122, true, null, false);
49+
final byte[] wxCode = this.wxService.getQrcodeService().createWxaCodeBytes("111", null, 122, true, null, false);
5050
assertThat(wxCode).isNotNull();
5151
}
5252

@@ -70,7 +70,7 @@ public void testCreateWxaCodeByFile() throws WxErrorException {
7070

7171
@Test
7272
public void testCreateQrcodeUnlimitByFile() throws WxErrorException {
73-
final File wxCode = this.wxService.getQrcodeService().createWxaCodeUnlimit("111",null,"/opt/logs");
73+
final File wxCode = this.wxService.getQrcodeService().createWxaCodeUnlimit("111", null, "/opt/logs");
7474
assertThat(wxCode).isNotNull();
7575
}
7676
}

0 commit comments

Comments
 (0)