From 172b96444fc6fc27a1e528a66fe075b55897bb2b Mon Sep 17 00:00:00 2001
From: Well
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/apache/DefaultApacheHttpClientBuilder.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/apache/DefaultApacheHttpClientBuilder.java
index d071dc97d2..ef7120b768 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/apache/DefaultApacheHttpClientBuilder.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/apache/DefaultApacheHttpClientBuilder.java
@@ -93,6 +93,12 @@ public class DefaultApacheHttpClientBuilder implements ApacheHttpClientBuilder {
*/
private String userAgent;
+ /**
+ * 支持的TLS协议版本,默认支持现代TLS版本
+ * Supported TLS protocol versions, defaults to modern TLS versions
+ */
+ private String[] supportedProtocols = {"TLSv1.2", "TLSv1.3", "TLSv1.1", "TLSv1"};
+
/**
* 自定义请求拦截器
*/
@@ -179,6 +185,12 @@ public ApacheHttpClientBuilder sslConnectionSocketFactory(SSLConnectionSocketFac
return this;
}
+ @Override
+ public ApacheHttpClientBuilder supportedProtocols(String[] supportedProtocols) {
+ this.supportedProtocols = supportedProtocols;
+ return this;
+ }
+
public IdleConnectionMonitorThread getIdleConnectionMonitorThread() {
return this.idleConnectionMonitorThread;
}
@@ -257,7 +269,7 @@ private SSLConnectionSocketFactory buildSSLConnectionSocketFactory() {
return new SSLConnectionSocketFactory(
sslcontext,
- new String[]{"TLSv1"},
+ this.supportedProtocols,
null,
SSLConnectionSocketFactory.getDefaultHostnameVerifier());
} catch (NoSuchAlgorithmException | KeyManagementException | KeyStoreException e) {
diff --git a/weixin-java-common/src/test/java/me/chanjar/weixin/common/util/http/apache/SSLConfigurationTest.java b/weixin-java-common/src/test/java/me/chanjar/weixin/common/util/http/apache/SSLConfigurationTest.java
new file mode 100644
index 0000000000..cecda5ca54
--- /dev/null
+++ b/weixin-java-common/src/test/java/me/chanjar/weixin/common/util/http/apache/SSLConfigurationTest.java
@@ -0,0 +1,116 @@
+package me.chanjar.weixin.common.util.http.apache;
+
+import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
+import org.apache.http.impl.client.CloseableHttpClient;
+import org.testng.Assert;
+import org.testng.annotations.Test;
+
+import javax.net.ssl.SSLContext;
+import javax.net.ssl.SSLSocket;
+import javax.net.ssl.SSLSocketFactory;
+import java.lang.reflect.Constructor;
+import java.lang.reflect.Field;
+import java.util.Arrays;
+import java.util.List;
+
+/**
+ * 测试SSL配置,特别是TLS协议版本配置
+ * Test SSL configuration, especially TLS protocol version configuration
+ */
+public class SSLConfigurationTest {
+
+ @Test
+ public void testDefaultTLSProtocols() throws Exception {
+ // Create a new instance to check the default configuration
+ Class> builderClass = DefaultApacheHttpClientBuilder.class;
+ Object builder = builderClass.getDeclaredMethod("get").invoke(null);
+
+ // 验证默认支持的TLS协议版本包含现代版本
+ Field supportedProtocolsField = builderClass.getDeclaredField("supportedProtocols");
+ supportedProtocolsField.setAccessible(true);
+ String[] supportedProtocols = (String[]) supportedProtocolsField.get(builder);
+
+ List
+ * 字段说明:
+ *
+ * 提供微信公众号群发消息的功能,包括图文消息、视频消息的群发,
+ * 支持按分组群发、按openid列表群发、消息预览、群发状态查询等功能。
+ *
+ * 详情请见:群发消息开发文档
+ *
+ * 提供微信模板消息的发送、行业设置、模板管理等功能。
+ * 模板消息用于在用户触发特定事件后,向用户发送重要的服务通知。
+ *
+ * 详情请见:模板消息开发文档
+ *
+ * 提供微信公众号用户标签的创建、查询、更新、删除等功能。
+ * 通过标签可以方便地对用户进行分组管理和精准营销。
+ * 一个公众号最多可以创建100个标签。
+ *
+ * 详情请见:用户标签管理
+ *
+ * 微信支付为商户提供的运营工具转账能力,用于商户的日常运营活动中进行转账操作
+ *
+ * @author WxJava Team
+ * @see 运营工具-商家转账API
+ */
+public interface BusinessOperationTransferService {
+
+ /**
+ *
+ * 注意:由于预约扣费功能需要用户授权和实际的签约关系,
+ * 这些测试主要用于验证接口调用的正确性,而不是功能的完整性。
+ * 实际测试需要在具有有效签约关系的环境中进行。
+ *
+ * 用于获取所有小程序类目的 ID 和名称信息,包括一级类目和二级类目。
+ *
+ * 包含一级类目和二级类目的 ID 和名称。
+ *
+ * 问题背景:当微信返回的 XML 包含某些未在 WxPayOrderNotifyResult 中定义的字段时,
+ * 这些字段会被微信服务器用于签名计算。如果 toMap() 方法丢失了这些字段,
+ * 则签名验证会失败,抛出 "参数格式校验错误!" 异常。
+ *
+ * 解决方案:修改 WxPayOrderNotifyResult.toMap() 方法,使用父类的 toMap() 方法
+ * 直接从原始 XML 解析所有字段,而不是使用 SignUtils.xmlBean2Map(this)。
+ *
+ * 通过 code 换取用户登录态信息,用于多端登录场景(如手表端)。
+ *
+ * 从业机构调用该接口向微信医保后台下单
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4012503131
+ * @author xgl
+ * @date 2025/12/19 14:37
+ */
+@Data
+@Builder(builderMethodName = "newBuilder")
+@NoArgsConstructor
+@AllArgsConstructor
+public class MedInsOrdersRequest {
+
+ /**
+ *
+ * 从业机构调用医保自费混合收款下单接口后返回的结果
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4012503131
+ * @author xgl
+ * @date 2025/12/19 14:37
+ */
+@Data
+public class MedInsOrdersResult {
+ /**
+ *
+ * 从业机构调用该接口向微信医保后台通知医保订单的退款成功结果
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4012166534
+ * @author xgl
+ * @date 2025/12/20
+ */
+@Data
+@Builder(builderMethodName = "newBuilder")
+@NoArgsConstructor
+@AllArgsConstructor
+public class MedInsRefundNotifyRequest {
+
+ /**
+ *
+ * 描述医保自费混合支付中现金增加的类型
+ *
+ * @author xgl
+ * @date 2025/12/20
+ */
+public enum CashAddTypeEnum {
+ /**
+ * 默认增加类型
+ */
+ @SerializedName("DEFAULT_ADD_TYPE")
+ DEFAULT_ADD_TYPE,
+ /**
+ * 运费
+ */
+ @SerializedName("FREIGHT")
+ FREIGHT,
+ /**
+ * 其他医疗费用
+ */
+ @SerializedName("OTHER_MEDICAL_EXPENSES")
+ OTHER_MEDICAL_EXPENSES
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/CashReduceTypeEnum.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/CashReduceTypeEnum.java
new file mode 100644
index 0000000000..4f90b8500a
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/CashReduceTypeEnum.java
@@ -0,0 +1,44 @@
+package com.github.binarywang.wxpay.bean.mipay.enums;
+
+import com.google.gson.annotations.SerializedName;
+
+/**
+ * 现金减少类型枚举
+ *
+ * 描述医保自费混合支付中现金减少的类型
+ *
+ * @author xgl
+ * @date 2025/12/20
+ */
+public enum CashReduceTypeEnum {
+ /**
+ * 默认减少类型
+ */
+ @SerializedName("DEFAULT_REDUCE_TYPE")
+ DEFAULT_REDUCE_TYPE,
+ /**
+ * 医院减免
+ */
+ @SerializedName("HOSPITAL_REDUCE")
+ HOSPITAL_REDUCE,
+ /**
+ * 药店折扣
+ */
+ @SerializedName("PHARMACY_DISCOUNT")
+ PHARMACY_DISCOUNT,
+ /**
+ * 折扣优惠
+ */
+ @SerializedName("DISCOUNT")
+ DISCOUNT,
+ /**
+ * 预付费抵扣
+ */
+ @SerializedName("PRE_PAYMENT")
+ PRE_PAYMENT,
+ /**
+ * 押金扣除
+ */
+ @SerializedName("DEPOSIT_DEDUCTION")
+ DEPOSIT_DEDUCTION
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/MedInsPayStatusEnum.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/MedInsPayStatusEnum.java
new file mode 100644
index 0000000000..324530f0ff
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/MedInsPayStatusEnum.java
@@ -0,0 +1,44 @@
+package com.github.binarywang.wxpay.bean.mipay.enums;
+
+import com.google.gson.annotations.SerializedName;
+
+/**
+ * 医保支付状态枚举
+ *
+ * 描述医保自费混合支付中医保部分的支付状态
+ *
+ * @author xgl
+ * @date 2025/12/20
+ */
+public enum MedInsPayStatusEnum {
+ /**
+ * 未知的医保支付状态
+ */
+ @SerializedName("UNKNOWN_MED_INS_PAY_STATUS")
+ UNKNOWN_MED_INS_PAY_STATUS,
+ /**
+ * 医保支付已创建
+ */
+ @SerializedName("MED_INS_PAY_CREATED")
+ MED_INS_PAY_CREATED,
+ /**
+ * 医保支付成功
+ */
+ @SerializedName("MED_INS_PAY_SUCCESS")
+ MED_INS_PAY_SUCCESS,
+ /**
+ * 医保支付已退款
+ */
+ @SerializedName("MED_INS_PAY_REFUND")
+ MED_INS_PAY_REFUND,
+ /**
+ * 医保支付失败
+ */
+ @SerializedName("MED_INS_PAY_FAIL")
+ MED_INS_PAY_FAIL,
+ /**
+ * 无需医保支付
+ */
+ @SerializedName("NO_MED_INS_PAY")
+ NO_MED_INS_PAY
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/MixPayStatusEnum.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/MixPayStatusEnum.java
new file mode 100644
index 0000000000..7360704986
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/MixPayStatusEnum.java
@@ -0,0 +1,39 @@
+package com.github.binarywang.wxpay.bean.mipay.enums;
+
+import com.google.gson.annotations.SerializedName;
+
+/**
+ * 混合支付状态枚举
+ *
+ * 描述医保自费混合支付的整体状态
+ *
+ * @author xgl
+ * @date 2025/12/20
+ */
+public enum MixPayStatusEnum {
+ /**
+ * 未知的混合支付状态
+ */
+ @SerializedName("UNKNOWN_MIX_PAY_STATUS")
+ UNKNOWN_MIX_PAY_STATUS,
+ /**
+ * 混合支付已创建
+ */
+ @SerializedName("MIX_PAY_CREATED")
+ MIX_PAY_CREATED,
+ /**
+ * 混合支付成功
+ */
+ @SerializedName("MIX_PAY_SUCCESS")
+ MIX_PAY_SUCCESS,
+ /**
+ * 混合支付已退款
+ */
+ @SerializedName("MIX_PAY_REFUND")
+ MIX_PAY_REFUND,
+ /**
+ * 混合支付失败
+ */
+ @SerializedName("MIX_PAY_FAIL")
+ MIX_PAY_FAIL
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/MixPayTypeEnum.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/MixPayTypeEnum.java
new file mode 100644
index 0000000000..ad62d50a66
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/MixPayTypeEnum.java
@@ -0,0 +1,41 @@
+package com.github.binarywang.wxpay.bean.mipay.enums;
+
+import com.google.gson.annotations.SerializedName;
+
+/**
+ * 混合支付类型枚举
+ *
+ * 描述医保自费混合支付的类型
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4012503131
+ *
+ * @author xgl
+ * @date 2025/12/20 09:21
+ */
+public enum MixPayTypeEnum {
+
+ /**
+ * 未知的混合支付类型,会被拦截。
+ */
+ @SerializedName("UNKNOWN_MIX_PAY_TYPE")
+ UNKNOWN_MIX_PAY_TYPE,
+
+ /**
+ * 只向微信支付下单,没有向医保局下单。包括没有向医保局上传费用明细、预结算。
+ */
+ @SerializedName("CASH_ONLY")
+ CASH_ONLY,
+
+ /**
+ * 只向医保局下单,没有向微信支付下单。如果医保局分账结果中有自费部份,但由于有减免抵扣,没有向微信支付下单,也是纯医保。
+ */
+ @SerializedName("INSURANCE_ONLY")
+ INSURANCE_ONLY,
+
+ /**
+ * 向医保局下单,也向微信支付下单。如果医保预结算全部需自费,也属于混合类型。
+ */
+ @SerializedName("CASH_AND_INSURANCE")
+ CASH_AND_INSURANCE
+
+
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/OrderTypeEnum.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/OrderTypeEnum.java
new file mode 100644
index 0000000000..749b1276e7
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/OrderTypeEnum.java
@@ -0,0 +1,87 @@
+package com.github.binarywang.wxpay.bean.mipay.enums;
+
+import com.google.gson.annotations.SerializedName;
+
+/**
+ * 订单类型枚举
+ *
+ * 描述医保自费混合支付的订单类型
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4012503131
+ *
+ * @author xgl
+ * @date 2025/12/20
+ */
+public enum OrderTypeEnum {
+
+ /**
+ * 未知类型,会被拦截
+ */
+ @SerializedName("UNKNOWN_ORDER_TYPE")
+ UNKNOWN_ORDER_TYPE,
+
+ /**
+ * 挂号支付
+ */
+ @SerializedName("REG_PAY")
+ REG_PAY,
+
+ /**
+ * 诊间支付
+ */
+ @SerializedName("DIAG_PAY")
+ DIAG_PAY,
+
+ /**
+ * 新冠检测费用(核酸)
+ */
+ @SerializedName("COVID_EXAM_PAY")
+ COVID_EXAM_PAY,
+
+ /**
+ * 住院费支付
+ */
+ @SerializedName("IN_HOSP_PAY")
+ IN_HOSP_PAY,
+
+ /**
+ * 药店支付
+ */
+ @SerializedName("PHARMACY_PAY")
+ PHARMACY_PAY,
+
+ /**
+ * 保险费支付
+ */
+ @SerializedName("INSURANCE_PAY")
+ INSURANCE_PAY,
+
+ /**
+ * 互联网医院挂号支付
+ */
+ @SerializedName("INT_REG_PAY")
+ INT_REG_PAY,
+
+ /**
+ * 互联网医院复诊支付
+ */
+ @SerializedName("INT_RE_DIAG_PAY")
+ INT_RE_DIAG_PAY,
+
+ /**
+ * 互联网医院处方支付
+ */
+ @SerializedName("INT_RX_PAY")
+ INT_RX_PAY,
+
+ /**
+ * 新冠抗原检测
+ */
+ @SerializedName("COVID_ANTIGEN_PAY")
+ COVID_ANTIGEN_PAY,
+
+ /**
+ * 药费支付
+ */
+ @SerializedName("MED_PAY")
+ MED_PAY
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/SelfPayStatusEnum.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/SelfPayStatusEnum.java
new file mode 100644
index 0000000000..a7014b9e13
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/SelfPayStatusEnum.java
@@ -0,0 +1,44 @@
+package com.github.binarywang.wxpay.bean.mipay.enums;
+
+import com.google.gson.annotations.SerializedName;
+
+/**
+ * 自费支付状态枚举
+ *
+ * 描述医保自费混合支付中自费部分的支付状态
+ *
+ * @author xgl
+ * @date 2025/12/20
+ */
+public enum SelfPayStatusEnum {
+ /**
+ * 未知的自费支付状态
+ */
+ @SerializedName("UNKNOWN_SELF_PAY_STATUS")
+ UNKNOWN_SELF_PAY_STATUS,
+ /**
+ * 自费支付已创建
+ */
+ @SerializedName("SELF_PAY_CREATED")
+ SELF_PAY_CREATED,
+ /**
+ * 自费支付成功
+ */
+ @SerializedName("SELF_PAY_SUCCESS")
+ SELF_PAY_SUCCESS,
+ /**
+ * 自费支付已退款
+ */
+ @SerializedName("SELF_PAY_REFUND")
+ SELF_PAY_REFUND,
+ /**
+ * 自费支付失败
+ */
+ @SerializedName("SELF_PAY_FAIL")
+ SELF_PAY_FAIL,
+ /**
+ * 无需自费支付
+ */
+ @SerializedName("NO_SELF_PAY")
+ NO_SELF_PAY
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/UserCardTypeEnum.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/UserCardTypeEnum.java
new file mode 100644
index 0000000000..1bf97b7628
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/UserCardTypeEnum.java
@@ -0,0 +1,54 @@
+package com.github.binarywang.wxpay.bean.mipay.enums;
+
+import com.google.gson.annotations.SerializedName;
+
+/**
+ * 用户证件类型枚举
+ *
+ * 描述医保自费混合支付中用户的证件类型
+ *
+ * @author xgl
+ * @date 2025/12/20
+ */
+public enum UserCardTypeEnum {
+ /**
+ * 未知的用户证件类型
+ */
+ @SerializedName("UNKNOWN_USER_CARD_TYPE")
+ UNKNOWN_USER_CARD_TYPE,
+ /**
+ * 居民身份证
+ */
+ @SerializedName("ID_CARD")
+ ID_CARD,
+ /**
+ * 户口本
+ */
+ @SerializedName("HOUSEHOLD_REGISTRATION")
+ HOUSEHOLD_REGISTRATION,
+ /**
+ * 外国护照
+ */
+ @SerializedName("FOREIGNER_PASSPORT")
+ FOREIGNER_PASSPORT,
+ /**
+ * 台湾居民来往大陆通行证
+ */
+ @SerializedName("MAINLAND_TRAVEL_PERMIT_FOR_TW")
+ MAINLAND_TRAVEL_PERMIT_FOR_TW,
+ /**
+ * 澳门居民来往大陆通行证
+ */
+ @SerializedName("MAINLAND_TRAVEL_PERMIT_FOR_MO")
+ MAINLAND_TRAVEL_PERMIT_FOR_MO,
+ /**
+ * 香港居民来往大陆通行证
+ */
+ @SerializedName("MAINLAND_TRAVEL_PERMIT_FOR_HK")
+ MAINLAND_TRAVEL_PERMIT_FOR_HK,
+ /**
+ * 外国人永久居留身份证
+ */
+ @SerializedName("FOREIGN_PERMANENT_RESIDENT")
+ FOREIGN_PERMANENT_RESIDENT
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/MiPayNotifyV3Result.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/MiPayNotifyV3Result.java
new file mode 100644
index 0000000000..a0641379fb
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/MiPayNotifyV3Result.java
@@ -0,0 +1,265 @@
+package com.github.binarywang.wxpay.bean.notify;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ *
+ * 文档地址:用工关系简介
+ *
+ * 企业可以调用该接口解除和用户的B2C用工关系
+ *
+ * 企业可以调用该接口向用户推送用工相关消息
+ *
+ * 文档地址:推送用工消息
+ *
+ * 文档地址:解绑用工关系
+ *
+ * 重要提示:审核额度限制
+ *
+ * 最佳实践:
+ *
+ * 文档地址:
+ * 查询额度
+ *
+ * 返回字段说明:
+ *
+ * 重要说明:
+ *
+ * 使用示例:
+ *
+ * 重要提示:审核额度限制
+ *
+ * 使用示例:
+ *
+ * 用于查询第三方平台服务商的当月提交审核限额和加急次数
+ *
+ * 字段说明:
+ *
+ * 重要提示:
+ *
+ * 这是一个完整的示例,展示如何在提交审核前检查额度,避免额度不足导致的失败
+ *
+ * 当需要为多个小程序提交审核时,应该先统一检查额度是否充足
+ *
+ * 参考:{@code https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140842}
+ *
+ * 参考:{@code https://mp.weixin.qq.com/cgi-bin/announce?action=getannouncement&announce_id=11513156443eZYea&version=&lang=zh_CN}
+ *
* 请阅读:
* 公众平台:全局返回码说明
* 企业微信:全局错误码
+ *
+ * 对应操作:{@code uploadTempMedia}
* 对应地址:
- * POST https://api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=TYPE
+ * {@code POST https://api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=TYPE}
* 参考文档地址: https://developers.weixin.qq.com/miniprogram/dev/api/open-api/customer-message/uploadTempMedia.html
- *
+ * 导入抽样数据到微信后台,用于流量分配。
* 第三方通过调用微信API,将数据写入到setdynamicdata这个API。每个Post数据包不超过5K,若数据过多可开多进(线)程并发导入数据(例如:数据量为十万量级可以开50个线程并行导数据)。
* 文档地址:https://wsad.weixin.qq.com/wsad/zh_CN/htmledition/widget-docs-v3/html/custom/quickstart/implement/import/index.html
* http请求方式:POST http(s)://api.weixin.qq.com/wxa/setdynamicdata?access_token=ACCESS_TOKEN
- *
*
- * @param lifespan 数据有效时间,秒为单位,一般为86400,一天一次导入的频率
- * @param type 用于标识数据所属的服务类目
- * @param scene 1代表用于搜索的数据
- * @param data 推送到微信后台的数据列表,该数据被微信用于流量分配,注意该字段为string类型而不是object
- * @throws WxErrorException .
+ * @param lifespan 数据有效时间(秒),如 86400 表示一天
+ * @param type 数据所属服务类目标识
+ * @param scene 场景值,1 代表用于搜索的数据
+ * @param data 推送到微信后台的数据列表(字符串类型)
+ * @throws WxErrorException 调用微信接口失败时抛出
*/
void setDynamicData(int lifespan, String type, int scene, String data) throws WxErrorException;
/**
- *
- *
- *
- * 验证消息的确来自微信服务器.
+ * 校验消息是否来自微信服务器。
* 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421135319&token=&lang=zh_CN
- *
*
- * @param timestamp the timestamp
- * @param nonce the nonce
- * @param signature the signature
- * @return the boolean
+ * @param timestamp 时间戳
+ * @param nonce 随机数
+ * @param signature 签名字符串
+ * @return 校验通过返回 true,否则返回 false
*/
boolean checkSignature(String timestamp, String nonce, String signature);
/**
- * 获取access_token, 不强制刷新access_token.
+ * 获取 access_token,不强制刷新。
*
- * @return the access token
- * @throws WxErrorException the wx error exception
- * @see #getAccessToken(boolean) #getAccessToken(boolean)
+ * @return access_token 字符串
+ * @throws WxErrorException 调用微信接口失败时抛出
+ * @see #getAccessToken(boolean)
*/
String getAccessToken() throws WxErrorException;
/**
+ * 获取 access_token,本方法线程安全。多线程同时刷新时只刷新一次,避免超出调用次数上限。
+ * 一般无需主动调用,所有接口会自动处理 token 过期。
+ * 详情见:http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140183&token=&lang=zh_CN
*
- *
- *
- * 获取access_token,本方法线程安全.
- * 且在多线程同时刷新时只刷新一次,避免超出2000次/日的调用次数上限
- *
- * 另:本service的所有方法都会在access_token过期是调用此方法
- *
- * 程序员在非必要情况下尽量不要主动调用此方法
- *
- * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140183&token=&lang=zh_CN
- *
- *
- * @param forceRefresh 强制刷新
- * @return the access token
- * @throws WxErrorException the wx error exception
+ * @param forceRefresh 是否强制刷新
+ * @return access_token 字符串
+ * @throws WxErrorException 调用微信接口失败时抛出
*/
String getAccessToken(boolean forceRefresh) throws WxErrorException;
/**
- *
- *
- *
* 用户支付完成后,获取该用户的 UnionId,无需用户授权。本接口支持第三方平台代理查询。
- *
* 注意:调用前需要用户完成支付,且在支付后的五分钟内有效。
* 请求地址: GET https://api.weixin.qq.com/wxa/getpaidunionid?access_token=ACCESS_TOKEN&openid=OPENID
- * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/api/getPaidUnionId.html
- *
+ * 文档:https://developers.weixin.qq.com/miniprogram/dev/api/getPaidUnionId.html
*
- * @param openid 必填 支付用户唯一标识
- * @param transactionId 非必填 微信支付订单号
- * @param mchId 非必填 微信支付分配的商户号,和商户订单号配合使用
- * @param outTradeNo 非必填 微信支付商户订单号,和商户号配合使用
- * @return UnionId. paid union id
- * @throws WxErrorException .
+ * @param openid 支付用户唯一标识(必填)
+ * @param transactionId 微信支付订单号(可选)
+ * @param mchId 微信支付分配的商户号,与商户订单号配合使用(可选)
+ * @param outTradeNo 微信支付商户订单号,与商户号配合使用(可选)
+ * @return 用户的 UnionId
+ * @throws WxErrorException 调用微信接口失败时抛出
*/
String getPaidUnionId(String openid, String transactionId, String mchId, String outTradeNo)
throws WxErrorException;
/**
+ * 执行自定义的微信API请求。
+ *
+ * Service没有实现某个API的时候,可以用这个方法,比{@link #get}和{@link #post}方法更灵活,可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。
+ * 可以参考 {@link MediaUploadRequestExecutor} 的实现方法。
*
- *
- *
- * Service没有实现某个API的时候,可以用这个,
- * 比{@link #get}和{@link #post}方法更灵活,可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。
- * 可以参考,{@link MediaUploadRequestExecutor}的实现方法
- *
- *
- * @param
- * 设置当微信系统响应系统繁忙时,要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试.
- * 默认:1000ms
- *
- *
- * @param retrySleepMillis 重试等待毫秒数
+ * @param retrySleepMillis 重试等待的毫秒数,默认1000ms
*/
void setRetrySleepMillis(int retrySleepMillis);
/**
+ * 设置微信系统繁忙时的最大重试次数。
*
- *
- *
- * 设置当微信系统响应系统繁忙时,最大重试次数.
- * 默认:5次
- *
- *
- * @param maxRetryTimes 最大重试次数
+ * @param maxRetryTimes 最大重试次数,默认5次
*/
void setMaxRetryTimes(int maxRetryTimes);
/**
- * 获取WxMaConfig 对象.
+ * 获取当前小程序的配置信息对象。
*
- * @return WxMaConfig wx ma config
+ * @return 当前小程序的WxMaConfig配置对象
*/
WxMaConfig getWxMaConfig();
/**
- * 注入 {@link WxMaConfig} 的实现.
+ * 注入小程序配置信息。
*
- * @param maConfig config
+ * @param maConfig 小程序配置信息对象
*/
void setWxMaConfig(WxMaConfig maConfig);
/**
- * Map里 加入新的 {@link WxMaConfig},适用于动态添加新的微信公众号配置.
+ * 动态添加新的小程序配置信息。
*
- * @param miniappId 小程序标识
- * @param configStorage 新的微信配置
+ * @param miniappId 小程序唯一标识
+ * @param configStorage 新的小程序配置信息
*/
void addConfig(String miniappId, WxMaConfig configStorage);
/**
- * 从 Map中 移除 {@link String miniappId} 所对应的 {@link WxMaConfig},适用于动态移除小程序配置.
+ * 动态移除指定小程序的配置信息。
*
- * @param miniappId 对应小程序的标识
+ * @param miniappId 小程序唯一标识
*/
void removeConfig(String miniappId);
/**
- * 注入多个 {@link WxMaConfig} 的实现. 并为每个 {@link WxMaConfig} 赋予不同的 {@link String mpId} 值 随机采用一个{@link
- * String mpId}进行Http初始化操作
+ * 批量注入多个小程序配置信息。
*
- * @param configs WxMaConfig map
+ * @param configs 小程序配置Map,key为小程序标识
*/
void setMultiConfigs(Map
+ * 文档:https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/intracity_service.html
+ *
+ * @return 同城配送服务对象WxMaIntracityService
*/
WxMaIntracityService getIntracityService();
}
From a45f0ac04869c86db2bb2a314d06fbcc3720bca3 Mon Sep 17 00:00:00 2001
From: Binary Wang
Date: Wed, 2 Jul 2025 10:17:11 +0800
Subject: [PATCH 004/208] =?UTF-8?q?:art:=20=E4=BC=98=E5=8C=96=E5=B0=8F?=
=?UTF-8?q?=E7=A8=8B=E5=BA=8F=E4=BA=91=E5=BC=80=E5=8F=91=E6=8E=A5=E5=8F=A3?=
=?UTF-8?q?=E7=B1=BB=E7=9A=84=E6=B3=A8=E9=87=8A=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../wx/miniapp/api/WxMaCloudService.java | 538 ++++++++----------
1 file changed, 228 insertions(+), 310 deletions(-)
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaCloudService.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaCloudService.java
index 81a6cfca30..ea7e9ab20f 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaCloudService.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaCloudService.java
@@ -16,539 +16,457 @@
*/
public interface WxMaCloudService {
/**
- * Invoke cloud function string.
+ * 触发云函数。注意:HTTP API 途径触发云函数不包含用户信息。
*
- * @param name the name
- * @param body the body
- * @return the string
- * @throws WxErrorException the wx error exception
+ * @param name 云函数名称
+ * @param body 云函数的传入参数,具体结构由开发者定义
+ * @return 云函数返回的buffer
+ * @throws WxErrorException 调用失败时抛出
*/
String invokeCloudFunction(String name, String body) throws WxErrorException;
/**
- *
* 触发云函数。注意:HTTP API 途径触发云函数不包含用户信息。
* 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/functions/invokeCloudFunction.html
*
- * 请求地址
- * POST https://api.weixin.qq.com/tcb/invokecloudfunction?access_token=ACCESS_TOKEN&env=ENV&name=FUNCTION_NAME
- *
- *
- *
- * @param env string 是 云开发环境ID
- * @param name string 是 云函数名称
- * @param body string 是 云函数的传入参数,具体结构由开发者定义。
- * @return resp_data string 云函数返回的buffer
- * @throws WxErrorException .
+ * @param env 云开发环境ID
+ * @param name 云函数名称
+ * @param body 云函数的传入参数,具体结构由开发者定义
+ * @return 云函数返回的buffer
+ * @throws WxErrorException 调用失败时抛出
*/
String invokeCloudFunction(String env, String name, String body) throws WxErrorException;
/**
- * Add list.
+ * 批量添加记录到集合。
*
- * @param collection the collection
- * @param list the list
- * @return the list
- * @throws WxErrorException the wx error exception
+ * @param collection 集合名称
+ * @param list 要添加的记录列表
+ * @return 插入成功的记录ID列表
+ * @throws WxErrorException 添加失败时抛出
*/
List
- * 数据库插入记录
- *
+ * 数据库插入记录。
* 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseAdd.html
- * 请求地址:POST https://api.weixin.qq.com/tcb/databaseadd?access_token=ACCESS_TOKEN
- *
*
- * @param env 云环境ID
- * @param query 数据库操作语句
- * @return 插入成功的数据集合主键_id json array
- * @throws WxErrorException .
+ * @param env 云环境ID
+ * @param query 数据库操作语句
+ * @return 插入成功的数据集合主键_id列表
+ * @throws WxErrorException 插入失败时抛出
*/
JsonArray databaseAdd(String env, String query) throws WxErrorException;
/**
- * Delete integer.
+ * 删除集合中符合条件的记录。
*
- * @param collection the collection
- * @param whereJson the where json
- * @return the integer
- * @throws WxErrorException the wx error exception
+ * @param collection 集合名称
+ * @param whereJson 查询条件JSON字符串
+ * @return 删除的记录数量
+ * @throws WxErrorException 删除失败时抛出
*/
Integer delete(String collection, String whereJson) throws WxErrorException;
/**
- * Database delete int.
+ * 数据库删除记录。
*
- * @param query the query
- * @return the int
- * @throws WxErrorException the wx error exception
+ * @param query 数据库操作语句
+ * @return 删除记录数量
+ * @throws WxErrorException 删除失败时抛出
*/
int databaseDelete(String query) throws WxErrorException;
/**
- *
- * 数据库删除记录
- *
+ * 数据库删除记录。
* 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseDelete.html
- * 请求地址:POST https://api.weixin.qq.com/tcb/databasedelete?access_token=ACCESS_TOKEN
- *
*
- * @param env 云环境ID
- * @param query 数据库操作语句
- * @return 删除记录数量 int
- * @throws WxErrorException .
+ * @param env 云环境ID
+ * @param query 数据库操作语句
+ * @return 删除记录数量
+ * @throws WxErrorException 删除失败时抛出
*/
int databaseDelete(String env, String query) throws WxErrorException;
/**
- * Update wx cloud database update result.
+ * 更新集合中符合条件的记录。
*
- * @param collection the collection
- * @param whereJson the where json
- * @param updateJson the update json
- * @return the wx cloud database update result
- * @throws WxErrorException the wx error exception
+ * @param collection 集合名称
+ * @param whereJson 查询条件JSON字符串
+ * @param updateJson 更新内容JSON字符串
+ * @return 更新结果对象
+ * @throws WxErrorException 更新失败时抛出
*/
WxCloudDatabaseUpdateResult update(String collection, String whereJson, String updateJson) throws WxErrorException;
/**
- * Database update wx cloud database update result.
+ * 数据库更新记录。
*
- * @param query the query
- * @return the wx cloud database update result
- * @throws WxErrorException the wx error exception
+ * @param query 数据库操作语句
+ * @return 更新结果对象
+ * @throws WxErrorException 更新失败时抛出
*/
WxCloudDatabaseUpdateResult databaseUpdate(String query) throws WxErrorException;
/**
- *
- * 数据库更新记录
- *
+ * 数据库更新记录。
* 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseUpdate.html
- * 请求地址:POST https://api.weixin.qq.com/tcb/databaseupdate?access_token=ACCESS_TOKEN
- *
*
- * @param env 云环境ID
- * @param query 数据库操作语句
- * @return . wx cloud database update result
- * @throws WxErrorException .
+ * @param env 云环境ID
+ * @param query 数据库操作语句
+ * @return 更新结果对象
+ * @throws WxErrorException 更新失败时抛出
*/
WxCloudDatabaseUpdateResult databaseUpdate(String env, String query) throws WxErrorException;
/**
+ * 查询集合中的记录。
+ * 示例:
* db.collection('geo')
- * .where({
- * price: _.gt(10)
- * })
- * .orderBy('_id', 'asc')
- * .orderBy('price', 'desc')
- * .skip(1)
- * .limit(10)
- * .get()
- *
- * @param collection the collection
- * @param whereJson the where json
- * @param orderBy the order by
- * @param skip the skip
- * @param limit the limit
- * @return wx cloud database query result
- * @throws WxErrorException the wx error exception
+ * .where({price: _.gt(10)})
+ * .orderBy('_id', 'asc')
+ * .orderBy('price', 'desc')
+ * .skip(1)
+ * .limit(10)
+ * .get()
+ *
+ * @param collection 集合名称
+ * @param whereJson 查询条件JSON字符串
+ * @param orderBy 排序条件Map
+ * @param skip 跳过记录数
+ * @param limit 限制返回记录数
+ * @return 查询结果对象
+ * @throws WxErrorException 查询失败时抛出
*/
WxCloudDatabaseQueryResult query(String collection, String whereJson, Map
- * 数据库查询记录
- *
+ * 数据库查询记录。
* 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseQuery.html
- * 请求地址:POST https://api.weixin.qq.com/tcb/databasequery?access_token=ACCESS_TOKEN
- *
*
- * @param env 云环境ID
- * @param query 数据库操作语句
- * @return . wx cloud database query result
- * @throws WxErrorException .
+ * @param env 云环境ID
+ * @param query 数据库操作语句
+ * @return 查询结果对象
+ * @throws WxErrorException 查询失败时抛出
*/
WxCloudDatabaseQueryResult databaseQuery(String env, String query) throws WxErrorException;
/**
- * Database aggregate json array.
+ * 数据库聚合记录。
*
- * @param query the query
- * @return the json array
- * @throws WxErrorException the wx error exception
+ * @param query 数据库操作语句
+ * @return 聚合结果JSON数组
+ * @throws WxErrorException 聚合失败时抛出
*/
JsonArray databaseAggregate(String query) throws WxErrorException;
/**
- *
- * 数据库聚合记录
- *
+ * 数据库聚合记录。
* 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseAggregate.html
- * 请求地址:POST https://api.weixin.qq.com/tcb/databaseaggregate?access_token=ACCESS_TOKEN
- *
*
- * @param env 云环境ID
- * @param query 数据库操作语句
- * @return . json array
- * @throws WxErrorException .
+ * @param env 云环境ID
+ * @param query 数据库操作语句
+ * @return 聚合结果JSON数组
+ * @throws WxErrorException 聚合失败时抛出
*/
JsonArray databaseAggregate(String env, String query) throws WxErrorException;
/**
- * Count long.
+ * 统计集合中符合条件的记录数。
*
- * @param collection the collection
- * @param whereJson the where json
- * @return the long
- * @throws WxErrorException the wx error exception
+ * @param collection 集合名称
+ * @param whereJson 查询条件JSON字符串
+ * @return 记录数量
+ * @throws WxErrorException 统计失败时抛出
*/
Long count(String collection, String whereJson) throws WxErrorException;
/**
- * Database count long.
+ * 统计集合记录数或统计查询语句对应的结果记录数。
*
- * @param query the query
- * @return the long
- * @throws WxErrorException the wx error exception
+ * @param query 数据库操作语句
+ * @return 记录数量
+ * @throws WxErrorException 统计失败时抛出
*/
Long databaseCount(String query) throws WxErrorException;
/**
- *
- * 统计集合记录数或统计查询语句对应的结果记录数
- *
+ * 统计集合记录数或统计查询语句对应的结果记录数。
* 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCount.html
- * 请求地址:POST https://api.weixin.qq.com/tcb/databasecount?access_token=ACCESS_TOKEN
- *
*
- * @param env 云环境ID
- * @param query 数据库操作语句
- * @return 记录数量 long
- * @throws WxErrorException .
+ * @param env 云环境ID
+ * @param query 数据库操作语句
+ * @return 记录数量
+ * @throws WxErrorException 统计失败时抛出
*/
Long databaseCount(String env, String query) throws WxErrorException;
/**
- * Update index.
+ * 变更数据库索引。
*
- * @param collectionName the collection name
- * @param createIndexes the create indexes
- * @param dropIndexNames the drop index names
- * @throws WxErrorException the wx error exception
+ * @param collectionName 集合名称
+ * @param createIndexes 新增索引对象列表
+ * @param dropIndexNames 要删除的索引名称列表
+ * @throws WxErrorException 更新失败时抛出
*/
void updateIndex(String collectionName, List
- * 变更数据库索引
- *
+ * 变更数据库索引。
* 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/updateIndex.html
- * 请求地址:POST https://api.weixin.qq.com/tcb/updateindex?access_token=ACCESS_TOKEN
- *
*
- * @param env 云环境ID
- * @param collectionName 集合名称
- * @param createIndexes 新增索引对象
- * @param dropIndexNames 要删除的索引的名字
- * @throws WxErrorException .
+ * @param env 云环境ID
+ * @param collectionName 集合名称
+ * @param createIndexes 新增索引对象列表
+ * @param dropIndexNames 要删除的索引名称列表
+ * @throws WxErrorException 更新失败时抛出
*/
void updateIndex(String env, String collectionName, List
- * 数据库导入
+ * 数据库导入。
+ * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateImport.html
+ * 注意:导入文件需先上传到同环境的存储中,可使用开发者工具或HTTP API的上传文件API上传
*
- * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateImport
- * .html
- * 请求地址: POST https://api.weixin.qq.com/tcb/databasemigrateimport?access_token=ACCESS_TOKEN
- *
- *
- * @param env 云环境ID
- * @param collectionName 导入collection名
- * @param filePath 导入文件路径(导入文件需先上传到同环境的存储中,可使用开发者工具或 HTTP API的上传文件 API上传)
- * @param fileType 导入文件类型, 1 JSON, 2 CSV
- * @param stopOnError 是否在遇到错误时停止导入
- * @param conflictMode 冲突处理模式 : 1 INSERT , 2 UPSERT
- * @return jobId long
- * @throws WxErrorException .
+ * @param env 云环境ID
+ * @param collectionName 导入collection名
+ * @param filePath 导入文件路径
+ * @param fileType 导入文件类型,1:JSON,2:CSV
+ * @param stopOnError 是否在遇到错误时停止导入
+ * @param conflictMode 冲突处理模式,1:INSERT,2:UPSERT
+ * @return 任务ID
+ * @throws WxErrorException 导入失败时抛出
*/
Long databaseMigrateImport(String env, String collectionName, String filePath, int fileType, boolean stopOnError,
int conflictMode) throws WxErrorException;
/**
- * Database migrate export long.
+ * 数据库导出。
*
- * @param filePath the file path
- * @param fileType the file type
- * @param query the query
- * @return the long
- * @throws WxErrorException the wx error exception
+ * @param filePath 导出文件路径
+ * @param fileType 导出文件类型,1:JSON,2:CSV
+ * @param query 导出条件
+ * @return 任务ID
+ * @throws WxErrorException 导出失败时抛出
*/
Long databaseMigrateExport(String filePath, int fileType, String query) throws WxErrorException;
/**
- *
- * 数据库导出
- *
- * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateExport
- * .html
- * 请求地址: POST https://api.weixin.qq.com/tcb/databasemigrateexport?access_token=ACCESS_TOKEN
- *
+ * 数据库导出。
+ * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateExport.html
+ * 注意:文件会导出到同环境的云存储中,可使用获取下载链接API获取下载链接
*
- * @param env 云环境ID
- * @param filePath 导出文件路径(文件会导出到同环境的云存储中,可使用获取下载链接 API 获取下载链接)
- * @param fileType 导出文件类型, 1 JSON, 2 CSV
- * @param query 导出条件
- * @return jobId long
- * @throws WxErrorException .
+ * @param env 云环境ID
+ * @param filePath 导出文件路径
+ * @param fileType 导出文件类型,1:JSON,2:CSV
+ * @param query 导出条件
+ * @return 任务ID
+ * @throws WxErrorException 导出失败时抛出
*/
Long databaseMigrateExport(String env, String filePath, int fileType, String query) throws WxErrorException;
/**
- * Database migrate query info wx cloud cloud database migrate query info result.
+ * 数据库迁移状态查询。
*
- * @param jobId the job id
- * @return the wx cloud cloud database migrate query info result
- * @throws WxErrorException the wx error exception
+ * @param jobId 迁移任务ID
+ * @return 迁移状态查询结果
+ * @throws WxErrorException 查询失败时抛出
*/
WxCloudCloudDatabaseMigrateQueryInfoResult databaseMigrateQueryInfo(Long jobId) throws WxErrorException;
/**
- *
- * 数据库迁移状态查询
- *
- * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database
- * /databaseMigrateQueryInfo.html
- * 请求地址:POST https://api.weixin.qq.com/tcb/databasemigratequeryinfo?access_token=ACCESS_TOKEN
- *
+ * 数据库迁移状态查询。
+ * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateQueryInfo.html
*
- * @param env 云环境ID
- * @param jobId 迁移任务ID
- * @return . wx cloud cloud database migrate query info result
- * @throws WxErrorException .
+ * @param env 云环境ID
+ * @param jobId 迁移任务ID
+ * @return 迁移状态查询结果
+ * @throws WxErrorException 查询失败时抛出
*/
WxCloudCloudDatabaseMigrateQueryInfoResult databaseMigrateQueryInfo(String env, Long jobId) throws WxErrorException;
/**
- * Upload file wx cloud upload file result.
+ * 获取文件上传链接。
*
- * @param path the path
- * @return the wx cloud upload file result
- * @throws WxErrorException the wx error exception
+ * @param path 上传路径
+ * @return 上传结果对象
+ * @throws WxErrorException 获取失败时抛出
*/
WxCloudUploadFileResult uploadFile(String path) throws WxErrorException;
/**
- *
- * 获取文件上传链接
- *
+ * 获取文件上传链接。
* 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/uploadFile.html
- * 请求地址:POST https://api.weixin.qq.com/tcb/uploadfile?access_token=ACCESS_TOKEN
- *
- *
*
- * @param env 云环境ID
- * @param path 上传路径
- * @return 上传结果 wx cloud upload file result
- * @throws WxErrorException .
+ * @param env 云环境ID
+ * @param path 上传路径
+ * @return 上传结果对象
+ * @throws WxErrorException 获取失败时抛出
*/
WxCloudUploadFileResult uploadFile(String env, String path) throws WxErrorException;
/**
- * Batch download file wx cloud batch download file result.
+ * 获取文件下载链接。
*
- * @param fileIds the file ids
- * @param maxAges the max ages
- * @return the wx cloud batch download file result
- * @throws WxErrorException the wx error exception
+ * @param fileIds 文件ID数组
+ * @param maxAges 下载链接有效期数组,对应文件id列表
+ * @return 下载链接信息对象
+ * @throws WxErrorException 获取失败时抛出
*/
WxCloudBatchDownloadFileResult batchDownloadFile(String[] fileIds, long[] maxAges) throws WxErrorException;
/**
- *
- * 获取文件下载链接
- *
+ * 获取文件下载链接。
* 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/batchDownloadFile.html
- * 请求地址:POST https://api.weixin.qq.com/tcb/batchdownloadfile?access_token=ACCESS_TOKEN
- *
- *
*
- * @param env 云环境ID
- * @param fileIds 文件ID列表
- * @param maxAges 下载链接有效期列表,对应文件id列表
- * @return 下载链接信息 wx cloud batch download file result
- * @throws WxErrorException .
+ * @param env 云环境ID
+ * @param fileIds 文件ID数组
+ * @param maxAges 下载链接有效期数组,对应文件id列表
+ * @return 下载链接信息对象
+ * @throws WxErrorException 获取失败时抛出
*/
WxCloudBatchDownloadFileResult batchDownloadFile(String env, String[] fileIds, long[] maxAges) throws WxErrorException;
/**
- * Batch delete file wx cloud batch delete file result.
+ * 删除文件。
*
- * @param fileIds the file ids
- * @return the wx cloud batch delete file result
- * @throws WxErrorException the wx error exception
+ * @param fileIds 文件ID数组
+ * @return 删除结果对象
+ * @throws WxErrorException 删除失败时抛出
*/
WxCloudBatchDeleteFileResult batchDeleteFile(String[] fileIds) throws WxErrorException;
/**
- *
- * 删除文件
- *
+ * 删除文件。
* 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/batchDeleteFile.html
- * 请求地址:POST https://api.weixin.qq.com/tcb/batchdeletefile?access_token=ACCESS_TOKEN
- *
- *
*
- * @param env 云环境ID
- * @param fileIds 文件ID列表
- * @return 下载链接信息 wx cloud batch delete file result
- * @throws WxErrorException .
+ * @param env 云环境ID
+ * @param fileIds 文件ID数组
+ * @return 删除结果对象
+ * @throws WxErrorException 删除失败时抛出
*/
WxCloudBatchDeleteFileResult batchDeleteFile(String env, String[] fileIds) throws WxErrorException;
/**
- *
- * 获取腾讯云API调用凭证
- *
- * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/utils/getQcloudToken.html
- * 请求地址:POST https://api.weixin.qq.com/tcb/getqcloudtoken?access_token=ACCESS_TOKEN
- *
+ * 获取腾讯云API调用凭证。
+ * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/utils/getQcloudToken.html
*
- * @param lifeSpan 有效期(单位为秒,最大7200)
- * @return . qcloud token
- * @throws WxErrorException .
+ * @param lifeSpan 有效期(单位为秒,最大7200)
+ * @return 腾讯云Token结果对象
+ * @throws WxErrorException 获取失败时抛出
*/
WxCloudGetQcloudTokenResult getQcloudToken(long lifeSpan) throws WxErrorException;
/**
- * Database collection add.
+ * 新增集合。
*
- * @param collectionName the collection name
- * @throws WxErrorException the wx error exception
+ * @param collectionName 集合名称
+ * @throws WxErrorException 新增失败时抛出
*/
void databaseCollectionAdd(String collectionName) throws WxErrorException;
/**
- *
- * 新增集合
+ * 新增集合。
+ * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionAdd.html
*
- * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionAdd
- * .html
- * 请求地址:POST https://api.weixin.qq.com/tcb/databasecollectionadd?access_token=ACCESS_TOKEN
- *
- *
- * @param env 云环境ID
- * @param collectionName 集合名称
- * @throws WxErrorException .
+ * @param env 云环境ID
+ * @param collectionName 集合名称
+ * @throws WxErrorException 新增失败时抛出
*/
void databaseCollectionAdd(String env, String collectionName) throws WxErrorException;
/**
- * Database collection delete.
+ * 删除集合。
*
- * @param collectionName the collection name
- * @throws WxErrorException the wx error exception
+ * @param collectionName 集合名称
+ * @throws WxErrorException 删除失败时抛出
*/
void databaseCollectionDelete(String collectionName) throws WxErrorException;
/**
- *
- * 删除集合
- *
- * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database
- * /databaseCollectionDelete.html
- * 请求地址:POST https://api.weixin.qq.com/tcb/databasecollectionadd?access_token=ACCESS_TOKEN
- *
+ * 删除集合。
+ * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionDelete.html
*
- * @param env 云环境ID
- * @param collectionName 集合名称
- * @throws WxErrorException .
+ * @param env 云环境ID
+ * @param collectionName 集合名称
+ * @throws WxErrorException 删除失败时抛出
*/
void databaseCollectionDelete(String env, String collectionName) throws WxErrorException;
/**
- * Database collection get wx cloud database collection get result.
+ * 获取特定云环境下集合信息。
*
- * @param limit the limit
- * @param offset the offset
- * @return the wx cloud database collection get result
- * @throws WxErrorException the wx error exception
+ * @param limit 获取数量限制,默认值:10
+ * @param offset 偏移量,默认值:0
+ * @return 集合信息获取结果对象
+ * @throws WxErrorException 获取失败时抛出
*/
WxCloudDatabaseCollectionGetResult databaseCollectionGet(Long limit, Long offset) throws WxErrorException;
/**
- *
- * 获取特定云环境下集合信息
- *
- * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionGet
- * .html
- * 请求地址:POST https://api.weixin.qq.com/tcb/databasecollectionget?access_token=ACCESS_TOKEN
- *
+ * 获取特定云环境下集合信息。
+ * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionGet.html
*
- * @param env 云环境ID
- * @param limit 获取数量限制,默认值:10
- * @param offset 偏移量,默认值:0
- * @return . wx cloud database collection get result
- * @throws WxErrorException .
+ * @param env 云环境ID
+ * @param limit 获取数量限制,默认值:10
+ * @param offset 偏移量,默认值:0
+ * @return 集合信息获取结果对象
+ * @throws WxErrorException 获取失败时抛出
*/
WxCloudDatabaseCollectionGetResult databaseCollectionGet(String env, Long limit, Long offset) throws WxErrorException;
/**
- * 发送携带 URL Link 的短信
- *
+ * 发送携带 URL Link 的短信。
* 文档地址:https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/cloudbase/cloudbase.sendSmsV2.html
- * @param request
- * @return WxCloudSendSmsV2Result
- * @throws WxErrorException
+ *
+ * @param request 短信发送请求对象
+ * @return 短信发送结果对象
+ * @throws WxErrorException 发送失败时抛出
*/
WxCloudSendSmsV2Result sendSmsV2(WxCloudSendSmsV2Request request) throws WxErrorException;
-
}
From 5b816242a450da6cb6257d6104a65233c2f64b12 Mon Sep 17 00:00:00 2001
From: Binary Wang
Date: Wed, 2 Jul 2025 10:18:04 +0800
Subject: [PATCH 005/208] =?UTF-8?q?:art:=20=E4=BC=98=E5=8C=96=E5=B0=8F?=
=?UTF-8?q?=E7=A8=8B=E5=BA=8F=E6=95=B0=E6=8D=AE=E5=88=86=E6=9E=90=E6=8E=A5?=
=?UTF-8?q?=E5=8F=A3=E7=B1=BB=E7=9A=84=E6=B3=A8=E9=87=8A=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../wx/miniapp/api/WxMaAnalysisService.java | 82 +++++++++----------
1 file changed, 41 insertions(+), 41 deletions(-)
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaAnalysisService.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaAnalysisService.java
index fa6d444406..d6d13431d5 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaAnalysisService.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaAnalysisService.java
@@ -7,7 +7,7 @@
import java.util.List;
/**
- * 小程序数据分析相关接口
+ * 小程序数据分析相关接口。
* 文档:https://mp.weixin.qq.com/debug/wxadoc/dev/api/analysis.html
*
* @author Charming
@@ -16,114 +16,114 @@
public interface WxMaAnalysisService {
/**
- * 查询概况趋势
+ * 查询概况趋势。
* 温馨提示:小程序接口目前只能查询一天的数据,即 beginDate 和 endDate 一样
*
- * @param beginDate 开始日期
- * @param endDate 结束日期,限定查询1天数据,end_date允许设置的最大值为昨日
- * @return 概况趋势
+ * @param beginDate 开始日期
+ * @param endDate 结束日期,限定查询1天数据,end_date允许设置的最大值为昨日
+ * @return 概况趋势列表
* @throws WxErrorException 获取失败时抛出,具体错误码请看文档
*/
List
+ * 签约、解约结果通知解析
+ * 详见:签约、解约结果通知
+ * 注意:
+ * 1、同样的通知可能会多次发送给商户系统。商户系统必须能够正确处理重复的通知。 推荐的做法是:当商户系统收到通知进行处理时,先检查对应业务数据的状态,并判断该通知是否已经处理。如果未处理,则再进行处理;如果已处理,则直接返回结果成功。在对业务数据进行状态检查和处理之前,要采用数据锁进行并发控制,以避免函数重入造成的数据混乱。
+ * 2、如果在所有通知频率(0/10/10/10/30/30/30/300/300/300/300/300/300/300/300/300/300/300/300/300/300/300/300/300/300/300/300/300/300/300(单位:秒))后没有收到微信侧回调,商户应调用查询订单接口确认订单状态。
+ * 特别提醒:
+ * 1、商户系统对于签约、解约结果通知的内容一定要做签名验证,并校验返回的商户协议号和用户openid信息是否一致,防止数据泄露导致出现“假通知”,造成损失。
+ * 2、当收到通知进行处理时,首先检查对应业务数据的状态,判断该通知是否已经处理过,如果没有处理过再进行处理,如果处理过直接返回结果成功。在对业务数据进行状态检查和处理之前,要采用数据锁进行并发控制,以避免函数重入造成的数据混乱。
+ *
+ *
+ * @param xmlData the wx withhold order query request
+ * @return wx sign result
+ * @throws WxPayException the wx pay exception
+ */
+ WxSignQueryResult parseSignNotifyResult(String xmlData) throws WxPayException;
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxEntrustPapServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxEntrustPapServiceImpl.java
index 8a90ea3500..b70a7dee37 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxEntrustPapServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxEntrustPapServiceImpl.java
@@ -154,4 +154,11 @@ public WxWithholdOrderQueryResult papOrderQuery(WxWithholdOrderQueryRequest wxWi
wxWithholdOrderQueryResult.checkResult(payService, wxWithholdOrderQueryRequest.getSignType(), true);
return wxWithholdOrderQueryResult;
}
+
+ @Override
+ public WxSignQueryResult parseSignNotifyResult(String xmlData) throws WxPayException {
+ WxSignQueryResult result = BaseWxPayResult.fromXML(xmlData, WxSignQueryResult.class);
+ result.checkResult(payService, WxPayConstants.SignType.MD5, true);
+ return result;
+ }
}
From d4cf48d05942597ee334a48236b8c583cdca0549 Mon Sep 17 00:00:00 2001
From: benben
- * 新增永久图文素材
- *
- * 详情请见: 新增永久素材
- * 接口url格式:https://api.weixin.qq.com/cgi-bin/material/add_news?access_token=ACCESS_TOKEN
- *
- * 除了3天就会失效的临时素材外,开发者有时需要永久保存一些素材,届时就可以通过本接口新增永久素材。
- * 永久图片素材新增后,将带有URL返回给开发者,开发者可以在腾讯系域名内使用(腾讯系域名外使用,图片将被屏蔽)。
- * 请注意:
- * 1、新增的永久素材也可以在公众平台官网素材管理模块中看到
- * 2、永久素材的数量是有上限的,请谨慎新增。图文消息素材和图片素材的上限为5000,其他类型为1000
- * 3、素材的格式大小等要求与公众平台官网一致。具体是,图片大小不超过2M,支持bmp/png/jpeg/jpg/gif格式,语音大小不超过5M,长度不超过60秒,支持mp3/wma/wav/amr格式
- * 4、调用该接口需https协议
- *
- *
- * @param news 上传的图文消息, 请看{@link WxMpMaterialNews}
- * @return the wx mp material upload result
- * @throws WxErrorException the wx error exception
- * @deprecated 关于永久图文素材相关接口下线的公告 : https://mp.weixin.qq.com/cgi-bin/announce?action=getannouncement&announce_id=11644831863qFQSh&version=&token=2085564289&lang=zh_CN
- */
- @Deprecated
- WxMpMaterialUploadResult materialNewsUpload(WxMpMaterialNews news) throws WxErrorException;
-
/**
*
* 获取声音或者图片永久素材
@@ -212,22 +188,6 @@ public interface WxMpMaterialService {
*/
WxMpMaterialNews materialNewsInfo(String mediaId) throws WxErrorException;
- /**
- *
*
- * @return the wx mp kf online list
- * @throws WxErrorException 异常
+ * @return 在线客服接待信息列表,包含在线客服账号、接待状态等信息
+ * @throws WxErrorException 微信API调用异常
*/
WxMpKfOnlineList kfOnlineList() throws WxErrorException;
@@ -81,9 +81,9 @@ public interface WxMpKefuService {
* 接口url格式:https://api.weixin.qq.com/customservice/kfaccount/add?access_token=ACCESS_TOKEN
*
*
- * @param request the request
- * @return the boolean
- * @throws WxErrorException 异常
+ * @param request 客服账号请求对象,包含客服账号、昵称等信息
+ * @return 添加是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean kfAccountAdd(WxMpKfAccountRequest request) throws WxErrorException;
@@ -94,22 +94,22 @@ public interface WxMpKefuService {
* 接口url格式:https://api.weixin.qq.com/customservice/kfaccount/update?access_token=ACCESS_TOKEN
*
*
- * @param request the request
- * @return the boolean
- * @throws WxErrorException the wx error exception
+ * @param request 客服账号请求对象,包含客服账号、昵称等信息
+ * @return 更新是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean kfAccountUpdate(WxMpKfAccountRequest request) throws WxErrorException;
/**
*
- * 修改永久图文素材
- *
- * 详情请见: 修改永久图文素材
- * 接口url格式:https://api.weixin.qq.com/cgi-bin/material/update_news?access_token=ACCESS_TOKEN
- *
- *
- * @param wxMpMaterialArticleUpdate 用来更新图文素材的bean, 请看{@link WxMpMaterialArticleUpdate}
- * @return the boolean
- * @throws WxErrorException the wx error exception
- * @deprecated 关于永久图文素材相关接口下线的公告 : https://mp.weixin.qq.com/cgi-bin/announce?action=getannouncement&announce_id=11644831863qFQSh&version=&token=2085564289&lang=zh_CN
- */
- @Deprecated
- boolean materialNewsUpdate(WxMpMaterialArticleUpdate wxMpMaterialArticleUpdate) throws WxErrorException;
-
/**
*
* 删除永久素材
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpMaterialServiceImpl.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpMaterialServiceImpl.java
index 45e1c5c4b1..dfaf7d8a98 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpMaterialServiceImpl.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpMaterialServiceImpl.java
@@ -83,15 +83,6 @@ public WxMpMaterialUploadResult materialFileUpload(String mediaType, WxMpMateria
return this.wxMpService.execute(MaterialUploadRequestExecutor.create(this.wxMpService.getRequestHttp()), url, material);
}
- @Override
- public WxMpMaterialUploadResult materialNewsUpload(WxMpMaterialNews news) throws WxErrorException {
- if (news == null || news.isEmpty()) {
- throw new IllegalArgumentException("news is empty!");
- }
- String responseContent = this.wxMpService.post(NEWS_ADD_URL, news.toJson());
- return WxMpMaterialUploadResult.fromJson(responseContent);
- }
-
@Override
public InputStream materialImageOrVoiceDownload(String mediaId) throws WxErrorException {
return this.wxMpService.execute(MaterialVoiceAndImageDownloadRequestExecutor
@@ -111,17 +102,6 @@ public WxMpMaterialNews materialNewsInfo(String mediaId) throws WxErrorException
MATERIAL_GET_URL, mediaId);
}
- @Override
- public boolean materialNewsUpdate(WxMpMaterialArticleUpdate wxMpMaterialArticleUpdate) throws WxErrorException {
- String responseText = this.wxMpService.post(NEWS_UPDATE_URL, wxMpMaterialArticleUpdate.toJson());
- WxError wxError = WxError.fromJson(responseText, WxType.MP);
- if (wxError.getErrorCode() == 0) {
- return true;
- } else {
- throw new WxErrorException(wxError);
- }
- }
-
@Override
public boolean materialDelete(String mediaId) throws WxErrorException {
return this.wxMpService.execute(MaterialDeleteRequestExecutor.create(this.wxMpService.getRequestHttp()),
diff --git a/weixin-java-mp/src/test/java/me/chanjar/weixin/mp/api/impl/WxMpMaterialServiceImplTest.java b/weixin-java-mp/src/test/java/me/chanjar/weixin/mp/api/impl/WxMpMaterialServiceImplTest.java
index 707f1df311..8068a5a302 100644
--- a/weixin-java-mp/src/test/java/me/chanjar/weixin/mp/api/impl/WxMpMaterialServiceImplTest.java
+++ b/weixin-java-mp/src/test/java/me/chanjar/weixin/mp/api/impl/WxMpMaterialServiceImplTest.java
@@ -135,11 +135,6 @@ public void testAddNews() throws WxErrorException {
wxMpMaterialNewsMultiple.addArticle(article1);
wxMpMaterialNewsMultiple.addArticle(article2);
-
- WxMpMaterialUploadResult resSingle = this.wxService.getMaterialService().materialNewsUpload(wxMpMaterialNewsSingle);
- this.singleNewsMediaId = resSingle.getMediaId();
- WxMpMaterialUploadResult resMulti = this.wxService.getMaterialService().materialNewsUpload(wxMpMaterialNewsMultiple);
- this.multiNewsMediaId = resMulti.getMediaId();
}
@Test(dependsOnMethods = {"testAddNews"})
@@ -201,8 +196,6 @@ public void testUpdateNewsInfo() throws WxErrorException {
wxMpMaterialArticleUpdateSingle.setMediaId(this.singleNewsMediaId);
wxMpMaterialArticleUpdateSingle.setArticles(articleSingle);
wxMpMaterialArticleUpdateSingle.setIndex(0);
- boolean resultSingle = this.wxService.getMaterialService().materialNewsUpdate(wxMpMaterialArticleUpdateSingle);
- assertTrue(resultSingle);
wxMpMaterialNewsSingle = this.wxService.getMaterialService()
.materialNewsInfo(this.singleNewsMediaId);
assertNotNull(wxMpMaterialNewsSingle);
@@ -218,8 +211,6 @@ public void testUpdateNewsInfo() throws WxErrorException {
wxMpMaterialArticleUpdateMulti.setMediaId(this.multiNewsMediaId);
wxMpMaterialArticleUpdateMulti.setArticles(articleMulti);
wxMpMaterialArticleUpdateMulti.setIndex(1);
- boolean resultMulti = this.wxService.getMaterialService().materialNewsUpdate(wxMpMaterialArticleUpdateMulti);
- assertTrue(resultMulti);
wxMpMaterialNewsMultiple = this.wxService.getMaterialService()
.materialNewsInfo(this.multiNewsMediaId);
assertNotNull(wxMpMaterialNewsMultiple);
From 3e4ee57e1c821a9a5bc17f257578d980c213625d Mon Sep 17 00:00:00 2001
From: Ryn
*/
private int maxRetryTimes = 5;
+
+ /**
+ * 连接超时时间,单位毫秒
+ */
+ private int connectionTimeout = 5000;
+
+ /**
+ * 读数据超时时间,即socketTimeout,单位毫秒
+ */
+ private int soTimeout = 5000;
+
+ /**
+ * 从连接池获取链接的超时时间,单位毫秒
+ */
+ private int connectionRequestTimeout = 5000;
}
}
diff --git a/spring-boot-starters/wx-java-mp-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/mp/config/WxMpStorageAutoConfiguration.java b/spring-boot-starters/wx-java-mp-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/mp/config/WxMpStorageAutoConfiguration.java
index deb527e69f..4c0938454a 100644
--- a/spring-boot-starters/wx-java-mp-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/mp/config/WxMpStorageAutoConfiguration.java
+++ b/spring-boot-starters/wx-java-mp-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/mp/config/WxMpStorageAutoConfiguration.java
@@ -9,6 +9,8 @@
import me.chanjar.weixin.common.redis.JedisWxRedisOps;
import me.chanjar.weixin.common.redis.RedisTemplateWxRedisOps;
import me.chanjar.weixin.common.redis.WxRedisOps;
+import me.chanjar.weixin.common.util.http.apache.ApacheHttpClientBuilder;
+import me.chanjar.weixin.common.util.http.apache.DefaultApacheHttpClientBuilder;
import me.chanjar.weixin.mp.config.WxMpConfigStorage;
import me.chanjar.weixin.mp.config.WxMpHostConfig;
import me.chanjar.weixin.mp.config.impl.WxMpDefaultConfigImpl;
@@ -122,6 +124,19 @@ private void setWxMpInfo(WxMpDefaultConfigImpl config) {
config.setSecret(properties.getSecret());
config.setToken(properties.getToken());
config.setAesKey(properties.getAesKey());
+ WxMpProperties.ConfigStorage storage = properties.getConfigStorage();
+ // 设置自定义的HttpClient超时配置
+ ApacheHttpClientBuilder clientBuilder = config.getApacheHttpClientBuilder();
+ if (clientBuilder == null) {
+ clientBuilder = DefaultApacheHttpClientBuilder.get();
+ }
+ if (clientBuilder instanceof DefaultApacheHttpClientBuilder) {
+ DefaultApacheHttpClientBuilder defaultBuilder = (DefaultApacheHttpClientBuilder) clientBuilder;
+ defaultBuilder.setConnectionTimeout(storage.getConnectionTimeout());
+ defaultBuilder.setSoTimeout(storage.getSoTimeout());
+ defaultBuilder.setConnectionRequestTimeout(storage.getConnectionRequestTimeout());
+ config.setApacheHttpClientBuilder(defaultBuilder);
+ }
config.setUseStableAccessToken(wxMpProperties.isUseStableAccessToken());
config.setHttpProxyHost(configStorageProperties.getHttpProxyHost());
config.setHttpProxyUsername(configStorageProperties.getHttpProxyUsername());
diff --git a/spring-boot-starters/wx-java-mp-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/mp/properties/WxMpProperties.java b/spring-boot-starters/wx-java-mp-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/mp/properties/WxMpProperties.java
index a01fc0a521..ebd6f57720 100644
--- a/spring-boot-starters/wx-java-mp-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/mp/properties/WxMpProperties.java
+++ b/spring-boot-starters/wx-java-mp-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/mp/properties/WxMpProperties.java
@@ -102,6 +102,21 @@ public static class ConfigStorage implements Serializable {
*/
private String httpProxyPassword;
+ /**
+ * 连接超时时间,单位毫秒
+ */
+ private int connectionTimeout = 5000;
+
+ /**
+ * 读数据超时时间,即socketTimeout,单位毫秒
+ */
+ private int soTimeout = 1;
+
+ /**
+ * 从连接池获取链接的超时时间,单位毫秒
+ */
+ private int connectionRequestTimeout = 5000;
+
}
}
diff --git a/spring-boot-starters/wx-java-open-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/config/storage/AbstractWxOpenConfigStorageConfiguration.java b/spring-boot-starters/wx-java-open-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/config/storage/AbstractWxOpenConfigStorageConfiguration.java
index ee0443c9ae..748ce80cd7 100644
--- a/spring-boot-starters/wx-java-open-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/config/storage/AbstractWxOpenConfigStorageConfiguration.java
+++ b/spring-boot-starters/wx-java-open-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/config/storage/AbstractWxOpenConfigStorageConfiguration.java
@@ -1,6 +1,8 @@
package com.binarywang.spring.starter.wxjava.open.config.storage;
import com.binarywang.spring.starter.wxjava.open.properties.WxOpenProperties;
+import me.chanjar.weixin.common.util.http.apache.ApacheHttpClientBuilder;
+import me.chanjar.weixin.common.util.http.apache.DefaultApacheHttpClientBuilder;
import me.chanjar.weixin.open.api.impl.WxOpenInMemoryConfigStorage;
/**
@@ -28,6 +30,20 @@ protected WxOpenInMemoryConfigStorage config(WxOpenInMemoryConfigStorage config,
}
config.setRetrySleepMillis(retrySleepMillis);
config.setMaxRetryTimes(maxRetryTimes);
+
+ // 设置自定义的HttpClient超时配置
+ ApacheHttpClientBuilder clientBuilder = config.getApacheHttpClientBuilder();
+ if (clientBuilder == null) {
+ clientBuilder = DefaultApacheHttpClientBuilder.get();
+ }
+ if (clientBuilder instanceof DefaultApacheHttpClientBuilder) {
+ DefaultApacheHttpClientBuilder defaultBuilder = (DefaultApacheHttpClientBuilder) clientBuilder;
+ defaultBuilder.setConnectionTimeout(storage.getConnectionTimeout());
+ defaultBuilder.setSoTimeout(storage.getSoTimeout());
+ defaultBuilder.setConnectionRequestTimeout(storage.getConnectionRequestTimeout());
+ config.setApacheHttpClientBuilder(defaultBuilder);
+ }
+
return config;
}
}
From 990dbba06b53404b505772285661cef34a9dfe5a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E7=97=B4=E8=B4=A7?= <252048765@qq.com>
Date: Wed, 16 Jul 2025 11:47:11 +0000
Subject: [PATCH 019/208] =?UTF-8?q?:art:=20=E3=80=90=E5=BC=80=E6=94=BE?=
=?UTF-8?q?=E5=B9=B3=E5=8F=B0=E3=80=91=E9=87=8D=E6=9E=84=E5=B0=8F=E7=A8=8B?=
=?UTF-8?q?=E5=BA=8F=E8=AE=A4=E8=AF=81=E5=8F=8A=E5=A4=87=E6=A1=88=E7=9B=B8?=
=?UTF-8?q?=E5=85=B3=E6=8E=A5=E5=8F=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../open/properties/WxOpenProperties.java | 15 +
.../open/api/WxOpenMaAuthAndIcpService.java | 32 +
.../weixin/open/api/WxOpenMaBasicService.java | 25 +-
.../weixin/open/api/WxOpenMaIcpService.java | 25 -
.../weixin/open/api/WxOpenMaService.java | 7 +
.../api/impl/WxOpenFastMaServiceImpl.java | 5 +
.../impl/WxOpenMaAuthAndIcpServiceImpl.java | 40 +
.../api/impl/WxOpenMaBasicServiceImpl.java | 8 +
.../open/api/impl/WxOpenMaIcpServiceImpl.java | 38 -
.../open/api/impl/WxOpenMaServiceImpl.java | 3 +
.../auth/MaAuthQueryIdentityTreeResult.java | 2 +-
.../WxOpenQueryAuthAndIcpResult.java | 134 +++
.../WxOpenSubmitAuthAndIcpParam.java | 767 ++++++++++++++++++
.../WxOpenSubmitAuthAndIcpResult.java | 52 ++
.../icp/WxOpenCreateIcpVerifyTaskParam.java | 26 +
.../WxOpenIcpCreateIcpVerifyTaskResult.java | 3 +-
.../open/bean/message/WxOpenXmlMessage.java | 33 +-
.../WxOpenGetAllCategoriesByTypeResult.java | 153 ++++
18 files changed, 1292 insertions(+), 76 deletions(-)
create mode 100644 weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaAuthAndIcpService.java
create mode 100644 weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenMaAuthAndIcpServiceImpl.java
create mode 100644 weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/authandicp/WxOpenQueryAuthAndIcpResult.java
create mode 100644 weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/authandicp/WxOpenSubmitAuthAndIcpParam.java
create mode 100644 weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/authandicp/WxOpenSubmitAuthAndIcpResult.java
create mode 100644 weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/icp/WxOpenCreateIcpVerifyTaskParam.java
create mode 100644 weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenGetAllCategoriesByTypeResult.java
diff --git a/spring-boot-starters/wx-java-open-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/properties/WxOpenProperties.java b/spring-boot-starters/wx-java-open-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/properties/WxOpenProperties.java
index 641c57b005..293d251397 100644
--- a/spring-boot-starters/wx-java-open-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/properties/WxOpenProperties.java
+++ b/spring-boot-starters/wx-java-open-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/properties/WxOpenProperties.java
@@ -108,6 +108,21 @@ public static class ConfigStorage implements Serializable {
*/
private int maxRetryTimes = 5;
+ /**
+ * 连接超时时间,单位毫秒
+ */
+ private int connectionTimeout = 5000;
+
+ /**
+ * 读数据超时时间,即socketTimeout,单位毫秒
+ */
+ private int soTimeout = 1;
+
+ /**
+ * 从连接池获取链接的超时时间,单位毫秒
+ */
+ private int connectionRequestTimeout = 5000;
+
}
public enum StorageType {
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaAuthAndIcpService.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaAuthAndIcpService.java
new file mode 100644
index 0000000000..de2c0a0de2
--- /dev/null
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaAuthAndIcpService.java
@@ -0,0 +1,32 @@
+package me.chanjar.weixin.open.api;
+
+import me.chanjar.weixin.common.error.WxErrorException;
+import me.chanjar.weixin.open.bean.authandicp.WxOpenQueryAuthAndIcpResult;
+import me.chanjar.weixin.open.bean.authandicp.WxOpenSubmitAuthAndIcpParam;
+import me.chanjar.weixin.open.bean.authandicp.WxOpenSubmitAuthAndIcpResult;
+
+/**
+ * 微信第三方平台 小程序认证及备案
+ * @author 痴货
+ * @createTime 2025/06/18 23:00
+ */
+public interface WxOpenMaAuthAndIcpService {
+
+ String QUERY_AUTH_AND_ICP = "https://api.weixin.qq.com/wxa/sec/query_auth_and_icp";
+
+ String SUBMIT_AUTH_AND_ICP = "https://api.weixin.qq.com/wxa/sec/submit_auth_and_icp";
+
+ /**
+ * 查询小程序认证及备案进度。
+ * @param procedureId 小程序认证及备案任务流程id
+ * @return 小程序认证及备案进度
+ */
+ WxOpenQueryAuthAndIcpResult queryAuthAndIcp(String procedureId) throws WxErrorException;
+
+ /**
+ * 提交小程序认证及备案信息。
+ * @param param 提交小程序认证及备案信息参数
+ * @return 提交结果
+ */
+ WxOpenSubmitAuthAndIcpResult submitAuthAndIcp(WxOpenSubmitAuthAndIcpParam param) throws WxErrorException;
+}
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaBasicService.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaBasicService.java
index 7452094c90..487604999e 100644
--- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaBasicService.java
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaBasicService.java
@@ -53,19 +53,23 @@ public interface WxOpenMaBasicService {
*/
String OPEN_GET_ALL_CATEGORIES = "https://api.weixin.qq.com/cgi-bin/wxopen/getallcategories";
/**
- * 8.2 添加类目
+ * 8.2 获取不同类型主体可设置的类目
+ */
+ String OPEN_GET_ALL_CATEGORIES_BY_TYPE = "https://api.weixin.qq.com/cgi-bin/wxopen/getcategoriesbytype";
+ /**
+ * 8.3 添加类目
*/
String OPEN_ADD_CATEGORY = "https://api.weixin.qq.com/cgi-bin/wxopen/addcategory";
/**
- * 8.3 删除类目
+ * 8.4 删除类目
*/
String OPEN_DELETE_CATEGORY = "https://api.weixin.qq.com/cgi-bin/wxopen/deletecategory";
/**
- * 8.4 获取账号已经设置的所有类目
+ * 8.5 获取账号已经设置的所有类目
*/
String OPEN_GET_CATEGORY = "https://api.weixin.qq.com/cgi-bin/wxopen/getcategory";
/**
- * 8.5 修改类目
+ * 8.6 修改类目
*/
String OPEN_MODIFY_CATEGORY = "https://api.weixin.qq.com/cgi-bin/wxopen/modifycategory";
@@ -167,7 +171,12 @@ WxFastMaSetNickameResult setNickname(String nickname, String idCard, String lice
String getAllCategories() throws WxErrorException;
/**
- * 8.2添加类目
+ * 8.2获取不同类型主体可设置的类目
+ */
+ WxOpenGetAllCategoriesByTypeResult getAllCategoriesByType(String verifyType) throws WxErrorException;
+
+ /**
+ * 8.3添加类目
*
* @param categoryList 类目列表
* @return .
@@ -176,7 +185,7 @@ WxFastMaSetNickameResult setNickname(String nickname, String idCard, String lice
WxOpenResult addCategory(List
From e5ef34553d94d649f857b79eacc2be502d3978a0 Mon Sep 17 00:00:00 2001
From: Farahani
*/
@XStreamAlias("refund_recv_accout")
- private String refundRecvAccout;
+ private String refundRecvAccount;
/**
*
@@ -324,7 +324,7 @@ public void loadXML(Document d) {
settlementRefundFee = readXmlInteger(d, "settlement_refund_fee");
refundStatus = readXmlString(d, "refund_status");
successTime = readXmlString(d, "success_time");
- refundRecvAccout = readXmlString(d, "refund_recv_accout");
+ refundRecvAccount = readXmlString(d, "refund_recv_accout");
refundAccount = readXmlString(d, "refund_account");
refundRequestSource = readXmlString(d, "refund_request_source");
}
diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/notify/WxPayRefundNotifyResultTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/notify/WxPayRefundNotifyResultTest.java
index 963afb2618..e7a22ee6cd 100644
--- a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/notify/WxPayRefundNotifyResultTest.java
+++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/notify/WxPayRefundNotifyResultTest.java
@@ -119,7 +119,7 @@ public void testFromXMLFastMode() throws WxPayException {
refundNotifyResult.loadReqInfo(xmlDecryptedReqInfo);
assertEquals(refundNotifyResult.getReqInfo().getRefundFee().intValue(), 15);
assertEquals(refundNotifyResult.getReqInfo().getRefundStatus(), "SUCCESS");
- assertEquals(refundNotifyResult.getReqInfo().getRefundRecvAccout(), "用户零钱");
+ assertEquals(refundNotifyResult.getReqInfo().getRefundRecvAccount(), "用户零钱");
System.out.println(refundNotifyResult);
} finally {
XmlConfig.fastMode = false;
From 3a1d8075fc27adf5eae9d23cd7628387132fce7a Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Thu, 24 Jul 2025 16:39:56 +0800
Subject: [PATCH 026/208] :art: Fix StackOverflowError in
WxCpRedissonConfigImpl and WxCpRedisTemplateConfigImpl toString() methods
---
.../impl/AbstractWxCpInRedisConfigImpl.java | 13 ++++
.../cp/config/impl/DemoToStringFix.java | 66 +++++++++++++++++++
2 files changed, 79 insertions(+)
create mode 100644 weixin-java-cp/src/test/java/me/chanjar/weixin/cp/config/impl/DemoToStringFix.java
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/AbstractWxCpInRedisConfigImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/AbstractWxCpInRedisConfigImpl.java
index 780e722c30..a078e8cf9e 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/AbstractWxCpInRedisConfigImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/AbstractWxCpInRedisConfigImpl.java
@@ -180,4 +180,17 @@ public boolean isAgentJsapiTicketExpired() {
Long expire = redisOps.getExpire(this.agentJsapiTicketKey);
return expire == null || expire < 2;
}
+
+ @Override
+ public String toString() {
+ return "AbstractWxCpInRedisConfigImpl{" +
+ "corpId='" + getCorpId() + '\'' +
+ ", agentId=" + getAgentId() +
+ ", keyPrefix='" + keyPrefix + '\'' +
+ ", accessTokenKey='" + accessTokenKey + '\'' +
+ ", jsapiTicketKey='" + jsapiTicketKey + '\'' +
+ ", agentJsapiTicketKey='" + agentJsapiTicketKey + '\'' +
+ ", lockKey='" + lockKey + '\'' +
+ '}';
+ }
}
diff --git a/weixin-java-cp/src/test/java/me/chanjar/weixin/cp/config/impl/DemoToStringFix.java b/weixin-java-cp/src/test/java/me/chanjar/weixin/cp/config/impl/DemoToStringFix.java
new file mode 100644
index 0000000000..48fe9a6639
--- /dev/null
+++ b/weixin-java-cp/src/test/java/me/chanjar/weixin/cp/config/impl/DemoToStringFix.java
@@ -0,0 +1,66 @@
+package me.chanjar.weixin.cp.config.impl;
+
+import me.chanjar.weixin.common.redis.WxRedisOps;
+
+/**
+ * Demonstration of the fix for toString() StackOverflowError issue
+ */
+public class DemoToStringFix {
+
+ public static void main(String[] args) {
+ System.out.println("=== Demonstrating toString() Fix for WxCp Redis Config ===");
+
+ // Create a simple stub WxRedisOps implementation for testing
+ WxRedisOps stubRedisOps = new WxRedisOps() {
+ @Override
+ public String getValue(String key) { return null; }
+ @Override
+ public void setValue(String key, String value, int expire, java.util.concurrent.TimeUnit timeUnit) {}
+ @Override
+ public Long getExpire(String key) { return null; }
+ @Override
+ public void expire(String key, int expire, java.util.concurrent.TimeUnit timeUnit) {}
+ @Override
+ public java.util.concurrent.locks.Lock getLock(String key) { return null; }
+ };
+
+ // Test AbstractWxCpInRedisConfigImpl directly with our stub
+ AbstractWxCpInRedisConfigImpl config = new AbstractWxCpInRedisConfigImpl(stubRedisOps, "demo:") {
+ // Anonymous class to test the abstract parent
+ };
+
+ config.setCorpId("demoCorpId");
+ config.setAgentId(1001);
+
+ System.out.println("Testing toString() method:");
+ try {
+ String result = config.toString();
+ System.out.println("✓ Success! toString() returned: " + result);
+ System.out.println("✓ No StackOverflowError occurred");
+
+ // Verify the result contains expected information and excludes redisOps
+ boolean containsCorpId = result.contains("demoCorpId");
+ boolean containsAgentId = result.contains("1001");
+ boolean containsKeyPrefix = result.contains("demo:");
+ boolean excludesRedisOps = !result.contains("redisOps") && !result.contains("WxRedisOps");
+
+ System.out.println("✓ Contains corpId: " + containsCorpId);
+ System.out.println("✓ Contains agentId: " + containsAgentId);
+ System.out.println("✓ Contains keyPrefix: " + containsKeyPrefix);
+ System.out.println("✓ Excludes redisOps: " + excludesRedisOps);
+
+ if (containsCorpId && containsAgentId && containsKeyPrefix && excludesRedisOps) {
+ System.out.println("✓ All validations passed!");
+ } else {
+ System.out.println("✗ Some validations failed");
+ }
+
+ } catch (StackOverflowError e) {
+ System.out.println("✗ StackOverflowError still occurred - fix failed");
+ } catch (Exception e) {
+ System.out.println("✗ Unexpected error: " + e.getMessage());
+ }
+
+ System.out.println("\n=== Demo completed ===");
+ }
+}
\ No newline at end of file
From 262a02b606354db065250993e40f6c39507a5ade Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Thu, 24 Jul 2025 16:43:23 +0800
Subject: [PATCH 027/208] =?UTF-8?q?:memo:=20=E4=B8=BA=E5=BE=AE=E4=BF=A1?=
=?UTF-8?q?=E6=94=AF=E4=BB=98=E6=96=B0=E5=A2=9E=E5=95=86=E6=88=B7=E8=BD=AC?=
=?UTF-8?q?=E8=B4=A6=E6=8E=A5=E5=8F=A3=E6=B7=BB=E5=8A=A0=E5=85=A8=E9=9D=A2?=
=?UTF-8?q?=E7=9A=84=E6=96=87=E6=A1=A3=E5=92=8C=E7=A4=BA=E4=BE=8B?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
NEW_TRANSFER_API_SUPPORT.md | 129 +++++++++
NEW_TRANSFER_API_USAGE.md | 148 +++++++++++
.../wxpay/example/NewTransferApiExample.java | 249 ++++++++++++++++++
3 files changed, 526 insertions(+)
create mode 100644 NEW_TRANSFER_API_SUPPORT.md
create mode 100644 NEW_TRANSFER_API_USAGE.md
create mode 100644 weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/NewTransferApiExample.java
diff --git a/NEW_TRANSFER_API_SUPPORT.md b/NEW_TRANSFER_API_SUPPORT.md
new file mode 100644
index 0000000000..c7e9eaf490
--- /dev/null
+++ b/NEW_TRANSFER_API_SUPPORT.md
@@ -0,0 +1,129 @@
+# 微信支付新版商户转账API支持
+
+## 问题解答
+
+**问题**: 新开通的商户号只能使用最新版本的商户转账接口,WxJava是否支持?
+
+**答案**: **WxJava 已经完整支持新版商户转账API!** 从2025年1月15日开始生效的新版转账API已在WxJava中实现。
+
+## 新版转账API特性
+
+### 1. API接口对比
+
+| 特性 | 传统转账API | 新版转账API (2025.1.15+) |
+|------|-------------|-------------------------|
+| **服务类** | `MerchantTransferService` | `TransferService` |
+| **API路径** | `/v3/transfer/batches` | `/v3/fund-app/mch-transfer/transfer-bills` |
+| **转账方式** | 批量转账 | 单笔转账 |
+| **场景支持** | 基础场景 | 丰富场景(如佣金报酬等) |
+| **撤销功能** | ❌ 不支持 | ✅ 支持 |
+| **适用范围** | 所有商户 | **新开通商户必须使用** |
+
+### 2. 新版API功能列表
+
+✅ **发起转账** - `transferBills()`
+✅ **查询转账** - `getBillsByOutBillNo()` / `getBillsByTransferBillNo()`
+✅ **撤销转账** - `transformBillsCancel()`
+✅ **回调通知** - `parseTransferBillsNotifyResult()`
+✅ **RSA加密** - 自动处理用户姓名加密
+✅ **场景支持** - 支持多种转账场景ID
+
+## 快速开始
+
+### 1. 获取服务实例
+
+```java
+// 获取WxPayService实例
+WxPayService wxPayService = new WxPayServiceImpl();
+wxPayService.setConfig(config);
+
+// 获取新版转账服务 - 这就是新开通商户需要使用的服务!
+TransferService transferService = wxPayService.getTransferService();
+```
+
+### 2. 发起转账(新版API)
+
+```java
+// 构建转账请求
+TransferBillsRequest request = TransferBillsRequest.newBuilder()
+ .appid("your_appid") // 应用ID
+ .outBillNo("T" + System.currentTimeMillis()) // 商户转账单号
+ .transferSceneId("1005") // 转账场景ID(佣金报酬)
+ .openid("user_openid") // 用户openid
+ .userName("张三") // 收款用户姓名(可选,自动加密)
+ .transferAmount(100) // 转账金额(分)
+ .transferRemark("佣金报酬") // 转账备注
+ .build();
+
+// 发起转账
+TransferBillsResult result = transferService.transferBills(request);
+System.out.println("转账成功,微信转账单号:" + result.getTransferBillNo());
+```
+
+### 3. 查询转账结果
+
+```java
+// 通过商户单号查询
+TransferBillsGetResult result = transferService.getBillsByOutBillNo("T1642567890123");
+
+// 通过微信转账单号查询
+TransferBillsGetResult result2 = transferService.getBillsByTransferBillNo("wx_transfer_bill_no");
+
+System.out.println("转账状态:" + result.getState());
+```
+
+### 4. 撤销转账(新功能)
+
+```java
+// 撤销转账
+TransferBillsCancelResult cancelResult = transferService.transformBillsCancel("T1642567890123");
+System.out.println("撤销状态:" + cancelResult.getState());
+```
+
+## 重要说明
+
+### 转账场景ID (transfer_scene_id)
+- **1005**: 佣金报酬(常用场景)
+- 其他场景需要在微信商户平台申请
+
+### 转账状态说明
+- **ACCEPTED**: 转账已受理
+- **PROCESSING**: 转账处理中
+- **SUCCESS**: 转账成功
+- **FAIL**: 转账失败
+- **CANCELLED**: 转账撤销完成
+
+### 新开通商户使用建议
+
+1. **优先使用** `TransferService` (新版API)
+2. **不要使用** `MerchantTransferService` (可能不支持)
+3. **必须设置** 转账场景ID (`transfer_scene_id`)
+4. **建议开启** 回调通知以实时获取转账结果
+
+## 完整示例代码
+
+详细的使用示例请参考:
+- 📄 [NEW_TRANSFER_API_USAGE.md](./NEW_TRANSFER_API_USAGE.md) - 详细使用指南
+- 💻 [NewTransferApiExample.java](./weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/NewTransferApiExample.java) - 完整代码示例
+
+## 常见问题
+
+**Q: 我是新开通的商户,应该使用哪个服务?**
+A: 使用 `TransferService`,这是专为新版API设计的服务。
+
+**Q: 新版API和旧版API有什么区别?**
+A: 新版API使用单笔转账模式,支持更丰富的转账场景,并且支持撤销功能。
+
+**Q: 如何设置转账场景ID?**
+A: 在商户平台申请相应场景,常用的佣金报酬场景ID是"1005"。
+
+**Q: 用户姓名需要加密吗?**
+A: WxJava会自动处理RSA加密,您只需要传入明文姓名即可。
+
+## 版本要求
+
+- WxJava 版本:4.7.0+
+- 支持时间:2025年1月15日+
+- 适用商户:所有商户(新开通商户强制使用)
+
+通过以上说明,新开通的微信支付商户可以放心使用WxJava进行商户转账操作!
\ No newline at end of file
diff --git a/NEW_TRANSFER_API_USAGE.md b/NEW_TRANSFER_API_USAGE.md
new file mode 100644
index 0000000000..9d1ac8254a
--- /dev/null
+++ b/NEW_TRANSFER_API_USAGE.md
@@ -0,0 +1,148 @@
+# 微信支付新版商户转账API使用指南
+
+## 概述
+
+从2025年1月15日开始,微信支付推出了新版的商户转账API。新开通的商户号只能使用最新版本的商户转账接口。WxJava 已经完整支持新版转账API。
+
+## API对比
+
+### 传统转账API (仍然支持)
+- **服务类**: `MerchantTransferService`
+- **API前缀**: `/v3/transfer/batches`
+- **特点**: 支持批量转账,一次可以转账给多个用户
+
+### 新版转账API (2025.1.15+)
+- **服务类**: `TransferService`
+- **API前缀**: `/v3/fund-app/mch-transfer/transfer-bills`
+- **特点**: 单笔转账,支持更丰富的转账场景
+
+## 使用新版转账API
+
+### 1. 获取服务实例
+
+```java
+// 获取WxPayService实例
+WxPayService wxPayService = new WxPayServiceImpl();
+wxPayService.setConfig(config);
+
+// 获取新版转账服务
+TransferService transferService = wxPayService.getTransferService();
+```
+
+### 2. 发起转账
+
+```java
+// 构建转账请求
+TransferBillsRequest request = TransferBillsRequest.newBuilder()
+ .appid("your_appid") // 应用ID
+ .outBillNo("T" + System.currentTimeMillis()) // 商户转账单号
+ .transferSceneId("1005") // 转账场景ID(佣金报酬)
+ .openid("user_openid") // 用户openid
+ .userName("张三") // 收款用户姓名(可选,需要加密)
+ .transferAmount(100) // 转账金额(分)
+ .transferRemark("佣金报酬") // 转账备注
+ .notifyUrl("https://your-domain.com/notify") // 回调地址(可选)
+ .userRecvPerception("Y") // 用户收款感知(可选)
+ .build();
+
+try {
+ TransferBillsResult result = transferService.transferBills(request);
+ System.out.println("转账成功,微信转账单号:" + result.getTransferBillNo());
+ System.out.println("状态:" + result.getState());
+} catch (WxPayException e) {
+ System.err.println("转账失败:" + e.getMessage());
+}
+```
+
+### 3. 查询转账结果
+
+```java
+// 通过商户单号查询
+String outBillNo = "T1642567890123";
+TransferBillsGetResult result = transferService.getBillsByOutBillNo(outBillNo);
+
+// 通过微信转账单号查询
+String transferBillNo = "1000000000000000000000000001";
+TransferBillsGetResult result2 = transferService.getBillsByTransferBillNo(transferBillNo);
+
+System.out.println("转账状态:" + result.getState());
+System.out.println("转账金额:" + result.getTransferAmount());
+```
+
+### 4. 撤销转账
+
+```java
+// 撤销转账(仅在特定状态下可撤销)
+String outBillNo = "T1642567890123";
+TransferBillsCancelResult cancelResult = transferService.transformBillsCancel(outBillNo);
+System.out.println("撤销结果:" + cancelResult.getState());
+```
+
+### 5. 处理回调通知
+
+```java
+// 在回调接口中处理通知
+@PostMapping("/transfer/notify")
+public String handleTransferNotify(HttpServletRequest request) throws Exception {
+ String notifyData = StreamUtils.copyToString(request.getInputStream(), StandardCharsets.UTF_8);
+
+ // 构建签名头
+ SignatureHeader header = new SignatureHeader();
+ header.setTimeStamp(request.getHeader("Wechatpay-Timestamp"));
+ header.setNonce(request.getHeader("Wechatpay-Nonce"));
+ header.setSignature(request.getHeader("Wechatpay-Signature"));
+ header.setSerial(request.getHeader("Wechatpay-Serial"));
+
+ try {
+ TransferBillsNotifyResult notifyResult = transferService.parseTransferBillsNotifyResult(notifyData, header);
+
+ // 处理业务逻辑
+ String outBillNo = notifyResult.getOutBillNo();
+ String state = notifyResult.getState();
+
+ System.out.println("转账单号:" + outBillNo + ",状态:" + state);
+
+ return "SUCCESS";
+ } catch (WxPayException e) {
+ System.err.println("验签失败:" + e.getMessage());
+ return "FAIL";
+ }
+}
+```
+
+## 重要参数说明
+
+### 转账场景ID (transfer_scene_id)
+- **1005**: 佣金报酬(常用)
+- 其他场景ID需要在商户平台申请
+
+### 转账状态
+- **PROCESSING**: 转账中
+- **SUCCESS**: 转账成功
+- **FAILED**: 转账失败
+- **REFUNDED**: 已退款
+
+### 用户收款感知 (user_recv_perception)
+- **Y**: 用户会收到微信转账通知
+- **N**: 用户不会收到微信转账通知
+
+## 新旧API对比总结
+
+| 特性 | 传统API (MerchantTransferService) | 新版API (TransferService) |
+|------|----------------------------------|---------------------------|
+| 发起方式 | 批量转账 | 单笔转账 |
+| API路径 | `/v3/transfer/batches` | `/v3/fund-app/mch-transfer/transfer-bills` |
+| 场景支持 | 基础转账场景 | 丰富的转账场景 |
+| 回调通知 | 支持 | 支持 |
+| 撤销功能 | 不支持 | 支持 |
+| 适用商户 | 所有商户 | 新开通商户必须使用 |
+
+## 注意事项
+
+1. **新开通的商户号**: 必须使用新版API (`TransferService`)
+2. **转账场景ID**: 需要在商户平台申请相应的转账场景
+3. **用户姓名加密**: 如果传入用户姓名,会自动进行RSA加密
+4. **回调验签**: 建议开启回调验签以确保安全性
+5. **错误处理**: 妥善处理各种异常情况
+
+通过以上指南,您可以轻松使用WxJava的新版商户转账API功能。
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/NewTransferApiExample.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/NewTransferApiExample.java
new file mode 100644
index 0000000000..8d74e5a4ef
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/NewTransferApiExample.java
@@ -0,0 +1,249 @@
+package com.github.binarywang.wxpay.example;
+
+import com.github.binarywang.wxpay.bean.notify.SignatureHeader;
+import com.github.binarywang.wxpay.bean.transfer.*;
+import com.github.binarywang.wxpay.config.WxPayConfig;
+import com.github.binarywang.wxpay.exception.WxPayException;
+import com.github.binarywang.wxpay.service.TransferService;
+import com.github.binarywang.wxpay.service.WxPayService;
+import com.github.binarywang.wxpay.service.impl.WxPayServiceImpl;
+
+/**
+ * 新版商户转账API使用示例
+ *
+ * 从2025年1月15日开始,微信支付推出了新版的商户转账API
+ * 新开通的商户号只能使用最新版本的商户转账接口
+ *
+ * @author WxJava Team
+ * @since 2025-01-15
+ */
+public class NewTransferApiExample {
+
+ private final TransferService transferService;
+
+ public NewTransferApiExample(WxPayConfig config) {
+ // 初始化微信支付服务
+ WxPayService wxPayService = new WxPayServiceImpl();
+ wxPayService.setConfig(config);
+
+ // 获取新版转账服务
+ this.transferService = wxPayService.getTransferService();
+ }
+
+ /**
+ * 发起单笔转账示例
+ * 新版API使用 /v3/fund-app/mch-transfer/transfer-bills 接口
+ */
+ public void transferExample() {
+ try {
+ // 构建转账请求
+ TransferBillsRequest request = TransferBillsRequest.newBuilder()
+ .appid("wx1234567890123456") // 应用ID
+ .outBillNo("TRANSFER_" + System.currentTimeMillis()) // 商户转账单号,确保唯一
+ .transferSceneId("1005") // 转账场景ID(1005=佣金报酬)
+ .openid("oUpF8uMuAJO_M2pxb1Q9zNjWeS6o") // 收款用户的openid
+ .userName("张三") // 收款用户真实姓名(可选,会自动加密)
+ .transferAmount(100) // 转账金额,单位:分(此处为1元)
+ .transferRemark("佣金报酬") // 转账备注,用户可见
+ .notifyUrl("https://your-domain.com/transfer/notify") // 异步通知地址(可选)
+ .userRecvPerception("Y") // 用户收款感知:Y=会收到通知,N=不会收到通知
+ .build();
+
+ // 发起转账
+ TransferBillsResult result = transferService.transferBills(request);
+
+ // 输出结果
+ System.out.println("=== 转账发起成功 ===");
+ System.out.println("商户单号: " + result.getOutBillNo());
+ System.out.println("微信转账单号: " + result.getTransferBillNo());
+ System.out.println("创建时间: " + result.getCreateTime());
+ System.out.println("状态: " + result.getState());
+ System.out.println("跳转领取页面信息: " + result.getPackageInfo());
+
+ } catch (WxPayException e) {
+ System.err.println("转账失败: " + e.getMessage());
+ System.err.println("错误代码: " + e.getErrCode());
+ System.err.println("错误描述: " + e.getErrCodeDes());
+ }
+ }
+
+ /**
+ * 通过商户单号查询转账结果
+ */
+ public void queryByOutBillNoExample() {
+ try {
+ String outBillNo = "TRANSFER_1642567890123";
+ TransferBillsGetResult result = transferService.getBillsByOutBillNo(outBillNo);
+
+ System.out.println("=== 查询转账结果(商户单号)===");
+ System.out.println("商户单号: " + result.getOutBillNo());
+ System.out.println("微信转账单号: " + result.getTransferBillNo());
+ System.out.println("状态: " + result.getState());
+ System.out.println("转账金额: " + result.getTransferAmount() + "分");
+ System.out.println("用户openid: " + result.getOpenid());
+ System.out.println("转账备注: " + result.getTransferRemark());
+
+ } catch (WxPayException e) {
+ System.err.println("查询失败: " + e.getMessage());
+ }
+ }
+
+ /**
+ * 通过微信转账单号查询转账结果
+ */
+ public void queryByTransferBillNoExample() {
+ try {
+ String transferBillNo = "1000000000000000000000000001";
+ TransferBillsGetResult result = transferService.getBillsByTransferBillNo(transferBillNo);
+
+ System.out.println("=== 查询转账结果(微信单号)===");
+ System.out.println("微信转账单号: " + result.getTransferBillNo());
+ System.out.println("状态: " + result.getState());
+ System.out.println("失败原因: " + result.getFailReason());
+
+ } catch (WxPayException e) {
+ System.err.println("查询失败: " + e.getMessage());
+ }
+ }
+
+ /**
+ * 撤销转账示例
+ * 注意:只有在特定状态下才能撤销
+ */
+ public void cancelTransferExample() {
+ try {
+ String outBillNo = "TRANSFER_1642567890123";
+ TransferBillsCancelResult result = transferService.transformBillsCancel(outBillNo);
+
+ System.out.println("=== 撤销转账结果 ===");
+ System.out.println("商户单号: " + result.getOutBillNo());
+ System.out.println("状态: " + result.getState());
+ System.out.println("更新时间: " + result.getUpdateTime());
+
+ } catch (WxPayException e) {
+ System.err.println("撤销失败: " + e.getMessage());
+ }
+ }
+
+ /**
+ * 处理转账回调通知示例
+ * 这个方法通常在您的Web服务器的回调接口中调用
+ */
+ public void handleNotifyExample(String notifyData, String timestamp, String nonce, String signature, String serial) {
+ try {
+ // 构建签名头信息
+ SignatureHeader header = new SignatureHeader();
+ header.setTimeStamp(timestamp);
+ header.setNonce(nonce);
+ header.setSignature(signature);
+ header.setSerial(serial);
+
+ // 解析并验签回调数据
+ TransferBillsNotifyResult notifyResult = transferService.parseTransferBillsNotifyResult(notifyData, header);
+
+ System.out.println("=== 处理转账回调通知 ===");
+ System.out.println("商户单号: " + notifyResult.getResult().getOutBillNo());
+ System.out.println("微信转账单号: " + notifyResult.getResult().getTransferBillNo());
+ System.out.println("状态: " + notifyResult.getResult().getState());
+ System.out.println("转账金额: " + notifyResult.getResult().getTransferAmount() + "分");
+ System.out.println("更新时间: " + notifyResult.getResult().getUpdateTime());
+
+ // 根据状态处理业务逻辑
+ switch (notifyResult.getResult().getState()) {
+ case "SUCCESS":
+ System.out.println("转账成功,进行业务处理...");
+ // 更新订单状态、发送通知等
+ break;
+ case "FAIL":
+ System.out.println("转账失败,失败原因: " + notifyResult.getResult().getFailReason());
+ // 处理失败逻辑
+ break;
+ default:
+ System.out.println("其他状态: " + notifyResult.getResult().getState());
+ }
+
+ } catch (WxPayException e) {
+ System.err.println("回调处理失败: " + e.getMessage());
+ }
+ }
+
+ /**
+ * 批量转账示例(使用传统API)
+ * 注意:新商户可能无法使用此API,建议使用新版单笔转账API
+ */
+ public void batchTransferExample() {
+ try {
+ // 构建转账明细列表
+ TransferBatchesRequest.TransferDetail detail1 = TransferBatchesRequest.TransferDetail.newBuilder()
+ .outDetailNo("DETAIL_" + System.currentTimeMillis() + "_1")
+ .transferAmount(100) // 1元
+ .transferRemark("佣金1")
+ .openid("oUpF8uMuAJO_M2pxb1Q9zNjWeS6o")
+ .userName("张三")
+ .build();
+
+ TransferBatchesRequest.TransferDetail detail2 = TransferBatchesRequest.TransferDetail.newBuilder()
+ .outDetailNo("DETAIL_" + System.currentTimeMillis() + "_2")
+ .transferAmount(200) // 2元
+ .transferRemark("佣金2")
+ .openid("oUpF8uMuAJO_M2pxb1Q9zNjWeS6p")
+ .userName("李四")
+ .build();
+
+ // 构建批量转账请求
+ TransferBatchesRequest batchRequest = TransferBatchesRequest.newBuilder()
+ .appid("wx1234567890123456")
+ .outBatchNo("BATCH_" + System.currentTimeMillis())
+ .batchName("佣金批量发放")
+ .batchRemark("2024年1月佣金")
+ .totalAmount(300) // 总金额:3元
+ .totalNum(2) // 总笔数:2笔
+ .transferDetailList(java.util.Arrays.asList(detail1, detail2))
+ .transferSceneId("1005") // 转账场景ID
+ .build();
+
+ // 发起批量转账
+ TransferBatchesResult batchResult = transferService.transferBatches(batchRequest);
+
+ System.out.println("=== 批量转账发起成功 ===");
+ System.out.println("商户批次单号: " + batchResult.getOutBatchNo());
+ System.out.println("微信批次单号: " + batchResult.getBatchId());
+ System.out.println("批次状态: " + batchResult.getBatchStatus());
+
+ } catch (WxPayException e) {
+ System.err.println("批量转账失败: " + e.getMessage());
+ }
+ }
+
+ /**
+ * 使用配置示例
+ */
+ public static void main(String[] args) {
+ // 配置微信支付参数
+ WxPayConfig config = new WxPayConfig();
+ config.setAppId("wx1234567890123456"); // 应用ID
+ config.setMchId("1234567890"); // 商户ID
+ config.setApiV3Key("your_api_v3_key_32_chars"); // APIv3密钥
+ config.setPrivateKeyPath("path/to/private.pem"); // 商户私钥文件路径
+ config.setCertSerialNo("your_certificate_serial"); // 商户证书序列号
+
+ // 创建示例实例
+ NewTransferApiExample example = new NewTransferApiExample(config);
+
+ // 运行示例
+ System.out.println("新版商户转账API使用示例");
+ System.out.println("===============================");
+
+ // 1. 发起单笔转账
+ example.transferExample();
+
+ // 2. 查询转账结果
+ // example.queryByOutBillNoExample();
+
+ // 3. 撤销转账
+ // example.cancelTransferExample();
+
+ // 4. 批量转账(传统API)
+ // example.batchTransferExample();
+ }
+}
\ No newline at end of file
From 875c35e7458c9e4c0d2563829fb413fc2a1c933b Mon Sep 17 00:00:00 2001
From: Winnie
*
- * @return the wx mp kf list
- * @throws WxErrorException 异常
+ * @return 客服基本信息列表,包含客服账号、昵称、头像等信息
+ * @throws WxErrorException 微信API调用异常
*/
WxMpKfList kfList() throws WxErrorException;
@@ -69,8 +69,8 @@ public interface WxMpKefuService {
* 接口url格式:https://api.weixin.qq.com/cgi-bin/customservice/getonlinekflist?access_token=ACCESS_TOKEN
*
+ * 微信支付v3结果共用属性类.
+ * 用于保存原始JSON响应内容,便于访问API返回的新增字段.
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+public abstract class BaseWxPayV3Result implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 原始JSON字符串.
+ * 保存微信支付v3 API返回的原始JSON内容,便于访问未在Result类中定义的字段.
+ */
+ private String rawJsonString;
+
+ /**
+ * 获取原始JSON响应内容.
+ *
+ * @return 原始JSON字符串
+ */
+ public String getRawJsonString() {
+ return rawJsonString;
+ }
+
+ /**
+ * 设置原始JSON响应内容.
+ *
+ * @param rawJsonString 原始JSON字符串
+ */
+ public void setRawJsonString(String rawJsonString) {
+ this.rawJsonString = rawJsonString;
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/MarketingFavorServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/MarketingFavorServiceImpl.java
index a10bbbb085..0f84d5f126 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/MarketingFavorServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/MarketingFavorServiceImpl.java
@@ -34,7 +34,9 @@ public FavorStocksCreateResult createFavorStocksV3(FavorStocksCreateRequest requ
String url = String.format("%s/v3/marketing/favor/coupon-stocks", this.payService.getPayBaseUrl());
RsaCryptoUtil.encryptFields(request, this.payService.getConfig().getVerifier().getValidCertificate());
String result = this.payService.postV3WithWechatpaySerial(url, GSON.toJson(request));
- return GSON.fromJson(result, FavorStocksCreateResult.class);
+ FavorStocksCreateResult favorStocksCreateResult = GSON.fromJson(result, FavorStocksCreateResult.class);
+ favorStocksCreateResult.setRawJsonString(result);
+ return favorStocksCreateResult;
}
@Override
@@ -75,7 +77,9 @@ public FavorStocksGetResult getFavorStocksV3(String stockId, String stockCreator
String url = String.format("%s/v3/marketing/favor/stocks/%s", this.payService.getPayBaseUrl(), stockId);
String query = String.format("?stock_creator_mchid=%s", stockCreatorMchid);
String result = this.payService.getV3(url + query);
- return GSON.fromJson(result, FavorStocksGetResult.class);
+ FavorStocksGetResult favorStocksGetResult = GSON.fromJson(result, FavorStocksGetResult.class);
+ favorStocksGetResult.setRawJsonString(result);
+ return favorStocksGetResult;
}
@Override
@@ -83,7 +87,9 @@ public FavorCouponsGetResult getFavorCouponsV3(String couponId, String appid, St
String url = String.format("%s/v3/marketing/favor/users/%s/coupons/%s", this.payService.getPayBaseUrl(), openid, couponId);
String query = String.format("?appid=%s", appid);
String result = this.payService.getV3(url + query);
- return GSON.fromJson(result, FavorCouponsGetResult.class);
+ FavorCouponsGetResult favorCouponsGetResult = GSON.fromJson(result, FavorCouponsGetResult.class);
+ favorCouponsGetResult.setRawJsonString(result);
+ return favorCouponsGetResult;
}
@Override
diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/marketing/FavorStocksGetResultTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/marketing/FavorStocksGetResultTest.java
new file mode 100644
index 0000000000..ed39413833
--- /dev/null
+++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/marketing/FavorStocksGetResultTest.java
@@ -0,0 +1,164 @@
+package com.github.binarywang.wxpay.bean.marketing;
+
+import com.github.binarywang.wxpay.bean.result.BaseWxPayV3Result;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonParser;
+import org.testng.annotations.Test;
+
+import static org.testng.Assert.*;
+
+/**
+ * 测试FavorStocksGetResult的原始JSON保存功能
+ *
+ * @author Binary Wang
+ */
+public class FavorStocksGetResultTest {
+
+ private static final Gson GSON = new GsonBuilder().create();
+
+ @Test
+ public void testRawJsonPreservation() {
+ // 模拟微信API返回的JSON(包含未在Result类中定义的字段)
+ String mockJson = "{\n" +
+ " \"stock_id\": \"9836588\",\n" +
+ " \"stock_creator_mchid\": \"1230000109\",\n" +
+ " \"stock_name\": \"微信支付代金券\",\n" +
+ " \"status\": \"running\",\n" +
+ " \"create_time\": \"2021-01-01T00:00:00.000+08:00\",\n" +
+ " \"description\": \"微信支付营销\",\n" +
+ " \"card_id\": \"pFS7Fjg9kqcMOBtl3bFn\",\n" +
+ " \"extra_field\": \"这是一个新增字段\"\n" +
+ "}";
+
+ // 模拟服务调用:反序列化JSON
+ FavorStocksGetResult result = GSON.fromJson(mockJson, FavorStocksGetResult.class);
+
+ // 模拟服务调用:设置原始JSON
+ result.setRawJsonString(mockJson);
+
+ // 验证基本字段正常解析
+ assertEquals(result.getStockId(), "9836588");
+ assertEquals(result.getStockCreatorMchId(), "1230000109");
+ assertEquals(result.getStockName(), "微信支付代金券");
+ assertEquals(result.getStatus(), "running");
+
+ // 验证原始JSON被保存
+ assertNotNull(result.getRawJsonString());
+ assertEquals(result.getRawJsonString(), mockJson);
+
+ // 验证可以从原始JSON中获取未定义的字段
+ assertTrue(result.getRawJsonString().contains("\"card_id\": \"pFS7Fjg9kqcMOBtl3bFn\""));
+ assertTrue(result.getRawJsonString().contains("\"extra_field\": \"这是一个新增字段\""));
+ }
+
+ @Test
+ public void testBaseV3ResultInheritance() {
+ FavorStocksGetResult result = new FavorStocksGetResult();
+
+ // 验证继承关系
+ assertTrue(result instanceof BaseWxPayV3Result);
+
+ // 验证基类方法可用
+ result.setRawJsonString("test json");
+ assertEquals(result.getRawJsonString(), "test json");
+ }
+
+ @Test
+ public void testNullRawJson() {
+ FavorStocksGetResult result = new FavorStocksGetResult();
+
+ // 验证初始状态下rawJsonString为null
+ assertNull(result.getRawJsonString());
+
+ // 验证设置null不会出错
+ result.setRawJsonString(null);
+ assertNull(result.getRawJsonString());
+ }
+
+ @Test
+ public void testRealWorldUsagePattern() {
+ // 实际使用场景的示例
+ String realApiResponse = "{\n" +
+ " \"stock_id\": \"9836588\",\n" +
+ " \"stock_creator_mchid\": \"1230000109\",\n" +
+ " \"stock_name\": \"微信支付代金券\",\n" +
+ " \"status\": \"running\",\n" +
+ " \"create_time\": \"2021-01-01T00:00:00.000+08:00\",\n" +
+ " \"description\": \"微信支付营销\",\n" +
+ " \"card_id\": \"pFS7Fjg9kqcMOBtl3bFn\",\n" +
+ " \"future_field_1\": \"未来可能新增的字段1\",\n" +
+ " \"future_field_2\": \"未来可能新增的字段2\"\n" +
+ "}";
+
+ FavorStocksGetResult result = GSON.fromJson(realApiResponse, FavorStocksGetResult.class);
+ result.setRawJsonString(realApiResponse);
+
+ // 1. 正常使用已定义的字段
+ assertEquals(result.getStockId(), "9836588");
+ assertEquals(result.getStockName(), "微信支付代金券");
+
+ // 2. 安全地获取可能存在的新字段
+ String cardId = getStringFieldSafely(result, "card_id");
+ assertEquals(cardId, "pFS7Fjg9kqcMOBtl3bFn");
+
+ // 3. 获取未来可能新增的字段
+ String futureField1 = getStringFieldSafely(result, "future_field_1");
+ assertEquals(futureField1, "未来可能新增的字段1");
+
+ String nonExistentField = getStringFieldSafely(result, "non_existent");
+ assertNull(nonExistentField);
+ }
+
+ @Test
+ public void testCardIdExtractionExample() {
+ // 测试具体的card_id字段提取(这是issue中提到的用例)
+ String apiResponseWithCardId = "{\n" +
+ " \"stock_id\": \"9836588\",\n" +
+ " \"stock_creator_mchid\": \"1230000109\",\n" +
+ " \"stock_name\": \"微信支付代金券\",\n" +
+ " \"status\": \"running\",\n" +
+ " \"card_id\": \"pFS7Fjg9kqcMOBtl3bFn\"\n" +
+ "}";
+
+ FavorStocksGetResult result = GSON.fromJson(apiResponseWithCardId, FavorStocksGetResult.class);
+ result.setRawJsonString(apiResponseWithCardId);
+
+ // 验证可以获取card_id字段
+ JsonElement jsonElement = JsonParser.parseString(result.getRawJsonString());
+ assertTrue(jsonElement.getAsJsonObject().has("card_id"));
+ String cardId = jsonElement.getAsJsonObject().get("card_id").getAsString();
+ assertEquals(cardId, "pFS7Fjg9kqcMOBtl3bFn");
+
+ // 展示实际用法
+ String extractedCardId = extractCardId(result);
+ assertEquals(extractedCardId, "pFS7Fjg9kqcMOBtl3bFn");
+ }
+
+ /**
+ * 提取card_id的示例方法
+ */
+ private String extractCardId(FavorStocksGetResult result) {
+ return getStringFieldSafely(result, "card_id");
+ }
+
+ /**
+ * 安全地从结果中获取字符串字段的工具方法
+ */
+ private String getStringFieldSafely(BaseWxPayV3Result result, String fieldName) {
+ String rawJson = result.getRawJsonString();
+ if (rawJson == null) return null;
+
+ try {
+ JsonElement jsonElement = JsonParser.parseString(rawJson);
+ if (jsonElement.getAsJsonObject().has(fieldName)) {
+ JsonElement fieldElement = jsonElement.getAsJsonObject().get(fieldName);
+ return fieldElement.isJsonNull() ? null : fieldElement.getAsString();
+ }
+ } catch (Exception e) {
+ // 解析失败时返回null
+ }
+ return null;
+ }
+}
\ No newline at end of file
From bc6fb7b58ec9f35769714a2023c6fef3abfc4a1a Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Fri, 8 Aug 2025 17:40:28 +0800
Subject: [PATCH 034/208] =?UTF-8?q?:art:=20#3656=20=E3=80=90=E5=BE=AE?=
=?UTF-8?q?=E4=BF=A1=E6=94=AF=E4=BB=98=E3=80=91=20=E4=BF=AE=E5=A4=8D?=
=?UTF-8?q?=E5=B9=B3=E5=8F=B0=E6=94=B6=E4=BB=98=E9=80=9A=20-=20=E5=90=88?=
=?UTF-8?q?=E5=8D=95=E6=94=AF=E4=BB=98=20-=20=E5=85=B3=E9=97=AD=E8=AE=A2?=
=?UTF-8?q?=E5=8D=95=E6=8E=A5=E5=8F=A3=EF=BC=8C=E5=A2=9E=E5=8A=A0=E7=BC=BA?=
=?UTF-8?q?=E5=B0=91=E7=9A=84=E4=B8=A4=E4=B8=AA=E5=8F=82=E6=95=B0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../bean/request/CombineCloseRequest.java | 28 +++++++++++
.../bean/request/CombineCloseRequestTest.java | 47 +++++++++++++++++++
2 files changed, 75 insertions(+)
create mode 100644 weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/request/CombineCloseRequestTest.java
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/CombineCloseRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/CombineCloseRequest.java
index b397f0f1c0..428878dc77 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/CombineCloseRequest.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/CombineCloseRequest.java
@@ -87,5 +87,33 @@ public static class SubOrders implements Serializable {
*/
@SerializedName(value = "out_trade_no")
private String outTradeNo;
+ /**
+ *
+ * 字段名:二级商户号
+ * 变量名:sub_mchid
+ * 是否必填:是
+ * 类型:string[1,32]
+ * 描述:
+ * 二级商户商户号,由微信支付生成并下发。服务商子商户的商户号,被合单方。直连商户不用传二级商户号。
+ * 示例值:1900000109
+ *
+ */
+ @SerializedName(value = "sub_mchid")
+ private String subMchid;
+ /**
+ *
+ * 字段名:子商户应用ID
+ * 变量名:sub_appid
+ * 是否必填:是
+ * 类型:string[1,32]
+ * 描述:
+ * 子商户申请的应用ID,全局唯一。请求基础下单接口时请注意APPID的应用属性,例如公众号场景下,
+ * 需使用应用属性为公众号的APPID 若sub_openid有传的情况下,
+ * sub_appid必填,且sub_appid需与sub_openid对应
+ * 示例值:wxd678efh567hg6999
+ *
+ */
+ @SerializedName(value = "sub_appid")
+ private String subAppid;
}
}
diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/request/CombineCloseRequestTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/request/CombineCloseRequestTest.java
new file mode 100644
index 0000000000..aaaa693324
--- /dev/null
+++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/request/CombineCloseRequestTest.java
@@ -0,0 +1,47 @@
+package com.github.binarywang.wxpay.bean.request;
+
+import com.google.gson.Gson;
+import org.testng.annotations.Test;
+
+import java.util.Arrays;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * @author Binary Wang
+ * created on 2024-12-19
+ */
+public class CombineCloseRequestTest {
+
+ @Test
+ public void testSerialization() {
+ CombineCloseRequest request = new CombineCloseRequest();
+ request.setCombineAppid("wxd678efh567hg6787");
+ request.setCombineOutTradeNo("P20150806125346");
+
+ CombineCloseRequest.SubOrders subOrder = new CombineCloseRequest.SubOrders();
+ subOrder.setMchid("1900000109");
+ subOrder.setOutTradeNo("20150806125346");
+ subOrder.setSubMchid("1230000109");
+ subOrder.setSubAppid("wxd678efh567hg6999");
+
+ request.setSubOrders(Arrays.asList(subOrder));
+
+ Gson gson = new Gson();
+ String json = gson.toJson(request);
+
+ // Verify that the JSON contains the new fields
+ assertThat(json).contains("\"sub_mchid\":\"1230000109\"");
+ assertThat(json).contains("\"sub_appid\":\"wxd678efh567hg6999\"");
+ assertThat(json).contains("\"combine_appid\":\"wxd678efh567hg6787\"");
+ assertThat(json).contains("\"mchid\":\"1900000109\"");
+ assertThat(json).contains("\"out_trade_no\":\"20150806125346\"");
+
+ // Verify deserialization works
+ CombineCloseRequest deserializedRequest = gson.fromJson(json, CombineCloseRequest.class);
+ assertThat(deserializedRequest.getCombineAppid()).isEqualTo("wxd678efh567hg6787");
+ assertThat(deserializedRequest.getSubOrders()).hasSize(1);
+ assertThat(deserializedRequest.getSubOrders().get(0).getSubMchid()).isEqualTo("1230000109");
+ assertThat(deserializedRequest.getSubOrders().get(0).getSubAppid()).isEqualTo("wxd678efh567hg6999");
+ }
+}
\ No newline at end of file
From dc46d9de75532409ea7ba7bfa41c874fd1704879 Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Fri, 8 Aug 2025 17:47:20 +0800
Subject: [PATCH 035/208] =?UTF-8?q?:art:=20#3640=20=E3=80=90=E5=BE=AE?=
=?UTF-8?q?=E4=BF=A1=E6=94=AF=E4=BB=98=E3=80=91=E4=BD=BF=E7=94=A8HttpClien?=
=?UTF-8?q?t=E5=8F=91=E9=80=81http=E8=AF=B7=E6=B1=82=E6=97=B6=E8=B0=83?=
=?UTF-8?q?=E6=95=B4=E4=B8=BA=E4=BD=BF=E7=94=A8=E8=BF=9E=E6=8E=A5=E6=B1=A0?=
=?UTF-8?q?=E7=9A=84=E5=BD=A2=E5=BC=8F?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
weixin-java-pay/CONNECTION_POOL.md | 67 +++++++++
.../binarywang/wxpay/config/WxPayConfig.java | 137 ++++++++++++++++++
.../impl/WxPayServiceApacheHttpImpl.java | 54 ++++---
.../impl/ConnectionPoolUsageExampleTest.java | 61 ++++++++
...rviceApacheHttpImplConnectionPoolTest.java | 86 +++++++++++
5 files changed, 388 insertions(+), 17 deletions(-)
create mode 100644 weixin-java-pay/CONNECTION_POOL.md
create mode 100644 weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/ConnectionPoolUsageExampleTest.java
create mode 100644 weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/WxPayServiceApacheHttpImplConnectionPoolTest.java
diff --git a/weixin-java-pay/CONNECTION_POOL.md b/weixin-java-pay/CONNECTION_POOL.md
new file mode 100644
index 0000000000..2b2569adcb
--- /dev/null
+++ b/weixin-java-pay/CONNECTION_POOL.md
@@ -0,0 +1,67 @@
+# HTTP连接池功能说明
+
+## 概述
+
+`WxPayServiceApacheHttpImpl` 现在支持HTTP连接池功能,可以显著提高高并发场景下的性能表现。
+
+## 主要改进
+
+1. **连接复用**: 不再为每个请求创建新的HttpClient实例,而是复用连接池中的连接
+2. **性能提升**: 减少连接建立和销毁的开销,提高吞吐量
+3. **资源优化**: 合理控制并发连接数,避免资源浪费
+4. **SSL支持**: 同时支持普通HTTP和SSL连接的连接池
+
+## 配置说明
+
+### 默认配置
+```java
+WxPayConfig config = new WxPayConfig();
+// 默认配置:
+// maxConnTotal = 20 (最大连接数)
+// maxConnPerRoute = 10 (每个路由最大连接数)
+```
+
+### 自定义配置
+```java
+WxPayConfig config = new WxPayConfig();
+config.setMaxConnTotal(50); // 设置最大连接数
+config.setMaxConnPerRoute(20); // 设置每个路由最大连接数
+```
+
+## 使用方式
+
+连接池功能是自动启用的,无需额外配置:
+
+```java
+// 1. 配置微信支付
+WxPayConfig config = new WxPayConfig();
+config.setAppId("your-app-id");
+config.setMchId("your-mch-id");
+config.setMchKey("your-mch-key");
+
+// 2. 创建支付服务(连接池自动启用)
+WxPayServiceApacheHttpImpl payService = new WxPayServiceApacheHttpImpl();
+payService.setConfig(config);
+
+// 3. 正常使用,所有HTTP请求都会使用连接池
+WxPayUnifiedOrderResult result = payService.unifiedOrder(request);
+```
+
+## 向后兼容性
+
+- 此功能完全向后兼容,现有代码无需修改
+- 如果不设置连接池参数,将使用默认配置
+- 支持原有的HttpClientBuilderCustomizer自定义功能
+
+## 注意事项
+
+1. 连接池中的HttpClient实例会被复用,不要手动关闭
+2. SSL连接和普通连接使用不同的连接池
+3. 连接池参数建议根据实际并发量调整
+4. 代理配置仍然正常工作
+
+## 性能建议
+
+- 对于高并发应用,建议适当增加`maxConnTotal`和`maxConnPerRoute`
+- 监控连接池使用情况,避免连接数不足导致的阻塞
+- 在容器环境中,注意连接池配置与容器资源限制的平衡
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/config/WxPayConfig.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/config/WxPayConfig.java
index 96b6f1dd8f..01f9cd534f 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/config/WxPayConfig.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/config/WxPayConfig.java
@@ -14,7 +14,16 @@
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.RegExUtils;
import org.apache.commons.lang3.StringUtils;
+import org.apache.http.HttpHost;
+import org.apache.http.auth.AuthScope;
+import org.apache.http.auth.UsernamePasswordCredentials;
+import org.apache.http.client.CredentialsProvider;
+import org.apache.http.impl.client.BasicCredentialsProvider;
import org.apache.http.impl.client.CloseableHttpClient;
+import org.apache.http.impl.client.HttpClients;
+import org.apache.http.impl.conn.PoolingHttpClientConnectionManager;
+import org.apache.http.conn.ssl.DefaultHostnameVerifier;
+import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.ssl.SSLContexts;
import javax.net.ssl.SSLContext;
@@ -185,11 +194,32 @@ public class WxPayConfig {
private CloseableHttpClient apiV3HttpClient;
+
+ /**
+ * 用于普通支付接口的可复用HttpClient,使用连接池
+ */
+ private CloseableHttpClient httpClient;
+
+ /**
+ * 用于需要SSL证书的支付接口的可复用HttpClient,使用连接池
+ */
+ private CloseableHttpClient sslHttpClient;
+
/**
* 支持扩展httpClientBuilder
*/
private HttpClientBuilderCustomizer httpClientBuilderCustomizer;
private HttpClientBuilderCustomizer apiV3HttpClientBuilderCustomizer;
+
+ /**
+ * HTTP连接池最大连接数,默认20
+ */
+ private int maxConnTotal = 20;
+
+ /**
+ * HTTP连接池每个路由的最大连接数,默认10
+ */
+ private int maxConnPerRoute = 10;
/**
* 私钥信息
*/
@@ -498,4 +528,111 @@ private Object[] p12ToPem() {
return null;
}
+
+ /**
+ * 初始化使用连接池的HttpClient
+ *
+ * @return CloseableHttpClient
+ * @throws WxPayException 初始化异常
+ */
+ public CloseableHttpClient initHttpClient() throws WxPayException {
+ if (this.httpClient != null) {
+ return this.httpClient;
+ }
+
+ // 创建连接池管理器
+ PoolingHttpClientConnectionManager connectionManager = new PoolingHttpClientConnectionManager();
+ connectionManager.setMaxTotal(this.maxConnTotal);
+ connectionManager.setDefaultMaxPerRoute(this.maxConnPerRoute);
+
+ // 创建HttpClient构建器
+ org.apache.http.impl.client.HttpClientBuilder httpClientBuilder = HttpClients.custom()
+ .setConnectionManager(connectionManager);
+
+ // 配置代理
+ configureProxy(httpClientBuilder);
+
+ // 提供自定义httpClientBuilder的能力
+ Optional.ofNullable(httpClientBuilderCustomizer).ifPresent(e -> {
+ e.customize(httpClientBuilder);
+ });
+
+ this.httpClient = httpClientBuilder.build();
+ return this.httpClient;
+ }
+
+ /**
+ * 初始化使用连接池且支持SSL的HttpClient
+ *
+ * @return CloseableHttpClient
+ * @throws WxPayException 初始化异常
+ */
+ public CloseableHttpClient initSslHttpClient() throws WxPayException {
+ if (this.sslHttpClient != null) {
+ return this.sslHttpClient;
+ }
+
+ // 初始化SSL上下文
+ SSLContext sslContext = this.getSslContext();
+ if (null == sslContext) {
+ sslContext = this.initSSLContext();
+ }
+
+ // 创建支持SSL的连接池管理器
+ PoolingHttpClientConnectionManager connectionManager = new PoolingHttpClientConnectionManager();
+ connectionManager.setMaxTotal(this.maxConnTotal);
+ connectionManager.setDefaultMaxPerRoute(this.maxConnPerRoute);
+
+ // 创建HttpClient构建器,配置SSL
+ org.apache.http.impl.client.HttpClientBuilder httpClientBuilder = HttpClients.custom()
+ .setConnectionManager(connectionManager)
+ .setSSLSocketFactory(new SSLConnectionSocketFactory(sslContext, new DefaultHostnameVerifier()));
+
+ // 配置代理
+ configureProxy(httpClientBuilder);
+
+ // 提供自定义httpClientBuilder的能力
+ Optional.ofNullable(httpClientBuilderCustomizer).ifPresent(e -> {
+ e.customize(httpClientBuilder);
+ });
+
+ this.sslHttpClient = httpClientBuilder.build();
+ return this.sslHttpClient;
+ }
+
+ /**
+ * 配置HTTP代理
+ */
+ private void configureProxy(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder) {
+ if (StringUtils.isNotBlank(this.getHttpProxyHost()) && this.getHttpProxyPort() > 0) {
+ if (StringUtils.isEmpty(this.getHttpProxyUsername())) {
+ this.setHttpProxyUsername("whatever");
+ }
+
+ // 使用代理服务器 需要用户认证的代理服务器
+ CredentialsProvider provider = new BasicCredentialsProvider();
+ provider.setCredentials(new AuthScope(this.getHttpProxyHost(), this.getHttpProxyPort()),
+ new UsernamePasswordCredentials(this.getHttpProxyUsername(), this.getHttpProxyPassword()));
+ httpClientBuilder.setDefaultCredentialsProvider(provider)
+ .setProxy(new HttpHost(this.getHttpProxyHost(), this.getHttpProxyPort()));
+ }
+ }
+
+ /**
+ * 获取用于普通支付接口的HttpClient
+ *
+ * @return CloseableHttpClient
+ */
+ public CloseableHttpClient getHttpClient() {
+ return httpClient;
+ }
+
+ /**
+ * 获取用于SSL支付接口的HttpClient
+ *
+ * @return CloseableHttpClient
+ */
+ public CloseableHttpClient getSslHttpClient() {
+ return sslHttpClient;
+ }
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceApacheHttpImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceApacheHttpImpl.java
index 130a47a49f..977a2856fe 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceApacheHttpImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceApacheHttpImpl.java
@@ -52,15 +52,15 @@ public class WxPayServiceApacheHttpImpl extends BaseWxPayServiceImpl {
@Override
public byte[] postForBytes(String url, String requestStr, boolean useKey) throws WxPayException {
try {
- HttpClientBuilder httpClientBuilder = createHttpClientBuilder(useKey);
HttpPost httpPost = this.createHttpPost(url, requestStr);
- try (CloseableHttpClient httpClient = httpClientBuilder.build()) {
- final byte[] bytes = httpClient.execute(httpPost, ByteArrayResponseHandler.INSTANCE);
- final String responseData = Base64.getEncoder().encodeToString(bytes);
- this.logRequestAndResponse(url, requestStr, responseData);
- wxApiData.set(new WxPayApiData(url, requestStr, responseData, null));
- return bytes;
- }
+ CloseableHttpClient httpClient = this.createHttpClient(useKey);
+
+ // 使用连接池的客户端,不需要手动关闭
+ final byte[] bytes = httpClient.execute(httpPost, ByteArrayResponseHandler.INSTANCE);
+ final String responseData = Base64.getEncoder().encodeToString(bytes);
+ this.logRequestAndResponse(url, requestStr, responseData);
+ wxApiData.set(new WxPayApiData(url, requestStr, responseData, null));
+ return bytes;
} catch (Exception e) {
this.logError(url, requestStr, e);
wxApiData.set(new WxPayApiData(url, requestStr, null, e.getMessage()));
@@ -71,17 +71,17 @@ public byte[] postForBytes(String url, String requestStr, boolean useKey) throws
@Override
public String post(String url, String requestStr, boolean useKey) throws WxPayException {
try {
- HttpClientBuilder httpClientBuilder = this.createHttpClientBuilder(useKey);
HttpPost httpPost = this.createHttpPost(url, requestStr);
- try (CloseableHttpClient httpClient = httpClientBuilder.build()) {
- try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
- String responseString = EntityUtils.toString(response.getEntity(), StandardCharsets.UTF_8);
- this.logRequestAndResponse(url, requestStr, responseString);
- if (this.getConfig().isIfSaveApiData()) {
- wxApiData.set(new WxPayApiData(url, requestStr, responseString, null));
- }
- return responseString;
+ CloseableHttpClient httpClient = this.createHttpClient(useKey);
+
+ // 使用连接池的客户端,不需要手动关闭
+ try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
+ String responseString = EntityUtils.toString(response.getEntity(), StandardCharsets.UTF_8);
+ this.logRequestAndResponse(url, requestStr, responseString);
+ if (this.getConfig().isIfSaveApiData()) {
+ wxApiData.set(new WxPayApiData(url, requestStr, responseString, null));
}
+ return responseString;
} finally {
httpPost.releaseConnection();
}
@@ -281,6 +281,26 @@ private CloseableHttpClient createApiV3HttpClient() throws WxPayException {
return apiV3HttpClient;
}
+ CloseableHttpClient createHttpClient(boolean useKey) throws WxPayException {
+ if (useKey) {
+ // 使用SSL连接池客户端
+ CloseableHttpClient sslHttpClient = this.getConfig().getSslHttpClient();
+ if (null == sslHttpClient) {
+ this.getConfig().initSslHttpClient();
+ sslHttpClient = this.getConfig().getSslHttpClient();
+ }
+ return sslHttpClient;
+ } else {
+ // 使用普通连接池客户端
+ CloseableHttpClient httpClient = this.getConfig().getHttpClient();
+ if (null == httpClient) {
+ this.getConfig().initHttpClient();
+ httpClient = this.getConfig().getHttpClient();
+ }
+ return httpClient;
+ }
+ }
+
private static StringEntity createEntry(String requestStr) {
return new StringEntity(requestStr, ContentType.create(APPLICATION_JSON, StandardCharsets.UTF_8));
//return new StringEntity(new String(requestStr.getBytes(StandardCharsets.UTF_8), StandardCharsets.ISO_8859_1));
diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/ConnectionPoolUsageExampleTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/ConnectionPoolUsageExampleTest.java
new file mode 100644
index 0000000000..143743ffcf
--- /dev/null
+++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/ConnectionPoolUsageExampleTest.java
@@ -0,0 +1,61 @@
+package com.github.binarywang.wxpay.service.impl;
+
+import com.github.binarywang.wxpay.config.WxPayConfig;
+import org.apache.http.impl.client.CloseableHttpClient;
+import org.testng.Assert;
+import org.testng.annotations.Test;
+
+/**
+ * 演示连接池功能的示例测试
+ */
+public class ConnectionPoolUsageExampleTest {
+
+ @Test
+ public void demonstrateConnectionPoolUsage() throws Exception {
+ // 1. 创建配置并设置连接池参数
+ WxPayConfig config = new WxPayConfig();
+ config.setAppId("wx123456789");
+ config.setMchId("1234567890");
+ config.setMchKey("32位商户密钥32位商户密钥32位商户密钥");
+
+ // 设置连接池参数(可选,有默认值)
+ config.setMaxConnTotal(50); // 最大连接数,默认20
+ config.setMaxConnPerRoute(20); // 每个路由最大连接数,默认10
+
+ // 2. 初始化连接池
+ CloseableHttpClient pooledClient = config.initHttpClient();
+ Assert.assertNotNull(pooledClient);
+
+ // 3. 创建支付服务实例
+ WxPayServiceApacheHttpImpl payService = new WxPayServiceApacheHttpImpl();
+ payService.setConfig(config);
+
+ // 4. 现在所有的HTTP请求都会使用连接池
+ // 对于非SSL请求,会复用同一个HttpClient实例
+ CloseableHttpClient client1 = payService.createHttpClient(false);
+ CloseableHttpClient client2 = payService.createHttpClient(false);
+ Assert.assertSame(client1, client2, "非SSL请求应该复用同一个客户端实例");
+
+ // 对于SSL请求,也会复用同一个SSL HttpClient实例(需要配置证书后)
+ System.out.println("连接池配置成功!");
+ System.out.println("最大连接数:" + config.getMaxConnTotal());
+ System.out.println("每路由最大连接数:" + config.getMaxConnPerRoute());
+ }
+
+ @Test
+ public void demonstrateDefaultConfiguration() throws Exception {
+ // 使用默认配置的示例
+ WxPayConfig config = new WxPayConfig();
+ config.setAppId("wx123456789");
+ config.setMchId("1234567890");
+ config.setMchKey("32位商户密钥32位商户密钥32位商户密钥");
+
+ // 不设置连接池参数,使用默认值
+ CloseableHttpClient client = config.initHttpClient();
+ Assert.assertNotNull(client);
+
+ // 验证默认配置
+ Assert.assertEquals(config.getMaxConnTotal(), 20, "默认最大连接数应该是20");
+ Assert.assertEquals(config.getMaxConnPerRoute(), 10, "默认每路由最大连接数应该是10");
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/WxPayServiceApacheHttpImplConnectionPoolTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/WxPayServiceApacheHttpImplConnectionPoolTest.java
new file mode 100644
index 0000000000..393d601a69
--- /dev/null
+++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/WxPayServiceApacheHttpImplConnectionPoolTest.java
@@ -0,0 +1,86 @@
+package com.github.binarywang.wxpay.service.impl;
+
+import com.github.binarywang.wxpay.config.WxPayConfig;
+import com.github.binarywang.wxpay.exception.WxPayException;
+import org.apache.http.impl.client.CloseableHttpClient;
+import org.apache.http.impl.conn.PoolingHttpClientConnectionManager;
+import org.testng.Assert;
+import org.testng.annotations.Test;
+
+/**
+ * 测试WxPayServiceApacheHttpImpl的连接池功能
+ */
+public class WxPayServiceApacheHttpImplConnectionPoolTest {
+
+ @Test
+ public void testHttpClientConnectionPool() throws Exception {
+ WxPayConfig config = new WxPayConfig();
+ config.setAppId("test-app-id");
+ config.setMchId("test-mch-id");
+ config.setMchKey("test-mch-key");
+
+ // 测试初始化连接池
+ CloseableHttpClient httpClient1 = config.initHttpClient();
+ Assert.assertNotNull(httpClient1, "HttpClient should not be null");
+
+ // 再次获取,应该返回同一个实例
+ CloseableHttpClient httpClient2 = config.getHttpClient();
+ Assert.assertSame(httpClient1, httpClient2, "Should return the same HttpClient instance");
+
+ // 验证连接池配置
+ WxPayServiceApacheHttpImpl service = new WxPayServiceApacheHttpImpl();
+ service.setConfig(config);
+
+ // 测试不使用SSL的情况下应该使用连接池
+ CloseableHttpClient clientForNonSSL = service.createHttpClient(false);
+ Assert.assertSame(httpClient1, clientForNonSSL, "Should use pooled client for non-SSL requests");
+ }
+
+ @Test
+ public void testSslHttpClientConnectionPool() throws Exception {
+ WxPayConfig config = new WxPayConfig();
+ config.setAppId("test-app-id");
+ config.setMchId("test-mch-id");
+ config.setMchKey("test-mch-key");
+
+ // 为了测试SSL客户端,我们需要设置一些基本的SSL配置
+ // 注意:在实际使用中需要提供真实的证书
+ try {
+ CloseableHttpClient sslClient1 = config.initSslHttpClient();
+ Assert.assertNotNull(sslClient1, "SSL HttpClient should not be null");
+
+ CloseableHttpClient sslClient2 = config.getSslHttpClient();
+ Assert.assertSame(sslClient1, sslClient2, "Should return the same SSL HttpClient instance");
+
+ WxPayServiceApacheHttpImpl service = new WxPayServiceApacheHttpImpl();
+ service.setConfig(config);
+
+ // 测试使用SSL的情况下应该使用SSL连接池
+ CloseableHttpClient clientForSSL = service.createHttpClient(true);
+ Assert.assertSame(sslClient1, clientForSSL, "Should use pooled SSL client for SSL requests");
+
+ } catch (WxPayException e) {
+ // SSL初始化失败是预期的,因为我们没有提供真实的证书
+ // 这里主要是测试代码路径是否正确
+ Assert.assertTrue(e.getMessage().contains("证书") || e.getMessage().contains("商户号"),
+ "Should fail with certificate or merchant ID related error");
+ }
+ }
+
+ @Test
+ public void testConnectionPoolConfiguration() throws Exception {
+ WxPayConfig config = new WxPayConfig();
+ config.setAppId("test-app-id");
+ config.setMchId("test-mch-id");
+ config.setMchKey("test-mch-key");
+ config.setMaxConnTotal(50);
+ config.setMaxConnPerRoute(20);
+
+ CloseableHttpClient httpClient = config.initHttpClient();
+ Assert.assertNotNull(httpClient, "HttpClient should not be null");
+
+ // 验证配置值是否正确设置
+ Assert.assertEquals(config.getMaxConnTotal(), 50, "Max total connections should be 50");
+ Assert.assertEquals(config.getMaxConnPerRoute(), 20, "Max connections per route should be 20");
+ }
+}
\ No newline at end of file
From e61ad44d27fe4c1c57b2c54a5bd1322955edc877 Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Fri, 8 Aug 2025 18:18:39 +0800
Subject: [PATCH 036/208] :memo: Add comprehensive GitHub Copilot instructions
for WxJava SDK development
---
.github/copilot-instructions.md | 198 ++++++++++++++++++++++++++++++++
others/mvnw | 0
2 files changed, 198 insertions(+)
create mode 100644 .github/copilot-instructions.md
mode change 100644 => 100755 others/mvnw
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
new file mode 100644
index 0000000000..cec0d76c6b
--- /dev/null
+++ b/.github/copilot-instructions.md
@@ -0,0 +1,198 @@
+# WxJava - WeChat Java SDK Development Instructions
+
+WxJava is a comprehensive WeChat Java SDK supporting multiple WeChat platforms including Official Accounts (公众号), Mini Programs (小程序), WeChat Pay (微信支付), Enterprise WeChat (企业微信), Open Platform (开放平台), and Channel/Video (视频号). This is a Maven multi-module project with Spring Boot and Solon framework integrations.
+
+**ALWAYS reference these instructions first and fallback to search or bash commands only when you encounter unexpected information that does not match the information here.**
+
+## Working Effectively
+
+### Prerequisites and Environment Setup
+- **Java Requirements**: JDK 8+ required (project uses Java 8 as minimum target)
+- **Maven**: Maven 3.6+ recommended (Maven 3.9.11 validated)
+- **IDE**: IntelliJ IDEA recommended (project optimized for IDEA)
+
+### Bootstrap, Build, and Validate
+Execute these commands in sequence after cloning:
+
+```bash
+# 1. Basic compilation (NEVER CANCEL - takes 4-5 minutes)
+mvn clean compile -DskipTests=true --no-transfer-progress
+# Timeout: Set 8+ minutes. Actual time: ~4 minutes
+
+# 2. Full package build (NEVER CANCEL - takes 2-3 minutes)
+mvn clean package -DskipTests=true --no-transfer-progress
+# Timeout: Set 5+ minutes. Actual time: ~2 minutes
+
+# 3. Code quality validation (NEVER CANCEL - takes 45-60 seconds)
+mvn checkstyle:check --no-transfer-progress
+# Timeout: Set 3+ minutes. Actual time: ~50 seconds
+```
+
+**CRITICAL TIMING NOTES:**
+- **NEVER CANCEL** any Maven build command
+- Compilation phase takes longest (~4 minutes) due to 34 modules
+- Full builds are faster on subsequent runs due to incremental compilation
+- Always use `--no-transfer-progress` to reduce log noise
+
+### Testing Structure
+- **Test Framework**: TestNG (not JUnit)
+- **Test Files**: 298 test files across all modules
+- **Default Behavior**: Tests are DISABLED by default in pom.xml (`
+ * 小程序 - 微信客服 相关接口
+ * 负责处理 https://api.weixin.qq.com/customservice/work/**
+ * 文档:https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/kf-work/getKfWorkBound.html
+ * 绑定的企业ID,需和小程序主体一致。
+ * 目前仅支持绑定非个人小程序。
+ * Created by tryking123 on 2025/8/18.
+ *
+ *
+ * @author tryking123
+ */
+public interface WxMaCustomserviceWorkService {
+
+ /**
+ * 查询小程序的微信客服绑定情况
+ */
+ String GET_CUSTOMSERVICE_URL = "https://api.weixin.qq.com/customservice/work/get";
+ /**
+ * 为小程序绑定微信客服 注:此接口绑定的企业ID需完成企业认证
+ */
+ String BIND_CUSTOMSERVICE_URL = "https://api.weixin.qq.com/customservice/work/bind";
+ /**
+ * 为小程序解除绑定微信客服
+ */
+ String UNBIND_CUSTOMSERVICE_URL = "https://api.weixin.qq.com/customservice/work/unbind";
+
+ /**
+ * 查询小程序的微信客服绑定情况
+ *
+ * @return 成功示例json { "errcode": 0,"entityName": "XXXXX有限公司","corpid": "wwee11111xxxxxxx","bindTime": 1694611289 }
+ * @throws WxErrorException
+ */
+ WxMaCustomserviceResult getCustomservice() throws WxErrorException;
+
+ /**
+ * 绑定微信客服
+ * @param corpid 企业ID,获取方式参考:https://developer.work.weixin.qq.com/document/path/90665#corpid
+ * @return 成功示例json { "errcode": 0 }
+ * @throws WxErrorException
+ */
+ WxMaCustomserviceResult bindCustomservice(String corpid) throws WxErrorException;
+
+ /**
+ * 解除绑定微信客服
+ * @param corpid 企业ID,获取方式参考:https://developer.work.weixin.qq.com/document/path/90665#corpid
+ * @return 成功示例json { "errcode": 0 }
+ * @throws WxErrorException
+ */
+ WxMaCustomserviceResult unbindCustomservice(String corpid) throws WxErrorException;
+}
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaService.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaService.java
index 87405edd8b..ef3a46bad9 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaService.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaService.java
@@ -278,6 +278,13 @@ WxMaApiResponse execute(
*/
WxMaCodeService getCodeService();
+ /**
+ * 获取小程序 - 微信客服。
+ *
+ * @return 微信客服服务对象WxMaCustomserviceWorkService
+ */
+ WxMaCustomserviceWorkService getCustomserviceWorkService();
+
/**
* 获取jsapi操作相关服务对象。
*
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java
index 4a5ca19274..ec33dede0c 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java
@@ -112,6 +112,7 @@ public abstract class BaseWxMaServiceImpl
+ * 小程序 - 微信客服 相关接口
+ * 负责处理 https://api.weixin.qq.com/customservice/work/**
+ * 文档:https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/kf-work/getKfWorkBound.html
+ * 绑定的企业ID,需和小程序主体一致。
+ * 目前仅支持绑定非个人小程序。
+ * Created by tryking123 on 2025/8/18.
+ *
+ *
+ * @author tryking123
+ */
+@RequiredArgsConstructor
+public class WxMaCustomserviceWorkServiceImpl implements WxMaCustomserviceWorkService {
+ private static final String CORPID = "corpid";
+
+ private final WxMaService service;
+
+ @Override
+ public WxMaCustomserviceResult getCustomservice() throws WxErrorException {
+ String responseContent = this.service.get(GET_CUSTOMSERVICE_URL, null);
+ return WxMaCustomserviceResult.fromJson(responseContent);
+ }
+
+ @Override
+ public WxMaCustomserviceResult bindCustomservice(String corpid) throws WxErrorException {
+ JsonObject paramJson = new JsonObject();
+ paramJson.addProperty(CORPID, corpid);
+ String response = this.service.post(BIND_CUSTOMSERVICE_URL, paramJson);
+ return WxMaCustomserviceResult.fromJson(response);
+ }
+
+ @Override
+ public WxMaCustomserviceResult unbindCustomservice(String corpid) throws WxErrorException {
+ JsonObject paramJson = new JsonObject();
+ paramJson.addProperty(CORPID, corpid);
+ String response = this.service.post(UNBIND_CUSTOMSERVICE_URL, paramJson);
+ return WxMaCustomserviceResult.fromJson(response);
+ }
+}
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/customservice/WxMaCustomserviceResult.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/customservice/WxMaCustomserviceResult.java
new file mode 100644
index 0000000000..e7a9a46de3
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/customservice/WxMaCustomserviceResult.java
@@ -0,0 +1,56 @@
+package cn.binarywang.wx.miniapp.bean.customservice;
+
+import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ * 客服绑定结果信息,包括错误码、主体名称、企业ID和绑定时间戳。
+ *
+ *
+ * @author tryking123
+ * @since 2025/8/18 17:40
+ */
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class WxMaCustomserviceResult implements Serializable {
+ private static final long serialVersionUID = 8854979405505241314L;
+
+ @SerializedName("errcode")
+ private Integer errCode;
+
+ /**
+ * 该小程序的主体名称,未绑定时不返回
+ */
+ @SerializedName("entityName")
+ private String entityName;
+
+ /**
+ * 企业ID,未绑定时不返回
+ */
+ @SerializedName("corpid")
+ private String corpid;
+
+ /** 接受绑定时间戳,ms */
+ @JsonProperty("bindTime")
+ private Long bindTime;
+
+ public static WxMaCustomserviceResult fromJson(String json) {
+ return WxMaGsonBuilder.create().fromJson(json, WxMaCustomserviceResult.class);
+ }
+}
From 1eefd11e0312dff9adec4462b650515009b17809 Mon Sep 17 00:00:00 2001
From: LiYaoheng
- * 设置客服信息(即更新客服信息)
+ * 邀请绑定客服账号
* 详情请见:客服管理
* 接口url格式:https://api.weixin.qq.com/customservice/kfaccount/inviteworker?access_token=ACCESS_TOKEN
*
*
- * @param request the request
- * @return the boolean
- * @throws WxErrorException 异常
+ * @param request 客服账号请求对象,包含客服账号、邀请者微信号等信息
+ * @return 邀请是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean kfAccountInviteWorker(WxMpKfAccountRequest request) throws WxErrorException;
@@ -120,10 +120,10 @@ public interface WxMpKefuService {
* 接口url格式:https://api.weixin.qq.com/customservice/kfaccount/uploadheadimg?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT
*
*
- * @param kfAccount the kf account
- * @param imgFile the img file
- * @return the boolean
- * @throws WxErrorException 异常
+ * @param kfAccount 客服账号,格式为:账号前缀@微信号
+ * @param imgFile 头像图片文件,支持JPG、PNG格式,大小不超过2MB
+ * @return 上传是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean kfAccountUploadHeadImg(String kfAccount, File imgFile) throws WxErrorException;
@@ -134,9 +134,9 @@ public interface WxMpKefuService {
* 接口url格式:https://api.weixin.qq.com/customservice/kfaccount/del?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT
*
*
- * @param kfAccount the kf account
- * @return the boolean
- * @throws WxErrorException 异常
+ * @param kfAccount 客服账号,格式为:账号前缀@微信号
+ * @return 删除是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean kfAccountDel(String kfAccount) throws WxErrorException;
@@ -150,10 +150,10 @@ public interface WxMpKefuService {
* 接口url格式: https://api.weixin.qq.com/customservice/kfsession/create?access_token=ACCESS_TOKEN
*
*
- * @param openid the openid
- * @param kfAccount the kf account
- * @return the boolean
- * @throws WxErrorException 异常
+ * @param openid 用户的openid,标识具体的用户
+ * @param kfAccount 客服账号,格式为:账号前缀@微信号
+ * @return 创建是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean kfSessionCreate(String openid, String kfAccount) throws WxErrorException;
@@ -165,10 +165,10 @@ public interface WxMpKefuService {
* 接口url格式: https://api.weixin.qq.com/customservice/kfsession/close?access_token=ACCESS_TOKEN
*
*
- * @param openid the openid
- * @param kfAccount the kf account
- * @return the boolean
- * @throws WxErrorException 异常
+ * @param openid 用户的openid,标识具体的用户
+ * @param kfAccount 客服账号,格式为:账号前缀@微信号
+ * @return 关闭是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean kfSessionClose(String openid, String kfAccount) throws WxErrorException;
@@ -180,9 +180,9 @@ public interface WxMpKefuService {
* 接口url格式: https://api.weixin.qq.com/customservice/kfsession/getsession?access_token=ACCESS_TOKEN&openid=OPENID
*
*
- * @param openid the openid
- * @return the wx mp kf session get result
- * @throws WxErrorException 异常
+ * @param openid 用户的openid,标识具体的用户
+ * @return 客户会话状态信息,包含客服账号、会话状态等
+ * @throws WxErrorException 微信API调用异常
*/
WxMpKfSessionGetResult kfSessionGet(String openid) throws WxErrorException;
@@ -194,9 +194,9 @@ public interface WxMpKefuService {
* 接口url格式: https://api.weixin.qq.com/customservice/kfsession/getsessionlist?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT
*
*
- * @param kfAccount the kf account
- * @return the wx mp kf session list
- * @throws WxErrorException 异常
+ * @param kfAccount 客服账号,格式为:账号前缀@微信号
+ * @return 客服会话列表,包含正在接待的会话信息
+ * @throws WxErrorException 微信API调用异常
*/
WxMpKfSessionList kfSessionList(String kfAccount) throws WxErrorException;
@@ -208,8 +208,8 @@ public interface WxMpKefuService {
* 接口url格式: https://api.weixin.qq.com/customservice/kfsession/getwaitcase?access_token=ACCESS_TOKEN
*
*
- * @return the wx mp kf session wait case list
- * @throws WxErrorException 异常
+ * @return 未接入会话列表,包含等待接入的会话信息
+ * @throws WxErrorException 微信API调用异常
*/
WxMpKfSessionWaitCaseList kfSessionGetWaitCase() throws WxErrorException;
@@ -223,12 +223,12 @@ public interface WxMpKefuService {
* 接口url格式: https://api.weixin.qq.com/customservice/msgrecord/getmsglist?access_token=ACCESS_TOKEN
*
*
- * @param startTime 起始时间
- * @param endTime 结束时间
- * @param msgId 消息id顺序从小到大,从1开始
- * @param number 每次获取条数,最多10000条
- * @return 聊天记录对象 wx mp kf msg list
- * @throws WxErrorException 异常
+ * @param startTime 起始时间,用于筛选聊天记录的时间范围
+ * @param endTime 结束时间,用于筛选聊天记录的时间范围
+ * @param msgId 消息id顺序从小到大,从1开始,用于分页获取
+ * @param number 每次获取条数,最多10000条,用于分页控制
+ * @return 聊天记录对象,包含客服和用户的聊天消息列表
+ * @throws WxErrorException 微信API调用异常
*/
WxMpKfMsgList kfMsgList(Date startTime, Date endTime, Long msgId, Integer number) throws WxErrorException;
@@ -240,17 +240,17 @@ public interface WxMpKefuService {
* 接口url格式: https://api.weixin.qq.com/customservice/msgrecord/getmsglist?access_token=ACCESS_TOKEN
*
*
- * @param startTime 起始时间
- * @param endTime 结束时间
- * @return 聊天记录对象 wx mp kf msg list
- * @throws WxErrorException 异常
+ * @param startTime 起始时间,用于筛选聊天记录的时间范围
+ * @param endTime 结束时间,用于筛选聊天记录的时间范围
+ * @return 聊天记录对象,包含客服和用户的聊天消息列表
+ * @throws WxErrorException 微信API调用异常
*/
WxMpKfMsgList kfMsgList(Date startTime, Date endTime) throws WxErrorException;
/**
*
* 客服输入状态
- * 开发者可通过调用“客服输入状态”接口,返回客服当前输入状态给用户。
+ * 开发者可通过调用"客服输入状态"接口,返回客服当前输入状态给用户。
* 此接口需要客服消息接口权限。
* 如果不满足发送客服消息的触发条件,则无法下发输入状态。
* 下发输入状态,需要客服之前30秒内跟用户有过消息交互。
@@ -261,10 +261,10 @@ public interface WxMpKefuService {
* 接口url格式:https://api.weixin.qq.com/cgi-bin/message/custom/typing?access_token=ACCESS_TOKEN
*
*
- * @param openid 用户id
- * @param command "Typing":对用户下发“正在输入"状态 "CancelTyping":取消对用户的”正在输入"状态
- * @return the boolean
- * @throws WxErrorException 异常
+ * @param openid 用户的openid,标识具体的用户
+ * @param command 输入状态命令,可选值:"Typing":对用户下发"正在输入"状态;"CancelTyping":取消对用户的"正在输入"状态
+ * @return 发送是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean sendKfTypingState(String openid, String command) throws WxErrorException;
}
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMassMessageService.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMassMessageService.java
index 823c2c6343..5ad3098c2a 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMassMessageService.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMassMessageService.java
@@ -8,138 +8,234 @@
import me.chanjar.weixin.mp.bean.result.WxMpMassUploadResult;
/**
- *
- * 群发消息服务类.
+ * 群发消息服务类
+ *
*
* @author Binary Wang
*/
public interface WxMpMassMessageService {
/**
*
- * 上传群发用的图文消息,上传后才能群发图文消息.
- *
- * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140549&token=&lang=zh_CN
+ * 上传群发用的图文消息,上传后才能群发图文消息
*
*
- * @param news the news
- * @return the wx mp mass upload result
- * @throws WxErrorException the wx error exception
- * @see #massGroupMessageSend(WxMpMassTagMessage) #massGroupMessageSend(WxMpMassTagMessage)
- * @see #massOpenIdsMessageSend(WxMpMassOpenIdsMessage) #massOpenIdsMessageSend(WxMpMassOpenIdsMessage)
+ * @param news 图文消息对象
+ * @return 上传结果对象,包含media_id等信息
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see #massGroupMessageSend(WxMpMassTagMessage)
+ * @see #massOpenIdsMessageSend(WxMpMassOpenIdsMessage)
+ * @see 上传群发用的图文消息
*/
WxMpMassUploadResult massNewsUpload(WxMpMassNews news) throws WxErrorException;
/**
*
- * 上传群发用的视频,上传后才能群发视频消息.
- * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140549&token=&lang=zh_CN
+ * 上传群发用的视频,上传后才能群发视频消息
*
*
- * @param video the video
- * @return the wx mp mass upload result
- * @throws WxErrorException the wx error exception
- * @see #massGroupMessageSend(WxMpMassTagMessage) #massGroupMessageSend(WxMpMassTagMessage)
- * @see #massOpenIdsMessageSend(WxMpMassOpenIdsMessage) #massOpenIdsMessageSend(WxMpMassOpenIdsMessage)
+ * @param video 视频消息对象
+ * @return 上传结果对象,包含media_id等信息
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see #massGroupMessageSend(WxMpMassTagMessage)
+ * @see #massOpenIdsMessageSend(WxMpMassOpenIdsMessage)
+ * @see 上传群发用的视频
*/
WxMpMassUploadResult massVideoUpload(WxMpMassVideo video) throws WxErrorException;
/**
*
- * 分组群发消息.
+ * 分组群发消息
* 如果发送图文消息,必须先使用 {@link #massNewsUpload(WxMpMassNews)} 获得media_id,然后再发送
* 如果发送视频消息,必须先使用 {@link #massVideoUpload(WxMpMassVideo)} 获得media_id,然后再发送
- * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140549&token=&lang=zh_CN
*
*
- * @param message the message
- * @return the wx mp mass send result
- * @throws WxErrorException the wx error exception
+ * @param message 分组群发消息对象
+ * @return 群发结果对象,包含msg_id等信息
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 分组群发消息
*/
WxMpMassSendResult massGroupMessageSend(WxMpMassTagMessage message) throws WxErrorException;
/**
*
- * 按openId列表群发消息.
+ * 按openId列表群发消息
* 如果发送图文消息,必须先使用 {@link #massNewsUpload(WxMpMassNews)} 获得media_id,然后再发送
* 如果发送视频消息,必须先使用 {@link #massVideoUpload(WxMpMassVideo)} 获得media_id,然后再发送
- * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140549&token=&lang=zh_CN
*
*
- * @param message the message
- * @return the wx mp mass send result
- * @throws WxErrorException the wx error exception
+ * @param message 按openid列表群发消息对象
+ * @return 群发结果对象,包含msg_id等信息
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 按openId列表群发消息
*/
WxMpMassSendResult massOpenIdsMessageSend(WxMpMassOpenIdsMessage message) throws WxErrorException;
/**
*
- * 群发消息预览接口.
+ * 群发消息预览接口
* 开发者可通过该接口发送消息给指定用户,在手机端查看消息的样式和排版。为了满足第三方平台开发者的需求,
* 在保留对openID预览能力的同时,增加了对指定微信号发送预览的能力,但该能力每日调用次数有限制(100次),请勿滥用。
- * 接口调用请求说明
- * http请求方式: POST
- * https://api.weixin.qq.com/cgi-bin/message/mass/preview?access_token=ACCESS_TOKEN
- * 详情请见:http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140549&token=&lang=zh_CN
*
*
- * @param wxMpMassPreviewMessage the wx mp mass preview message
- * @return wxMpMassSendResult wx mp mass send result
- * @throws WxErrorException the wx error exception
+ * @param wxMpMassPreviewMessage 预览消息对象
+ * @return 群发结果对象,包含msg_id等信息
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 群发消息预览接口
*/
WxMpMassSendResult massMessagePreview(WxMpMassPreviewMessage wxMpMassPreviewMessage) throws WxErrorException;
/**
*
- * 删除群发.
+ * 删除群发
* 群发之后,随时可以通过该接口删除群发。
* 请注意:
* 1、只有已经发送成功的消息才能删除
* 2、删除消息是将消息的图文详情页失效,已经收到的用户,还是能在其本地看到消息卡片。
* 3、删除群发消息只能删除图文消息和视频消息,其他类型的消息一经发送,无法删除。
* 4、如果多次群发发送的是一个图文消息,那么删除其中一次群发,就会删除掉这个图文消息也,导致所有群发都失效
- * 接口调用请求说明:
- * http请求方式: POST
- * https://api.weixin.qq.com/cgi-bin/message/mass/delete?access_token=ACCESS_TOKEN
- * 详情请见:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1481187827_i0l21
*
*
* @param msgId 发送出去的消息ID
* @param articleIndex 要删除的文章在图文消息中的位置,第一篇编号为1,该字段不填或填0会删除全部文章
- * @throws WxErrorException the wx error exception
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 删除群发
*/
void delete(Long msgId, Integer articleIndex) throws WxErrorException;
-
/**
+ *
* 获取群发速度
- * https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Batch_Sends_and_Originality_Checks.html#9
+ *
*
- * @return the wx mp mass speed get result
- * @throws WxErrorException the wx error exception
+ * @return 群发速度获取结果对象
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 获取群发速度
*/
WxMpMassSpeedGetResult messageMassSpeedGet() throws WxErrorException;
-
/**
+ *
* 设置群发速度
- * https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Batch_Sends_and_Originality_Checks.html#9
+ *
*
- * @param speed 群发速度的级别,是一个0到4的整数,数字越大表示群发速度越慢。 speed realspeed 0 80w/分钟 1 60w/分钟 2 45w/分钟 3 30w/分钟 4 10w/分钟
- * @throws WxErrorException the wx error exception
+ * @param speed 群发速度的级别,是一个0到4的整数,数字越大表示群发速度越慢。
+ * speed realspeed
+ * 0 80w/分钟
+ * 1 60w/分钟
+ * 2 45w/分钟
+ * 3 30w/分钟
+ * 4 10w/分钟
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 设置群发速度
*/
void messageMassSpeedSet(Integer speed) throws WxErrorException;
-
/**
+ *
* 查询群发消息发送状态【订阅号与服务号认证后均可用】
- * https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Batch_Sends_and_Originality_Checks.html#%E6%9F%A5%E8%AF%A2%E7%BE%A4%E5%8F%91%E6%B6%88%E6%81%AF%E5%8F%91%E9%80%81%E7%8A%B6%E6%80%81%E3%80%90%E8%AE%A2%E9%98%85%E5%8F%B7%E4%B8%8E%E6%9C%8D%E5%8A%A1%E5%8F%B7%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9D%87%E5%8F%AF%E7%94%A8%E3%80%91
+ *
*
* @param msgId 群发消息后返回的消息id
- * @return 消息发送后的状态 ,SEND_SUCCESS表示发送成功,SENDING表示发送中,SEND_FAIL表示发送失败,DELETE表示已删除
- * @throws WxErrorException the wx error exception
+ * @return 消息发送后的状态,SEND_SUCCESS表示发送成功,SENDING表示发送中,SEND_FAIL表示发送失败,DELETE表示已删除
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 查询群发消息发送状态
*/
WxMpMassGetResult messageMassGet(Long msgId) throws WxErrorException;
-
}
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMaterialService.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMaterialService.java
index ef396b7036..3c7a525b0f 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMaterialService.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMaterialService.java
@@ -17,7 +17,6 @@
/**
*
- * Created by Binary Wang on 2016/7/21.
* 素材管理的相关接口,包括媒体管理的接口,
* 即以https://api.weixin.qq.com/cgi-bin/material
* 和 https://api.weixin.qq.com/cgi-bin/media开头的接口
@@ -36,7 +35,7 @@ public interface WxMpMaterialService {
* 2、media_id是可复用的。
* 3、素材的格式大小等要求与公众平台官网一致。具体是,图片大小不超过2M,支持png/jpeg/jpg/gif格式,语音大小不超过5M,长度不超过60秒,支持mp3/amr格式
* 4、需使用https调用本接口。
- * 本接口即为原“上传多媒体文件”接口。
+ * 本接口即为原"上传多媒体文件"接口。
* 注意事项:
* 上传的临时多媒体文件有格式和大小限制,如下:
* 图片(image): 2M,支持PNG\JPEG\JPG\GIF格式
@@ -49,17 +48,17 @@ public interface WxMpMaterialService {
*
*
* @param mediaType 媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts}
- * @param file 文件对象
- * @return the wx media upload result
- * @throws WxErrorException the wx error exception
- * @see #mediaUpload(String, String, InputStream) #mediaUpload(String, String, InputStream)#mediaUpload(String, String, InputStream)
+ * @param file 文件对象,需要上传的临时素材文件
+ * @return 上传结果,包含media_id等信息
+ * @throws WxErrorException 微信API调用异常
+ * @see #mediaUpload(String, String, InputStream) 使用输入流上传临时素材
*/
WxMediaUploadResult mediaUpload(String mediaType, File file) throws WxErrorException;
/**
*
* 新增临时素材
- * 本接口即为原“上传多媒体文件”接口。
+ * 本接口即为原"上传多媒体文件"接口。
*
* 详情请见: 新增临时素材
* 接口url格式:https://api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=TYPE
@@ -67,10 +66,10 @@ public interface WxMpMaterialService {
*
* @param mediaType 媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts}
* @param fileType 文件类型,请看{@link me.chanjar.weixin.common.api.WxConsts}
- * @param inputStream 输入流
- * @return the wx media upload result
- * @throws WxErrorException the wx error exception
- * @see #mediaUpload(java.lang.String, java.io.File) #mediaUpload(java.lang.String, java.io.File)#mediaUpload(java.lang.String, java.io.File)
+ * @param inputStream 输入流,包含要上传的临时素材内容
+ * @return 上传结果,包含media_id等信息
+ * @throws WxErrorException 微信API调用异常
+ * @see #mediaUpload(String, File) 使用文件对象上传临时素材
*/
WxMediaUploadResult mediaUpload(String mediaType, String fileType, InputStream inputStream) throws WxErrorException;
@@ -78,15 +77,15 @@ public interface WxMpMaterialService {
*
*
- * @param mediaId 媒体文件Id
- * @return 保存到本地的临时文件 file
- * @throws WxErrorException the wx error exception
+ * @param mediaId 媒体文件Id,通过JSSDK上传语音素材获取
+ * @return 保存到本地的临时文件,高清语音素材
+ * @throws WxErrorException 微信API调用异常
*/
File jssdkMediaDownload(String mediaId) throws WxErrorException;
@@ -114,9 +113,9 @@ public interface WxMpMaterialService {
* 接口url格式:https://api.weixin.qq.com/cgi-bin/media/uploadimg?access_token=ACCESS_TOKEN
*
*
- * @param file 上传的文件对象
- * @return WxMediaImgUploadResult 返回图片url
- * @throws WxErrorException the wx error exception
+ * @param file 上传的文件对象,图片素材,支持jpg/png格式,大小不超过1MB
+ * @return 图片上传结果,包含图片URL,可用于图文消息中
+ * @throws WxErrorException 微信API调用异常
*/
WxMediaImgUploadResult mediaImgUpload(File file) throws WxErrorException;
@@ -141,8 +140,8 @@ public interface WxMpMaterialService {
*
* @param mediaType 媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts}
* @param material 上传的素材, 请看{@link WxMpMaterial}
- * @return the wx mp material upload result
- * @throws WxErrorException the wx error exception
+ * @return 上传结果,包含media_id等信息
+ * @throws WxErrorException 微信API调用异常
*/
WxMpMaterialUploadResult materialFileUpload(String mediaType, WxMpMaterial material) throws WxErrorException;
@@ -155,8 +154,8 @@ public interface WxMpMaterialService {
*
*
* @param mediaId 永久素材的id
- * @return the input stream
- * @throws WxErrorException the wx error exception
+ * @return 素材内容的输入流,可用于读取图片或语音文件
+ * @throws WxErrorException 微信API调用异常
*/
InputStream materialImageOrVoiceDownload(String mediaId) throws WxErrorException;
@@ -169,8 +168,8 @@ public interface WxMpMaterialService {
*
*
* @param mediaId 永久素材的id
- * @return the wx mp material video info result
- * @throws WxErrorException the wx error exception
+ * @return 视频素材信息,包含标题、描述和下载地址
+ * @throws WxErrorException 微信API调用异常
*/
WxMpMaterialVideoInfoResult materialVideoInfo(String mediaId) throws WxErrorException;
@@ -183,8 +182,8 @@ public interface WxMpMaterialService {
*
*
* @param mediaId 永久素材的id
- * @return the wx mp material news
- * @throws WxErrorException the wx error exception
+ * @return 图文素材信息,包含文章列表和标题等
+ * @throws WxErrorException 微信API调用异常
*/
WxMpMaterialNews materialNewsInfo(String mediaId) throws WxErrorException;
@@ -201,8 +200,8 @@ public interface WxMpMaterialService {
*
*
* @param mediaId 永久素材的id
- * @return the boolean
- * @throws WxErrorException the wx error exception
+ * @return 删除是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean materialDelete(String mediaId) throws WxErrorException;
@@ -219,8 +218,8 @@ public interface WxMpMaterialService {
* 接口url格式:https://api.weixin.qq.com/cgi-bin/material/get_materialcount?access_token=ACCESS_TOKEN
*
*
- * @return the wx mp material count result
- * @throws WxErrorException the wx error exception
+ * @return 素材统计结果,包含各类素材的数量
+ * @throws WxErrorException 微信API调用异常
*/
WxMpMaterialCountResult materialCount() throws WxErrorException;
@@ -232,10 +231,10 @@ public interface WxMpMaterialService {
* 接口url格式:https://api.weixin.qq.com/cgi-bin/material/batchget_material?access_token=ACCESS_TOKEN
*
*
- * @param offset 从全部素材的该偏移位置开始返回,0表示从第一个素材 返回
+ * @param offset 从全部素材的该偏移位置开始返回,0表示从第一个素材返回
* @param count 返回素材的数量,取值在1到20之间
- * @return the wx mp material news batch get result
- * @throws WxErrorException the wx error exception
+ * @return 图文素材列表,包含文章列表和标题等信息
+ * @throws WxErrorException 微信API调用异常
*/
WxMpMaterialNewsBatchGetResult materialNewsBatchGet(int offset, int count) throws WxErrorException;
@@ -248,10 +247,10 @@ public interface WxMpMaterialService {
*
*
* @param type 媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts}
- * @param offset 从全部素材的该偏移位置开始返回,0表示从第一个素材 返回
+ * @param offset 从全部素材的该偏移位置开始返回,0表示从第一个素材返回
* @param count 返回素材的数量,取值在1到20之间
- * @return the wx mp material file batch get result
- * @throws WxErrorException the wx error exception
+ * @return 其他媒体素材列表,包含图片、语音、视频等素材信息
+ * @throws WxErrorException 微信API调用异常
*/
WxMpMaterialFileBatchGetResult materialFileBatchGet(String type, int offset, int count) throws WxErrorException;
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMenuService.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMenuService.java
index 3e78893005..ad1813ee85 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMenuService.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMenuService.java
@@ -19,9 +19,9 @@ public interface WxMpMenuService {
* 详情请见:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1455782296&token=&lang=zh_CN
*
*
- * @param menu the menu
- * @return 如果是个性化菜单 ,则返回menuid,否则返回null
- * @throws WxErrorException the wx error exception
+ * @param menu 菜单对象,包含菜单结构和配置信息
+ * @return 如果是个性化菜单,则返回menuid,否则返回null
+ * @throws WxErrorException 微信API调用异常
*/
String menuCreate(WxMenu menu) throws WxErrorException;
@@ -33,9 +33,9 @@ public interface WxMpMenuService {
* 详情请见:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1455782296&token=&lang=zh_CN
*
*
- * @param json the json
- * @return 如果是个性化菜单 ,则返回menuid,否则返回null
- * @throws WxErrorException the wx error exception
+ * @param json 菜单配置的JSON字符串,包含菜单结构和配置信息
+ * @return 如果是个性化菜单,则返回menuid,否则返回null
+ * @throws WxErrorException 微信API调用异常
*/
String menuCreate(String json) throws WxErrorException;
@@ -45,7 +45,7 @@ public interface WxMpMenuService {
* 详情请见: https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141015&token=&lang=zh_CN
*
*
- * @throws WxErrorException the wx error exception
+ * @throws WxErrorException 微信API调用异常
*/
void menuDelete() throws WxErrorException;
@@ -55,8 +55,8 @@ public interface WxMpMenuService {
* 详情请见: https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1455782296&token=&lang=zh_CN
*
*
- * @param menuId 个性化菜单的menuid
- * @throws WxErrorException the wx error exception
+ * @param menuId 个性化菜单的menuid,通过创建个性化菜单时返回
+ * @throws WxErrorException 微信API调用异常
*/
void menuDelete(String menuId) throws WxErrorException;
@@ -66,8 +66,8 @@ public interface WxMpMenuService {
* 详情请见: https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141014&token=&lang=zh_CN
*
*
- * @return the wx mp menu
- * @throws WxErrorException the wx error exception
+ * @return 当前公众号的自定义菜单配置
+ * @throws WxErrorException 微信API调用异常
*/
WxMpMenu menuGet() throws WxErrorException;
@@ -77,9 +77,9 @@ public interface WxMpMenuService {
* 详情请见: http://mp.weixin.qq.com/wiki/0/c48ccd12b69ae023159b4bfaa7c39c20.html
*
*
- * @param userid 可以是粉丝的OpenID,也可以是粉丝的微信号。
- * @return the wx menu
- * @throws WxErrorException the wx error exception
+ * @param userid 可以是粉丝的OpenID,也可以是粉丝的微信号
+ * @return 匹配到的菜单配置
+ * @throws WxErrorException 微信API调用异常
*/
WxMenu menuTryMatch(String userid) throws WxErrorException;
@@ -98,8 +98,8 @@ public interface WxMpMenuService {
* https://api.weixin.qq.com/cgi-bin/get_current_selfmenu_info?access_token=ACCESS_TOKEN
*
*
- * @return the self menu info
- * @throws WxErrorException the wx error exception
+ * @return 自定义菜单配置信息,包含菜单结构和配置详情
+ * @throws WxErrorException 微信API调用异常
*/
WxMpGetSelfMenuInfoResult getSelfMenuInfo() throws WxErrorException;
}
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpQrcodeService.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpQrcodeService.java
index ed8c5e6a79..df923512c9 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpQrcodeService.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpQrcodeService.java
@@ -22,8 +22,8 @@ public interface WxMpQrcodeService {
*
* @param sceneId 场景值ID,临时二维码时为32位非0整型
* @param expireSeconds 该二维码有效时间,以秒为单位。 最大不超过2592000(即30天),此字段如果不填,则默认有效期为30秒。
- * @return the wx mp qr code ticket
- * @throws WxErrorException the wx error exception
+ * @return 二维码ticket,可用于获取二维码图片
+ * @throws WxErrorException 微信API调用异常
*/
WxMpQrCodeTicket qrCodeCreateTmpTicket(int sceneId, Integer expireSeconds) throws WxErrorException;
@@ -36,8 +36,8 @@ public interface WxMpQrcodeService {
*
* @param sceneStr 场景值ID(字符串形式的ID),字符串类型,长度限制为1到64
* @param expireSeconds 该二维码有效时间,以秒为单位。 最大不超过2592000(即30天),此字段如果不填,则默认有效期为30秒。
- * @return the wx mp qr code ticket
- * @throws WxErrorException the wx error exception
+ * @return 二维码ticket,可用于获取二维码图片
+ * @throws WxErrorException 微信API调用异常
*/
WxMpQrCodeTicket qrCodeCreateTmpTicket(String sceneStr, Integer expireSeconds) throws WxErrorException;
@@ -48,8 +48,8 @@ public interface WxMpQrcodeService {
*
*
* @param sceneId 场景值ID,最大值为100000(目前参数只支持1--100000)
- * @return the wx mp qr code ticket
- * @throws WxErrorException the wx error exception
+ * @return 二维码ticket,可用于获取二维码图片
+ * @throws WxErrorException 微信API调用异常
*/
WxMpQrCodeTicket qrCodeCreateLastTicket(int sceneId) throws WxErrorException;
@@ -60,8 +60,8 @@ public interface WxMpQrcodeService {
*
*
* @param sceneStr 参数。字符串类型长度现在为1到64
- * @return the wx mp qr code ticket
- * @throws WxErrorException the wx error exception
+ * @return 二维码ticket,可用于获取二维码图片
+ * @throws WxErrorException 微信API调用异常
*/
WxMpQrCodeTicket qrCodeCreateLastTicket(String sceneStr) throws WxErrorException;
@@ -71,9 +71,9 @@ public interface WxMpQrcodeService {
* 详情请见: 生成带参数的二维码
*
*
- * @param ticket 二维码ticket
- * @return the file
- * @throws WxErrorException the wx error exception
+ * @param ticket 二维码ticket,通过创建二维码接口获取
+ * @return 二维码图片文件,jpg格式
+ * @throws WxErrorException 微信API调用异常
*/
File qrCodePicture(WxMpQrCodeTicket ticket) throws WxErrorException;
@@ -85,8 +85,9 @@ public interface WxMpQrcodeService {
*
* @param ticket 二维码ticket
* @param needShortUrl 是否需要压缩的二维码地址
- * @return the string
- * @throws WxErrorException the wx error exception
+ * @return 二维码图片的URL地址
+ * @throws WxErrorException 微信API调用异常
+ * @deprecated 请使用 {@link #qrCodePictureUrl(String)} 方法
*/
@Deprecated
String qrCodePictureUrl(String ticket, boolean needShortUrl) throws WxErrorException;
@@ -97,9 +98,9 @@ public interface WxMpQrcodeService {
* 详情请见: 生成带参数的二维码
*
*
- * @param ticket 二维码ticket
- * @return the string
- * @throws WxErrorException the wx error exception
+ * @param ticket 二维码ticket,通过创建二维码接口获取
+ * @return 二维码图片的URL地址
+ * @throws WxErrorException 微信API调用异常
*/
String qrCodePictureUrl(String ticket) throws WxErrorException;
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpService.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpService.java
index 47a24b7931..468dced138 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpService.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpService.java
@@ -37,7 +37,7 @@ public interface WxMpService extends WxService {
* @param longData 需要转换的长信息,不超过4KB
* @param expireSeconds 短key有效期(单位秒),最大值为2592000(即30天),默认为2592000(30天)
* @return shortKey 短key,15字节,base62编码(0-9/a-z/A-Z)
- * @throws WxErrorException .
+ * @throws WxErrorException 微信API调用异常
*/
String genShorten(String longData, Integer expireSeconds) throws WxErrorException;
@@ -47,9 +47,9 @@ public interface WxMpService extends WxService {
* 详情请见: https://developers.weixin.qq.com/doc/offiaccount/Account_Management/KEY_Shortener.html
*
*
- * @param shortKey 短key
- * @return WxMpShortKeyResult 解析结果
- * @throws WxErrorException .
+ * @param shortKey 短key,15字节,base62编码(0-9/a-z/A-Z)
+ * @return WxMpShortKeyResult 解析结果,包含原始长信息
+ * @throws WxErrorException 微信API调用异常
*/
WxMpShortKeyResult fetchShorten(String shortKey) throws WxErrorException;
@@ -59,19 +59,19 @@ public interface WxMpService extends WxService {
* 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421135319&token=&lang=zh_CN
*
*
- * @param timestamp 时间戳
- * @param nonce 随机串
- * @param signature 签名
- * @return 是否验证通过 boolean
+ * @param timestamp 时间戳,字符串格式
+ * @param nonce 随机串,字符串格式
+ * @param signature 签名,字符串格式
+ * @return 是否验证通过,true表示验证通过,false表示验证失败
*/
boolean checkSignature(String timestamp, String nonce, String signature);
/**
* 获取access_token, 不强制刷新access_token.
*
- * @return token access token
- * @throws WxErrorException .
- * @see #getAccessToken(boolean) #getAccessToken(boolean)#getAccessToken(boolean)#getAccessToken(boolean)
+ * @return token access token,字符串格式
+ * @throws WxErrorException 微信API调用异常
+ * @see #getAccessToken(boolean) 获取access_token,可选择是否强制刷新
*/
String getAccessToken() throws WxErrorException;
@@ -87,21 +87,21 @@ public interface WxMpService extends WxService {
* 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140183&token=&lang=zh_CN
*
*
- * @param forceRefresh 是否强制刷新
- * @return token access token
- * @throws WxErrorException .
+ * @param forceRefresh 是否强制刷新,true表示强制刷新,false表示使用缓存
+ * @return token access token,字符串格式
+ * @throws WxErrorException 微信API调用异常
*/
String getAccessToken(boolean forceRefresh) throws WxErrorException;
/**
* 获得ticket,不强制刷新ticket.
*
- * @param type ticket 类型
- * @return ticket ticket
- * @throws WxErrorException .
- * @see #getTicket(TicketType, boolean) #getTicket(TicketType, boolean)#getTicket(TicketType, boolean)#getTicket(TicketType, boolean)
+ * @param ticketType ticket 类型,通过TicketType枚举指定
+ * @return ticket ticket,字符串格式
+ * @throws WxErrorException 微信API调用异常
+ * @see #getTicket(TicketType, boolean) 获得ticket,可选择是否强制刷新
*/
- String getTicket(TicketType type) throws WxErrorException;
+ String getTicket(TicketType ticketType) throws WxErrorException;
/**
*
* 获取临时素材
* 公众号可以使用本接口获取临时素材(即下载临时的多媒体文件)。请注意,视频文件不支持https下载,调用该接口需http协议。
- * 本接口即为原“下载多媒体文件”接口。
+ * 本接口即为原"下载多媒体文件"接口。
* 根据微信文档,视频文件下载不了,会返回null
* 详情请见: 获取临时素材
* 接口url格式:https://api.weixin.qq.com/cgi-bin/media/get?access_token=ACCESS_TOKEN&media_id=MEDIA_ID
*
*
- * @param mediaId 媒体文件Id
- * @return 保存到本地的临时文件 file
- * @throws WxErrorException the wx error exception
+ * @param mediaId 媒体文件Id,通过上传临时素材接口获取
+ * @return 保存到本地的临时文件,如果下载失败则返回null
+ * @throws WxErrorException 微信API调用异常
*/
File mediaDownload(String mediaId) throws WxErrorException;
@@ -100,9 +99,9 @@ public interface WxMpMaterialService {
* 接口url格式:https://api.weixin.qq.com/cgi-bin/media/get/jssdk?access_token=ACCESS_TOKEN&media_id=MEDIA_ID
*
@@ -109,19 +109,19 @@ public interface WxMpService extends WxService {
* 获得时会检查 Token是否过期,如果过期了,那么就刷新一下,否则就什么都不干
*
*
- * @param type ticket类型
- * @param forceRefresh 强制刷新
- * @return ticket ticket
- * @throws WxErrorException .
+ * @param ticketType ticket类型,通过TicketType枚举指定
+ * @param forceRefresh 强制刷新,true表示强制刷新,false表示使用缓存
+ * @return ticket ticket,字符串格式
+ * @throws WxErrorException 微信API调用异常
*/
- String getTicket(TicketType type, boolean forceRefresh) throws WxErrorException;
+ String getTicket(TicketType ticketType, boolean forceRefresh) throws WxErrorException;
/**
* 获得jsapi_ticket,不强制刷新jsapi_ticket.
*
- * @return jsapi ticket
- * @throws WxErrorException .
- * @see #getJsapiTicket(boolean) #getJsapiTicket(boolean)#getJsapiTicket(boolean)#getJsapiTicket(boolean)
+ * @return jsapi ticket,字符串格式
+ * @throws WxErrorException 微信API调用异常
+ * @see #getJsapiTicket(boolean) 获得jsapi_ticket,可选择是否强制刷新
*/
String getJsapiTicket() throws WxErrorException;
@@ -133,9 +133,9 @@ public interface WxMpService extends WxService {
* 详情请见:http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115&token=&lang=zh_CN
*
*
- * @param forceRefresh 强制刷新
- * @return jsapi ticket
- * @throws WxErrorException .
+ * @param forceRefresh 强制刷新,true表示强制刷新,false表示使用缓存
+ * @return jsapi ticket,字符串格式
+ * @throws WxErrorException 微信API调用异常
*/
String getJsapiTicket(boolean forceRefresh) throws WxErrorException;
@@ -146,9 +146,9 @@ public interface WxMpService extends WxService {
* 详情请见:http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115&token=&lang=zh_CN
*
*
- * @param url 地址
- * @return 生成的签名对象 wx jsapi signature
- * @throws WxErrorException .
+ * @param url 当前网页的URL,不包括#及其后面部分
+ * @return 生成的签名对象,包含签名、时间戳、随机串等信息
+ * @throws WxErrorException 微信API调用异常
*/
WxJsapiSignature createJsapiSignature(String url) throws WxErrorException;
@@ -158,9 +158,10 @@ public interface WxMpService extends WxService {
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=长链接转短链接接口
*
*
- * @param longUrl 长url
- * @return 生成的短地址 string
- * @throws WxErrorException .
+ * @param longUrl 长url,需要转换的原始URL
+ * @return 生成的短地址,字符串格式
+ * @throws WxErrorException 微信API调用异常
+ * @deprecated 请使用 {@link #genShorten(String, Integer)} 方法
*/
@Deprecated
String shortUrl(String longUrl) throws WxErrorException;
@@ -171,9 +172,9 @@ public interface WxMpService extends WxService {
* 详情请见:http://mp.weixin.qq.com/wiki/index.php?title=语义理解
*
*
- * @param semanticQuery 查询条件
- * @return 查询结果 wx mp semantic query result
- * @throws WxErrorException .
+ * @param semanticQuery 查询条件,包含查询内容、类型等信息
+ * @return 查询结果,包含语义理解的结果和建议回复
+ * @throws WxErrorException 微信API调用异常
*/
WxMpSemanticQueryResult semanticQuery(WxMpSemanticQuery semanticQuery) throws WxErrorException;
@@ -187,7 +188,7 @@ public interface WxMpService extends WxService {
* @param redirectUri 用户授权完成后的重定向链接,无需urlencode, 方法内会进行encode
* @param scope 应用授权作用域,拥有多个作用域用逗号(,)分隔,网页应用目前仅填写snsapi_login即可
* @param state 非必填,用于保持请求和回调的状态,授权请求后原样带回给第三方。该参数可用于防止csrf攻击(跨站请求伪造攻击),建议第三方带上该参数,可设置为简单的随机数加session进行校验
- * @return url string
+ * @return url 构造好的授权登录URL,字符串格式
*/
String buildQrConnectUrl(String redirectUri, String scope, String state);
@@ -197,8 +198,8 @@ public interface WxMpService extends WxService {
* http://mp.weixin.qq.com/wiki/0/2ad4b6bfd29f30f71d39616c2a0fcedc.html
*
*
- * @return 微信服务器ip地址数组 string [ ]
- * @throws WxErrorException .
+ * @return 微信服务器ip地址数组,包含所有微信服务器IP地址
+ * @throws WxErrorException 微信API调用异常
*/
String[] getCallbackIP() throws WxErrorException;
@@ -209,10 +210,10 @@ public interface WxMpService extends WxService {
* 为了帮助开发者排查回调连接失败的问题,提供这个网络检测的API。它可以对开发者URL做域名解析,然后对所有IP进行一次ping操作,得到丢包率和耗时。
*
*
- * @param action 执行的检测动作
- * @param operator 指定平台从某个运营商进行检测
- * @return 检测结果 wx net check result
- * @throws WxErrorException .
+ * @param action 执行的检测动作,可选值:all(全部检测)、dns(仅域名解析)、ping(仅网络连通性检测)
+ * @param operator 指定平台从某个运营商进行检测,可选值:CHINANET(中国电信)、UNICOM(中国联通)、CAP(中国联通)、CUCC(中国联通)
+ * @return 检测结果,包含丢包率和耗时等信息
+ * @throws WxErrorException 微信API调用异常
*/
WxNetCheckResult netCheck(String action, String operator) throws WxErrorException;
@@ -232,8 +233,8 @@ public interface WxMpService extends WxService {
* https://api.weixin.qq.com/cgi-bin/get_current_autoreply_info?access_token=ACCESS_TOKEN
*
*
- * @return 公众号的自动回复规则 current auto reply info
- * @throws WxErrorException .
+ * @return 公众号的自动回复规则,包含关注后自动回复、消息自动回复、关键词自动回复等信息
+ * @throws WxErrorException 微信API调用异常
*/
WxMpCurrentAutoReplyInfo getCurrentAutoReplyInfo() throws WxErrorException;
@@ -245,8 +246,8 @@ public interface WxMpService extends WxService {
*
*
*
- * @param appid 公众号的APPID
- * @throws WxErrorException the wx error exception
+ * @param appid 公众号的APPID,需要清零调用的公众号的appid
+ * @throws WxErrorException 微信API调用异常
*/
void clearQuota(String appid) throws WxErrorException;
@@ -257,53 +258,53 @@ public interface WxMpService extends WxService {
* 可以参考,{@link MediaUploadRequestExecutor}的实现方法
*
*
- * @param
* 模板消息接口
- * http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433751277&token=&lang=zh_CN
+ *
+ * @author Binary Wang
*/
public interface WxMpTemplateMsgService {
- /**
- *
- * 设置所属行业
- * 官方文档中暂未告知响应内容
- * 详情请见:http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433751277&token=&lang=zh_CN
- *
- *
- * @param wxMpIndustry 行业信息
- * @return 是否成功 industry
- * @throws WxErrorException .
- */
- boolean setIndustry(WxMpTemplateIndustry wxMpIndustry) throws WxErrorException;
+ /**
+ *
+ * 设置所属行业
+ * 官方文档中暂未告知响应内容
+ *
+ *
+ * @param wxMpIndustry 行业信息
+ * @return 是否成功设置行业
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 设置所属行业
+ */
+ boolean setIndustry(WxMpTemplateIndustry wxMpIndustry) throws WxErrorException;
- /***
- *
- * 获取设置的行业信息
- * 详情请见:http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433751277&token=&lang=zh_CN
- *
- *
- * @return wxMpIndustry industry
- * @throws WxErrorException .
- */
- WxMpTemplateIndustry getIndustry() throws WxErrorException;
+ /**
+ *
+ * 获取设置的行业信息
+ *
+ *
+ * @return 行业信息对象
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 获取设置的行业信息
+ */
+ WxMpTemplateIndustry getIndustry() throws WxErrorException;
- /**
- *
- * 发送模板消息
- * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433751277&token=&lang=zh_CN
- *
- *
- * @param templateMessage 模板消息
- * @return 消息Id string
- * @throws WxErrorException .
- */
- String sendTemplateMsg(WxMpTemplateMessage templateMessage) throws WxErrorException;
+ /**
+ *
+ * 发送模板消息
+ *
+ *
+ * @param templateMessage 模板消息对象
+ * @return 消息ID,可用于查询模板消息发送状态
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 发送模板消息
+ */
+ String sendTemplateMsg(WxMpTemplateMessage templateMessage) throws WxErrorException;
- /**
- *
- * 获得模板ID
- * 从行业模板库选择模板到账号后台,获得模板ID的过程可在MP中完成
- * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433751277&token=&lang=zh_CN
- * 接口地址格式:https://api.weixin.qq.com/cgi-bin/template/api_add_template?access_token=ACCESS_TOKEN
- *
- *
- * @param shortTemplateId 模板库中模板的编号,有“TM**”和“OPENTMTM**”等形式
- * @return templateId 模板Id
- * @throws WxErrorException .
- * @deprecated 请使用 addTemplate(java.lang.String, java.util.List)
- */
- @Deprecated
- String addTemplate(String shortTemplateId) throws WxErrorException;
+ /**
+ *
+ * 获得模板ID
+ * 从行业模板库选择模板到账号后台,获得模板ID的过程可在MP中完成
+ *
+ *
+ * @param shortTemplateId 模板库中模板的编号,有"TM**"和"OPENTMTM**"等形式
+ * @return 模板ID
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @deprecated 请使用 {@link #addTemplate(String, List)}
+ * @see 获得模板ID
+ */
+ @Deprecated
+ String addTemplate(String shortTemplateId) throws WxErrorException;
- /**
- *
- * 获得模板ID
- * 从类目模板库选择模板到账号后台,获得模板ID的过程可在MP中完成
- * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433751277&token=&lang=zh_CN
- * 接口地址格式:https://api.weixin.qq.com/cgi-bin/template/api_add_template?access_token=ACCESS_TOKEN
- *
- *
- * @param shortTemplateId 模板库中模板的编号,有“TM**”和“OPENTMTM**”等形式,对于类目模板,为纯数字ID
- * @param keywordNameList 选用的类目模板的关键词,按顺序传入,如果为空,或者关键词不在模板库中,会返回40246错误码
- * @return templateId 模板Id
- * @throws WxErrorException .
- */
- String addTemplate(String shortTemplateId, List
+ * 获得模板ID
+ * 从类目模板库选择模板到账号后台,获得模板ID的过程可在MP中完成
+ *
+ *
+ * @param shortTemplateId 模板库中模板的编号,有"TM**"和"OPENTMTM**"等形式,对于类目模板,为纯数字ID
+ * @param keywordNameList 选用的类目模板的关键词,按顺序传入,如果为空,或者关键词不在模板库中,会返回40246错误码
+ * @return 模板ID
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 获得模板ID
+ */
+ String addTemplate(String shortTemplateId, List
- * 获取模板列表
- * 获取已添加至账号下所有模板列表,可在MP中查看模板列表信息,为方便第三方开发者,提供通过接口调用的方式来获取账号下所有模板信息
- * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433751277&token=&lang=zh_CN
- * 接口地址格式:https://api.weixin.qq.com/cgi-bin/template/get_all_private_template?access_token=ACCESS_TOKEN
- *
- *
- * @return templateId 模板Id
- * @throws WxErrorException .
- */
- List
+ * 获取模板列表
+ * 获取已添加至账号下所有模板列表,可在MP中查看模板列表信息,为方便第三方开发者,提供通过接口调用的方式来获取账号下所有模板信息
+ *
+ *
+ * @return 模板列表,包含所有已添加的模板信息
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 获取模板列表
+ */
+ List
- * 删除模板
- * 删除模板可在MP中完成,为方便第三方开发者,提供通过接口调用的方式来删除某账号下的模板
- * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433751277&token=&lang=zh_CN
- * 接口地址格式:https://api.weixin.qq.com/cgi-bin/template/del_private_template?access_token=ACCESS_TOKEN
- *
- *
- * @param templateId 模板Id
- * @return . boolean
- * @throws WxErrorException .
- */
- boolean delPrivateTemplate(String templateId) throws WxErrorException;
+ /**
+ *
+ * 删除模板
+ * 删除模板可在MP中完成,为方便第三方开发者,提供通过接口调用的方式来删除某账号下的模板
+ *
+ *
+ * @param templateId 模板ID
+ * @return 是否成功删除
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 删除模板
+ */
+ boolean delPrivateTemplate(String templateId) throws WxErrorException;
}
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpUserService.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpUserService.java
index 882fe93c00..d696c512ee 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpUserService.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpUserService.java
@@ -22,9 +22,9 @@ public interface WxMpUserService {
* 接口地址:https://api.weixin.qq.com/cgi-bin/user/info/updateremark?access_token=ACCESS_TOKEN
*
*
- * @param openid 用户openid
- * @param remark 备注名
- * @throws WxErrorException the wx error exception
+ * @param openid 用户openid,标识具体的用户
+ * @param remark 备注名,长度限制为30字符以内
+ * @throws WxErrorException 微信API调用异常
*/
void userUpdateRemark(String openid, String remark) throws WxErrorException;
@@ -36,9 +36,9 @@ public interface WxMpUserService {
* 接口地址:https://api.weixin.qq.com/cgi-bin/user/info?access_token=ACCESS_TOKEN&openid=OPENID&lang=zh_CN
*
*
- * @param openid 用户openid
- * @return the wx mp user
- * @throws WxErrorException the wx error exception
+ * @param openid 用户openid,标识具体的用户
+ * @return 用户基本信息,包含昵称、头像、性别、关注时间等
+ * @throws WxErrorException 微信API调用异常
*/
WxMpUser userInfo(String openid) throws WxErrorException;
@@ -50,10 +50,10 @@ public interface WxMpUserService {
* 接口地址:https://api.weixin.qq.com/cgi-bin/user/info?access_token=ACCESS_TOKEN&openid=OPENID&lang=zh_CN
*
*
- * @param openid 用户openid
+ * @param openid 用户openid,标识具体的用户
* @param lang 语言,zh_CN 简体(默认),zh_TW 繁体,en 英语
- * @return the wx mp user
- * @throws WxErrorException the wx error exception
+ * @return 用户基本信息,包含昵称、头像、性别、关注时间等
+ * @throws WxErrorException 微信API调用异常
*/
WxMpUser userInfo(String openid, String lang) throws WxErrorException;
@@ -66,9 +66,9 @@ public interface WxMpUserService {
* 接口地址:https://api.weixin.qq.com/cgi-bin/user/info/batchget?access_token=ACCESS_TOKEN
*
*
- * @param openidList 用户openid列表
- * @return the list
- * @throws WxErrorException the wx error exception
+ * @param openidList 用户openid列表,最多100个
+ * @return 用户基本信息列表,包含每个用户的基本信息
+ * @throws WxErrorException 微信API调用异常
*/
List
* 创建标签
* 一个公众号,最多可以创建100个标签。
- * 详情请见:用户标签管理
- * 接口url格式: https://api.weixin.qq.com/cgi-bin/tags/create?access_token=ACCESS_TOKEN
*
*
* @param name 标签名字(30个字符以内)
- * @return the wx user tag
- * @throws WxErrorException the wx error exception
+ * @return 创建的标签对象,包含标签ID等信息
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 用户标签管理
+ * @see 创建标签接口
*/
WxUserTag tagCreate(String name) throws WxErrorException;
/**
*
* 获取公众号已创建的标签
- * 详情请见:用户标签管理
- * 接口url格式: https://api.weixin.qq.com/cgi-bin/tags/get?access_token=ACCESS_TOKEN
*
*
- * @return the list
- * @throws WxErrorException the wx error exception
+ * @return 标签列表,包含所有已创建的标签信息
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 用户标签管理
+ * @see 获取标签接口
*/
List
* 编辑标签
- * 详情请见:用户标签管理
- * 接口url格式: https://api.weixin.qq.com/cgi-bin/tags/update?access_token=ACCESS_TOKEN
+ * 可以修改标签的名称,但不能修改标签ID。
*
*
- * @param tagId the tag id
- * @param name the name
- * @return the boolean
- * @throws WxErrorException the wx error exception
+ * @param tagId 标签ID,不能为null
+ * @param name 新的标签名字(30个字符以内)
+ * @return 操作是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 用户标签管理
+ * @see 编辑标签接口
*/
Boolean tagUpdate(Long tagId, String name) throws WxErrorException;
/**
*
* 删除标签
- * 详情请见:用户标签管理
- * 接口url格式: https://api.weixin.qq.com/cgi-bin/tags/delete?access_token=ACCESS_TOKEN
+ * 删除标签后,该标签下的所有用户将被取消标签。
*
*
- * @param tagId the tag id
- * @return the boolean
- * @throws WxErrorException the wx error exception
+ * @param tagId 标签ID,不能为null
+ * @return 操作是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 用户标签管理
+ * @see 删除标签接口
*/
Boolean tagDelete(Long tagId) throws WxErrorException;
/**
*
* 获取标签下粉丝列表
- * 详情请见:用户标签管理
- * 接口url格式: https://api.weixin.qq.com/cgi-bin/user/tag/get?access_token=ACCESS_TOKEN
+ * 可用于获取某个标签下的所有用户信息,支持分页查询。
*
*
- * @param tagId the tag id
- * @param nextOpenid the next openid
- * @return the wx tag list user
- * @throws WxErrorException the wx error exception
+ * @param tagId 标签ID,不能为null
+ * @param nextOpenid 第一个拉取用户的openid,不填从头开始拉取
+ * @return 标签下粉丝列表对象,包含用户信息和分页信息
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 用户标签管理
+ * @see 获取标签下粉丝列表接口
*/
- WxTagListUser tagListUser(Long tagId, String nextOpenid)
- throws WxErrorException;
+ WxTagListUser tagListUser(Long tagId, String nextOpenid) throws WxErrorException;
/**
*
* 批量为用户打标签
- * 详情请见:用户标签管理
- * 接口url格式: https://api.weixin.qq.com/cgi-bin/tags/members/batchtagging?access_token=ACCESS_TOKEN
+ * 可以为多个用户同时打上同一个标签。
*
*
- * @param tagId the tag id
- * @param openids the openids
- * @return the boolean
- * @throws WxErrorException the wx error exception
+ * @param tagId 标签ID,不能为null
+ * @param openids 用户openid数组,不能为null或空数组
+ * @return 操作是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 用户标签管理
+ * @see 批量为用户打标签接口
*/
boolean batchTagging(Long tagId, String[] openids) throws WxErrorException;
/**
*
* 批量为用户取消标签
- * 详情请见:用户标签管理
- * 接口url格式: https://api.weixin.qq.com/cgi-bin/tags/members/batchuntagging?access_token=ACCESS_TOKEN
+ * 可以为多个用户同时取消同一个标签。
*
*
- * @param tagId the tag id
- * @param openids the openids
- * @return the boolean
- * @throws WxErrorException the wx error exception
+ * @param tagId 标签ID,不能为null
+ * @param openids 用户openid数组,不能为null或空数组
+ * @return 操作是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 用户标签管理
+ * @see 批量为用户取消标签接口
*/
boolean batchUntagging(Long tagId, String[] openids) throws WxErrorException;
-
/**
*
* 获取用户身上的标签列表
- * 详情请见:用户标签管理
- * 接口url格式: https://api.weixin.qq.com/cgi-bin/tags/getidlist?access_token=ACCESS_TOKEN
+ * 可查询某个用户被打上的所有标签ID。
*
*
- * @param openid the openid
- * @return 标签Id的列表 list
- * @throws WxErrorException the wx error exception
+ * @param openid 用户的openid,不能为null或空字符串
+ * @return 标签ID的列表,表示该用户被打上的所有标签
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
+ *
+ * @see 用户标签管理
+ * @see 获取用户身上的标签列表接口
*/
List
- * Created by BinaryWang on 2018/6/9.
- *
+ * Created by BinaryWang on 2018/6/9.
*
* @author Binary Wang
*/
@RequiredArgsConstructor
public class WxMpAiOpenServiceImpl implements WxMpAiOpenService {
- private final WxMpService wxMpService;
+ private final WxMpService wxMpService;
- @Override
- public void uploadVoice(String voiceId, AiLangType lang, File voiceFile) throws WxErrorException {
- if (lang == null) {
- lang = AiLangType.zh_CN;
+ @Override
+ public void uploadVoice(String voiceId, AiLangType lang, File voiceFile) throws WxErrorException {
+ if (lang == null) {
+ lang = AiLangType.zh_CN;
+ }
+
+ this.wxMpService.execute(VoiceUploadRequestExecutor.create(this.wxMpService.getRequestHttp()),
+ String.format(VOICE_UPLOAD_URL.getUrl(this.wxMpService.getWxMpConfigStorage()), "mp3", voiceId, lang.getCode()),
+ voiceFile);
}
- this.wxMpService.execute(VoiceUploadRequestExecutor.create(this.wxMpService.getRequestHttp()),
- String.format(VOICE_UPLOAD_URL.getUrl(this.wxMpService.getWxMpConfigStorage()), "mp3", voiceId, lang.getCode()),
- voiceFile);
- }
+ @Override
+ public String queryRecognitionResult(String voiceId, AiLangType lang) throws WxErrorException {
+ if (lang == null) {
+ lang = AiLangType.zh_CN;
+ }
- @Override
- public String recogniseVoice(String voiceId, AiLangType lang, File voiceFile) throws WxErrorException {
- this.uploadVoice(voiceId, lang, voiceFile);
- return this.queryRecognitionResult(voiceId, lang);
- }
+ final String response = this.wxMpService.get(VOICE_QUERY_RESULT_URL,
+ String.format("voice_id=%s&lang=%s", voiceId, lang.getCode()));
+ WxError error = WxError.fromJson(response, WxType.MP);
+ if (error.getErrorCode() != 0) {
+ throw new WxErrorException(error);
+ }
- @Override
- public String translate(AiLangType langFrom, AiLangType langTo, String content) throws WxErrorException {
- String response = this.wxMpService.post(String.format(TRANSLATE_URL.getUrl(this.wxMpService.getWxMpConfigStorage()),
- langFrom.getCode(), langTo.getCode()), content);
+ return GsonParser.parse(response).get("result").getAsString();
+ }
- WxError error = WxError.fromJson(response, WxType.MP);
- if (error.getErrorCode() != 0) {
- throw new WxErrorException(error);
+ @Override
+ public String recogniseVoice(String voiceId, AiLangType lang, File voiceFile) throws WxErrorException {
+ this.uploadVoice(voiceId, lang, voiceFile);
+ return this.queryRecognitionResult(voiceId, lang);
}
- return GsonParser.parse(response).get("to_content").getAsString();
- }
+ @Override
+ public String translate(AiLangType langFrom, AiLangType langTo, String content) throws WxErrorException {
+ String response = this.wxMpService.post(String.format(TRANSLATE_URL.getUrl(this.wxMpService.getWxMpConfigStorage()),
+ langFrom.getCode(), langTo.getCode()), content);
- @Override
- public String queryRecognitionResult(String voiceId, AiLangType lang) throws WxErrorException {
- if (lang == null) {
- lang = AiLangType.zh_CN;
- }
+ WxError error = WxError.fromJson(response, WxType.MP);
+ if (error.getErrorCode() != 0) {
+ throw new WxErrorException(error);
+ }
- final String response = this.wxMpService.get(VOICE_QUERY_RESULT_URL,
- String.format("voice_id=%s&lang=%s", voiceId, lang.getCode()));
- WxError error = WxError.fromJson(response, WxType.MP);
- if (error.getErrorCode() != 0) {
- throw new WxErrorException(error);
+ return GsonParser.parse(response).get("to_content").getAsString();
}
-
- return GsonParser.parse(response).get("result").getAsString();
- }
}
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpUserTagServiceImpl.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpUserTagServiceImpl.java
index 007942f096..63a3208e4b 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpUserTagServiceImpl.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpUserTagServiceImpl.java
@@ -46,10 +46,10 @@ public List
@@ -44,6 +49,11 @@ public interface WxOpenMaService extends WxMaService {
*/
String API_SET_WEBVIEW_DOMAIN = "https://api.weixin.qq.com/wxa/setwebviewdomain";
+ /**
+ * 快速配置小程序业务域名
+ */
+ String API_SET_WEBVIEW_DOMAIN_DIRECTLY = "https://api.weixin.qq.com/wxa/setwebviewdomain_directly";
+
/**
* 获取业务域名校验文件(仅供第三方代小程序调用)
*/
@@ -310,6 +320,24 @@ WxOpenMaDomainResult modifyDomain(String action, List
- * 文档地址:https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/ecommerce/fund/chapter3_5.shtml
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4012476670
*
*/
@Data
@@ -88,4 +88,19 @@ public class SpWithdrawRequest implements Serializable {
@SerializedName(value = "account_type")
private String accountType;
+ /**
+ *
+ * 字段名:回调通知地址
+ * 变量名:notify_url
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 异步接收提现状态变更通知的回调地址,通知url必须为外网可访问的url,不能携带参数。
+ * 如果参数中传了notify_url,则商户平台上配置的回调地址将不会生效,优先回调当前传的地址。
+ * 示例值:https://www.weixin.qq.com/wxpay/pay.php
+ *
+ */
+ @SerializedName(value = "notify_url")
+ private String notifyUrl;
+
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubDayEndBalanceWithdrawRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubDayEndBalanceWithdrawRequest.java
new file mode 100644
index 0000000000..11749ef117
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubDayEndBalanceWithdrawRequest.java
@@ -0,0 +1,125 @@
+package com.github.binarywang.wxpay.bean.ecommerce;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 二级商户按日终余额预约提现
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4013328143
+ *
+ *
+ * @author copilot
+ * created on 2024/12/24
+ */
+@Data
+@NoArgsConstructor
+public class SubDayEndBalanceWithdrawRequest implements Serializable {
+
+ private static final long serialVersionUID = -8745123456789012345L;
+
+ /**
+ *
+ * 字段名:二级商户号
+ * 变量名:sub_mchid
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 电商平台二级商户号,由微信支付生成并下发。
+ * 示例值:1900000109
+ *
+ */
+ @SerializedName(value = "sub_mchid")
+ private String subMchid;
+
+ /**
+ *
+ * 字段名:商户提现单号
+ * 变量名:out_request_no
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 必须是字母数字
+ * 示例值:20190611222222222200000000012122
+ *
+ */
+ @SerializedName(value = "out_request_no")
+ private String outRequestNo;
+
+ /**
+ *
+ * 字段名:提现金额
+ * 变量名:amount
+ * 是否必填:是
+ * 类型:int64
+ * 描述:
+ * 提现金额(单位:分)
+ * 示例值:100
+ *
+ */
+ @SerializedName(value = "amount")
+ private Integer amount;
+
+ /**
+ *
+ * 字段名:备注
+ * 变量名:remark
+ * 是否必填:否
+ * 类型:string(56)
+ * 描述:
+ * 商户对提现单的备注
+ * 示例值:交易提现
+ *
+ */
+ @SerializedName(value = "remark")
+ private String remark;
+
+ /**
+ *
+ * 字段名:银行附言
+ * 变量名:bank_memo
+ * 是否必填:否
+ * 类型:string(32)
+ * 描述:
+ * 展示在收款银行系统中的附言,数字、字母最长32个汉字(能否成功展示依赖银行系统支持)。
+ * 示例值:微信支付提现
+ *
+ */
+ @SerializedName(value = "bank_memo")
+ private String bankMemo;
+
+ /**
+ *
+ * 字段名:出款账户类型
+ * 变量名:account_type
+ * 是否必填:是
+ * 类型:string(16)
+ * 描述:
+ * 枚举值:
+ * BASIC:基本户
+ * OPERATION:运营账户
+ * FEES:手续费账户
+ * 示例值:BASIC
+ *
+ */
+ @SerializedName(value = "account_type")
+ private String accountType;
+
+ /**
+ *
+ * 字段名:回调通知地址
+ * 变量名:notify_url
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 异步接收提现状态变更通知的回调地址,通知url必须为外网可访问的url,不能携带参数。
+ * 如果参数中传了notify_url,则商户平台上配置的回调地址将不会生效,优先回调当前传的地址。
+ * 示例值:https://www.weixin.qq.com/wxpay/pay.php
+ *
+ */
+ @SerializedName(value = "notify_url")
+ private String notifyUrl;
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubDayEndBalanceWithdrawResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubDayEndBalanceWithdrawResult.java
new file mode 100644
index 0000000000..f64eacb7b2
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubDayEndBalanceWithdrawResult.java
@@ -0,0 +1,99 @@
+package com.github.binarywang.wxpay.bean.ecommerce;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 二级商户按日终余额预约提现结果
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4013328143
+ *
+ *
+ * @author copilot
+ * created on 2024/12/24
+ */
+@Data
+@NoArgsConstructor
+public class SubDayEndBalanceWithdrawResult implements Serializable {
+
+ private static final long serialVersionUID = -8745123456789012346L;
+
+ /**
+ *
+ * 字段名:二级商户号
+ * 变量名:sub_mchid
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 电商平台二级商户号,由微信支付生成并下发。
+ * 示例值:1900000109
+ *
+ */
+ @SerializedName(value = "sub_mchid")
+ private String subMchid;
+
+ /**
+ *
+ * 字段名:电商平台商户号
+ * 变量名:sp_mchid
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 电商平台商户号
+ * 示例值:1800000123
+ *
+ */
+ @SerializedName(value = "sp_mchid")
+ private String spMchid;
+
+ /**
+ *
+ * 字段名:商户提现单号
+ * 变量名:out_request_no
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 商户提现单号,由商户自定义生成。
+ * 示例值:20190611222222222200000000012122
+ *
+ */
+ @SerializedName(value = "out_request_no")
+ private String outRequestNo;
+
+ /**
+ *
+ * 字段名:微信支付提现单号
+ * 变量名:withdraw_id
+ * 是否必填:是
+ * 类型:string(128)
+ * 描述:
+ * 电商平台提交二级商户提现申请后,由微信支付返回的申请单号,作为查询申请状态的唯一标识。
+ * 示例值:12321937198237912739132791732912793127931279317929791239112123
+ *
+ */
+ @SerializedName(value = "withdraw_id")
+ private String withdrawId;
+
+ /**
+ *
+ * 字段名:提现单状态
+ * 变量名:status
+ * 是否必填:是
+ * 类型:string(16)
+ * 描述:
+ * 枚举值:
+ * CREATE_SUCCESS:受理成功
+ * SUCCESS:提现成功
+ * FAIL:提现失败
+ * REFUND:提现退票
+ * CLOSE:关单
+ * INIT:业务单已创建
+ * 示例值:CREATE_SUCCESS
+ *
+ */
+ @SerializedName(value = "status")
+ private String status;
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubDayEndBalanceWithdrawStatusResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubDayEndBalanceWithdrawStatusResult.java
new file mode 100644
index 0000000000..c642ab15d2
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubDayEndBalanceWithdrawStatusResult.java
@@ -0,0 +1,261 @@
+package com.github.binarywang.wxpay.bean.ecommerce;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 查询二级商户按日终余额预约提现状态
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4013328163
+ *
+ *
+ * @author copilot
+ * created on 2024/12/24
+ */
+@Data
+@NoArgsConstructor
+public class SubDayEndBalanceWithdrawStatusResult implements Serializable {
+
+ private static final long serialVersionUID = -8745123456789012347L;
+
+ /**
+ *
+ * 字段名:二级商户号
+ * 变量名:sub_mchid
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 电商平台二级商户号,由微信支付生成并下发。
+ * 示例值:1900000109
+ *
+ */
+ @SerializedName(value = "sub_mchid")
+ private String subMchid;
+
+ /**
+ *
+ * 字段名:电商平台商户号
+ * 变量名:sp_mchid
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 电商平台商户号
+ * 示例值:1800000123
+ *
+ */
+ @SerializedName(value = "sp_mchid")
+ private String spMchid;
+
+ /**
+ *
+ * 字段名:提现单状态
+ * 变量名:status
+ * 是否必填:是
+ * 类型:string(16)
+ * 描述:
+ * 枚举值:
+ * CREATE_SUCCESS:受理成功
+ * SUCCESS:提现成功
+ * FAIL:提现失败
+ * REFUND:提现退票
+ * CLOSE:关单
+ * INIT:业务单已创建
+ * 示例值:CREATE_SUCCESS
+ *
+ */
+ @SerializedName(value = "status")
+ private String status;
+
+ /**
+ *
+ * 字段名:微信支付提现单号
+ * 变量名:withdraw_id
+ * 是否必填:是
+ * 类型:string(128)
+ * 描述:
+ * 电商平台提交二级商户提现申请后,由微信支付返回的申请单号,作为查询申请状态的唯一标识。
+ * 示例值:12321937198237912739132791732912793127931279317929791239112123
+ *
+ */
+ @SerializedName(value = "withdraw_id")
+ private String withdrawId;
+
+ /**
+ *
+ * 字段名:商户提现单号
+ * 变量名:out_request_no
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 商户提现单号,由商户自定义生成。
+ * 示例值:20190611222222222200000000012122
+ *
+ */
+ @SerializedName(value = "out_request_no")
+ private String outRequestNo;
+
+ /**
+ *
+ * 字段名:提现金额
+ * 变量名:amount
+ * 是否必填:是
+ * 类型:int64
+ * 描述:
+ * 单位:分
+ * 示例值:1
+ *
+ */
+ @SerializedName(value = "amount")
+ private Integer amount;
+
+ /**
+ *
+ * 字段名:发起提现时间
+ * 变量名:create_time
+ * 是否必填:是
+ * 类型:string(29)
+ * 描述:
+ * 遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss:sss+TIMEZONE,
+ * YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss:sss表示时分秒毫秒,
+ * TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。
+ * 例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。
+ * 示例值:2015-05-20T13:29:35.120+08:00
+ *
+ */
+ @SerializedName(value = "create_time")
+ private String createTime;
+
+ /**
+ *
+ * 字段名:提现状态更新时间
+ * 变量名:update_time
+ * 是否必填:是
+ * 类型:string(29)
+ * 描述:
+ * 遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss:sss+TIMEZONE,
+ * YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss:sss表示时分秒毫秒,
+ * TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。
+ * 例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。
+ * 示例值:2015-05-20T13:29:35.120+08:00
+ *
+ */
+ @SerializedName(value = "update_time")
+ private String updateTime;
+
+ /**
+ *
+ * 字段名:失败原因
+ * 变量名:reason
+ * 是否必填:否
+ * 类型:string(255)
+ * 描述:
+ * 仅在提现失败、退票、关单时有值
+ * 示例值:卡号错误
+ *
+ */
+ @SerializedName(value = "reason")
+ private String reason;
+
+ /**
+ *
+ * 字段名:提现备注
+ * 变量名:remark
+ * 是否必填:否
+ * 类型:string(56)
+ * 描述:
+ * 商户对提现单的备注,若发起提现时未传入相应值或输入不合法,则该值为空
+ * 示例值:交易提现
+ *
+ */
+ @SerializedName(value = "remark")
+ private String remark;
+
+ /**
+ *
+ * 字段名:银行附言
+ * 变量名:bank_memo
+ * 是否必填:否
+ * 类型:string(32)
+ * 描述:
+ * 展示在收款银行系统中的附言,由数字、字母、汉字组成(能否成功展示依赖银行系统支持)。若发起提现时未传入相应值或输入不合法,则该值为空
+ * 示例值:微信提现
+ *
+ */
+ @SerializedName(value = "bank_memo")
+ private String bankMemo;
+
+ /**
+ *
+ * 字段名:出款账户类型
+ * 变量名:account_type
+ * 是否必填:是
+ * 类型:string(16)
+ * 描述:
+ * BASIC:基本户
+ * OPERATION:运营账户
+ * FEES:手续费账户
+ * 示例值:BASIC
+ *
+ */
+ @SerializedName(value = "account_type")
+ private String accountType;
+
+ /**
+ *
+ * 字段名:提现失败解决方案
+ * 变量名:solution
+ * 是否必填:否
+ * 类型:string(255)
+ * 描述:
+ * 仅在提现失败、退票、关单时有值
+ * 示例值:请修改结算银行卡信息
+ *
+ */
+ @SerializedName(value = "solution")
+ private String solution;
+
+ /**
+ *
+ * 字段名:出款户名
+ * 变量名:account_name
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 出款户名(加密)
+ * 示例值:2mPt3pWzZ+O3dSGbGnCrR3bqMZ5pwfpQy1NNrA==
+ *
+ */
+ @SerializedName(value = "account_name")
+ private String accountName;
+
+ /**
+ *
+ * 字段名:出款账号
+ * 变量名:account_number
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 出款账号(加密)
+ * 示例值:2mPt3pWzZ+O3dSGbGnCrR3bqMZ5pwfpQy1NNrA==
+ *
+ */
+ @SerializedName(value = "account_number")
+ private String accountNumber;
+
+ /**
+ *
+ * 字段名:出款银行全称(含支行)
+ * 变量名:bank_name
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 出款银行全称(含支行)(加密)
+ * 示例值:2mPt3pWzZ+O3dSGbGnCrR3bqMZ5pwfpQy1NNrA==
+ *
+ */
+ @SerializedName(value = "bank_name")
+ private String bankName;
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubWithdrawRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubWithdrawRequest.java
index 3c74db24c9..541d779a30 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubWithdrawRequest.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubWithdrawRequest.java
@@ -9,7 +9,7 @@
/**
* 二级商户账户余额提现
*
- * 文档地址:https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/pay/combine/chapter3_3.shtml
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4012476652
*
*/
@Data
@@ -86,4 +86,19 @@ public class SubWithdrawRequest implements Serializable {
@SerializedName(value = "bank_memo")
private String bankMemo;
+ /**
+ *
+ * 字段名:回调通知地址
+ * 变量名:notify_url
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 异步接收提现状态变更通知的回调地址,通知url必须为外网可访问的url,不能携带参数。
+ * 如果参数中传了notify_url,则商户平台上配置的回调地址将不会生效,优先回调当前传的地址。
+ * 示例值:https://www.weixin.qq.com/wxpay/pay.php
+ *
+ */
+ @SerializedName(value = "notify_url")
+ private String notifyUrl;
+
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/WithdrawNotifyResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/WithdrawNotifyResult.java
new file mode 100644
index 0000000000..c5223dd123
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/WithdrawNotifyResult.java
@@ -0,0 +1,266 @@
+package com.github.binarywang.wxpay.bean.ecommerce;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 提现状态变更通知结果
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4013049135
+ *
+ *
+ * @author copilot
+ * created on 2024/12/24
+ */
+@Data
+@NoArgsConstructor
+public class WithdrawNotifyResult implements Serializable {
+
+ private static final long serialVersionUID = -7451351849088368701L;
+
+ /**
+ * 源数据
+ */
+ private NotifyResponse rawData;
+
+ /**
+ *
+ * 字段名:电商平台商户号
+ * 变量名:sp_mchid
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 微信支付分配给电商平台的商户号
+ * 示例值:1900000100
+ *
+ */
+ @SerializedName(value = "sp_mchid")
+ private String spMchid;
+
+ /**
+ *
+ * 字段名:二级商户号
+ * 变量名:sub_mchid
+ * 是否必填:否
+ * 类型:string(32)
+ * 描述:
+ * 微信支付分配给二级商户的商户号,仅二级商户提现时返回
+ * 示例值:1900000109
+ *
+ */
+ @SerializedName(value = "sub_mchid")
+ private String subMchid;
+
+ /**
+ *
+ * 字段名:商户提现单号
+ * 变量名:out_request_no
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 商户提现单号,由商户自定义生成
+ * 示例值:20190611222222222200000000012122
+ *
+ */
+ @SerializedName(value = "out_request_no")
+ private String outRequestNo;
+
+ /**
+ *
+ * 字段名:微信支付提现单号
+ * 变量名:withdraw_id
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 微信支付提现单号
+ * 示例值:12321002198704230011101200
+ *
+ */
+ @SerializedName(value = "withdraw_id")
+ private String withdrawId;
+
+ /**
+ *
+ * 字段名:提现状态
+ * 变量名:status
+ * 是否必填:是
+ * 类型:string(16)
+ * 描述:
+ * 提现状态:
+ * CREATE_SUCCESS:受理成功
+ * SUCCESS:提现成功
+ * FAILED:提现失败
+ * REFUND:提现退票
+ * CLOSE:关单
+ * 示例值:SUCCESS
+ *
+ */
+ @SerializedName(value = "status")
+ private String status;
+
+ /**
+ *
+ * 字段名:提现金额
+ * 变量名:amount
+ * 是否必填:是
+ * 类型:int64
+ * 描述:
+ * 提现金额,单位:分(人民币)
+ * 示例值:100
+ *
+ */
+ @SerializedName(value = "amount")
+ private Integer amount;
+
+ /**
+ *
+ * 字段名:提现发起时间
+ * 变量名:create_time
+ * 是否必填:是
+ * 类型:string(29)
+ * 描述:
+ * 提现发起时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss:sss+TIMEZONE,
+ * YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss:sss表示时分秒毫秒,
+ * TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。
+ * 例如:2015-05-20T13:29:35.120+08:00表示,北京时间2015年5月20日13点29分35秒
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName(value = "create_time")
+ private String createTime;
+
+ /**
+ *
+ * 字段名:提现更新时间
+ * 变量名:update_time
+ * 是否必填:是
+ * 类型:string(29)
+ * 描述:
+ * 提现更新时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss:sss+TIMEZONE,
+ * YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss:sss表示时分秒毫秒,
+ * TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。
+ * 例如:2015-05-20T13:29:35.120+08:00表示,北京时间2015年5月20日13点29分35秒
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName(value = "update_time")
+ private String updateTime;
+
+ /**
+ *
+ * 字段名:失败原因
+ * 变量名:reason
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 提现失败原因,仅在提现失败、退票时有值
+ * 示例值:账户余额不足
+ *
+ */
+ @SerializedName(value = "reason")
+ private String reason;
+
+ /**
+ *
+ * 字段名:备注
+ * 变量名:remark
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 商户对提现单的备注,若提现申请时未传递,则无此字段
+ * 示例值:交易提现
+ *
+ */
+ @SerializedName(value = "remark")
+ private String remark;
+
+ /**
+ *
+ * 字段名:银行附言
+ * 变量名:bank_memo
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 展示在收款银行系统中的附言,若提现申请时未传递,则无此字段
+ * 示例值:微信支付提现
+ *
+ */
+ @SerializedName(value = "bank_memo")
+ private String bankMemo;
+
+ /**
+ *
+ * 字段名:账户类型
+ * 变量名:account_type
+ * 是否必填:否
+ * 类型:string(16)
+ * 描述:
+ * 提现账户类型,仅电商平台提现时返回:
+ * BASIC:基本账户
+ * OPERATION:运营账户
+ * FEES:手续费账户
+ * 示例值:BASIC
+ *
+ */
+ @SerializedName(value = "account_type")
+ private String accountType;
+
+ /**
+ *
+ * 字段名:提现失败解决方案
+ * 变量名:solution
+ * 是否必填:否
+ * 类型:string(255)
+ * 描述:
+ * 仅在提现失败、退票、关单时有值
+ * 示例值:请修改结算银行卡信息
+ *
+ */
+ @SerializedName(value = "solution")
+ private String solution;
+
+ /**
+ *
+ * 字段名:出款户名
+ * 变量名:account_name
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 出款户名(加密)
+ * 示例值:2mPt3pWzZ+O3dSGbGnCrR3bqMZ5pwfpQy1NNrA==
+ *
+ */
+ @SerializedName(value = "account_name")
+ private String accountName;
+
+ /**
+ *
+ * 字段名:出款账号
+ * 变量名:account_number
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 出款账号(加密)
+ * 示例值:2mPt3pWzZ+O3dSGbGnCrR3bqMZ5pwfpQy1NNrA==
+ *
+ */
+ @SerializedName(value = "account_number")
+ private String accountNumber;
+
+ /**
+ *
+ * 字段名:出款银行全称(含支行)
+ * 变量名:bank_name
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 出款银行全称(含支行)(加密)
+ * 示例值:2mPt3pWzZ+O3dSGbGnCrR3bqMZ5pwfpQy1NNrA==
+ *
+ */
+ @SerializedName(value = "bank_name")
+ private String bankName;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/EcommerceService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/EcommerceService.java
index 2dbb2906c3..b630ce1785 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/EcommerceService.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/EcommerceService.java
@@ -417,10 +417,23 @@ public interface EcommerceService {
*/
RefundNotifyResult parseRefundNotifyResult(String notifyData, SignatureHeader header) throws WxPayException;
+ /**
+ *
+ * 提现状态变更通知回调数据处理
+ * 文档地址: https://pay.weixin.qq.com/doc/v3/partner/4013049135
+ *
+ *
+ * @param notifyData 通知数据
+ * @param header 通知头部数据,不传则表示不校验头
+ * @return 解密后通知数据 withdraw notify result
+ * @throws WxPayException the wx pay exception
+ */
+ WithdrawNotifyResult parseWithdrawNotifyResult(String notifyData, SignatureHeader header) throws WxPayException;
+
/**
*
* 二级商户账户余额提现API
- * 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/ecommerce/fund/chapter3_2.shtml
+ * 文档地址: https://pay.weixin.qq.com/doc/v3/partner/4012476652
*
*
* @param request 提现请求
@@ -432,7 +445,7 @@ public interface EcommerceService {
/**
*
* 电商平台提现API
- * 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/ecommerce/fund/chapter3_5.shtml
+ * 文档地址: https://pay.weixin.qq.com/doc/v3/partner/4012476670
*
*
* @param request 提现请求
@@ -466,6 +479,43 @@ public interface EcommerceService {
*/
SpWithdrawStatusResult querySpWithdrawByOutRequestNo(String outRequestNo) throws WxPayException;
+ /**
+ *
+ * 平台查询预约提现状态(根据微信支付预约提现单号查询)
+ * 文档地址: https://pay.weixin.qq.com/doc/v3/partner/4012476674
+ *
+ *
+ * @param withdrawId 微信支付提现单号
+ * @return 返回数据 return sp withdraw status result
+ * @throws WxPayException the wx pay exception
+ */
+ SpWithdrawStatusResult querySpWithdrawByWithdrawId(String withdrawId) throws WxPayException;
+
+ /**
+ *
+ * 二级商户按日终余额预约提现
+ * 文档地址: https://pay.weixin.qq.com/doc/v3/partner/4013328143
+ *
+ *
+ * @param request 提现请求
+ * @return 返回数据 return day-end balance withdraw result
+ * @throws WxPayException the wx pay exception
+ */
+ SubDayEndBalanceWithdrawResult subDayEndBalanceWithdraw(SubDayEndBalanceWithdrawRequest request) throws WxPayException;
+
+ /**
+ *
+ * 查询二级商户按日终余额预约提现状态
+ * 文档地址: https://pay.weixin.qq.com/doc/v3/partner/4013328163
+ *
+ *
+ * @param subMchid 二级商户号
+ * @param outRequestNo 商户提现单号
+ * @return 返回数据 return day-end balance withdraw status result
+ * @throws WxPayException the wx pay exception
+ */
+ SubDayEndBalanceWithdrawStatusResult querySubDayEndBalanceWithdraw(String subMchid, String outRequestNo) throws WxPayException;
+
/**
*
* 修改结算账号API
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/EcommerceServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/EcommerceServiceImpl.java
index 479520d7f7..171535c992 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/EcommerceServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/EcommerceServiceImpl.java
@@ -337,6 +337,27 @@ public RefundNotifyResult parseRefundNotifyResult(String notifyData, SignatureHe
}
}
+ @Override
+ public WithdrawNotifyResult parseWithdrawNotifyResult(String notifyData, SignatureHeader header) throws WxPayException {
+ if (Objects.nonNull(header) && !this.verifyNotifySign(header, notifyData)) {
+ throw new WxPayException("非法请求,头部信息验证失败");
+ }
+ NotifyResponse response = GSON.fromJson(notifyData, NotifyResponse.class);
+ NotifyResponse.Resource resource = response.getResource();
+ String cipherText = resource.getCiphertext();
+ String associatedData = resource.getAssociatedData();
+ String nonce = resource.getNonce();
+ String apiV3Key = this.payService.getConfig().getApiV3Key();
+ try {
+ String result = AesUtils.decryptToString(associatedData, nonce, cipherText, apiV3Key);
+ WithdrawNotifyResult notifyResult = GSON.fromJson(result, WithdrawNotifyResult.class);
+ notifyResult.setRawData(response);
+ return notifyResult;
+ } catch (GeneralSecurityException | IOException e) {
+ throw new WxPayException("解析报文异常!", e);
+ }
+ }
+
@Override
public SubWithdrawResult subWithdraw(SubWithdrawRequest request) throws WxPayException {
String url = String.format("%s/v3/ecommerce/fund/withdraw", this.payService.getPayBaseUrl());
@@ -365,6 +386,27 @@ public SpWithdrawStatusResult querySpWithdrawByOutRequestNo(String outRequestNo)
return GSON.fromJson(response, SpWithdrawStatusResult.class);
}
+ @Override
+ public SpWithdrawStatusResult querySpWithdrawByWithdrawId(String withdrawId) throws WxPayException {
+ String url = String.format("%s/v3/merchant/fund/withdraw/withdraw-id/%s", this.payService.getPayBaseUrl(), withdrawId);
+ String response = this.payService.getV3(url);
+ return GSON.fromJson(response, SpWithdrawStatusResult.class);
+ }
+
+ @Override
+ public SubDayEndBalanceWithdrawResult subDayEndBalanceWithdraw(SubDayEndBalanceWithdrawRequest request) throws WxPayException {
+ String url = String.format("%s/v3/ecommerce/fund/balance-withdraw", this.payService.getPayBaseUrl());
+ String response = this.payService.postV3(url, GSON.toJson(request));
+ return GSON.fromJson(response, SubDayEndBalanceWithdrawResult.class);
+ }
+
+ @Override
+ public SubDayEndBalanceWithdrawStatusResult querySubDayEndBalanceWithdraw(String subMchid, String outRequestNo) throws WxPayException {
+ String url = String.format("%s/v3/ecommerce/fund/balance-withdraw/out-request-no/%s?sub_mchid=%s", this.payService.getPayBaseUrl(), outRequestNo, subMchid);
+ String response = this.payService.getV3(url);
+ return GSON.fromJson(response, SubDayEndBalanceWithdrawStatusResult.class);
+ }
+
@Override
public void modifySettlement(String subMchid, SettlementRequest request) throws WxPayException {
String url = String.format("%s/v3/apply4sub/sub_merchants/%s/modify-settlement", this.payService.getPayBaseUrl(), subMchid);
From b94106fd57a779f2a6a0b9f81f68a68d3410aca4 Mon Sep 17 00:00:00 2001
From: kongkong
+ * 发起运营工具商家转账
+ *
+ * 请求方式:POST(HTTPS)
+ * 请求地址:https://api.mch.weixin.qq.com/v3/fund-app/operation/mch-transfer/transfer-bills
+ *
+ * 文档地址:运营工具-商家转账API
+ *
+ *
+ * @param request 运营工具转账请求参数
+ * @return BusinessOperationTransferResult 转账结果
+ * @throws WxPayException 微信支付异常
+ */
+ BusinessOperationTransferResult createOperationTransfer(BusinessOperationTransferRequest request) throws WxPayException;
+
+ /**
+ *
+ * 查询运营工具转账结果
+ *
+ * 请求方式:GET(HTTPS)
+ * 请求地址:https://api.mch.weixin.qq.com/v3/fund-app/operation/mch-transfer/transfer-bills/out-bill-no/{out_bill_no}
+ *
+ * 文档地址:运营工具-商家转账API
+ *
+ *
+ * @param request 查询请求参数
+ * @return BusinessOperationTransferQueryResult 查询结果
+ * @throws WxPayException 微信支付异常
+ */
+ BusinessOperationTransferQueryResult queryOperationTransfer(BusinessOperationTransferQueryRequest request) throws WxPayException;
+
+ /**
+ *
+ * 通过商户单号查询运营工具转账结果
+ *
+ * 请求方式:GET(HTTPS)
+ * 请求地址:https://api.mch.weixin.qq.com/v3/fund-app/operation/mch-transfer/transfer-bills/out-bill-no/{out_bill_no}
+ *
+ * 文档地址:运营工具-商家转账API
+ *
+ *
+ * @param outBillNo 商户单号
+ * @return BusinessOperationTransferQueryResult 查询结果
+ * @throws WxPayException 微信支付异常
+ */
+ BusinessOperationTransferQueryResult queryOperationTransferByOutBillNo(String outBillNo) throws WxPayException;
+
+ /**
+ *
+ * 通过微信转账单号查询运营工具转账结果
+ *
+ * 请求方式:GET(HTTPS)
+ * 请求地址:https://api.mch.weixin.qq.com/v3/fund-app/operation/mch-transfer/transfer-bills/transfer-bill-no/{transfer_bill_no}
+ *
+ * 文档地址:运营工具-商家转账API
+ *
+ *
+ * @param transferBillNo 微信转账单号
+ * @return BusinessOperationTransferQueryResult 查询结果
+ * @throws WxPayException 微信支付异常
+ */
+ BusinessOperationTransferQueryResult queryOperationTransferByTransferBillNo(String transferBillNo) throws WxPayException;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java
index 4ee5226d3d..775915b858 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java
@@ -1646,6 +1646,13 @@ WxPayRefundQueryResult refundQuery(String transactionId, String outTradeNo, Stri
*/
TransferService getTransferService();
+ /**
+ * 获取运营工具-商家转账服务类
+ *
+ * @return the business operation transfer service
+ */
+ BusinessOperationTransferService getBusinessOperationTransferService();
+
/**
* 获取服务商支付分服务类
*
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
index 3884881b8d..e5c9abf53b 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
@@ -130,6 +130,9 @@ public abstract class BaseWxPayServiceImpl implements WxPayService {
@Getter
private final BrandMerchantTransferService brandMerchantTransferService = new BrandMerchantTransferServiceImpl(this);
+ @Getter
+ private final BusinessOperationTransferService businessOperationTransferService = new BusinessOperationTransferServiceImpl(this);
+
protected Map
+ * 押金消费请求
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=4
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@Builder(builderMethodName = "newBuilder")
+@NoArgsConstructor
+@AllArgsConstructor
+@XStreamAlias("xml")
+public class WxDepositConsumeRequest extends BaseWxPayRequest {
+
+ /**
+ *
+ * 微信押金订单号
+ * transaction_id
+ * 是
+ * String(32)
+ * 1009660380201506130728806387
+ * 微信押金订单号
+ *
+ */
+ @Required
+ @XStreamAlias("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 商户消费单号
+ * out_trade_no
+ * 是
+ * String(32)
+ * 20150806125346
+ * 商户系统内部的消费单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一
+ *
+ */
+ @Required
+ @XStreamAlias("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 消费金额
+ * consume_fee
+ * 是
+ * Int
+ * 88
+ * 消费金额,单位为分,不能大于押金金额
+ *
+ */
+ @Required
+ @XStreamAlias("consume_fee")
+ private Integer consumeFee;
+
+ /**
+ *
+ * 消费描述
+ * consume_desc
+ * 否
+ * String(128)
+ * 单车使用费
+ * 对一笔消费的具体描述信息
+ *
+ */
+ @XStreamAlias("consume_desc")
+ private String consumeDesc;
+
+ @Override
+ protected void checkConstraints() throws WxPayException {
+ // No additional constraints beyond @Required fields
+ }
+
+ @Override
+ protected void storeMap(Map
+ * 查询押金订单请求
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=3
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@Builder(builderMethodName = "newBuilder")
+@NoArgsConstructor
+@AllArgsConstructor
+@XStreamAlias("xml")
+public class WxDepositOrderQueryRequest extends BaseWxPayRequest {
+
+ /**
+ *
+ * 微信订单号
+ * transaction_id
+ * 否
+ * String(32)
+ * 1009660380201506130728806387
+ * 微信的订单号,优先使用
+ *
+ */
+ @XStreamAlias("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 商户订单号
+ * out_trade_no
+ * 否
+ * String(32)
+ * 20150806125346
+ * 商户系统内部的订单号,当没提供transaction_id时需要传这个
+ *
+ */
+ @XStreamAlias("out_trade_no")
+ private String outTradeNo;
+
+ @Override
+ protected void checkConstraints() throws WxPayException {
+ if (transactionId == null && outTradeNo == null) {
+ throw new WxPayException("transaction_id 和 out_trade_no 不能同时为空");
+ }
+ }
+
+ @Override
+ protected void storeMap(Map
+ * 押金退款请求
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=6
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@Builder(builderMethodName = "newBuilder")
+@NoArgsConstructor
+@AllArgsConstructor
+@XStreamAlias("xml")
+public class WxDepositRefundRequest extends BaseWxPayRequest {
+
+ /**
+ *
+ * 微信押金订单号
+ * transaction_id
+ * 否
+ * String(32)
+ * 1009660380201506130728806387
+ * 微信押金订单号,与out_trade_no二选一
+ *
+ */
+ @XStreamAlias("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 商户押金订单号
+ * out_trade_no
+ * 否
+ * String(32)
+ * 20150806125346
+ * 商户系统内部的押金订单号,与transaction_id二选一
+ *
+ */
+ @XStreamAlias("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 商户退款单号
+ * out_refund_no
+ * 是
+ * String(32)
+ * 1217752501201407033233368018
+ * 商户系统内部的退款单号,商户系统内部唯一,同一退款单号多次请求只退一笔
+ *
+ */
+ @Required
+ @XStreamAlias("out_refund_no")
+ private String outRefundNo;
+
+ /**
+ *
+ * 退款金额
+ * refund_fee
+ * 是
+ * Int
+ * 100
+ * 退款总金额,订单总金额,单位为分,只能为整数
+ *
+ */
+ @Required
+ @XStreamAlias("refund_fee")
+ private Integer refundFee;
+
+ /**
+ *
+ * 退款原因
+ * refund_desc
+ * 否
+ * String(80)
+ * 商品已售完
+ * 若商户传入,会在下发给用户的退款消息中体现退款原因
+ *
+ */
+ @XStreamAlias("refund_desc")
+ private String refundDesc;
+
+ @Override
+ protected void checkConstraints() throws WxPayException {
+ if (transactionId == null && outTradeNo == null) {
+ throw new WxPayException("transaction_id 和 out_trade_no 不能同时为空");
+ }
+ }
+
+ @Override
+ protected void storeMap(Map
+ * 押金撤销请求
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=5
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@Builder(builderMethodName = "newBuilder")
+@NoArgsConstructor
+@AllArgsConstructor
+@XStreamAlias("xml")
+public class WxDepositUnfreezeRequest extends BaseWxPayRequest {
+
+ /**
+ *
+ * 微信押金订单号
+ * transaction_id
+ * 是
+ * String(32)
+ * 1009660380201506130728806387
+ * 微信押金订单号
+ *
+ */
+ @Required
+ @XStreamAlias("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 商户撤销单号
+ * out_trade_no
+ * 是
+ * String(32)
+ * 20150806125346
+ * 商户系统内部的撤销单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一
+ *
+ */
+ @Required
+ @XStreamAlias("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 撤销金额
+ * unfreeze_fee
+ * 是
+ * Int
+ * 99
+ * 撤销金额,单位为分,不能大于剩余押金金额
+ *
+ */
+ @Required
+ @XStreamAlias("unfreeze_fee")
+ private Integer unfreezeFee;
+
+ /**
+ *
+ * 撤销原因
+ * unfreeze_desc
+ * 否
+ * String(128)
+ * 用户主动取消
+ * 对一笔撤销的具体原因描述
+ *
+ */
+ @XStreamAlias("unfreeze_desc")
+ private String unfreezeDesc;
+
+ @Override
+ protected void checkConstraints() throws WxPayException {
+ // No additional constraints beyond @Required fields
+ }
+
+ @Override
+ protected void storeMap(Map
+ * 押金下单请求
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=2
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@Builder(builderMethodName = "newBuilder")
+@NoArgsConstructor
+@AllArgsConstructor
+@XStreamAlias("xml")
+public class WxDepositUnifiedOrderRequest extends BaseWxPayRequest {
+
+ /**
+ *
+ * 押金商品描述
+ * body
+ * 是
+ * String(128)
+ * 共享单车押金
+ * 押金商品描述
+ *
+ */
+ @Required
+ @XStreamAlias("body")
+ private String body;
+
+ /**
+ *
+ * 商户订单号
+ * out_trade_no
+ * 是
+ * String(32)
+ * 20150806125346
+ * 商户系统内部的订单号,32个字符内、可包含字母, 其他说明见商户订单号
+ *
+ */
+ @Required
+ @XStreamAlias("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 押金金额
+ * total_fee
+ * 是
+ * Int
+ * 99
+ * 押金金额,单位为分,只能为整数,详见支付金额
+ *
+ */
+ @Required
+ @XStreamAlias("total_fee")
+ private Integer totalFee;
+
+ /**
+ *
+ * 终端IP
+ * spbill_create_ip
+ * 是
+ * String(16)
+ * 123.12.12.123
+ * 用户端实际ip
+ *
+ */
+ @Required
+ @XStreamAlias("spbill_create_ip")
+ private String spbillCreateIp;
+
+ /**
+ *
+ * 通知地址
+ * notify_url
+ * 是
+ * String(256)
+ * http://www.weixin.qq.com/wxpay/pay.php
+ * 接收微信支付异步通知回调地址
+ *
+ */
+ @Required
+ @XStreamAlias("notify_url")
+ private String notifyUrl;
+
+ /**
+ *
+ * 交易类型
+ * trade_type
+ * 是
+ * String(16)
+ * JSAPI
+ * 交易类型,取值如下:JSAPI,NATIVE,APP,WAP
+ *
+ */
+ @Required
+ @XStreamAlias("trade_type")
+ private String tradeType;
+
+ /**
+ *
+ * 用户标识
+ * openid
+ * 否
+ * String(128)
+ * oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
+ * trade_type=JSAPI时,此参数必传,用户在商户appid下的唯一标识。
+ *
+ */
+ @XStreamAlias("openid")
+ private String openid;
+
+ /**
+ *
+ * 商品详情
+ * detail
+ * 否
+ * String(8192)
+ * 详情
+ * 商品名称明细列表
+ *
+ */
+ @XStreamAlias("detail")
+ private String detail;
+
+ /**
+ *
+ * 附加数据
+ * attach
+ * 否
+ * String(127)
+ * 深圳分店
+ * 附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据
+ *
+ */
+ @XStreamAlias("attach")
+ private String attach;
+
+ /**
+ *
+ * 货币类型
+ * fee_type
+ * 否
+ * String(16)
+ * CNY
+ * 符合ISO 4217标准的三位字母代码,默认人民币:CNY
+ *
+ */
+ @XStreamAlias("fee_type")
+ private String feeType;
+
+ /**
+ *
+ * 交易起始时间
+ * time_start
+ * 否
+ * String(14)
+ * 20091225091010
+ * 订单生成时间,格式为yyyyMMddHHmmss
+ *
+ */
+ @XStreamAlias("time_start")
+ private String timeStart;
+
+ /**
+ *
+ * 交易结束时间
+ * time_expire
+ * 否
+ * String(14)
+ * 20091227091010
+ * 订单失效时间,格式为yyyyMMddHHmmss
+ *
+ */
+ @XStreamAlias("time_expire")
+ private String timeExpire;
+
+ @Override
+ protected void checkConstraints() throws WxPayException {
+ if ("JSAPI".equals(this.tradeType) && this.openid == null) {
+ throw new WxPayException("当trade_type为JSAPI时,openid为必填参数");
+ }
+ }
+
+ @Override
+ protected void storeMap(Map
+ * 押金消费结果
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=4
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@AllArgsConstructor
+@NoArgsConstructor
+@XStreamAlias("xml")
+public class WxDepositConsumeResult extends BaseWxPayResult implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 微信订单号
+ * transaction_id
+ * 是
+ * String(32)
+ * 1217752501201407033233368018
+ * 微信支付押金订单号
+ *
+ */
+ @XStreamAlias("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 商户消费单号
+ * out_trade_no
+ * 是
+ * String(32)
+ * 20150806125346
+ * 商户系统内部的消费单号
+ *
+ */
+ @XStreamAlias("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 消费金额
+ * consume_fee
+ * 是
+ * Int
+ * 88
+ * 本次消费的金额,单位为分
+ *
+ */
+ @XStreamAlias("consume_fee")
+ private Integer consumeFee;
+
+ /**
+ *
+ * 剩余押金
+ * remain_fee
+ * 是
+ * Int
+ * 11
+ * 剩余押金金额,单位为分
+ *
+ */
+ @XStreamAlias("remain_fee")
+ private Integer remainFee;
+
+ /**
+ *
+ * 消费时间
+ * time_end
+ * 是
+ * String(14)
+ * 20141030133525
+ * 消费完成时间,格式为yyyyMMddHHmmss
+ *
+ */
+ @XStreamAlias("time_end")
+ private String timeEnd;
+
+ @Override
+ protected void loadXml(Document d) {
+ transactionId = readXmlString(d, "transaction_id");
+ outTradeNo = readXmlString(d, "out_trade_no");
+ consumeFee = readXmlInteger(d, "consume_fee");
+ remainFee = readXmlInteger(d, "remain_fee");
+ timeEnd = readXmlString(d, "time_end");
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositOrderQueryResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositOrderQueryResult.java
new file mode 100644
index 0000000000..66a5acb658
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositOrderQueryResult.java
@@ -0,0 +1,152 @@
+package com.github.binarywang.wxpay.bean.result;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import org.w3c.dom.Document;
+
+import java.io.Serializable;
+
+/**
+ *
+ * 查询押金订单结果
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=3
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@AllArgsConstructor
+@NoArgsConstructor
+@XStreamAlias("xml")
+public class WxDepositOrderQueryResult extends BaseWxPayResult implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 微信订单号
+ * transaction_id
+ * 是
+ * String(32)
+ * 1217752501201407033233368018
+ * 微信支付订单号
+ *
+ */
+ @XStreamAlias("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 商户订单号
+ * out_trade_no
+ * 是
+ * String(32)
+ * 20150806125346
+ * 商户系统内部订单号
+ *
+ */
+ @XStreamAlias("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 交易状态
+ * trade_state
+ * 是
+ * String(32)
+ * SUCCESS
+ * 交易状态:
+ * SUCCESS—支付成功
+ * REFUND—转入退款
+ * NOTPAY—未支付
+ * CLOSED—已关闭
+ * REVOKED—已撤销(付款码支付)
+ * USERPAYING—用户支付中(付款码支付)
+ * PAYERROR—支付失败(其他原因,如银行返回失败)
+ *
+ */
+ @XStreamAlias("trade_state")
+ private String tradeState;
+
+ /**
+ *
+ * 交易状态描述
+ * trade_state_desc
+ * 是
+ * String(256)
+ * 支付成功
+ * 对当前查询订单状态的描述和下一步操作的指引
+ *
+ */
+ @XStreamAlias("trade_state_desc")
+ private String tradeStateDesc;
+
+ /**
+ *
+ * 押金金额
+ * total_fee
+ * 否
+ * Int
+ * 99
+ * 订单总金额,单位为分
+ *
+ */
+ @XStreamAlias("total_fee")
+ private Integer totalFee;
+
+ /**
+ *
+ * 现金支付金额
+ * cash_fee
+ * 否
+ * Int
+ * 99
+ * 现金支付金额订单现金支付金额
+ *
+ */
+ @XStreamAlias("cash_fee")
+ private Integer cashFee;
+
+ /**
+ *
+ * 支付完成时间
+ * time_end
+ * 否
+ * String(14)
+ * 20141030133525
+ * 订单支付时间,格式为yyyyMMddHHmmss
+ *
+ */
+ @XStreamAlias("time_end")
+ private String timeEnd;
+
+ /**
+ *
+ * 剩余押金
+ * remain_fee
+ * 否
+ * Int
+ * 88
+ * 剩余押金金额,单位为分
+ *
+ */
+ @XStreamAlias("remain_fee")
+ private Integer remainFee;
+
+ @Override
+ protected void loadXml(Document d) {
+ transactionId = readXmlString(d, "transaction_id");
+ outTradeNo = readXmlString(d, "out_trade_no");
+ tradeState = readXmlString(d, "trade_state");
+ tradeStateDesc = readXmlString(d, "trade_state_desc");
+ totalFee = readXmlInteger(d, "total_fee");
+ cashFee = readXmlInteger(d, "cash_fee");
+ timeEnd = readXmlString(d, "time_end");
+ remainFee = readXmlInteger(d, "remain_fee");
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositRefundResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositRefundResult.java
new file mode 100644
index 0000000000..7c25b534a5
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositRefundResult.java
@@ -0,0 +1,103 @@
+package com.github.binarywang.wxpay.bean.result;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import org.w3c.dom.Document;
+
+import java.io.Serializable;
+
+/**
+ *
+ * 押金退款结果
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=6
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@AllArgsConstructor
+@NoArgsConstructor
+@XStreamAlias("xml")
+public class WxDepositRefundResult extends BaseWxPayResult implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 微信订单号
+ * transaction_id
+ * 是
+ * String(32)
+ * 1217752501201407033233368018
+ * 微信支付押金订单号
+ *
+ */
+ @XStreamAlias("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 商户退款单号
+ * out_refund_no
+ * 是
+ * String(32)
+ * 1217752501201407033233368018
+ * 商户系统内部的退款单号
+ *
+ */
+ @XStreamAlias("out_refund_no")
+ private String outRefundNo;
+
+ /**
+ *
+ * 微信退款单号
+ * refund_id
+ * 是
+ * String(32)
+ * 1217752501201407033233368018
+ * 微信退款单号
+ *
+ */
+ @XStreamAlias("refund_id")
+ private String refundId;
+
+ /**
+ *
+ * 退款金额
+ * refund_fee
+ * 是
+ * Int
+ * 100
+ * 退款总金额,单位为分,可以做部分退款
+ *
+ */
+ @XStreamAlias("refund_fee")
+ private Integer refundFee;
+
+ /**
+ *
+ * 现金退款金额
+ * cash_refund_fee
+ * 否
+ * Int
+ * 100
+ * 现金退款金额,单位为分,只能为整数
+ *
+ */
+ @XStreamAlias("cash_refund_fee")
+ private Integer cashRefundFee;
+
+ @Override
+ protected void loadXml(Document d) {
+ transactionId = readXmlString(d, "transaction_id");
+ outRefundNo = readXmlString(d, "out_refund_no");
+ refundId = readXmlString(d, "refund_id");
+ refundFee = readXmlInteger(d, "refund_fee");
+ cashRefundFee = readXmlInteger(d, "cash_refund_fee");
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositUnfreezeResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositUnfreezeResult.java
new file mode 100644
index 0000000000..98da8c878b
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositUnfreezeResult.java
@@ -0,0 +1,103 @@
+package com.github.binarywang.wxpay.bean.result;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import org.w3c.dom.Document;
+
+import java.io.Serializable;
+
+/**
+ *
+ * 押金撤销结果
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=5
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@AllArgsConstructor
+@NoArgsConstructor
+@XStreamAlias("xml")
+public class WxDepositUnfreezeResult extends BaseWxPayResult implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 微信订单号
+ * transaction_id
+ * 是
+ * String(32)
+ * 1217752501201407033233368018
+ * 微信支付押金订单号
+ *
+ */
+ @XStreamAlias("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 商户撤销单号
+ * out_trade_no
+ * 是
+ * String(32)
+ * 20150806125346
+ * 商户系统内部的撤销单号
+ *
+ */
+ @XStreamAlias("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 撤销金额
+ * unfreeze_fee
+ * 是
+ * Int
+ * 99
+ * 撤销的押金金额,单位为分
+ *
+ */
+ @XStreamAlias("unfreeze_fee")
+ private Integer unfreezeFee;
+
+ /**
+ *
+ * 剩余押金
+ * remain_fee
+ * 是
+ * Int
+ * 0
+ * 剩余押金金额,单位为分
+ *
+ */
+ @XStreamAlias("remain_fee")
+ private Integer remainFee;
+
+ /**
+ *
+ * 撤销时间
+ * time_end
+ * 是
+ * String(14)
+ * 20141030133525
+ * 撤销完成时间,格式为yyyyMMddHHmmss
+ *
+ */
+ @XStreamAlias("time_end")
+ private String timeEnd;
+
+ @Override
+ protected void loadXml(Document d) {
+ transactionId = readXmlString(d, "transaction_id");
+ outTradeNo = readXmlString(d, "out_trade_no");
+ unfreezeFee = readXmlInteger(d, "unfreeze_fee");
+ remainFee = readXmlInteger(d, "remain_fee");
+ timeEnd = readXmlString(d, "time_end");
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositUnifiedOrderResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositUnifiedOrderResult.java
new file mode 100644
index 0000000000..120aeb111a
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositUnifiedOrderResult.java
@@ -0,0 +1,89 @@
+package com.github.binarywang.wxpay.bean.result;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import org.w3c.dom.Document;
+
+import java.io.Serializable;
+
+/**
+ *
+ * 押金下单结果
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=2
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@AllArgsConstructor
+@NoArgsConstructor
+@XStreamAlias("xml")
+public class WxDepositUnifiedOrderResult extends BaseWxPayResult implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 交易类型
+ * trade_type
+ * 是
+ * String(16)
+ * JSAPI
+ * 交易类型,取值为:JSAPI,NATIVE,APP等
+ *
+ */
+ @XStreamAlias("trade_type")
+ private String tradeType;
+
+ /**
+ *
+ * 预支付交易会话标识
+ * prepay_id
+ * 是
+ * String(64)
+ * wx201410272009395522657a690389285100
+ * 微信生成的预支付会话标识,用于后续接口调用中使用,该值有效期为2小时
+ *
+ */
+ @XStreamAlias("prepay_id")
+ private String prepayId;
+
+ /**
+ *
+ * 二维码链接
+ * code_url
+ * 否
+ * String(64)
+ * URl:weixin://wxpay/s/An4baqw
+ * trade_type 为 NATIVE 时有返回,可将该参数值生成二维码展示出来进行扫码支付
+ *
+ */
+ @XStreamAlias("code_url")
+ private String codeUrl;
+
+ /**
+ *
+ * 微信订单号
+ * transaction_id
+ * 是
+ * String(32)
+ * 1217752501201407033233368018
+ * 微信支付分配的交易会话标识
+ *
+ */
+ @XStreamAlias("transaction_id")
+ private String transactionId;
+
+ @Override
+ protected void loadXml(Document d) {
+ tradeType = readXmlString(d, "trade_type");
+ prepayId = readXmlString(d, "prepay_id");
+ codeUrl = readXmlString(d, "code_url");
+ transactionId = readXmlString(d, "transaction_id");
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxDepositService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxDepositService.java
new file mode 100644
index 0000000000..cb0bc3b062
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxDepositService.java
@@ -0,0 +1,90 @@
+package com.github.binarywang.wxpay.service;
+
+import com.github.binarywang.wxpay.bean.request.WxDepositConsumeRequest;
+import com.github.binarywang.wxpay.bean.request.WxDepositOrderQueryRequest;
+import com.github.binarywang.wxpay.bean.request.WxDepositRefundRequest;
+import com.github.binarywang.wxpay.bean.request.WxDepositUnfreezeRequest;
+import com.github.binarywang.wxpay.bean.request.WxDepositUnifiedOrderRequest;
+import com.github.binarywang.wxpay.bean.result.WxDepositConsumeResult;
+import com.github.binarywang.wxpay.bean.result.WxDepositOrderQueryResult;
+import com.github.binarywang.wxpay.bean.result.WxDepositRefundResult;
+import com.github.binarywang.wxpay.bean.result.WxDepositUnfreezeResult;
+import com.github.binarywang.wxpay.bean.result.WxDepositUnifiedOrderResult;
+import com.github.binarywang.wxpay.exception.WxPayException;
+
+/**
+ *
+ * 微信押金支付相关接口.
+ * https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=1
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+public interface WxDepositService {
+
+ /**
+ *
+ * 押金下单
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=2
+ * 用于商户发起押金支付,支持JSAPI、NATIVE、APP等支付方式
+ *
+ *
+ * @param request 押金下单请求对象
+ * @return wx deposit unified order result
+ * @throws WxPayException wx pay exception
+ */
+ WxDepositUnifiedOrderResult unifiedOrder(WxDepositUnifiedOrderRequest request) throws WxPayException;
+
+ /**
+ *
+ * 查询押金订单
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=3
+ * 通过商户订单号或微信订单号查询押金订单状态
+ *
+ *
+ * @param request 查询押金订单请求对象
+ * @return wx deposit order query result
+ * @throws WxPayException wx pay exception
+ */
+ WxDepositOrderQueryResult queryOrder(WxDepositOrderQueryRequest request) throws WxPayException;
+
+ /**
+ *
+ * 押金消费
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=4
+ * 用于对已支付的押金进行消费扣减
+ *
+ *
+ * @param request 押金消费请求对象
+ * @return wx deposit consume result
+ * @throws WxPayException wx pay exception
+ */
+ WxDepositConsumeResult consume(WxDepositConsumeRequest request) throws WxPayException;
+
+ /**
+ *
+ * 押金撤销
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=5
+ * 用于对已支付的押金进行撤销退还
+ *
+ *
+ * @param request 押金撤销请求对象
+ * @return wx deposit unfreeze result
+ * @throws WxPayException wx pay exception
+ */
+ WxDepositUnfreezeResult unfreeze(WxDepositUnfreezeRequest request) throws WxPayException;
+
+ /**
+ *
+ * 押金退款
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=6
+ * 用于对已消费的押金进行退款
+ *
+ *
+ * @param request 押金退款请求对象
+ * @return wx deposit refund result
+ * @throws WxPayException wx pay exception
+ */
+ WxDepositRefundResult refund(WxDepositRefundRequest request) throws WxPayException;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java
index 775915b858..2cd701949b 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java
@@ -229,6 +229,13 @@ public interface WxPayService {
*/
WxEntrustPapService getWxEntrustPapService();
+ /**
+ * 获取微信押金支付服务类
+ *
+ * @return deposit service
+ */
+ WxDepositService getWxDepositService();
+
/**
* 获取批量转账到零钱服务类.
*
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
index e5c9abf53b..1783a833dd 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
@@ -103,6 +103,9 @@ public abstract class BaseWxPayServiceImpl implements WxPayService {
@Getter
private final WxEntrustPapService wxEntrustPapService = new WxEntrustPapServiceImpl(this);
+ @Getter
+ private final WxDepositService wxDepositService = new WxDepositServiceImpl(this);
+
@Getter
private final PartnerTransferService partnerTransferService = new PartnerTransferServiceImpl(this);
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxDepositServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxDepositServiceImpl.java
new file mode 100644
index 0000000000..70bc5a5162
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxDepositServiceImpl.java
@@ -0,0 +1,84 @@
+package com.github.binarywang.wxpay.service.impl;
+
+import com.github.binarywang.wxpay.bean.request.*;
+import com.github.binarywang.wxpay.bean.result.*;
+import com.github.binarywang.wxpay.exception.WxPayException;
+import com.github.binarywang.wxpay.service.WxDepositService;
+import com.github.binarywang.wxpay.service.WxPayService;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+
+/**
+ *
+ * 微信押金支付服务实现
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+@Slf4j
+@RequiredArgsConstructor
+public class WxDepositServiceImpl implements WxDepositService {
+
+ private final WxPayService payService;
+
+ @Override
+ public WxDepositUnifiedOrderResult unifiedOrder(WxDepositUnifiedOrderRequest request) throws WxPayException {
+ request.checkAndSign(payService.getConfig());
+
+ String url = payService.getPayBaseUrl() + "/pay/depositpay";
+ String responseContent = payService.post(url, request.toXML(), false);
+ WxDepositUnifiedOrderResult result = BaseWxPayResult.fromXML(responseContent, WxDepositUnifiedOrderResult.class);
+ result.checkResult(payService, request.getSignType(), true);
+
+ return result;
+ }
+
+ @Override
+ public WxDepositOrderQueryResult queryOrder(WxDepositOrderQueryRequest request) throws WxPayException {
+ request.checkAndSign(payService.getConfig());
+
+ String url = payService.getPayBaseUrl() + "/pay/depositorderquery";
+ String responseContent = payService.post(url, request.toXML(), false);
+ WxDepositOrderQueryResult result = BaseWxPayResult.fromXML(responseContent, WxDepositOrderQueryResult.class);
+ result.checkResult(payService, request.getSignType(), true);
+
+ return result;
+ }
+
+ @Override
+ public WxDepositConsumeResult consume(WxDepositConsumeRequest request) throws WxPayException {
+ request.checkAndSign(payService.getConfig());
+
+ String url = payService.getPayBaseUrl() + "/pay/depositconsume";
+ String responseContent = payService.post(url, request.toXML(), false);
+ WxDepositConsumeResult result = BaseWxPayResult.fromXML(responseContent, WxDepositConsumeResult.class);
+ result.checkResult(payService, request.getSignType(), true);
+
+ return result;
+ }
+
+ @Override
+ public WxDepositUnfreezeResult unfreeze(WxDepositUnfreezeRequest request) throws WxPayException {
+ request.checkAndSign(payService.getConfig());
+
+ String url = payService.getPayBaseUrl() + "/pay/depositreverse";
+ String responseContent = payService.post(url, request.toXML(), false);
+ WxDepositUnfreezeResult result = BaseWxPayResult.fromXML(responseContent, WxDepositUnfreezeResult.class);
+ result.checkResult(payService, request.getSignType(), true);
+
+ return result;
+ }
+
+ @Override
+ public WxDepositRefundResult refund(WxDepositRefundRequest request) throws WxPayException {
+ request.checkAndSign(payService.getConfig());
+
+ String url = payService.getPayBaseUrl() + "/pay/depositrefund";
+ String responseContent = payService.post(url, request.toXML(), true);
+ WxDepositRefundResult result = BaseWxPayResult.fromXML(responseContent, WxDepositRefundResult.class);
+ result.checkResult(payService, request.getSignType(), true);
+
+ return result;
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/WxDepositServiceTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/WxDepositServiceTest.java
new file mode 100644
index 0000000000..1bbf347211
--- /dev/null
+++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/WxDepositServiceTest.java
@@ -0,0 +1,135 @@
+package com.github.binarywang.wxpay.service.impl;
+
+import com.github.binarywang.wxpay.bean.request.*;
+import com.github.binarywang.wxpay.bean.result.*;
+import com.github.binarywang.wxpay.exception.WxPayException;
+import com.github.binarywang.wxpay.service.WxPayService;
+import com.github.binarywang.wxpay.testbase.ApiTestModule;
+import com.google.inject.Inject;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.testng.annotations.Guice;
+import org.testng.annotations.Test;
+
+/**
+ *
+ * 微信押金支付测试
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+@Test
+@Guice(modules = ApiTestModule.class)
+public class WxDepositServiceTest {
+
+ private final Logger logger = LoggerFactory.getLogger(this.getClass());
+
+ @Inject
+ private WxPayService payService;
+
+ /**
+ * 测试押金下单
+ */
+ @Test
+ public void testUnifiedOrder() throws WxPayException {
+ WxDepositUnifiedOrderRequest request = WxDepositUnifiedOrderRequest.newBuilder()
+ .body("共享单车押金")
+ .outTradeNo("D" + System.currentTimeMillis())
+ .totalFee(99)
+ .spbillCreateIp("192.168.1.1")
+ .notifyUrl("https://example.com/wxpay/notify")
+ .tradeType("JSAPI")
+ .openid("test_openid_123")
+ .build();
+
+ try {
+ WxDepositUnifiedOrderResult result = this.payService.getWxDepositService().unifiedOrder(request);
+ logger.info("押金下单结果: {}", result);
+ } catch (WxPayException e) {
+ logger.error("押金下单失败", e);
+ // For demo purposes, just log the error - tests need proper WeChat credentials to run
+ }
+ }
+
+ /**
+ * 测试查询押金订单
+ */
+ @Test
+ public void testQueryOrder() throws WxPayException {
+ WxDepositOrderQueryRequest request = WxDepositOrderQueryRequest.newBuilder()
+ .outTradeNo("D1695559200000")
+ .build();
+
+ try {
+ WxDepositOrderQueryResult result = this.payService.getWxDepositService().queryOrder(request);
+ logger.info("押金订单查询结果: {}", result);
+ } catch (WxPayException e) {
+ logger.error("押金订单查询失败", e);
+ // For demo purposes, just log the error - tests need proper WeChat credentials to run
+ }
+ }
+
+ /**
+ * 测试押金消费
+ */
+ @Test
+ public void testConsume() throws WxPayException {
+ WxDepositConsumeRequest request = WxDepositConsumeRequest.newBuilder()
+ .transactionId("1217752501201407033233368018")
+ .outTradeNo("C" + System.currentTimeMillis())
+ .consumeFee(10)
+ .consumeDesc("单车使用费")
+ .build();
+
+ try {
+ WxDepositConsumeResult result = this.payService.getWxDepositService().consume(request);
+ logger.info("押金消费结果: {}", result);
+ } catch (WxPayException e) {
+ logger.error("押金消费失败", e);
+ // For demo purposes, just log the error - tests need proper WeChat credentials to run
+ }
+ }
+
+ /**
+ * 测试押金撤销
+ */
+ @Test
+ public void testUnfreeze() throws WxPayException {
+ WxDepositUnfreezeRequest request = WxDepositUnfreezeRequest.newBuilder()
+ .transactionId("1217752501201407033233368018")
+ .outTradeNo("U" + System.currentTimeMillis())
+ .unfreezeFee(99)
+ .unfreezeDesc("用户主动取消")
+ .build();
+
+ try {
+ WxDepositUnfreezeResult result = this.payService.getWxDepositService().unfreeze(request);
+ logger.info("押金撤销结果: {}", result);
+ } catch (WxPayException e) {
+ logger.error("押金撤销失败", e);
+ // For demo purposes, just log the error - tests need proper WeChat credentials to run
+ }
+ }
+
+ /**
+ * 测试押金退款
+ */
+ @Test
+ public void testRefund() throws WxPayException {
+ WxDepositRefundRequest request = WxDepositRefundRequest.newBuilder()
+ .transactionId("1217752501201407033233368018")
+ .outRefundNo("R" + System.currentTimeMillis())
+ .refundFee(50)
+ .refundDesc("部分退款")
+ .build();
+
+ try {
+ WxDepositRefundResult result = this.payService.getWxDepositService().refund(request);
+ logger.info("押金退款结果: {}", result);
+ } catch (WxPayException e) {
+ logger.error("押金退款失败", e);
+ // For demo purposes, just log the error - tests need proper WeChat credentials to run
+ }
+ }
+}
\ No newline at end of file
From 092e99281786fe5ee147fed9c497b36783c21340 Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Sat, 15 Nov 2025 17:12:21 +0800
Subject: [PATCH 074/208] =?UTF-8?q?:new:=20#3688=20=E3=80=90=E5=BE=AE?=
=?UTF-8?q?=E4=BF=A1=E6=94=AF=E4=BB=98=E3=80=91=20=E5=AE=9E=E7=8E=B0?=
=?UTF-8?q?=E9=A2=84=E7=BA=A6=E6=89=A3=E8=B4=B9=E6=9C=8D=E5=8A=A1=E7=9A=84?=
=?UTF-8?q?=E7=9B=B8=E5=85=B3=E6=8E=A5=E5=8F=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
weixin-java-pay/SUBSCRIPTION_BILLING_USAGE.md | 194 ++++++++++++++++++
.../bean/subscriptionbilling/BillingPlan.java | 110 ++++++++++
.../SubscriptionAmount.java | 49 +++++
.../SubscriptionCancelRequest.java | 49 +++++
.../SubscriptionCancelResult.java | 77 +++++++
.../SubscriptionInstantBillingRequest.java | 104 ++++++++++
.../SubscriptionInstantBillingResult.java | 111 ++++++++++
.../SubscriptionQueryResult.java | 177 ++++++++++++++++
.../SubscriptionScheduleRequest.java | 131 ++++++++++++
.../SubscriptionScheduleResult.java | 121 +++++++++++
.../SubscriptionTransactionQueryRequest.java | 91 ++++++++
.../SubscriptionTransactionQueryResult.java | 190 +++++++++++++++++
.../service/SubscriptionBillingService.java | 105 ++++++++++
.../wxpay/service/WxPayService.java | 7 +
.../service/impl/BaseWxPayServiceImpl.java | 3 +
.../impl/SubscriptionBillingServiceImpl.java | 91 ++++++++
.../SubscriptionBillingServiceImplTest.java | 144 +++++++++++++
17 files changed, 1754 insertions(+)
create mode 100644 weixin-java-pay/SUBSCRIPTION_BILLING_USAGE.md
create mode 100644 weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/BillingPlan.java
create mode 100644 weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionAmount.java
create mode 100644 weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionCancelRequest.java
create mode 100644 weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionCancelResult.java
create mode 100644 weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionInstantBillingRequest.java
create mode 100644 weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionInstantBillingResult.java
create mode 100644 weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionQueryResult.java
create mode 100644 weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionScheduleRequest.java
create mode 100644 weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionScheduleResult.java
create mode 100644 weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionTransactionQueryRequest.java
create mode 100644 weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionTransactionQueryResult.java
create mode 100644 weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/SubscriptionBillingService.java
create mode 100644 weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/SubscriptionBillingServiceImpl.java
create mode 100644 weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/SubscriptionBillingServiceImplTest.java
diff --git a/weixin-java-pay/SUBSCRIPTION_BILLING_USAGE.md b/weixin-java-pay/SUBSCRIPTION_BILLING_USAGE.md
new file mode 100644
index 0000000000..acc8f269b8
--- /dev/null
+++ b/weixin-java-pay/SUBSCRIPTION_BILLING_USAGE.md
@@ -0,0 +1,194 @@
+# 微信支付预约扣费功能使用说明
+
+## 概述
+
+微信支付预约扣费功能(连续包月功能)允许商户在用户授权的情况下,按照约定的时间和金额,自动从用户的支付账户中扣取费用。主要适用于连续包月、订阅服务等场景。
+
+## 功能特性
+
+- **预约扣费**:创建未来某个时间点的扣费计划
+- **查询预约**:查询已创建的扣费计划状态
+- **取消预约**:取消已创建的扣费计划
+- **立即扣费**:立即执行扣费操作
+- **扣费记录查询**:查询历史扣费记录
+
+## 快速开始
+
+### 1. 获取服务实例
+
+```java
+// 通过 WxPayService 获取预约扣费服务
+SubscriptionBillingService subscriptionService = wxPayService.getSubscriptionBillingService();
+```
+
+### 2. 创建预约扣费
+
+```java
+// 创建预约扣费请求
+SubscriptionScheduleRequest request = new SubscriptionScheduleRequest();
+request.setOutTradeNo("subscription_" + System.currentTimeMillis());
+request.setOpenid("用户的openid");
+request.setDescription("腾讯视频VIP会员");
+request.setScheduleTime("2024-09-01T10:00:00+08:00");
+
+// 设置扣费金额
+SubscriptionAmount amount = new SubscriptionAmount();
+amount.setTotal(3000); // 30元,单位为分
+amount.setCurrency("CNY");
+request.setAmount(amount);
+
+// 设置扣费计划(可选)
+BillingPlan billingPlan = new BillingPlan();
+billingPlan.setPlanType("MONTHLY"); // 按月扣费
+billingPlan.setPeriod(1); // 每1个月
+billingPlan.setTotalCount(12); // 总共12次
+request.setBillingPlan(billingPlan);
+
+// 发起预约扣费
+SubscriptionScheduleResult result = subscriptionService.scheduleSubscription(request);
+System.out.println("预约扣费ID: " + result.getSubscriptionId());
+```
+
+### 3. 查询预约扣费
+
+```java
+// 通过预约扣费ID查询
+String subscriptionId = "从预约扣费结果中获取的ID";
+SubscriptionQueryResult queryResult = subscriptionService.querySubscription(subscriptionId);
+System.out.println("预约状态: " + queryResult.getStatus());
+```
+
+### 4. 取消预约扣费
+
+```java
+// 创建取消请求
+SubscriptionCancelRequest cancelRequest = new SubscriptionCancelRequest();
+cancelRequest.setSubscriptionId(subscriptionId);
+cancelRequest.setCancelReason("用户主动取消");
+
+// 取消预约扣费
+SubscriptionCancelResult cancelResult = subscriptionService.cancelSubscription(cancelRequest);
+System.out.println("取消结果: " + cancelResult.getStatus());
+```
+
+### 5. 立即扣费
+
+```java
+// 创建立即扣费请求
+SubscriptionInstantBillingRequest instantRequest = new SubscriptionInstantBillingRequest();
+instantRequest.setOutTradeNo("instant_" + System.currentTimeMillis());
+instantRequest.setOpenid("用户的openid");
+instantRequest.setDescription("补扣上月会员费");
+
+// 设置扣费金额
+SubscriptionAmount instantAmount = new SubscriptionAmount();
+instantAmount.setTotal(3000); // 30元
+instantAmount.setCurrency("CNY");
+instantRequest.setAmount(instantAmount);
+
+// 执行立即扣费
+SubscriptionInstantBillingResult instantResult = subscriptionService.instantBilling(instantRequest);
+System.out.println("扣费结果: " + instantResult.getTradeState());
+```
+
+### 6. 查询扣费记录
+
+```java
+// 创建查询请求
+SubscriptionTransactionQueryRequest queryRequest = new SubscriptionTransactionQueryRequest();
+queryRequest.setOpenid("用户的openid");
+queryRequest.setBeginTime("2024-08-01T00:00:00+08:00");
+queryRequest.setEndTime("2024-08-31T23:59:59+08:00");
+queryRequest.setLimit(20);
+queryRequest.setOffset(0);
+
+// 查询扣费记录
+SubscriptionTransactionQueryResult transactionResult = subscriptionService.queryTransactions(queryRequest);
+System.out.println("总记录数: " + transactionResult.getTotalCount());
+for (SubscriptionTransactionQueryResult.SubscriptionTransaction transaction : transactionResult.getData()) {
+ System.out.println("订单号: " + transaction.getOutTradeNo() + ", 状态: " + transaction.getTradeState());
+}
+```
+
+## 扣费计划类型
+
+- `MONTHLY`:按月扣费
+- `WEEKLY`:按周扣费
+- `DAILY`:按日扣费
+- `YEARLY`:按年扣费
+
+## 预约状态说明
+
+- `SCHEDULED`:已预约
+- `CANCELLED`:已取消
+- `EXECUTED`:已执行
+- `FAILED`:执行失败
+
+## 交易状态说明
+
+- `SUCCESS`:支付成功
+- `REFUND`:转入退款
+- `NOTPAY`:未支付
+- `CLOSED`:已关闭
+- `REVOKED`:已撤销(刷卡支付)
+- `USERPAYING`:用户支付中
+- `PAYERROR`:支付失败
+
+## 注意事项
+
+1. **用户授权**:使用预约扣费功能前,需要用户在微信内完成签约授权
+2. **商户资质**:需要具备相应的业务资质才能开通此功能
+3. **金额限制**:扣费金额需要在签约模板规定的范围内
+4. **频率限制**:API调用有频率限制,请注意控制调用频次
+5. **异常处理**:建议对所有API调用进行异常处理
+
+## 相关文档
+
+- [微信支付预约扣费API文档](https://pay.weixin.qq.com/doc/v3/merchant/4012161105)
+- [微信支付开发指南](https://pay.weixin.qq.com/wiki/doc/apiv3/index.shtml)
+
+## 示例完整代码
+
+```java
+import com.github.binarywang.wxpay.service.SubscriptionBillingService;
+import com.github.binarywang.wxpay.bean.subscriptionbilling.*;
+
+public class SubscriptionBillingExample {
+
+ private SubscriptionBillingService subscriptionService;
+
+ public void example() throws Exception {
+ // 1. 创建预约扣费
+ SubscriptionScheduleRequest request = new SubscriptionScheduleRequest();
+ request.setOutTradeNo("subscription_" + System.currentTimeMillis());
+ request.setOpenid("用户openid");
+ request.setDescription("VIP会员续费");
+ request.setScheduleTime("2024-09-01T10:00:00+08:00");
+
+ SubscriptionAmount amount = new SubscriptionAmount();
+ amount.setTotal(3000);
+ amount.setCurrency("CNY");
+ request.setAmount(amount);
+
+ BillingPlan plan = new BillingPlan();
+ plan.setPlanType("MONTHLY");
+ plan.setPeriod(1);
+ plan.setTotalCount(12);
+ request.setBillingPlan(plan);
+
+ SubscriptionScheduleResult result = subscriptionService.scheduleSubscription(request);
+
+ // 2. 查询预约状态
+ SubscriptionQueryResult query = subscriptionService.querySubscription(result.getSubscriptionId());
+
+ // 3. 如需取消
+ if ("SCHEDULED".equals(query.getStatus())) {
+ SubscriptionCancelRequest cancelReq = new SubscriptionCancelRequest();
+ cancelReq.setSubscriptionId(result.getSubscriptionId());
+ cancelReq.setCancelReason("用户取消");
+
+ SubscriptionCancelResult cancelResult = subscriptionService.cancelSubscription(cancelReq);
+ }
+ }
+}
+```
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/BillingPlan.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/BillingPlan.java
new file mode 100644
index 0000000000..b664f4cb7b
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/BillingPlan.java
@@ -0,0 +1,110 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 扣费计划信息
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class BillingPlan implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:计划类型
+ * 变量名:plan_type
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 扣费计划类型
+ * MONTHLY:按月扣费
+ * WEEKLY:按周扣费
+ * DAILY:按日扣费
+ * YEARLY:按年扣费
+ * 示例值:MONTHLY
+ *
+ */
+ @SerializedName("plan_type")
+ private String planType;
+
+ /**
+ *
+ * 字段名:扣费周期
+ * 变量名:period
+ * 是否必填:是
+ * 类型:int
+ * 描述:
+ * 扣费周期,配合plan_type使用
+ * 例如:plan_type为MONTHLY,period为1,表示每1个月扣费一次
+ * 示例值:1
+ *
+ */
+ @SerializedName("period")
+ private Integer period;
+
+ /**
+ *
+ * 字段名:总扣费次数
+ * 变量名:total_count
+ * 是否必填:否
+ * 类型:int
+ * 描述:
+ * 总扣费次数,不填表示无限次扣费
+ * 示例值:12
+ *
+ */
+ @SerializedName("total_count")
+ private Integer totalCount;
+
+ /**
+ *
+ * 字段名:已扣费次数
+ * 变量名:executed_count
+ * 是否必填:否
+ * 类型:int
+ * 描述:
+ * 已扣费次数,查询时返回
+ * 示例值:2
+ *
+ */
+ @SerializedName("executed_count")
+ private Integer executedCount;
+
+ /**
+ *
+ * 字段名:计划开始时间
+ * 变量名:start_time
+ * 是否必填:否
+ * 类型:string(32)
+ * 描述:
+ * 计划开始时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("start_time")
+ private String startTime;
+
+ /**
+ *
+ * 字段名:计划结束时间
+ * 变量名:end_time
+ * 是否必填:否
+ * 类型:string(32)
+ * 描述:
+ * 计划结束时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE
+ * 示例值:2019-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("end_time")
+ private String endTime;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionAmount.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionAmount.java
new file mode 100644
index 0000000000..c778a8ecb6
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionAmount.java
@@ -0,0 +1,49 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 预约扣费金额信息
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionAmount implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:总金额
+ * 变量名:total
+ * 是否必填:是
+ * 类型:int
+ * 描述:
+ * 订单总金额,单位为分
+ * 示例值:100
+ *
+ */
+ @SerializedName("total")
+ private Integer total;
+
+ /**
+ *
+ * 字段名:货币类型
+ * 变量名:currency
+ * 是否必填:否
+ * 类型:string(16)
+ * 描述:
+ * CNY:人民币,境内商户号仅支持人民币
+ * 示例值:CNY
+ *
+ */
+ @SerializedName("currency")
+ private String currency;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionCancelRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionCancelRequest.java
new file mode 100644
index 0000000000..233d756f03
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionCancelRequest.java
@@ -0,0 +1,49 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 取消预约扣费请求参数
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionCancelRequest implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:预约扣费ID
+ * 变量名:subscription_id
+ * 是否必填:是
+ * 类型:string(64)
+ * 描述:
+ * 微信支付预约扣费ID
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("subscription_id")
+ private String subscriptionId;
+
+ /**
+ *
+ * 字段名:取消原因
+ * 变量名:cancel_reason
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 取消原因描述
+ * 示例值:用户主动取消
+ *
+ */
+ @SerializedName("cancel_reason")
+ private String cancelReason;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionCancelResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionCancelResult.java
new file mode 100644
index 0000000000..74ca22f130
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionCancelResult.java
@@ -0,0 +1,77 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 取消预约扣费响应结果
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionCancelResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:预约扣费ID
+ * 变量名:subscription_id
+ * 是否必填:是
+ * 类型:string(64)
+ * 描述:
+ * 微信支付预约扣费ID
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("subscription_id")
+ private String subscriptionId;
+
+ /**
+ *
+ * 字段名:预约状态
+ * 变量名:status
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 预约状态,取消后应为CANCELLED
+ * 示例值:CANCELLED
+ *
+ */
+ @SerializedName("status")
+ private String status;
+
+ /**
+ *
+ * 字段名:取消时间
+ * 变量名:cancel_time
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 取消时间,遵循rfc3339标准格式
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("cancel_time")
+ private String cancelTime;
+
+ /**
+ *
+ * 字段名:取消原因
+ * 变量名:cancel_reason
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 取消原因描述
+ * 示例值:用户主动取消
+ *
+ */
+ @SerializedName("cancel_reason")
+ private String cancelReason;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionInstantBillingRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionInstantBillingRequest.java
new file mode 100644
index 0000000000..2b5a3dec37
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionInstantBillingRequest.java
@@ -0,0 +1,104 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 立即扣费请求参数
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionInstantBillingRequest implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:商户订单号
+ * 变量名:out_trade_no
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 字段名:用户标识
+ * 变量名:openid
+ * 是否必填:是
+ * 类型:string(128)
+ * 描述:
+ * 用户在直连商户appid下的唯一标识
+ * 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
+ *
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ *
+ * 字段名:订单描述
+ * 变量名:description
+ * 是否必填:是
+ * 类型:string(127)
+ * 描述:
+ * 订单描述
+ * 示例值:腾讯充值中心-QQ会员充值
+ *
+ */
+ @SerializedName("description")
+ private String description;
+
+ /**
+ *
+ * 字段名:扣费金额
+ * 变量名:amount
+ * 是否必填:是
+ * 类型:object
+ * 描述:
+ * 扣费金额信息
+ *
+ */
+ @SerializedName("amount")
+ private SubscriptionAmount amount;
+
+ /**
+ *
+ * 字段名:通知地址
+ * 变量名:notify_url
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 异步接收微信支付结果通知的回调地址,通知url必须为外网可访问的url,不能携带参数
+ * 示例值:https://www.weixin.qq.com/wxpay/pay.php
+ *
+ */
+ @SerializedName("notify_url")
+ private String notifyUrl;
+
+ /**
+ *
+ * 字段名:附加数据
+ * 变量名:attach
+ * 是否必填:否
+ * 类型:string(128)
+ * 描述:
+ * 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用
+ * 示例值:自定义数据
+ *
+ */
+ @SerializedName("attach")
+ private String attach;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionInstantBillingResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionInstantBillingResult.java
new file mode 100644
index 0000000000..ac34307cd4
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionInstantBillingResult.java
@@ -0,0 +1,111 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 立即扣费响应结果
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionInstantBillingResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:微信支付订单号
+ * 变量名:transaction_id
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 微信支付系统生成的订单号
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 字段名:商户订单号
+ * 变量名:out_trade_no
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 商户系统内部订单号
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 字段名:交易状态
+ * 变量名:trade_state
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 交易状态
+ * SUCCESS:支付成功
+ * REFUND:转入退款
+ * NOTPAY:未支付
+ * CLOSED:已关闭
+ * REVOKED:已撤销(刷卡支付)
+ * USERPAYING:用户支付中
+ * PAYERROR:支付失败
+ * 示例值:SUCCESS
+ *
+ */
+ @SerializedName("trade_state")
+ private String tradeState;
+
+ /**
+ *
+ * 字段名:交易状态描述
+ * 变量名:trade_state_desc
+ * 是否必填:是
+ * 类型:string(256)
+ * 描述:
+ * 交易状态描述
+ * 示例值:支付成功
+ *
+ */
+ @SerializedName("trade_state_desc")
+ private String tradeStateDesc;
+
+ /**
+ *
+ * 字段名:支付完成时间
+ * 变量名:success_time
+ * 是否必填:否
+ * 类型:string(32)
+ * 描述:
+ * 支付完成时间,遵循rfc3339标准格式
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("success_time")
+ private String successTime;
+
+ /**
+ *
+ * 字段名:扣费金额
+ * 变量名:amount
+ * 是否必填:是
+ * 类型:object
+ * 描述:
+ * 扣费金额信息
+ *
+ */
+ @SerializedName("amount")
+ private SubscriptionAmount amount;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionQueryResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionQueryResult.java
new file mode 100644
index 0000000000..17e2c7dc19
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionQueryResult.java
@@ -0,0 +1,177 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 预约扣费查询结果
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionQueryResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:预约扣费ID
+ * 变量名:subscription_id
+ * 是否必填:是
+ * 类型:string(64)
+ * 描述:
+ * 微信支付预约扣费ID
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("subscription_id")
+ private String subscriptionId;
+
+ /**
+ *
+ * 字段名:商户订单号
+ * 变量名:out_trade_no
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 商户系统内部订单号
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 字段名:用户标识
+ * 变量名:openid
+ * 是否必填:是
+ * 类型:string(128)
+ * 描述:
+ * 用户在直连商户appid下的唯一标识
+ * 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
+ *
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ *
+ * 字段名:订单描述
+ * 变量名:description
+ * 是否必填:是
+ * 类型:string(127)
+ * 描述:
+ * 订单描述
+ * 示例值:腾讯充值中心-QQ会员充值
+ *
+ */
+ @SerializedName("description")
+ private String description;
+
+ /**
+ *
+ * 字段名:预约状态
+ * 变量名:status
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 预约状态
+ * SCHEDULED:已预约
+ * CANCELLED:已取消
+ * EXECUTED:已执行
+ * FAILED:执行失败
+ * 示例值:SCHEDULED
+ *
+ */
+ @SerializedName("status")
+ private String status;
+
+ /**
+ *
+ * 字段名:预约扣费时间
+ * 变量名:schedule_time
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 预约扣费的时间,遵循rfc3339标准格式
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("schedule_time")
+ private String scheduleTime;
+
+ /**
+ *
+ * 字段名:创建时间
+ * 变量名:create_time
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 预约创建时间,遵循rfc3339标准格式
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("create_time")
+ private String createTime;
+
+ /**
+ *
+ * 字段名:更新时间
+ * 变量名:update_time
+ * 是否必填:否
+ * 类型:string(32)
+ * 描述:
+ * 预约更新时间,遵循rfc3339标准格式
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("update_time")
+ private String updateTime;
+
+ /**
+ *
+ * 字段名:预约扣费金额
+ * 变量名:amount
+ * 是否必填:是
+ * 类型:object
+ * 描述:
+ * 预约扣费金额信息
+ *
+ */
+ @SerializedName("amount")
+ private SubscriptionAmount amount;
+
+ /**
+ *
+ * 字段名:扣费计划
+ * 变量名:billing_plan
+ * 是否必填:否
+ * 类型:object
+ * 描述:
+ * 扣费计划信息
+ *
+ */
+ @SerializedName("billing_plan")
+ private BillingPlan billingPlan;
+
+ /**
+ *
+ * 字段名:附加数据
+ * 变量名:attach
+ * 是否必填:否
+ * 类型:string(128)
+ * 描述:
+ * 附加数据
+ * 示例值:自定义数据
+ *
+ */
+ @SerializedName("attach")
+ private String attach;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionScheduleRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionScheduleRequest.java
new file mode 100644
index 0000000000..51cf5aebd1
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionScheduleRequest.java
@@ -0,0 +1,131 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 预约扣费请求参数
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionScheduleRequest implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:商户订单号
+ * 变量名:out_trade_no
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 字段名:用户标识
+ * 变量名:openid
+ * 是否必填:是
+ * 类型:string(128)
+ * 描述:
+ * 用户在直连商户appid下的唯一标识
+ * 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
+ *
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ *
+ * 字段名:订单描述
+ * 变量名:description
+ * 是否必填:是
+ * 类型:string(127)
+ * 描述:
+ * 订单描述
+ * 示例值:腾讯充值中心-QQ会员充值
+ *
+ */
+ @SerializedName("description")
+ private String description;
+
+ /**
+ *
+ * 字段名:预约扣费金额
+ * 变量名:amount
+ * 是否必填:是
+ * 类型:object
+ * 描述:
+ * 预约扣费金额信息
+ *
+ */
+ @SerializedName("amount")
+ private SubscriptionAmount amount;
+
+ /**
+ *
+ * 字段名:预约扣费时间
+ * 变量名:schedule_time
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 预约扣费的时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("schedule_time")
+ private String scheduleTime;
+
+ /**
+ *
+ * 字段名:扣费计划
+ * 变量名:billing_plan
+ * 是否必填:否
+ * 类型:object
+ * 描述:
+ * 扣费计划信息,用于连续包月等场景
+ *
+ */
+ @SerializedName("billing_plan")
+ private BillingPlan billingPlan;
+
+ /**
+ *
+ * 字段名:通知地址
+ * 变量名:notify_url
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 异步接收微信支付结果通知的回调地址,通知url必须为外网可访问的url,不能携带参数
+ * 示例值:https://www.weixin.qq.com/wxpay/pay.php
+ *
+ */
+ @SerializedName("notify_url")
+ private String notifyUrl;
+
+ /**
+ *
+ * 字段名:附加数据
+ * 变量名:attach
+ * 是否必填:否
+ * 类型:string(128)
+ * 描述:
+ * 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用
+ * 示例值:自定义数据
+ *
+ */
+ @SerializedName("attach")
+ private String attach;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionScheduleResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionScheduleResult.java
new file mode 100644
index 0000000000..fc0f9f6615
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionScheduleResult.java
@@ -0,0 +1,121 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 预约扣费响应结果
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionScheduleResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:预约扣费ID
+ * 变量名:subscription_id
+ * 是否必填:是
+ * 类型:string(64)
+ * 描述:
+ * 微信支付预约扣费ID
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("subscription_id")
+ private String subscriptionId;
+
+ /**
+ *
+ * 字段名:商户订单号
+ * 变量名:out_trade_no
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 商户系统内部订单号
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 字段名:预约状态
+ * 变量名:status
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 预约状态
+ * SCHEDULED:已预约
+ * CANCELLED:已取消
+ * EXECUTED:已执行
+ * FAILED:执行失败
+ * 示例值:SCHEDULED
+ *
+ */
+ @SerializedName("status")
+ private String status;
+
+ /**
+ *
+ * 字段名:预约扣费时间
+ * 变量名:schedule_time
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 预约扣费的时间,遵循rfc3339标准格式
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("schedule_time")
+ private String scheduleTime;
+
+ /**
+ *
+ * 字段名:创建时间
+ * 变量名:create_time
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 预约创建时间,遵循rfc3339标准格式
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("create_time")
+ private String createTime;
+
+ /**
+ *
+ * 字段名:预约扣费金额
+ * 变量名:amount
+ * 是否必填:是
+ * 类型:object
+ * 描述:
+ * 预约扣费金额信息
+ *
+ */
+ @SerializedName("amount")
+ private SubscriptionAmount amount;
+
+ /**
+ *
+ * 字段名:扣费计划
+ * 变量名:billing_plan
+ * 是否必填:否
+ * 类型:object
+ * 描述:
+ * 扣费计划信息
+ *
+ */
+ @SerializedName("billing_plan")
+ private BillingPlan billingPlan;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionTransactionQueryRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionTransactionQueryRequest.java
new file mode 100644
index 0000000000..17b3681cea
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionTransactionQueryRequest.java
@@ -0,0 +1,91 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 查询扣费记录请求参数
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionTransactionQueryRequest implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:用户标识
+ * 变量名:openid
+ * 是否必填:否
+ * 类型:string(128)
+ * 描述:
+ * 用户在直连商户appid下的唯一标识
+ * 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
+ *
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ *
+ * 字段名:开始时间
+ * 变量名:begin_time
+ * 是否必填:否
+ * 类型:string(32)
+ * 描述:
+ * 查询开始时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("begin_time")
+ private String beginTime;
+
+ /**
+ *
+ * 字段名:结束时间
+ * 变量名:end_time
+ * 是否必填:否
+ * 类型:string(32)
+ * 描述:
+ * 查询结束时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("end_time")
+ private String endTime;
+
+ /**
+ *
+ * 字段名:分页大小
+ * 变量名:limit
+ * 是否必填:否
+ * 类型:int
+ * 描述:
+ * 分页大小,不超过50
+ * 示例值:20
+ *
+ */
+ @SerializedName("limit")
+ private Integer limit;
+
+ /**
+ *
+ * 字段名:分页偏移量
+ * 变量名:offset
+ * 是否必填:否
+ * 类型:int
+ * 描述:
+ * 分页偏移量
+ * 示例值:0
+ *
+ */
+ @SerializedName("offset")
+ private Integer offset;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionTransactionQueryResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionTransactionQueryResult.java
new file mode 100644
index 0000000000..75fff11a22
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionTransactionQueryResult.java
@@ -0,0 +1,190 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ * 查询扣费记录响应结果
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionTransactionQueryResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:总数量
+ * 变量名:total_count
+ * 是否必填:是
+ * 类型:int
+ * 描述:
+ * 符合条件的记录总数量
+ * 示例值:100
+ *
+ */
+ @SerializedName("total_count")
+ private Integer totalCount;
+
+ /**
+ *
+ * 字段名:扣费记录列表
+ * 变量名:data
+ * 是否必填:是
+ * 类型:array
+ * 描述:
+ * 扣费记录列表
+ *
+ */
+ @SerializedName("data")
+ private List
+ * 字段名:微信支付订单号
+ * 变量名:transaction_id
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 微信支付系统生成的订单号
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 字段名:商户订单号
+ * 变量名:out_trade_no
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 商户系统内部订单号
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 字段名:预约扣费ID
+ * 变量名:subscription_id
+ * 是否必填:否
+ * 类型:string(64)
+ * 描述:
+ * 微信支付预约扣费ID,预约扣费产生的交易才有此字段
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("subscription_id")
+ private String subscriptionId;
+
+ /**
+ *
+ * 字段名:交易状态
+ * 变量名:trade_state
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 交易状态
+ * SUCCESS:支付成功
+ * REFUND:转入退款
+ * NOTPAY:未支付
+ * CLOSED:已关闭
+ * REVOKED:已撤销(刷卡支付)
+ * USERPAYING:用户支付中
+ * PAYERROR:支付失败
+ * 示例值:SUCCESS
+ *
+ */
+ @SerializedName("trade_state")
+ private String tradeState;
+
+ /**
+ *
+ * 字段名:支付完成时间
+ * 变量名:success_time
+ * 是否必填:否
+ * 类型:string(32)
+ * 描述:
+ * 支付完成时间,遵循rfc3339标准格式
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("success_time")
+ private String successTime;
+
+ /**
+ *
+ * 字段名:扣费金额
+ * 变量名:amount
+ * 是否必填:是
+ * 类型:object
+ * 描述:
+ * 扣费金额信息
+ *
+ */
+ @SerializedName("amount")
+ private SubscriptionAmount amount;
+
+ /**
+ *
+ * 字段名:用户标识
+ * 变量名:openid
+ * 是否必填:是
+ * 类型:string(128)
+ * 描述:
+ * 用户在直连商户appid下的唯一标识
+ * 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
+ *
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ *
+ * 字段名:订单描述
+ * 变量名:description
+ * 是否必填:是
+ * 类型:string(127)
+ * 描述:
+ * 订单描述
+ * 示例值:腾讯充值中心-QQ会员充值
+ *
+ */
+ @SerializedName("description")
+ private String description;
+
+ /**
+ *
+ * 字段名:附加数据
+ * 变量名:attach
+ * 是否必填:否
+ * 类型:string(128)
+ * 描述:
+ * 附加数据
+ * 示例值:自定义数据
+ *
+ */
+ @SerializedName("attach")
+ private String attach;
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/SubscriptionBillingService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/SubscriptionBillingService.java
new file mode 100644
index 0000000000..e662e4dd4f
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/SubscriptionBillingService.java
@@ -0,0 +1,105 @@
+package com.github.binarywang.wxpay.service;
+
+import com.github.binarywang.wxpay.bean.subscriptionbilling.*;
+import com.github.binarywang.wxpay.exception.WxPayException;
+
+/**
+ * 微信支付-预约扣费服务 (连续包月功能)
+ *
+ * 微信支付预约扣费功能,支持商户在用户授权的情况下,
+ * 按照约定的时间和金额,自动从用户的支付账户中扣取费用。
+ * 主要用于连续包月、订阅服务等场景。
+ *
+ * 文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-08-31
+ */
+public interface SubscriptionBillingService {
+
+ /**
+ * 预约扣费
+ *
+ * 商户可以通过该接口预约未来某个时间点的扣费。
+ * 适用于连续包月、订阅服务等场景。
+ *
+ * 文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ * 请求URL: https://api.mch.weixin.qq.com/v3/subscription-billing/schedule
+ * 请求方式: POST
+ * 是否需要证书: 是
+ *
+ *
+ * @param request 预约扣费请求参数
+ * @return 预约扣费结果
+ * @throws WxPayException 微信支付异常
+ */
+ SubscriptionScheduleResult scheduleSubscription(SubscriptionScheduleRequest request) throws WxPayException;
+
+ /**
+ * 查询预约扣费
+ *
+ * 商户可以通过该接口查询已预约的扣费信息。
+ *
+ * 文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ * 请求URL: https://api.mch.weixin.qq.com/v3/subscription-billing/schedule/{subscription_id}
+ * 请求方式: GET
+ *
+ *
+ * @param subscriptionId 预约扣费ID
+ * @return 预约扣费查询结果
+ * @throws WxPayException 微信支付异常
+ */
+ SubscriptionQueryResult querySubscription(String subscriptionId) throws WxPayException;
+
+ /**
+ * 取消预约扣费
+ *
+ * 商户可以通过该接口取消已预约的扣费。
+ *
+ * 文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ * 请求URL: https://api.mch.weixin.qq.com/v3/subscription-billing/schedule/{subscription_id}/cancel
+ * 请求方式: POST
+ * 是否需要证书: 是
+ *
+ *
+ * @param request 取消预约扣费请求参数
+ * @return 取消预约扣费结果
+ * @throws WxPayException 微信支付异常
+ */
+ SubscriptionCancelResult cancelSubscription(SubscriptionCancelRequest request) throws WxPayException;
+
+ /**
+ * 立即扣费
+ *
+ * 商户可以通过该接口立即执行扣费操作。
+ * 通常用于补扣失败的费用或者特殊情况下的即时扣费。
+ *
+ * 文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ * 请求URL: https://api.mch.weixin.qq.com/v3/subscription-billing/instant-billing
+ * 请求方式: POST
+ * 是否需要证书: 是
+ *
+ *
+ * @param request 立即扣费请求参数
+ * @return 立即扣费结果
+ * @throws WxPayException 微信支付异常
+ */
+ SubscriptionInstantBillingResult instantBilling(SubscriptionInstantBillingRequest request) throws WxPayException;
+
+ /**
+ * 查询扣费记录
+ *
+ * 商户可以通过该接口查询扣费记录。
+ *
+ * 文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ * 请求URL: https://api.mch.weixin.qq.com/v3/subscription-billing/transactions
+ * 请求方式: GET
+ *
+ *
+ * @param request 查询扣费记录请求参数
+ * @return 扣费记录查询结果
+ * @throws WxPayException 微信支付异常
+ */
+ SubscriptionTransactionQueryResult queryTransactions(SubscriptionTransactionQueryRequest request) throws WxPayException;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java
index 2cd701949b..82f05910ff 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java
@@ -337,6 +337,13 @@ public interface WxPayService {
*/
BrandMerchantTransferService getBrandMerchantTransferService();
+ /**
+ * 获取微信支付预约扣费服务类 (连续包月功能)
+ *
+ * @return the subscription billing service
+ */
+ SubscriptionBillingService getSubscriptionBillingService();
+
/**
* 设置企业付款服务类,允许开发者自定义实现类.
*
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
index 1783a833dd..4c01836bbc 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
@@ -133,6 +133,9 @@ public abstract class BaseWxPayServiceImpl implements WxPayService {
@Getter
private final BrandMerchantTransferService brandMerchantTransferService = new BrandMerchantTransferServiceImpl(this);
+ @Getter
+ private final SubscriptionBillingService subscriptionBillingService = new SubscriptionBillingServiceImpl(this);
+
@Getter
private final BusinessOperationTransferService businessOperationTransferService = new BusinessOperationTransferServiceImpl(this);
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/SubscriptionBillingServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/SubscriptionBillingServiceImpl.java
new file mode 100644
index 0000000000..45c1a9f0d2
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/SubscriptionBillingServiceImpl.java
@@ -0,0 +1,91 @@
+package com.github.binarywang.wxpay.service.impl;
+
+import com.github.binarywang.wxpay.bean.subscriptionbilling.*;
+import com.github.binarywang.wxpay.exception.WxPayException;
+import com.github.binarywang.wxpay.service.SubscriptionBillingService;
+import com.github.binarywang.wxpay.service.WxPayService;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+
+/**
+ * 微信支付-预约扣费服务实现 (连续包月功能)
+ *
+ * 微信支付预约扣费功能,支持商户在用户授权的情况下,
+ * 按照约定的时间和金额,自动从用户的支付账户中扣取费用。
+ * 主要用于连续包月、订阅服务等场景。
+ *
+ * 文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-08-31
+ */
+@Slf4j
+@RequiredArgsConstructor
+public class SubscriptionBillingServiceImpl implements SubscriptionBillingService {
+
+ private static final Gson GSON = new GsonBuilder().create();
+ private final WxPayService payService;
+
+ @Override
+ public SubscriptionScheduleResult scheduleSubscription(SubscriptionScheduleRequest request) throws WxPayException {
+ String url = String.format("%s/v3/subscription-billing/schedule", this.payService.getPayBaseUrl());
+ String response = this.payService.postV3(url, GSON.toJson(request));
+ return GSON.fromJson(response, SubscriptionScheduleResult.class);
+ }
+
+ @Override
+ public SubscriptionQueryResult querySubscription(String subscriptionId) throws WxPayException {
+ String url = String.format("%s/v3/subscription-billing/schedule/%s", this.payService.getPayBaseUrl(), subscriptionId);
+ String response = this.payService.getV3(url);
+ return GSON.fromJson(response, SubscriptionQueryResult.class);
+ }
+
+ @Override
+ public SubscriptionCancelResult cancelSubscription(SubscriptionCancelRequest request) throws WxPayException {
+ String url = String.format("%s/v3/subscription-billing/schedule/%s/cancel",
+ this.payService.getPayBaseUrl(), request.getSubscriptionId());
+ String response = this.payService.postV3(url, GSON.toJson(request));
+ return GSON.fromJson(response, SubscriptionCancelResult.class);
+ }
+
+ @Override
+ public SubscriptionInstantBillingResult instantBilling(SubscriptionInstantBillingRequest request) throws WxPayException {
+ String url = String.format("%s/v3/subscription-billing/instant-billing", this.payService.getPayBaseUrl());
+ String response = this.payService.postV3(url, GSON.toJson(request));
+ return GSON.fromJson(response, SubscriptionInstantBillingResult.class);
+ }
+
+ @Override
+ public SubscriptionTransactionQueryResult queryTransactions(SubscriptionTransactionQueryRequest request) throws WxPayException {
+ String url = String.format("%s/v3/subscription-billing/transactions", this.payService.getPayBaseUrl());
+
+ StringBuilder queryString = new StringBuilder();
+ if (request.getOpenid() != null) {
+ queryString.append("openid=").append(request.getOpenid()).append("&");
+ }
+ if (request.getBeginTime() != null) {
+ queryString.append("begin_time=").append(request.getBeginTime()).append("&");
+ }
+ if (request.getEndTime() != null) {
+ queryString.append("end_time=").append(request.getEndTime()).append("&");
+ }
+ if (request.getLimit() != null) {
+ queryString.append("limit=").append(request.getLimit()).append("&");
+ }
+ if (request.getOffset() != null) {
+ queryString.append("offset=").append(request.getOffset()).append("&");
+ }
+
+ if (queryString.length() > 0) {
+ // Remove trailing &
+ queryString.setLength(queryString.length() - 1);
+ url += "?" + queryString.toString();
+ }
+
+ String response = this.payService.getV3(url);
+ return GSON.fromJson(response, SubscriptionTransactionQueryResult.class);
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/SubscriptionBillingServiceImplTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/SubscriptionBillingServiceImplTest.java
new file mode 100644
index 0000000000..21143a47d1
--- /dev/null
+++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/SubscriptionBillingServiceImplTest.java
@@ -0,0 +1,144 @@
+package com.github.binarywang.wxpay.service.impl;
+
+import com.github.binarywang.wxpay.bean.subscriptionbilling.*;
+import com.github.binarywang.wxpay.service.SubscriptionBillingService;
+import com.github.binarywang.wxpay.service.WxPayService;
+import com.github.binarywang.wxpay.testbase.ApiTestModule;
+import com.google.inject.Inject;
+import org.testng.annotations.Guice;
+import org.testng.annotations.Test;
+
+/**
+ * 微信支付预约扣费服务测试类
+ *
* {@link cn.binarywang.wx.miniapp.api.impl.BaseWxMaServiceImpl#setRetrySleepMillis(int)}
*
+ *
+ * @return 重试间隔,单位:毫秒
*/
int getRetrySleepMillis();
/**
- * http 请求最大重试次数
+ * HTTP 请求最大重试次数
*
*
* {@link cn.binarywang.wx.miniapp.api.impl.BaseWxMaServiceImpl#setMaxRetryTimes(int)}
*
+ *
+ * @return 最大重试次数
*/
int getMaxRetryTimes();
/**
- * http client builder
+ * 获取用于创建 HTTP 客户端的 ApacheHttpClientBuilder
*
- * @return ApacheHttpClientBuilder apache http client builder
+ * @return ApacheHttpClientBuilder 实例
*/
ApacheHttpClientBuilder getApacheHttpClientBuilder();
/**
- * 是否自动刷新token
+ * 是否在 token 失效时自动刷新
*
- * @return the boolean
+ * @return 如果自动刷新则返回 true,否则返回 false
*/
boolean autoRefreshToken();
/**
- * 设置自定义的apiHost地址
- * 具体取值,可以参考https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Interface_field_description.html
+ * 设置自定义的 apiHost 地址
+ * 具体取值,可以参考 API 域名文档
*
- * @param apiHostUrl api域名地址
+ * @param apiHostUrl api 域名地址
*/
void setApiHostUrl(String apiHostUrl);
/**
- * 获取自定义的apiHost地址,用于替换原请求中的https://api.weixin.qq.com
- * 具体取值,可以参考https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Interface_field_description.html
+ * 获取自定义的 apiHost 地址,用于替换原请求中的 https://api.weixin.qq.com
+ * 具体取值,可以参考 API 域名文档
*
- * @return 自定义的api域名地址
+ * @return 自定义的 api 域名地址
*/
String getApiHostUrl();
/**
- * 获取自定义的获取accessToken地址,用于向自定义统一服务获取accessToken
+ * 获取自定义的获取 accessToken 地址,用于向自定义统一服务获取 accessToken
*
- * @return 自定义的获取accessToken地址
+ * @return 自定义的获取 accessToken 地址
*/
String getAccessTokenUrl();
/**
- * 设置自定义的获取accessToken地址 可用于设置获取accessToken的自定义服务
+ * 设置自定义的获取 accessToken 地址,可用于设置获取 accessToken 的自定义服务
*
- * @param accessTokenUrl 自定义的获取accessToken地址
+ * @param accessTokenUrl 自定义的获取 accessToken 地址
*/
void setAccessTokenUrl(String accessTokenUrl);
/**
- * 服务端API签名用到的RSA私钥【pkcs8格式,会以 -----BEGIN PRIVATE KEY-----开头, 'BEGIN RSA PRIVATE
- * KEY'的是pkcs1格式,需要转换(可用openssl转换)。 设置参考:
- * https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/getting_started/api_signature.html
+ * 服务端 API 签名用到的 RSA 私钥(pkcs8 格式,会以 -----BEGIN PRIVATE KEY----- 开头,
+ * 'BEGIN RSA PRIVATE KEY' 的是 pkcs1 格式,需要转换(可用 openssl 转换)。设置参考:
+ * API 签名文档
*
- * @return rsa private key string
+ * @return RSA 私钥字符串(pkcs8 格式)
*/
String getApiSignatureRsaPrivateKey();
/**
- * 服务端API签名用到的AES密钥
- * https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/getting_started/api_signature.html
+ * 服务端 API 签名用到的 AES 密钥
+ * API 签名文档
*
- * @return aes key string
+ * @return AES 密钥字符串
*/
String getApiSignatureAesKey();
@@ -307,6 +317,6 @@ default void updateAccessTokenBefore(WxAccessTokenEntity wxAccessTokenEntity) {}
/** 密钥对应的序号 */
String getApiSignatureRsaPrivateKeySn();
- /** 密钥对应的小程序ID (普通小程序同 appId, 托管第三方平台的是 componentAppId) */
+ /** 密钥对应的小程序 ID(普通小程序为 appId,托管第三方平台为 componentAppId) */
String getWechatMpAppid();
}
From b8d2bb345a0120818ecab31264ca8024cde92b44 Mon Sep 17 00:00:00 2001
From: Binary Wang
+ * 获取所有类目名称信息,用于给用户展示选择
+ * https://developers.weixin.qq.com/doc/oplatform/openApi/miniprogram-management/category-management/api_getallcategoryname.html
+ *
+ *
+ * @return 类目名称列表
+ * @throws WxErrorException .
+ */
+ WxOpenMaCategoryNameListResult getAllCategoryName() throws WxErrorException;
+
/**
* 获取订单页Path信息
*
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenFastMaServiceImpl.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenFastMaServiceImpl.java
index 84ff7b495c..c80ce03c3e 100644
--- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenFastMaServiceImpl.java
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenFastMaServiceImpl.java
@@ -152,6 +152,12 @@ public WxOpenResult modifyCategory(WxFastMaCategory category) throws WxErrorExce
return WxOpenGsonBuilder.create().fromJson(response, WxOpenResult.class);
}
+ @Override
+ public WxOpenMaCategoryNameListResult getAllCategoryName() throws WxErrorException {
+ String response = get(OPEN_GET_ALL_CATEGORY_NAME, "");
+ return WxOpenGsonBuilder.create().fromJson(response, WxOpenMaCategoryNameListResult.class);
+ }
+
/**
* 获取订单页Path信息
*
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenMaBasicServiceImpl.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenMaBasicServiceImpl.java
index 56d209a322..6204b1e260 100644
--- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenMaBasicServiceImpl.java
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenMaBasicServiceImpl.java
@@ -146,6 +146,12 @@ public WxOpenResult modifyCategory(WxFastMaCategory category) throws WxErrorExce
return WxOpenGsonBuilder.create().fromJson(response, WxOpenResult.class);
}
+ @Override
+ public WxOpenMaCategoryNameListResult getAllCategoryName() throws WxErrorException {
+ String response = wxMaService.get(OPEN_GET_ALL_CATEGORY_NAME, "");
+ return WxOpenGsonBuilder.create().fromJson(response, WxOpenMaCategoryNameListResult.class);
+ }
+
/**
* 获取订单页Path信息
*
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenMaCategoryNameListResult.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenMaCategoryNameListResult.java
new file mode 100644
index 0000000000..014a4ae84a
--- /dev/null
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenMaCategoryNameListResult.java
@@ -0,0 +1,75 @@
+package me.chanjar.weixin.open.bean.result;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import me.chanjar.weixin.open.util.json.WxOpenGsonBuilder;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ * 获取类目名称信息的返回结果.
+ *
+ * 预约转账批次单号查询接口响应结果
+ * 通过预约批次单号查询批量预约商家转账批次单基本信息。
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4015901167
+ *
+ *
+ * @author wanggang
+ * created on 2025/11/28
+ */
+@Data
+@NoArgsConstructor
+public class ReservationTransferBatchGetResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 【商户号】 微信支付分配的商户号
+ */
+ @SerializedName("mch_id")
+ private String mchId;
+
+ /**
+ * 【商户预约批次单号】 商户系统内部的商家预约批次单号
+ */
+ @SerializedName("out_batch_no")
+ private String outBatchNo;
+
+ /**
+ * 【微信预约批次单号】 微信预约批次单号,微信商家转账系统返回的唯一标识
+ */
+ @SerializedName("reservation_batch_no")
+ private String reservationBatchNo;
+
+ /**
+ * 【商户AppID】 商户在微信申请公众号或移动应用成功后分配的账号ID
+ */
+ @SerializedName("appid")
+ private String appid;
+
+ /**
+ * 【批次备注】 批次备注
+ */
+ @SerializedName("batch_remark")
+ private String batchRemark;
+
+ /**
+ * 【转账场景ID】 商户在商户平台-产品中心-商家转账中申请的转账场景ID
+ */
+ @SerializedName("transfer_scene_id")
+ private String transferSceneId;
+
+ /**
+ * 【批次状态】
+ * ACCEPTED: 批次已受理
+ * PROCESSING: 批次处理中
+ * FINISHED: 批次处理完成
+ * CLOSED: 批次已关闭
+ */
+ @SerializedName("batch_state")
+ private String batchState;
+
+ /**
+ * 【转账总金额】 转账金额单位为"分"
+ */
+ @SerializedName("total_amount")
+ private Integer totalAmount;
+
+ /**
+ * 【转账总笔数】 转账总笔数
+ */
+ @SerializedName("total_num")
+ private Integer totalNum;
+
+ /**
+ * 【转账成功金额】 转账成功金额单位为"分"
+ */
+ @SerializedName("success_amount")
+ private Integer successAmount;
+
+ /**
+ * 【转账成功笔数】 转账成功笔数
+ */
+ @SerializedName("success_num")
+ private Integer successNum;
+
+ /**
+ * 【转账失败金额】 转账失败金额单位为"分"
+ */
+ @SerializedName("fail_amount")
+ private Integer failAmount;
+
+ /**
+ * 【转账失败笔数】 转账失败笔数
+ */
+ @SerializedName("fail_num")
+ private Integer failNum;
+
+ /**
+ * 【批次创建时间】 批次受理成功时返回
+ * 遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE
+ */
+ @SerializedName("create_time")
+ private String createTime;
+
+ /**
+ * 【批次更新时间】 批次最后更新时间
+ * 遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE
+ */
+ @SerializedName("update_time")
+ private String updateTime;
+
+ /**
+ * 【批次关闭原因】 批次关闭原因
+ * MERCHANT_REVOCATION: 商户主动撤销
+ * OVERDUE_CLOSE: 系统超时关闭
+ */
+ @SerializedName("close_reason")
+ private String closeReason;
+
+ /**
+ * 【是否需要查询明细】
+ */
+ @SerializedName("need_query_detail")
+ private Boolean needQueryDetail;
+
+ /**
+ * 【转账明细列表】
+ */
+ @SerializedName("transfer_detail_list")
+ private List
+ * 批量预约商家转账请求参数
+ * 商户可以通过批量预约接口一次发起批量转账请求,最多可以同时向50个用户发起转账。
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4015901167
+ *
+ *
+ * @author wanggang
+ * created on 2025/11/28
+ */
+@Data
+@Builder(builderMethodName = "newBuilder")
+@NoArgsConstructor
+@AllArgsConstructor
+public class ReservationTransferBatchRequest implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 【商户AppID】 商户在微信申请公众号或移动应用成功后分配的账号ID
+ */
+ @SerializedName("appid")
+ private String appid;
+
+ /**
+ * 【商户预约批次单号】 商户系统内部的商家预约批次单号,要求此参数只能由数字、大小写字母组成,在商户系统内部唯一
+ */
+ @SerializedName("out_batch_no")
+ private String outBatchNo;
+
+ /**
+ * 【转账场景ID】 商户在商户平台-产品中心-商家转账中申请的转账场景ID
+ */
+ @SerializedName("transfer_scene_id")
+ private String transferSceneId;
+
+ /**
+ * 【批次备注】 批次备注
+ */
+ @SerializedName("batch_remark")
+ private String batchRemark;
+
+ /**
+ * 【转账总金额】 转账金额单位为"分",转账总金额必须与批次内所有转账明细金额之和保持一致,否则无法发起转账操作
+ */
+ @SerializedName("total_amount")
+ private Integer totalAmount;
+
+ /**
+ * 【转账总笔数】 转账总笔数,需要与批次内所有转账明细笔数保持一致,否则无法发起转账操作
+ */
+ @SerializedName("total_num")
+ private Integer totalNum;
+
+ /**
+ * 【转账明细列表】 转账明细列表,最多50条
+ */
+ @SerializedName("transfer_detail_list")
+ private List
+ * 批量预约商家转账响应结果
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4015901167
+ *
+ *
+ * @author wanggang
+ * created on 2025/11/28
+ */
+@Data
+@NoArgsConstructor
+public class ReservationTransferBatchResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 【商户预约批次单号】 商户系统内部的商家预约批次单号
+ */
+ @SerializedName("out_batch_no")
+ private String outBatchNo;
+
+ /**
+ * 【微信预约批次单号】 微信预约批次单号,微信商家转账系统返回的唯一标识
+ */
+ @SerializedName("reservation_batch_no")
+ private String reservationBatchNo;
+
+ /**
+ * 【批次创建时间】 批次受理成功时返回
+ * 遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE
+ */
+ @SerializedName("create_time")
+ private String createTime;
+
+ /**
+ * 【批次状态】
+ * ACCEPTED: 批次已受理
+ * PROCESSING: 批次处理中
+ * FINISHED: 批次处理完成
+ * CLOSED: 批次已关闭
+ */
+ @SerializedName("batch_state")
+ private String batchState;
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/ReservationTransferNotifyResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/ReservationTransferNotifyResult.java
new file mode 100644
index 0000000000..438354e7bd
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/ReservationTransferNotifyResult.java
@@ -0,0 +1,173 @@
+package com.github.binarywang.wxpay.bean.transfer;
+
+import com.github.binarywang.wxpay.bean.notify.OriginNotifyResponse;
+import com.github.binarywang.wxpay.bean.notify.WxPayBaseNotifyV3Result;
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ *
+ * 预约商家转账通知回调结果
+ * 预约批次单中的明细单在转账成功或转账失败时,微信会把相关结果信息发送给商户。
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4015901167
+ *
+ *
+ * @author wanggang
+ * created on 2025/11/28
+ */
+@Data
+public class ReservationTransferNotifyResult implements Serializable, WxPayBaseNotifyV3Result
+ * 商户查询用户授权信息接口响应结果
+ * 商户通过此接口可查询用户是否对商户的商家转账场景进行了授权。
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4015901167
+ *
+ *
+ * @author wanggang
+ * created on 2025/11/28
+ */
+@Data
+@NoArgsConstructor
+public class UserAuthorizationStatusResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 【商户AppID】 商户在微信申请公众号或移动应用成功后分配的账号ID
+ */
+ @SerializedName("appid")
+ private String appid;
+
+ /**
+ * 【商户号】 微信支付分配的商户号
+ */
+ @SerializedName("mch_id")
+ private String mchId;
+
+ /**
+ * 【用户标识】 用户在直连商户应用下的用户标识
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ * 【授权状态】 用户授权状态
+ * UNAUTHORIZED: 未授权
+ * AUTHORIZED: 已授权
+ */
+ @SerializedName("authorization_state")
+ private String authorizationState;
+
+ /**
+ * 【授权时间】 用户授权时间,遵循rfc3339标准格式
+ * 格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE
+ */
+ @SerializedName("authorize_time")
+ private String authorizeTime;
+
+ /**
+ * 【取消授权时间】 用户取消授权时间,遵循rfc3339标准格式
+ * 格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE
+ */
+ @SerializedName("deauthorize_time")
+ private String deauthorizeTime;
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/constant/WxPayConstants.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/constant/WxPayConstants.java
index b1a57ccc0f..ec9e14ff2d 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/constant/WxPayConstants.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/constant/WxPayConstants.java
@@ -401,6 +401,71 @@ public static class TransformBillState {
}
+
+ /**
+ * 用户授权状态
+ *
+ * @see 商户查询用户授权信息
+ */
+ @UtilityClass
+ public static class AuthorizationState {
+ /**
+ * 未授权
+ */
+ public static final String UNAUTHORIZED = "UNAUTHORIZED";
+
+ /**
+ * 已授权
+ */
+ public static final String AUTHORIZED = "AUTHORIZED";
+ }
+
+ /**
+ * 预约转账批次状态
+ *
+ * @see 批量预约商家转账
+ */
+ @UtilityClass
+ public static class ReservationBatchState {
+ /**
+ * 批次已受理
+ */
+ public static final String ACCEPTED = "ACCEPTED";
+
+ /**
+ * 批次处理中
+ */
+ public static final String PROCESSING = "PROCESSING";
+
+ /**
+ * 批次处理完成
+ */
+ public static final String FINISHED = "FINISHED";
+
+ /**
+ * 批次已关闭
+ */
+ public static final String CLOSED = "CLOSED";
+ }
+
+ /**
+ * 预约转账批次关闭原因
+ *
+ * @see 预约转账批次单号查询
+ */
+ @UtilityClass
+ public static class ReservationBatchCloseReason {
+ /**
+ * 商户主动撤销
+ */
+ public static final String MERCHANT_REVOCATION = "MERCHANT_REVOCATION";
+
+ /**
+ * 系统超时关闭
+ */
+ public static final String OVERDUE_CLOSE = "OVERDUE_CLOSE";
+ }
+
/**
* 【转账场景ID】 该笔转账使用的转账场景,可前往“商户平台-产品中心-商家转账”中申请。
*/
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/TransferService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/TransferService.java
index 01113c9506..e48e327505 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/TransferService.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/TransferService.java
@@ -189,4 +189,123 @@ public interface TransferService {
* @throws WxPayException the wx pay exception
*/
TransferBillsNotifyResult parseTransferBillsNotifyResult(String notifyData, SignatureHeader header) throws WxPayException;
+
+ // ===================== 用户授权免确认模式相关接口 =====================
+
+ /**
+ *
+ * 商户查询用户授权信息接口
+ *
+ * 商户通过此接口可查询用户是否对商户的商家转账场景进行了授权。
+ *
+ * 请求方式:GET(HTTPS)
+ * 请求地址:请求地址
+ *
+ * 文档地址:商户查询用户授权信息
+ *
+ *
+ * @param openid 用户在直连商户应用下的用户标识
+ * @param transferSceneId 转账场景ID
+ * @return UserAuthorizationStatusResult 用户授权信息
+ * @throws WxPayException .
+ */
+ UserAuthorizationStatusResult getUserAuthorizationStatus(String openid, String transferSceneId) throws WxPayException;
+
+ /**
+ *
+ * 批量预约商家转账接口
+ *
+ * 商户可以通过批量预约接口一次发起批量转账请求,最多可以同时向50个用户发起转账。
+ * 批量预约接口适用于用户已授权免确认的场景,在转账时无需用户确认即可完成转账。
+ *
+ * 请求方式:POST(HTTPS)
+ * 请求地址:请求地址
+ *
+ * 文档地址:批量预约商家转账
+ *
+ *
+ * @param request 批量预约商家转账请求参数
+ * @return ReservationTransferBatchResult 批量预约商家转账结果
+ * @throws WxPayException .
+ */
+ ReservationTransferBatchResult reservationTransferBatch(ReservationTransferBatchRequest request) throws WxPayException;
+
+ /**
+ *
+ * 商户预约批次单号查询批次单接口
+ *
+ * 通过商户预约批次单号查询批量预约商家转账批次单基本信息。
+ *
+ * 请求方式:GET(HTTPS)
+ * 请求地址:请求地址
+ *
+ * 文档地址:商户预约批次单号查询批次单
+ *
+ *
+ * @param outBatchNo 商户预约批次单号
+ * @param needQueryDetail 是否需要查询明细
+ * @param offset 分页偏移量
+ * @param limit 分页大小
+ * @param detailState 明细状态(PROCESSING/SUCCESS/FAIL)
+ * @return ReservationTransferBatchGetResult 批量预约商家转账批次查询结果
+ * @throws WxPayException .
+ */
+ ReservationTransferBatchGetResult getReservationTransferBatchByOutBatchNo(String outBatchNo, Boolean needQueryDetail,
+ Integer offset, Integer limit, String detailState) throws WxPayException;
+
+ /**
+ *
+ * 微信预约批次单号查询批次单接口
+ *
+ * 通过微信预约批次单号查询批量预约商家转账批次单基本信息。
+ *
+ * 请求方式:GET(HTTPS)
+ * 请求地址:请求地址
+ *
+ * 文档地址:微信预约批次单号查询批次单
+ *
+ *
+ * @param reservationBatchNo 微信预约批次单号
+ * @param needQueryDetail 是否需要查询明细
+ * @param offset 分页偏移量
+ * @param limit 分页大小
+ * @param detailState 明细状态(PROCESSING/SUCCESS/FAIL)
+ * @return ReservationTransferBatchGetResult 批量预约商家转账批次查询结果
+ * @throws WxPayException .
+ */
+ ReservationTransferBatchGetResult getReservationTransferBatchByReservationBatchNo(String reservationBatchNo, Boolean needQueryDetail,
+ Integer offset, Integer limit, String detailState) throws WxPayException;
+
+ /**
+ *
+ * 解析预约商家转账通知回调结果
+ *
+ * 预约批次单中的明细单在转账成功或转账失败时,微信会把相关结果信息发送给商户。
+ *
+ * 文档地址:预约商家转账通知
+ *
+ *
+ * @param notifyData 通知数据
+ * @param header 通知头部数据,不传则表示不校验头
+ * @return ReservationTransferNotifyResult 预约商家转账通知结果
+ * @throws WxPayException the wx pay exception
+ */
+ ReservationTransferNotifyResult parseReservationTransferNotifyResult(String notifyData, SignatureHeader header) throws WxPayException;
+
+ /**
+ *
+ * 关闭预约商家转账批次接口
+ *
+ * 商户可以通过此接口关闭预约商家转账批次单。关闭后,该批次内所有未成功的转账将被取消。
+ *
+ * 请求方式:POST(HTTPS)
+ * 请求地址:请求地址
+ *
+ * 文档地址:关闭预约商家转账批次
+ *
+ *
+ * @param outBatchNo 商户预约批次单号
+ * @throws WxPayException .
+ */
+ void closeReservationTransferBatch(String outBatchNo) throws WxPayException;
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/TransferServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/TransferServiceImpl.java
index 038af32b87..fe05ab89ad 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/TransferServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/TransferServiceImpl.java
@@ -124,4 +124,85 @@ public TransferBillsGetResult getBillsByTransferBillNo(String transferBillNo) th
public TransferBillsNotifyResult parseTransferBillsNotifyResult(String notifyData, SignatureHeader header) throws WxPayException {
return this.payService.baseParseOrderNotifyV3Result(notifyData, header, TransferBillsNotifyResult.class, TransferBillsNotifyResult.DecryptNotifyResult.class);
}
+
+ // ===================== 用户授权免确认模式相关接口实现 =====================
+
+ @Override
+ public UserAuthorizationStatusResult getUserAuthorizationStatus(String openid, String transferSceneId) throws WxPayException {
+ String url = String.format("%s/v3/fund-app/mch-transfer/authorization/openid/%s?transfer_scene_id=%s",
+ this.payService.getPayBaseUrl(), openid, transferSceneId);
+ String result = this.payService.getV3(url);
+ return GSON.fromJson(result, UserAuthorizationStatusResult.class);
+ }
+
+ @Override
+ public ReservationTransferBatchResult reservationTransferBatch(ReservationTransferBatchRequest request) throws WxPayException {
+ String url = String.format("%s/v3/fund-app/mch-transfer/reservation/transfer-batches", this.payService.getPayBaseUrl());
+ List
+ * 微信支付-服务商申请退款.
+ * 应用场景
+ * 当交易发生之后一年内,由于买家或者卖家的原因需要退款时,卖家可以通过退款接口将支付金额退还给买家,微信支付将在收到退款请求并且验证成功之后,将支付款按原路退还至买家账号上。
+ *
+ * 注意:
+ * 1、交易时间超过一年的订单无法提交退款
+ * 2、微信支付退款支持单笔交易分多次退款(不超50次),多次退款需要提交原支付订单的商户订单号和设置不同的退款单号。申请退款总金额不能超过订单金额。 一笔退款失败后重新提交,请不要更换退款单号,请使用原商户退款单号
+ * 3、错误或无效请求频率限制:6qps,即每秒钟异常或错误的退款申请请求不超过6次
+ * 4、每个支付订单的部分退款次数不能超过50次
+ * 5、如果同一个用户有多笔退款,建议分不同批次进行退款,避免并发退款导致退款失败
+ * 6、申请退款接口的返回仅代表业务的受理情况,具体退款是否成功,需要通过退款查询接口获取结果
+ * 7、一个月之前的订单申请退款频率限制为:5000/min
+ *
+ * 详见 https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_1_9.shtml
+ * 接口地址
+ * https://api.mch.weixin.qq.com/v3/refund/domestic/refunds
+ *
+ *
+ * @param request 请求对象
+ * @return 退款操作结果 wx pay refund result
+ * @throws WxPayException the wx pay exception
+ */
+ WxPayRefundV3Result partnerRefundV3(WxPayPartnerRefundV3Request request) throws WxPayException;
+
/**
*
* 微信支付-查询退款.
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
index 4c01836bbc..ba3dc37144 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
@@ -264,6 +264,16 @@ public WxPayRefundV3Result refundV3(WxPayRefundV3Request request) throws WxPayEx
return GSON.fromJson(response, WxPayRefundV3Result.class);
}
+ @Override
+ public WxPayRefundV3Result partnerRefundV3(WxPayPartnerRefundV3Request request) throws WxPayException {
+ if (StringUtils.isBlank(request.getSubMchid())) {
+ request.setSubMchid(this.getConfig().getSubMchId());
+ }
+ String url = String.format("%s/v3/refund/domestic/refunds", this.getPayBaseUrl());
+ String response = this.postV3WithWechatpaySerial(url, GSON.toJson(request));
+ return GSON.fromJson(response, WxPayRefundV3Result.class);
+ }
+
@Override
public WxPayRefundQueryResult refundQuery(String transactionId, String outTradeNo, String outRefundNo, String refundId)
throws WxPayException {
From 1f4ed687507ab52a34eb0843eef0da3b6f0dae61 Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Fri, 28 Nov 2025 11:29:22 +0800
Subject: [PATCH 094/208] =?UTF-8?q?:art:=20#3750=20=E3=80=90=E5=BE=AE?=
=?UTF-8?q?=E4=BF=A1=E6=94=AF=E4=BB=98=E3=80=91=E4=BF=AE=E5=A4=8D=20V2=20?=
=?UTF-8?q?=E6=94=AF=E4=BB=98=E5=9B=9E=E8=B0=83=E7=AD=BE=E5=90=8D=E9=AA=8C?=
=?UTF-8?q?=E8=AF=81=E5=A4=B1=E8=B4=A5=E7=9A=84=E9=97=AE=E9=A2=98?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../bean/notify/WxPayOrderNotifyResult.java | 4 +-
.../WxPayOrderNotifyUnknownFieldTest.java | 104 ++++++++++++++++++
2 files changed, 107 insertions(+), 1 deletion(-)
create mode 100644 weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/notify/WxPayOrderNotifyUnknownFieldTest.java
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayOrderNotifyResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayOrderNotifyResult.java
index 27e8c1e1ec..8f16e5d4e4 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayOrderNotifyResult.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayOrderNotifyResult.java
@@ -342,7 +342,9 @@ public static WxPayOrderNotifyResult fromXML(String xmlString) {
@Override
public Map
+ * 查询投诉单列表API
+ * 商户可通过调用此接口,查询指定时间段的所有用户投诉信息,以分页输出查询结果。
+ * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html
+ *
+ *
+ * @param request {@link WxMaComplaintRequest} 查询投诉单列表请求数据
+ * @return {@link WxMaComplaintResult} 微信返回的投诉单列表
+ * @throws WxErrorException the wx error exception
+ */
+ WxMaComplaintResult queryComplaints(WxMaComplaintRequest request) throws WxErrorException;
+
+ /**
+ *
+ * 查询投诉单详情API
+ * 商户可通过调用此接口,查询指定投诉单的用户投诉详情,包含投诉内容、投诉关联订单、投诉人联系方式等信息,方便商户处理投诉。
+ * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html
+ *
+ *
+ * @param request {@link WxMaComplaintDetailRequest} 投诉单详情请求数据
+ * @return {@link WxMaComplaintDetailResult} 微信返回的投诉单详情
+ * @throws WxErrorException the wx error exception
+ */
+ WxMaComplaintDetailResult getComplaint(WxMaComplaintDetailRequest request) throws WxErrorException;
+
+ /**
+ *
+ * 查询投诉协商历史API
+ * 商户可通过调用此接口,查询指定投诉的用户商户协商历史,以分页输出查询结果,方便商户根据处理历史来制定后续处理方案。
+ * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html
+ *
+ *
+ * @param request {@link WxMaNegotiationHistoryRequest} 请求数据
+ * @return {@link WxMaNegotiationHistoryResult} 微信返回结果
+ * @throws WxErrorException the wx error exception
+ */
+ WxMaNegotiationHistoryResult queryNegotiationHistorys(WxMaNegotiationHistoryRequest request) throws WxErrorException;
+
+ /**
+ *
+ * 创建投诉通知回调地址API
+ * 商户通过调用此接口创建投诉通知回调URL,当用户产生新投诉且投诉状态已变更时,微信会通过回调URL通知商户。
+ * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html
+ *
+ *
+ * @param request {@link WxMaComplaintNotifyUrlRequest} 请求数据
+ * @return {@link WxMaComplaintNotifyUrlResult} 微信返回结果
+ * @throws WxErrorException the wx error exception
+ */
+ WxMaComplaintNotifyUrlResult addComplaintNotifyUrl(WxMaComplaintNotifyUrlRequest request) throws WxErrorException;
+
+ /**
+ *
+ * 查询投诉通知回调地址API
+ * 商户通过调用此接口查询投诉通知的回调URL。
+ * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html
+ *
+ *
+ * @return {@link WxMaComplaintNotifyUrlResult} 微信返回结果
+ * @throws WxErrorException the wx error exception
+ */
+ WxMaComplaintNotifyUrlResult getComplaintNotifyUrl() throws WxErrorException;
+
+ /**
+ *
+ * 更新投诉通知回调地址API
+ * 商户通过调用此接口更新投诉通知的回调URL。
+ * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html
+ *
+ *
+ * @param request {@link WxMaComplaintNotifyUrlRequest} 请求数据
+ * @return {@link WxMaComplaintNotifyUrlResult} 微信返回结果
+ * @throws WxErrorException the wx error exception
+ */
+ WxMaComplaintNotifyUrlResult updateComplaintNotifyUrl(WxMaComplaintNotifyUrlRequest request) throws WxErrorException;
+
+ /**
+ *
+ * 删除投诉通知回调地址API
+ * 当商户不再需要推送通知时,可通过调用此接口删除投诉通知的回调URL,取消通知回调。
+ * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html
+ *
+ *
+ * @throws WxErrorException the wx error exception
+ */
+ void deleteComplaintNotifyUrl() throws WxErrorException;
+
+ /**
+ *
+ * 提交回复API
+ * 商户可通过调用此接口,提交回复内容。其中上传图片凭证需首先调用商户上传反馈图片接口,得到图片id,再将id填入请求。
+ * 回复可配置文字链,传入跳转链接文案和跳转链接字段,用户点击即可跳转对应页面
+ * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html
+ *
+ *
+ * @param request {@link WxMaResponseRequest} 请求数据
+ * @throws WxErrorException the wx error exception
+ */
+ void submitResponse(WxMaResponseRequest request) throws WxErrorException;
+
+ /**
+ *
+ * 反馈处理完成API
+ * 商户可通过调用此接口,反馈投诉单已处理完成。
+ * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html
+ *
+ *
+ * @param request {@link WxMaCompleteRequest} 请求数据
+ * @throws WxErrorException the wx error exception
+ */
+ void complete(WxMaCompleteRequest request) throws WxErrorException;
+
+ /**
+ *
+ * 商户上传反馈图片API
+ * 商户可通过调用此接口上传反馈图片凭证,上传成功后可在提交回复时使用。
+ * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html
+ *
+ *
+ * @param imageFile 需要上传的图片文件
+ * @return String 微信返回的媒体文件标识Id
+ * @throws WxErrorException the wx error exception
+ * @throws IOException IO异常
+ */
+ String uploadResponseImage(File imageFile) throws WxErrorException, IOException;
+
+ /**
+ *
+ * 商户上传反馈图片API
+ * 商户可通过调用此接口上传反馈图片凭证,上传成功后可在提交回复时使用。
+ * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html
+ *
+ *
+ * @param inputStream 需要上传的图片文件流
+ * @param fileName 需要上传的图片文件名
+ * @return String 微信返回的媒体文件标识Id
+ * @throws WxErrorException the wx error exception
+ * @throws IOException IO异常
+ */
+ String uploadResponseImage(InputStream inputStream, String fileName) throws WxErrorException, IOException;
+}
\ No newline at end of file
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaService.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaService.java
index ef3a46bad9..1b556da81f 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaService.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaService.java
@@ -605,4 +605,13 @@ WxMaApiResponse execute(
* @return 同城配送服务对象WxMaIntracityService
*/
WxMaIntracityService getIntracityService();
+
+ /**
+ * 获取交易投诉服务对象。
+ *
+ * 文档:https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html
+ *
+ * @return 交易投诉服务对象WxMaComplaintService
+ */
+ WxMaComplaintService getComplaintService();
}
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java
index ec33dede0c..28acb38472 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java
@@ -165,6 +165,7 @@ public abstract class BaseWxMaServiceImpl
+ * 字段名:投诉单号
+ * 是否必填:是
+ * 描述:投诉单对应的投诉单号
+ *
+ */
+ @SerializedName("complaint_id")
+ private String complaintId;
+
+ public String toJson() {
+ return WxMaGsonBuilder.create().toJson(this);
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintDetailResult.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintDetailResult.java
new file mode 100644
index 0000000000..52a0be1704
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintDetailResult.java
@@ -0,0 +1,166 @@
+package cn.binarywang.wx.miniapp.bean.complaint;
+
+import cn.binarywang.wx.miniapp.bean.WxMaBaseResponse;
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ * 小程序投诉单详情结果
+ *
+ * @author Binary Wang
+ * created on 2025-01-01
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class WxMaComplaintDetailResult extends WxMaBaseResponse {
+
+ /**
+ *
+ * 字段名:投诉单号
+ * 是否必填:是
+ * 描述:投诉单对应的投诉单号
+ *
+ */
+ @SerializedName("complaint_id")
+ private String complaintId;
+
+ /**
+ *
+ * 字段名:投诉时间
+ * 是否必填:是
+ * 描述:用户提交投诉的时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE
+ *
+ */
+ @SerializedName("complaint_time")
+ private String complaintTime;
+
+ /**
+ *
+ * 字段名:投诉详情
+ * 是否必填:是
+ * 描述:用户提交的投诉详情
+ *
+ */
+ @SerializedName("complaint_detail")
+ private String complaintDetail;
+
+ /**
+ *
+ * 字段名:投诉状态
+ * 是否必填:是
+ * 描述:投诉单状态:WAITING_MERCHANT_RESPONSE-等待商户回复 MERCHANT_RESPONSED-商户已回复 WAITING_USER_RESPONSE-等待用户回复 USER_RESPONSED-用户已回复 COMPLAINT_COMPLETED-投诉已完成
+ *
+ */
+ @SerializedName("complaint_state")
+ private String complaintState;
+
+ /**
+ *
+ * 字段名:投诉人openid
+ * 是否必填:是
+ * 描述:投诉人在小程序的openid
+ *
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ *
+ * 字段名:投诉人联系方式
+ * 是否必填:否
+ * 描述:投诉人联系方式,可能为空
+ *
+ */
+ @SerializedName("phone_number")
+ private String phoneNumber;
+
+ /**
+ *
+ * 字段名:被投诉订单信息
+ * 是否必填:是
+ * 描述:被投诉的订单信息
+ *
+ */
+ @SerializedName("complaint_order_info")
+ private ComplaintOrderInfo complaintOrderInfo;
+
+ /**
+ *
+ * 字段名:投诉材料
+ * 是否必填:否
+ * 描述:用户上传的投诉相关的图片凭证
+ *
+ */
+ @SerializedName("complaint_media_list")
+ private List
+ * 字段名:商户订单号
+ * 是否必填:是
+ * 描述:商户系统内部订单号
+ *
+ */
+ @SerializedName("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 字段名:微信订单号
+ * 是否必填:是
+ * 描述:微信支付系统生成的订单号
+ *
+ */
+ @SerializedName("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 字段名:订单金额
+ * 是否必填:是
+ * 描述:订单金额,单位为分
+ *
+ */
+ @SerializedName("amount")
+ private Integer amount;
+ }
+
+ /**
+ * 投诉材料
+ */
+ @Data
+ public static class ComplaintMedia implements Serializable {
+ private static final long serialVersionUID = 3244929701614280806L;
+
+ /**
+ *
+ * 字段名:媒体文件业务类型
+ * 是否必填:是
+ * 描述:媒体文件对应的业务类型:USER_COMPLAINT_IMAGE-用户投诉图片
+ *
+ */
+ @SerializedName("media_type")
+ private String mediaType;
+
+ /**
+ *
+ * 字段名:媒体文件请求URL
+ * 是否必填:是
+ * 描述:微信返回的媒体文件请求URL,通过该URL可以获取到对应的媒体文件(图片、视频等)
+ *
+ */
+ @SerializedName("media_url")
+ private String mediaUrl;
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintNotifyUrlRequest.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintNotifyUrlRequest.java
new file mode 100644
index 0000000000..6af338c974
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintNotifyUrlRequest.java
@@ -0,0 +1,38 @@
+package cn.binarywang.wx.miniapp.bean.complaint;
+
+import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder;
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 小程序投诉通知回调URL请求实体
+ *
+ * @author Binary Wang
+ * created on 2025-01-01
+ */
+@Data
+@Builder(builderMethodName = "newBuilder")
+@NoArgsConstructor
+@AllArgsConstructor
+public class WxMaComplaintNotifyUrlRequest implements Serializable {
+ private static final long serialVersionUID = 3244929701614280806L;
+
+ /**
+ *
+ * 字段名:通知地址
+ * 是否必填:是
+ * 描述:通知地址,仅支持https
+ *
+ */
+ @SerializedName("url")
+ private String url;
+
+ public String toJson() {
+ return WxMaGsonBuilder.create().toJson(this);
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintNotifyUrlResult.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintNotifyUrlResult.java
new file mode 100644
index 0000000000..7771998b80
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintNotifyUrlResult.java
@@ -0,0 +1,37 @@
+package cn.binarywang.wx.miniapp.bean.complaint;
+
+import cn.binarywang.wx.miniapp.bean.WxMaBaseResponse;
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+/**
+ * 小程序投诉通知回调URL结果
+ *
+ * @author Binary Wang
+ * created on 2025-01-01
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class WxMaComplaintNotifyUrlResult extends WxMaBaseResponse {
+
+ /**
+ *
+ * 字段名:通知地址
+ * 是否必填:是
+ * 描述:通知地址,仅支持https
+ *
+ */
+ @SerializedName("url")
+ private String url;
+
+ /**
+ *
+ * 字段名:签名串
+ * 是否必填:是
+ * 描述:用于验证通知消息的签名串
+ *
+ */
+ @SerializedName("signature")
+ private String signature;
+}
\ No newline at end of file
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintRequest.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintRequest.java
new file mode 100644
index 0000000000..9ac45e0c12
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintRequest.java
@@ -0,0 +1,70 @@
+package cn.binarywang.wx.miniapp.bean.complaint;
+
+import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder;
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 小程序交易投诉查询请求实体
+ *
+ * @author Binary Wang
+ * created on 2025-01-01
+ */
+@Data
+@Builder(builderMethodName = "newBuilder")
+@NoArgsConstructor
+@AllArgsConstructor
+public class WxMaComplaintRequest implements Serializable {
+ private static final long serialVersionUID = 3244929701614280806L;
+
+ /**
+ *
+ * 字段名:开始日期
+ * 是否必填:是
+ * 描述:查询的起始时间,格式为YYYY-MM-DD,例如2021-01-01
+ *
+ */
+ @SerializedName("begin_date")
+ private String beginDate;
+
+ /**
+ *
+ * 字段名:结束日期
+ * 是否必填:是
+ * 描述:查询的结束时间,格式为YYYY-MM-DD,例如2021-01-31
+ *
+ */
+ @SerializedName("end_date")
+ private String endDate;
+
+ /**
+ *
+ * 字段名:分页大小
+ * 是否必填:否
+ * 描述:单次拉取条目,最大为50,不传默认为10
+ *
+ */
+ @SerializedName("limit")
+ @Builder.Default
+ private Integer limit = 10;
+
+ /**
+ *
+ * 字段名:分页开始位置
+ * 是否必填:否
+ * 描述:该次请求的分页开始位置,从0开始计数,例如offset=10,表示从第11条记录开始返回,不传默认为0
+ *
+ */
+ @SerializedName("offset")
+ @Builder.Default
+ private Integer offset = 0;
+
+ public String toJson() {
+ return WxMaGsonBuilder.create().toJson(this);
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintResult.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintResult.java
new file mode 100644
index 0000000000..0e4208fdc1
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintResult.java
@@ -0,0 +1,156 @@
+package cn.binarywang.wx.miniapp.bean.complaint;
+
+import cn.binarywang.wx.miniapp.bean.WxMaBaseResponse;
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ * 小程序交易投诉查询结果
+ *
+ * @author Binary Wang
+ * created on 2025-01-01
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class WxMaComplaintResult extends WxMaBaseResponse {
+
+ /**
+ *
+ * 字段名:投诉单信息
+ * 是否必填:是
+ * 描述:查询返回的投诉单信息
+ *
+ */
+ @SerializedName("data")
+ private List
+ * 字段名:总数
+ * 是否必填:是
+ * 描述:总投诉单条数,用于分页展示
+ *
+ */
+ @SerializedName("total_count")
+ private Integer totalCount;
+
+ /**
+ * 投诉单信息
+ */
+ @Data
+ public static class Complaint implements Serializable {
+ private static final long serialVersionUID = 3244929701614280806L;
+
+ /**
+ *
+ * 字段名:投诉单号
+ * 是否必填:是
+ * 描述:投诉单对应的投诉单号
+ *
+ */
+ @SerializedName("complaint_id")
+ private String complaintId;
+
+ /**
+ *
+ * 字段名:投诉时间
+ * 是否必填:是
+ * 描述:用户提交投诉的时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE
+ *
+ */
+ @SerializedName("complaint_time")
+ private String complaintTime;
+
+ /**
+ *
+ * 字段名:投诉详情
+ * 是否必填:是
+ * 描述:用户提交的投诉详情
+ *
+ */
+ @SerializedName("complaint_detail")
+ private String complaintDetail;
+
+ /**
+ *
+ * 字段名:投诉状态
+ * 是否必填:是
+ * 描述:投诉单状态:WAITING_MERCHANT_RESPONSE-等待商户回复 MERCHANT_RESPONSED-商户已回复 WAITING_USER_RESPONSE-等待用户回复 USER_RESPONSED-用户已回复 COMPLAINT_COMPLETED-投诉已完成
+ *
+ */
+ @SerializedName("complaint_state")
+ private String complaintState;
+
+ /**
+ *
+ * 字段名:投诉人openid
+ * 是否必填:是
+ * 描述:投诉人在小程序的openid
+ *
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ *
+ * 字段名:投诉人联系方式
+ * 是否必填:否
+ * 描述:投诉人联系方式,可能为空
+ *
+ */
+ @SerializedName("phone_number")
+ private String phoneNumber;
+
+ /**
+ *
+ * 字段名:被投诉订单信息
+ * 是否必填:是
+ * 描述:被投诉的订单信息
+ *
+ */
+ @SerializedName("complaint_order_info")
+ private ComplaintOrderInfo complaintOrderInfo;
+ }
+
+ /**
+ * 被投诉订单信息
+ */
+ @Data
+ public static class ComplaintOrderInfo implements Serializable {
+ private static final long serialVersionUID = 3244929701614280806L;
+
+ /**
+ *
+ * 字段名:商户订单号
+ * 是否必填:是
+ * 描述:商户系统内部订单号
+ *
+ */
+ @SerializedName("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 字段名:微信订单号
+ * 是否必填:是
+ * 描述:微信支付系统生成的订单号
+ *
+ */
+ @SerializedName("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 字段名:订单金额
+ * 是否必填:是
+ * 描述:订单金额,单位为分
+ *
+ */
+ @SerializedName("amount")
+ private Integer amount;
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaCompleteRequest.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaCompleteRequest.java
new file mode 100644
index 0000000000..71d1066024
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaCompleteRequest.java
@@ -0,0 +1,38 @@
+package cn.binarywang.wx.miniapp.bean.complaint;
+
+import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder;
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 小程序反馈处理完成请求实体
+ *
+ * @author Binary Wang
+ * created on 2025-01-01
+ */
+@Data
+@Builder(builderMethodName = "newBuilder")
+@NoArgsConstructor
+@AllArgsConstructor
+public class WxMaCompleteRequest implements Serializable {
+ private static final long serialVersionUID = 3244929701614280806L;
+
+ /**
+ *
+ * 字段名:投诉单号
+ * 是否必填:是
+ * 描述:投诉单对应的投诉单号
+ *
+ */
+ @SerializedName("complaint_id")
+ private String complaintId;
+
+ public String toJson() {
+ return WxMaGsonBuilder.create().toJson(this);
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaNegotiationHistoryRequest.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaNegotiationHistoryRequest.java
new file mode 100644
index 0000000000..a03742b6af
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaNegotiationHistoryRequest.java
@@ -0,0 +1,60 @@
+package cn.binarywang.wx.miniapp.bean.complaint;
+
+import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder;
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 小程序查询投诉协商历史请求实体
+ *
+ * @author Binary Wang
+ * created on 2025-01-01
+ */
+@Data
+@Builder(builderMethodName = "newBuilder")
+@NoArgsConstructor
+@AllArgsConstructor
+public class WxMaNegotiationHistoryRequest implements Serializable {
+ private static final long serialVersionUID = 3244929701614280806L;
+
+ /**
+ *
+ * 字段名:投诉单号
+ * 是否必填:是
+ * 描述:投诉单对应的投诉单号
+ *
+ */
+ @SerializedName("complaint_id")
+ private String complaintId;
+
+ /**
+ *
+ * 字段名:分页大小
+ * 是否必填:否
+ * 描述:单次拉取条目,最大为50,不传默认为10
+ *
+ */
+ @SerializedName("limit")
+ @Builder.Default
+ private Integer limit = 10;
+
+ /**
+ *
+ * 字段名:分页开始位置
+ * 是否必填:否
+ * 描述:该次请求的分页开始位置,从0开始计数,例如offset=10,表示从第11条记录开始返回,不传默认为0
+ *
+ */
+ @SerializedName("offset")
+ @Builder.Default
+ private Integer offset = 0;
+
+ public String toJson() {
+ return WxMaGsonBuilder.create().toJson(this);
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaNegotiationHistoryResult.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaNegotiationHistoryResult.java
new file mode 100644
index 0000000000..194daca9ff
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaNegotiationHistoryResult.java
@@ -0,0 +1,88 @@
+package cn.binarywang.wx.miniapp.bean.complaint;
+
+import cn.binarywang.wx.miniapp.bean.WxMaBaseResponse;
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ * 小程序查询投诉协商历史结果
+ *
+ * @author Binary Wang
+ * created on 2025-01-01
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class WxMaNegotiationHistoryResult extends WxMaBaseResponse {
+
+ /**
+ *
+ * 字段名:协商历史
+ * 是否必填:是
+ * 描述:协商历史记录
+ *
+ */
+ @SerializedName("data")
+ private List
+ * 字段名:总数
+ * 是否必填:是
+ * 描述:总协商历史条数,用于分页展示
+ *
+ */
+ @SerializedName("total_count")
+ private Integer totalCount;
+
+ /**
+ * 协商历史
+ */
+ @Data
+ public static class NegotiationHistory implements Serializable {
+ private static final long serialVersionUID = 3244929701614280806L;
+
+ /**
+ *
+ * 字段名:操作时间
+ * 是否必填:是
+ * 描述:操作时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE
+ *
+ */
+ @SerializedName("operate_time")
+ private String operateTime;
+
+ /**
+ *
+ * 字段名:操作类型
+ * 是否必填:是
+ * 描述:操作类型:USER_CREATE_COMPLAINT-用户提交投诉 USER_CONTINUE_COMPLAINT-用户继续投诉 MERCHANT_RESPONSE-商户回复 MERCHANT_CONFIRM_COMPLETE-商户确认完成处理
+ *
+ */
+ @SerializedName("operate_type")
+ private String operateType;
+
+ /**
+ *
+ * 字段名:操作内容
+ * 是否必填:是
+ * 描述:具体的操作内容
+ *
+ */
+ @SerializedName("operate_details")
+ private String operateDetails;
+
+ /**
+ *
+ * 字段名:图片凭证
+ * 是否必填:否
+ * 描述:操作过程中上传的图片凭证
+ *
+ */
+ @SerializedName("image_list")
+ private List
+ * 字段名:投诉单号
+ * 是否必填:是
+ * 描述:投诉单对应的投诉单号
+ *
+ */
+ @SerializedName("complaint_id")
+ private String complaintId;
+
+ /**
+ *
+ * 字段名:回复内容
+ * 是否必填:是
+ * 描述:具体的回复内容,长度不超过200字符
+ *
+ */
+ @SerializedName("response_content")
+ private String responseContent;
+
+ /**
+ *
+ * 字段名:回复图片
+ * 是否必填:否
+ * 描述:回复的图片凭证,最多可传5张图片,由图片上传接口返回
+ *
+ */
+ @SerializedName("response_images")
+ private List
+ * 字段名:跳转链接
+ * 是否必填:否
+ * 描述:点击跳转链接
+ *
+ */
+ @SerializedName("jump_url")
+ private String jumpUrl;
+
+ /**
+ *
+ * 字段名:跳转链接文案
+ * 是否必填:否
+ * 描述:跳转链接文案,在response_content中展示的跳转链接文案,长度不超过10个字符
+ *
+ */
+ @SerializedName("jump_url_text")
+ private String jumpUrlText;
+
+ public String toJson() {
+ return WxMaGsonBuilder.create().toJson(this);
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/constant/WxMaApiUrlConstants.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/constant/WxMaApiUrlConstants.java
index 79806dbd84..ea9b123fb9 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/constant/WxMaApiUrlConstants.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/constant/WxMaApiUrlConstants.java
@@ -964,4 +964,34 @@ public interface Intracity {
String GET_CITY = "https://api.weixin.qq.com/cgi-bin/express/intracity/getcity";
}
+
+ /**
+ * 小程序交易投诉接口
+ *
+ *
+ * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html
+ *
+ */
+ public interface Complaint {
+ /** 查询投诉单列表 */
+ String QUERY_COMPLAINTS_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/list";
+ /** 查询投诉单详情 */
+ String GET_COMPLAINT_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/detail";
+ /** 查询投诉协商历史 */
+ String QUERY_NEGOTIATION_HISTORY_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/negotiation/history";
+ /** 创建投诉通知回调地址 */
+ String ADD_COMPLAINT_NOTIFY_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/notify/add";
+ /** 查询投诉通知回调地址 */
+ String GET_COMPLAINT_NOTIFY_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/notify/get";
+ /** 更新投诉通知回调地址 */
+ String UPDATE_COMPLAINT_NOTIFY_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/notify/update";
+ /** 删除投诉通知回调地址 */
+ String DELETE_COMPLAINT_NOTIFY_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/notify/delete";
+ /** 提交回复 */
+ String SUBMIT_RESPONSE_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/response";
+ /** 反馈处理完成 */
+ String COMPLETE_COMPLAINT_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/complete";
+ /** 上传反馈图片 */
+ String UPLOAD_RESPONSE_IMAGE_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/upload";
+ }
}
From 8f20f3babac5ac22c581206abde83d17999ecccb Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Fri, 28 Nov 2025 11:49:15 +0800
Subject: [PATCH 096/208] =?UTF-8?q?:new:=20#3678=20=E3=80=90=E5=B0=8F?=
=?UTF-8?q?=E7=A8=8B=E5=BA=8F=E3=80=91=E6=96=B0=E5=A2=9E=E5=AE=A2=E6=9C=8D?=
=?UTF-8?q?=E7=AE=A1=E7=90=86=E7=9B=B8=E5=85=B3=E6=8E=A5=E5=8F=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
MINIAPP_KEFU_SERVICE.md | 80 +++++++++++
.../wx/miniapp/api/WxMaKefuService.java | 128 ++++++++++++++++++
.../wx/miniapp/api/WxMaService.java | 7 +
.../miniapp/api/impl/BaseWxMaServiceImpl.java | 6 +
.../miniapp/api/impl/WxMaKefuServiceImpl.java | 92 +++++++++++++
.../wx/miniapp/bean/kefu/WxMaKfInfo.java | 79 +++++++++++
.../wx/miniapp/bean/kefu/WxMaKfList.java | 35 +++++
.../wx/miniapp/bean/kefu/WxMaKfSession.java | 43 ++++++
.../miniapp/bean/kefu/WxMaKfSessionList.java | 61 +++++++++
.../kefu/request/WxMaKfAccountRequest.java | 49 +++++++
.../kefu/request/WxMaKfSessionRequest.java | 43 ++++++
.../api/impl/WxMaKefuServiceImplTest.java | 60 ++++++++
.../wx/miniapp/demo/WxMaKefuServiceDemo.java | 84 ++++++++++++
13 files changed, 767 insertions(+)
create mode 100644 MINIAPP_KEFU_SERVICE.md
create mode 100644 weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaKefuService.java
create mode 100644 weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/WxMaKefuServiceImpl.java
create mode 100644 weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/kefu/WxMaKfInfo.java
create mode 100644 weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/kefu/WxMaKfList.java
create mode 100644 weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/kefu/WxMaKfSession.java
create mode 100644 weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/kefu/WxMaKfSessionList.java
create mode 100644 weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/kefu/request/WxMaKfAccountRequest.java
create mode 100644 weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/kefu/request/WxMaKfSessionRequest.java
create mode 100644 weixin-java-miniapp/src/test/java/cn/binarywang/wx/miniapp/api/impl/WxMaKefuServiceImplTest.java
create mode 100644 weixin-java-miniapp/src/test/java/cn/binarywang/wx/miniapp/demo/WxMaKefuServiceDemo.java
diff --git a/MINIAPP_KEFU_SERVICE.md b/MINIAPP_KEFU_SERVICE.md
new file mode 100644
index 0000000000..96cf4c3831
--- /dev/null
+++ b/MINIAPP_KEFU_SERVICE.md
@@ -0,0 +1,80 @@
+# WeChat Mini Program Customer Service Management
+
+This document describes the new customer service management functionality added to the WxJava Mini Program SDK.
+
+## Overview
+
+Previously, the mini program module only had:
+- `WxMaCustomserviceWorkService` - For binding mini programs to enterprise WeChat customer service
+- `WxMaMsgService.sendKefuMsg()` - For sending customer service messages
+
+The new `WxMaKefuService` adds comprehensive customer service management capabilities:
+
+## Features
+
+### Customer Service Account Management
+- `kfList()` - Get list of customer service accounts
+- `kfAccountAdd()` - Add new customer service account
+- `kfAccountUpdate()` - Update customer service account
+- `kfAccountDel()` - Delete customer service account
+
+### Session Management
+- `kfSessionCreate()` - Create customer service session
+- `kfSessionClose()` - Close customer service session
+- `kfSessionGet()` - Get customer session status
+- `kfSessionList()` - Get customer service session list
+
+## Usage Example
+
+```java
+// Get the customer service management service
+WxMaKefuService kefuService = wxMaService.getKefuService();
+
+// Add a new customer service account
+WxMaKfAccountRequest request = WxMaKfAccountRequest.builder()
+ .kfAccount("service001@example")
+ .kfNick("Customer Service 001")
+ .kfPwd("password123")
+ .build();
+boolean result = kefuService.kfAccountAdd(request);
+
+// Create a session between user and customer service
+boolean sessionResult = kefuService.kfSessionCreate("user_openid", "service001@example");
+
+// Get customer service list
+WxMaKfList kfList = kefuService.kfList();
+```
+
+## Bean Classes
+
+### Request Objects
+- `WxMaKfAccountRequest` - For customer service account operations
+- `WxMaKfSessionRequest` - For session operations
+
+### Response Objects
+- `WxMaKfInfo` - Customer service account information
+- `WxMaKfList` - List of customer service accounts
+- `WxMaKfSession` - Session information
+- `WxMaKfSessionList` - List of sessions
+
+## API Endpoints
+
+The service uses the following WeChat Mini Program API endpoints:
+- `https://api.weixin.qq.com/cgi-bin/customservice/getkflist` - Get customer service list
+- `https://api.weixin.qq.com/customservice/kfaccount/add` - Add customer service account
+- `https://api.weixin.qq.com/customservice/kfaccount/update` - Update customer service account
+- `https://api.weixin.qq.com/customservice/kfaccount/del` - Delete customer service account
+- `https://api.weixin.qq.com/customservice/kfsession/create` - Create session
+- `https://api.weixin.qq.com/customservice/kfsession/close` - Close session
+- `https://api.weixin.qq.com/customservice/kfsession/getsession` - Get session
+- `https://api.weixin.qq.com/customservice/kfsession/getsessionlist` - Get session list
+
+## Integration
+
+The service is automatically available through the main `WxMaService` interface:
+
+```java
+WxMaKefuService kefuService = wxMaService.getKefuService();
+```
+
+This fills the gap mentioned in the original issue and provides full customer service management capabilities for WeChat Mini Programs.
\ No newline at end of file
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaKefuService.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaKefuService.java
new file mode 100644
index 0000000000..b8b5a03809
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaKefuService.java
@@ -0,0 +1,128 @@
+package cn.binarywang.wx.miniapp.api;
+
+import cn.binarywang.wx.miniapp.bean.kefu.WxMaKfInfo;
+import cn.binarywang.wx.miniapp.bean.kefu.WxMaKfList;
+import cn.binarywang.wx.miniapp.bean.kefu.WxMaKfSession;
+import cn.binarywang.wx.miniapp.bean.kefu.WxMaKfSessionList;
+import cn.binarywang.wx.miniapp.bean.kefu.request.WxMaKfAccountRequest;
+import me.chanjar.weixin.common.error.WxErrorException;
+
+/**
+ *
+ * 小程序客服管理接口.
+ * 不同于 WxMaCustomserviceWorkService (企业微信客服绑定) 和 WxMaMsgService.sendKefuMsg (发送客服消息),
+ * 此接口专门处理小程序客服账号管理、会话管理等功能。
+ *
+ * 注意:小程序客服管理接口与公众号客服管理接口在API端点和功能上有所不同。
+ *
+ *
+ * @author Binary Wang
+ */
+public interface WxMaKefuService {
+
+ /**
+ *
+ * 获取客服基本信息
+ * 详情请见:获取客服基本信息
+ * 接口url格式:https://api.weixin.qq.com/cgi-bin/customservice/getkflist?access_token=ACCESS_TOKEN
+ *
+ *
+ * @return 客服列表
+ * @throws WxErrorException 异常
+ */
+ WxMaKfList kfList() throws WxErrorException;
+
+ /**
+ *
+ * 添加客服账号
+ * 详情请见:添加客服账号
+ * 接口url格式:https://api.weixin.qq.com/customservice/kfaccount/add?access_token=ACCESS_TOKEN
+ *
+ *
+ * @param request 客服账号信息
+ * @return 是否成功
+ * @throws WxErrorException 异常
+ */
+ boolean kfAccountAdd(WxMaKfAccountRequest request) throws WxErrorException;
+
+ /**
+ *
+ * 修改客服账号
+ * 详情请见:修改客服账号
+ * 接口url格式:https://api.weixin.qq.com/customservice/kfaccount/update?access_token=ACCESS_TOKEN
+ *
+ *
+ * @param request 客服账号信息
+ * @return 是否成功
+ * @throws WxErrorException 异常
+ */
+ boolean kfAccountUpdate(WxMaKfAccountRequest request) throws WxErrorException;
+
+ /**
+ *
+ * 删除客服账号
+ * 详情请见:删除客服账号
+ * 接口url格式:https://api.weixin.qq.com/customservice/kfaccount/del?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT
+ *
+ *
+ * @param kfAccount 客服账号
+ * @return 是否成功
+ * @throws WxErrorException 异常
+ */
+ boolean kfAccountDel(String kfAccount) throws WxErrorException;
+
+ /**
+ *
+ * 创建会话
+ * 详情请见:创建会话
+ * 接口url格式:https://api.weixin.qq.com/customservice/kfsession/create?access_token=ACCESS_TOKEN
+ *
+ *
+ * @param openid 用户openid
+ * @param kfAccount 客服账号
+ * @return 是否成功
+ * @throws WxErrorException 异常
+ */
+ boolean kfSessionCreate(String openid, String kfAccount) throws WxErrorException;
+
+ /**
+ *
+ * 关闭会话
+ * 详情请见:关闭会话
+ * 接口url格式:https://api.weixin.qq.com/customservice/kfsession/close?access_token=ACCESS_TOKEN
+ *
+ *
+ * @param openid 用户openid
+ * @param kfAccount 客服账号
+ * @return 是否成功
+ * @throws WxErrorException 异常
+ */
+ boolean kfSessionClose(String openid, String kfAccount) throws WxErrorException;
+
+ /**
+ *
+ * 获取客户的会话状态
+ * 详情请见:获取客户的会话状态
+ * 接口url格式:https://api.weixin.qq.com/customservice/kfsession/getsession?access_token=ACCESS_TOKEN&openid=OPENID
+ *
+ *
+ * @param openid 用户openid
+ * @return 会话信息
+ * @throws WxErrorException 异常
+ */
+ WxMaKfSession kfSessionGet(String openid) throws WxErrorException;
+
+ /**
+ *
+ * 获取客服的会话列表
+ * 详情请见:获取客服的会话列表
+ * 接口url格式:https://api.weixin.qq.com/customservice/kfsession/getsessionlist?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT
+ *
+ *
+ * @param kfAccount 客服账号
+ * @return 会话列表
+ * @throws WxErrorException 异常
+ */
+ WxMaKfSessionList kfSessionList(String kfAccount) throws WxErrorException;
+
+}
\ No newline at end of file
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaService.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaService.java
index 1b556da81f..26ced8bedd 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaService.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaService.java
@@ -285,6 +285,13 @@ WxMaApiResponse execute(
*/
WxMaCustomserviceWorkService getCustomserviceWorkService();
+ /**
+ * 获取小程序客服管理服务。
+ *
+ * @return 客服管理服务对象WxMaKefuService
+ */
+ WxMaKefuService getKefuService();
+
/**
* 获取jsapi操作相关服务对象。
*
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java
index 28acb38472..0769eaae67 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java
@@ -113,6 +113,7 @@ public abstract class BaseWxMaServiceImpl
+ * 多端登录验证接口的响应
+ * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/miniapp/openapi/code2Verifyinfo.html
+ *
+ * 微信返回报文:{"errcode": 0, "errmsg": "ok", "session_key":"xxx", "openid":"xxx", "unionid":"xxx", "is_limit": false}
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@EqualsAndHashCode(callSuper = false)
+public class WxMaCode2VerifyInfoResult implements Serializable {
+ private static final long serialVersionUID = -2468325025088437364L;
+
+ @SerializedName("session_key")
+ private String sessionKey;
+
+ @SerializedName("openid")
+ private String openid;
+
+ @SerializedName("unionid")
+ private String unionid;
+
+ /**
+ * 是否为受限用户
+ */
+ @SerializedName("is_limit")
+ private Boolean isLimit;
+
+ public static WxMaCode2VerifyInfoResult fromJson(String json) {
+ return WxMaGsonBuilder.create().fromJson(json, WxMaCode2VerifyInfoResult.class);
+ }
+
+}
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/constant/WxMaApiUrlConstants.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/constant/WxMaApiUrlConstants.java
index ea9b123fb9..45e1219659 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/constant/WxMaApiUrlConstants.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/constant/WxMaApiUrlConstants.java
@@ -364,6 +364,8 @@ public interface User {
String SET_USER_STORAGE =
"https://api.weixin.qq.com/wxa/set_user_storage?appid=%s&signature=%s&openid=%s&sig_method=%s";
String GET_PHONE_NUMBER_URL = "https://api.weixin.qq.com/wxa/business/getuserphonenumber";
+ /** 多端登录验证接口 */
+ String CODE_2_VERIFY_INFO_URL = "https://api.weixin.qq.com/wxa/sec/checkcode2verifyinfo";
}
public interface Ocr {
From 085125960b78c8ea14a909788b550dba6b903df6 Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Wed, 3 Dec 2025 17:27:24 +0800
Subject: [PATCH 106/208] =?UTF-8?q?:art:=20#3608=20=E3=80=90=E5=BE=AE?=
=?UTF-8?q?=E4=BF=A1=E6=94=AF=E4=BB=98=E3=80=91=E4=BF=AE=E5=A4=8D=20fullPu?=
=?UTF-8?q?blicKeyModel=20=E9=85=8D=E7=BD=AE=E5=9C=A8=20Spring=20Boot=20St?=
=?UTF-8?q?arter=20=E5=92=8C=20Solon=20=E6=8F=92=E4=BB=B6=E4=B8=AD?=
=?UTF-8?q?=E6=97=A0=E6=95=88=E7=9A=84=E9=97=AE=E9=A2=98?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../pay/config/WxPayAutoConfiguration.java | 7 ++++
.../pay/properties/WxPayProperties.java | 36 +++++++++++++++++++
.../pay/config/WxPayAutoConfiguration.java | 2 ++
.../pay/properties/WxPayProperties.java | 10 ++++++
4 files changed, 55 insertions(+)
diff --git a/solon-plugins/wx-java-pay-solon-plugin/src/main/java/com/binarywang/solon/wxjava/pay/config/WxPayAutoConfiguration.java b/solon-plugins/wx-java-pay-solon-plugin/src/main/java/com/binarywang/solon/wxjava/pay/config/WxPayAutoConfiguration.java
index 1957e4157e..94112c7d9d 100644
--- a/solon-plugins/wx-java-pay-solon-plugin/src/main/java/com/binarywang/solon/wxjava/pay/config/WxPayAutoConfiguration.java
+++ b/solon-plugins/wx-java-pay-solon-plugin/src/main/java/com/binarywang/solon/wxjava/pay/config/WxPayAutoConfiguration.java
@@ -46,13 +46,20 @@ public WxPayService wxPayService() {
payConfig.setSubMchId(StringUtils.trimToNull(this.properties.getSubMchId()));
payConfig.setKeyPath(StringUtils.trimToNull(this.properties.getKeyPath()));
payConfig.setUseSandboxEnv(this.properties.isUseSandboxEnv());
+ payConfig.setNotifyUrl(StringUtils.trimToNull(this.properties.getNotifyUrl()));
//以下是apiv3以及支付分相关
payConfig.setServiceId(StringUtils.trimToNull(this.properties.getServiceId()));
payConfig.setPayScoreNotifyUrl(StringUtils.trimToNull(this.properties.getPayScoreNotifyUrl()));
+ payConfig.setPayScorePermissionNotifyUrl(StringUtils.trimToNull(this.properties.getPayScorePermissionNotifyUrl()));
payConfig.setPrivateKeyPath(StringUtils.trimToNull(this.properties.getPrivateKeyPath()));
payConfig.setPrivateCertPath(StringUtils.trimToNull(this.properties.getPrivateCertPath()));
payConfig.setCertSerialNo(StringUtils.trimToNull(this.properties.getCertSerialNo()));
payConfig.setApiV3Key(StringUtils.trimToNull(this.properties.getApiv3Key()));
+ payConfig.setPublicKeyId(StringUtils.trimToNull(this.properties.getPublicKeyId()));
+ payConfig.setPublicKeyPath(StringUtils.trimToNull(this.properties.getPublicKeyPath()));
+ payConfig.setApiHostUrl(StringUtils.trimToNull(this.properties.getApiHostUrl()));
+ payConfig.setStrictlyNeedWechatPaySerial(this.properties.isStrictlyNeedWechatPaySerial());
+ payConfig.setFullPublicKeyModel(this.properties.isFullPublicKeyModel());
wxPayService.setConfig(payConfig);
return wxPayService;
diff --git a/solon-plugins/wx-java-pay-solon-plugin/src/main/java/com/binarywang/solon/wxjava/pay/properties/WxPayProperties.java b/solon-plugins/wx-java-pay-solon-plugin/src/main/java/com/binarywang/solon/wxjava/pay/properties/WxPayProperties.java
index a882f6ac31..0b035e983e 100644
--- a/solon-plugins/wx-java-pay-solon-plugin/src/main/java/com/binarywang/solon/wxjava/pay/properties/WxPayProperties.java
+++ b/solon-plugins/wx-java-pay-solon-plugin/src/main/java/com/binarywang/solon/wxjava/pay/properties/WxPayProperties.java
@@ -82,4 +82,40 @@ public class WxPayProperties {
*/
private boolean useSandboxEnv;
+ /**
+ * 微信支付异步回调地址,通知url必须为直接可访问的url,不能携带参数
+ */
+ private String notifyUrl;
+
+ /**
+ * 微信支付分授权回调地址
+ */
+ private String payScorePermissionNotifyUrl;
+
+ /**
+ * 公钥ID
+ */
+ private String publicKeyId;
+
+ /**
+ * pub_key.pem证书文件的绝对路径或者以classpath:开头的类路径.
+ */
+ private String publicKeyPath;
+
+ /**
+ * 自定义API主机地址,用于替换默认的 https://api.mch.weixin.qq.com
+ * 例如:http://proxy.company.com:8080
+ */
+ private String apiHostUrl;
+
+ /**
+ * 是否将全部v3接口的请求都添加Wechatpay-Serial请求头,默认不添加
+ */
+ private boolean strictlyNeedWechatPaySerial = false;
+
+ /**
+ * 是否完全使用公钥模式(用以微信从平台证书到公钥的灰度切换),默认不使用
+ */
+ private boolean fullPublicKeyModel = false;
+
}
diff --git a/spring-boot-starters/wx-java-pay-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/pay/config/WxPayAutoConfiguration.java b/spring-boot-starters/wx-java-pay-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/pay/config/WxPayAutoConfiguration.java
index 451cfbe4d0..5a794de7e8 100644
--- a/spring-boot-starters/wx-java-pay-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/pay/config/WxPayAutoConfiguration.java
+++ b/spring-boot-starters/wx-java-pay-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/pay/config/WxPayAutoConfiguration.java
@@ -62,6 +62,8 @@ public WxPayService wxPayService() {
payConfig.setPublicKeyId(StringUtils.trimToNull(this.properties.getPublicKeyId()));
payConfig.setPublicKeyPath(StringUtils.trimToNull(this.properties.getPublicKeyPath()));
payConfig.setApiHostUrl(StringUtils.trimToNull(this.properties.getApiHostUrl()));
+ payConfig.setStrictlyNeedWechatPaySerial(this.properties.isStrictlyNeedWechatPaySerial());
+ payConfig.setFullPublicKeyModel(this.properties.isFullPublicKeyModel());
wxPayService.setConfig(payConfig);
return wxPayService;
diff --git a/spring-boot-starters/wx-java-pay-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/pay/properties/WxPayProperties.java b/spring-boot-starters/wx-java-pay-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/pay/properties/WxPayProperties.java
index 143b7deefa..8212e3b013 100644
--- a/spring-boot-starters/wx-java-pay-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/pay/properties/WxPayProperties.java
+++ b/spring-boot-starters/wx-java-pay-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/pay/properties/WxPayProperties.java
@@ -106,4 +106,14 @@ public class WxPayProperties {
*/
private String apiHostUrl;
+ /**
+ * 是否将全部v3接口的请求都添加Wechatpay-Serial请求头,默认不添加
+ */
+ private boolean strictlyNeedWechatPaySerial = false;
+
+ /**
+ * 是否完全使用公钥模式(用以微信从平台证书到公钥的灰度切换),默认不使用
+ */
+ private boolean fullPublicKeyModel = false;
+
}
From cd4317ab3e78e3ba1233c6f3d2610afa07538270 Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Thu, 4 Dec 2025 19:38:10 +0800
Subject: [PATCH 107/208] =?UTF-8?q?:art:=20#3384=20=E3=80=90=E5=85=AC?=
=?UTF-8?q?=E4=BC=97=E5=8F=B7=E3=80=91=E4=B8=BA=20starter=20=E6=B7=BB?=
=?UTF-8?q?=E5=8A=A0=20HttpComponents=20(httpclient5)=20=E6=94=AF=E6=8C=81?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../wx-java-mp-multi-spring-boot-starter/pom.xml | 5 +++++
.../wx-java-mp-spring-boot-starter/pom.xml | 5 +++++
.../wxjava/mp/config/WxMpServiceAutoConfiguration.java | 8 ++++++++
.../spring/starter/wxjava/mp/enums/HttpClientType.java | 4 ++++
4 files changed, 22 insertions(+)
diff --git a/spring-boot-starters/wx-java-mp-multi-spring-boot-starter/pom.xml b/spring-boot-starters/wx-java-mp-multi-spring-boot-starter/pom.xml
index fe10f8332f..1ded1a4e16 100644
--- a/spring-boot-starters/wx-java-mp-multi-spring-boot-starter/pom.xml
+++ b/spring-boot-starters/wx-java-mp-multi-spring-boot-starter/pom.xml
@@ -44,6 +44,11 @@
+ * 字段名:混合支付类型
+ * 变量名:mix_pay_type
+ * 必填:是
+ * 类型:string
+ * 描述:
+ * 混合支付类型可选取值:
+ * - UNKNOWN_MIX_PAY_TYPE: 未知的混合支付类型,会被拦截
+ * - CASH_ONLY: 只向微信支付下单,没有向医保局下单
+ * - INSURANCE_ONLY: 只向医保局下单,没有向微信支付下单
+ * - CASH_AND_INSURANCE: 向医保局下单,也向微信支付下单
+ *
+ */
+ @SerializedName("mix_pay_type")
+ public MixPayTypeEnum mixPayType;
+
+ /**
+ *
+ * 字段名:订单类型
+ * 变量名:order_type
+ * 必填:是
+ * 类型:string
+ * 描述:
+ * 订单类型可选取值:
+ * - UNKNOWN_ORDER_TYPE: 未知类型,会被拦截
+ * - REG_PAY: 挂号支付
+ * - DIAG_PAY: 诊间支付
+ * - COVID_EXAM_PAY: 新冠检测费用(核酸)
+ * - IN_HOSP_PAY: 住院费支付
+ * - PHARMACY_PAY: 药店支付
+ * - INSURANCE_PAY: 保险费支付
+ * - INT_REG_PAY: 互联网医院挂号支付
+ * - INT_RE_DIAG_PAY: 互联网医院复诊支付
+ * - INT_RX_PAY: 互联网医院处方支付
+ * - COVID_ANTIGEN_PAY: 新冠抗原检测
+ * - MED_PAY: 药费支付
+ *
+ */
+ @SerializedName("order_type")
+ public OrderTypeEnum orderType;
+
+ /**
+ *
+ * 字段名:从业机构/服务商的公众号ID
+ * 变量名:appid
+ * 必填:是
+ * 类型:string(32)
+ * 描述:从业机构/服务商的公众号ID
+ *
+ */
+ @SerializedName("appid")
+ public String appid;
+
+ /**
+ *
+ * 字段名:医疗机构的公众号ID
+ * 变量名:sub_appid
+ * 必填:是
+ * 类型:string(32)
+ * 描述:医疗机构的公众号ID
+ *
+ */
+ @SerializedName("sub_appid")
+ public String subAppid;
+
+ /**
+ *
+ * 字段名:医疗机构的商户号
+ * 变量名:sub_mchid
+ * 必填:是
+ * 类型:string(32)
+ * 描述:医疗机构的商户号
+ *
+ */
+ @SerializedName("sub_mchid")
+ public String subMchid;
+
+ /**
+ *
+ * 字段名:用户在appid下的唯一标识
+ * 变量名:openid
+ * 必填:否
+ * 类型:string(128)
+ * 描述:openid与sub_openid二选一,传入openid时需要使用appid调起医保自费混合支付
+ *
+ */
+ @SerializedName("openid")
+ public String openid;
+
+ /**
+ *
+ * 字段名:用户在sub_appid下的唯一标识
+ * 变量名:sub_openid
+ * 必填:否
+ * 类型:string(128)
+ * 描述:openid与sub_openid二选一,传入sub_openid时需要使用sub_appid调起医保自费混合支付
+ *
+ */
+ @SerializedName("sub_openid")
+ public String subOpenid;
+
+ /**
+ *
+ * 字段名:支付人身份信息
+ * 变量名:payer
+ * 必填:是
+ * 类型:object
+ * 描述:支付人身份信息
+ *
+ */
+ @SerializedName("payer")
+ @SpecEncrypt
+ public PersonIdentification payer;
+
+ /**
+ *
+ * 字段名:是否代亲属支付
+ * 变量名:pay_for_relatives
+ * 必填:否
+ * 类型:boolean
+ * 描述:不传默认替本人支付
+ * - true: 代亲属支付
+ * - false: 本人支付
+ *
+ */
+ @SerializedName("pay_for_relatives")
+ public Boolean payForRelatives;
+
+ /**
+ *
+ * 字段名:亲属身份信息
+ * 变量名:relative
+ * 必填:否
+ * 类型:object
+ * 描述:pay_for_relatives为true时,该字段必填
+ *
+ */
+ @SerializedName("relative")
+ @SpecEncrypt
+ public PersonIdentification relative;
+
+ /**
+ *
+ * 字段名:从业机构订单号
+ * 变量名:out_trade_no
+ * 必填:是
+ * 类型:string(64)
+ * 描述:从业机构/服务商需要调两次接口:从业机构/服务商向微信支付下单获取微信支付凭证,请求中会带上out_trade_no。下单成功后,从业机构/服务商调用混合下单的接口(即该接口),请求中也会带上out_trade_no。
+ *
+ */
+ @SerializedName("out_trade_no")
+ public String outTradeNo;
+
+ /**
+ *
+ * 字段名:医疗机构订单号
+ * 变量名:serial_no
+ * 必填:是
+ * 类型:string(40)
+ * 描述:例如医院HIS系统订单号。传与费用明细上传中medOrgOrd字段一样的值,局端会校验,不一致将会返回错误
+ *
+ */
+ @SerializedName("serial_no")
+ public String serialNo;
+
+ /**
+ *
+ * 字段名:支付订单号
+ * 变量名:pay_order_id
+ * 必填:否
+ * 类型:string
+ * 描述:支付订单号
+ *
+ */
+ @SerializedName("pay_order_id")
+ public String payOrderId;
+
+ /**
+ *
+ * 字段名:支付授权号
+ * 变量名:pay_auth_no
+ * 必填:否
+ * 类型:string
+ * 描述:支付授权号
+ *
+ */
+ @SerializedName("pay_auth_no")
+ public String payAuthNo;
+
+ /**
+ *
+ * 字段名:地理位置
+ * 变量名:geo_location
+ * 必填:否
+ * 类型:string
+ * 描述:地理位置
+ *
+ */
+ @SerializedName("geo_location")
+ public String geoLocation;
+
+ /**
+ *
+ * 字段名:城市ID
+ * 变量名:city_id
+ * 必填:否
+ * 类型:string
+ * 描述:城市ID
+ *
+ */
+ @SerializedName("city_id")
+ public String cityId;
+
+ /**
+ *
+ * 字段名:医疗机构名称
+ * 变量名:med_inst_name
+ * 必填:否
+ * 类型:string
+ * 描述:医疗机构名称
+ *
+ */
+ @SerializedName("med_inst_name")
+ public String medInstName;
+
+ /**
+ *
+ * 字段名:医疗机构编号
+ * 变量名:med_inst_no
+ * 必填:否
+ * 类型:string
+ * 描述:医疗机构编号
+ *
+ */
+ @SerializedName("med_inst_no")
+ public String medInstNo;
+
+ /**
+ *
+ * 字段名:医保订单创建时间
+ * 变量名:med_ins_order_create_time
+ * 必填:否
+ * 类型:string
+ * 描述:医保订单创建时间
+ *
+ */
+ @SerializedName("med_ins_order_create_time")
+ public String medInsOrderCreateTime;
+
+ /**
+ *
+ * 字段名:总金额
+ * 变量名:total_fee
+ * 必填:否
+ * 类型:long
+ * 描述:总金额
+ *
+ */
+ @SerializedName("total_fee")
+ public Long totalFee;
+
+ /**
+ *
+ * 字段名:医保统筹基金支付金额
+ * 变量名:med_ins_gov_fee
+ * 必填:否
+ * 类型:long
+ * 描述:医保统筹基金支付金额
+ *
+ */
+ @SerializedName("med_ins_gov_fee")
+ public Long medInsGovFee;
+
+ /**
+ *
+ * 字段名:医保个人账户支付金额
+ * 变量名:med_ins_self_fee
+ * 必填:否
+ * 类型:long
+ * 描述:医保个人账户支付金额
+ *
+ */
+ @SerializedName("med_ins_self_fee")
+ public Long medInsSelfFee;
+
+ /**
+ *
+ * 字段名:医保其他基金支付金额
+ * 变量名:med_ins_other_fee
+ * 必填:否
+ * 类型:long
+ * 描述:医保其他基金支付金额
+ *
+ */
+ @SerializedName("med_ins_other_fee")
+ public Long medInsOtherFee;
+
+ /**
+ *
+ * 字段名:医保现金支付金额
+ * 变量名:med_ins_cash_fee
+ * 必填:否
+ * 类型:long
+ * 描述:医保现金支付金额
+ *
+ */
+ @SerializedName("med_ins_cash_fee")
+ public Long medInsCashFee;
+
+ /**
+ *
+ * 字段名:微信支付现金支付金额
+ * 变量名:wechat_pay_cash_fee
+ * 必填:否
+ * 类型:long
+ * 描述:微信支付现金支付金额
+ *
+ */
+ @SerializedName("wechat_pay_cash_fee")
+ public Long wechatPayCashFee;
+
+ /**
+ *
+ * 字段名:现金增加明细
+ * 变量名:cash_add_detail
+ * 必填:否
+ * 类型:list
+ * 描述:现金增加明细
+ *
+ */
+ @SerializedName("cash_add_detail")
+ public List
+ * 字段名:现金减少明细
+ * 变量名:cash_reduce_detail
+ * 必填:否
+ * 类型:list
+ * 描述:现金减少明细
+ *
+ */
+ @SerializedName("cash_reduce_detail")
+ public List
+ * 字段名:回调URL
+ * 变量名:callback_url
+ * 必填:否
+ * 类型:string
+ * 描述:回调URL
+ *
+ */
+ @SerializedName("callback_url")
+ public String callbackUrl;
+
+ /**
+ *
+ * 字段名:预支付交易会话标识
+ * 变量名:prepay_id
+ * 必填:否
+ * 类型:string
+ * 描述:预支付交易会话标识
+ *
+ */
+ @SerializedName("prepay_id")
+ public String prepayId;
+
+ /**
+ *
+ * 字段名:透传请求内容
+ * 变量名:passthrough_request_content
+ * 必填:否
+ * 类型:string
+ * 描述:透传请求内容
+ *
+ */
+ @SerializedName("passthrough_request_content")
+ public String passthroughRequestContent;
+
+ /**
+ *
+ * 字段名:扩展字段
+ * 变量名:extends
+ * 必填:否
+ * 类型:string
+ * 描述:扩展字段
+ *
+ */
+ @SerializedName("extends")
+ public String _extends;
+
+ /**
+ *
+ * 字段名:附加数据
+ * 变量名:attach
+ * 必填:否
+ * 类型:string
+ * 描述:附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用
+ *
+ */
+ @SerializedName("attach")
+ public String attach;
+
+ /**
+ *
+ * 字段名:渠道编号
+ * 变量名:channel_no
+ * 必填:否
+ * 类型:string
+ * 描述:渠道编号
+ *
+ */
+ @SerializedName("channel_no")
+ public String channelNo;
+
+ /**
+ *
+ * 字段名:医保测试环境标识
+ * 变量名:med_ins_test_env
+ * 必填:否
+ * 类型:boolean
+ * 描述:医保测试环境标识
+ *
+ */
+ @SerializedName("med_ins_test_env")
+ public Boolean medInsTestEnv;
+
+ /**
+ *
+ * 支付人身份信息
+ *
+ */
+ public static class PersonIdentification {
+ /**
+ *
+ * 字段名:姓名
+ * 变量名:name
+ * 必填:是
+ * 类型:string
+ * 描述:姓名,需加密
+ *
+ */
+ @SerializedName("name")
+ @SpecEncrypt
+ public String name;
+
+ /**
+ *
+ * 字段名:身份证摘要
+ * 变量名:id_digest
+ * 必填:是
+ * 类型:string
+ * 描述:身份证摘要,需加密
+ *
+ */
+ @SerializedName("id_digest")
+ @SpecEncrypt
+ public String idDigest;
+
+ /**
+ *
+ * 字段名:证件类型
+ * 变量名:card_type
+ * 必填:是
+ * 类型:string
+ * 描述:证件类型
+ *
+ */
+ @SerializedName("card_type")
+ public UserCardTypeEnum cardType;
+ }
+
+ /**
+ *
+ * 现金增加明细实体
+ *
+ */
+ public static class CashAddEntity {
+ /**
+ *
+ * 字段名:现金增加金额
+ * 变量名:cash_add_fee
+ * 必填:是
+ * 类型:long
+ * 描述:现金增加金额
+ *
+ */
+ @SerializedName("cash_add_fee")
+ public Long cashAddFee;
+
+ /**
+ *
+ * 字段名:现金增加类型
+ * 变量名:cash_add_type
+ * 必填:是
+ * 类型:string
+ * 描述:现金增加类型
+ *
+ */
+ @SerializedName("cash_add_type")
+ public CashAddTypeEnum cashAddType;
+ }
+
+ /**
+ *
+ * 现金减少明细实体
+ *
+ */
+ public static class CashReduceEntity {
+ /**
+ *
+ * 字段名:现金减少金额
+ * 变量名:cash_reduce_fee
+ * 必填:是
+ * 类型:long
+ * 描述:现金减少金额
+ *
+ */
+ @SerializedName("cash_reduce_fee")
+ public Long cashReduceFee;
+
+ /**
+ *
+ * 字段名:现金减少类型
+ * 变量名:cash_reduce_type
+ * 必填:是
+ * 类型:string
+ * 描述:现金减少类型
+ *
+ */
+ @SerializedName("cash_reduce_type")
+ public CashReduceTypeEnum cashReduceType;
+ }
+
+
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsOrdersResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsOrdersResult.java
new file mode 100644
index 0000000000..4fc68e279f
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsOrdersResult.java
@@ -0,0 +1,497 @@
+package com.github.binarywang.wxpay.bean.mipay;
+
+import com.github.binarywang.wxpay.bean.mipay.enums.MedInsPayStatusEnum;
+import com.github.binarywang.wxpay.bean.mipay.enums.MixPayStatusEnum;
+import com.github.binarywang.wxpay.bean.mipay.enums.MixPayTypeEnum;
+import com.github.binarywang.wxpay.bean.mipay.enums.OrderTypeEnum;
+import com.github.binarywang.wxpay.bean.mipay.enums.SelfPayStatusEnum;
+import com.google.gson.annotations.SerializedName;
+import java.util.List;
+import lombok.Data;
+
+/**
+ * 医保自费混合收款下单响应
+ *
+ * 字段名:混合交易订单号
+ * 变量名:mix_trade_no
+ * 必填:是
+ * 类型:string
+ * 描述:微信支付生成的混合交易订单号
+ *
+ */
+ @SerializedName("mix_trade_no")
+ public String mixTradeNo;
+
+ /**
+ *
+ * 字段名:混合支付状态
+ * 变量名:mix_pay_status
+ * 必填:是
+ * 类型:string
+ * 描述:混合支付整体状态
+ *
+ */
+ @SerializedName("mix_pay_status")
+ public MixPayStatusEnum mixPayStatus;
+
+ /**
+ *
+ * 字段名:自费支付状态
+ * 变量名:self_pay_status
+ * 必填:是
+ * 类型:string
+ * 描述:自费部分支付状态
+ *
+ */
+ @SerializedName("self_pay_status")
+ public SelfPayStatusEnum selfPayStatus;
+
+ /**
+ *
+ * 字段名:医保支付状态
+ * 变量名:med_ins_pay_status
+ * 必填:是
+ * 类型:string
+ * 描述:医保部分支付状态
+ *
+ */
+ @SerializedName("med_ins_pay_status")
+ public MedInsPayStatusEnum medInsPayStatusEnum;
+
+ /**
+ *
+ * 字段名:支付完成时间
+ * 变量名:paid_time
+ * 必填:否
+ * 类型:string
+ * 描述:支付完成时间,格式为yyyyMMddHHmmss
+ *
+ */
+ @SerializedName("paid_time")
+ public String paidTime;
+
+ /**
+ *
+ * 字段名:透传响应内容
+ * 变量名:passthrough_response_content
+ * 必填:否
+ * 类型:string
+ * 描述:透传响应内容
+ *
+ */
+ @SerializedName("passthrough_response_content")
+ public String passthroughResponseContent;
+
+ /**
+ *
+ * 字段名:混合支付类型
+ * 变量名:mix_pay_type
+ * 必填:是
+ * 类型:string
+ * 描述:
+ * 混合支付类型可选取值:
+ * - UNKNOWN_MIX_PAY_TYPE: 未知的混合支付类型,会被拦截
+ * - CASH_ONLY: 只向微信支付下单,没有向医保局下单
+ * - INSURANCE_ONLY: 只向医保局下单,没有向微信支付下单
+ * - CASH_AND_INSURANCE: 向医保局下单,也向微信支付下单
+ *
+ */
+ @SerializedName("mix_pay_type")
+ public MixPayTypeEnum mixPayType;
+
+ /**
+ *
+ * 字段名:订单类型
+ * 变量名:order_type
+ * 必填:是
+ * 类型:string
+ * 描述:
+ * 订单类型可选取值:
+ * - UNKNOWN_ORDER_TYPE: 未知类型,会被拦截
+ * - REG_PAY: 挂号支付
+ * - DIAG_PAY: 诊间支付
+ * - COVID_EXAM_PAY: 新冠检测费用(核酸)
+ * - IN_HOSP_PAY: 住院费支付
+ * - PHARMACY_PAY: 药店支付
+ * - INSURANCE_PAY: 保险费支付
+ * - INT_REG_PAY: 互联网医院挂号支付
+ * - INT_RE_DIAG_PAY: 互联网医院复诊支付
+ * - INT_RX_PAY: 互联网医院处方支付
+ * - COVID_ANTIGEN_PAY: 新冠抗原检测
+ * - MED_PAY: 药费支付
+ *
+ */
+ @SerializedName("order_type")
+ public OrderTypeEnum orderType;
+
+ /**
+ *
+ * 字段名:从业机构/服务商的公众号ID
+ * 变量名:appid
+ * 必填:是
+ * 类型:string(32)
+ * 描述:从业机构/服务商的公众号ID
+ *
+ */
+ @SerializedName("appid")
+ public String appid;
+
+ /**
+ *
+ * 字段名:医疗机构的公众号ID
+ * 变量名:sub_appid
+ * 必填:是
+ * 类型:string(32)
+ * 描述:医疗机构的公众号ID
+ *
+ */
+ @SerializedName("sub_appid")
+ public String subAppid;
+
+ /**
+ *
+ * 字段名:医疗机构的商户号
+ * 变量名:sub_mchid
+ * 必填:是
+ * 类型:string(32)
+ * 描述:医疗机构的商户号
+ *
+ */
+ @SerializedName("sub_mchid")
+ public String subMchid;
+
+ /**
+ *
+ * 字段名:用户在appid下的唯一标识
+ * 变量名:openid
+ * 必填:否
+ * 类型:string(128)
+ * 描述:openid与sub_openid二选一,传入openid时需要使用appid调起医保自费混合支付
+ *
+ */
+ @SerializedName("openid")
+ public String openid;
+
+ /**
+ *
+ * 字段名:用户在sub_appid下的唯一标识
+ * 变量名:sub_openid
+ * 必填:否
+ * 类型:string(128)
+ * 描述:openid与sub_openid二选一,传入sub_openid时需要使用sub_appid调起医保自费混合支付
+ *
+ */
+ @SerializedName("sub_openid")
+ public String subOpenid;
+
+ /**
+ *
+ * 字段名:是否代亲属支付
+ * 变量名:pay_for_relatives
+ * 必填:否
+ * 类型:boolean
+ * 描述:不传默认替本人支付
+ * - true: 代亲属支付
+ * - false: 本人支付
+ *
+ */
+ @SerializedName("pay_for_relatives")
+ public Boolean payForRelatives;
+
+ /**
+ *
+ * 字段名:从业机构订单号
+ * 变量名:out_trade_no
+ * 必填:是
+ * 类型:string(64)
+ * 描述:从业机构/服务商需要调两次接口:从业机构/服务商向微信支付下单获取微信支付凭证,请求中会带上out_trade_no。下单成功后,从业机构/服务商调用混合下单的接口(即该接口),请求中也会带上out_trade_no。
+ *
+ */
+ @SerializedName("out_trade_no")
+ public String outTradeNo;
+
+ /**
+ *
+ * 字段名:医疗机构订单号
+ * 变量名:serial_no
+ * 必填:是
+ * 类型:string(40)
+ * 描述:例如医院HIS系统订单号。传与费用明细上传中medOrgOrd字段一样的值,局端会校验,不一致将会返回错误
+ *
+ */
+ @SerializedName("serial_no")
+ public String serialNo;
+
+ /**
+ *
+ * 字段名:支付订单号
+ * 变量名:pay_order_id
+ * 必填:否
+ * 类型:string
+ * 描述:支付订单号
+ *
+ */
+ @SerializedName("pay_order_id")
+ public String payOrderId;
+
+ /**
+ *
+ * 字段名:支付授权号
+ * 变量名:pay_auth_no
+ * 必填:否
+ * 类型:string
+ * 描述:支付授权号
+ *
+ */
+ @SerializedName("pay_auth_no")
+ public String payAuthNo;
+
+ /**
+ *
+ * 字段名:地理位置
+ * 变量名:geo_location
+ * 必填:否
+ * 类型:string
+ * 描述:地理位置
+ *
+ */
+ @SerializedName("geo_location")
+ public String geoLocation;
+
+ /**
+ *
+ * 字段名:城市ID
+ * 变量名:city_id
+ * 必填:否
+ * 类型:string
+ * 描述:城市ID
+ *
+ */
+ @SerializedName("city_id")
+ public String cityId;
+
+ /**
+ *
+ * 字段名:医疗机构名称
+ * 变量名:med_inst_name
+ * 必填:否
+ * 类型:string
+ * 描述:医疗机构名称
+ *
+ */
+ @SerializedName("med_inst_name")
+ public String medInstName;
+
+ /**
+ *
+ * 字段名:医疗机构编号
+ * 变量名:med_inst_no
+ * 必填:否
+ * 类型:string
+ * 描述:医疗机构编号
+ *
+ */
+ @SerializedName("med_inst_no")
+ public String medInstNo;
+
+ /**
+ *
+ * 字段名:医保订单创建时间
+ * 变量名:med_ins_order_create_time
+ * 必填:否
+ * 类型:string
+ * 描述:医保订单创建时间
+ *
+ */
+ @SerializedName("med_ins_order_create_time")
+ public String medInsOrderCreateTime;
+
+ /**
+ *
+ * 字段名:总金额
+ * 变量名:total_fee
+ * 必填:否
+ * 类型:long
+ * 描述:总金额
+ *
+ */
+ @SerializedName("total_fee")
+ public Long totalFee;
+
+ /**
+ *
+ * 字段名:医保统筹基金支付金额
+ * 变量名:med_ins_gov_fee
+ * 必填:否
+ * 类型:long
+ * 描述:医保统筹基金支付金额
+ *
+ */
+ @SerializedName("med_ins_gov_fee")
+ public Long medInsGovFee;
+
+ /**
+ *
+ * 字段名:医保个人账户支付金额
+ * 变量名:med_ins_self_fee
+ * 必填:否
+ * 类型:long
+ * 描述:医保个人账户支付金额
+ *
+ */
+ @SerializedName("med_ins_self_fee")
+ public Long medInsSelfFee;
+
+ /**
+ *
+ * 字段名:医保其他基金支付金额
+ * 变量名:med_ins_other_fee
+ * 必填:否
+ * 类型:long
+ * 描述:医保其他基金支付金额
+ *
+ */
+ @SerializedName("med_ins_other_fee")
+ public Long medInsOtherFee;
+
+ /**
+ *
+ * 字段名:医保现金支付金额
+ * 变量名:med_ins_cash_fee
+ * 必填:否
+ * 类型:long
+ * 描述:医保现金支付金额
+ *
+ */
+ @SerializedName("med_ins_cash_fee")
+ public Long medInsCashFee;
+
+ /**
+ *
+ * 字段名:微信支付现金支付金额
+ * 变量名:wechat_pay_cash_fee
+ * 必填:否
+ * 类型:long
+ * 描述:微信支付现金支付金额
+ *
+ */
+ @SerializedName("wechat_pay_cash_fee")
+ public Long wechatPayCashFee;
+
+ /**
+ *
+ * 字段名:现金增加明细
+ * 变量名:cash_add_detail
+ * 必填:否
+ * 类型:list
+ * 描述:现金增加明细
+ *
+ */
+ @SerializedName("cash_add_detail")
+ public List
+ * 字段名:现金减少明细
+ * 变量名:cash_reduce_detail
+ * 必填:否
+ * 类型:list
+ * 描述:现金减少明细
+ *
+ */
+ @SerializedName("cash_reduce_detail")
+ public List
+ * 字段名:回调URL
+ * 变量名:callback_url
+ * 必填:否
+ * 类型:string
+ * 描述:回调URL
+ *
+ */
+ @SerializedName("callback_url")
+ public String callbackUrl;
+
+ /**
+ *
+ * 字段名:预支付交易会话标识
+ * 变量名:prepay_id
+ * 必填:否
+ * 类型:string
+ * 描述:预支付交易会话标识
+ *
+ */
+ @SerializedName("prepay_id")
+ public String prepayId;
+
+ /**
+ *
+ * 字段名:透传请求内容
+ * 变量名:passthrough_request_content
+ * 必填:否
+ * 类型:string
+ * 描述:透传请求内容
+ *
+ */
+ @SerializedName("passthrough_request_content")
+ public String passthroughRequestContent;
+
+ /**
+ *
+ * 字段名:扩展字段
+ * 变量名:extends
+ * 必填:否
+ * 类型:string
+ * 描述:扩展字段
+ *
+ */
+ @SerializedName("extends")
+ public String _extends;
+
+ /**
+ *
+ * 字段名:附加数据
+ * 变量名:attach
+ * 必填:否
+ * 类型:string
+ * 描述:附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用
+ *
+ */
+ @SerializedName("attach")
+ public String attach;
+
+ /**
+ *
+ * 字段名:渠道编号
+ * 变量名:channel_no
+ * 必填:否
+ * 类型:string
+ * 描述:渠道编号
+ *
+ */
+ @SerializedName("channel_no")
+ public String channelNo;
+
+ /**
+ *
+ * 字段名:医保测试环境标识
+ * 变量名:med_ins_test_env
+ * 必填:否
+ * 类型:boolean
+ * 描述:医保测试环境标识
+ *
+ */
+ @SerializedName("med_ins_test_env")
+ public Boolean medInsTestEnv;
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsRefundNotifyRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsRefundNotifyRequest.java
new file mode 100644
index 0000000000..b6e15a3644
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsRefundNotifyRequest.java
@@ -0,0 +1,116 @@
+package com.github.binarywang.wxpay.bean.mipay;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * 医保退款通知请求
+ *
+ * 字段名:医保自费混合订单号
+ * 必填:是
+ * 类型:string(32)
+ * 描述:医保自费混合订单号
+ *
+ */
+ private String mixTradeNo;
+
+ /**
+ *
+ * 字段名:医疗机构的商户号
+ * 变量名:sub_mchid
+ * 必填:是
+ * 类型:string(32)
+ * 描述:医疗机构的商户号
+ *
+ */
+ @SerializedName("sub_mchid")
+ private String subMchid;
+
+ /**
+ *
+ * 字段名:医保退款的总金额
+ * 变量名:med_refund_total_fee
+ * 必填:是
+ * 类型:integer
+ * 描述:单位分,医保退款的总金额。
+ *
+ */
+ @SerializedName("med_refund_total_fee")
+ private Integer medRefundTotalFee;
+
+ /**
+ *
+ * 字段名:医保统筹退款金额
+ * 变量名:med_refund_gov_fee
+ * 必填:是
+ * 类型:integer
+ * 描述:单位分,医保统筹退款金额。
+ *
+ */
+ @SerializedName("med_refund_gov_fee")
+ private Integer medRefundGovFee;
+
+ /**
+ *
+ * 字段名:医保个账退款金额
+ * 变量名:med_refund_self_fee
+ * 必填:是
+ * 类型:integer
+ * 描述:单位分,医保个账退款金额。
+ *
+ */
+ @SerializedName("med_refund_self_fee")
+ private Integer medRefundSelfFee;
+
+ /**
+ *
+ * 字段名:医保其他退款金额
+ * 变量名:med_refund_other_fee
+ * 必填:是
+ * 类型:integer
+ * 描述:单位分,医保其他退款金额。
+ *
+ */
+ @SerializedName("med_refund_other_fee")
+ private Integer medRefundOtherFee;
+
+ /**
+ *
+ * 字段名:医保退款成功时间
+ * 变量名:refund_time
+ * 必填:是
+ * 类型:string(64)
+ * 描述:遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE。
+ *
+ */
+ @SerializedName("refund_time")
+ private String refundTime;
+
+ /**
+ *
+ * 字段名:从业机构\服务商退款单号
+ * 变量名:out_refund_no
+ * 必填:是
+ * 类型:string(64)
+ * 描述:有自费单时,从业机构\服务商应填与自费退款申请处一致的out_refund_no。否则从业机构透传医疗机构退款单号即可。
+ *
+ */
+ @SerializedName("out_refund_no")
+ private String outRefundNo;
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/CashAddTypeEnum.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/CashAddTypeEnum.java
new file mode 100644
index 0000000000..b935f20410
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/CashAddTypeEnum.java
@@ -0,0 +1,29 @@
+package com.github.binarywang.wxpay.bean.mipay.enums;
+
+import com.google.gson.annotations.SerializedName;
+
+/**
+ * 现金增加类型枚举
+ *
+ * 医保混合收款成功通知结果
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4012165722
+ *
+ *
+ * @author xgl
+ * @date 2025/12/20
+ */
+@Data
+@NoArgsConstructor
+public class MiPayNotifyV3Result implements Serializable, WxPayBaseNotifyV3Result
+ * 字段名:应用ID
+ * 变量名:appid
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 从业机构/服务商的公众号ID
+ *
+ */
+ @SerializedName(value = "appid")
+ private String appid;
+
+ /**
+ *
+ * 字段名:医疗机构的公众号ID
+ * 变量名:sub_appid
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 医疗机构的公众号ID
+ *
+ */
+ @SerializedName(value = "sub_appid")
+ private String subAppid;
+
+ /**
+ *
+ * 字段名:医疗机构的商户号
+ * 变量名:sub_mchid
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 医疗机构的商户号
+ *
+ */
+ @SerializedName(value = "sub_mchid")
+ private String subMchid;
+
+ /**
+ *
+ * 字段名:从业机构订单号
+ * 变量名:out_trade_no
+ * 是否必填:是
+ * 类型:string(64)
+ * 描述:
+ * 从业机构/服务商订单号
+ *
+ */
+ @SerializedName(value = "out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 字段名:医保自费混合订单号
+ * 变量名:mix_trade_no
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 微信支付系统生成的医保自费混合订单号
+ *
+ */
+ @SerializedName(value = "mix_trade_no")
+ private String mixTradeNo;
+
+ /**
+ *
+ * 字段名:微信支付订单号
+ * 变量名:transaction_id
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 微信支付系统生成的订单号
+ *
+ */
+ @SerializedName(value = "transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 字段名:医保订单创建时间
+ * 变量名:med_ins_order_create_time
+ * 是否必填:是
+ * 类型:string(64)
+ * 描述:
+ * 医保订单创建时间,遵循rfc3339标准格式
+ *
+ */
+ @SerializedName(value = "med_ins_order_create_time")
+ private String medInsOrderCreateTime;
+
+ /**
+ *
+ * 字段名:医保订单完成时间
+ * 变量名:med_ins_order_finish_time
+ * 是否必填:是
+ * 类型:string(64)
+ * 描述:
+ * 医保订单完成时间,遵循rfc3339标准格式
+ *
+ */
+ @SerializedName(value = "med_ins_order_finish_time")
+ private String medInsOrderFinishTime;
+
+ /**
+ *
+ * 字段名:总金额
+ * 变量名:total_fee
+ * 是否必填:否
+ * 类型:long
+ * 描述:
+ * 总金额,单位为分
+ *
+ */
+ @SerializedName(value = "total_fee")
+ private Long totalFee;
+
+ /**
+ *
+ * 字段名:医保统筹基金支付金额
+ * 变量名:med_ins_gov_fee
+ * 是否必填:否
+ * 类型:long
+ * 描述:
+ * 医保统筹基金支付金额,单位为分
+ *
+ */
+ @SerializedName(value = "med_ins_gov_fee")
+ private Long medInsGovFee;
+
+ /**
+ *
+ * 字段名:医保个人账户支付金额
+ * 变量名:med_ins_self_fee
+ * 是否必填:否
+ * 类型:long
+ * 描述:
+ * 医保个人账户支付金额,单位为分
+ *
+ */
+ @SerializedName(value = "med_ins_self_fee")
+ private Long medInsSelfFee;
+
+ /**
+ *
+ * 字段名:医保其他基金支付金额
+ * 变量名:med_ins_other_fee
+ * 是否必填:否
+ * 类型:long
+ * 描述:
+ * 医保其他基金支付金额,单位为分
+ *
+ */
+ @SerializedName(value = "med_ins_other_fee")
+ private Long medInsOtherFee;
+
+ /**
+ *
+ * 字段名:医保现金支付金额
+ * 变量名:med_ins_cash_fee
+ * 是否必填:否
+ * 类型:long
+ * 描述:
+ * 医保现金支付金额,单位为分
+ *
+ */
+ @SerializedName(value = "med_ins_cash_fee")
+ private Long medInsCashFee;
+
+ /**
+ *
+ * 字段名:微信支付现金支付金额
+ * 变量名:wechat_pay_cash_fee
+ * 是否必填:否
+ * 类型:long
+ * 描述:
+ * 微信支付现金支付金额,单位为分
+ *
+ */
+ @SerializedName(value = "wechat_pay_cash_fee")
+ private Long wechatPayCashFee;
+
+ /**
+ *
+ * 字段名:附加数据
+ * 变量名:attach
+ * 是否必填:否
+ * 类型:string(128)
+ * 描述:
+ * 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用
+ *
+ */
+ @SerializedName(value = "attach")
+ private String attach;
+
+ /**
+ *
+ * 字段名:支付状态
+ * 变量名:trade_state
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 交易状态,枚举值:
+ * SUCCESS:支付成功
+ * REFUND:转入退款
+ * NOTPAY:未支付
+ * CLOSED:已关闭
+ * REVOKED:已撤销
+ * USERPAYING:用户支付中
+ * PAYERROR:支付失败
+ *
+ */
+ @SerializedName(value = "trade_state")
+ private String tradeState;
+
+ /**
+ *
+ * 字段名:支付状态描述
+ * 变量名:trade_state_desc
+ * 是否必填:是
+ * 类型:string(256)
+ * 描述:
+ * 交易状态描述
+ *
+ */
+ @SerializedName(value = "trade_state_desc")
+ private String tradeStateDesc;
+ }
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/MiPayService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/MiPayService.java
new file mode 100644
index 0000000000..83b75ad40c
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/MiPayService.java
@@ -0,0 +1,94 @@
+package com.github.binarywang.wxpay.service;
+
+import com.github.binarywang.wxpay.bean.mipay.MedInsOrdersRequest;
+import com.github.binarywang.wxpay.bean.mipay.MedInsOrdersResult;
+import com.github.binarywang.wxpay.bean.mipay.MedInsRefundNotifyRequest;
+import com.github.binarywang.wxpay.bean.notify.MiPayNotifyV3Result;
+import com.github.binarywang.wxpay.bean.notify.SignatureHeader;
+import com.github.binarywang.wxpay.exception.WxPayException;
+
+/**
+ * 医保相关接口
+ * 医保相关接口
+ * @author xgl
+ * @date 2025/12/20
+ */
+public interface MiPayService {
+
+ /**
+ *
+ * 医保自费混合收款下单
+ *
+ * 从业机构调用该接口向微信医保后台下单
+ *
+ * 文档地址:医保自费混合收款下单
+ *
+ *
+ * @param request 下单参数
+ * @return ReservationTransferNotifyResult 下单结果
+ * @throws WxPayException the wx pay exception
+ */
+ MedInsOrdersResult medInsOrders(MedInsOrdersRequest request) throws WxPayException;
+
+ /**
+ *
+ * 使用医保自费混合订单号查看下单结果
+ *
+ * 从业机构使用混合下单订单号,通过该接口主动查询订单状态,完成下一步的业务逻辑。
+ *
+ * 文档地址:使用医保自费混合订单号查看下单结果
+ *
+ *
+ * @param mixTradeNo 医保自费混合订单号
+ * @param subMchid 医疗机构的商户号
+ * @return MedInsOrdersResult 下单结果
+ * @throws WxPayException the wx pay exception
+ */
+ MedInsOrdersResult getMedInsOrderByMixTradeNo(String mixTradeNo, String subMchid) throws WxPayException;
+
+ /**
+ *
+ * 使用从业机构订单号查看下单结果
+ *
+ * 从业机构使用从业机构订单号、医疗机构商户号,通过该接口主动查询订单状态,完成下一步的业务逻辑。
+ *
+ * 文档地址:使用从业机构订单号查看下单结果
+ *
+ *
+ * @param outTradeNo 从业机构订单号
+ * @param subMchid 医疗机构的商户号
+ * @return MedInsOrdersResult 下单结果
+ * @throws WxPayException the wx pay exception
+ */
+ MedInsOrdersResult getMedInsOrderByOutTradeNo(String outTradeNo, String subMchid) throws WxPayException;
+
+ /**
+ *
+ * 解析医保混合收款成功通知
+ *
+ * 微信支付会通过POST请求向商户设置的回调URL推送医保混合收款成功通知,商户需要接收处理该消息,并返回应答。
+ *
+ * 文档地址:医保混合收款成功通知
+ *
+ *
+ * @param notifyData 通知数据字符串
+ * @return MiPayNotifyV3Result 医保混合收款成功通知结果
+ * @throws WxPayException the wx pay exception
+ */
+ MiPayNotifyV3Result parseMiPayNotifyV3Result(String notifyData, SignatureHeader header) throws WxPayException;
+
+ /**
+ *
+ * 医保退款通知
+ *
+ * 从业机构调用该接口向微信医保后台通知医保订单的退款成功结果
+ *
+ * 文档地址:医保退款通知
+ *
+ *
+ * @param request 医保退款通知请求参数
+ * @throws WxPayException the wx pay exception
+ */
+ void medInsRefundNotify(MedInsRefundNotifyRequest request) throws WxPayException;
+
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java
index 93da0d1332..cfb2479ae7 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java
@@ -1706,4 +1706,12 @@ WxPayRefundQueryResult refundQuery(String transactionId, String outTradeNo, Stri
* @return the partner pay score sign plan service
*/
PartnerPayScoreSignPlanService getPartnerPayScoreSignPlanService();
+
+ /**
+ * 获取医保支付服务类
+ *
+ * @return the merchant transfer service
+ */
+ MiPayService getMiPayService();
+
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
index ba3dc37144..f2e343df22 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
@@ -1,17 +1,21 @@
package com.github.binarywang.wxpay.service.impl;
-import com.github.binarywang.utils.qrcode.QrcodeUtils;
-import com.github.binarywang.wxpay.bean.WxPayApiData;
+import static com.github.binarywang.wxpay.constant.WxPayConstants.QUERY_COMMENT_DATE_FORMAT;
+import static com.github.binarywang.wxpay.constant.WxPayConstants.TarType;
import com.github.binarywang.wxpay.bean.coupon.*;
import com.github.binarywang.wxpay.bean.notify.*;
+import com.github.binarywang.wxpay.bean.request.*;
+import com.github.binarywang.wxpay.bean.result.*;
+import com.github.binarywang.wxpay.service.*;
+import java.util.*;
+import com.github.binarywang.wxpay.bean.result.enums.GlobalTradeTypeEnum;
+import com.github.binarywang.wxpay.bean.result.enums.TradeTypeEnum;
+import com.github.binarywang.utils.qrcode.QrcodeUtils;
+import com.github.binarywang.wxpay.bean.WxPayApiData;
import com.github.binarywang.wxpay.bean.order.WxPayAppOrderResult;
import com.github.binarywang.wxpay.bean.order.WxPayMpOrderResult;
import com.github.binarywang.wxpay.bean.order.WxPayMwebOrderResult;
import com.github.binarywang.wxpay.bean.order.WxPayNativeOrderResult;
-import com.github.binarywang.wxpay.bean.request.*;
-import com.github.binarywang.wxpay.bean.result.*;
-import com.github.binarywang.wxpay.bean.result.enums.TradeTypeEnum;
-import com.github.binarywang.wxpay.bean.result.enums.GlobalTradeTypeEnum;
import com.github.binarywang.wxpay.bean.transfer.TransferBillsNotifyResult;
import com.github.binarywang.wxpay.config.WxPayConfig;
import com.github.binarywang.wxpay.config.WxPayConfigHolder;
@@ -19,7 +23,6 @@
import com.github.binarywang.wxpay.constant.WxPayConstants.TradeType;
import com.github.binarywang.wxpay.exception.WxPayException;
import com.github.binarywang.wxpay.exception.WxSignTestException;
-import com.github.binarywang.wxpay.service.*;
import com.github.binarywang.wxpay.util.SignUtils;
import com.github.binarywang.wxpay.util.XmlConfig;
import com.github.binarywang.wxpay.util.ZipUtils;
@@ -29,14 +32,6 @@
import com.google.common.collect.Maps;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
-import lombok.Getter;
-import lombok.Setter;
-import lombok.extern.slf4j.Slf4j;
-import me.chanjar.weixin.common.error.WxRuntimeException;
-import org.apache.commons.lang3.StringUtils;
-import org.apache.commons.lang3.reflect.ConstructorUtils;
-import org.apache.http.entity.ContentType;
-
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
@@ -45,12 +40,15 @@
import java.nio.file.Path;
import java.nio.file.Paths;
import java.security.GeneralSecurityException;
-import java.util.*;
import java.util.concurrent.ConcurrentHashMap;
import java.util.zip.ZipException;
-
-import static com.github.binarywang.wxpay.constant.WxPayConstants.QUERY_COMMENT_DATE_FORMAT;
-import static com.github.binarywang.wxpay.constant.WxPayConstants.TarType;
+import lombok.Getter;
+import lombok.Setter;
+import lombok.extern.slf4j.Slf4j;
+import me.chanjar.weixin.common.error.WxRuntimeException;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.lang3.reflect.ConstructorUtils;
+import org.apache.http.entity.ContentType;
/**
*
@@ -139,6 +137,9 @@ public abstract class BaseWxPayServiceImpl implements WxPayService {
@Getter
private final BusinessOperationTransferService businessOperationTransferService = new BusinessOperationTransferServiceImpl(this);
+ @Getter
+ private final MiPayService miPayService = new MiPayServiceImpl(this);
+
protected Map
+ * 微信支付实名验证请求对象.
+ * 详见文档:https://pay.wechatpay.cn/doc/v2/merchant/4011987607
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@Builder(builderMethodName = "newBuilder")
+@NoArgsConstructor
+@AllArgsConstructor
+@XStreamAlias("xml")
+public class RealNameRequest extends BaseWxPayRequest {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:用户标识
+ * 变量名:openid
+ * 是否必填:是
+ * 类型:String(128)
+ * 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
+ * 描述:用户在商户appid下的唯一标识
+ *
+ */
+ @Required
+ @XStreamAlias("openid")
+ private String openid;
+
+ @Override
+ protected void checkConstraints() {
+ //do nothing
+ }
+
+ @Override
+ protected void storeMap(Map
+ * 微信支付实名验证返回结果.
+ * 详见文档:https://pay.wechatpay.cn/doc/v2/merchant/4011987607
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@NoArgsConstructor
+@XStreamAlias("xml")
+public class RealNameResult extends BaseWxPayResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:用户标识
+ * 变量名:openid
+ * 是否必填:否
+ * 类型:String(128)
+ * 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
+ * 描述:用户在商户appid下的唯一标识
+ *
+ */
+ @XStreamAlias("openid")
+ private String openid;
+
+ /**
+ *
+ * 字段名:实名认证状态
+ * 变量名:is_certified
+ * 是否必填:是
+ * 类型:String(1)
+ * 示例值:Y
+ * 描述:Y-已实名认证 N-未实名认证
+ *
+ */
+ @XStreamAlias("is_certified")
+ private String isCertified;
+
+ /**
+ *
+ * 字段名:实名认证信息
+ * 变量名:cert_info
+ * 是否必填:否
+ * 类型:String(256)
+ * 示例值:
+ * 描述:实名认证的相关信息,如姓名等(加密)
+ *
+ */
+ @XStreamAlias("cert_info")
+ private String certInfo;
+
+ /**
+ *
+ * 字段名:引导链接
+ * 变量名:guide_url
+ * 是否必填:否
+ * 类型:String(256)
+ * 示例值:
+ * 描述:未实名时,引导用户进行实名认证的URL
+ *
+ */
+ @XStreamAlias("guide_url")
+ private String guideUrl;
+
+ /**
+ * 从XML结构中加载额外的属性
+ *
+ * @param d Document
+ */
+ @Override
+ protected void loadXml(Document d) {
+ openid = readXmlString(d, "openid");
+ isCertified = readXmlString(d, "is_certified");
+ certInfo = readXmlString(d, "cert_info");
+ guideUrl = readXmlString(d, "guide_url");
+ }
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/RealNameService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/RealNameService.java
new file mode 100644
index 0000000000..d69bda7d33
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/RealNameService.java
@@ -0,0 +1,43 @@
+package com.github.binarywang.wxpay.service;
+
+import com.github.binarywang.wxpay.bean.realname.RealNameRequest;
+import com.github.binarywang.wxpay.bean.realname.RealNameResult;
+import com.github.binarywang.wxpay.exception.WxPayException;
+
+/**
+ *
+ * 微信支付实名验证相关服务类.
+ * 详见文档:https://pay.wechatpay.cn/doc/v2/merchant/4011987607
+ *
+ *
+ * @author Binary Wang
+ */
+public interface RealNameService {
+ /**
+ *
+ * 获取用户实名认证信息API.
+ * 用于商户查询用户的实名认证状态,如果用户未实名认证,会返回引导用户实名认证的URL
+ * 文档详见:https://pay.wechatpay.cn/doc/v2/merchant/4011987607
+ * 接口链接:https://api.mch.weixin.qq.com/userinfo/realnameauth/query
+ *
+ *
+ * @param request 请求对象
+ * @return 实名认证查询结果
+ * @throws WxPayException the wx pay exception
+ */
+ RealNameResult queryRealName(RealNameRequest request) throws WxPayException;
+
+ /**
+ *
+ * 获取用户实名认证信息API(简化方法).
+ * 用于商户查询用户的实名认证状态,如果用户未实名认证,会返回引导用户实名认证的URL
+ * 文档详见:https://pay.wechatpay.cn/doc/v2/merchant/4011987607
+ * 接口链接:https://api.mch.weixin.qq.com/userinfo/realnameauth/query
+ *
+ *
+ * @param openid 用户openid
+ * @return 实名认证查询结果
+ * @throws WxPayException the wx pay exception
+ */
+ RealNameResult queryRealName(String openid) throws WxPayException;
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java
index cfb2479ae7..dab89a0142 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java
@@ -1707,6 +1707,13 @@ WxPayRefundQueryResult refundQuery(String transactionId, String outTradeNo, Stri
*/
PartnerPayScoreSignPlanService getPartnerPayScoreSignPlanService();
+ /**
+ * 获取实名验证服务类
+ *
+ * @return the real name service
+ */
+ RealNameService getRealNameService();
+
/**
* 获取医保支付服务类
*
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
index f2e343df22..b4c2b919a4 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
@@ -137,6 +137,9 @@ public abstract class BaseWxPayServiceImpl implements WxPayService {
@Getter
private final BusinessOperationTransferService businessOperationTransferService = new BusinessOperationTransferServiceImpl(this);
+ @Getter
+ private final RealNameService realNameService = new RealNameServiceImpl(this);
+
@Getter
private final MiPayService miPayService = new MiPayServiceImpl(this);
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/RealNameServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/RealNameServiceImpl.java
new file mode 100644
index 0000000000..9a1c57fe0f
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/RealNameServiceImpl.java
@@ -0,0 +1,41 @@
+package com.github.binarywang.wxpay.service.impl;
+
+import com.github.binarywang.wxpay.bean.realname.RealNameRequest;
+import com.github.binarywang.wxpay.bean.realname.RealNameResult;
+import com.github.binarywang.wxpay.bean.result.BaseWxPayResult;
+import com.github.binarywang.wxpay.exception.WxPayException;
+import com.github.binarywang.wxpay.service.RealNameService;
+import com.github.binarywang.wxpay.service.WxPayService;
+import lombok.RequiredArgsConstructor;
+
+/**
+ *
+ * 微信支付实名验证相关服务实现类.
+ * 详见文档:https://pay.wechatpay.cn/doc/v2/merchant/4011987607
+ *
+ *
+ * @author Binary Wang
+ */
+@RequiredArgsConstructor
+public class RealNameServiceImpl implements RealNameService {
+ private final WxPayService payService;
+
+ @Override
+ public RealNameResult queryRealName(RealNameRequest request) throws WxPayException {
+ request.checkAndSign(this.payService.getConfig());
+ String url = this.payService.getPayBaseUrl() + "/userinfo/realnameauth/query";
+
+ String responseContent = this.payService.post(url, request.toXML(), true);
+ RealNameResult result = BaseWxPayResult.fromXML(responseContent, RealNameResult.class);
+ result.checkResult(this.payService, request.getSignType(), true);
+ return result;
+ }
+
+ @Override
+ public RealNameResult queryRealName(String openid) throws WxPayException {
+ RealNameRequest request = RealNameRequest.newBuilder()
+ .openid(openid)
+ .build();
+ return this.queryRealName(request);
+ }
+}
diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/RealNameServiceImplTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/RealNameServiceImplTest.java
new file mode 100644
index 0000000000..dda2371948
--- /dev/null
+++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/RealNameServiceImplTest.java
@@ -0,0 +1,54 @@
+package com.github.binarywang.wxpay.service.impl;
+
+import com.github.binarywang.wxpay.bean.realname.RealNameRequest;
+import com.github.binarywang.wxpay.bean.realname.RealNameResult;
+import com.github.binarywang.wxpay.exception.WxPayException;
+import com.github.binarywang.wxpay.service.WxPayService;
+import com.github.binarywang.wxpay.testbase.ApiTestModule;
+import com.google.inject.Inject;
+import lombok.extern.slf4j.Slf4j;
+import org.testng.annotations.Guice;
+import org.testng.annotations.Test;
+
+/**
+ *
+ * 实名验证测试类.
+ *
+ *
+ * @author Binary Wang
+ */
+@Test
+@Guice(modules = ApiTestModule.class)
+@Slf4j
+public class RealNameServiceImplTest {
+
+ @Inject
+ private WxPayService payService;
+
+ /**
+ * 测试查询用户实名认证信息.
+ *
+ * @throws WxPayException the wx pay exception
+ */
+ @Test
+ public void testQueryRealName() throws WxPayException {
+ RealNameRequest request = RealNameRequest.newBuilder()
+ .openid("oUpF8uMuAJO_M2pxb1Q9zNjWeS6o")
+ .build();
+
+ RealNameResult result = this.payService.getRealNameService().queryRealName(request);
+ log.info("实名认证查询结果:{}", result);
+ }
+
+ /**
+ * 测试查询用户实名认证信息(简化方法).
+ *
+ * @throws WxPayException the wx pay exception
+ */
+ @Test
+ public void testQueryRealNameSimple() throws WxPayException {
+ RealNameResult result = this.payService.getRealNameService()
+ .queryRealName("oUpF8uMuAJO_M2pxb1Q9zNjWeS6o");
+ log.info("实名认证查询结果:{}", result);
+ }
+}
From 14537479c75261ffe6618380eb764f527fc2b685 Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Sat, 20 Dec 2025 20:07:04 +0800
Subject: [PATCH 121/208] =?UTF-8?q?:art:=20#3813=20=E3=80=90=E5=BE=AE?=
=?UTF-8?q?=E4=BF=A1=E6=94=AF=E4=BB=98=E3=80=91=E4=BF=AE=E5=A4=8D=E5=A7=94?=
=?UTF-8?q?=E6=89=98=E4=BB=A3=E6=89=A3=E5=8D=8F=E8=AE=AE=E5=AD=97=E6=AE=B5?=
=?UTF-8?q?=E5=90=8D=E6=8B=BC=E5=86=99=E9=94=99=E8=AF=AF?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../binarywang/wxpay/bean/result/WxSignQueryResult.java | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxSignQueryResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxSignQueryResult.java
index 808b9d7ddf..5241597194 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxSignQueryResult.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxSignQueryResult.java
@@ -86,7 +86,7 @@ public class WxSignQueryResult extends BaseWxPayResult implements Serializable {
* 协议解约方式
* 非必传
*/
- @XStreamAlias("contract_terminated_mode")
+ @XStreamAlias("contract_termination_mode")
private Integer contractTerminatedMode;
/**
@@ -114,7 +114,7 @@ protected void loadXml(Document d) {
contractSignedTime = readXmlString(d, "contract_signed_time");
contractExpiredTime = readXmlString(d, "contrace_Expired_time");
contractTerminatedTime = readXmlString(d, "contract_terminated_time");
- contractTerminatedMode = readXmlInteger(d, "contract_terminate_mode");
+ contractTerminatedMode = readXmlInteger(d, "contract_termination_mode");
contractTerminationRemark = readXmlString(d, "contract_termination_remark");
openId = readXmlString(d, "openid");
}
From 58cdef951fff41a02ee4e72f41b5c2ce1dbda893 Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Sat, 20 Dec 2025 20:08:30 +0800
Subject: [PATCH 122/208] =?UTF-8?q?:new:=20#3811=20=E3=80=90=E5=B0=8F?=
=?UTF-8?q?=E7=A8=8B=E5=BA=8F=E3=80=91=E6=B7=BB=E5=8A=A0=E5=B0=8F=E6=B8=B8?=
=?UTF-8?q?=E6=88=8F=E9=81=93=E5=85=B7=E7=9B=B4=E8=B4=AD=EF=BC=88present?=
=?UTF-8?q?=5Fgoods=EF=BC=89API=E7=9A=84=E6=94=AF=E6=8C=81?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../wx/miniapp/api/WxMaXPayService.java | 10 +++
.../miniapp/api/impl/WxMaXPayServiceImpl.java | 16 +++++
.../xpay/WxMaXPayPresentGoodsRequest.java | 63 +++++++++++++++++++
.../xpay/WxMaXPayPresentGoodsResponse.java | 34 ++++++++++
.../miniapp/constant/WxMaApiUrlConstants.java | 1 +
5 files changed, 124 insertions(+)
create mode 100644 weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/xpay/WxMaXPayPresentGoodsRequest.java
create mode 100644 weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/xpay/WxMaXPayPresentGoodsResponse.java
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaXPayService.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaXPayService.java
index a633c93de6..68d4dc0c97 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaXPayService.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaXPayService.java
@@ -71,6 +71,16 @@ public interface WxMaXPayService {
*/
WxMaXPayPresentCurrencyResponse presentCurrency(WxMaXPayPresentCurrencyRequest request, WxMaXPaySigParams sigParams) throws WxErrorException;
+ /**
+ * 道具直购。
+ *
+ * @param request 道具直购请求对象
+ * @param sigParams 签名参数对象
+ * @return 道具直购结果
+ * @throws WxErrorException 直购失败时抛出
+ */
+ WxMaXPayPresentGoodsResponse presentGoods(WxMaXPayPresentGoodsRequest request, WxMaXPaySigParams sigParams) throws WxErrorException;
+
/**
* 下载对账单。
*
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/WxMaXPayServiceImpl.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/WxMaXPayServiceImpl.java
index 29a7c51a2c..37cf5e0d4e 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/WxMaXPayServiceImpl.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/WxMaXPayServiceImpl.java
@@ -108,6 +108,22 @@ public WxMaXPayPresentCurrencyResponse presentCurrency(WxMaXPayPresentCurrencyRe
return getDetailResponse;
}
+ @Override
+ public WxMaXPayPresentGoodsResponse presentGoods(WxMaXPayPresentGoodsRequest request, WxMaXPaySigParams sigParams) throws WxErrorException {
+ final String postBody = request.toJson();
+ final String uri = sigParams.signUriWithPay(PRESENT_GOODS_URL, postBody);
+ String responseContent = this.service.post(uri, postBody);
+ WxMaXPayPresentGoodsResponse getDetailResponse = WxMaGsonBuilder.create()
+ .fromJson(responseContent, WxMaXPayPresentGoodsResponse.class);
+
+ if (getDetailResponse.getErrcode() != 0) {
+ throw new WxErrorException(
+ new WxError(getDetailResponse.getErrcode(), getDetailResponse.getErrmsg()));
+ }
+
+ return getDetailResponse;
+ }
+
@Override
public WxMaXPayDownloadBillResponse downloadBill(WxMaXPayDownloadBillRequest request, WxMaXPaySigParams sigParams) throws WxErrorException {
final String postBody = request.toJson();
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/xpay/WxMaXPayPresentGoodsRequest.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/xpay/WxMaXPayPresentGoodsRequest.java
new file mode 100644
index 0000000000..ba9d7100da
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/xpay/WxMaXPayPresentGoodsRequest.java
@@ -0,0 +1,63 @@
+package cn.binarywang.wx.miniapp.bean.xpay;
+
+import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder;
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 小游戏道具直购API请求.
+ *
+ * @author Binary Wang
+ */
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class WxMaXPayPresentGoodsRequest implements Serializable {
+ private static final long serialVersionUID = 7495157056049312109L;
+
+ /**
+ * 用户的openid.
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ * 环境。0-正式环境;1-沙箱环境.
+ */
+ @SerializedName("env")
+ private Integer env;
+
+ /**
+ * 商户订单号.
+ */
+ @SerializedName("order_id")
+ private String orderId;
+
+ /**
+ * 设备类型。0-安卓;1-iOS.
+ */
+ @SerializedName("device_type")
+ private Integer deviceType;
+
+ /**
+ * 道具id.
+ */
+ @SerializedName("goods_id")
+ private String goodsId;
+
+ /**
+ * 道具数量.
+ */
+ @SerializedName("goods_number")
+ private Integer goodsNumber;
+
+ public String toJson() {
+ return WxMaGsonBuilder.create().toJson(this);
+ }
+}
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/xpay/WxMaXPayPresentGoodsResponse.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/xpay/WxMaXPayPresentGoodsResponse.java
new file mode 100644
index 0000000000..ed3ea8d7f0
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/xpay/WxMaXPayPresentGoodsResponse.java
@@ -0,0 +1,34 @@
+package cn.binarywang.wx.miniapp.bean.xpay;
+
+import cn.binarywang.wx.miniapp.bean.WxMaBaseResponse;
+import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder;
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 小游戏道具直购API响应.
+ *
+ * @author Binary Wang
+ */
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class WxMaXPayPresentGoodsResponse extends WxMaBaseResponse implements Serializable {
+ private static final long serialVersionUID = 7495157056049312110L;
+
+ /**
+ * 商户订单号.
+ */
+ @SerializedName("order_id")
+ private String orderId;
+
+ public String toJson() {
+ return WxMaGsonBuilder.create().toJson(this);
+ }
+}
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/constant/WxMaApiUrlConstants.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/constant/WxMaApiUrlConstants.java
index 45e1219659..3963286394 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/constant/WxMaApiUrlConstants.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/constant/WxMaApiUrlConstants.java
@@ -875,6 +875,7 @@ public interface XPay {
String NOTIFY_PROVIDE_GOODS_URL =
"https://api.weixin.qq.com/xpay/notify_provide_goods?pay_sig=%s";
String PRESENT_CURRENCY_URL = "https://api.weixin.qq.com/xpay/present_currency?pay_sig=%s";
+ String PRESENT_GOODS_URL = "https://api.weixin.qq.com/xpay/present_goods?pay_sig=%s";
String DOWNLOAD_BILL_URL = "https://api.weixin.qq.com/xpay/download_bill?pay_sig=%s";
String REFUND_ORDER_URL = "https://api.weixin.qq.com/xpay/refund_order?pay_sig=%s";
String CREATE_WITHDRAW_ORDER_URL =
From 621b8dc0e457302484054d3b1a997bc7da75b220 Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Sun, 21 Dec 2025 17:31:53 +0800
Subject: [PATCH 123/208] =?UTF-8?q?:new:=20#3812=20=E3=80=90=E5=B0=8F?=
=?UTF-8?q?=E7=A8=8B=E5=BA=8F=E3=80=91=E5=AE=9E=E7=8E=B0=E7=94=A8=E5=B7=A5?=
=?UTF-8?q?=E5=85=B3=E7=B3=BBAPI=E6=94=AF=E6=8C=81?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../api/WxMaEmployeeRelationService.java | 41 +++++++++++++
.../wx/miniapp/api/WxMaService.java | 9 +++
.../miniapp/api/impl/BaseWxMaServiceImpl.java | 7 +++
.../impl/WxMaEmployeeRelationServiceImpl.java | 32 ++++++++++
.../employee/WxMaSendEmployeeMsgRequest.java | 61 +++++++++++++++++++
.../employee/WxMaUnbindEmployeeRequest.java | 51 ++++++++++++++++
.../miniapp/constant/WxMaApiUrlConstants.java | 8 +++
7 files changed, 209 insertions(+)
create mode 100644 weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaEmployeeRelationService.java
create mode 100644 weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/WxMaEmployeeRelationServiceImpl.java
create mode 100644 weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/employee/WxMaSendEmployeeMsgRequest.java
create mode 100644 weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/employee/WxMaUnbindEmployeeRequest.java
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaEmployeeRelationService.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaEmployeeRelationService.java
new file mode 100644
index 0000000000..4c0a74b2ce
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaEmployeeRelationService.java
@@ -0,0 +1,41 @@
+package cn.binarywang.wx.miniapp.api;
+
+import cn.binarywang.wx.miniapp.bean.employee.WxMaSendEmployeeMsgRequest;
+import cn.binarywang.wx.miniapp.bean.employee.WxMaUnbindEmployeeRequest;
+import me.chanjar.weixin.common.error.WxErrorException;
+
+/**
+ * 小程序用工关系相关操作接口
+ *
+ * 文档:https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/laboruse/intro.html
+ *
+ * @return 用工关系服务对象WxMaEmployeeRelationService
+ */
+ WxMaEmployeeRelationService getEmployeeRelationService();
}
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java
index 93bb2656e6..c0e1ff4a4e 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java
@@ -167,6 +167,8 @@ public abstract class BaseWxMaServiceImpl
+ * 字段名:用户openid
+ * 是否必填:是
+ * 描述:需要接收消息的用户openid
+ *
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ *
+ * 字段名:企业id
+ * 是否必填:是
+ * 描述:企业id,小程序管理员在微信开放平台配置
+ *
+ */
+ @SerializedName("corp_id")
+ private String corpId;
+
+ /**
+ *
+ * 字段名:消息内容
+ * 是否必填:是
+ * 描述:推送的消息内容,文本格式,最长不超过200个字符
+ *
+ */
+ @SerializedName("msg")
+ private String msg;
+
+ public String toJson() {
+ return WxMaGsonBuilder.create().toJson(this);
+ }
+}
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/employee/WxMaUnbindEmployeeRequest.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/employee/WxMaUnbindEmployeeRequest.java
new file mode 100644
index 0000000000..e56d84670c
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/employee/WxMaUnbindEmployeeRequest.java
@@ -0,0 +1,51 @@
+package cn.binarywang.wx.miniapp.bean.employee;
+
+import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder;
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 小程序解绑用工关系请求实体
+ *
+ * 字段名:用户openid
+ * 是否必填:是
+ * 描述:需要解绑的用户openid
+ *
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ *
+ * 字段名:企业id
+ * 是否必填:是
+ * 描述:企业id,小程序管理员在微信开放平台配置
+ *
+ */
+ @SerializedName("corp_id")
+ private String corpId;
+
+ public String toJson() {
+ return WxMaGsonBuilder.create().toJson(this);
+ }
+}
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/constant/WxMaApiUrlConstants.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/constant/WxMaApiUrlConstants.java
index 3963286394..76625334f4 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/constant/WxMaApiUrlConstants.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/constant/WxMaApiUrlConstants.java
@@ -997,4 +997,12 @@ public interface Complaint {
/** 上传反馈图片 */
String UPLOAD_RESPONSE_IMAGE_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/upload";
}
+
+ /** 用工关系 */
+ public interface Employee {
+ /** 解绑用工关系 */
+ String UNBIND_EMPLOYEE_URL = "https://api.weixin.qq.com/wxa/unbinduserb2cauthinfo";
+ /** 推送用工消息 */
+ String SEND_EMPLOYEE_MSG_URL = "https://api.weixin.qq.com/wxa/sendemployeerelationmsg";
+ }
}
From b0d9c6cc7679688fbdb3f29559d16755a13671f9 Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Sun, 21 Dec 2025 17:49:11 +0800
Subject: [PATCH 124/208] =?UTF-8?q?:new:=20#3717=20=E3=80=90=E5=BE=AE?=
=?UTF-8?q?=E4=BF=A1=E6=94=AF=E4=BB=98=E3=80=91=E5=95=86=E6=88=B7=E8=BD=AC?=
=?UTF-8?q?=E8=B4=A6=E6=96=B0=E5=A2=9E=E5=85=8D=E7=A1=AE=E8=AE=A4=E6=94=B6?=
=?UTF-8?q?=E6=AC=BE=E6=8E=88=E6=9D=83=E6=A8=A1=E5=BC=8F=E6=94=AF=E6=8C=81?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/NEW_TRANSFER_API_SUPPORT.md | 25 ++++
docs/NEW_TRANSFER_API_USAGE.md | 94 +++++++++++++++
.../bean/transfer/TransferBillsRequest.java | 20 ++++
.../wxpay/constant/WxPayConstants.java | 21 ++++
.../wxpay/example/NewTransferApiExample.java | 112 +++++++++++++++++-
5 files changed, 268 insertions(+), 4 deletions(-)
diff --git a/docs/NEW_TRANSFER_API_SUPPORT.md b/docs/NEW_TRANSFER_API_SUPPORT.md
index c7e9eaf490..835ff7d518 100644
--- a/docs/NEW_TRANSFER_API_SUPPORT.md
+++ b/docs/NEW_TRANSFER_API_SUPPORT.md
@@ -17,6 +17,7 @@
| **转账方式** | 批量转账 | 单笔转账 |
| **场景支持** | 基础场景 | 丰富场景(如佣金报酬等) |
| **撤销功能** | ❌ 不支持 | ✅ 支持 |
+| **授权模式** | 仅需确认模式 | ✅ 支持免确认授权模式 |
| **适用范围** | 所有商户 | **新开通商户必须使用** |
### 2. 新版API功能列表
@@ -27,6 +28,30 @@
✅ **回调通知** - `parseTransferBillsNotifyResult()`
✅ **RSA加密** - 自动处理用户姓名加密
✅ **场景支持** - 支持多种转账场景ID
+✅ **授权模式** - 支持免确认收款授权模式
+
+### 3. 收款授权模式支持
+
+**新增功能:免确认收款授权模式**
+
+- **需确认收款授权模式**(默认):用户需要手动确认才能收款
+- **免确认收款授权模式**:用户授权后,收款无需确认,转账直接到账
+
+#### 使用方法
+
+```java
+// 免确认授权模式 - 提升用户体验
+TransferBillsRequest request = TransferBillsRequest.newBuilder()
+ .receiptAuthorizationMode(WxPayConstants.ReceiptAuthorizationMode.NO_CONFIRM_RECEIPT_AUTHORIZATION)
+ // 其他参数...
+ .build();
+
+// 需确认授权模式(默认)
+TransferBillsRequest request2 = TransferBillsRequest.newBuilder()
+ .receiptAuthorizationMode(WxPayConstants.ReceiptAuthorizationMode.CONFIRM_RECEIPT_AUTHORIZATION)
+ // 其他参数...
+ .build();
+```
## 快速开始
diff --git a/docs/NEW_TRANSFER_API_USAGE.md b/docs/NEW_TRANSFER_API_USAGE.md
index 9d1ac8254a..7b1a8da4ea 100644
--- a/docs/NEW_TRANSFER_API_USAGE.md
+++ b/docs/NEW_TRANSFER_API_USAGE.md
@@ -16,6 +16,100 @@
- **API前缀**: `/v3/fund-app/mch-transfer/transfer-bills`
- **特点**: 单笔转账,支持更丰富的转账场景
+## 收款授权模式功能
+
+### 授权模式说明
+
+微信支付转账支持两种收款授权模式:
+
+#### 1. 需确认收款授权模式(默认)
+- **常量**: `WxPayConstants.ReceiptAuthorizationMode.CONFIRM_RECEIPT_AUTHORIZATION`
+- **特点**: 用户收到转账后需要手动点击确认才能到账
+- **适用场景**: 一般的转账场景
+- **用户体验**: 安全性高,但需要额外操作
+
+#### 2. 免确认收款授权模式
+- **常量**: `WxPayConstants.ReceiptAuthorizationMode.NO_CONFIRM_RECEIPT_AUTHORIZATION`
+- **特点**: 用户事先授权后,转账直接到账,无需确认
+- **适用场景**: 高频转账场景,如佣金发放、返现等
+- **用户体验**: 体验流畅,无需额外操作
+- **前提条件**: 需要用户事先进行授权
+
+### 使用示例
+
+#### 免确认授权模式转账
+
+```java
+TransferBillsRequest request = TransferBillsRequest.newBuilder()
+ .appid("your_appid")
+ .outBillNo("NO_CONFIRM_" + System.currentTimeMillis())
+ .transferSceneId("1005") // 佣金报酬场景
+ .openid("user_openid")
+ .transferAmount(200) // 2元
+ .transferRemark("免确认收款转账")
+ .receiptAuthorizationMode(WxPayConstants.ReceiptAuthorizationMode.NO_CONFIRM_RECEIPT_AUTHORIZATION)
+ .userRecvPerception("Y")
+ .build();
+
+try {
+ TransferBillsResult result = transferService.transferBills(request);
+ System.out.println("转账成功,直接到账:" + result.getTransferBillNo());
+} catch (WxPayException e) {
+ if ("USER_NOT_AUTHORIZED".equals(e.getErrCode())) {
+ System.err.println("用户未授权免确认收款,请先引导用户进行授权");
+ }
+}
+```
+
+#### 需确认授权模式转账(默认)
+
+```java
+TransferBillsRequest request = TransferBillsRequest.newBuilder()
+ .appid("your_appid")
+ .outBillNo("CONFIRM_" + System.currentTimeMillis())
+ .transferSceneId("1005")
+ .openid("user_openid")
+ .transferAmount(150) // 1.5元
+ .transferRemark("需确认收款转账")
+ // .receiptAuthorizationMode(...) // 不设置时使用默认的确认模式
+ .userRecvPerception("Y")
+ .build();
+
+TransferBillsResult result = transferService.transferBills(request);
+System.out.println("转账发起成功,等待用户确认:" + result.getPackageInfo());
+```
+
+### 错误处理
+
+使用免确认授权模式时,需要处理以下可能的错误:
+
+```java
+try {
+ TransferBillsResult result = transferService.transferBills(request);
+} catch (WxPayException e) {
+ switch (e.getErrCode()) {
+ case "USER_NOT_AUTHORIZED":
+ // 用户未授权免确认收款
+ System.err.println("请先引导用户进行免确认收款授权");
+ // 可以引导用户到授权页面
+ break;
+ case "AUTHORIZATION_EXPIRED":
+ // 授权已过期
+ System.err.println("用户授权已过期,请重新授权");
+ break;
+ default:
+ System.err.println("转账失败:" + e.getMessage());
+ }
+}
+```
+
+### 使用建议
+
+1. **高频转账场景**推荐使用免确认模式,提升用户体验
+2. **首次使用**需引导用户进行授权
+3. **处理异常**妥善处理授权相关异常,提供友好的错误提示
+4. **场景选择**根据业务场景选择合适的授权模式
+
## 使用新版转账API
### 1. 获取服务实例
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/TransferBillsRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/TransferBillsRequest.java
index 230e564e4b..2ac4b08c93 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/TransferBillsRequest.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/TransferBillsRequest.java
@@ -87,6 +87,26 @@ public class TransferBillsRequest implements Serializable {
@SerializedName("transfer_scene_report_infos")
private List
+ * 字段名:收款授权模式
+ * 变量名:receipt_authorization_mode
+ * 是否必填:否
+ * 类型:string
+ * 描述:
+ * 控制收款方式的授权模式,可选值:
+ * - CONFIRM_RECEIPT_AUTHORIZATION:需确认收款授权模式(默认值)
+ * - NO_CONFIRM_RECEIPT_AUTHORIZATION:免确认收款授权模式(需要用户事先授权)
+ * 为空时,默认为需确认收款授权模式
+ * 示例值:NO_CONFIRM_RECEIPT_AUTHORIZATION
+ *
+ *
+ * @see com.github.binarywang.wxpay.constant.WxPayConstants.ReceiptAuthorizationMode
+ */
+ @SerializedName("receipt_authorization_mode")
+ private String receiptAuthorizationMode;
+
@Data
@Builder(builderMethodName = "newBuilder")
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/constant/WxPayConstants.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/constant/WxPayConstants.java
index ec9e14ff2d..2b736691b7 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/constant/WxPayConstants.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/constant/WxPayConstants.java
@@ -524,4 +524,25 @@ public static class CASH_MARKETING {
}
}
+
+ /**
+ * 收款授权模式
+ *
+ * @see 官方文档
+ */
+ @UtilityClass
+ public static class ReceiptAuthorizationMode {
+ /**
+ * 需确认收款授权模式(默认值)
+ * 用户需要手动确认才能收款
+ */
+ public static final String CONFIRM_RECEIPT_AUTHORIZATION = "CONFIRM_RECEIPT_AUTHORIZATION";
+
+ /**
+ * 免确认收款授权模式
+ * 用户授权后,收款不需要确认,转账直接到账
+ */
+ public static final String NO_CONFIRM_RECEIPT_AUTHORIZATION = "NO_CONFIRM_RECEIPT_AUTHORIZATION";
+ }
+
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/NewTransferApiExample.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/NewTransferApiExample.java
index 8d74e5a4ef..228234d589 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/NewTransferApiExample.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/NewTransferApiExample.java
@@ -3,6 +3,7 @@
import com.github.binarywang.wxpay.bean.notify.SignatureHeader;
import com.github.binarywang.wxpay.bean.transfer.*;
import com.github.binarywang.wxpay.config.WxPayConfig;
+import com.github.binarywang.wxpay.constant.WxPayConstants;
import com.github.binarywang.wxpay.exception.WxPayException;
import com.github.binarywang.wxpay.service.TransferService;
import com.github.binarywang.wxpay.service.WxPayService;
@@ -215,6 +216,100 @@ public void batchTransferExample() {
}
}
+ /**
+ * 使用免确认收款授权模式进行转账示例
+ * 注意:使用此模式前,用户需要先进行授权
+ */
+ public void transferWithNoConfirmAuthModeExample() {
+ try {
+ // 构建转账请求,使用免确认收款授权模式
+ TransferBillsRequest request = TransferBillsRequest.newBuilder()
+ .appid("wx1234567890123456")
+ .outBillNo("NO_CONFIRM_" + System.currentTimeMillis()) // 商户转账单号
+ .transferSceneId("1005") // 转账场景ID(佣金报酬)
+ .openid("oUpF8uMuAJO_M2pxb1Q9zNjWeS6o") // 收款用户的openid
+ .transferAmount(200) // 转账金额,单位:分(此处为2元)
+ .transferRemark("免确认收款转账") // 转账备注
+ .receiptAuthorizationMode(WxPayConstants.ReceiptAuthorizationMode.NO_CONFIRM_RECEIPT_AUTHORIZATION)
+ .userRecvPerception("Y") // 用户收款感知
+ .build();
+
+ // 发起转账
+ TransferBillsResult result = transferService.transferBills(request);
+
+ System.out.println("=== 免确认授权模式转账成功 ===");
+ System.out.println("商户单号: " + result.getOutBillNo());
+ System.out.println("微信转账单号: " + result.getTransferBillNo());
+ System.out.println("状态: " + result.getState());
+ System.out.println("说明: 使用免确认授权模式,转账直接到账,无需用户确认");
+
+ } catch (WxPayException e) {
+ System.err.println("免确认授权转账失败: " + e.getMessage());
+ System.err.println("错误代码: " + e.getErrCode());
+
+ // 可能的错误原因
+ if ("USER_NOT_AUTHORIZED".equals(e.getErrCode())) {
+ System.err.println("用户未授权免确认收款,请先引导用户进行授权");
+ }
+ }
+ }
+
+ /**
+ * 使用需确认收款授权模式进行转账示例(默认模式)
+ */
+ public void transferWithConfirmAuthModeExample() {
+ try {
+ // 构建转账请求,显式设置为需确认收款授权模式
+ TransferBillsRequest request = TransferBillsRequest.newBuilder()
+ .appid("wx1234567890123456")
+ .outBillNo("CONFIRM_" + System.currentTimeMillis()) // 商户转账单号
+ .transferSceneId("1005") // 转账场景ID
+ .openid("oUpF8uMuAJO_M2pxb1Q9zNjWeS6o") // 收款用户的openid
+ .transferAmount(150) // 转账金额,单位:分(此处为1.5元)
+ .transferRemark("需确认收款转账") // 转账备注
+ .receiptAuthorizationMode(WxPayConstants.ReceiptAuthorizationMode.CONFIRM_RECEIPT_AUTHORIZATION)
+ .userRecvPerception("Y") // 用户收款感知
+ .build();
+
+ // 发起转账
+ TransferBillsResult result = transferService.transferBills(request);
+
+ System.out.println("=== 需确认授权模式转账成功 ===");
+ System.out.println("商户单号: " + result.getOutBillNo());
+ System.out.println("微信转账单号: " + result.getTransferBillNo());
+ System.out.println("状态: " + result.getState());
+ System.out.println("packageInfo: " + result.getPackageInfo());
+ System.out.println("说明: 使用需确认授权模式,用户需要手动确认才能收款");
+
+ } catch (WxPayException e) {
+ System.err.println("需确认授权转账失败: " + e.getMessage());
+ }
+ }
+
+ /**
+ * 权限模式对比示例
+ * 展示两种权限模式的区别和使用场景
+ */
+ public void authModeComparisonExample() {
+ System.out.println("\n=== 收款授权模式对比 ===");
+ System.out.println("1. 需确认收款授权模式 (CONFIRM_RECEIPT_AUTHORIZATION):");
+ System.out.println(" - 这是默认模式");
+ System.out.println(" - 用户收到转账后需要手动点击确认才能到账");
+ System.out.println(" - 适用于一般的转账场景");
+ System.out.println(" - 转账状态可能包含 WAIT_USER_CONFIRM 等待确认状态");
+
+ System.out.println("\n2. 免确认收款授权模式 (NO_CONFIRM_RECEIPT_AUTHORIZATION):");
+ System.out.println(" - 用户事先授权后,转账直接到账,无需确认");
+ System.out.println(" - 提升用户体验,减少操作步骤");
+ System.out.println(" - 适用于高频转账场景,如佣金发放等");
+ System.out.println(" - 需要用户先进行授权,否则会返回授权错误");
+
+ System.out.println("\n使用建议:");
+ System.out.println("- 高频业务场景推荐使用免确认模式,提升用户体验");
+ System.out.println("- 首次使用需引导用户进行授权");
+ System.out.println("- 处理授权相关异常,提供友好的错误提示");
+ }
+
/**
* 使用配置示例
*/
@@ -230,20 +325,29 @@ public static void main(String[] args) {
// 创建示例实例
NewTransferApiExample example = new NewTransferApiExample(config);
+ // 权限模式对比说明
+ example.authModeComparisonExample();
+
// 运行示例
System.out.println("新版商户转账API使用示例");
System.out.println("===============================");
- // 1. 发起单笔转账
+ // 1. 发起转账(使用免确认授权模式)
+ // example.transferWithNoConfirmAuthModeExample();
+
+ // 2. 发起转账(使用需确认授权模式)
+ // example.transferWithConfirmAuthModeExample();
+
+ // 3. 发起单笔转账(默认模式)
example.transferExample();
- // 2. 查询转账结果
+ // 4. 查询转账结果
// example.queryByOutBillNoExample();
- // 3. 撤销转账
+ // 5. 撤销转账
// example.cancelTransferExample();
- // 4. 批量转账(传统API)
+ // 6. 批量转账(传统API)
// example.batchTransferExample();
}
}
\ No newline at end of file
From f249450dbe7fa079aa6d012ef5da9571be9fb074 Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Sun, 21 Dec 2025 18:03:36 +0800
Subject: [PATCH 125/208] =?UTF-8?q?:art:=20#3798=20=E3=80=90=E5=BE=AE?=
=?UTF-8?q?=E4=BF=A1=E6=94=AF=E4=BB=98=E3=80=91=E5=BE=AE=E4=BF=A1=E6=94=AF?=
=?UTF-8?q?=E4=BB=98=E4=B8=8B=E5=8D=95=E6=8E=A5=E5=8F=A3=E7=BB=93=E6=9E=9C?=
=?UTF-8?q?JsapiResult=E7=B1=BB=E4=B8=AD=E6=B7=BB=E5=8A=A0prepayId?=
=?UTF-8?q?=E5=AD=97=E6=AE=B5?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../result/WxPayUnifiedOrderV3Result.java | 138 +++++++--
.../result/WxPayUnifiedOrderV3ResultTest.java | 267 ++++++++++++++++++
2 files changed, 389 insertions(+), 16 deletions(-)
create mode 100644 weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/result/WxPayUnifiedOrderV3ResultTest.java
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxPayUnifiedOrderV3Result.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxPayUnifiedOrderV3Result.java
index 309fb8e752..5b60f3b520 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxPayUnifiedOrderV3Result.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxPayUnifiedOrderV3Result.java
@@ -58,7 +58,7 @@ public class WxPayUnifiedOrderV3Result implements Serializable {
/**
*
* 字段名:二维码链接(NATIVE支付 会返回)
- * 变量名:h5_url
+ * 变量名:code_url
* 是否必填:是
* 类型:string[1,512]
* 描述:
@@ -81,6 +81,19 @@ public static class JsapiResult implements Serializable {
private String packageValue;
private String signType;
private String paySign;
+ /**
+ *
*/
@SerializedName("total_fee")
- public Long totalFee;
+ public Integer totalFee;
/**
*
+ * 字段名:预支付交易会话标识
+ * 变量名:prepay_id
+ * 是否必填:否(用户可选存储)
+ * 类型:string[1,64]
+ * 描述:
+ * 预支付交易会话标识。用于后续接口调用中使用,该值有效期为2小时
+ * 此字段用于支持用户存储prepay_id,以便复用和重新生成支付签名
+ * 示例值:wx201410272009395522657a690389285100
+ *
+ */
+ private String prepayId;
private String getSignStr() {
return String.format("%s\n%s\n%s\n%s\n", appId, timeStamp, nonceStr, packageValue);
@@ -106,30 +119,123 @@ private String getSignStr() {
}
public
+ * 根据已有的prepay_id生成JSAPI支付所需的参数对象(解耦版本)
+ * 应用场景:
+ * 1. 用户已经通过createPartnerOrderV3或unifiedPartnerOrderV3获取了prepay_id
+ * 2. 用户希望存储prepay_id用于后续复用
+ * 3. 支付失败后,使用存储的prepay_id重新生成支付签名信息
+ *
+ * 使用示例:
+ * // 步骤1:创建订单并获取prepay_id
+ * WxPayUnifiedOrderV3Result result = wxPayService.unifiedPartnerOrderV3(TradeTypeEnum.JSAPI, request);
+ * String prepayId = result.getPrepayId();
+ * // 存储prepayId到数据库...
+ *
+ * // 步骤2:需要支付时,使用存储的prepay_id生成支付信息
+ * WxPayUnifiedOrderV3Result.JsapiResult payInfo = WxPayUnifiedOrderV3Result.getJsapiPayInfo(
+ * prepayId, appId, wxPayService.getConfig().getPrivateKey()
+ * );
+ *
+ *
+ * @param prepayId 预支付交易会话标识
+ * @param appId 应用ID
+ * @param privateKey 商户私钥,用于签名
+ * @return JSAPI支付所需的参数对象
+ */
+ public static JsapiResult getJsapiPayInfo(String prepayId, String appId, PrivateKey privateKey) {
+ if (prepayId == null || appId == null || privateKey == null) {
+ throw new IllegalArgumentException("prepayId, appId 和 privateKey 不能为空");
+ }
+ return buildJsapiResult(prepayId, appId, privateKey);
+ }
+
+ /**
+ *
+ * 根据已有的prepay_id生成APP支付所需的参数对象(解耦版本)
+ * 应用场景:
+ * 1. 用户已经通过createPartnerOrderV3或unifiedPartnerOrderV3获取了prepay_id
+ * 2. 用户希望存储prepay_id用于后续复用
+ * 3. 支付失败后,使用存储的prepay_id重新生成支付签名信息
+ *
+ * 使用示例:
+ * // 步骤1:创建订单并获取prepay_id
+ * WxPayUnifiedOrderV3Result result = wxPayService.unifiedPartnerOrderV3(TradeTypeEnum.APP, request);
+ * String prepayId = result.getPrepayId();
+ * // 存储prepayId到数据库...
+ *
+ * // 步骤2:需要支付时,使用存储的prepay_id生成支付信息
+ * WxPayUnifiedOrderV3Result.AppResult payInfo = WxPayUnifiedOrderV3Result.getAppPayInfo(
+ * prepayId, appId, mchId, wxPayService.getConfig().getPrivateKey()
+ * );
+ *
+ *
+ * @param prepayId 预支付交易会话标识
+ * @param appId 应用ID
+ * @param mchId 商户号
+ * @param privateKey 商户私钥,用于签名
+ * @return APP支付所需的参数对象
+ */
+ public static AppResult getAppPayInfo(String prepayId, String appId, String mchId, PrivateKey privateKey) {
+ if (prepayId == null || appId == null || mchId == null || privateKey == null) {
+ throw new IllegalArgumentException("prepayId, appId, mchId 和 privateKey 不能为空");
+ }
+ return buildAppResult(prepayId, appId, mchId, privateKey);
+ }
+
+ /**
+ * 构建JSAPI支付结果对象
+ *
+ * @param prepayId 预支付交易会话标识
+ * @param appId 应用ID
+ * @param privateKey 商户私钥,用于签名
+ * @return JSAPI支付所需的参数对象
+ */
+ private static JsapiResult buildJsapiResult(String prepayId, String appId, PrivateKey privateKey) {
+ String timestamp = String.valueOf(System.currentTimeMillis() / 1000);
+ String nonceStr = SignUtils.genRandomStr();
+ JsapiResult jsapiResult = new JsapiResult();
+ jsapiResult.setAppId(appId).setTimeStamp(timestamp)
+ .setPackageValue("prepay_id=" + prepayId).setNonceStr(nonceStr)
+ .setPrepayId(prepayId)
+ //签名类型,默认为RSA,仅支持RSA。
+ .setSignType("RSA").setPaySign(SignUtils.sign(jsapiResult.getSignStr(), privateKey));
+ return jsapiResult;
+ }
+
+ /**
+ * 构建APP支付结果对象
+ *
+ * @param prepayId 预支付交易会话标识
+ * @param appId 应用ID
+ * @param mchId 商户号
+ * @param privateKey 商户私钥,用于签名
+ * @return APP支付所需的参数对象
+ */
+ private static AppResult buildAppResult(String prepayId, String appId, String mchId, PrivateKey privateKey) {
+ String timestamp = String.valueOf(System.currentTimeMillis() / 1000);
+ String nonceStr = SignUtils.genRandomStr();
+ AppResult appResult = new AppResult();
+ appResult.setAppid(appId).setPrepayId(prepayId).setPartnerId(mchId)
+ .setNoncestr(nonceStr).setTimestamp(timestamp)
+ //暂填写固定值Sign=WXPay
+ .setPackageValue("Sign=WXPay")
+ .setSign(SignUtils.sign(appResult.getSignStr(), privateKey));
+ return appResult;
+ }
}
diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/result/WxPayUnifiedOrderV3ResultTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/result/WxPayUnifiedOrderV3ResultTest.java
new file mode 100644
index 0000000000..2e824b0e00
--- /dev/null
+++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/result/WxPayUnifiedOrderV3ResultTest.java
@@ -0,0 +1,267 @@
+package com.github.binarywang.wxpay.bean.result;
+
+import com.github.binarywang.wxpay.bean.result.enums.TradeTypeEnum;
+import com.github.binarywang.wxpay.v3.util.SignUtils;
+import org.testng.Assert;
+import org.testng.annotations.Test;
+
+import java.security.KeyPair;
+import java.security.KeyPairGenerator;
+import java.security.PrivateKey;
+
+/**
+ *
+ * WxPayUnifiedOrderV3Result 测试类
+ * 主要测试prepayId字段和静态工厂方法的解耦功能
+ *
+ *
+ * @author copilot
+ */
+public class WxPayUnifiedOrderV3ResultTest {
+
+ /**
+ * 生成测试用的RSA密钥对
+ */
+ private KeyPair generateKeyPair() throws Exception {
+ KeyPairGenerator keyPairGenerator = KeyPairGenerator.getInstance("RSA");
+ keyPairGenerator.initialize(2048);
+ return keyPairGenerator.generateKeyPair();
+ }
+
+ /**
+ * 测试JsapiResult中的prepayId字段是否正确设置
+ */
+ @Test
+ public void testJsapiResultWithPrepayId() throws Exception {
+ // 准备测试数据
+ String testPrepayId = "wx201410272009395522657a690389285100";
+ String testAppId = "wx8888888888888888";
+ KeyPair keyPair = generateKeyPair();
+ PrivateKey privateKey = keyPair.getPrivate();
+
+ // 创建WxPayUnifiedOrderV3Result对象
+ WxPayUnifiedOrderV3Result result = new WxPayUnifiedOrderV3Result();
+ result.setPrepayId(testPrepayId);
+
+ // 调用getPayInfo生成JsapiResult
+ WxPayUnifiedOrderV3Result.JsapiResult jsapiResult =
+ result.getPayInfo(TradeTypeEnum.JSAPI, testAppId, null, privateKey);
+
+ // 验证prepayId字段是否正确设置
+ Assert.assertNotNull(jsapiResult.getPrepayId(), "prepayId不应为null");
+ Assert.assertEquals(jsapiResult.getPrepayId(), testPrepayId, "prepayId应该与设置的值相同");
+
+ // 验证其他字段
+ Assert.assertEquals(jsapiResult.getAppId(), testAppId);
+ Assert.assertNotNull(jsapiResult.getTimeStamp());
+ Assert.assertNotNull(jsapiResult.getNonceStr());
+ Assert.assertEquals(jsapiResult.getPackageValue(), "prepay_id=" + testPrepayId);
+ Assert.assertEquals(jsapiResult.getSignType(), "RSA");
+ Assert.assertNotNull(jsapiResult.getPaySign());
+ }
+
+ /**
+ * 测试使用静态工厂方法生成JsapiResult(解耦场景)
+ */
+ @Test
+ public void testGetJsapiPayInfoStaticMethod() throws Exception {
+ // 准备测试数据
+ String testPrepayId = "wx201410272009395522657a690389285100";
+ String testAppId = "wx8888888888888888";
+ KeyPair keyPair = generateKeyPair();
+ PrivateKey privateKey = keyPair.getPrivate();
+
+ // 使用静态工厂方法生成JsapiResult
+ WxPayUnifiedOrderV3Result.JsapiResult jsapiResult =
+ WxPayUnifiedOrderV3Result.getJsapiPayInfo(testPrepayId, testAppId, privateKey);
+
+ // 验证prepayId字段
+ Assert.assertNotNull(jsapiResult.getPrepayId(), "prepayId不应为null");
+ Assert.assertEquals(jsapiResult.getPrepayId(), testPrepayId, "prepayId应该与输入的值相同");
+
+ // 验证其他字段
+ Assert.assertEquals(jsapiResult.getAppId(), testAppId);
+ Assert.assertNotNull(jsapiResult.getTimeStamp());
+ Assert.assertNotNull(jsapiResult.getNonceStr());
+ Assert.assertEquals(jsapiResult.getPackageValue(), "prepay_id=" + testPrepayId);
+ Assert.assertEquals(jsapiResult.getSignType(), "RSA");
+ Assert.assertNotNull(jsapiResult.getPaySign());
+ }
+
+ /**
+ * 测试使用静态工厂方法生成AppResult(解耦场景)
+ */
+ @Test
+ public void testGetAppPayInfoStaticMethod() throws Exception {
+ // 准备测试数据
+ String testPrepayId = "wx201410272009395522657a690389285100";
+ String testAppId = "wx8888888888888888";
+ String testMchId = "1900000109";
+ KeyPair keyPair = generateKeyPair();
+ PrivateKey privateKey = keyPair.getPrivate();
+
+ // 使用静态工厂方法生成AppResult
+ WxPayUnifiedOrderV3Result.AppResult appResult =
+ WxPayUnifiedOrderV3Result.getAppPayInfo(testPrepayId, testAppId, testMchId, privateKey);
+
+ // 验证prepayId字段
+ Assert.assertNotNull(appResult.getPrepayId(), "prepayId不应为null");
+ Assert.assertEquals(appResult.getPrepayId(), testPrepayId, "prepayId应该与输入的值相同");
+
+ // 验证其他字段
+ Assert.assertEquals(appResult.getAppid(), testAppId);
+ Assert.assertEquals(appResult.getPartnerId(), testMchId);
+ Assert.assertNotNull(appResult.getTimestamp());
+ Assert.assertNotNull(appResult.getNoncestr());
+ Assert.assertEquals(appResult.getPackageValue(), "Sign=WXPay");
+ Assert.assertNotNull(appResult.getSign());
+ }
+
+ /**
+ * 测试解耦场景:先获取prepayId,后续再生成支付信息
+ */
+ @Test
+ public void testDecoupledScenario() throws Exception {
+ // 模拟场景:先创建订单获取prepayId
+ String testPrepayId = "wx201410272009395522657a690389285100";
+ String testAppId = "wx8888888888888888";
+ KeyPair keyPair = generateKeyPair();
+ PrivateKey privateKey = keyPair.getPrivate();
+
+ // 步骤1:模拟从创建订单接口获取prepayId
+ WxPayUnifiedOrderV3Result orderResult = new WxPayUnifiedOrderV3Result();
+ orderResult.setPrepayId(testPrepayId);
+
+ // 获取prepayId用于存储
+ String storedPrepayId = orderResult.getPrepayId();
+ Assert.assertEquals(storedPrepayId, testPrepayId);
+
+ // 步骤2:后续支付失败时,使用存储的prepayId重新生成支付信息
+ WxPayUnifiedOrderV3Result.JsapiResult newPayInfo =
+ WxPayUnifiedOrderV3Result.getJsapiPayInfo(storedPrepayId, testAppId, privateKey);
+
+ // 验证重新生成的支付信息
+ Assert.assertEquals(newPayInfo.getPrepayId(), storedPrepayId);
+ Assert.assertEquals(newPayInfo.getPackageValue(), "prepay_id=" + storedPrepayId);
+ Assert.assertNotNull(newPayInfo.getPaySign());
+ }
+
+ /**
+ * 测试多次生成支付信息,签名应该不同(因为timestamp和nonceStr每次都不同)
+ */
+ @Test
+ public void testMultipleGenerationsHaveDifferentSignatures() throws Exception {
+ String testPrepayId = "wx201410272009395522657a690389285100";
+ String testAppId = "wx8888888888888888";
+ KeyPair keyPair = generateKeyPair();
+ PrivateKey privateKey = keyPair.getPrivate();
+
+ // 生成第一次支付信息
+ WxPayUnifiedOrderV3Result.JsapiResult result1 =
+ WxPayUnifiedOrderV3Result.getJsapiPayInfo(testPrepayId, testAppId, privateKey);
+
+ // 等待一秒确保timestamp不同
+ Thread.sleep(1000);
+
+ // 生成第二次支付信息
+ WxPayUnifiedOrderV3Result.JsapiResult result2 =
+ WxPayUnifiedOrderV3Result.getJsapiPayInfo(testPrepayId, testAppId, privateKey);
+
+ // prepayId应该相同
+ Assert.assertEquals(result1.getPrepayId(), result2.getPrepayId());
+
+ // 但是timestamp、nonceStr和签名应该不同
+ Assert.assertNotEquals(result1.getTimeStamp(), result2.getTimeStamp(), "timestamp应该不同");
+ Assert.assertNotEquals(result1.getNonceStr(), result2.getNonceStr(), "nonceStr应该不同");
+ Assert.assertNotEquals(result1.getPaySign(), result2.getPaySign(), "签名应该不同");
+ }
+
+ /**
+ * 测试AppResult中的prepayId字段
+ */
+ @Test
+ public void testAppResultWithPrepayId() throws Exception {
+ String testPrepayId = "wx201410272009395522657a690389285100";
+ String testAppId = "wx8888888888888888";
+ String testMchId = "1900000109";
+ KeyPair keyPair = generateKeyPair();
+ PrivateKey privateKey = keyPair.getPrivate();
+
+ WxPayUnifiedOrderV3Result result = new WxPayUnifiedOrderV3Result();
+ result.setPrepayId(testPrepayId);
+
+ // 调用getPayInfo生成AppResult
+ WxPayUnifiedOrderV3Result.AppResult appResult =
+ result.getPayInfo(TradeTypeEnum.APP, testAppId, testMchId, privateKey);
+
+ // 验证prepayId字段
+ Assert.assertNotNull(appResult.getPrepayId(), "prepayId不应为null");
+ Assert.assertEquals(appResult.getPrepayId(), testPrepayId, "prepayId应该与设置的值相同");
+ }
+
+ /**
+ * 测试getJsapiPayInfo方法的空值验证
+ */
+ @Test(expectedExceptions = IllegalArgumentException.class,
+ expectedExceptionsMessageRegExp = "prepayId, appId 和 privateKey 不能为空")
+ public void testGetJsapiPayInfoWithNullPrepayId() {
+ WxPayUnifiedOrderV3Result.getJsapiPayInfo(null, "appId", null);
+ }
+
+ /**
+ * 测试getJsapiPayInfo方法的空值验证 - appId为null
+ */
+ @Test(expectedExceptions = IllegalArgumentException.class,
+ expectedExceptionsMessageRegExp = "prepayId, appId 和 privateKey 不能为空")
+ public void testGetJsapiPayInfoWithNullAppId() throws Exception {
+ KeyPair keyPair = generateKeyPair();
+ WxPayUnifiedOrderV3Result.getJsapiPayInfo("prepayId", null, keyPair.getPrivate());
+ }
+
+ /**
+ * 测试getJsapiPayInfo方法的空值验证 - privateKey为null
+ */
+ @Test(expectedExceptions = IllegalArgumentException.class,
+ expectedExceptionsMessageRegExp = "prepayId, appId 和 privateKey 不能为空")
+ public void testGetJsapiPayInfoWithNullPrivateKey() {
+ WxPayUnifiedOrderV3Result.getJsapiPayInfo("prepayId", "appId", null);
+ }
+
+ /**
+ * 测试getAppPayInfo方法的空值验证 - prepayId为null
+ */
+ @Test(expectedExceptions = IllegalArgumentException.class,
+ expectedExceptionsMessageRegExp = "prepayId, appId, mchId 和 privateKey 不能为空")
+ public void testGetAppPayInfoWithNullPrepayId() {
+ WxPayUnifiedOrderV3Result.getAppPayInfo(null, "appId", "mchId", null);
+ }
+
+ /**
+ * 测试getAppPayInfo方法的空值验证 - appId为null
+ */
+ @Test(expectedExceptions = IllegalArgumentException.class,
+ expectedExceptionsMessageRegExp = "prepayId, appId, mchId 和 privateKey 不能为空")
+ public void testGetAppPayInfoWithNullAppId() throws Exception {
+ KeyPair keyPair = generateKeyPair();
+ WxPayUnifiedOrderV3Result.getAppPayInfo("prepayId", null, "mchId", keyPair.getPrivate());
+ }
+
+ /**
+ * 测试getAppPayInfo方法的空值验证 - mchId为null
+ */
+ @Test(expectedExceptions = IllegalArgumentException.class,
+ expectedExceptionsMessageRegExp = "prepayId, appId, mchId 和 privateKey 不能为空")
+ public void testGetAppPayInfoWithNullMchId() throws Exception {
+ KeyPair keyPair = generateKeyPair();
+ WxPayUnifiedOrderV3Result.getAppPayInfo("prepayId", "appId", null, keyPair.getPrivate());
+ }
+
+ /**
+ * 测试getAppPayInfo方法的空值验证 - privateKey为null
+ */
+ @Test(expectedExceptions = IllegalArgumentException.class,
+ expectedExceptionsMessageRegExp = "prepayId, appId, mchId 和 privateKey 不能为空")
+ public void testGetAppPayInfoWithNullPrivateKey() {
+ WxPayUnifiedOrderV3Result.getAppPayInfo("prepayId", "appId", "mchId", null);
+ }
+}
From e3463a0adfe0cb8d4111f751c5ff68b18f68fca8 Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Sun, 21 Dec 2025 20:27:44 +0800
Subject: [PATCH 126/208] =?UTF-8?q?:art:=20#3686=20=E3=80=90=E5=BE=AE?=
=?UTF-8?q?=E4=BF=A1=E6=94=AF=E4=BB=98=E3=80=91=E4=BB=98=E6=AC=BE=E7=A0=81?=
=?UTF-8?q?=E6=94=AF=E4=BB=98=E6=8E=A5=E5=8F=A3=E6=B7=BB=E5=8A=A0=E6=9C=8D?=
=?UTF-8?q?=E5=8A=A1=E5=95=86=E6=A8=A1=E5=BC=8F=E6=94=AF=E6=8C=81?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../bean/request/WxPayCodepayRequest.java | 52 +++++++++++++++++++
.../service/impl/BaseWxPayServiceImpl.java | 41 ++++++++++++---
2 files changed, 85 insertions(+), 8 deletions(-)
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxPayCodepayRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxPayCodepayRequest.java
index ecfa614a16..632561075a 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxPayCodepayRequest.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxPayCodepayRequest.java
@@ -45,6 +45,58 @@ public class WxPayCodepayRequest implements Serializable {
*/
@SerializedName(value = "mchid")
protected String mchid;
+ /**
+ *
+ * 字段名:服务商应用ID
+ * 变量名:sp_appid
+ * 是否必填:否
+ * 类型:string[1,32]
+ * 描述:
+ * 服务商模式下使用,由微信生成的应用ID,全局唯一。
+ * 示例值:wxd678efh567hg6787
+ *
+ */
+ @SerializedName(value = "sp_appid")
+ protected String spAppid;
+ /**
+ *
+ * 字段名:服务商商户号
+ * 变量名:sp_mchid
+ * 是否必填:否
+ * 类型:string[1,32]
+ * 描述:
+ * 服务商模式下使用,服务商商户号,由微信支付生成并下发。
+ * 示例值:1230000109
+ *
+ */
+ @SerializedName(value = "sp_mchid")
+ protected String spMchid;
+ /**
+ *
+ * 字段名:子商户应用ID
+ * 变量名:sub_appid
+ * 是否必填:否
+ * 类型:string[1,32]
+ * 描述:
+ * 服务商模式下使用,由微信生成的应用ID,全局唯一。
+ * 示例值:wxd678efh567hg6787
+ *
+ */
+ @SerializedName(value = "sub_appid")
+ protected String subAppid;
+ /**
+ *
+ * 字段名:子商户商户号
+ * 变量名:sub_mchid
+ * 是否必填:否
+ * 类型:string[1,32]
+ * 描述:
+ * 服务商模式下使用,子商户商户号,由微信支付生成并下发。
+ * 示例值:1230000109
+ *
+ */
+ @SerializedName(value = "sub_mchid")
+ protected String subMchid;
/**
*
* 字段名:商品描述
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
index b4c2b919a4..484e191544 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
@@ -1201,15 +1201,40 @@ public WxPayMicropayResult micropay(WxPayMicropayRequest request) throws WxPayEx
@Override
public WxPayCodepayResult codepay(WxPayCodepayRequest request) throws WxPayException {
- if (StringUtils.isBlank(request.getAppid())) {
- request.setAppid(this.getConfig().getAppId());
- }
- if (StringUtils.isBlank(request.getMchid())) {
- request.setMchid(this.getConfig().getMchId());
+ // 判断是否为服务商模式:如果设置了sp_appid或sp_mchid或sub_mchid中的任何一个,则认为是服务商模式
+ boolean isPartnerMode = StringUtils.isNotBlank(request.getSpAppid())
+ || StringUtils.isNotBlank(request.getSpMchid())
+ || StringUtils.isNotBlank(request.getSubMchid());
+
+ if (isPartnerMode) {
+ // 服务商模式
+ if (StringUtils.isBlank(request.getSpAppid())) {
+ request.setSpAppid(this.getConfig().getAppId());
+ }
+ if (StringUtils.isBlank(request.getSpMchid())) {
+ request.setSpMchid(this.getConfig().getMchId());
+ }
+ if (StringUtils.isBlank(request.getSubAppid())) {
+ request.setSubAppid(this.getConfig().getSubAppId());
+ }
+ if (StringUtils.isBlank(request.getSubMchid())) {
+ request.setSubMchid(this.getConfig().getSubMchId());
+ }
+ String url = String.format("%s/v3/pay/partner/transactions/codepay", this.getPayBaseUrl());
+ String body = this.postV3WithWechatpaySerial(url, GSON.toJson(request));
+ return GSON.fromJson(body, WxPayCodepayResult.class);
+ } else {
+ // 直连商户模式
+ if (StringUtils.isBlank(request.getAppid())) {
+ request.setAppid(this.getConfig().getAppId());
+ }
+ if (StringUtils.isBlank(request.getMchid())) {
+ request.setMchid(this.getConfig().getMchId());
+ }
+ String url = String.format("%s/v3/pay/transactions/codepay", this.getPayBaseUrl());
+ String body = this.postV3WithWechatpaySerial(url, GSON.toJson(request));
+ return GSON.fromJson(body, WxPayCodepayResult.class);
}
- String url = String.format("%s/v3/pay/transactions/codepay", this.getPayBaseUrl());
- String body = this.postV3WithWechatpaySerial(url, GSON.toJson(request));
- return GSON.fromJson(body, WxPayCodepayResult.class);
}
@Override
From 40428bc7cf2127acbae91bb4d2685d249e6cde83 Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Sun, 21 Dec 2025 21:54:43 +0800
Subject: [PATCH 127/208] =?UTF-8?q?:memo:=20=E6=B7=BB=E5=8A=A0=E5=BE=AE?=
=?UTF-8?q?=E4=BF=A1=E5=BC=80=E6=94=BE=E5=B9=B3=E5=8F=B0=E5=B0=8F=E7=A8=8B?=
=?UTF-8?q?=E5=BA=8F=E5=AE=A1=E6=A0=B8=E9=A2=9D=E5=BA=A6=E7=AE=A1=E7=90=86?=
=?UTF-8?q?=E6=8C=87=E5=8D=97?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../AUDIT_QUOTA_MANAGEMENT_GUIDE.md | 321 ++++++++++++++++++
weixin-java-open/README.md | 30 ++
.../weixin/open/api/WxOpenMaService.java | 68 +++-
.../message/WxOpenMaSubmitAuditMessage.java | 31 ++
.../bean/result/WxOpenMaQueryQuotaResult.java | 38 ++-
.../api/impl/WxOpenMaServiceImplTest.java | 135 ++++++++
6 files changed, 617 insertions(+), 6 deletions(-)
create mode 100644 weixin-java-open/AUDIT_QUOTA_MANAGEMENT_GUIDE.md
diff --git a/weixin-java-open/AUDIT_QUOTA_MANAGEMENT_GUIDE.md b/weixin-java-open/AUDIT_QUOTA_MANAGEMENT_GUIDE.md
new file mode 100644
index 0000000000..d84932034a
--- /dev/null
+++ b/weixin-java-open/AUDIT_QUOTA_MANAGEMENT_GUIDE.md
@@ -0,0 +1,321 @@
+# 微信开放平台小程序审核额度管理最佳实践
+
+## 问题背景
+
+在使用微信开放平台第三方服务为多个授权小程序提交审核时,需要注意以下重要限制:
+
+### 审核额度限制
+
+- **默认额度**: 每个第三方平台账号每月默认有 **20 个** 审核额度
+- **消耗规则**: 每次调用 `submitAudit()` 提交一个小程序审核,会消耗 **1 个** 审核额度
+- **重置周期**: 额度每月初自动重置
+- **不可返还**: 审核撤回(undoCodeAudit)不会返还已消耗的额度
+- **增加额度**: 如需更多额度,需要联系微信开放平台客服申请
+
+### 常见问题
+
+**问题**: 开放平台是每个 appId 都要这样提交审核吗?额度不够吧?
+
+**回答**: 是的,每个授权的小程序(appId)都需要单独调用 `submitAudit()` 提交审核,每次提交会消耗 1 个审核额度。默认的 20 个额度对于管理大量小程序的第三方平台来说可能不够用,建议:
+1. 提交审核前先查询剩余额度
+2. 合理规划审核计划,避免重复提交审核
+3. 联系微信开放平台申请增加额度
+
+## API 使用说明
+
+### 1. 查询审核额度
+
+```java
+// 查询当前审核额度
+WxOpenMaQueryQuotaResult quota = wxOpenMaService.queryQuota();
+
+System.out.println("当月剩余提交审核次数: " + quota.getRest()); // 剩余额度
+System.out.println("当月提交审核额度上限: " + quota.getLimit()); // 总额度
+System.out.println("剩余加急次数: " + quota.getSpeedupRest()); // 剩余加急次数
+System.out.println("加急额度上限: " + quota.getSpeedupLimit()); // 加急额度上限
+```
+
+**返回字段说明**:
+- `rest`: 当月剩余提交审核次数
+- `limit`: 当月提交审核额度上限(默认 20)
+- `speedupRest`: 剩余加急次数
+- `speedupLimit`: 加急额度上限
+
+### 2. 提交审核
+
+```java
+// 构建审核项
+WxMaCodeSubmitAuditItem item = new WxMaCodeSubmitAuditItem();
+item.setAddress("index"); // 页面路径
+item.setTag("工具"); // 标签
+item.setFirstClass("工具"); // 一级类目
+item.setSecondClass("效率"); // 二级类目
+item.setTitle("首页"); // 页面标题
+
+// 构建提交审核消息
+WxOpenMaSubmitAuditMessage message = new WxOpenMaSubmitAuditMessage();
+message.setItemList(Collections.singletonList(item));
+message.setVersionDesc("版本描述");
+
+// 提交审核
+WxOpenMaSubmitAuditResult result = wxOpenMaService.submitAudit(message);
+System.out.println("审核ID: " + result.getAuditId());
+```
+
+## 最佳实践
+
+### 方案一:单个小程序提交前检查额度
+
+这是最基本的做法,适用于偶尔提交审核的场景。
+
+```java
+import me.chanjar.weixin.open.api.WxOpenMaService;
+import me.chanjar.weixin.open.bean.message.WxOpenMaSubmitAuditMessage;
+import me.chanjar.weixin.open.bean.result.WxOpenMaQueryQuotaResult;
+import me.chanjar.weixin.open.bean.result.WxOpenMaSubmitAuditResult;
+import me.chanjar.weixin.common.error.WxErrorException;
+
+public class AuditSubmitter {
+
+ /**
+ * 提交审核前检查额度
+ */
+ public WxOpenMaSubmitAuditResult submitWithQuotaCheck(
+ WxOpenMaService wxOpenMaService,
+ WxOpenMaSubmitAuditMessage message) throws WxErrorException {
+
+ // 1. 检查审核额度
+ WxOpenMaQueryQuotaResult quota = wxOpenMaService.queryQuota();
+ System.out.println("当前剩余审核额度: " + quota.getRest());
+
+ if (quota.getRest() <= 0) {
+ throw new RuntimeException("审核额度不足,无法提交审核。剩余额度: " + quota.getRest());
+ }
+
+ // 2. 提交审核
+ WxOpenMaSubmitAuditResult result = wxOpenMaService.submitAudit(message);
+ System.out.println("提交审核成功,审核ID: " + result.getAuditId());
+
+ // 3. 再次查询额度(可选)
+ quota = wxOpenMaService.queryQuota();
+ System.out.println("提交后剩余审核额度: " + quota.getRest());
+
+ return result;
+ }
+}
+```
+
+### 方案二:批量提交审核的额度管理
+
+适用于需要同时为多个小程序提交审核的场景。
+
+```java
+import me.chanjar.weixin.open.api.WxOpenComponentService;
+import me.chanjar.weixin.open.api.WxOpenMaService;
+import me.chanjar.weixin.open.bean.message.WxOpenMaSubmitAuditMessage;
+import me.chanjar.weixin.open.bean.result.WxOpenMaQueryQuotaResult;
+import me.chanjar.weixin.open.bean.result.WxOpenMaSubmitAuditResult;
+import me.chanjar.weixin.common.error.WxErrorException;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+public class BatchAuditSubmitter {
+
+ /**
+ * 批量提交审核结果
+ */
+ public static class BatchSubmitResult {
+ private int successCount; // 成功数量
+ private int failCount; // 失败数量
+ private int skipCount; // 跳过数量(额度不足)
+ private List
+ *
* @param deviceTicketRequest
* @return
* @throws WxErrorException
@@ -37,4 +39,53 @@ public interface WxMaDeviceSubscribeService {
*/
void sendDeviceSubscribeMsg(WxMaDeviceSubscribeMessageRequest deviceSubscribeMessageRequest) throws WxErrorException;
+ /**
+ *
+ *
+ * {@code
+ * // 1. 先查询剩余额度
+ * WxOpenMaQueryQuotaResult quota = wxOpenMaService.queryQuota();
+ * if (quota.getRest() <= 0) {
+ * throw new RuntimeException("审核额度不足,剩余:" + quota.getRest());
+ * }
+ *
+ * // 2. 提交审核
+ * WxOpenMaSubmitAuditMessage message = new WxOpenMaSubmitAuditMessage();
+ * message.setItemList(itemList);
+ * WxOpenMaSubmitAuditResult result = wxOpenMaService.submitAudit(message);
+ * }
*
* @param submitAuditMessage the submit audit message
* @return the wx open ma submit audit result
* @throws WxErrorException the wx error exception
+ * @see #queryQuota() 查询审核额度
+ * @see #speedAudit(Long) 加急审核
*/
WxOpenMaSubmitAuditResult submitAudit(WxOpenMaSubmitAuditMessage submitAuditMessage) throws WxErrorException;
@@ -690,11 +716,43 @@ WxOpenMaDomainResult modifyDomainDirectly(String action, List
+ *
+ *
+ *
+ * {@code
+ * WxOpenMaQueryQuotaResult quota = wxOpenMaService.queryQuota();
+ * System.out.println("剩余审核次数:" + quota.getRest());
+ * System.out.println("审核额度上限:" + quota.getLimit());
+ * System.out.println("剩余加急次数:" + quota.getSpeedupRest());
+ * }
+ *
+ * @return 审核额度信息
+ * @throws WxErrorException 调用微信接口失败时抛出
+ * @see #submitAudit(WxOpenMaSubmitAuditMessage) 提交审核
+ * @see #speedAudit(Long) 加急审核
*/
WxOpenMaQueryQuotaResult queryQuota() throws WxErrorException;
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/message/WxOpenMaSubmitAuditMessage.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/message/WxOpenMaSubmitAuditMessage.java
index d8c1461d67..79400aa968 100644
--- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/message/WxOpenMaSubmitAuditMessage.java
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/message/WxOpenMaSubmitAuditMessage.java
@@ -10,8 +10,39 @@
/**
* 微信小程序代码包提交审核(仅供第三方开发者代小程序调用)
+ *
+ *
+ * {@code
+ * // 1. 构建审核项
+ * WxMaCodeSubmitAuditItem item = new WxMaCodeSubmitAuditItem();
+ * item.setAddress("index");
+ * item.setTag("游戏");
+ * item.setFirstClass("游戏");
+ * item.setSecondClass("休闲游戏");
+ * item.setTitle("首页");
+ *
+ * // 2. 构建提交审核消息
+ * WxOpenMaSubmitAuditMessage message = new WxOpenMaSubmitAuditMessage();
+ * message.setItemList(Collections.singletonList(item));
+ * message.setVersionDesc("版本描述");
+ *
+ * // 3. 提交审核
+ * WxOpenMaSubmitAuditResult result = wxOpenMaService.submitAudit(message);
+ * System.out.println("审核ID: " + result.getAuditId());
+ * }
*
* @author yqx
+ * @see me.chanjar.weixin.open.api.WxOpenMaService#submitAudit(WxOpenMaSubmitAuditMessage)
+ * @see me.chanjar.weixin.open.api.WxOpenMaService#queryQuota()
* created on 2018/9/13
*/
@Data
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenMaQueryQuotaResult.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenMaQueryQuotaResult.java
index 3b02906242..0f964b5f44 100644
--- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenMaQueryQuotaResult.java
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenMaQueryQuotaResult.java
@@ -6,7 +6,31 @@
import me.chanjar.weixin.open.util.json.WxOpenGsonBuilder;
/**
- * 微信开放平台小程序当前分阶段发布详情
+ * 微信开放平台小程序提交审核额度查询结果
+ *
+ *
+ *
+ *
+ *
+ * @see me.chanjar.weixin.open.api.WxOpenMaService#queryQuota()
+ * @see me.chanjar.weixin.open.api.WxOpenMaService#submitAudit(me.chanjar.weixin.open.bean.message.WxOpenMaSubmitAuditMessage)
*/
@Data
@EqualsAndHashCode(callSuper = true)
@@ -14,15 +38,27 @@ public class WxOpenMaQueryQuotaResult extends WxOpenResult {
private static final long serialVersionUID = 5915265985261653007L;
+ /**
+ * 当月剩余提交审核次数
+ */
@SerializedName("rest")
private Integer rest;
+ /**
+ * 当月提交审核额度上限
+ */
@SerializedName("limit")
private Integer limit;
+ /**
+ * 剩余加急次数
+ */
@SerializedName("speedup_rest")
private Integer speedupRest;
+ /**
+ * 加急额度上限
+ */
@SerializedName("speedup_limit")
private Integer speedupLimit;
diff --git a/weixin-java-open/src/test/java/me/chanjar/weixin/open/api/impl/WxOpenMaServiceImplTest.java b/weixin-java-open/src/test/java/me/chanjar/weixin/open/api/impl/WxOpenMaServiceImplTest.java
index 4d8e41b59e..1de6ffe2d6 100644
--- a/weixin-java-open/src/test/java/me/chanjar/weixin/open/api/impl/WxOpenMaServiceImplTest.java
+++ b/weixin-java-open/src/test/java/me/chanjar/weixin/open/api/impl/WxOpenMaServiceImplTest.java
@@ -306,6 +306,141 @@ public void testGetGrayReleasePlan() {
@Test
public void testQueryQuota() {
+ // 此测试方法演示如何使用审核额度查询功能
+ // 注意:实际运行需要真实的微信 API 凭据
+ /*
+ try {
+ // 查询当前审核额度
+ WxOpenMaQueryQuotaResult quota = wxOpenMaService.queryQuota();
+
+ System.out.println("审核额度信息:");
+ System.out.println(" 当月剩余提交审核次数: " + quota.getRest());
+ System.out.println(" 当月提交审核额度上限: " + quota.getLimit());
+ System.out.println(" 剩余加急次数: " + quota.getSpeedupRest());
+ System.out.println(" 加急额度上限: " + quota.getSpeedupLimit());
+
+ // 检查额度是否充足
+ if (quota.getRest() <= 0) {
+ System.err.println("警告:审核额度已用尽!");
+ } else if (quota.getRest() <= 5) {
+ System.out.println("提示:审核额度即将用尽,请注意!");
+ }
+ } catch (WxErrorException e) {
+ e.printStackTrace();
+ }
+ */
+ }
+
+ /**
+ * 演示提交审核前检查额度的最佳实践
+ *
+ * 创建设备组
+ * 详情请见:https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/hardware-device/createIotGroupId.html
+ *
+ *
+ * @param createIotGroupIdRequest 请求参数
+ * @return 设备组的唯一标识
+ * @throws WxErrorException
+ */
+ String createIotGroupId(WxMaCreateIotGroupIdRequest createIotGroupIdRequest) throws WxErrorException;
+
+ /**
+ *
+ * 查询设备组信息
+ * 详情请见:https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/hardware-device/getIotGroupInfo.html
+ *
+ *
+ * @param getIotGroupInfoRequest 请求参数
+ * @return 设备组信息
+ * @throws WxErrorException
+ */
+ WxMaIotGroupDeviceInfoResponse getIotGroupInfo(WxMaGetIotGroupInfoRequest getIotGroupInfoRequest) throws WxErrorException;
+
+ /**
+ *
+ * 设备组添加设备
+ * 一个设备组最多添加 50 个设备。 一个设备同一时间只能被添加到一个设备组中。
+ * 详情请见:https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/hardware-device/addIotGroupDevice.html
+ *
+ *
+ * @param request 请求参数
+ * @return 成功添加的设备信息
+ * @throws WxErrorException
+ */
+ List
+ * 设备组删除设备
+ * 详情请见:https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/hardware-device/removeIotGroupDevice.html
+ *
+ *
+ * @param request 请求参数
+ * @return 成功删除的设备信息
+ * @throws WxErrorException
+ */
+ List>() {
+ }.getType());
+ }
+
+ @Override
+ public List
>() {
+ }.getType());
+ }
}
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/device/WxMaCreateIotGroupIdRequest.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/device/WxMaCreateIotGroupIdRequest.java
new file mode 100644
index 0000000000..20a0a146ae
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/device/WxMaCreateIotGroupIdRequest.java
@@ -0,0 +1,38 @@
+package cn.binarywang.wx.miniapp.bean.device;
+
+import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder;
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * @Author: yanglegetuo
+ * @Date: 2025/12/22 8:51
+ * @Description: 创建设备组 请求参数
+ */
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class WxMaCreateIotGroupIdRequest implements Serializable {
+ private static final long serialVersionUID = 1827809470414413390L;
+ /**
+ * 设备型号id。通过注册设备获得(必填)
+ */
+ @SerializedName("model_id")
+ private String modelId;
+ /**
+ * 设备组的名称(创建时决定,无法修改)
+ */
+ @SerializedName("group_name")
+ private String groupName;
+
+
+ public String toJson() {
+ return WxMaGsonBuilder.create().toJson(this);
+ }
+}
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/device/WxMaGetIotGroupInfoRequest.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/device/WxMaGetIotGroupInfoRequest.java
new file mode 100644
index 0000000000..47ebc2be44
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/device/WxMaGetIotGroupInfoRequest.java
@@ -0,0 +1,33 @@
+package cn.binarywang.wx.miniapp.bean.device;
+
+import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder;
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * @Author: yanglegetuo
+ * @Date: 2025/12/22 8:51
+ * @Description: 查询设备组信息 请求参数
+ */
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class WxMaGetIotGroupInfoRequest implements Serializable {
+
+ private static final long serialVersionUID = 4913375114243384968L;
+ /**
+ * 设备组的唯一标识(必填)
+ */
+ @SerializedName("group_id")
+ private String groupId;
+
+ public String toJson() {
+ return WxMaGsonBuilder.create().toJson(this);
+ }
+}
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/device/WxMaIotGroupDeviceInfoResponse.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/device/WxMaIotGroupDeviceInfoResponse.java
new file mode 100644
index 0000000000..e7bd92edf8
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/device/WxMaIotGroupDeviceInfoResponse.java
@@ -0,0 +1,51 @@
+package cn.binarywang.wx.miniapp.bean.device;
+
+import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder;
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ * @Author: yanglegetuo
+ * @Date: 2025/12/22 8:51
+ * @Description: 设备组信息 响应参数
+ */
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class WxMaIotGroupDeviceInfoResponse implements Serializable {
+
+ private static final long serialVersionUID = 6615660801230308048L;
+ /**
+ * 设备组名称
+ */
+ @SerializedName("group_name")
+ private String groupName;
+ /**
+ * 设备列表
+ */
+ @SerializedName("device_list")
+ private List
* 字段名:医保统筹基金支付金额
* 变量名:med_ins_gov_fee
* 必填:否
- * 类型:long
+ * 类型:Integer
* 描述:医保统筹基金支付金额
*
*/
@SerializedName("med_ins_gov_fee")
- public Long medInsGovFee;
+ public Integer medInsGovFee;
/**
*
* 字段名:医保个人账户支付金额
* 变量名:med_ins_self_fee
* 必填:否
- * 类型:long
+ * 类型:Integer
* 描述:医保个人账户支付金额
*
*/
@SerializedName("med_ins_self_fee")
- public Long medInsSelfFee;
+ public Integer medInsSelfFee;
/**
*
* 字段名:医保其他基金支付金额
* 变量名:med_ins_other_fee
* 必填:否
- * 类型:long
+ * 类型:Integer
* 描述:医保其他基金支付金额
*
*/
@SerializedName("med_ins_other_fee")
- public Long medInsOtherFee;
+ public Integer medInsOtherFee;
/**
*
* 字段名:医保现金支付金额
* 变量名:med_ins_cash_fee
* 必填:否
- * 类型:long
+ * 类型:Integer
* 描述:医保现金支付金额
*
*/
@SerializedName("med_ins_cash_fee")
- public Long medInsCashFee;
+ public Integer medInsCashFee;
/**
*
* 字段名:微信支付现金支付金额
* 变量名:wechat_pay_cash_fee
* 必填:否
- * 类型:long
+ * 类型:Integer
* 描述:微信支付现金支付金额
*
*/
@SerializedName("wechat_pay_cash_fee")
- public Long wechatPayCashFee;
+ public Integer wechatPayCashFee;
/**
*
@@ -462,6 +464,11 @@ public class MedInsOrdersRequest {
* 支付人身份信息
*
*/
+ @Data
+ @Builder
+ @NoArgsConstructor
+ @AllArgsConstructor
+ @Accessors(chain = true)
public static class PersonIdentification {
/**
*
@@ -507,18 +514,23 @@ public static class PersonIdentification {
* 现金增加明细实体
*
*/
+ @Data
+ @Builder
+ @NoArgsConstructor
+ @AllArgsConstructor
+ @Accessors(chain = true)
public static class CashAddEntity {
/**
*
* 字段名:现金增加金额
* 变量名:cash_add_fee
* 必填:是
- * 类型:long
+ * 类型:Integer
* 描述:现金增加金额
*
*/
@SerializedName("cash_add_fee")
- public Long cashAddFee;
+ public Integer cashAddFee;
/**
*
@@ -538,18 +550,23 @@ public static class CashAddEntity {
* 现金减少明细实体
*
*/
+ @Data
+ @Builder
+ @NoArgsConstructor
+ @AllArgsConstructor
+ @Accessors(chain = true)
public static class CashReduceEntity {
/**
*
* 字段名:现金减少金额
* 变量名:cash_reduce_fee
* 必填:是
- * 类型:long
+ * 类型:Integer
* 描述:现金减少金额
*
*/
@SerializedName("cash_reduce_fee")
- public Long cashReduceFee;
+ public Integer cashReduceFee;
/**
*
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsOrdersResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsOrdersResult.java
index 4fc68e279f..9a119d8723 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsOrdersResult.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsOrdersResult.java
@@ -65,7 +65,7 @@ public class MedInsOrdersResult {
*
*/
@SerializedName("med_ins_pay_status")
- public MedInsPayStatusEnum medInsPayStatusEnum;
+ public MedInsPayStatusEnum medInsPayStatus;
/**
*
@@ -320,72 +320,72 @@ public class MedInsOrdersResult {
* 字段名:总金额
* 变量名:total_fee
* 必填:否
- * 类型:long
+ * 类型:Integer
* 描述:总金额
*
*/
@SerializedName("total_fee")
- public Long totalFee;
+ public Integer totalFee;
/**
*
* 字段名:医保统筹基金支付金额
* 变量名:med_ins_gov_fee
* 必填:否
- * 类型:long
+ * 类型:Integer
* 描述:医保统筹基金支付金额
*
*/
@SerializedName("med_ins_gov_fee")
- public Long medInsGovFee;
+ public Integer medInsGovFee;
/**
*
* 字段名:医保个人账户支付金额
* 变量名:med_ins_self_fee
* 必填:否
- * 类型:long
+ * 类型:Integer
* 描述:医保个人账户支付金额
*
*/
@SerializedName("med_ins_self_fee")
- public Long medInsSelfFee;
+ public Integer medInsSelfFee;
/**
*
* 字段名:医保其他基金支付金额
* 变量名:med_ins_other_fee
* 必填:否
- * 类型:long
+ * 类型:Integer
* 描述:医保其他基金支付金额
*
*/
@SerializedName("med_ins_other_fee")
- public Long medInsOtherFee;
+ public Integer medInsOtherFee;
/**
*
* 字段名:医保现金支付金额
* 变量名:med_ins_cash_fee
* 必填:否
- * 类型:long
+ * 类型:Integer
* 描述:医保现金支付金额
*
*/
@SerializedName("med_ins_cash_fee")
- public Long medInsCashFee;
+ public Integer medInsCashFee;
/**
*
* 字段名:微信支付现金支付金额
* 变量名:wechat_pay_cash_fee
* 必填:否
- * 类型:long
+ * 类型:Integer
* 描述:微信支付现金支付金额
*
*/
@SerializedName("wechat_pay_cash_fee")
- public Long wechatPayCashFee;
+ public Integer wechatPayCashFee;
/**
*
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsRefundNotifyRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsRefundNotifyRequest.java
index b6e15a3644..cb935b52cd 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsRefundNotifyRequest.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsRefundNotifyRequest.java
@@ -20,16 +20,6 @@
@AllArgsConstructor
public class MedInsRefundNotifyRequest {
- /**
- *
- * 字段名:医保自费混合订单号
- * 必填:是
- * 类型:string(32)
- * 描述:医保自费混合订单号
- *
- */
- private String mixTradeNo;
-
/**
*
* 字段名:医疗机构的商户号
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/MiPayService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/MiPayService.java
index 83b75ad40c..5e2f678c16 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/MiPayService.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/MiPayService.java
@@ -87,8 +87,9 @@ public interface MiPayService {
*
*
* @param request 医保退款通知请求参数
+ * @param mixTradeNo 【医保自费混合订单号】 医保自费混合订单号
* @throws WxPayException the wx pay exception
*/
- void medInsRefundNotify(MedInsRefundNotifyRequest request) throws WxPayException;
+ void medInsRefundNotify(MedInsRefundNotifyRequest request, String mixTradeNo) throws WxPayException;
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/MiPayServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/MiPayServiceImpl.java
index 3063d7731e..769b789fa3 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/MiPayServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/MiPayServiceImpl.java
@@ -59,8 +59,8 @@ public MiPayNotifyV3Result parseMiPayNotifyV3Result(String notifyData, Signature
}
@Override
- public void medInsRefundNotify(MedInsRefundNotifyRequest request) throws WxPayException {
- String url = String.format("%s/v3/med-ins/refunds/notify?mix_trade_no=%s", this.payService.getPayBaseUrl(), request.getMixTradeNo());
+ public void medInsRefundNotify(MedInsRefundNotifyRequest request, String mixTradeNo) throws WxPayException {
+ String url = String.format("%s/v3/med-ins/refunds/notify?mix_trade_no=%s", this.payService.getPayBaseUrl(), mixTradeNo);
this.payService.postV3(url, GSON.toJson(request));
}
diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/MiPayServiceImplTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/MiPayServiceImplTest.java
index 23c3c56816..095d355bd4 100644
--- a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/MiPayServiceImplTest.java
+++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/MiPayServiceImplTest.java
@@ -131,13 +131,12 @@ public void medInsRefundNotify() throws WxPayException {
// 解析请求参数
MedInsRefundNotifyRequest request = GSON.fromJson(requestParamStr, MedInsRefundNotifyRequest.class);
- request.setMixTradeNo(mixTradeNo);
MiPayService miPayService = wxPayService.getMiPayService();
try {
// 调用医保退款通知方法,预期会失败,因为是模拟数据
- miPayService.medInsRefundNotify(request);
+ miPayService.medInsRefundNotify(request,mixTradeNo);
log.info("医保退款通知调用成功");
} catch (WxPayException e) {
// 预期会抛出异常,因为是模拟数据
From 912ba354e992afc162b124e97e1ef9fcaf1fb4cd Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Wed, 24 Dec 2025 16:12:56 +0800
Subject: [PATCH 132/208] =?UTF-8?q?:art:=20#3821=20=E3=80=90=E4=BC=81?=
=?UTF-8?q?=E4=B8=9A=E5=BE=AE=E4=BF=A1=E3=80=91=E4=BF=AE=E5=A4=8D=20WxCpRe?=
=?UTF-8?q?disConfigImpl.getWebhookKey()=20=E6=96=B9=E6=B3=95=E6=97=A0?=
=?UTF-8?q?=E9=99=90=E9=80=92=E5=BD=92=E8=B0=83=E7=94=A8=E7=9A=84=E9=97=AE?=
=?UTF-8?q?=E9=A2=98?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../cp/config/impl/WxCpRedisConfigImpl.java | 2 +-
.../config/impl/WxCpRedisConfigImplTest.java | 48 +++++++++++++++++++
2 files changed, 49 insertions(+), 1 deletion(-)
create mode 100644 weixin-java-cp/src/test/java/me/chanjar/weixin/cp/config/impl/WxCpRedisConfigImplTest.java
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpRedisConfigImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpRedisConfigImpl.java
index 15c0ff6727..49cd7c4559 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpRedisConfigImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpRedisConfigImpl.java
@@ -468,7 +468,7 @@ public boolean autoRefreshToken() {
@Override
public String getWebhookKey() {
- return this.getWebhookKey();
+ return this.webhookKey;
}
@Override
diff --git a/weixin-java-cp/src/test/java/me/chanjar/weixin/cp/config/impl/WxCpRedisConfigImplTest.java b/weixin-java-cp/src/test/java/me/chanjar/weixin/cp/config/impl/WxCpRedisConfigImplTest.java
new file mode 100644
index 0000000000..1a7fdccbd1
--- /dev/null
+++ b/weixin-java-cp/src/test/java/me/chanjar/weixin/cp/config/impl/WxCpRedisConfigImplTest.java
@@ -0,0 +1,48 @@
+package me.chanjar.weixin.cp.config.impl;
+
+import org.mockito.Mockito;
+import org.testng.Assert;
+import org.testng.annotations.Test;
+import redis.clients.jedis.JedisPool;
+
+/**
+ * WxCpRedisConfigImpl 测试类
+ */
+public class WxCpRedisConfigImplTest {
+
+ /**
+ * 测试 getWebhookKey 方法不会导致无限递归
+ * 这个测试验证了 #issue 中提到的无限递归问题已被修复
+ */
+ @Test
+ public void testGetWebhookKeyNoInfiniteRecursion() {
+ // 使用 Mockito 创建 mock JedisPool,避免真实连接
+ JedisPool jedisPool = Mockito.mock(JedisPool.class);
+
+ WxCpRedisConfigImpl config = new WxCpRedisConfigImpl(jedisPool);
+
+ // 测试1: webhookKey 为 null 时应该返回 null,而不是抛出 StackOverflowError
+ String webhookKey = config.getWebhookKey();
+ Assert.assertNull(webhookKey, "未设置 webhookKey 时应返回 null");
+
+ // 测试2: 通过反射设置 webhookKey,然后验证能够正确获取
+ // 注意:由于 WxCpRedisConfigImpl 没有提供 setWebhookKey 方法,
+ // 我们通过反射来设置这个字段以测试 getter 的正确性
+ try {
+ java.lang.reflect.Field field = WxCpRedisConfigImpl.class.getDeclaredField("webhookKey");
+ boolean originalAccessible = field.isAccessible();
+ field.setAccessible(true);
+ try {
+ String testWebhookKey = "test-webhook-key-123";
+ field.set(config, testWebhookKey);
+
+ String retrievedKey = config.getWebhookKey();
+ Assert.assertEquals(retrievedKey, testWebhookKey, "应该返回设置的 webhookKey 值");
+ } finally {
+ field.setAccessible(originalAccessible);
+ }
+ } catch (NoSuchFieldException | IllegalAccessException e) {
+ Assert.fail("反射设置 webhookKey 失败: " + e.getMessage());
+ }
+ }
+}
From 6504f5d82cf6ee87f6839b42b697201eda7f443b Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Wed, 24 Dec 2025 16:14:20 +0800
Subject: [PATCH 133/208] =?UTF-8?q?:new:=20#3823=20=E3=80=90=E4=BC=81?=
=?UTF-8?q?=E4=B8=9A=E5=BE=AE=E4=BF=A1=E3=80=91=E6=B7=BB=E5=8A=A0=E8=8E=B7?=
=?UTF-8?q?=E5=8F=96=E5=BA=94=E7=94=A8=E7=AE=A1=E7=90=86=E5=91=98=E5=88=97?=
=?UTF-8?q?=E8=A1=A8=E7=9A=84=E6=8E=A5=E5=8F=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../weixin/cp/api/WxCpAgentService.java | 15 +++++
.../cp/api/impl/WxCpAgentServiceImpl.java | 18 ++++++
.../weixin/cp/constant/WxCpApiPathConsts.java | 4 ++
.../cp/api/impl/WxCpAgentServiceImplTest.java | 62 +++++++++++++++++++
4 files changed, 99 insertions(+)
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpAgentService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpAgentService.java
index 9eddc0f507..05f06f1da9 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpAgentService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpAgentService.java
@@ -2,6 +2,7 @@
import me.chanjar.weixin.common.error.WxErrorException;
import me.chanjar.weixin.cp.bean.WxCpAgent;
+import me.chanjar.weixin.cp.bean.WxCpTpAdmin;
import java.util.List;
@@ -52,4 +53,18 @@ public interface WxCpAgentService {
*/
List
+ * 获取应用管理员列表
+ * 第三方服务商可以用此接口获取授权企业中某个第三方应用或者代开发应用的管理员列表(不包括外部管理员),
+ * 以便服务商在用户进入应用主页之后根据是否管理员身份做权限的区分。
+ * 详情请见: 文档
+ *
+ *
+ * @param agentId 应用id
+ * @return admin list
+ * @throws WxErrorException the wx error exception
+ */
+ WxCpTpAdmin getAdminList(Integer agentId) throws WxErrorException;
+
}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpAgentServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpAgentServiceImpl.java
index 81628fed82..cc08d33bb1 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpAgentServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpAgentServiceImpl.java
@@ -11,6 +11,7 @@
import me.chanjar.weixin.cp.api.WxCpAgentService;
import me.chanjar.weixin.cp.api.WxCpService;
import me.chanjar.weixin.cp.bean.WxCpAgent;
+import me.chanjar.weixin.cp.bean.WxCpTpAdmin;
import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
import java.util.List;
@@ -65,4 +66,21 @@ public List
+ * 单据创建后,用户24小时内不领取将过期关闭,建议拉起用户确认收款页面前,先查单据状态:如单据状态为WAIT_USER_CONFIRM,可用之前的package信息拉起;单据到终态时需更换单号重新发起转账。
+ */
+ @SerializedName("package_info")
+ private String packageInfo;
/**
* 发起转账的时间
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/BusinessOperationTransferExample.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/BusinessOperationTransferExample.java
index d11738816b..117395ba62 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/BusinessOperationTransferExample.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/BusinessOperationTransferExample.java
@@ -8,6 +8,8 @@
import com.github.binarywang.wxpay.service.WxPayService;
import com.github.binarywang.wxpay.service.impl.WxPayServiceImpl;
+import java.util.Arrays;
+
/**
* 运营工具-商家转账API使用示例
*
@@ -41,10 +43,15 @@ public void init() {
public void createOperationTransferExample() {
try {
// 构建转账请求
+ BusinessOperationTransferRequest.TransferSceneReportInfo reportInfo = new BusinessOperationTransferRequest.TransferSceneReportInfo();
+ reportInfo.setInfoType("活动名称");
+ reportInfo.setInfoContent("新会员有礼");
+
BusinessOperationTransferRequest request = BusinessOperationTransferRequest.newBuilder()
.appid("your_app_id") // 应用ID
.outBillNo("OT" + System.currentTimeMillis()) // 商户转账单号
- .operationSceneId(WxPayConstants.OperationSceneId.OPERATION_CASH_MARKETING) // 运营工具转账场景ID
+ .transferSceneId(WxPayConstants.OperationSceneId.OPERATION_CASH_MARKETING) // 运营工具转账场景ID
+ .transferSceneReportInfos(Arrays.asList(reportInfo)) // 转账场景报备信息
.openid("user_openid") // 用户openid
.userName("张三") // 用户姓名(可选)
.transferAmount(100) // 转账金额,单位分
@@ -59,7 +66,8 @@ public void createOperationTransferExample() {
System.out.println("转账成功!");
System.out.println("商户单号: " + result.getOutBillNo());
System.out.println("微信转账单号: " + result.getTransferBillNo());
- System.out.println("转账状态: " + result.getTransferState());
+ System.out.println("单据状态: " + result.getState());
+ System.out.println("跳转领取页面的package信息: " + result.getPackageInfo());
System.out.println("创建时间: " + result.getCreateTime());
} catch (WxPayException e) {
diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/BusinessOperationTransferServiceTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/BusinessOperationTransferServiceTest.java
index 4107be4347..672483f96b 100644
--- a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/BusinessOperationTransferServiceTest.java
+++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/BusinessOperationTransferServiceTest.java
@@ -7,6 +7,8 @@
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;
+import java.util.Arrays;
+
import static org.assertj.core.api.Assertions.assertThat;
/**
@@ -36,10 +38,17 @@ public void testServiceInitialization() {
@Test
public void testRequestBuilder() {
+
+ // 构建转账请求
+ BusinessOperationTransferRequest.TransferSceneReportInfo reportInfo = new BusinessOperationTransferRequest.TransferSceneReportInfo();
+ reportInfo.setInfoType("test_info_type");
+ reportInfo.setInfoContent("test_info_content");
+
BusinessOperationTransferRequest request = BusinessOperationTransferRequest.newBuilder()
.appid("test_app_id")
.outBillNo("OT" + System.currentTimeMillis())
- .operationSceneId(WxPayConstants.OperationSceneId.OPERATION_CASH_MARKETING)
+ .transferSceneId(WxPayConstants.OperationSceneId.OPERATION_CASH_MARKETING)
+ .transferSceneReportInfos(Arrays.asList(reportInfo))
.openid("test_openid")
.transferAmount(100)
.transferRemark("测试转账")
@@ -47,7 +56,7 @@ public void testRequestBuilder() {
.build();
assertThat(request.getAppid()).isEqualTo("test_app_id");
- assertThat(request.getOperationSceneId()).isEqualTo(WxPayConstants.OperationSceneId.OPERATION_CASH_MARKETING);
+ assertThat(request.getTransferSceneId()).isEqualTo(WxPayConstants.OperationSceneId.OPERATION_CASH_MARKETING);
assertThat(request.getTransferAmount()).isEqualTo(100);
assertThat(request.getTransferRemark()).isEqualTo("测试转账");
}
@@ -77,11 +86,13 @@ public void testResultClasses() {
BusinessOperationTransferResult result = new BusinessOperationTransferResult();
result.setOutBillNo("test_out_bill_no");
result.setTransferBillNo("test_transfer_bill_no");
- result.setTransferState("SUCCESS");
+ result.setState("SUCCESS");
+ result.setPackageInfo("test_package_info");
assertThat(result.getOutBillNo()).isEqualTo("test_out_bill_no");
assertThat(result.getTransferBillNo()).isEqualTo("test_transfer_bill_no");
- assertThat(result.getTransferState()).isEqualTo("SUCCESS");
+ assertThat(result.getState()).isEqualTo("SUCCESS");
+ assertThat(result.getPackageInfo()).isEqualTo("test_package_info");
BusinessOperationTransferQueryResult queryResult = new BusinessOperationTransferQueryResult();
queryResult.setOperationSceneId("2001");
From 987001214ddf126d748853445d0b8859abd34258 Mon Sep 17 00:00:00 2001
From: buaazyl
* 无效媒体文件类型
- * 对应操作:
+ * uploadTempMedia
+ *
* 无效媒体文件 ID.
- * 对应操作:getTempMedia
+ *
+ * 对应操作:{@code getTempMedia}
* 对应地址:
- * GET https://api.weixin.qq.com/cgi-bin/media/get?access_token=ACCESS_TOKEN&media_id=MEDIA_ID
+ * {@code GET https://api.weixin.qq.com/cgi-bin/media/get?access_token=ACCESS_TOKEN&media_id=MEDIA_ID}
* 参考文档地址: https://developers.weixin.qq.com/miniprogram/dev/api/open-api/customer-message/getTempMedia.html
- *
+ *
*/
CODE_40007(40007, "无效媒体文件 ID"),
/**
@@ -99,29 +99,29 @@ public enum WxMaErrorMsgEnum {
*/
CODE_41028(41028, "form_id 不正确,或者过期"),
/**
- *
* code 或 template_id 不正确.
- * 对应操作:code2Session, sendUniformMessage, sendTemplateMessage
+ *
+ * 对应操作:{@code code2Session}, {@code sendUniformMessage}, {@code sendTemplateMessage}
* 对应地址:
- * GET https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JSCODE&grant_type=authorization_code
+ * {@code GET https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JSCODE&grant_type=authorization_code}
* POST https://api.weixin.qq.com/cgi-bin/message/wxopen/template/uniform_send?access_token=ACCESS_TOKEN
* POST https://api.weixin.qq.com/cgi-bin/message/wxopen/template/send?access_token=ACCESS_TOKEN
* 参考文档地址: https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/code2Session.html
* https://developers.weixin.qq.com/miniprogram/dev/api/open-api/uniform-message/sendUniformMessage.html
* https://developers.weixin.qq.com/miniprogram/dev/api/open-api/template-message/sendTemplateMessage.html
- *
+ *
*/
CODE_41029(41029, "请求的参数不正确"),
/**
- *
* form_id 已被使用,或者所传page页面不存在,或者小程序没有发布
- * 对应操作:sendUniformMessage, getWXACodeUnlimit
+ *
+ * 对应操作:{@code sendUniformMessage}, {@code getWXACodeUnlimit}
* 对应地址:
* POST https://api.weixin.qq.com/cgi-bin/message/wxopen/template/uniform_send?access_token=ACCESS_TOKEN
* POST https://api.weixin.qq.com/wxa/getwxacodeunlimit?access_token=ACCESS_TOKEN
* 参考文档地址: https://developers.weixin.qq.com/miniprogram/dev/api/open-api/uniform-message/sendUniformMessage.html
- * https://developers.weixin.qq.com/miniprogram/dev/api/open-api/qr-code/getWXACodeUnlimit.html
- *
+ * https://developers.weixin.qq.com/miniprogram/dev/api/open-api/qr-code/getWXACodeUnlimit.html
+ *
*/
CODE_41030(41030, "请求的参数不正确"),
/**
@@ -138,13 +138,13 @@ public enum WxMaErrorMsgEnum {
*/
CODE_45009(45009, "调用分钟频率受限"),
/**
- *
* 频率限制,每个用户每分钟100次.
- * 对应操作:code2Session
+ *
+ * 对应操作:{@code code2Session}
* 对应地址:
- * GET https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JSCODE&grant_type=authorization_code
+ * {@code GET https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JSCODE&grant_type=authorization_code}
* 参考文档地址: https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/code2Session.html
- *
+ *
*/
CODE_45011(45011, "频率限制,每个用户每分钟100次"),
/**
@@ -190,12 +190,13 @@ public enum WxMaErrorMsgEnum {
*/
CODE_45072(45072, "command字段取值不对"),
/**
- *
* 下发输入状态,需要之前30秒内跟用户有过消息交互.
- * 对应操作:customerTyping
+ *
+ * 对应操作:{@code customerTyping}
* 对应地址:
* POST https://api.weixin.qq.com/cgi-bin/message/custom/typing?access_token=ACCESS_TOKEN
* 参考文档地址: https://developers.weixin.qq.com/miniprogram/dev/api/open-api/customer-message/customerTyping.html
+ *
*/
CODE_45080(45080, "下发输入状态,需要之前30秒内跟用户有过消息交互"),
/**
@@ -686,7 +687,7 @@ public enum WxMaErrorMsgEnum {
/**
* 89252
- * 法人&企业信息一致性校验中 front checking
+ * {@code 法人&企业信息一致性校验中 front checking}
*/
CODE_89252(89252, "法人&企业信息一致性校验中"),
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/error/WxOpenErrorMsgEnum.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/error/WxOpenErrorMsgEnum.java
index 28fb5de8ad..ba910e988b 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/error/WxOpenErrorMsgEnum.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/error/WxOpenErrorMsgEnum.java
@@ -527,7 +527,7 @@ public enum WxOpenErrorMsgEnum {
CODE_40099(40099, "invalid code, this code has consumed."),
/**
- * invalid DateInfo, Make Sure OldDateInfoType==NewDateInfoType && NewBeginTime<=OldBeginTime && OldEndTime<= NewEndTime
+ * {@code invalid DateInfo, Make Sure OldDateInfoType==NewDateInfoType && NewBeginTime<=OldBeginTime && OldEndTime<= NewEndTime}
*/
CODE_40100(40100, "invalid DateInfo, Make Sure OldDateInfoType==NewDateInfoType && NewBeginTime<=OldBeginTime && OldEndTime<= NewEndTime"),
@@ -572,7 +572,7 @@ public enum WxOpenErrorMsgEnum {
CODE_40108(40108, "invalid client version"),
/**
- * too many code size, must <= 100
+ * {@code too many code size, must <= 100}
*/
CODE_40109(40109, "too many code size, must <= 100"),
@@ -702,7 +702,7 @@ public enum WxOpenErrorMsgEnum {
CODE_40135(40135, "invalid not supply bonus, can not change card_id which supply bonus to be not supply"),
/**
- * invalid use DepositCodeMode, make sure sku.quantity>DepositCode.quantity
+ * {@code invalid use DepositCodeMode, make sure sku.quantity>DepositCode.quantity}
*/
CODE_40136(40136, "invalid use DepositCodeMode, make sure sku.quantity>DepositCode.quantity"),
@@ -1082,7 +1082,7 @@ public enum WxOpenErrorMsgEnum {
CODE_40211(40211, "invalid scope_data"),
/**
- * paegs 当中存在不合法的query,query格式遵循URL标准,即k1=v1&k2=v2 invalid query
+ * {@code paegs 当中存在不合法的query,query格式遵循URL标准,即k1=v1&k2=v2 invalid query}
*/
CODE_40212(40212, "paegs 当中存在不合法的query,query格式遵循URL标准,即k1=v1&k2=v2"),
@@ -4242,7 +4242,7 @@ public enum WxOpenErrorMsgEnum {
CODE_71005(71005, "limit exe count"),
/**
- * limit coin count, 1 <= coin_count <= 100000
+ * {@code limit coin count, 1 <= coin_count <= 100000}
*/
CODE_71006(71006, "limit coin count, 1 <= coin_count <= 100000"),
@@ -4347,7 +4347,7 @@ public enum WxOpenErrorMsgEnum {
CODE_72018(72018, "duplicate order id, invoice had inserted to user"),
/**
- * limit msg operation card list size, must <= 5
+ * {@code limit msg operation card list size, must <= 5}
*/
CODE_72019(72019, "limit msg operation card list size, must <= 5"),
@@ -6432,7 +6432,7 @@ public enum WxOpenErrorMsgEnum {
CODE_88009(88009, "reply is not exists"),
/**
- * count range error. cout <= 0 or count > 50
+ * {@code count range error. cout <= 0 or count > 50}
*/
CODE_88010(88010, "count range error. cout <= 0 or count > 50"),
@@ -6682,7 +6682,7 @@ public enum WxOpenErrorMsgEnum {
CODE_89251(89251, "模板消息已下发,待法人人脸核身校验"),
/**
- * 法人&企业信息一致性校验中 front checking
+ * {@code 法人&企业信息一致性校验中 front checking}
*/
CODE_89253(89253, "法人&企业信息一致性校验中"),
@@ -7257,7 +7257,7 @@ public enum WxOpenErrorMsgEnum {
CODE_200021(200021, "场景描述 sceneDesc 参数错误"),
/**
- * 禁止创建/更新商品(如商品创建功能被封禁) 或 禁止编辑&更新房间
+ * {@code 禁止创建/更新商品(如商品创建功能被封禁) 或 禁止编辑&更新房间}
*/
CODE_300001(300001, "禁止创建/更新商品(如商品创建功能被封禁) 或 禁止编辑&更新房间"),
@@ -8382,7 +8382,7 @@ public enum WxOpenErrorMsgEnum {
CODE_9300003(9300003, "begin_time must less than end_time"),
/**
- * end_time - begin_time > 1year
+ * {@code end_time - begin_time > 1year}
*/
CODE_9300004(9300004, "end_time - begin_time > 1year"),
@@ -8397,7 +8397,7 @@ public enum WxOpenErrorMsgEnum {
CODE_9300006(9300006, "invalid activity status"),
/**
- * gift_num must >0 and <=15
+ * {@code gift_num must >0 and <=15}
*/
CODE_9300007(9300007, "gift_num must >0 and <=15"),
@@ -8412,7 +8412,7 @@ public enum WxOpenErrorMsgEnum {
CODE_9300009(9300009, "activity can not finish"),
/**
- * card_info_list must >= 2
+ * {@code card_info_list must >= 2}
*/
CODE_9300010(9300010, "card_info_list must >= 2"),
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/service/WxOcrService.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/service/WxOcrService.java
index 39a8a93754..d0aeef8491 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/service/WxOcrService.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/service/WxOcrService.java
@@ -12,7 +12,9 @@
/**
* 基于小程序或 H5 的身份证、银行卡、行驶证 OCR 识别.
- * https://mp.weixin.qq.com/wiki?t=resource/res_main&id=21516712284rHWMX
+ *
+ * 参考:{@code https://mp.weixin.qq.com/wiki?t=resource/res_main&id=21516712284rHWMX}
+ *
*
* @author Binary Wang
* created on 2019-06-22
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/session/InternalSessionManager.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/session/InternalSessionManager.java
index e3d9ab8351..24ea58ef38 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/session/InternalSessionManager.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/session/InternalSessionManager.java
@@ -7,13 +7,12 @@ public interface InternalSessionManager {
/**
* Return the active Session, associated with this Manager, with the
- * specified session id (if any); otherwise return null.
+ * specified session id (if any); otherwise return {@code null}.
*
* @param id The session id for the session to be returned
+ * @return the session or null
* @throws IllegalStateException if a new session cannot be
* instantiated for any reason
- * @throws java.io.IOException if an input/output error occurs while
- * processing this request
*/
InternalSession findSession(String id);
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/SignUtils.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/SignUtils.java
index fc3579d45c..1886209f98 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/SignUtils.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/SignUtils.java
@@ -25,6 +25,7 @@ public class SignUtils {
*
* @param message 签名数据
* @param key 签名密钥
+ * @return 签名结果
*/
public static String createHmacSha256Sign(String message, String key) {
try {
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/crypto/SHA1.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/crypto/SHA1.java
index 9b9f776768..43cc54b43d 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/crypto/SHA1.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/crypto/SHA1.java
@@ -29,7 +29,10 @@ public static String gen(String... arr) {
}
/**
- * 用&串接arr参数,生成sha1 digest.
+ * {@code 用&串接arr参数,生成sha1 digest.}
+ *
+ * @param arr 参数数组
+ * @return sha1摘要
*/
public static String genWithAmple(String... arr) {
if (StringUtils.isAnyEmpty(arr)) {
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/crypto/WxCryptUtil.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/crypto/WxCryptUtil.java
index 0b0590b1e6..50362636fc 100755
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/crypto/WxCryptUtil.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/crypto/WxCryptUtil.java
@@ -197,6 +197,7 @@ public EncryptContext encryptContext(String plainText) {
/**
* 对明文进行加密.
*
+ * @param randomStr 随机字符串
* @param plainText 需要加密的明文
* @return 加密后base64编码的字符串
*/
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/InputStreamData.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/InputStreamData.java
index d07873f3c4..f03932984f 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/InputStreamData.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/InputStreamData.java
@@ -10,8 +10,9 @@
/**
* 输入流数据.
- *
+ *
* InputStreamData
+ *
*
* @author zichuan.zhou91@gmail.com
* created on 2022/2/15
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/apache/ApacheHttpClientBuilder.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/apache/ApacheHttpClientBuilder.java
index de34ca5bd1..5b13e7cc17 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/apache/ApacheHttpClientBuilder.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/apache/ApacheHttpClientBuilder.java
@@ -21,42 +21,66 @@ public interface ApacheHttpClientBuilder {
/**
* 代理服务器地址.
+ *
+ * @param httpProxyHost 代理服务器地址
+ * @return ApacheHttpClientBuilder
*/
ApacheHttpClientBuilder httpProxyHost(String httpProxyHost);
/**
* 代理服务器端口.
+ *
+ * @param httpProxyPort 代理服务器端口
+ * @return ApacheHttpClientBuilder
*/
ApacheHttpClientBuilder httpProxyPort(int httpProxyPort);
/**
* 代理服务器用户名.
+ *
+ * @param httpProxyUsername 代理服务器用户名
+ * @return ApacheHttpClientBuilder
*/
ApacheHttpClientBuilder httpProxyUsername(String httpProxyUsername);
/**
* 代理服务器密码.
+ *
+ * @param httpProxyPassword 代理服务器密码
+ * @return ApacheHttpClientBuilder
*/
ApacheHttpClientBuilder httpProxyPassword(String httpProxyPassword);
/**
* 重试策略.
+ *
+ * @param httpRequestRetryHandler 重试处理器
+ * @return ApacheHttpClientBuilder
*/
- ApacheHttpClientBuilder httpRequestRetryHandler(HttpRequestRetryHandler httpRequestRetryHandler );
+ ApacheHttpClientBuilder httpRequestRetryHandler(HttpRequestRetryHandler httpRequestRetryHandler);
/**
* 超时时间.
+ *
+ * @param keepAliveStrategy 保持连接策略
+ * @return ApacheHttpClientBuilder
*/
ApacheHttpClientBuilder keepAliveStrategy(ConnectionKeepAliveStrategy keepAliveStrategy);
/**
* ssl连接socket工厂.
+ *
+ * @param sslConnectionSocketFactory SSL连接Socket工厂
+ * @return ApacheHttpClientBuilder
*/
ApacheHttpClientBuilder sslConnectionSocketFactory(SSLConnectionSocketFactory sslConnectionSocketFactory);
/**
* 支持的TLS协议版本.
* Supported TLS protocol versions.
+ *
+ * @param supportedProtocols 支持的协议版本数组
+ * @return ApacheHttpClientBuilder
*/
ApacheHttpClientBuilder supportedProtocols(String[] supportedProtocols);
}
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/json/WxGsonBuilder.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/json/WxGsonBuilder.java
index 6ea269f7e4..8f3dafe48a 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/json/WxGsonBuilder.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/json/WxGsonBuilder.java
@@ -43,6 +43,11 @@ public boolean shouldSkipClass(Class> aClass) {
});
}
+ /**
+ * 创建Gson实例
+ *
+ * @return Gson实例
+ */
public static Gson create() {
if (Objects.isNull(GSON_INSTANCE)) {
synchronized (INSTANCE) {
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/xml/XStreamInitializer.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/xml/XStreamInitializer.java
index 3fa91fa70e..51cd1e980c 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/xml/XStreamInitializer.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/xml/XStreamInitializer.java
@@ -22,6 +22,11 @@ public class XStreamInitializer {
public static ClassLoader classLoader;
+ /**
+ * 设置类加载器
+ *
+ * @param classLoaderInfo 类加载器
+ */
public static void setClassLoader(ClassLoader classLoaderInfo) {
classLoader = classLoaderInfo;
}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpCorpGroupService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpCorpGroupService.java
index 4da13d3fde..69aea4bca7 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpCorpGroupService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpCorpGroupService.java
@@ -9,7 +9,7 @@
* 企业互联相关接口
*
* @author libo <422423229@qq.com>
- * Created on 27/2/2023 9:57 PM
+ * @since 2023-02-27 9:57 PM
*/
public interface WxCpCorpGroupService {
/**
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExportService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExportService.java
index 24c6ea9dc1..a2c7adabea 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExportService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExportService.java
@@ -85,7 +85,7 @@ public interface WxCpExportService {
* 获取导出结果
*
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/export/get_result?access_token=ACCESS_TOKEN&jobid=jobid_xxxxxxxxxxxxxxx
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/export/get_result?access_token=ACCESS_TOKEN&jobid=jobid_xxxxxxxxxxxxxxx}
*
* 文档地址:https://developer.work.weixin.qq.com/document/path/94854
* 返回的url文件下载解密可参考 CSDN
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExternalContactService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExternalContactService.java
index 7f3cdeab7c..6de9f9226d 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExternalContactService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExternalContactService.java
@@ -146,7 +146,7 @@ public interface WxCpExternalContactService {
* 企业可通过此接口,根据外部联系人的userid(如何获取?),拉取客户详情。
*
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid=EXTERNAL_USERID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid=EXTERNAL_USERID}
*
* 权限说明:
*
@@ -252,9 +252,9 @@ public interface WxCpExternalContactService {
*
* 权限说明:
*
- * 该企业授权了该服务商第三方应用,且授权的第三方应用具备“企业客户权限->客户基础信息”权限
+ * {@code 该企业授权了该服务商第三方应用,且授权的第三方应用具备“企业客户权限->客户基础信息”权限}
* 该客户的跟进人必须在应用的可见范围之内
- * 应用需具备“企业客户权限->客户基础信息”权限
+ * {@code 应用需具备“企业客户权限->客户基础信息”权限}
*
*
* @param externalUserid 代开发自建应用获取到的外部联系人ID
@@ -276,8 +276,8 @@ public interface WxCpExternalContactService {
*
* @param externalUserid 服务商主体的external_userid,必须是source_agentid对应的应用所获取
* @param sourceAgentId 企业授权的代开发自建应用或第三方应用的agentid
- * @return
- * @throws WxErrorException
+ * @return 企业的external_userid
+ * @throws WxErrorException 微信错误异常
*/
String fromServiceExternalUserid(String externalUserid, String sourceAgentId) throws WxErrorException;
@@ -362,7 +362,7 @@ public interface WxCpExternalContactService {
* 权限说明:
*
* 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)
- * 第三方应用需具有“企业客户权限->客户基础信息”权限
+ * {@code 第三方应用需具有“企业客户权限->客户基础信息”权限}
* 对于第三方/自建应用,群主必须在应用的可见范围
* 仅支持企业服务人员创建的客户群
* 仅可转换出自己企业下的客户群chat_id
@@ -410,11 +410,12 @@ WxCpExternalContactBatchInfo getContactDetailBatch(String[] userIdList, String c
* 文档地址: https://developer.work.weixin.qq.com/document/path/99434
*
*
+ * 注意:企业可通过外部联系人临时ID排除重复数据,外部联系人临时ID有效期为4小时。
+ *
* @param cursor the cursor
* @param limit the limit
* @return 已服务的外部联系人列表
* @throws WxErrorException .
- * @apiNote 企业可通过外部联系人临时ID排除重复数据,外部联系人临时ID有效期为4小时。
*/
WxCpExternalContactListInfo getContactList(String cursor, Integer limit) throws WxErrorException;
@@ -438,7 +439,7 @@ WxCpExternalContactBatchInfo getContactDetailBatch(String[] userIdList, String c
* 企业可通过此接口获取指定成员添加的客户列表。客户是指配置了客户联系功能的成员所添加的外部联系人。没有配置客户联系功能的成员,所添加的外部联系人将不会作为客户返回。
*
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/list?access_token=ACCESS_TOKEN&userid=USERID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/list?access_token=ACCESS_TOKEN&userid=USERID}
*
* 权限说明:
*
@@ -469,7 +470,8 @@ WxCpExternalContactBatchInfo getContactDetailBatch(String[] userIdList, String c
/**
* 获取待分配的离职成员列表
* 企业和第三方可通过此接口,获取所有离职成员的客户列表,并可进一步调用分配离职成员的客户接口将这些客户重新分配给其他企业成员。
- *
+
+ *
* 请求方式:POST(HTTPS)
* 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_unassigned_list?access_token=ACCESS_TOKEN
*
@@ -496,17 +498,17 @@ WxCpExternalContactBatchInfo getContactDetailBatch(String[] userIdList, String c
/**
* 企业可通过此接口,转接在职成员的客户给其他成员。
- *
+ *
* 权限说明:
- * * 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。
- * 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限
+ * 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。
+ * {@code 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限}
* 接替成员必须在此第三方应用或自建应用的可见范围内。
* 接替成员需要配置了客户联系功能。
* 接替成员需要在企业微信激活且已经过实名认证。
- *
+ *
* 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。
- * 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限
+ * {@code 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限}
* 接替成员必须在此第三方应用或自建应用的可见范围内。
- *
+
+ *
* 权限说明:
- *
+
+ *
* 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。
- * 第三方应用需拥有“企业客户权限->客户联系->离职分配”权限
+ * {@code 第三方应用需拥有“企业客户权限->客户联系->离职分配”权限}
* 接替成员必须在此第三方应用或自建应用的可见范围内。
* 接替成员需要配置了客户联系功能。
* 接替成员需要在企业微信激活且已经过实名认证。
- *
+
+ *
* 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。
- * 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限
+ * {@code 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限}
* 接替成员必须在此第三方应用或自建应用的可见范围内。
- *
+
+ *
* 群主离职了的客户群,才可继承
* 继承给的新群主,必须是配置了客户联系功能的成员
* 继承给的新群主,必须有设置实名
* 继承给的新群主,必须有激活企业微信
* 同一个人的群,限制每天最多分配300个给新群主
- *
+
+ *
* 权限说明:
- *
+
+ *
* 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。
- * 第三方应用需拥有“企业客户权限->客户联系->分配离职成员的客户群”权限
+ * {@code 第三方应用需拥有“企业客户权限->客户联系->分配离职成员的客户群”权限}
* 对于第三方/自建应用,群主必须在应用的可见范围。
- *
+
+ *
* 请求方式: POST(HTTP)
- *
+
+ *
* 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_msg_template?access_token=ACCESS_TOKEN
- *
+
+ *
* 文档地址
*
* @param wxCpMsgTemplate the wx cp msg template
@@ -733,15 +744,18 @@ WxCpUserExternalGroupChatStatistic getGroupChatStatistic(Date startTime, Integer
/**
* 提醒成员群发
* 企业和第三方应用可调用此接口,重新触发群发通知,提醒成员完成群发任务,24小时内每个群发最多触发三次提醒。
- *
+
+ *
* 请求方式: POST(HTTPS)
- *
+
+ *
* 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/remind_groupmsg_send?access_token=ACCESS_TOKEN
- *
+ *
* 文档地址
*
* @param msgId 群发消息的id,通过获取群发记录列表接口返回
* @return the wx cp msg template add result
+ * @throws WxErrorException 微信错误异常
*/
WxCpBaseResp remindGroupMsgSend(String msgId) throws WxErrorException;
@@ -753,11 +767,12 @@ WxCpUserExternalGroupChatStatistic getGroupChatStatistic(Date startTime, Integer
* 请求方式: POST(HTTPS)
*
* 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/cancel_groupmsg_send?access_token=ACCESS_TOKEN
- *
+ *
* 文档地址
*
* @param msgId 群发消息的id,通过获取群发记录列表接口返回
* @return the wx cp msg template add result
+ * @throws WxErrorException 微信错误异常
*/
WxCpBaseResp cancelGroupMsgSend(String msgId) throws WxErrorException;
@@ -1002,7 +1017,7 @@ WxCpGroupMsgListResult getGroupMsgListV2(String chatType, Date startTime, Date e
/**
*
+ *
+ *
+ *
+ *
+ *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid
- * =EXTERNAL_USERID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid=EXTERNAL_USERID}
*
* @param externalUserId 外部联系人的userid,注意不是学校成员的帐号
* @return external contact
@@ -306,9 +315,9 @@ WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserI
/**
* 获取可使用的家长范围
* 获取可在微信「学校通知-学校应用」使用该应用的家长范围,以学生或部门列表的形式返回。应用只能给该列表下的家长发送「学校通知」。注意该范围只能由学校的系统管理员在「管理端-家校沟通-配置」配置。
- *
+ *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/agent/get_allow_scope?access_token=ACCESS_TOKEN&agentid=AGENTID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/agent/get_allow_scope?access_token=ACCESS_TOKEN&agentid=AGENTID}
*
* @param agentId the agent id
* @return allow scope
@@ -332,7 +341,7 @@ WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserI
/**
* 获取部门列表
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/department/list?access_token=ACCESS_TOKEN&id=ID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/department/list?access_token=ACCESS_TOKEN&id=ID}
*
* @param id 部门id。获取指定部门及其下的子部门。 如果不填,默认获取全量组织架构
* @return wx cp department list
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpService.java
index 0b601ca502..76012a2812 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpService.java
@@ -584,7 +584,7 @@ public interface WxCpService extends WxService {
/**
* 企业互联的服务类对象
*
- * @return
+ * @return 企业互联服务对象
*/
WxCpCorpGroupService getCorpGroupService();
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpUserService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpUserService.java
index 2368386b23..7a7b5f40a8 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpUserService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpUserService.java
@@ -38,7 +38,7 @@ public interface WxCpUserService {
*
- * Created by songfan on 2020/7/14.
*
- * @author songfan & Mr.Pan
+ * @author songfan, Mr.Pan
+ * @since 2020/7/14
*/
@Data
@Builder
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalUnassignList.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalUnassignList.java
index 8605760fa7..f3fdd96ce7 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalUnassignList.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalUnassignList.java
@@ -12,7 +12,8 @@
/**
* 离职员工外部联系人列表
*
- * @author yqx & Wang_Wong created on 2020/3/15
+ * @author yqx, Wang_Wong
+ * @since 2020/3/15
*/
@Getter
@Setter
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/acquisition/WxCpCustomerAcquisitionStatistic.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/acquisition/WxCpCustomerAcquisitionStatistic.java
index bb02b039bd..87e3d5580a 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/acquisition/WxCpCustomerAcquisitionStatistic.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/acquisition/WxCpCustomerAcquisitionStatistic.java
@@ -10,7 +10,7 @@
* 获客链接的使用详情
*
* @author Hugo
- * @date 2023/12/11 10:31
+ * @since 2023/12/11 10:31
*/
@Data
@EqualsAndHashCode(callSuper = true)
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/interceptrule/WxCpInterceptRuleInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/interceptrule/WxCpInterceptRuleInfo.java
index 20d6b32442..23bb70a240 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/interceptrule/WxCpInterceptRuleInfo.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/interceptrule/WxCpInterceptRuleInfo.java
@@ -10,9 +10,10 @@
import java.util.List;
/**
- * @Date: 2024-03-07 17:02
- * @Author: shenliuming
- * @return:
+ * 防骚扰规则详情
+ *
+ * @author shenliuming
+ * @since 2024-03-07 17:02
*/
@Data
@EqualsAndHashCode(callSuper = true)
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/interceptrule/WxCpInterceptRuleList.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/interceptrule/WxCpInterceptRuleList.java
index 6826413e13..543d32fcb9 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/interceptrule/WxCpInterceptRuleList.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/interceptrule/WxCpInterceptRuleList.java
@@ -9,9 +9,10 @@
import java.util.List;
/**
- * @Date: 2024-03-07 15:54
- * @Author: shenliuming
- * @return:
+ * 防骚扰规则列表
+ *
+ * @author shenliuming
+ * @since 2024-03-07 15:54
*/
@Data
@EqualsAndHashCode(callSuper = true)
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Attachment.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Attachment.java
index be9dcc9dd0..1fff457f97 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Attachment.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Attachment.java
@@ -33,6 +33,7 @@ public class Attachment implements Serializable {
* Sets image.
*
* @param image the image
+ * @return this
*/
public Attachment setImage(Image image) {
this.image = image;
@@ -44,6 +45,7 @@ public Attachment setImage(Image image) {
* Sets link.
*
* @param link the link
+ * @return this
*/
public Attachment setLink(Link link) {
this.link = link;
@@ -55,6 +57,7 @@ public Attachment setLink(Link link) {
* Sets mini program.
*
* @param miniProgram the mini program
+ * @return this
*/
public Attachment setMiniProgram(MiniProgram miniProgram) {
this.miniProgram = miniProgram;
@@ -66,6 +69,7 @@ public Attachment setMiniProgram(MiniProgram miniProgram) {
* Sets video.
*
* @param video the video
+ * @return this
*/
public Attachment setVideo(Video video) {
this.video = video;
@@ -77,6 +81,7 @@ public Attachment setVideo(Video video) {
* Sets file.
*
* @param file the file
+ * @return this
*/
public Attachment setFile(File file) {
this.file = file;
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountLink.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountLink.java
index a903d0fa54..38d25e61cd 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountLink.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountLink.java
@@ -27,10 +27,10 @@ public class WxCpKfAccountLink implements Serializable {
* 场景值,字符串类型,由开发者自定义。
* 不多于32字节
* 字符串取值范围(正则表达式):[0-9a-zA-Z_-]*
- *
+ *
* 1. 若scene非空,返回的客服链接开发者可拼接scene_param=SCENE_PARAM参数使用,用户进入会话事件会将SCENE_PARAM原样返回。
* 其中SCENE_PARAM需要urlencode,且长度不能超过128字节。
- * 如 https://work.weixin.qq.com/kf/kfcbf8f8d07ac7215f?enc_scene=ENCGFSDF567DF&scene_param=a%3D1%26b%3D2
+ * {@code 如 https://work.weixin.qq.com/kf/kfcbf8f8d07ac7215f?enc_scene=ENCGFSDF567DF&scene_param=a%3D1%26b%3D2}
* 2. 历史调用接口返回的客服链接(包含encScene=XXX参数),不支持scene_param参数。
* 3. 返回的客服链接,不能修改或复制参数到其他链接使用。否则进入会话事件参数校验不通过,导致无法回调。
*/
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/media/MediaUploadByUrlReq.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/media/MediaUploadByUrlReq.java
index c5cb21bde5..0149a426f6 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/media/MediaUploadByUrlReq.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/media/MediaUploadByUrlReq.java
@@ -5,8 +5,9 @@
/**
* 生成异步上传任务
+ *
* @author imyzt
- * @date 2025/04/27
+ * @since 2025/04/27
*/
@Data
public class MediaUploadByUrlReq {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/media/MediaUploadByUrlResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/media/MediaUploadByUrlResult.java
index cc931eed39..595f85dffa 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/media/MediaUploadByUrlResult.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/media/MediaUploadByUrlResult.java
@@ -10,8 +10,9 @@
/**
* 异步上传企微素材
+ *
* @author imyzt
- * @date 2025/4/27
+ * @since 2025/4/27
*/
@EqualsAndHashCode(callSuper = true)
@Data
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpLinkedCorpMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpLinkedCorpMessage.java
index 92209fd4e5..7e777384eb 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpLinkedCorpMessage.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpLinkedCorpMessage.java
@@ -85,13 +85,13 @@ public class WxCpLinkedCorpMessage implements Serializable {
/**
*
* 文档地址
- *
* external_userid必须是handover_userid的客户(即配置了客户联系功能的成员所添加的联系人)。
* 在职成员的每位客户最多被分配2次。客户被转接成功后,将有90个自然日的服务关系保护期,保护期内的客户无法再次被分配。
- *
* 权限说明:
- *
* handover_userid必须是已离职用户。
* external_userid必须是handover_userid的客户(即配置了客户联系功能的成员所添加的联系人)。
* 在职成员的每位客户最多被分配2次。客户被转接成功后,将有90个自然日的服务关系保护期,保护期内的客户无法再次被分配。
- *
* 权限说明:
- *
* 注意::
- *
* 注意:
* 继承给的新群主,必须是配置了客户联系功能的成员
* 继承给的新群主,必须有设置实名
@@ -716,11 +724,14 @@ WxCpUserExternalGroupChatStatistic getGroupChatStatistic(Date startTime, Integer
* 企业可通过此接口添加企业群发消息的任务并通知客服人员发送给相关客户或客户群。(注:企业微信终端需升级到2.7.5版本及以上)
* 注意:调用该接口并不会直接发送消息给客户/客户群,需要相关的客服人员操作以后才会实际发送(客服人员的企业微信需要升级到2.7.5及以上版本)
* 同一个企业每个自然月内仅可针对一个客户/客户群发送4条消息,超过限制的用户将会被忽略。
- *
*
* @param mediaId 媒体id
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMessageService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMessageService.java
index e49a36ba50..534cc89b36 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMessageService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMessageService.java
@@ -72,8 +72,9 @@ public interface WxCpMessageService {
* 请求地址: https://qyapi.weixin.qq.com/cgi-bin/message/recall?access_token=ACCESS_TOKEN
* 文档地址: https://developer.work.weixin.qq.com/document/path/94867
*
+ *
* @param msgId 消息id
- * @throws WxErrorException
+ * @throws WxErrorException 异常
*/
void recall(String msgId) throws WxErrorException;
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOAuth2Service.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOAuth2Service.java
index b7a44047aa..1824196720 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOAuth2Service.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOAuth2Service.java
@@ -90,9 +90,10 @@ public interface WxCpOAuth2Service {
/**
* 获取家校访问用户身份
* 该接口用于根据code获取家长或者学生信息
- *
* 企业和第三方应用可通过此接口获取企业与成员的群发记录。
- * 获取企业群发成员执行结果
+ * 文档地址:https://work.weixin.qq.com/api/doc/90000/90135/93338
*
*
* @param msgid 群发消息的id,通过获取群发记录列表接口返回
@@ -1031,7 +1046,7 @@ WxCpGroupMsgListResult getGroupMsgListV2(String chatType, Date startTime, Date e
/**
*
* 获取群发成员发送任务列表。
- * 获取群发成员发送任务列表
+ * 文档地址:https://work.weixin.qq.com/api/doc/90000/90135/93338
*
*
* @param msgid 群发消息的id,通过获取群发记录列表接口返回
@@ -1045,7 +1060,7 @@ WxCpGroupMsgListResult getGroupMsgListV2(String chatType, Date startTime, Date e
/**
*
* 添加入群欢迎语素材。
- * 添加入群欢迎语素材
+ * 文档地址:https://open.work.weixin.qq.com/api/doc/90000/90135/92366
*
*
* @param template 素材内容
@@ -1057,7 +1072,7 @@ WxCpGroupMsgListResult getGroupMsgListV2(String chatType, Date startTime, Date e
/**
*
* 编辑入群欢迎语素材。
- * 编辑入群欢迎语素材
+ * 文档地址:https://open.work.weixin.qq.com/api/doc/90000/90135/92366
*
*
* @param template the template
@@ -1069,7 +1084,7 @@ WxCpGroupMsgListResult getGroupMsgListV2(String chatType, Date startTime, Date e
/**
*
* 获取入群欢迎语素材。
- * 获取入群欢迎语素材
+ * 文档地址:https://open.work.weixin.qq.com/api/doc/90000/90135/92366
*
*
* @param templateId 群欢迎语的素材id
@@ -1082,7 +1097,7 @@ WxCpGroupMsgListResult getGroupMsgListV2(String chatType, Date startTime, Date e
*
* 删除入群欢迎语素材。
* 企业可通过此API删除入群欢迎语素材,且仅能删除调用方自己创建的入群欢迎语素材。
- * 删除入群欢迎语素材
+ * 文档地址:https://open.work.weixin.qq.com/api/doc/90000/90135/92366
*
*
* @param templateId 群欢迎语的素材id
@@ -1094,8 +1109,8 @@ WxCpGroupMsgListResult getGroupMsgListV2(String chatType, Date startTime, Date e
/**
*
- * 获取商品图册
- * 获取商品图册列表
+ * 获取商品图册列表
+ * 文档地址:https://work.weixin.qq.com/api/doc/90000/90135/95096
*
*
* @param limit 返回的最大记录数,整型,最大值100,默认值50,超过最大值时取默认值
@@ -1108,7 +1123,7 @@ WxCpGroupMsgListResult getGroupMsgListV2(String chatType, Date startTime, Date e
/**
*
* 获取商品图册
- * 获取商品图册
+ * 文档地址:https://work.weixin.qq.com/api/doc/90000/90135/95096
*
*
* @param productId 商品id
@@ -1155,7 +1170,7 @@ WxMediaUploadResult uploadAttachment(String mediaType, Integer attachmentType, F
* 企业和第三方应用可以通过此接口新建敏感词规则
* 请求方式:POST(HTTPS)
* 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_intercept_rule?access_token=ACCESS_TOKEN
- *
+ *
* @param ruleAddRequest the rule add request
* @return 规则id
* @throws WxErrorException the wx error exception
@@ -1169,7 +1184,7 @@ WxMediaUploadResult uploadAttachment(String mediaType, Integer attachmentType, F
* 企业和第三方应用可以通过此接口修改敏感词规则
* 请求方式:POST(HTTPS)
* 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/update_intercept_rule?access_token=ACCESS_TOKEN
- *
+ *
* @param interceptRule the rule
* @throws WxErrorException the wx error exception
*/
@@ -1181,7 +1196,7 @@ WxMediaUploadResult uploadAttachment(String mediaType, Integer attachmentType, F
* 企业和第三方应用可以通过此接口修改敏感词规则
* 请求方式:POST(HTTPS)
* 请求地址
- *
+ *
* @param ruleId 规则id
* @throws WxErrorException the wx error exception
*/
@@ -1220,7 +1235,7 @@ WxMediaUploadResult uploadAttachment(String mediaType, Integer attachmentType, F
* 请求地址:
* https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_product_album?access_token=ACCESS_TOKEN
* 文档地址
- *
+ *
* @param wxCpProductAlbumInfo 商品图册信息
* @return 商品id string
* @throws WxErrorException the wx error exception
@@ -1235,7 +1250,7 @@ WxMediaUploadResult uploadAttachment(String mediaType, Integer attachmentType, F
* 请求地址:
* https://qyapi.weixin.qq.com/cgi-bin/externalcontact/update_product_album?access_token=ACCESS_TOKEN
* 文档地址
- *
+ *
* @param wxCpProductAlbumInfo 商品图册信息
* @throws WxErrorException the wx error exception
*/
@@ -1250,7 +1265,7 @@ WxMediaUploadResult uploadAttachment(String mediaType, Integer attachmentType, F
* https://qyapi.weixin.qq.com/cgi-bin/externalcontact/delete_product_album?access_token=ACCESS_TOKEN
*
* 文档地址
- *
+ *
* @param productId 商品id
* @throws WxErrorException the wx error exception
*/
@@ -1379,7 +1394,7 @@ WxMediaUploadResult uploadAttachment(String mediaType, Integer attachmentType, F
* 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition/statistic?access_token=ACCESS_TOKEN
*
* @author Hugo
- * @date 2023/12/5 14:34
+ * @since 2023/12/5 14:34
* @param linkId 获客链接的id
* @param startTime 统计起始时间
* @param endTime 统计结束时间
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpGroupRobotService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpGroupRobotService.java
index c1a8d56255..b8ccea5e50 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpGroupRobotService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpGroupRobotService.java
@@ -126,9 +126,10 @@ public interface WxCpGroupRobotService {
/**
* 发送模板卡片消息
- * @param webhookUrl
- * @param wxCpGroupRobotMessage
- * @throws WxErrorException
+ *
+ * @param webhookUrl webhook地址
+ * @param wxCpGroupRobotMessage 群机器人消息
+ * @throws WxErrorException 异常
*/
void sendTemplateCardMessage(String webhookUrl, WxCpGroupRobotMessage wxCpGroupRobotMessage) throws WxErrorException;
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpKfService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpKfService.java
index 5a53829dc0..046cfbc5bb 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpKfService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpKfService.java
@@ -222,7 +222,7 @@ WxCpKfCustomerBatchGetResp customerBatchGet(List
+ *
* @param request 查询参数
* @return 客户数据统计 -企业汇总数据
* @throws WxErrorException the wx error exception
@@ -238,7 +238,7 @@ WxCpKfCustomerBatchGetResp customerBatchGet(List
+ *
* @param request 查询参数
* @return 客户数据统计 -企业汇总数据
* @throws WxErrorException the wx error exception
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpLivingService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpLivingService.java
index a2e2344190..63fabad7a1 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpLivingService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpLivingService.java
@@ -27,7 +27,7 @@ public interface WxCpLivingService {
/**
* 获取直播详情
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/living/get_living_info?access_token=ACCESS_TOKEN&livingid=LIVINGID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/living/get_living_info?access_token=ACCESS_TOKEN&livingid=LIVINGID}
*
* @param livingId 直播id
* @return 获取的直播详情 living info
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMediaService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMediaService.java
index e874b26f42..dd5ce594b2 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMediaService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMediaService.java
@@ -110,9 +110,9 @@ WxMediaUploadResult upload(String mediaType, String filename, String url)
* 获取高清语音素材.
* 可以使用本接口获取从JSSDK的uploadVoice接口上传的临时语音素材,格式为speex,16K采样率。该音频比上文的临时素材获取接口(格式为amr,8K采样率)更加清晰,适合用作语音识别等对音质要求较高的业务。
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/media/get/jssdk?access_token=ACCESS_TOKEN&media_id=MEDIA_ID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/media/get/jssdk?access_token=ACCESS_TOKEN&media_id=MEDIA_ID}
* 仅企业微信2.4及以上版本支持。
- * 文档地址:https://work.weixin.qq.com/api/doc#90000/90135/90255
+ * 文档地址:https://work.weixin.qq.com/api/doc/90000/90135/90255
*
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/getuserinfo?access_token=ACCESS_TOKEN&code=CODE}
+ *
*
* @param code the code
* @return school user info
@@ -123,7 +124,7 @@ public interface WxCpOAuth2Service {
/**
*
* 获取用户登录身份
- * https://qyapi.weixin.qq.com/cgi-bin/auth/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
+ * {@code https://qyapi.weixin.qq.com/cgi-bin/auth/getuserinfo?access_token=ACCESS_TOKEN&code=CODE}
* 该接口可使用用户登录成功颁发的code来获取成员信息,适用于自建应用与代开发应用
*
* 注意: 旧的/user/getuserinfo 接口的url已变更为auth/getuserinfo,不过旧接口依旧可以使用,建议是关注新接口即可
@@ -140,13 +141,15 @@ public interface WxCpOAuth2Service {
/**
* 获取用户二次验证信息
- *
*
* @param wxCpOaMeetingRoomBookingInfoRequest 会议室预定信息查询对象
+ * @return 会议室预定信息
* @throws WxErrorException .
*/
WxCpOaMeetingRoomBookingInfoResult getMeetingRoomBookingInfo(WxCpOaMeetingRoomBookingInfoRequest wxCpOaMeetingRoomBookingInfoRequest) throws WxErrorException;
@@ -99,6 +100,7 @@ public interface WxCpOaMeetingRoomService {
*
*
* @param wxCpOaMeetingRoomBookRequest 会议室预定对象
+ * @return 预定结果
* @throws WxErrorException .
*/
WxCpOaMeetingRoomBookResult bookingMeetingRoom(WxCpOaMeetingRoomBookRequest wxCpOaMeetingRoomBookRequest) throws WxErrorException;
@@ -114,6 +116,7 @@ public interface WxCpOaMeetingRoomService {
*
*
* @param wxCpOaMeetingRoomBookByScheduleRequest 会议室预定对象
+ * @return 预定结果
* @throws WxErrorException .
*/
WxCpOaMeetingRoomBookResult bookingMeetingRoomBySchedule(WxCpOaMeetingRoomBookByScheduleRequest wxCpOaMeetingRoomBookByScheduleRequest) throws WxErrorException;
@@ -129,6 +132,7 @@ public interface WxCpOaMeetingRoomService {
*
*
* @param wxCpOaMeetingRoomBookByMeetingRequest 会议室预定对象
+ * @return 预定结果
* @throws WxErrorException .
*/
WxCpOaMeetingRoomBookResult bookingMeetingRoomByMeeting(WxCpOaMeetingRoomBookByMeetingRequest wxCpOaMeetingRoomBookByMeetingRequest) throws WxErrorException;
@@ -147,10 +151,10 @@ public interface WxCpOaMeetingRoomService {
* @param wxCpOaMeetingRoomCancelBookRequest 取消预定会议室对象
* @throws WxErrorException .
*/
- void cancelBookMeetingRoom(WxCpOaMeetingRoomCancelBookRequest wxCpOaMeetingRoomCancelBookRequest) throws WxErrorException;
+ void cancelBookMeetingRoom(WxCpOaMeetingRoomCancelBookRequest wxCpOaMeetingRoomCancelBookRequest) throws WxErrorException;
- /**
+ /**
* 根据会议室预定ID查询预定详情.
*
* api: https://qyapi.weixin.qq.com/cgi-bin/auth/get_tfa_info?access_token=ACCESS_TOKEN
* 权限说明:仅『通讯录同步』或者自建应用可调用,如用自建应用调用,用户需要在二次验证范围和应用可见范围内。
* 并发限制:20
+ *
*
* @param code 用户进入二次验证页面时,企业微信颁发的code,每次成员授权带上的code将不一样,code只能使用一次,5分钟未被使用自动过期
- * @return me.chanjar.weixin.cp.bean.workbench.WxCpSecondVerificationInfo 二次验证授权码,开发者可以调用通过二次验证接口,解锁企业微信终端.tfa_code有效期五分钟,且只能使用一次。
+ * @return 二次验证授权码,开发者可以调用通过二次验证接口,解锁企业微信终端.tfa_code有效期五分钟,且只能使用一次。
+ * @throws WxErrorException 微信错误异常
*/
WxCpSecondVerificationInfo getTfaInfo(String code) throws WxErrorException;
}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaMeetingRoomService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaMeetingRoomService.java
index c2e6c5c872..cc039fd9f5 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaMeetingRoomService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaMeetingRoomService.java
@@ -84,6 +84,7 @@ public interface WxCpOaMeetingRoomService {
*
* 企业可通过此接口根据预定id查询相关会议室的预定情况
@@ -161,8 +165,9 @@ public interface WxCpOaMeetingRoomService {
*
*
* @param wxCpOaMeetingRoomBookingInfoByBookingIdRequest 根据会议室预定ID查询预定详情对象
+ * @return 预定详情
* @throws WxErrorException .
*/
- WxCpOaMeetingRoomBookingInfoByBookingIdResult getBookingInfoByBookingId(WxCpOaMeetingRoomBookingInfoByBookingIdRequest wxCpOaMeetingRoomBookingInfoByBookingIdRequest) throws WxErrorException;
+ WxCpOaMeetingRoomBookingInfoByBookingIdResult getBookingInfoByBookingId(WxCpOaMeetingRoomBookingInfoByBookingIdRequest wxCpOaMeetingRoomBookingInfoByBookingIdRequest) throws WxErrorException;
}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaService.java
index ee57107b5c..3494dcfa4e 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaService.java
@@ -11,7 +11,8 @@
/**
* 企业微信OA相关接口.
*
- * @author Element & Wang_Wong created on 2019-04-06 10:52
+ * @author Element, Wang_Wong
+ * @since 2019-04-06 10:52
*/
public interface WxCpOaService {
@@ -331,7 +332,7 @@ List
+ *
* @param userId 需要录入的用户id
* @param userFace 需要录入的人脸图片数据,需要将图片数据base64处理后填入,对已录入的人脸会进行更新处理
* @throws WxErrorException the wx error exception
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolService.java
index 56687c9cb1..5f1d41c197 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolService.java
@@ -80,9 +80,10 @@ public interface WxCpSchoolService {
/**
* 获取直播详情
+ *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/living/get_living_info?access_token=ACCESS_TOKEN&livingid
- * =LIVINGID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/living/get_living_info?access_token=ACCESS_TOKEN&livingid=LIVINGID}
+ *
*
* @param livingId the living id
* @return living info
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolUserService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolUserService.java
index a92bfcc100..d004ca8aa5 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolUserService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolUserService.java
@@ -19,9 +19,10 @@ public interface WxCpSchoolUserService {
/**
* 获取访问用户身份
* 该接口用于根据code获取成员信息
- *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/user/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/user/getuserinfo?access_token=ACCESS_TOKEN&code=CODE}
+ *
*
* @param code the code
* @return user info
@@ -32,9 +33,10 @@ public interface WxCpSchoolUserService {
/**
* 获取家校访问用户身份
* 该接口用于根据code获取家长或者学生信息
- *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/getuserinfo?access_token=ACCESS_TOKEN&code=CODE}
+ *
*
* @param code the code
* @return school user info
@@ -90,8 +92,10 @@ public interface WxCpSchoolUserService {
/**
* 删除学生
+ *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_student?access_token=ACCESS_TOKEN&userid=USERID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_student?access_token=ACCESS_TOKEN&userid=USERID}
+ *
*
* @param studentUserId the student user id
* @return wx cp base resp
@@ -160,8 +164,10 @@ WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserI
/**
* 读取学生或家长
+ *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/get?access_token=ACCESS_TOKEN&userid=USERID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/get?access_token=ACCESS_TOKEN&userid=USERID}
+ *
*
* @param userId the user id
* @return user
@@ -171,9 +177,10 @@ WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserI
/**
* 获取部门成员详情
+ *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/list?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID
- * &fetch_child=FETCH_CHILD
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/list?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID&fetch_child=FETCH_CHILD}
+ *
*
* @param departmentId 获取的部门id
* @param fetchChild 1/0:是否递归获取子部门下面的成员
@@ -184,9 +191,10 @@ WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserI
/**
* 获取部门家长详情
+ *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/list_parent?access_token=ACCESS_TOKEN&department_id
- * =DEPARTMENT_ID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/list_parent?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID}
+ *
*
* @param departmentId 获取的部门id
* @return user list parent
@@ -207,8 +215,10 @@ WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserI
/**
* 删除家长
+ *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_parent?access_token=ACCESS_TOKEN&userid=USERID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_parent?access_token=ACCESS_TOKEN&userid=USERID}
+ *
*
* @param userId the user id
* @return wx cp base resp
@@ -256,7 +266,7 @@ WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserI
/**
* 删除部门
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/department/delete?access_token=ACCESS_TOKEN&id=ID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/department/delete?access_token=ACCESS_TOKEN&id=ID}
*
* @param id the id
* @return wx cp base resp
@@ -292,10 +302,9 @@ WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserI
/**
* 获取外部联系人详情
* 学校可通过此接口,根据外部联系人的userid(如何获取?),拉取外部联系人详情。
- *
* 获取部门成员详情
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/user/list?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID&fetch_child=FETCH_CHILD
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/user/list?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID&fetch_child=FETCH_CHILD}
*
* 文档地址:https://work.weixin.qq.com/api/doc/90000/90135/90201
*
@@ -213,7 +213,7 @@ public interface WxCpUserService {
* 获取加入企业二维码。
*
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/corp/get_join_qrcode?access_token=ACCESS_TOKEN&size_type=SIZE_TYPE
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/corp/get_join_qrcode?access_token=ACCESS_TOKEN&size_type=SIZE_TYPE}
*
* 文档地址:https://work.weixin.qq.com/api/doc/90000/90135/91714
*
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpCorpGroupServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpCorpGroupServiceImpl.java
index 48bd952a83..e3dc1cbe1c 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpCorpGroupServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpCorpGroupServiceImpl.java
@@ -18,7 +18,7 @@
* 企业互联相关接口实现类
*
* @author libo <422423229@qq.com>
- * Created on 27/2/2023 9:57 PM
+ * @since 2023-02-27 9:57 PM
*/
@RequiredArgsConstructor
public class WxCpCorpGroupServiceImpl implements WxCpCorpGroupService {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpExternalContactServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpExternalContactServiceImpl.java
index 8e3a8d7b95..d43589595f 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpExternalContactServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpExternalContactServiceImpl.java
@@ -38,7 +38,7 @@
/**
* The type Wx cp external contact service.
*
- * @author 曹祖鹏 & yuanqixun & Mr.Pan & Wang_Wong
+ * @author 曹祖鹏, yuanqixun, Mr.Pan, Wang_Wong
*/
@RequiredArgsConstructor
public class WxCpExternalContactServiceImpl implements WxCpExternalContactService {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpBaseResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpBaseResp.java
index 6bf9a30aeb..a895c38a8f 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpBaseResp.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpBaseResp.java
@@ -10,7 +10,8 @@
/**
* 返回结果
*
- * @author yqx & WangWong created on 2020/3/16
+ * @author yqx, WangWong
+ * @since 2020/3/16
*/
@Getter
@Setter
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpAuthInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpAuthInfo.java
index fa50216153..9919fd72b8 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpAuthInfo.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpTpAuthInfo.java
@@ -216,7 +216,7 @@ public static class Agent implements Serializable {
/**
* 付费状态
- *
+ *
*
*
+ *
*
*
* 请使用.
- * {@link LinkedCorpMsgType#TEXT}
- * {@link LinkedCorpMsgType#IMAGE}
- * {@link LinkedCorpMsgType#VIDEO}
- * {@link LinkedCorpMsgType#NEWS}
- * {@link LinkedCorpMsgType#MPNEWS}
- * {@link LinkedCorpMsgType#MARKDOWN}
- * {@link LinkedCorpMsgType#MINIPROGRAM_NOTICE}
+ * {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#TEXT}
+ * {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#IMAGE}
+ * {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#VIDEO}
+ * {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#NEWS}
+ * {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#MPNEWS}
+ * {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#MARKDOWN}
+ * {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#MINIPROGRAM_NOTICE}
*
*
* @param msgType 消息类型
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlMessage.java
index 4001c7d0e4..08a0936317 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlMessage.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlMessage.java
@@ -68,19 +68,19 @@ public class WxCpXmlMessage implements Serializable {
/**
*
* 当接受用户消息时,可能会获得以下值:
- * {@link WxConsts.XmlMsgType#TEXT}
- * {@link WxConsts.XmlMsgType#IMAGE}
- * {@link WxConsts.XmlMsgType#VOICE}
- * {@link WxConsts.XmlMsgType#VIDEO}
- * {@link WxConsts.XmlMsgType#LOCATION}
- * {@link WxConsts.XmlMsgType#LINK}
- * {@link WxConsts.XmlMsgType#EVENT}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#TEXT}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#IMAGE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VOICE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VIDEO}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#LOCATION}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#LINK}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#EVENT}
* 当发送消息的时候使用:
- * {@link WxConsts.XmlMsgType#TEXT}
- * {@link WxConsts.XmlMsgType#IMAGE}
- * {@link WxConsts.XmlMsgType#VOICE}
- * {@link WxConsts.XmlMsgType#VIDEO}
- * {@link WxConsts.XmlMsgType#NEWS}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#TEXT}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#IMAGE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VOICE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VIDEO}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#NEWS}
*
*/
@XStreamAlias("MsgType")
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TemplateCardBuilder.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TemplateCardBuilder.java
index d3cbb89a3d..1ab92630a9 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TemplateCardBuilder.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TemplateCardBuilder.java
@@ -12,7 +12,8 @@
* 用法: WxCustomMessage m = WxCustomMessage.TEMPLATECARD().title(...)....toUser(...).build();
*
*
- * @author yzts a> created on 2019-05-16
+ * @author yzts
+ * @since 2019-05-16
*/
public class TemplateCardBuilder extends BaseBuilder
+ *
* 取值范围:-604800 ~ 86399
*/
@SerializedName("remind_time_diffs")
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/meetingroom/WxCpOaMeetingRoomBookResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/meetingroom/WxCpOaMeetingRoomBookResult.java
index 16cf32fa5c..4f74bab79c 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/meetingroom/WxCpOaMeetingRoomBookResult.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/meetingroom/WxCpOaMeetingRoomBookResult.java
@@ -39,7 +39,7 @@ public static WxCpOaMeetingRoomBookResult fromJson(String json) {
private String schedule_id;
/**
* 通过会议预定会议室 和 通过日程预定会议室 接口返回
- *
+ *
* 会议室冲突日期列表,为当天0点的时间戳;使用重复会议预定会议室,部分日期与会议室预定情况冲突时返回
*/
@SerializedName("conflict_date")
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTips.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTips.java
index 58daeb007c..eada2ad100 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTips.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTips.java
@@ -8,7 +8,7 @@
/**
* @author mrsiu@msn.com
* @version 1.0
- * @date 2025/1/16 09:40
+ * @since 2025/1/16 09:40
*/
@Data
public class TemplateTips {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsContent.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsContent.java
index 939e6819a0..0af8be8be5 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsContent.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsContent.java
@@ -5,7 +5,7 @@
/**
* @author mrsiu@msn.com
* @version 1.0
- * @date 2025/1/16 09:42
+ * @since 2025/1/16 09:42
*/
@Data
public class TemplateTipsContent {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubText.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubText.java
index ac4681038c..78e88562e8 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubText.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubText.java
@@ -5,7 +5,7 @@
/**
* @author mrsiu@msn.com
* @version 1.0
- * @date 2025/1/16 09:45
+ * @since 2025/1/16 09:45
*/
@Data
public class TemplateTipsSubText {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContent.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContent.java
index 9c99b2688e..f33c31d054 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContent.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContent.java
@@ -6,7 +6,7 @@
/**
* @author mrsiu@msn.com
* @version 1.0
- * @date 2025/1/16 09:46
+ * @since 2025/1/16 09:46
*/
@Data
public class TemplateTipsSubTextContent {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContentLink.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContentLink.java
index 4cd198409a..fd4db2c18f 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContentLink.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContentLink.java
@@ -5,7 +5,7 @@
/**
* @author mrsiu@msn.com
* @version 1.0
- * @date 2025/1/16 09:49
+ * @since 2025/1/16 09:49
*/
@Data
public class TemplateTipsSubTextContentLink {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContentPlainText.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContentPlainText.java
index 12969cdcdb..0a2e792edb 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContentPlainText.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContentPlainText.java
@@ -3,9 +3,9 @@
import lombok.Data;
/**
- * @author mrsiu@msn.com
- * @date 2025/1/16 09:47
- * @version 1.0
+ * @author mrsiu@msn.com
+ * @version 1.0
+ * @since 2025/1/16 09:47
*/
@Data
public class TemplateTipsSubTextContentPlainText {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsText.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsText.java
index 100c5bb137..c9dbe68abf 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsText.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsText.java
@@ -6,9 +6,9 @@
import java.util.List;
/**
- * @author mrsiu@msn.com
- * @date 2025/1/16 09:43
- * @version 1.0
+ * @author mrsiu@msn.com
+ * @version 1.0
+ * @since 2025/1/16 09:43
*/
@Data
public class TemplateTipsText {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpCorpGroupConfigStorage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpCorpGroupConfigStorage.java
index 07acb189a8..df758ac3a2 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpCorpGroupConfigStorage.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpCorpGroupConfigStorage.java
@@ -31,8 +31,8 @@ public interface WxCpCorpGroupConfigStorage {
/**
* Update corp access token.
*
- * @param corpId
- * @param agentId
+ * @param corpId 企业ID
+ * @param agentId 应用ID
* @param corpAccessToken the corp access token
* @param expiresInSeconds the expires in seconds
*/
@@ -41,8 +41,8 @@ public interface WxCpCorpGroupConfigStorage {
/**
* 授权企业的access token相关
*
- * @param corpId the corp id
- * @param agentId
+ * @param corpId 企业ID
+ * @param agentId 应用ID
* @return the access token
*/
String getCorpAccessToken(String corpId, Integer agentId);
@@ -50,8 +50,8 @@ public interface WxCpCorpGroupConfigStorage {
/**
* Gets access token entity.
*
- * @param corpId the corp id
- * @param agentId
+ * @param corpId 企业ID
+ * @param agentId 应用ID
* @return the access token entity
*/
WxAccessToken getCorpAccessTokenEntity(String corpId, Integer agentId);
@@ -59,8 +59,8 @@ public interface WxCpCorpGroupConfigStorage {
/**
* Is access token expired boolean.
*
- * @param corpId the corp id
- * @param agentId
+ * @param corpId 企业ID
+ * @param agentId 应用ID
* @return the boolean
*/
boolean isCorpAccessTokenExpired(String corpId, Integer agentId);
@@ -68,8 +68,8 @@ public interface WxCpCorpGroupConfigStorage {
/**
* Expire access token.
*
- * @param corpId the corp id
- * @param agentId
+ * @param corpId 企业ID
+ * @param agentId 应用ID
*/
void expireCorpAccessToken(String corpId, Integer agentId);
@@ -118,7 +118,8 @@ public interface WxCpCorpGroupConfigStorage {
/**
* Gets access token lock.
*
- * @param corpId the corp id
+ * @param corpId 企业ID
+ * @param agentId 应用ID
* @return the access token lock
*/
Lock getCorpAccessTokenLock(String corpId, Integer agentId);
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpTpConfigStorage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpTpConfigStorage.java
index 2cd37821b5..0a2ed0e76a 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpTpConfigStorage.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpTpConfigStorage.java
@@ -133,7 +133,7 @@ public interface WxCpTpConfigStorage {
String getEncodingAESKey();
/**
- * 企微服务商企业ID & 企业secret
+ * {@code 企微服务商企业ID & 企业secret}
*
* @return the corp id
*/
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/AbstractWxCpTpInRedisConfigImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/AbstractWxCpTpInRedisConfigImpl.java
index 08eed33c16..6d1260fe68 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/AbstractWxCpTpInRedisConfigImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/AbstractWxCpTpInRedisConfigImpl.java
@@ -187,7 +187,9 @@ public String getEncodingAESKey() {
/**
- * 企微服务商企业ID & 企业secret, 来自于企微配置
+ * {@code 企微服务商企业ID & 企业secret, 来自于企微配置}
+ *
+ * @return 企业ID
*/
@Override
public String getCorpId() {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpTpDefaultConfigImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpTpDefaultConfigImpl.java
index fc124251f5..7fbbc9ccce 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpTpDefaultConfigImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpTpDefaultConfigImpl.java
@@ -29,7 +29,7 @@ public class WxCpTpDefaultConfigImpl implements WxCpTpConfigStorage, Serializabl
private final transient Map
- * 获取审批申请详情
+ * 获取审批申请详情
*
* @param spNo 审批单编号。
* @param corpId the corp id
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpOrderService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpOrderService.java
index 3aff90bb56..6e0acb7dee 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpOrderService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpOrderService.java
@@ -18,7 +18,7 @@ public interface WxCpTpOrderService {
* 获取订单详情
*
* 文档地址
- *
+ *
*
* @param orderId 订单号
* @return the order
@@ -31,7 +31,7 @@ public interface WxCpTpOrderService {
* 获取订单列表
*
* 文档地址
- *
+ *
*
* @param startTime 起始时间
* @param endTime 终止时间
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpService.java
index b24be535da..93855d1a48 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpService.java
@@ -199,7 +199,7 @@ public interface WxCpTpService {
* @return permanent code info
* @throws WxErrorException the wx error exception
* @author yuan
- * @since 2020 -03-18
+ * @since 2020-03-18
*/
WxCpTpPermanentCodeInfo getPermanentCodeInfo(String authCode) throws WxErrorException;
@@ -227,7 +227,7 @@ public interface WxCpTpService {
* @param authType 授权类型:0 正式授权, 1 测试授权。
* @return pre auth url
* @throws WxErrorException the wx error exception
- * @link https ://work.weixin.qq.com/api/doc/90001/90143/90602
+ * @see 文档地址
*/
String getPreAuthUrl(String redirectUri, String state, int authType) throws WxErrorException;
@@ -558,12 +558,12 @@ WxCpTpXmlMessage fromEncryptedXml(String encryptedXml,
WxCpTpAppQrcode getAppQrcode(String suiteId, String appId, String state, Integer style, Integer resultType) throws WxErrorException ;
/**
- *
* 明文corpid转换为加密corpid 为更好地保护企业与用户的数据,第三方应用获取的corpid不再是明文的corpid,将升级为第三方服务商级别的加密corpid。文档说明
* 第三方可以将已有的明文corpid转换为第三方的加密corpid。
- * @param corpId
- * @return
- * @throws WxErrorException
+ *
+ * @param corpId 企业ID
+ * @return 加密的企业ID
+ * @throws WxErrorException 微信错误异常
*/
WxCpTpCorpId2OpenCorpId corpId2OpenCorpId(String corpId) throws WxErrorException;
@@ -655,6 +655,8 @@ WxCpTpXmlMessage fromEncryptedXml(String encryptedXml,
/**
* 构造第三方应用oauth2链接
+ *
+ * @return OAuth2服务
*/
WxCpTpOAuth2Service getWxCpTpOAuth2Service();
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpTagService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpTagService.java
index b508df59a1..df60041865 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpTagService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpTagService.java
@@ -13,7 +13,7 @@
*
*
* @author zhangq * 文档地址 - *
+ * ** 文档地址 - *
+ * * * @param orderId 订单号 * @return the order @@ -49,7 +49,7 @@ public WxCpTpOrderDetails getOrder(String orderId) throws WxErrorException { * 获取订单列表 ** 文档地址 - *
+ * * * @param startTime 起始时间 * @param endTime 终止时间 diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/WxCpTpTagServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/WxCpTpTagServiceImpl.java index b81760e72c..1b03f18c79 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/WxCpTpTagServiceImpl.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/WxCpTpTagServiceImpl.java @@ -25,7 +25,7 @@ * * * @author zhangq
* 创建卡券
- *
*
- * @param cardCreateRequest 卡券创建请求对象
+ * @param cardCreateMessage 卡券创建请求对象
* @return 卡券创建结果对象
* @throws WxErrorException 微信API调用异常,可能包括:
*
* 获取图文群发总数据(getarticletotal)
- * 详情请见文档:图文分析数据接口
+ *
+ * {@code 详情请见文档:图文分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getarticletotal?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度1天,endDate不能早于begingDate
@@ -73,10 +76,13 @@ public interface WxMpDataCubeService {
List getArticleTotal(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取图文统计数据(getuserread)
- * 详情请见文档:图文分析数据接口
+ *
+ * {@code 详情请见文档:图文分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getuserread?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度3天,endDate不能早于begingDate
@@ -86,10 +92,13 @@ public interface WxMpDataCubeService {
List getUserRead(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取图文统计分时数据(getuserreadhour)
- * 详情请见文档:图文分析数据接口
+ *
+ * {@code 详情请见文档:图文分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getuserreadhour?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度1天,endDate不能早于begingDate
@@ -99,10 +108,13 @@ public interface WxMpDataCubeService {
List getUserReadHour(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取图文分享转发数据(getusershare)
- * 详情请见文档:图文分析数据接口
+ *
+ * {@code 详情请见文档:图文分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getusershare?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度7天,endDate不能早于begingDate
@@ -112,10 +124,13 @@ public interface WxMpDataCubeService {
List getUserShare(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取图文分享转发分时数据(getusersharehour)
- * 详情请见文档:图文分析数据接口
+ *
+ * {@code 详情请见文档:图文分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getusersharehour?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度1天,endDate不能早于begingDate
@@ -127,10 +142,13 @@ public interface WxMpDataCubeService {
//*******************消息分析数据接口***********************//
/**
- *
* 获取消息发送概况数据(getupstreammsg)
- * 详情请见文档:消息分析数据接口
+ *
+ * {@code 详情请见文档:消息分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getupstreammsg?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度7天,endDate不能早于begingDate
@@ -140,10 +158,13 @@ public interface WxMpDataCubeService {
List getUpstreamMsg(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取消息分送分时数据(getupstreammsghour)
- * 详情请见文档:消息分析数据接口
+ *
+ * {@code 详情请见文档:消息分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getupstreammsghour?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度1天,endDate不能早于begingDate
@@ -153,10 +174,13 @@ public interface WxMpDataCubeService {
List getUpstreamMsgHour(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取消息发送周数据(getupstreammsgweek)
- * 详情请见文档:消息分析数据接口
+ *
+ * {@code 详情请见文档:消息分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getupstreammsgweek?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度30天,endDate不能早于begingDate
@@ -166,10 +190,13 @@ public interface WxMpDataCubeService {
List getUpstreamMsgWeek(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取消息发送月数据(getupstreammsgmonth)
- * 详情请见文档:消息分析数据接口
+ *
+ * {@code 详情请见文档:消息分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getupstreammsgmonth?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度30天,endDate不能早于begingDate
@@ -179,10 +206,13 @@ public interface WxMpDataCubeService {
List getUpstreamMsgMonth(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取消息发送分布数据(getupstreammsgdist)
- * 详情请见文档:消息分析数据接口
+ *
+ * {@code 详情请见文档:消息分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getupstreammsgdist?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度15天,endDate不能早于begingDate
@@ -192,10 +222,13 @@ public interface WxMpDataCubeService {
List getUpstreamMsgDist(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取消息发送分布周数据(getupstreammsgdistweek)
- * 详情请见文档:消息分析数据接口
+ *
+ * {@code 详情请见文档:消息分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getupstreammsgdistweek?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度30天,endDate不能早于begingDate
@@ -205,10 +238,13 @@ public interface WxMpDataCubeService {
List getUpstreamMsgDistWeek(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取消息发送分布月数据(getupstreammsgdistmonth)
- * 详情请见文档:消息分析数据接口
+ *
+ * {@code 详情请见文档:消息分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getupstreammsgdistmonth?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度30天,endDate不能早于begingDate
@@ -220,10 +256,13 @@ public interface WxMpDataCubeService {
//*******************接口分析数据接口***********************//
/**
- *
* 获取接口分析数据(getinterfacesummary)
- * 详情请见文档:接口分析数据接口
+ *
+ * {@code 详情请见文档:接口分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getinterfacesummary?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度30天,endDate不能早于begingDate
@@ -233,10 +272,13 @@ public interface WxMpDataCubeService {
List getInterfaceSummary(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取接口分析分时数据(getinterfacesummaryhour)
- * 详情请见文档:接口分析数据接口
+ *
+ * {@code 详情请见文档:接口分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getinterfacesummaryhour?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度1天,endDate不能早于begingDate
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpService.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpService.java
index 468dced138..2d965bf8de 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpService.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpService.java
@@ -54,10 +54,10 @@ public interface WxMpService extends WxService {
WxMpShortKeyResult fetchShorten(String shortKey) throws WxErrorException;
/**
- *
* 验证消息的确来自微信服务器.
- * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421135319&token=&lang=zh_CN
- *
+ *
+ * {@code 详情请见: 接入指南}
+ *
*
* @param timestamp 时间戳,字符串格式
* @param nonce 随机串,字符串格式
@@ -76,16 +76,19 @@ public interface WxMpService extends WxService {
String getAccessToken() throws WxErrorException;
/**
- *
* 获取access_token,本方法线程安全.
+ *
* 且在多线程同时刷新时只刷新一次,避免超出2000次/日的调用次数上限
- *
+ *
+ *
* 另:本service的所有方法都会在access_token过期时调用此方法
- *
+ *
+ *
* 程序员在非必要情况下尽量不要主动调用此方法
- *
- * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140183&token=&lang=zh_CN
- *
+ *
+ *
+ * {@code 详情请见: 获取access_token}
+ *
*
* @param forceRefresh 是否强制刷新,true表示强制刷新,false表示使用缓存
* @return token access token,字符串格式
@@ -126,12 +129,13 @@ public interface WxMpService extends WxService {
String getJsapiTicket() throws WxErrorException;
/**
- *
* 获得jsapi_ticket.
+ *
* 获得时会检查jsapiToken是否过期,如果过期了,那么就刷新一下,否则就什么都不干
- *
- * 详情请见:http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115&token=&lang=zh_CN
- *
+ *
+ *
+ * {@code 详情请见:JS-SDK使用权限签名算法}
+ *
*
* @param forceRefresh 强制刷新,true表示强制刷新,false表示使用缓存
* @return jsapi ticket,字符串格式
@@ -140,11 +144,10 @@ public interface WxMpService extends WxService {
String getJsapiTicket(boolean forceRefresh) throws WxErrorException;
/**
- *
* 创建调用jsapi时所需要的签名.
- *
- * 详情请见:http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115&token=&lang=zh_CN
- *
+ *
+ * {@code 详情请见:JS-SDK使用权限签名算法}
+ *
*
* @param url 当前网页的URL,不包括#及其后面部分
* @return 生成的签名对象,包含签名、时间戳、随机串等信息
@@ -153,10 +156,10 @@ public interface WxMpService extends WxService {
WxJsapiSignature createJsapiSignature(String url) throws WxErrorException;
/**
- *
* 长链接转短链接接口.
- * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=长链接转短链接接口
- *
+ *
+ * 详情请见: 长链接转短链接接口
+ *
*
* @param longUrl 长url,需要转换的原始URL
* @return 生成的短地址,字符串格式
@@ -167,10 +170,10 @@ public interface WxMpService extends WxService {
String shortUrl(String longUrl) throws WxErrorException;
/**
- *
* 语义查询接口.
- * 详情请见:http://mp.weixin.qq.com/wiki/index.php?title=语义理解
- *
+ *
+ * 详情请见:语义理解
+ *
*
* @param semanticQuery 查询条件,包含查询内容、类型等信息
* @return 查询结果,包含语义理解的结果和建议回复
@@ -179,11 +182,13 @@ public interface WxMpService extends WxService {
WxMpSemanticQueryResult semanticQuery(WxMpSemanticQuery semanticQuery) throws WxErrorException;
/**
- *
* 构造第三方使用网站应用授权登录的url.
- * 详情请见: 网站应用微信登录开发指南
- * URL格式为:https://open.weixin.qq.com/connect/qrconnect?appid=APPID&redirect_uri=REDIRECT_URI&response_type=code&scope=SCOPE&state=STATE#wechat_redirect
- *
+ *
+ * {@code 详情请见: 网站应用微信登录开发指南}
+ *
+ *
+ * {@code URL格式为:https://open.weixin.qq.com/connect/qrconnect?appid=APPID&redirect_uri=REDIRECT_URI&response_type=code&scope=SCOPE&state=STATE#wechat_redirect}
+ *
*
* @param redirectUri 用户授权完成后的重定向链接,无需urlencode, 方法内会进行encode
* @param scope 应用授权作用域,拥有多个作用域用逗号(,)分隔,网页应用目前仅填写snsapi_login即可
@@ -193,10 +198,7 @@ public interface WxMpService extends WxService {
String buildQrConnectUrl(String redirectUri, String scope, String state);
/**
- *
* 获取微信服务器IP地址
- * http://mp.weixin.qq.com/wiki/0/2ad4b6bfd29f30f71d39616c2a0fcedc.html
- *
*
* @return 微信服务器ip地址数组,包含所有微信服务器IP地址
* @throws WxErrorException 微信API调用异常
@@ -204,11 +206,10 @@ public interface WxMpService extends WxService {
String[] getCallbackIP() throws WxErrorException;
/**
- *
- * 网络检测
- * https://mp.weixin.qq.com/wiki?t=resource/res_main&id=21541575776DtsuT
- * 为了帮助开发者排查回调连接失败的问题,提供这个网络检测的API。它可以对开发者URL做域名解析,然后对所有IP进行一次ping操作,得到丢包率和耗时。
- *
+ * 网络检测
+ *
+ * 为了帮助开发者排查回调连接失败的问题,提供这个网络检测的API。它可以对开发者URL做域名解析,然后对所有IP进行一次ping操作,得到丢包率和耗时。
+ *
*
* @param action 执行的检测动作,可选值:all(全部检测)、dns(仅域名解析)、ping(仅网络连通性检测)
* @param operator 指定平台从某个运营商进行检测,可选值:CHINANET(中国电信)、UNICOM(中国联通)、CAP(中国联通)、CUCC(中国联通)
@@ -239,12 +240,13 @@ public interface WxMpService extends WxService {
WxMpCurrentAutoReplyInfo getCurrentAutoReplyInfo() throws WxErrorException;
/**
- *
- * 公众号调用或第三方平台帮公众号调用对公众号的所有api调用(包括第三方帮其调用)次数进行清零:
- * HTTP调用:https://api.weixin.qq.com/cgi-bin/clear_quota?access_token=ACCESS_TOKEN
- * 接口文档地址:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433744592
- *
- *
+ * 公众号调用或第三方平台帮公众号调用对公众号的所有api调用(包括第三方帮其调用)次数进行清零.
+ *
+ * HTTP调用:https://api.weixin.qq.com/cgi-bin/clear_quota?access_token=ACCESS_TOKEN
+ *
+ *
+ * {@code 接口文档地址:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433744592}
+ *
*
* @param appid 公众号的APPID,需要清零调用的公众号的appid
* @throws WxErrorException 微信API调用异常
@@ -252,11 +254,9 @@ public interface WxMpService extends WxService {
void clearQuota(String appid) throws WxErrorException;
/**
- *
* Service没有实现某个API的时候,可以用这个,
* 比{@link #get}和{@link #post}方法更灵活,可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。
* 可以参考,{@link MediaUploadRequestExecutor}的实现方法
- *
*
* @param 返回值类型
* @param 参数类型
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/BaseWxMpServiceImpl.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/BaseWxMpServiceImpl.java
index 63ca608eba..76ab466157 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/BaseWxMpServiceImpl.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/BaseWxMpServiceImpl.java
@@ -304,8 +304,9 @@ public String getAccessToken(boolean forceRefresh) throws WxErrorException {
/**
* 通过网络请求获取稳定版接口调用凭据
*
- * @return .
- * @throws IOException .
+ * @param forceRefresh 是否强制刷新
+ * @return access_token字符串
+ * @throws IOException IO异常
*/
protected abstract String doGetStableAccessTokenRequest(boolean forceRefresh) throws IOException;
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassOpenIdsMessage.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassOpenIdsMessage.java
index 80e1658c16..936996ef69 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassOpenIdsMessage.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassOpenIdsMessage.java
@@ -25,11 +25,11 @@ public class WxMpMassOpenIdsMessage implements Serializable {
/**
*
* 请使用
- * {@link WxConsts.MassMsgType#IMAGE}
- * {@link WxConsts.MassMsgType#MPNEWS}
- * {@link WxConsts.MassMsgType#TEXT}
- * {@link WxConsts.MassMsgType#MPVIDEO}
- * {@link WxConsts.MassMsgType#VOICE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#IMAGE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#MPNEWS}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#TEXT}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#MPVIDEO}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#VOICE}
* 如果msgtype和media_id不匹配的话,会返回系统繁忙的错误
*
*/
@@ -60,6 +60,8 @@ public String toJson() {
/**
* 添加openid,最多支持10,000个
+ *
+ * @param openid 用户openid
*/
public void addUser(String openid) {
this.toUsers.add(openid);
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassPreviewMessage.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassPreviewMessage.java
index dca743c9c3..57b34d352a 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassPreviewMessage.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassPreviewMessage.java
@@ -19,11 +19,11 @@ public class WxMpMassPreviewMessage implements Serializable {
*
* 消息类型
* 请使用
- * {@link WxConsts.MassMsgType#IMAGE}
- * {@link WxConsts.MassMsgType#MPNEWS}
- * {@link WxConsts.MassMsgType#TEXT}
- * {@link WxConsts.MassMsgType#MPVIDEO}
- * {@link WxConsts.MassMsgType#VOICE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#IMAGE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#MPNEWS}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#TEXT}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#MPVIDEO}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#VOICE}
* 如果msgtype和media_id不匹配的话,会返回系统繁忙的错误
*
*/
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassTagMessage.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassTagMessage.java
index 598e5754f1..466ef8d96f 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassTagMessage.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassTagMessage.java
@@ -24,11 +24,11 @@ public class WxMpMassTagMessage implements Serializable {
*
* 消息类型.
* 请使用
- * {@link WxConsts.MassMsgType#IMAGE}
- * {@link WxConsts.MassMsgType#MPNEWS}
- * {@link WxConsts.MassMsgType#TEXT}
- * {@link WxConsts.MassMsgType#MPVIDEO}
- * {@link WxConsts.MassMsgType#VOICE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#IMAGE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#MPNEWS}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#TEXT}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#MPVIDEO}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#VOICE}
* 如果msgtype和media_id不匹配的话,会返回系统繁忙的错误
*
*/
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpUserQuery.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpUserQuery.java
index 9e73b46159..ac4a596dd8 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpUserQuery.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpUserQuery.java
@@ -63,9 +63,8 @@ public WxMpUserQuery add(String openid, String lang) {
/**
* 添加一个OpenId到列表中,并返回本对象
*
- *
* 该方法默认lang = zh_CN
- *
+ *
*
* @param openid openid
* @return {@link WxMpUserQuery}
@@ -100,6 +99,8 @@ public WxMpUserQuery remove(String openid, String lang) {
/**
* 获取查询参数列表
+ *
+ * @return 查询参数列表
*/
public List getQueryParamList() {
return this.queryParamList;
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/WxMpCardMpnewsGethtmlResult.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/WxMpCardMpnewsGethtmlResult.java
index 6d7dde1ad6..34a9c56b99 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/WxMpCardMpnewsGethtmlResult.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/WxMpCardMpnewsGethtmlResult.java
@@ -8,7 +8,9 @@
/**
- * @author S
+ * 卡券图文消息HTML结果
+ *
+ * @author S (sshzh90@gmail.com)
*/
@Data
public class WxMpCardMpnewsGethtmlResult implements Serializable {
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/MemberCardActivateUserFormRequest.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/MemberCardActivateUserFormRequest.java
index d8634cfa3c..0adb413869 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/MemberCardActivateUserFormRequest.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/MemberCardActivateUserFormRequest.java
@@ -39,8 +39,8 @@ public class MemberCardActivateUserFormRequest implements Serializable {
/**
* 绑定老会员卡信息
*
- * @param name
- * @param url
+ * @param name 名称
+ * @param url 链接地址
*/
public void setBindOldCard(String name, String url) {
if (StringUtils.isAnyEmpty(name, url)) {
@@ -56,8 +56,8 @@ public void setBindOldCard(String name, String url) {
/**
* 设置服务声明,用于放置商户会员卡守则
*
- * @param name
- * @param url
+ * @param name 名称
+ * @param url 链接地址
*/
public void setServiceStatement(String name, String url) {
if (StringUtils.isAnyEmpty(name, url)) {
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/MemberCardUserForm.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/MemberCardUserForm.java
index 0c0fae3e2b..b3b0c9be5e 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/MemberCardUserForm.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/MemberCardUserForm.java
@@ -50,6 +50,7 @@ public class MemberCardUserForm implements Serializable {
/**
* 添加富文本类型字段
*
+ * @param field 富文本字段
*/
public void addRichField(MemberCardUserFormRichField field) {
if (field == null) {
@@ -64,6 +65,7 @@ public void addRichField(MemberCardUserFormRichField field) {
/**
* 添加微信选项类型字段
*
+ * @param fieldType 微信字段类型
*/
public void addWechatField(CardWechatFieldType fieldType) {
if (fieldType == null) {
@@ -78,6 +80,7 @@ public void addWechatField(CardWechatFieldType fieldType) {
/**
* 添加文本类型字段
*
+ * @param field 文本字段
*/
public void addCustomField(String field) {
if (StringUtils.isBlank(field)) {
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/NotifyOptional.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/NotifyOptional.java
index 139db68557..1ba8a0e60c 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/NotifyOptional.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/NotifyOptional.java
@@ -6,12 +6,13 @@
import java.io.Serializable;
/**
- *
* 控制原生消息结构体,包含各字段的消息控制字段。
- *
+ *
* 用于 `7 更新会员信息` 的接口参数调用
- * https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1451025283
- *
+ *
+ *
+ * {@code 参考:会员卡接口}
+ *
*
* @author YuJian(mgcnrx11@gmail.com)
* @version 2017/7/15
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/WxMpMemberCardUpdateResult.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/WxMpMemberCardUpdateResult.java
index 663fe1f1e5..b4ad8eb139 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/WxMpMemberCardUpdateResult.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/WxMpMemberCardUpdateResult.java
@@ -6,10 +6,10 @@
import me.chanjar.weixin.mp.util.json.WxMpGsonBuilder;
/**
- *
* 用于 `7 更新会员信息` 的接口调用后的返回结果
- * https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1451025283
- *
+ *
+ * {@code 参考:会员卡接口}
+ *
*
* @author YuJian(mgcnrx11@gmail.com)
* @version 2017/7/15
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/WxMpMemberCardUserInfoResult.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/WxMpMemberCardUserInfoResult.java
index 8fad40ccf8..9a2b47f5bf 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/WxMpMemberCardUserInfoResult.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/WxMpMemberCardUserInfoResult.java
@@ -6,11 +6,10 @@
import me.chanjar.weixin.mp.util.json.WxMpGsonBuilder;
/**
- *
* 拉取会员信息返回的结果
- *
- * 字段格式参考https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1451025283 6.2.1小节的步骤5
- *
+ *
+ * {@code 字段格式参考:会员卡接口 6.2.1小节的步骤5}
+ *
*
* @author YuJian
* @version 2017/7/9
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/kefu/WxMpKefuMessage.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/kefu/WxMpKefuMessage.java
index f066c1d934..01be3c08d2 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/kefu/WxMpKefuMessage.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/kefu/WxMpKefuMessage.java
@@ -45,6 +45,8 @@ public class WxMpKefuMessage implements Serializable {
/**
* 获得文本消息builder.
+ *
+ * @return 文本消息builder
*/
public static TextBuilder TEXT() {
return new TextBuilder();
@@ -52,6 +54,8 @@ public static TextBuilder TEXT() {
/**
* 获得图片消息builder.
+ *
+ * @return 图片消息builder
*/
public static ImageBuilder IMAGE() {
return new ImageBuilder();
@@ -59,6 +63,8 @@ public static ImageBuilder IMAGE() {
/**
* 获得语音消息builder.
+ *
+ * @return 语音消息builder
*/
public static VoiceBuilder VOICE() {
return new VoiceBuilder();
@@ -66,6 +72,8 @@ public static VoiceBuilder VOICE() {
/**
* 获得视频消息builder.
+ *
+ * @return 视频消息builder
*/
public static VideoBuilder VIDEO() {
return new VideoBuilder();
@@ -73,6 +81,8 @@ public static VideoBuilder VIDEO() {
/**
* 获得音乐消息builder.
+ *
+ * @return 音乐消息builder
*/
public static MusicBuilder MUSIC() {
return new MusicBuilder();
@@ -80,6 +90,8 @@ public static MusicBuilder MUSIC() {
/**
* 获得图文消息(点击跳转到外链)builder.
+ *
+ * @return 图文消息builder
*/
public static NewsBuilder NEWS() {
return new NewsBuilder();
@@ -87,6 +99,8 @@ public static NewsBuilder NEWS() {
/**
* 获得图文消息(点击跳转到图文消息页面)builder.
+ *
+ * @return 图文消息builder
*/
public static MpNewsBuilder MPNEWS() {
return new MpNewsBuilder();
@@ -94,6 +108,8 @@ public static MpNewsBuilder MPNEWS() {
/**
* 获得卡券消息builder.
+ *
+ * @return 卡券消息builder
*/
public static WxCardBuilder WXCARD() {
return new WxCardBuilder();
@@ -101,6 +117,8 @@ public static WxCardBuilder WXCARD() {
/**
* 获得菜单消息builder.
+ *
+ * @return 菜单消息builder
*/
public static WxMsgMenuBuilder MSGMENU() {
return new WxMsgMenuBuilder();
@@ -108,20 +126,25 @@ public static WxMsgMenuBuilder MSGMENU() {
/**
* 小程序卡片.
+ *
+ * @return 小程序卡片builder
*/
public static MiniProgramPageBuilder MINIPROGRAMPAGE() {
return new MiniProgramPageBuilder();
}
/**
- * 发送图文消息(点击跳转到图文消息页面)使用通过 “发布” 系列接口得到的 article_id(草稿箱功能上线后不再支持客服接口中带 media_id 的 mpnews 类型的图文消息)
+ * 发送图文消息(点击跳转到图文消息页面)使用通过 “发布” 系列接口得到的 article_id
+ *
+ * @return 图文消息builder
*/
public static MpNewsArticleBuilder MPNEWSARTICLE() {
return new MpNewsArticleBuilder();
}
/**
- *
+ * 设置消息类型
+ *
* 请使用
* {@link me.chanjar.weixin.common.api.WxConsts.KefuMsgType#TEXT}
* {@link me.chanjar.weixin.common.api.WxConsts.KefuMsgType#IMAGE}
@@ -135,7 +158,9 @@ public static MpNewsArticleBuilder MPNEWSARTICLE() {
* {@link me.chanjar.weixin.common.api.WxConsts.KefuMsgType#TASKCARD}
* {@link me.chanjar.weixin.common.api.WxConsts.KefuMsgType#MSGMENU}
* {@link me.chanjar.weixin.common.api.WxConsts.KefuMsgType#MP_NEWS_ARTICLE}
- *
+ *
+ *
+ * @param msgType 消息类型
*/
public void setMsgType(String msgType) {
this.msgType = msgType;
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/message/WxMpXmlMessage.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/message/WxMpXmlMessage.java
index 3d5f4ac3a0..dfc88ab13b 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/message/WxMpXmlMessage.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/message/WxMpXmlMessage.java
@@ -927,6 +927,7 @@ public static WxMpXmlMessage fromXml(InputStream is) {
* @param timestamp 时间戳
* @param nonce 随机串
* @param msgSignature 签名串
+ * @return 解密后的消息对象
*/
public static WxMpXmlMessage fromEncryptedXml(String encryptedXml, WxMpConfigStorage wxMpConfigStorage,
String timestamp, String nonce, String msgSignature) {
@@ -956,14 +957,16 @@ public WxMpXmlMessage decryptField(WxMpConfigStorage wxMpConfigStorage,
/**
*
* 当接受用户消息时,可能会获得以下值:
- * {@link WxConsts.XmlMsgType#TEXT}
- * {@link WxConsts.XmlMsgType#IMAGE}
- * {@link WxConsts.XmlMsgType#VOICE}
- * {@link WxConsts.XmlMsgType#VIDEO}
- * {@link WxConsts.XmlMsgType#LOCATION}
- * {@link WxConsts.XmlMsgType#LINK}
- * {@link WxConsts.XmlMsgType#EVENT}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#TEXT}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#IMAGE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VOICE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VIDEO}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#LOCATION}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#LINK}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#EVENT}
*
+ *
+ * @return 消息类型
*/
public String getMsgType() {
return this.msgType;
@@ -972,13 +975,15 @@ public String getMsgType() {
/**
*
* 当发送消息的时候使用:
- * {@link WxConsts.XmlMsgType#TEXT}
- * {@link WxConsts.XmlMsgType#IMAGE}
- * {@link WxConsts.XmlMsgType#VOICE}
- * {@link WxConsts.XmlMsgType#VIDEO}
- * {@link WxConsts.XmlMsgType#NEWS}
- * {@link WxConsts.XmlMsgType#MUSIC}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#TEXT}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#IMAGE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VOICE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VIDEO}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#NEWS}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#MUSIC}
*
+ *
+ * @param msgType 消息类型
*/
public void setMsgType(String msgType) {
this.msgType = msgType;
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/message/WxMpXmlOutMessage.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/message/WxMpXmlOutMessage.java
index a44aea740c..1f3143df7e 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/message/WxMpXmlOutMessage.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/message/WxMpXmlOutMessage.java
@@ -70,6 +70,8 @@ public abstract class WxMpXmlOutMessage implements Serializable {
/**
* 获得文本消息builder
+ *
+ * @return 文本消息构建器
*/
public static TextBuilder TEXT() {
return new TextBuilder();
@@ -77,6 +79,8 @@ public static TextBuilder TEXT() {
/**
* 获得图片消息builder
+ *
+ * @return 图片消息构建器
*/
public static ImageBuilder IMAGE() {
return new ImageBuilder();
@@ -84,6 +88,8 @@ public static ImageBuilder IMAGE() {
/**
* 获得语音消息builder
+ *
+ * @return 语音消息构建器
*/
public static VoiceBuilder VOICE() {
return new VoiceBuilder();
@@ -91,6 +97,8 @@ public static VoiceBuilder VOICE() {
/**
* 获得视频消息builder
+ *
+ * @return 视频消息构建器
*/
public static VideoBuilder VIDEO() {
return new VideoBuilder();
@@ -98,6 +106,8 @@ public static VideoBuilder VIDEO() {
/**
* 获得音乐消息builder
+ *
+ * @return 音乐消息构建器
*/
public static MusicBuilder MUSIC() {
return new MusicBuilder();
@@ -105,6 +115,8 @@ public static MusicBuilder MUSIC() {
/**
* 获得图文消息builder
+ *
+ * @return 图文消息构建器
*/
public static NewsBuilder NEWS() {
return new NewsBuilder();
@@ -112,6 +124,8 @@ public static NewsBuilder NEWS() {
/**
* 获得客服消息builder
+ *
+ * @return 客服消息构建器
*/
public static TransferCustomerServiceBuilder TRANSFER_CUSTOMER_SERVICE() {
return new TransferCustomerServiceBuilder();
@@ -119,11 +133,18 @@ public static TransferCustomerServiceBuilder TRANSFER_CUSTOMER_SERVICE() {
/**
* 获得设备消息builder
+ *
+ * @return 设备消息builder
*/
public static DeviceBuilder DEVICE() {
return new DeviceBuilder();
}
+ /**
+ * 转换成xml格式
+ *
+ * @return xml格式字符串
+ */
@SuppressWarnings("unchecked")
public String toXml() {
return XStreamTransformer.toXml((Class) this.getClass(), this);
@@ -131,6 +152,9 @@ public String toXml() {
/**
* 转换成加密的结果
+ *
+ * @param wxMpConfigStorage 公众号配置
+ * @return 加密后的消息对象
*/
public WxMpXmlOutMessage toEncrypted(WxMpConfigStorage wxMpConfigStorage) {
String plainXml = toXml();
@@ -146,6 +170,9 @@ public WxMpXmlOutMessage toEncrypted(WxMpConfigStorage wxMpConfigStorage) {
/**
* 转换成加密的xml格式
+ *
+ * @param wxMpConfigStorage 公众号配置
+ * @return 加密后的xml格式字符串
*/
public String toEncryptedXml(WxMpConfigStorage wxMpConfigStorage) {
String plainXml = toXml();
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/result/WxMpMassGetResult.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/result/WxMpMassGetResult.java
index fe8f6e4043..58f2ea2693 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/result/WxMpMassGetResult.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/result/WxMpMassGetResult.java
@@ -9,7 +9,8 @@
/**
*
* 查询群发消息发送状态【订阅号与服务号认证后均可用】
- * https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Batch_Sends_and_Originality_Checks.html#%E6%9F%A5%E8%AF%A2%E7%BE%A4%E5%8F%91%E6%B6%88%E6%81%AF%E5%8F%91%E9%80%81%E7%8A%B6%E6%80%81%E3%80%90%E8%AE%A2%E9%98%85%E5%8F%B7%E4%B8%8E%E6%9C%8D%E5%8A%A1%E5%8F%B7%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9D%87%E5%8F%AF%E7%94%A8%E3%80%91
+ * 文档地址:https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Batch_Sends_and_Originality_Checks.html
+ *
* @author S
*/
@Data
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/WxMpConfigStorage.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/WxMpConfigStorage.java
index 11aeef6124..1bebe86885 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/WxMpConfigStorage.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/WxMpConfigStorage.java
@@ -24,7 +24,7 @@ public interface WxMpConfigStorage {
* Is use stable access token api
*
* @return the boolean
- * @link https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/getStableAccessToken.html
+ * @see 文档
*/
boolean isStableAccessToken();
@@ -211,6 +211,8 @@ public interface WxMpConfigStorage {
*
* {@link me.chanjar.weixin.mp.api.impl.BaseWxMpServiceImpl#setRetrySleepMillis(int)}
*
+ *
+ * @return 重试间隔毫秒数
*/
int getRetrySleepMillis();
@@ -219,6 +221,8 @@ public interface WxMpConfigStorage {
*
* {@link me.chanjar.weixin.mp.api.impl.BaseWxMpServiceImpl#setMaxRetryTimes(int)}
*
+ *
+ * @return 最大重试次数
*/
int getMaxRetryTimes();
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/impl/WxMpRedisConfigImpl.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/impl/WxMpRedisConfigImpl.java
index 870fa1e276..7939d57a18 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/impl/WxMpRedisConfigImpl.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/impl/WxMpRedisConfigImpl.java
@@ -39,6 +39,8 @@ public WxMpRedisConfigImpl(WxRedisOps redisOps, String keyPrefix) {
/**
* 每个公众号生成独有的存储key.
+ *
+ * @param appId 公众号appId
*/
@Override
public void setAppId(String appId) {
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/impl/WxMpRedissonConfigImpl.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/impl/WxMpRedissonConfigImpl.java
index e0d9e92af1..4982336f8a 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/impl/WxMpRedissonConfigImpl.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/impl/WxMpRedissonConfigImpl.java
@@ -42,6 +42,8 @@ private WxMpRedissonConfigImpl(@NonNull WxRedisOps redisOps, String keyPrefix) {
/**
* 每个公众号生成独有的存储key.
+ *
+ * @param appId 公众号appId
*/
@Override
public void setAppId(String appId) {
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/constant/WxMpEventConstants.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/constant/WxMpEventConstants.java
index b2e984b0f9..4dfee6295e 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/constant/WxMpEventConstants.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/constant/WxMpEventConstants.java
@@ -20,7 +20,7 @@ public class WxMpEventConstants {
public static final String SUBMIT_MEMBERCARD_USER_INFO = "submit_membercard_user_info";
/**
- * 微信摇一摇周边>>摇一摇事件通知.
+ * 微信摇一摇周边-摇一摇事件通知.
*/
public static final String SHAKEAROUND_USER_SHAKE = "ShakearoundUserShake";
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/crypto/WxMpCryptUtil.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/crypto/WxMpCryptUtil.java
index 99d759f32f..7757ad78bf 100755
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/crypto/WxMpCryptUtil.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/crypto/WxMpCryptUtil.java
@@ -27,7 +27,7 @@ public class WxMpCryptUtil extends me.chanjar.weixin.common.util.crypto.WxCryptU
/**
* 构造函数
*
- * @param wxMpConfigStorage
+ * @param wxMpConfigStorage 公众号配置存储
*/
public WxMpCryptUtil(WxMpConfigStorage wxMpConfigStorage) {
/*
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/xml/XStreamTransformer.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/xml/XStreamTransformer.java
index ace711a236..55e92700de 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/xml/XStreamTransformer.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/xml/XStreamTransformer.java
@@ -33,7 +33,12 @@ public class XStreamTransformer {
}
/**
- * xml -> pojo.
+ * {@code xml -> pojo.}
+ *
+ * @param 返回类型
+ * @param clazz 类型
+ * @param xml xml字符串
+ * @return 转换后的对象
*/
@SuppressWarnings("unchecked")
public static T fromXml(Class clazz, String xml) {
@@ -41,6 +46,14 @@ public static T fromXml(Class clazz, String xml) {
return object;
}
+ /**
+ * {@code xml -> pojo.}
+ *
+ * @param 返回类型
+ * @param clazz 类型
+ * @param is 输入流
+ * @return 转换后的对象
+ */
@SuppressWarnings("unchecked")
public static T fromXml(Class clazz, InputStream is) {
T object = (T) CLASS_2_XSTREAM_INSTANCE.get(clazz).fromXML(is);
@@ -48,7 +61,12 @@ public static T fromXml(Class clazz, InputStream is) {
}
/**
- * pojo -> xml.
+ * {@code pojo -> xml.}
+ *
+ * @param 类型参数
+ * @param clazz 类型
+ * @param object 对象
+ * @return xml字符串
*/
public static String toXml(Class clazz, T object) {
return CLASS_2_XSTREAM_INSTANCE.get(clazz).toXML(object);
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/MiPayNotifyV3Result.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/MiPayNotifyV3Result.java
index a0641379fb..346d427fc4 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/MiPayNotifyV3Result.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/MiPayNotifyV3Result.java
@@ -13,7 +13,7 @@
*
*
* @author xgl
- * @date 2025/12/20
+ * @since 2025/12/20
*/
@Data
@NoArgsConstructor
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayBaseNotifyV3Result.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayBaseNotifyV3Result.java
index 86915d0956..364c9080d8 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayBaseNotifyV3Result.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayBaseNotifyV3Result.java
@@ -5,7 +5,8 @@
*
* @author Pursuer
* @version 1.0
- * @date 2023/6/15
+ * @since 2023/6/15
+ * @param 解密后的数据类型
*/
public interface WxPayBaseNotifyV3Result {
/**
@@ -13,9 +14,8 @@ public interface WxPayBaseNotifyV3Result {
*
* @param rawData 原始数据
* @author Pursuer
- * @date 2023/6/15
- * @since 1.0
- **/
+ * @since 2023/6/15
+ */
void setRawData(OriginNotifyResponse rawData);
/**
@@ -23,8 +23,7 @@ public interface WxPayBaseNotifyV3Result {
*
* @param data 解密后的数据
* @author Pursuer
- * @date 2023/6/15
- * @since 1.0
- **/
+ * @since 2023/6/15
+ */
void setResult(T data);
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayNotifyV3Response.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayNotifyV3Response.java
index b9d7f4d9f6..eac5f7c9de 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayNotifyV3Response.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayNotifyV3Response.java
@@ -28,8 +28,8 @@ public class WxPayNotifyV3Response {
/**
* 返回成功
*
- * @param msg
- * @return
+ * @param msg 返回消息
+ * @return 成功响应的JSON字符串
*/
public static String success(String msg) {
WxPayNotifyV3Response response = new WxPayNotifyV3Response(SUCCESS, msg);
@@ -40,7 +40,7 @@ public static String success(String msg) {
* 返回失败
*
* @param msg 返回信息,如非空,为错误原因
- * @return
+ * @return 失败响应的JSON字符串
*/
public static String fail(String msg) {
WxPayNotifyV3Response response = new WxPayNotifyV3Response(FAIL, msg);
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/config/WxPayConfig.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/config/WxPayConfig.java
index a3a9dc7a92..b42451a666 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/config/WxPayConfig.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/config/WxPayConfig.java
@@ -325,7 +325,8 @@ public SSLContext initSSLContext() throws WxPayException {
*
* @return org.apache.http.impl.client.CloseableHttpClient
* @author doger.wang
- **/
+ * @throws WxPayException 微信支付异常
+ */
public CloseableHttpClient initApiV3HttpClient() throws WxPayException {
if (StringUtils.isBlank(this.getApiV3Key())) {
throw new WxPayException("请确保apiV3Key值已设置");
@@ -663,6 +664,8 @@ public CloseableHttpClient initSslHttpClient() throws WxPayException {
/**
* 配置HTTP代理
+ *
+ * @param httpClientBuilder HttpClient构建器
*/
private void configureProxy(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder) {
if (StringUtils.isNotBlank(this.getHttpProxyHost()) && this.getHttpProxyPort() > 0) {
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/util/RequestUtils.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/util/RequestUtils.java
index b641cbe537..c4ad966415 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/util/RequestUtils.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/util/RequestUtils.java
@@ -17,7 +17,7 @@ public class RequestUtils {
/**
* 获取请求头数据,微信V3版本回调使用
*
- * @param request
+ * @param request HTTP请求对象
* @return 字符串
*/
public static String readData(HttpServletRequest request) {
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/util/ResourcesUtils.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/util/ResourcesUtils.java
index ac68b00bb4..51dd8fbbb6 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/util/ResourcesUtils.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/util/ResourcesUtils.java
@@ -23,6 +23,10 @@ public class ResourcesUtils {
* - {@link Class#getClassLoader() ClassLoaderUtil.class.getClassLoader()}
* - if
callingClass is provided: {@link Class#getClassLoader() callingClass.getClassLoader()}
* - * 默认接口实现类,使用apache httpclient实现 + * 默认接口实现类,使用apache httpClient 5实现 * Created by Binary Wang on 2017-5-27. ** * @author Binary Wang */ -public class WxMpServiceImpl extends WxMpServiceHttpClientImpl { +public class WxMpServiceImpl extends WxMpServiceHttpComponentsImpl { } diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenServiceHttpComponentsImpl.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenServiceHttpComponentsImpl.java new file mode 100644 index 0000000000..913c1971cb --- /dev/null +++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenServiceHttpComponentsImpl.java @@ -0,0 +1,74 @@ +package me.chanjar.weixin.open.api.impl; + +import me.chanjar.weixin.common.bean.result.WxMinishopImageUploadResult; +import me.chanjar.weixin.common.error.WxErrorException; +import me.chanjar.weixin.common.util.http.HttpClientType; +import me.chanjar.weixin.common.util.http.MinishopUploadRequestExecutor; +import me.chanjar.weixin.common.util.http.SimpleGetRequestExecutor; +import me.chanjar.weixin.common.util.http.SimplePostRequestExecutor; +import me.chanjar.weixin.common.util.http.hc.DefaultHttpComponentsClientBuilder; +import me.chanjar.weixin.common.util.http.hc.HttpComponentsClientBuilder; +import me.chanjar.weixin.open.api.WxOpenConfigStorage; +import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; +import org.apache.hc.core5.http.HttpHost; + +import java.io.File; + +/** + * httpclient 5 实现 + * + * @author zhangyl + */ +public class WxOpenServiceHttpComponentsImpl extends WxOpenServiceAbstractImpl
- * 微信支付接口请求实现类,默认使用Apache HttpClient实现 + * 微信支付接口请求实现类,默认使用Apache HttpClient 5实现 * Created by Binary Wang on 2017-7-8. ** * @author Binary Wang */ -public class WxPayServiceImpl extends WxPayServiceApacheHttpImpl { +public class WxPayServiceImpl extends WxPayServiceHttpComponentsImpl { } diff --git a/weixin-java-qidian/src/main/java/me/chanjar/weixin/qidian/api/impl/WxQidianServiceImpl.java b/weixin-java-qidian/src/main/java/me/chanjar/weixin/qidian/api/impl/WxQidianServiceImpl.java index 45e87204cb..2e1314b3b1 100644 --- a/weixin-java-qidian/src/main/java/me/chanjar/weixin/qidian/api/impl/WxQidianServiceImpl.java +++ b/weixin-java-qidian/src/main/java/me/chanjar/weixin/qidian/api/impl/WxQidianServiceImpl.java @@ -2,11 +2,11 @@ /** *
- * 默认接口实现类,使用apache httpclient实现 + * 默认接口实现类,使用apache httpClient 5实现 * Created by Binary Wang on 2017-5-27. ** * @author Binary Wang */ -public class WxQidianServiceImpl extends WxQidianServiceHttpClientImpl { +public class WxQidianServiceImpl extends WxQidianServiceHttpComponentsImpl { } From 72fa3b3301967c29031fabdad1574951a19b1c48 Mon Sep 17 00:00:00 2001 From: buaazyl
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
index 2e896cda7e..5347099a0b 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
@@ -263,6 +263,9 @@ public WxPayRefundResult refundV2(WxPayRefundRequest request) throws WxPayExcept
@Override
public WxPayRefundV3Result refundV3(WxPayRefundV3Request request) throws WxPayException {
+ if (StringUtils.isBlank(request.getNotifyUrl())) {
+ request.setNotifyUrl(this.getConfig().getRefundNotifyUrl());
+ }
String url = String.format("%s/v3/refund/domestic/refunds", this.getPayBaseUrl());
String response = this.postV3WithWechatpaySerial(url, GSON.toJson(request));
return GSON.fromJson(response, WxPayRefundV3Result.class);
@@ -270,6 +273,9 @@ public WxPayRefundV3Result refundV3(WxPayRefundV3Request request) throws WxPayEx
@Override
public WxPayRefundV3Result partnerRefundV3(WxPayPartnerRefundV3Request request) throws WxPayException {
+ if (StringUtils.isBlank(request.getNotifyUrl())) {
+ request.setNotifyUrl(this.getConfig().getRefundNotifyUrl());
+ }
if (StringUtils.isBlank(request.getSubMchid())) {
request.setSubMchid(this.getConfig().getSubMchId());
}
From e27325f58090db4e8801dfb433795668f1fe23bd Mon Sep 17 00:00:00 2001
From: Noctis_nkt
Date: Fri, 9 Jan 2026 14:18:23 +0800
Subject: [PATCH 146/208] =?UTF-8?q?=E3=80=90=E4=BC=81=E4=B8=9A=E5=BE=AE?=
=?UTF-8?q?=E4=BF=A1=E3=80=91=E6=96=B0=E5=A2=9E=E7=AE=A1=E7=90=86=E8=A1=A8?=
=?UTF-8?q?=E6=A0=BC=E5=86=85=E5=AE=B9=E7=9B=B8:new:=20#3837=20=E3=80=90?=
=?UTF-8?q?=E4=BC=81=E4=B8=9A=E5=BE=AE=E4=BF=A1=E3=80=91=E5=BE=AE=E6=96=87?=
=?UTF-8?q?=E6=A1=A3=EF=BC=88WeDoc=EF=BC=89=E6=9C=8D=E5=8A=A1=E6=96=B0?=
=?UTF-8?q?=E5=A2=9E=E4=BA=86=E4=B8=89=E4=B8=AA=E7=AE=A1=E7=90=86=E8=A1=A8?=
=?UTF-8?q?=E6=A0=BC=E5=86=85=E5=AE=B9=E7=9A=84=20API=20=E6=8E=A5=E5=8F=A3?=
=?UTF-8?q?=EF=BC=8C=E5=8C=85=E6=8B=AC=E6=89=B9=E9=87=8F=E6=9B=B4=E6=96=B0?=
=?UTF-8?q?=E8=A1=A8=E6=A0=BC=E5=86=85=E5=AE=B9=E3=80=81=E8=8E=B7=E5=8F=96?=
=?UTF-8?q?=E8=A1=A8=E6=A0=BC=E8=A1=8C=E5=88=97=E4=BF=A1=E6=81=AF=E4=BB=A5?=
=?UTF-8?q?=E5=8F=8A=E8=8E=B7=E5=8F=96=E6=8C=87=E5=AE=9A=E8=8C=83=E5=9B=B4?=
=?UTF-8?q?=E7=9A=84=E8=A1=A8=E6=A0=BC=E6=95=B0=E6=8D=AE?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../weixin/cp/api/WxCpOaWeDocService.java | 49 ++++
.../cp/api/impl/WxCpOaWeDocServiceImpl.java | 23 ++
.../doc/WxCpDocSheetBatchUpdateRequest.java | 199 ++++++++++++++
.../doc/WxCpDocSheetBatchUpdateResponse.java | 126 +++++++++
.../cp/bean/oa/doc/WxCpDocSheetData.java | 260 ++++++++++++++++++
.../oa/doc/WxCpDocSheetGetDataRequest.java | 64 +++++
.../bean/oa/doc/WxCpDocSheetProperties.java | 79 ++++++
.../weixin/cp/constant/WxCpApiPathConsts.java | 15 +
8 files changed, 815 insertions(+)
create mode 100644 weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetBatchUpdateRequest.java
create mode 100644 weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetBatchUpdateResponse.java
create mode 100644 weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetData.java
create mode 100644 weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetGetDataRequest.java
create mode 100644 weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetProperties.java
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaWeDocService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaWeDocService.java
index 1356c839b2..d63d32694a 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaWeDocService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaWeDocService.java
@@ -78,4 +78,53 @@ public interface WxCpOaWeDocService {
* @throws WxErrorException the wx error exception
*/
WxCpDocShare docShare(@NonNull String docId) throws WxErrorException;
+
+ /**
+ * 编辑表格内容
+ * 该接口可以对一个在线表格批量执行多个更新操作
+ *
+ * 注意:
+ * 1.批量更新请求中的各个操作会逐个按顺序执行,直到全部执行完成则请求返回,或者其中一个操作报错则不再继续执行后续的操作
+ * 2.每一个更新操作在执行之前都会做请求校验(包括权限校验、参数校验等等),如果校验未通过则该更新操作会报错并返回,不再执行后续操作
+ * 3.单次批量更新请求的操作数量 <= 5
+ *
+ * 请求方式:POST(HTTPS)
+ * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/spreadsheet/batch_update?access_token=ACCESS_TOKEN
+ *
+ * @param request 编辑表格内容请求参数
+ * @return 编辑表格内容批量更新的响应结果
+ * @throws WxErrorException the wx error exception
+ */
+ WxCpDocSheetBatchUpdateResponse docBatchUpdate(@NonNull WxCpDocSheetBatchUpdateRequest request) throws WxErrorException;
+
+ /**
+ * 获取表格行列信息
+ * 该接口用于获取在线表格的工作表、行数、列数等。
+ *
+ * 请求方式:POST(HTTPS)
+ * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/spreadsheet/get_sheet_properties?access_token=ACCESS_TOKEN
+ *
+ * @param docId 在线表格的docid
+ * @return 返回表格行列信息
+ * @throws WxErrorException
+ */
+ WxCpDocSheetProperties getSheetProperties(@NonNull String docId) throws WxErrorException;
+
+
+ /**
+ * 本接口用于获取指定范围内的在线表格信息,单次查询的范围大小需满足以下限制:
+ *
+ * 查询范围行数 <=1000
+ * 查询范围列数 <=200
+ * 范围内的总单元格数量 <=10000
+ *
+ * 请求方式:POST(HTTPS)
+ * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/spreadsheet/get_sheet_range_data?access_token=ACCESS_TOKEN
+ *
+ * @param request 获取指定范围内的在线表格信息请求参数
+ * @return 返回指定范围内的在线表格信息
+ * @throws WxErrorException
+ */
+ WxCpDocSheetData getSheetRangeData(@NonNull WxCpDocSheetGetDataRequest request) throws WxErrorException;
+
}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaWeDocServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaWeDocServiceImpl.java
index 81de32453d..fc5379dc73 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaWeDocServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOaWeDocServiceImpl.java
@@ -63,4 +63,27 @@ public WxCpDocShare docShare(@NonNull String docId) throws WxErrorException {
String responseContent = this.cpService.post(apiUrl, jsonObject.toString());
return WxCpDocShare.fromJson(responseContent);
}
+
+ @Override
+ public WxCpDocSheetBatchUpdateResponse docBatchUpdate(@NonNull WxCpDocSheetBatchUpdateRequest request) throws WxErrorException {
+ String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(WEDOC_SPREADSHEET_BATCH_UPDATE);
+ String responseContent = this.cpService.post(apiUrl, request.toJson());
+ return WxCpDocSheetBatchUpdateResponse.fromJson(responseContent);
+ }
+
+ @Override
+ public WxCpDocSheetProperties getSheetProperties(@NonNull String docId) throws WxErrorException {
+ String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(WEDOC_SPREADSHEET_GET_SHEET_PROPERTIES);
+ JsonObject jsonObject = new JsonObject();
+ jsonObject.addProperty("docid", docId);
+ String responseContent = this.cpService.post(apiUrl, jsonObject.toString());
+ return WxCpDocSheetProperties.fromJson(responseContent);
+ }
+
+ @Override
+ public WxCpDocSheetData getSheetRangeData(@NonNull WxCpDocSheetGetDataRequest request) throws WxErrorException {
+ String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(WEDOC_SPREADSHEET_GET_SHEET_RANGE_DATA);
+ String responseContent = this.cpService.post(apiUrl, request.toJson());
+ return WxCpDocSheetData.fromJson(responseContent);
+ }
}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetBatchUpdateRequest.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetBatchUpdateRequest.java
new file mode 100644
index 0000000000..37c42717e7
--- /dev/null
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetBatchUpdateRequest.java
@@ -0,0 +1,199 @@
+package me.chanjar.weixin.cp.bean.oa.doc;
+
+import java.io.Serializable;
+import java.util.List;
+
+import com.google.gson.annotations.SerializedName;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+import me.chanjar.weixin.cp.bean.oa.doc.WxCpDocSheetData.GridData;
+import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
+
+/**
+ * 编辑表格内容请求
+ *
+ * @author zhongying
+ * @since 2026-01-07
+ */
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Accessors(chain = true)
+public class WxCpDocSheetBatchUpdateRequest implements Serializable {
+ private static final long serialVersionUID = 584565591133421347L;
+
+ /**
+ * 文档的docid.必填
+ */
+ @SerializedName("docid")
+ private String docId;
+
+ /**
+ * 更新操作列表.必填
+ */
+ @SerializedName("requests")
+ private List requests;
+
+ /**
+ * From json wx cp doc sheet batch update request.
+ *
+ * @param json the json
+ * @return the wx cp doc sheet batch update request
+ */
+ public static WxCpDocSheetBatchUpdateRequest fromJson(String json) {
+ return WxCpGsonBuilder.create().fromJson(json, WxCpDocSheetBatchUpdateRequest.class);
+ }
+
+ /**
+ * To json string.
+ *
+ * @return the string
+ */
+ public String toJson() {
+ return WxCpGsonBuilder.create().toJson(this);
+ }
+
+ /**
+ * 更新操作
+ */
+ @Getter
+ @Setter
+ public static class Request implements Serializable {
+ private static final long serialVersionUID = 253933038745894628L;
+
+ /**
+ * 新增工作表
+ */
+ @SerializedName("add_sheet_request")
+ private AddSheetRequest addSheetRequest;
+
+ /**
+ * 删除工作表请求
+ */
+ @SerializedName("delete_sheet_request")
+ private DeleteSheetRequest deleteSheetRequest;
+
+ /**
+ * 更新范围内单元格内容
+ */
+ @SerializedName("update_range_request")
+ private UpdateRangeRequest updateRangeRequest;
+
+ /**
+ * 删除表格连续的行或列
+ */
+ @SerializedName("delete_dimension_request")
+ private DeleteDimensionRequest deleteDimensionRequest;
+
+ /**
+ * 新增工作表,新增需满足以下限制
+ * 范围列数 <=200
+ * 范围内的总单元格数量 <=10000
+ */
+ @Getter
+ @Setter
+ public static class AddSheetRequest implements Serializable {
+ private static final long serialVersionUID = 523704967699486288L;
+
+ /**
+ * 工作表名称
+ */
+ @SerializedName("title")
+ private String title;
+
+ /**
+ * 新增工作表的初始行数
+ */
+ @SerializedName("row_count")
+ private int rowCount;
+
+ /**
+ * 新增工作表的初始列数
+ */
+ @SerializedName("column_count")
+ private int columnCount;
+ }
+
+ /**
+ * 删除工作表请求
+ */
+ @Getter
+ @Setter
+ public static class DeleteSheetRequest implements Serializable {
+ private static final long serialVersionUID = 767974765396168274L;
+
+ /**
+ * 工作表唯一标识
+ */
+ @SerializedName("sheet_id")
+ private String sheetId;
+ }
+
+ /**
+ * 更新范围内单元格内容
+ */
+ @Getter
+ @Setter
+ public static class UpdateRangeRequest implements Serializable {
+ private static final long serialVersionUID = 433859595039061888L;
+
+ /**
+ * 工作表唯一标识
+ */
+ @SerializedName("sheet_id")
+ private String sheetId;
+
+ /**
+ * 表格数据
+ */
+ @SerializedName("grid_data")
+ private GridData gridData;
+ }
+
+ /**
+ * 删除表格连续的行或列
+ * 注意:
+ * 1.该操作会导致表格缩表
+ * 2.删除的范围遵循 左闭右开 ———— [start_index,end_index) ,如果 end_index <= start_index
+ * 则该请求报错。
+ */
+ @Getter
+ @Setter
+ public static class DeleteDimensionRequest implements Serializable {
+ private static final long serialVersionUID = 107245521502978033L;
+
+ /**
+ * 工作表唯一标识
+ */
+ @SerializedName("sheet_id")
+ private String sheetId;
+
+ /**
+ * 删除的维度类型.
+ * ROW:行
+ * COLUMN:列
+ */
+ @SerializedName("dimension")
+ private String dimension;
+
+ /**
+ * 删除行列的起始序号(从1开始)
+ */
+ @SerializedName("start_index")
+ private int startIndex;
+
+ /**
+ * 删除行列的终止序号(从1开始)
+ */
+ @SerializedName("end_index")
+ private int endIndex;
+ }
+ }
+}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetBatchUpdateResponse.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetBatchUpdateResponse.java
new file mode 100644
index 0000000000..8e31e9022f
--- /dev/null
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetBatchUpdateResponse.java
@@ -0,0 +1,126 @@
+package me.chanjar.weixin.cp.bean.oa.doc;
+
+import java.io.Serializable;
+
+import com.google.gson.annotations.SerializedName;
+
+import lombok.Data;
+import lombok.Getter;
+import lombok.Setter;
+import me.chanjar.weixin.cp.bean.oa.doc.WxCpDocSheetProperties.Properties;
+import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
+
+/**
+ * 更新操作(UpdateRequest])对应的响应结构体类型
+ *
+ * @author zhongying
+ * @since 2026-01-08
+ */
+@Data
+public class WxCpDocSheetBatchUpdateResponse implements Serializable {
+ private static final long serialVersionUID = 781694717017131015L;
+
+ /**
+ * 新增工作表响应
+ */
+ @SerializedName("add_sheet_response")
+ private AddSheetResponse addSheetResponse;
+
+ /**
+ * 删除工作表响应
+ */
+ @SerializedName("delete_sheet_response")
+ private DeleteSheetResponse deleteSheetResponse;
+
+ /**
+ * 更新范围内单元格内容响应
+ */
+ @SerializedName("update_range_response")
+ private UpdateRangeResponse updateRangeResponse;
+
+ /**
+ * 删除表格连续的行或列响应
+ */
+ @SerializedName("delete_dimension_response")
+ private DeleteDimensionResponse deleteDimensionResponse;
+
+ /**
+ * 从 JSON 字符串反序列化为 WxCpDocSheetBatchUpdateResponse 对象。
+ *
+ * @param json the json
+ * @return 反序列化得到的 WxCpDocSheetBatchUpdateResponse 对象
+ */
+ public static WxCpDocSheetBatchUpdateResponse fromJson(String json) {
+ return WxCpGsonBuilder.create().fromJson(json, WxCpDocSheetBatchUpdateResponse.class);
+ }
+
+ /**
+ * To json string.
+ *
+ * @return the string
+ */
+ public String toJson() {
+ return WxCpGsonBuilder.create().toJson(this);
+ }
+
+ /**
+ * 新增工作表响应
+ */
+ @Getter
+ @Setter
+ public static class AddSheetResponse implements Serializable {
+ private static final long serialVersionUID = 618814209485621336L;
+
+ /**
+ * 新增子表的属性
+ */
+ @SerializedName("properties")
+ private Properties properties;
+ }
+
+ /**
+ * 删除工作表响应
+ */
+ @Getter
+ @Setter
+ public static class DeleteSheetResponse implements Serializable {
+ private static final long serialVersionUID = 625927337093938411L;
+
+ /**
+ * 被删除的工作表的唯一标识
+ */
+ @SerializedName("sheet_id")
+ private String sheetId;
+ }
+
+ /**
+ * 更新范围内单元格内容响应
+ */
+ @Getter
+ @Setter
+ public static class UpdateRangeResponse implements Serializable {
+ private static final long serialVersionUID = 180842641209787414L;
+
+ /**
+ * 数据更新的成功的单元格数量
+ */
+ @SerializedName("updated_cells")
+ private int updatedCells;
+ }
+
+ /**
+ * 删除表格连续的行(或列),请求响应体结构
+ */
+ @Getter
+ @Setter
+ public static class DeleteDimensionResponse implements Serializable {
+ private static final long serialVersionUID = 107245521502978033L;
+
+ /**
+ * 被删除的行数(或列数)
+ */
+ @SerializedName("deleted")
+ private int deleted;
+ }
+
+}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetData.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetData.java
new file mode 100644
index 0000000000..15e76430b7
--- /dev/null
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetData.java
@@ -0,0 +1,260 @@
+package me.chanjar.weixin.cp.bean.oa.doc;
+
+import java.io.Serializable;
+import java.util.List;
+
+import com.google.gson.annotations.SerializedName;
+
+import lombok.Data;
+import lombok.Getter;
+import lombok.Setter;
+import me.chanjar.weixin.cp.bean.WxCpBaseResp;
+import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
+
+/**
+ * 获取表格数据
+ *
+ * @author zhongying
+ * @since 2026-01-07
+ */
+@Data
+public class WxCpDocSheetData extends WxCpBaseResp implements Serializable {
+ private static final long serialVersionUID = 498054945993671723L;
+
+ /**
+ * 返回data
+ */
+ @SerializedName("grid_data")
+ private GridData gridData;
+
+ /**
+ * From json sheet data.
+ *
+ * @param json the json
+ * @return the sheet data
+ */
+ public static WxCpDocSheetData fromJson(String json) {
+ return WxCpGsonBuilder.create().fromJson(json, WxCpDocSheetData.class);
+ }
+
+ /**
+ * To json string.
+ *
+ * @return the string
+ */
+ @Override
+ public String toJson() {
+ return WxCpGsonBuilder.create().toJson(this);
+ }
+
+ /**
+ * 表格数据
+ */
+ @Getter
+ @Setter
+ public static class GridData implements Serializable {
+ private static final long serialVersionUID = 389887488098521821L;
+
+ /**
+ * 起始行编号 (从0开始计算)
+ */
+ @SerializedName("start_row")
+ private int startRow;
+
+ /**
+ * 起始列编号 (从0开始计算)
+ */
+ @SerializedName("start_column")
+ private int startColumn;
+
+ /**
+ * 各行的数据
+ */
+ @SerializedName("rows")
+ private List rows;
+
+ /**
+ * 行数据
+ */
+ @Getter
+ @Setter
+ public static class RowData implements Serializable {
+ private static final long serialVersionUID = 225648868492722337L;
+
+ /**
+ * 各个单元格的数据内容
+ */
+ @SerializedName("values")
+ private List values;
+
+ /**
+ * 单元格的信息
+ */
+ @Getter
+ @Setter
+ public static class CellData implements Serializable {
+ private static final long serialVersionUID = 656471192719707304L;
+
+ /**
+ * 单元格的数据内容
+ */
+ @SerializedName("cell_value")
+ private CellValue cellValue;
+
+ /**
+ * 单元格的样式信息
+ */
+ @SerializedName("cell_format")
+ private CellFormat cellFormat;
+
+ /**
+ * 单元格的数据内容,暂时只支持文本、链接,一个CellValue中只能选填一个字段
+ */
+ @Getter
+ @Setter
+ public static class CellValue implements Serializable {
+ private static final long serialVersionUID = 656471192719707304L;
+
+ /**
+ * 文本
+ */
+ @SerializedName("text")
+ private String text;
+
+ /**
+ * 链接
+ */
+ @SerializedName("link")
+ private Link link;
+
+ /**
+ * 链接
+ */
+ @Getter
+ @Setter
+ public static class Link implements Serializable {
+ private static final long serialVersionUID = 912896452879347178L;
+
+ /**
+ * 链接url
+ */
+ @SerializedName("url")
+ private String url;
+
+ /**
+ * 链接标题
+ */
+ @SerializedName("text")
+ private String text;
+ }
+ }
+
+ /**
+ * 单元格的样式信息
+ */
+ @Getter
+ @Setter
+ public static class CellFormat implements Serializable {
+ private static final long serialVersionUID = 656471192719707304L;
+
+ /**
+ * 文字样式
+ */
+
+ @SerializedName("text_format")
+ private TextFormat textFormat;
+
+ /**
+ * 文字样式
+ */
+ @Getter
+ @Setter
+ public static class TextFormat implements Serializable {
+ private static final long serialVersionUID = 184358104921122206L;
+
+ /**
+ * 字体
+ */
+ @SerializedName("font")
+ private String font;
+
+ /**
+ * 字体大小,最大72
+ */
+ @SerializedName("font_size")
+ private int fontSize;
+
+ /**
+ * 字体加粗
+ */
+ @SerializedName("bold")
+ private boolean bold;
+
+ /**
+ * 斜体
+ */
+ @SerializedName("italic")
+ private boolean italic;
+
+ /**
+ * 字体删除线
+ */
+ @SerializedName("strikethrough")
+ private boolean strikethrough;
+
+ /**
+ * 字体下划线
+ */
+ @SerializedName("underline")
+ private boolean underline;
+
+ /**
+ * 字体颜色
+ */
+ @SerializedName("color")
+ private Color color;
+
+ /**
+ * 字体颜色
+ */
+ @Getter
+ @Setter
+ public static class Color implements Serializable {
+ private static final long serialVersionUID = 140418085882147315L;
+
+ /**
+ * 红色,取值范围:[0,255]
+ */
+ @SerializedName("red")
+ private int red;
+
+ /**
+ * 绿色,取值范围:[0,255]
+ */
+ @SerializedName("green")
+ private int green;
+
+ /**
+ * 蓝色,取值范围:[0,255]
+ */
+ @SerializedName("blue")
+ private int blue;
+
+ /**
+ * alpha通道,取值范围:[0,255],默认值为255完全不透明
+ */
+ @SerializedName("alpha")
+ private int alpha;
+
+ }
+
+ }
+ }
+
+ }
+
+ }
+
+ }
+
+}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetGetDataRequest.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetGetDataRequest.java
new file mode 100644
index 0000000000..df2907aa31
--- /dev/null
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetGetDataRequest.java
@@ -0,0 +1,64 @@
+package me.chanjar.weixin.cp.bean.oa.doc;
+
+import java.io.Serializable;
+
+import com.google.gson.annotations.SerializedName;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.experimental.Accessors;
+import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
+
+/**
+ * 获取表格数据请求
+ *
+ * @author zhongying
+ * @since 2026-01-07
+ */
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Accessors(chain = true)
+public class WxCpDocSheetGetDataRequest implements Serializable {
+ private static final long serialVersionUID = 827718590347822812L;
+
+ /**
+ * 在线表格唯一标识.必填
+ */
+ @SerializedName("docid")
+ private String docId;
+
+ /**
+ * 工作表ID,工作表的唯一标识.必填
+ */
+ @SerializedName("sheet_id")
+ private String sheetId;
+
+ /**
+ * 查询的范围,格式为"A1:B2",表示获取A1到B2单元格的数据.必填
+ */
+ @SerializedName("range")
+ private String range;
+
+ /**
+ * From json to {@link WxCpDocSheetGetDataRequest}.
+ *
+ * @param json the json string representing {@link WxCpDocSheetGetDataRequest}
+ * @return the {@link WxCpDocSheetGetDataRequest} object
+ */
+ public static WxCpDocSheetGetDataRequest fromJson(String json) {
+ return WxCpGsonBuilder.create().fromJson(json, WxCpDocSheetGetDataRequest.class);
+ }
+
+ /**
+ * To json string.
+ *
+ * @return the string
+ */
+ public String toJson() {
+ return WxCpGsonBuilder.create().toJson(this);
+ }
+}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetProperties.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetProperties.java
new file mode 100644
index 0000000000..6e67965fe0
--- /dev/null
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetProperties.java
@@ -0,0 +1,79 @@
+package me.chanjar.weixin.cp.bean.oa.doc;
+
+import java.io.Serializable;
+import java.util.List;
+
+import com.google.gson.annotations.SerializedName;
+
+import lombok.Data;
+import lombok.Getter;
+import lombok.Setter;
+import me.chanjar.weixin.cp.bean.WxCpBaseResp;
+import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
+
+/**
+ * 获取表格行列信息
+ *
+ * @author zhongying
+ * @since 2026-01-07
+ */
+@Data
+public class WxCpDocSheetProperties extends WxCpBaseResp implements Serializable {
+ private static final long serialVersionUID = 666707252457243065L;
+
+ @SerializedName("properties")
+ private List properties;
+
+ /**
+ * From json sheet properties.
+ *
+ * @param json the json
+ * @return the sheet properties
+ */
+ public static WxCpDocSheetProperties fromJson(String json) {
+ return WxCpGsonBuilder.create().fromJson(json, WxCpDocSheetProperties.class);
+ }
+
+ /**
+ * To json string.
+ *
+ * @return the string
+ */
+ public String toJson() {
+ return WxCpGsonBuilder.create().toJson(this);
+ }
+
+ /**
+ * 工作表属性
+ */
+ @Getter
+ @Setter
+ public static class Properties implements Serializable {
+ private static final long serialVersionUID = 640301090538839892L;
+
+ /**
+ * 工作表ID,工作表的唯一标识
+ */
+ @SerializedName("sheet_id")
+ private String sheetId;
+
+ /**
+ * 工作表名称
+ */
+ @SerializedName("title")
+ private String title;
+
+ /**
+ * 表格的总行数
+ */
+ @SerializedName("row_count")
+ private int rowCount;
+
+ /**
+ * 表格的总列数
+ */
+ @SerializedName("column_count")
+ private int columnCount;
+
+ }
+}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/constant/WxCpApiPathConsts.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/constant/WxCpApiPathConsts.java
index ade813ef5c..82bb811b3c 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/constant/WxCpApiPathConsts.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/constant/WxCpApiPathConsts.java
@@ -575,6 +575,21 @@ interface Oa {
*/
String WEDOC_DOC_SHARE = "/cgi-bin/wedoc/doc_share";
+ /**
+ * The constant WEDOC_SPREADSHEET_BATCH_UPDATE.
+ */
+ String WEDOC_SPREADSHEET_BATCH_UPDATE = "/cgi-bin/wedoc/spreadsheet/batch_update";
+
+ /**
+ * The constant WEDOC_SPREADSHEET_GET_SHEET_PROPERTIES.
+ */
+ String WEDOC_SPREADSHEET_GET_SHEET_PROPERTIES = "/cgi-bin/wedoc/spreadsheet/get_sheet_properties";
+
+ /**
+ * The constant WEDOC_SPREADSHEET_GET_SHEET_RANGE_DATA.
+ */
+ String WEDOC_SPREADSHEET_GET_SHEET_RANGE_DATA = "/cgi-bin/wedoc/spreadsheet/get_sheet_range_data";
+
/**
* 邮件
* https://developer.work.weixin.qq.com/document/path/95486
From 397bbe04c4376ab6f73717acd10a2558c6728906 Mon Sep 17 00:00:00 2001
From: buaazyl
Date: Sat, 10 Jan 2026 14:23:38 +0800
Subject: [PATCH 147/208] =?UTF-8?q?:art:=20#3844=20=E3=80=90=E5=9F=BA?=
=?UTF-8?q?=E7=A1=80=E6=9E=B6=E6=9E=84=E3=80=91=E5=B0=86=20httpclient4=20?=
=?UTF-8?q?=E4=BE=9D=E8=B5=96=E7=9A=84=20scope=20=E4=BB=8E=E9=BB=98?=
=?UTF-8?q?=E8=AE=A4=E7=9A=84=20compile=20=E6=94=B9=E4=B8=BA=20provided?=
=?UTF-8?q?=EF=BC=8C=E4=BB=A5=E4=BE=BF=E8=AE=A9=E4=BD=BF=E7=94=A8=E8=80=85?=
=?UTF-8?q?=E5=8F=AF=E4=BB=A5=E6=9B=B4=E7=81=B5=E6=B4=BB=E5=9C=B0=E9=80=89?=
=?UTF-8?q?=E6=8B=A9=20HTTP=20=E5=AE=A2=E6=88=B7=E7=AB=AF=E5=AE=9E?=
=?UTF-8?q?=E7=8E=B0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/HTTPCLIENT_UPGRADE_GUIDE.md | 10 +++++-----
pom.xml | 2 +-
weixin-java-channel/pom.xml | 10 ++++++++++
weixin-java-common/pom.xml | 2 ++
weixin-java-cp/pom.xml | 5 +++++
weixin-java-miniapp/pom.xml | 10 ++++++++++
weixin-java-mp/pom.xml | 10 ++++++++++
weixin-java-open/pom.xml | 10 ++++++++++
weixin-java-pay/pom.xml | 8 ++++++++
weixin-java-qidian/pom.xml | 5 +++++
10 files changed, 66 insertions(+), 6 deletions(-)
diff --git a/docs/HTTPCLIENT_UPGRADE_GUIDE.md b/docs/HTTPCLIENT_UPGRADE_GUIDE.md
index 945341966e..5cabb10674 100644
--- a/docs/HTTPCLIENT_UPGRADE_GUIDE.md
+++ b/docs/HTTPCLIENT_UPGRADE_GUIDE.md
@@ -43,8 +43,8 @@
### 对现有项目
- **向后兼容**:不需要修改任何代码
-- HttpClient 4.x 依然可用,项目同时包含两个版本的依赖
-- 如果希望继续使用 HttpClient 4.x,只需在配置中显式指定
+- 如果希望继续使用 HttpClient 4.x,只需在配置中显式指定,pay 模块会自动包含 httpclient4 依赖(因为某些接口必须使用 httpclient4)
+ 其他模块(mp、miniapp、cp、open、channel、qidian)如果需要使用 httpclient4,必须显式在项目中添加 httpclient4 依赖
## 迁移步骤
@@ -94,10 +94,10 @@ WxMpService wxMpService = new WxMpServiceHttpClientImpl();
A: 不会。项目保持完全向后兼容,HttpClient 4.x 的所有实现都保持不变。
### Q: 我需要修改代码吗?
-A: 大多数情况下不需要。如果希望继续使用 HttpClient 4.x,只需在配置中指定 `http-client-type=HttpClient` 即可。
+A: 大多数情况下不需要。如果希望继续使用 HttpClient 4.x,只需在配置中指定 `http-client-type=HttpClient` ,并引入 HttpClient 4.x 依赖即可。
### Q: 我可以在同一个项目中同时使用两个版本吗?
-A: 可以。不同的模块可以配置使用不同的 HTTP 客户端。例如,MP 模块使用 HttpClient 5.x,MiniApp 模块默认使用 HttpClient 4.x,但也可以按需配置为 HttpClient 5.x。
+A: 可以。不同的模块可以配置使用不同的 HTTP 客户端。例如,MP 模块使用 HttpClient 5.x,pay 模块部分接口仍使用 HttpClient 4.x,但也可以按需配置为 HttpClient 5.x。
### Q: 如何排除不需要的依赖?
A: 如果只想使用一个版本,可以在 `pom.xml` 中排除另一个:
@@ -196,4 +196,4 @@ weixin-java-common/
- ✅ **推荐使用 HttpClient 5.x**:性能更好,功能更强
- ✅ **向后兼容**:可以继续使用 HttpClient 4.x
- ✅ **灵活配置**:支持多种 HTTP 客户端,按需选择
-- ✅ **平滑迁移**:无需修改代码,仅需配置即可
+- ✅ **平滑迁移**:无需修改代码,仅需配置,若不使用 HttpClient 5.x ,引入其他依赖即可
diff --git a/pom.xml b/pom.xml
index 5740a27790..d58a677b28 100644
--- a/pom.xml
+++ b/pom.xml
@@ -136,7 +136,7 @@
UTF-8
4.5.13
- 5.5
+ 5.5.2
9.4.57.v20241219
diff --git a/weixin-java-channel/pom.xml b/weixin-java-channel/pom.xml
index 13dd26fa98..c15ea302e9 100644
--- a/weixin-java-channel/pom.xml
+++ b/weixin-java-channel/pom.xml
@@ -29,6 +29,16 @@
jodd-http
provided
+ * {@link me.chanjar.weixin.mp.api.impl.BaseWxMpServiceImpl#setMaxRetryTimes(int)}
+ * {@link cn.binarywang.wx.miniapp.api.impl.BaseWxMaServiceImpl#setMaxRetryTimes(int)}
+ *
+ */
+ private int maxRetryTimes = 5;
+
+ /**
+ * http 请求重试间隔
+ *
+ * {@link me.chanjar.weixin.mp.api.impl.BaseWxMpServiceImpl#setRetrySleepMillis(int)}
+ * {@link cn.binarywang.wx.miniapp.api.impl.BaseWxMaServiceImpl#setRetrySleepMillis(int)}
+ *
+ */
+ private int retrySleepMillis = 1000;
+
+ /**
+ * 连接超时时间,单位毫秒
+ */
+ private int connectionTimeout = 5000;
+
+ /**
+ * 读数据超时时间,即socketTimeout,单位毫秒
+ */
+ private int soTimeout = 5000;
+
+ /**
+ * 从连接池获取链接的超时时间,单位毫秒
+ */
+ private int connectionRequestTimeout = 5000;
+ }
+
+ public enum StorageType {
+ /**
+ * 内存
+ */
+ memory,
+ /**
+ * jedis
+ */
+ jedis,
+ /**
+ * redisson
+ */
+ redisson,
+ /**
+ * redisTemplate
+ */
+ redistemplate
+ }
+
+}
diff --git a/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/properties/WxOpenMultiRedisProperties.java b/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/properties/WxOpenMultiRedisProperties.java
new file mode 100644
index 0000000000..ae6d5368d7
--- /dev/null
+++ b/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/properties/WxOpenMultiRedisProperties.java
@@ -0,0 +1,57 @@
+package com.binarywang.spring.starter.wxjava.open.properties;
+
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 微信开放平台多账号Redis配置.
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class WxOpenMultiRedisProperties implements Serializable {
+ private static final long serialVersionUID = -5924815351660074401L;
+
+ /**
+ * 主机地址.
+ */
+ private String host = "127.0.0.1";
+
+ /**
+ * 端口号.
+ */
+ private int port = 6379;
+
+ /**
+ * 密码.
+ */
+ private String password;
+
+ /**
+ * 超时.
+ */
+ private int timeout = 2000;
+
+ /**
+ * 数据库.
+ */
+ private int database = 0;
+
+ /**
+ * sentinel ips
+ */
+ private String sentinelIps;
+
+ /**
+ * sentinel name
+ */
+ private String sentinelName;
+
+ private Integer maxActive;
+ private Integer maxIdle;
+ private Integer maxWaitMillis;
+ private Integer minIdle;
+}
diff --git a/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/properties/WxOpenSingleProperties.java b/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/properties/WxOpenSingleProperties.java
new file mode 100644
index 0000000000..116da323dc
--- /dev/null
+++ b/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/properties/WxOpenSingleProperties.java
@@ -0,0 +1,49 @@
+package com.binarywang.spring.starter.wxjava.open.properties;
+
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 微信开放平台单个应用配置.
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class WxOpenSingleProperties implements Serializable {
+ private static final long serialVersionUID = 1980986361098922525L;
+
+ /**
+ * 设置微信开放平台的appid.
+ */
+ private String appId;
+
+ /**
+ * 设置微信开放平台的app secret.
+ */
+ private String secret;
+
+ /**
+ * 设置微信开放平台的token.
+ */
+ private String token;
+
+ /**
+ * 设置微信开放平台的EncodingAESKey.
+ */
+ private String aesKey;
+
+ /**
+ * 自定义API主机地址,用于替换默认的 https://api.weixin.qq.com
+ * 例如:http://proxy.company.com:8080
+ */
+ private String apiHostUrl;
+
+ /**
+ * 自定义获取AccessToken地址,用于向自定义统一服务获取AccessToken
+ * 例如:http://proxy.company.com:8080/oauth/token
+ */
+ private String accessTokenUrl;
+}
diff --git a/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/service/WxOpenMultiServices.java b/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/service/WxOpenMultiServices.java
new file mode 100644
index 0000000000..9228071a10
--- /dev/null
+++ b/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/service/WxOpenMultiServices.java
@@ -0,0 +1,26 @@
+package com.binarywang.spring.starter.wxjava.open.service;
+
+
+import me.chanjar.weixin.open.api.WxOpenService;
+
+/**
+ * 微信开放平台 {@link WxOpenService} 所有实例存放类.
+ *
+ * @author binarywang
+ */
+public interface WxOpenMultiServices {
+ /**
+ * 通过租户 Id 获取 WxOpenService
+ *
+ * @param tenantId 租户 Id
+ * @return WxOpenService
+ */
+ WxOpenService getWxOpenService(String tenantId);
+
+ /**
+ * 根据租户 Id,从列表中移除一个 WxOpenService 实例
+ *
+ * @param tenantId 租户 Id
+ */
+ void removeWxOpenService(String tenantId);
+}
diff --git a/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/service/WxOpenMultiServicesImpl.java b/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/service/WxOpenMultiServicesImpl.java
new file mode 100644
index 0000000000..76fb139e6c
--- /dev/null
+++ b/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/service/WxOpenMultiServicesImpl.java
@@ -0,0 +1,35 @@
+package com.binarywang.spring.starter.wxjava.open.service;
+
+import me.chanjar.weixin.open.api.WxOpenService;
+
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+
+/**
+ * 微信开放平台 {@link WxOpenMultiServices} 默认实现
+ *
+ * @author Binary Wang
+ */
+public class WxOpenMultiServicesImpl implements WxOpenMultiServices {
+ private final Map+ * 服务商可通过本接口获取服务商所拥有的应用模板列表 + * 文档地址:https://developer.work.weixin.qq.com/document/path/97111 + *+ * + * @return 应用模板列表 + * @throws WxErrorException 微信错误异常 + */ + WxCpTpTemplateList getTemplateList() throws WxErrorException; + + /** + * 获取代开发应用详情 + *
+ * 服务商可通过本接口获取某个授权企业中已经安装的代开发自建应用的详情 + * 文档地址:https://developer.work.weixin.qq.com/document/path/97111 + *+ * + * @param authCorpId 授权企业的corpid + * @param agentId 应用的agentid,为空时则返回该企业所有的代开发自建应用详情 + * @return 代开发应用详情 + * @throws WxErrorException 微信错误异常 + */ + WxCpTpCustomizedAppDetail getCustomizedAppDetail(String authCorpId, Integer agentId) throws WxErrorException; + +} diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpService.java index 93855d1a48..92966c1d03 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpService.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpService.java @@ -662,4 +662,18 @@ WxCpTpXmlMessage fromEncryptedXml(String encryptedXml, void setWxCpTpOAuth2Service(WxCpTpOAuth2Service wxCpTpOAuth2Service); + /** + * 获取代开发服务 + * + * @return 代开发服务 + */ + WxCpTpCustomizedService getWxCpTpCustomizedService(); + + /** + * 设置代开发服务 + * + * @param wxCpTpCustomizedService 代开发服务 + */ + void setWxCpTpCustomizedService(WxCpTpCustomizedService wxCpTpCustomizedService); + } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/BaseWxCpTpServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/BaseWxCpTpServiceImpl.java index f8f554b81a..25c1470eb2 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/BaseWxCpTpServiceImpl.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/BaseWxCpTpServiceImpl.java @@ -60,6 +60,7 @@ public abstract class BaseWxCpTpServiceImpl
+ * 注意:
+ * 根据上面返回的文件类型,拼接好存放文件的绝对路径即可。此时绝对路径写入文件流,来达到获取媒体文件的目的。
+ * 详情可以看官方文档,亦可阅读此接口源码。
+ *
+ * @param sdkfileid 消息体内容中的sdkfileid信息
+ * @param proxy 使用代理的请求,需要传入代理的链接。如:socks5://10.0.0.1:8081 或者 http://10.0.0.1:8081,如果没有传null
+ * @param passwd 代理账号密码,需要传入代理的账号密码。如 user_name:passwd_123,如果没有传null
+ * @param timeout 超时时间,分片数据需累加到文件存储。单次最大返回512K字节,如果文件比较大,自行设置长一点,比如timeout=10000
+ * @param targetFilePath 目标文件绝对路径+实际文件名,比如:/usr/local/file/20220114/474f866b39d10718810d55262af82662.gif
+ * @throws WxErrorException the wx error exception
+ */
+ void downloadMediaFile(@NonNull String sdkfileid, String proxy, String passwd, @NonNull long timeout,
+ @NonNull String targetFilePath) throws WxErrorException;
+
/**
* 获取媒体文件 传入一个lambda,each所有的数据分片byte[],更加灵活
* 针对图片、文件等媒体数据,提供sdk接口拉取数据内容。
@@ -85,10 +152,29 @@ void getMediaFile(@NonNull long sdk, @NonNull String sdkfileid, String proxy, St
* @param timeout 超时时间,分片数据需累加到文件存储。单次最大返回512K字节,如果文件比较大,自行设置长一点,比如timeout=10000
* @param action 传入一个lambda,each所有的数据分片
* @throws WxErrorException the wx error exception
+ * @deprecated 请使用 {@link #downloadMediaFile(String, String, String, long, Consumer)} 代替,
+ * 该方法需要传入SDK,容易导致SDK生命周期管理混乱,引发JVM崩溃
*/
+ @Deprecated
void getMediaFile(@NonNull long sdk, @NonNull String sdkfileid, String proxy, String passwd, @NonNull long timeout,
@NonNull Consumer
+ * 注意:configKey 是配置文件中定义的 key(如 wx.pay.configs.<configKey>.xxx),
+ * 而不是 appId。如果使用 appId 作为配置 key,则可以直接传入 appId。
+ *
+ * 注意:configKey 是配置文件中定义的 key(如 wx.pay.configs.<configKey>.xxx),
+ * 而不是 appId。如果使用 appId 作为配置 key,则可以直接传入 appId。
+ *
+ * 本示例展示了如何使用 wx-java-pay-multi-spring-boot-starter 来管理多个公众号的支付配置。
+ *
+ * 适用场景:系统需要支持多个公众号,根据用户所在的公众号动态选择支付配置
+ *
+ * 适用场景:服务商为多个子商户提供支付服务
+ *
+ * 适用场景:查询不同公众号的订单支付状态
+ *
+ * 适用场景:为不同公众号的订单申请退款
+ *
+ * 适用场景:需要在运行时更新配置(如证书更新后需要重新加载)
+ *
+ * 使用单个 WxMaService 实例管理多个租户配置,通过 switchover 切换租户。
+ * 相比 {@link WxMaMultiServicesImpl},此实现共享 HTTP 客户端,节省资源。
+ *
+ * 注意:由于使用 ThreadLocal 切换配置,在异步或多线程场景需要特别注意线程上下文切换。
+ *
+ * 使用单个 WxMpService 实例管理多个租户配置,通过 switchover 切换租户。
+ * 相比 {@link WxMpMultiServicesImpl},此实现共享 HTTP 客户端,节省资源。
+ *
+ * 注意:由于使用 ThreadLocal 切换配置,在异步或多线程场景需要特别注意线程上下文切换。
+ *
- * 文档地址:推送用工消息
+ * 文档地址:推送用工消息
*
- * 文档地址:解绑用工关系
+ * 文档地址:解绑用工关系
*
+ * 微信返回的媒体文件标识Id。
+ * 示例值:6uqyGjGrCf2GtyXP8bxrbuH9-aAoTjH-rKeSl3Lf4_So6kdkQu4w8BYVP3bzLtvR38lxt4PjtCDXsQpzqge_hQEovHzOhsLleGFQVRF-U_0
+ */
+ @SerializedName("media_id")
+ private String mediaId;
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/MerchantMediaService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/MerchantMediaService.java
index 0e35dbb68b..f7f0aaaf3e 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/MerchantMediaService.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/MerchantMediaService.java
@@ -1,6 +1,7 @@
package com.github.binarywang.wxpay.service;
import com.github.binarywang.wxpay.bean.media.ImageUploadResult;
+import com.github.binarywang.wxpay.bean.media.VideoUploadResult;
import com.github.binarywang.wxpay.exception.WxPayException;
import java.io.File;
@@ -42,5 +43,34 @@ public interface MerchantMediaService {
*/
ImageUploadResult imageUploadV3(InputStream inputStream, String fileName) throws WxPayException, IOException;
+ /**
+ *
+ * 请求方式:POST(HTTPS)
+ * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/hr/employee/get_field_info?access_token=ACCESS_TOKEN
+ * 权限说明:
+ * 需要配置人事助手的secret,调用接口前需给对应成员赋予人事小助手应用的权限。
+ *
+ * @param fields 指定字段key列表,不填则返回全部字段
+ * @return 字段信息响应 wx cp hr employee field info resp
+ * @throws WxErrorException the wx error exception
+ */
+ WxCpHrEmployeeFieldInfoResp getFieldInfo(List
+ * 请求方式:POST(HTTPS)
+ * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/hr/employee/get_employee_field_info?access_token=ACCESS_TOKEN
+ * 权限说明:
+ * 需要配置人事助手的secret,调用接口前需给对应成员赋予人事小助手应用的权限。
+ *
+ * @param userids 员工userid列表,不超过20个
+ * @param fields 指定字段key列表,不填则返回全部字段
+ * @return 员工档案数据响应 wx cp hr employee field data resp
+ * @throws WxErrorException the wx error exception
+ */
+ WxCpHrEmployeeFieldDataResp getEmployeeFieldInfo(List
+ * 请求方式:POST(HTTPS)
+ * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/hr/employee/update_employee_field_info?access_token=ACCESS_TOKEN
+ * 权限说明:
+ * 需要配置人事助手的secret,调用接口前需给对应成员赋予人事小助手应用的权限。
+ *
+ * @param userid 员工userid
+ * @param fieldList 字段数据列表
+ * @throws WxErrorException the wx error exception
+ */
+ void updateEmployeeFieldInfo(String userid, List
+ *
+ */
+ private MultiTenantMode multiTenantMode = MultiTenantMode.ISOLATED;
}
public enum StorageType {
@@ -151,4 +160,19 @@ public enum HttpClientType {
*/
JODD_HTTP
}
+
+ public enum MultiTenantMode {
+ /**
+ * 隔离模式:为每个租户创建独立的 WxMaService 实例.
+ * 优点:线程安全,不依赖 ThreadLocal
+ * 缺点:每个租户创建独立的 HTTP 客户端,资源占用较多
+ */
+ ISOLATED,
+ /**
+ * 共享模式:使用单个 WxMaService 实例管理所有租户配置.
+ * 优点:共享 HTTP 客户端,节省资源
+ * 缺点:依赖 ThreadLocal 切换配置,异步场景需注意
+ */
+ SHARED
+ }
}
diff --git a/spring-boot-starters/wx-java-miniapp-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/miniapp/service/WxMaMultiServicesSharedImpl.java b/spring-boot-starters/wx-java-miniapp-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/miniapp/service/WxMaMultiServicesSharedImpl.java
new file mode 100644
index 0000000000..40a01fb52e
--- /dev/null
+++ b/spring-boot-starters/wx-java-miniapp-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/miniapp/service/WxMaMultiServicesSharedImpl.java
@@ -0,0 +1,53 @@
+package com.binarywang.spring.starter.wxjava.miniapp.service;
+
+import cn.binarywang.wx.miniapp.api.WxMaService;
+import lombok.RequiredArgsConstructor;
+
+/**
+ * 微信小程序 {@link WxMaMultiServices} 共享式实现.
+ *
+ *
+ */
+ private MultiTenantMode multiTenantMode = MultiTenantMode.ISOLATED;
}
public enum StorageType {
@@ -155,4 +164,19 @@ public enum HttpClientType {
*/
JODD_HTTP
}
+
+ public enum MultiTenantMode {
+ /**
+ * 隔离模式:为每个租户创建独立的 WxMpService 实例.
+ * 优点:线程安全,不依赖 ThreadLocal
+ * 缺点:每个租户创建独立的 HTTP 客户端,资源占用较多
+ */
+ ISOLATED,
+ /**
+ * 共享模式:使用单个 WxMpService 实例管理所有租户配置.
+ * 优点:共享 HTTP 客户端,节省资源
+ * 缺点:依赖 ThreadLocal 切换配置,异步场景需注意
+ */
+ SHARED
+ }
}
diff --git a/spring-boot-starters/wx-java-mp-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/mp/service/WxMpMultiServicesSharedImpl.java b/spring-boot-starters/wx-java-mp-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/mp/service/WxMpMultiServicesSharedImpl.java
new file mode 100644
index 0000000000..ca9123c572
--- /dev/null
+++ b/spring-boot-starters/wx-java-mp-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/mp/service/WxMpMultiServicesSharedImpl.java
@@ -0,0 +1,53 @@
+package com.binarywang.spring.starter.wxjava.mp.service;
+
+import lombok.RequiredArgsConstructor;
+import me.chanjar.weixin.mp.api.WxMpService;
+
+/**
+ * 微信公众号 {@link WxMpMultiServices} 共享式实现.
+ *
+ * 微工卡批量转账API请求参数
+ * 文档地址:https://pay.weixin.qq.com/wiki/doc/apiv3_partner/Offline/apis/chapter4_1_8.shtml
+ *
+ * 适用对象:服务商
+ * 请求URL:https://api.mch.weixin.qq.com/v3/payroll-card/transfer-batches
+ * 请求方式:POST
+ *
+ *
+ * @author binarywang
+ * created on 2025/01/19
+ */
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class PayrollTransferBatchesRequest implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:应用ID
+ * 变量名:appid
+ * 是否必填:二选一
+ * 类型:string[1, 32]
+ * 描述:
+ * 服务商在微信申请公众号/小程序或移动应用成功后分配的账号ID
+ * 示例值:wxa1111111
+ *
+ */
+ @SerializedName(value = "appid")
+ private String appid;
+
+ /**
+ *
+ * 字段名:子商户应用ID
+ * 变量名:sub_appid
+ * 是否必填:二选一
+ * 类型:string[1, 32]
+ * 描述:
+ * 特约商户在微信申请公众号/小程序或移动应用成功后分配的账号ID
+ * 示例值:wxa1111111
+ *
+ */
+ @SerializedName(value = "sub_appid")
+ private String subAppid;
+
+ /**
+ *
+ * 字段名:子商户号
+ * 变量名:sub_mchid
+ * 是否必填:是
+ * 类型:string[1, 32]
+ * 描述:
+ * 微信服务商下特约商户的商户号,由微信支付生成并下发
+ * 示例值:1111111
+ *
+ */
+ @SerializedName(value = "sub_mchid")
+ private String subMchid;
+
+ /**
+ *
+ * 字段名:商家批次单号
+ * 变量名:out_batch_no
+ * 是否必填:是
+ * 类型:string[1, 32]
+ * 描述:
+ * 商户系统内部的商家批次单号,要求此参数只能由数字、大小写字母组成,在商户系统内部唯一
+ * 示例值:plfk2020042013
+ *
+ */
+ @SerializedName(value = "out_batch_no")
+ private String outBatchNo;
+
+ /**
+ *
+ * 字段名:批次名称
+ * 变量名:batch_name
+ * 是否必填:是
+ * 类型:string[1, 32]
+ * 描述:
+ * 该笔批量转账的名称
+ * 示例值:2019年1月深圳分部报销单
+ *
+ */
+ @SerializedName(value = "batch_name")
+ private String batchName;
+
+ /**
+ *
+ * 字段名:批次备注
+ * 变量名:batch_remark
+ * 是否必填:是
+ * 类型:string[1, 32]
+ * 描述:
+ * 转账说明,UTF8编码,最多允许32个字符
+ * 示例值:2019年1月深圳分部报销单
+ *
+ */
+ @SerializedName(value = "batch_remark")
+ private String batchRemark;
+
+ /**
+ *
+ * 字段名:转账总金额
+ * 变量名:total_amount
+ * 是否必填:是
+ * 类型:int64
+ * 描述:
+ * 转账金额单位为"分"。转账总金额必须与批次内所有明细转账金额之和保持一致,否则无法发起转账操作
+ * 示例值:4000000
+ *
+ */
+ @SerializedName(value = "total_amount")
+ private Long totalAmount;
+
+ /**
+ *
+ * 字段名:转账总笔数
+ * 变量名:total_num
+ * 是否必填:是
+ * 类型:int
+ * 描述:
+ * 一个转账批次单最多发起一千笔转账。转账总笔数必须与批次内所有明细之和保持一致,否则无法发起转账操作
+ * 示例值:200
+ *
+ */
+ @SerializedName(value = "total_num")
+ private Integer totalNum;
+
+ /**
+ *
+ * 字段名:转账明细列表
+ * 变量名:transfer_detail_list
+ * 是否必填:是
+ * 类型:array
+ * 描述:
+ * 发起批量转账的明细列表,最多一千笔
+ *
+ */
+ @SerializedName(value = "transfer_detail_list")
+ private List
+ * 字段名:商家明细单号
+ * 变量名:out_detail_no
+ * 是否必填:是
+ * 类型:string[1, 32]
+ * 描述:
+ * 商户系统内部区分转账批次单下不同转账明细单的唯一标识
+ * 示例值:x23zy545Bd5436
+ *
+ */
+ @SerializedName(value = "out_detail_no")
+ private String outDetailNo;
+
+ /**
+ *
+ * 字段名:转账金额
+ * 变量名:transfer_amount
+ * 是否必填:是
+ * 类型:int64
+ * 描述:
+ * 转账金额单位为"分"
+ * 示例值:200000
+ *
+ */
+ @SerializedName(value = "transfer_amount")
+ private Long transferAmount;
+
+ /**
+ *
+ * 字段名:转账备注
+ * 变量名:transfer_remark
+ * 是否必填:是
+ * 类型:string[1, 32]
+ * 描述:
+ * 单条转账备注(微信用户会收到该备注),UTF8编码,最多允许32个字符
+ * 示例值:2020年4月报销
+ *
+ */
+ @SerializedName(value = "transfer_remark")
+ private String transferRemark;
+
+ /**
+ *
+ * 字段名:用户标识
+ * 变量名:openid
+ * 是否必填:是
+ * 类型:string[1, 64]
+ * 描述:
+ * 用户在商户对应appid下的唯一标识
+ * 示例值:o-MYE42l80oelYMDE34nYD456Xoy
+ *
+ */
+ @SerializedName(value = "openid")
+ private String openid;
+
+ /**
+ *
+ * 字段名:收款用户姓名
+ * 变量名:user_name
+ * 是否必填:否
+ * 类型:string[1, 1024]
+ * 描述:
+ * 收款用户真实姓名。该字段需进行加密处理,加密方法详见敏感信息加密说明
+ * 示例值:757b340b45ebef5467rter35gf464344v3542sdf4t6re4tb4f54ty45t4yyry45
+ *
+ */
+ @SpecEncrypt
+ @SerializedName(value = "user_name")
+ private String userName;
+ }
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/payroll/PayrollTransferBatchesResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/payroll/PayrollTransferBatchesResult.java
new file mode 100644
index 0000000000..628c75d5f7
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/payroll/PayrollTransferBatchesResult.java
@@ -0,0 +1,241 @@
+package com.github.binarywang.wxpay.bean.marketing.payroll;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ *
+ * 微工卡批量转账API返回结果
+ * 文档地址:https://pay.weixin.qq.com/wiki/doc/apiv3_partner/Offline/apis/chapter4_1_8.shtml
+ *
+ * 适用对象:服务商
+ * 请求URL:https://api.mch.weixin.qq.com/v3/payroll-card/transfer-batches
+ * 请求方式:POST
+ *
+ *
+ * @author binarywang
+ * created on 2025/01/19
+ */
+@Data
+@NoArgsConstructor
+public class PayrollTransferBatchesResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:商家批次单号
+ * 变量名:out_batch_no
+ * 是否必填:是
+ * 类型:string[1, 32]
+ * 描述:
+ * 商户系统内部的商家批次单号
+ * 示例值:plfk2020042013
+ *
+ */
+ @SerializedName(value = "out_batch_no")
+ private String outBatchNo;
+
+ /**
+ *
+ * 字段名:微信批次单号
+ * 变量名:batch_id
+ * 是否必填:是
+ * 类型:string[1, 64]
+ * 描述:
+ * 微信批次单号,微信商家转账系统返回的唯一标识
+ * 示例值:1030000071100999991182020050700019480001
+ *
+ */
+ @SerializedName(value = "batch_id")
+ private String batchId;
+
+ /**
+ *
+ * 字段名:批次状态
+ * 变量名:batch_status
+ * 是否必填:是
+ * 类型:string[1, 32]
+ * 描述:
+ * ACCEPTED:已受理,批次已受理成功,若发起批量转账的30分钟后,转账批次单仍处于该状态,可能原因是商户账户余额不足等。商户可查询账户资金流水,若该笔转账批次单的扣款已经发生,则表示批次已经进入转账中,请再次查单确认
+ * PROCESSING:转账中,已开始处理批次内的转账明细单
+ * FINISHED:已完成,批次内的所有转账明细单都已处理完成
+ * CLOSED:已关闭,可查询具体的批次关闭原因确认
+ * 示例值:ACCEPTED
+ *
+ */
+ @SerializedName(value = "batch_status")
+ private String batchStatus;
+
+ /**
+ *
+ * 字段名:批次类型
+ * 变量名:batch_type
+ * 是否必填:是
+ * 类型:string[1, 32]
+ * 描述:
+ * 批次类型
+ * API:API方式发起
+ * WEB:WEB方式发起
+ * 示例值:API
+ *
+ */
+ @SerializedName(value = "batch_type")
+ private String batchType;
+
+ /**
+ *
+ * 字段名:批次名称
+ * 变量名:batch_name
+ * 是否必填:是
+ * 类型:string[1, 32]
+ * 描述:
+ * 该笔批量转账的名称
+ * 示例值:2019年1月深圳分部报销单
+ *
+ */
+ @SerializedName(value = "batch_name")
+ private String batchName;
+
+ /**
+ *
+ * 字段名:批次备注
+ * 变量名:batch_remark
+ * 是否必填:是
+ * 类型:string[1, 32]
+ * 描述:
+ * 转账说明,UTF8编码,最多允许32个字符
+ * 示例值:2019年1月深圳分部报销单
+ *
+ */
+ @SerializedName(value = "batch_remark")
+ private String batchRemark;
+
+ /**
+ *
+ * 字段名:批次关闭原因
+ * 变量名:close_reason
+ * 是否必填:否
+ * 类型:string[1, 32]
+ * 描述:
+ * 如果批次单状态为"CLOSED"(已关闭),则有关闭原因
+ * 示例值:OVERDUE_CLOSE
+ *
+ */
+ @SerializedName(value = "close_reason")
+ private String closeReason;
+
+ /**
+ *
+ * 字段名:转账总金额
+ * 变量名:total_amount
+ * 是否必填:是
+ * 类型:int64
+ * 描述:
+ * 转账金额单位为"分"
+ * 示例值:4000000
+ *
+ */
+ @SerializedName(value = "total_amount")
+ private Long totalAmount;
+
+ /**
+ *
+ * 字段名:转账总笔数
+ * 变量名:total_num
+ * 是否必填:是
+ * 类型:int
+ * 描述:
+ * 一个转账批次单最多发起一千笔转账
+ * 示例值:200
+ *
+ */
+ @SerializedName(value = "total_num")
+ private Integer totalNum;
+
+ /**
+ *
+ * 字段名:批次创建时间
+ * 变量名:create_time
+ * 是否必填:是
+ * 类型:string[1, 32]
+ * 描述:
+ * 批次受理成功时返回,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss:sss+TIMEZONE
+ * 示例值:2015-05-20T13:29:35.120+08:00
+ *
+ */
+ @SerializedName(value = "create_time")
+ private String createTime;
+
+ /**
+ *
+ * 字段名:批次更新时间
+ * 变量名:update_time
+ * 是否必填:是
+ * 类型:string[1, 32]
+ * 描述:
+ * 批次最近一次状态变更的时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss:sss+TIMEZONE
+ * 示例值:2015-05-20T13:29:35.120+08:00
+ *
+ */
+ @SerializedName(value = "update_time")
+ private String updateTime;
+
+ /**
+ *
+ * 字段名:转账成功金额
+ * 变量名:success_amount
+ * 是否必填:否
+ * 类型:int64
+ * 描述:
+ * 转账成功的金额,单位为"分"
+ * 示例值:3900000
+ *
+ */
+ @SerializedName(value = "success_amount")
+ private Long successAmount;
+
+ /**
+ *
+ * 字段名:转账成功笔数
+ * 变量名:success_num
+ * 是否必填:否
+ * 类型:int
+ * 描述:
+ * 转账成功的笔数
+ * 示例值:199
+ *
+ */
+ @SerializedName(value = "success_num")
+ private Integer successNum;
+
+ /**
+ *
+ * 字段名:转账失败金额
+ * 变量名:fail_amount
+ * 是否必填:否
+ * 类型:int64
+ * 描述:
+ * 转账失败的金额,单位为"分"
+ * 示例值:100000
+ *
+ */
+ @SerializedName(value = "fail_amount")
+ private Long failAmount;
+
+ /**
+ *
+ * 字段名:转账失败笔数
+ * 变量名:fail_num
+ * 是否必填:否
+ * 类型:int
+ * 描述:
+ * 转账失败的笔数
+ * 示例值:1
+ *
+ */
+ @SerializedName(value = "fail_num")
+ private Integer failNum;
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/PayrollService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/PayrollService.java
index b3f788815c..581e3230b7 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/PayrollService.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/PayrollService.java
@@ -101,4 +101,16 @@ public interface PayrollService {
*/
WxPayApplyBillV3Result merchantFundWithdrawBillType(String billType, String billDate, String tarType) throws WxPayException;
+ /**
+ * 微工卡批量转账API
+ * 适用对象:服务商
+ * 请求URL:https://api.mch.weixin.qq.com/v3/payroll-card/transfer-batches
+ * 请求方式:POST
+ *
+ * @param request 请求参数
+ * @return 返回数据
+ * @throws WxPayException the wx pay exception
+ */
+ PayrollTransferBatchesResult payrollCardTransferBatches(PayrollTransferBatchesRequest request) throws WxPayException;
+
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/PayrollServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/PayrollServiceImpl.java
index 3d8c831271..85f7ee23dd 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/PayrollServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/PayrollServiceImpl.java
@@ -193,4 +193,27 @@ public WxPayApplyBillV3Result merchantFundWithdrawBillType(String billType, Stri
return GSON.fromJson(response, WxPayApplyBillV3Result.class);
}
+ /**
+ * 微工卡批量转账API
+ * 适用对象:服务商
+ * 请求URL:https://api.mch.weixin.qq.com/v3/payroll-card/transfer-batches
+ * 请求方式:POST
+ *
+ * @param request 请求参数
+ * @return 返回数据
+ * @throws WxPayException the wx pay exception
+ */
+ @Override
+ public PayrollTransferBatchesResult payrollCardTransferBatches(PayrollTransferBatchesRequest request) throws WxPayException {
+ String url = String.format("%s/v3/payroll-card/transfer-batches", payService.getPayBaseUrl());
+ // 对敏感信息进行加密
+ if (request.getTransferDetailList() != null && !request.getTransferDetailList().isEmpty()) {
+ for (PayrollTransferBatchesRequest.TransferDetail detail : request.getTransferDetailList()) {
+ RsaCryptoUtil.encryptFields(detail, payService.getConfig().getVerifier().getValidCertificate());
+ }
+ }
+ String response = payService.postV3WithWechatpaySerial(url, GSON.toJson(request));
+ return GSON.fromJson(response, PayrollTransferBatchesResult.class);
+ }
+
}
diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/PayrollServiceImplTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/PayrollServiceImplTest.java
index 03bbc8c593..ce43aa3d04 100644
--- a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/PayrollServiceImplTest.java
+++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/PayrollServiceImplTest.java
@@ -14,6 +14,8 @@
import org.testng.annotations.Guice;
import org.testng.annotations.Test;
+import java.util.Collections;
+
/**
* 微工卡(服务商)
*
@@ -125,4 +127,29 @@ public void merchantFundWithdrawBillType() throws WxPayException {
log.info(result.toString());
}
+ @Test
+ public void payrollCardTransferBatches() throws WxPayException {
+ PayrollTransferBatchesRequest request = PayrollTransferBatchesRequest.builder()
+ .appid("wxa1111111")
+ .subMchid("1111111")
+ .subAppid("wxa1111111")
+ .outBatchNo("plfk2020042013" + System.currentTimeMillis())
+ .batchName("2019年1月深圳分部报销单")
+ .batchRemark("2019年1月深圳分部报销单")
+ .totalAmount(200000L)
+ .totalNum(1)
+ .transferDetailList(Collections.singletonList(
+ PayrollTransferBatchesRequest.TransferDetail.builder()
+ .outDetailNo("x23zy545Bd5436" + System.currentTimeMillis())
+ .transferAmount(200000L)
+ .transferRemark("2020年4月报销")
+ .openid("o-MYE42l80oelYMDE34nYD456Xoy")
+ .userName("张三")
+ .build()
+ ))
+ .build();
+ PayrollTransferBatchesResult result = wxPayService.getPayrollService().payrollCardTransferBatches(request);
+ log.info(result.toString());
+ }
+
}
From ae2aa43190b53ac69c3618b117b815949517d61f Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Tue, 20 Jan 2026 13:36:30 +0800
Subject: [PATCH 161/208] =?UTF-8?q?:art:=20#3861=20=E3=80=90=E5=BE=AE?=
=?UTF-8?q?=E4=BF=A1=E6=94=AF=E4=BB=98=E3=80=91=E5=BE=AE=E5=B7=A5=E5=8D=A1?=
=?UTF-8?q?=E6=A0=B8=E8=BA=AB=E9=A2=84=E4=B8=8B=E5=8D=95=E6=8E=A5=E5=8F=A3?=
=?UTF-8?q?=E7=9A=84=E8=AF=B7=E6=B1=82=E7=B1=BB=E6=B7=BB=E5=8A=A0=E7=BC=BA?=
=?UTF-8?q?=E5=A4=B1=E7=9A=84=E6=A0=B8=E8=BA=AB=E7=B1=BB=E5=9E=8B=E5=AD=97?=
=?UTF-8?q?=E6=AE=B5?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../payroll/PreOrderWithAuthRequest.java | 18 ++++++++++++++++++
.../service/impl/PayrollServiceImplTest.java | 1 +
2 files changed, 19 insertions(+)
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/payroll/PreOrderWithAuthRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/payroll/PreOrderWithAuthRequest.java
index 1556fbc343..0e20fc8fa6 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/payroll/PreOrderWithAuthRequest.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/payroll/PreOrderWithAuthRequest.java
@@ -166,4 +166,22 @@ public class PreOrderWithAuthRequest implements Serializable {
*/
@SerializedName(value = "employment_type")
private String employmentType;
+
+ /**
+ *
+ * 字段名:核身类型
+ * 变量名:authenticate_type
+ * 是否必填:否
+ * 类型:string[1,32]
+ * 描述:
+ * 核身类型,用于标识本次核身的业务类型;枚举值:
+ * NORMAL_AUTHENTICATE:普通核身
+ * LOGIN_AUTHENTICATE:登录核身
+ * INSURANCE_AUTHENTICATE:保险核身
+ * CONTRACT_AUTHENTICATE:合同核身
+ * 示例值:NORMAL_AUTHENTICATE
+ *
+ */
+ @SerializedName(value = "authenticate_type")
+ private String authenticateType;
}
diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/PayrollServiceImplTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/PayrollServiceImplTest.java
index ce43aa3d04..20bb33d7fd 100644
--- a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/PayrollServiceImplTest.java
+++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/PayrollServiceImplTest.java
@@ -114,6 +114,7 @@ public void payrollCardPreOrderWithAuth() throws WxPayException {
request.setIdCardNumber("7FzH5XksJG3a8HLLsaaUV6K54y1OnPMY5");
request.setProjectName("某项目");
request.setUserName("LP7bT4hQXUsOZCEvK2YrSiqFsnP0oRMfeoLN0vBg");
+ request.setAuthenticateType("NORMAL_AUTHENTICATE");
PreOrderWithAuthResult preOrderWithAuthResult = wxPayService.getPayrollService().payrollCardPreOrderWithAuth(request);
log.info(preOrderWithAuthResult.toString());
From 28a0d6e8eea226b15d4f1ea7354cca8244a03beb Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Tue, 20 Jan 2026 13:37:39 +0800
Subject: [PATCH 162/208] =?UTF-8?q?:art:=20#3860=20=E3=80=90=E5=BE=AE?=
=?UTF-8?q?=E4=BF=A1=E6=94=AF=E4=BB=98=E3=80=91=E8=BD=AC=E8=B4=A6=E5=88=B0?=
=?UTF-8?q?=E9=93=B6=E8=A1=8C=E5=8D=A1=E7=9A=84=E6=9F=A5=E8=AF=A2=E6=8E=A5?=
=?UTF-8?q?=E5=8F=A3=E5=A2=9E=E5=8A=A0=20bank=5Fname=20=E5=92=8C=20bank=5F?=
=?UTF-8?q?card=5Fnumber=5Ftail=20=E5=AD=97=E6=AE=B5?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../transfer/BatchDetailsResult.java | 26 +++
.../transfer/BatchDetailsResultTest.java | 182 ++++++++++++++++++
2 files changed, 208 insertions(+)
create mode 100644 weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/marketing/transfer/BatchDetailsResultTest.java
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/transfer/BatchDetailsResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/transfer/BatchDetailsResult.java
index 4ca7958ed5..854fd6ba5a 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/transfer/BatchDetailsResult.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/transfer/BatchDetailsResult.java
@@ -235,4 +235,30 @@ public String toString() {
*/
@SerializedName(value = "update_time")
private String updateTime;
+ /**
+ *
+ * 字段名:开户银行全称(含支行)
+ * 变量名:bank_name
+ * 是否必填:否
+ * 类型:string[1, 128]
+ * 描述:
+ * 转账到银行卡时返回,开户银行全称(含支行)
+ * 示例值:中国农业银行股份有限公司深圳分行
+ *
+ */
+ @SerializedName(value = "bank_name")
+ private String bankName;
+ /**
+ *
+ * 字段名:银行卡号后四位
+ * 变量名:bank_card_number_tail
+ * 是否必填:否
+ * 类型:string[4, 4]
+ * 描述:
+ * 转账到银行卡时返回,用于标识银行卡的后四位
+ * 示例值:1234
+ *
+ */
+ @SerializedName(value = "bank_card_number_tail")
+ private String bankCardNumberTail;
}
diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/marketing/transfer/BatchDetailsResultTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/marketing/transfer/BatchDetailsResultTest.java
new file mode 100644
index 0000000000..c2347300a6
--- /dev/null
+++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/marketing/transfer/BatchDetailsResultTest.java
@@ -0,0 +1,182 @@
+package com.github.binarywang.wxpay.bean.marketing.transfer;
+
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import org.testng.annotations.Test;
+
+import static org.testng.Assert.*;
+
+/**
+ * 测试 BatchDetailsResult 的字段序列化和反序列化功能
+ *
+ * @author Binary Wang
+ */
+public class BatchDetailsResultTest {
+
+ private static final Gson GSON = new GsonBuilder().create();
+
+ @Test
+ public void testBankFieldsDeserialization() {
+ // 模拟微信API返回的JSON(包含银行相关字段)
+ String mockJson = "{\n" +
+ " \"sp_mchid\": \"1900001109\",\n" +
+ " \"out_batch_no\": \"plfk2020042013\",\n" +
+ " \"batch_id\": \"1030000071100999991182020050700019480001\",\n" +
+ " \"appid\": \"wxf636efh567hg4356\",\n" +
+ " \"out_detail_no\": \"x23zy545Bd5436\",\n" +
+ " \"detail_id\": \"1040000071100999991182020050700019500100\",\n" +
+ " \"detail_status\": \"SUCCESS\",\n" +
+ " \"transfer_amount\": 200000,\n" +
+ " \"transfer_remark\": \"2020年4月报销\",\n" +
+ " \"openid\": \"o-MYE42l80oelYMDE34nYD456Xoy\",\n" +
+ " \"username\": \"757b340b45ebef5467rter35gf464344v3542sdf4t6re4tb4f54ty45t4yyry45\",\n" +
+ " \"initiate_time\": \"2015-05-20T13:29:35.120+08:00\",\n" +
+ " \"update_time\": \"2015-05-20T13:29:35.120+08:00\",\n" +
+ " \"bank_name\": \"中国农业银行股份有限公司深圳分行\",\n" +
+ " \"bank_card_number_tail\": \"1234\"\n" +
+ "}";
+
+ // 反序列化JSON
+ BatchDetailsResult result = GSON.fromJson(mockJson, BatchDetailsResult.class);
+
+ // 验证基本字段正常解析
+ assertEquals(result.getSpMchid(), "1900001109");
+ assertEquals(result.getOutBatchNo(), "plfk2020042013");
+ assertEquals(result.getBatchId(), "1030000071100999991182020050700019480001");
+ assertEquals(result.getAppId(), "wxf636efh567hg4356");
+ assertEquals(result.getOutDetailNo(), "x23zy545Bd5436");
+ assertEquals(result.getDetailId(), "1040000071100999991182020050700019500100");
+ assertEquals(result.getDetailStatus(), "SUCCESS");
+ assertEquals(result.getTransferAmount(), Integer.valueOf(200000));
+ assertEquals(result.getTransferRemark(), "2020年4月报销");
+ assertEquals(result.getOpenid(), "o-MYE42l80oelYMDE34nYD456Xoy");
+ assertEquals(result.getUserName(), "757b340b45ebef5467rter35gf464344v3542sdf4t6re4tb4f54ty45t4yyry45");
+ assertEquals(result.getInitiateTime(), "2015-05-20T13:29:35.120+08:00");
+ assertEquals(result.getUpdateTime(), "2015-05-20T13:29:35.120+08:00");
+
+ // 验证新增的银行相关字段
+ assertEquals(result.getBankName(), "中国农业银行股份有限公司深圳分行");
+ assertEquals(result.getBankCardNumberTail(), "1234");
+ }
+
+ @Test
+ public void testBankFieldsWithNull() {
+ // 测试不包含银行字段的情况(转账到零钱)
+ String mockJsonWithoutBank = "{\n" +
+ " \"sp_mchid\": \"1900001109\",\n" +
+ " \"out_batch_no\": \"plfk2020042013\",\n" +
+ " \"batch_id\": \"1030000071100999991182020050700019480001\",\n" +
+ " \"out_detail_no\": \"x23zy545Bd5436\",\n" +
+ " \"detail_id\": \"1040000071100999991182020050700019500100\",\n" +
+ " \"detail_status\": \"SUCCESS\",\n" +
+ " \"transfer_amount\": 200000,\n" +
+ " \"transfer_remark\": \"2020年4月报销\",\n" +
+ " \"openid\": \"o-MYE42l80oelYMDE34nYD456Xoy\",\n" +
+ " \"username\": \"757b340b45ebef5467rter35gf464344v3542sdf4t6re4tb4f54ty45t4yyry45\",\n" +
+ " \"initiate_time\": \"2015-05-20T13:29:35.120+08:00\",\n" +
+ " \"update_time\": \"2015-05-20T13:29:35.120+08:00\"\n" +
+ "}";
+
+ BatchDetailsResult result = GSON.fromJson(mockJsonWithoutBank, BatchDetailsResult.class);
+
+ // 验证其他字段正常
+ assertEquals(result.getSpMchid(), "1900001109");
+ assertEquals(result.getDetailStatus(), "SUCCESS");
+
+ // 验证银行字段为null(转账到零钱场景下不返回这些字段)
+ assertNull(result.getBankName());
+ assertNull(result.getBankCardNumberTail());
+ }
+
+ @Test
+ public void testBankFieldsSerialization() {
+ // 测试序列化
+ BatchDetailsResult result = new BatchDetailsResult();
+ result.setSpMchid("1900001109");
+ result.setOutBatchNo("plfk2020042013");
+ result.setBatchId("1030000071100999991182020050700019480001");
+ result.setDetailStatus("SUCCESS");
+ result.setBankName("中国工商银行股份有限公司北京分行");
+ result.setBankCardNumberTail("5678");
+
+ String json = GSON.toJson(result);
+
+ // 验证JSON包含银行字段
+ assertTrue(json.contains("\"bank_name\":\"中国工商银行股份有限公司北京分行\""));
+ assertTrue(json.contains("\"bank_card_number_tail\":\"5678\""));
+ }
+
+ @Test
+ public void testToString() {
+ // 测试toString方法
+ BatchDetailsResult result = new BatchDetailsResult();
+ result.setSpMchid("1900001109");
+ result.setBankName("中国建设银行股份有限公司上海分行");
+ result.setBankCardNumberTail("9012");
+
+ String resultString = result.toString();
+
+ // 验证toString包含所有字段
+ assertNotNull(resultString);
+ assertTrue(resultString.contains("1900001109"));
+ assertTrue(resultString.contains("中国建设银行股份有限公司上海分行"));
+ assertTrue(resultString.contains("9012"));
+ }
+
+ @Test
+ public void testBankNameWithSpecialCharacters() {
+ // 测试银行名称包含特殊字符的情况
+ String mockJson = "{\n" +
+ " \"sp_mchid\": \"1900001109\",\n" +
+ " \"out_batch_no\": \"plfk2020042013\",\n" +
+ " \"batch_id\": \"1030000071100999991182020050700019480001\",\n" +
+ " \"out_detail_no\": \"x23zy545Bd5436\",\n" +
+ " \"detail_id\": \"1040000071100999991182020050700019500100\",\n" +
+ " \"detail_status\": \"SUCCESS\",\n" +
+ " \"transfer_amount\": 200000,\n" +
+ " \"transfer_remark\": \"2020年4月报销\",\n" +
+ " \"openid\": \"o-MYE42l80oelYMDE34nYD456Xoy\",\n" +
+ " \"username\": \"757b340b45ebef5467rter35gf464344v3542sdf4t6re4tb4f54ty45t4yyry45\",\n" +
+ " \"initiate_time\": \"2015-05-20T13:29:35.120+08:00\",\n" +
+ " \"update_time\": \"2015-05-20T13:29:35.120+08:00\",\n" +
+ " \"bank_name\": \"中国农业银行股份有限公司北京市朝阳区(支行)\",\n" +
+ " \"bank_card_number_tail\": \"0000\"\n" +
+ "}";
+
+ BatchDetailsResult result = GSON.fromJson(mockJson, BatchDetailsResult.class);
+
+ // 验证特殊字符正确解析
+ assertEquals(result.getBankName(), "中国农业银行股份有限公司北京市朝阳区(支行)");
+ assertEquals(result.getBankCardNumberTail(), "0000");
+ }
+
+ @Test
+ public void testFailedTransferWithoutBankFields() {
+ // 测试转账失败的情况
+ String mockJson = "{\n" +
+ " \"sp_mchid\": \"1900001109\",\n" +
+ " \"out_batch_no\": \"plfk2020042013\",\n" +
+ " \"batch_id\": \"1030000071100999991182020050700019480001\",\n" +
+ " \"out_detail_no\": \"x23zy545Bd5436\",\n" +
+ " \"detail_id\": \"1040000071100999991182020050700019500100\",\n" +
+ " \"detail_status\": \"FAIL\",\n" +
+ " \"transfer_amount\": 200000,\n" +
+ " \"transfer_remark\": \"2020年4月报销\",\n" +
+ " \"fail_reason\": \"ACCOUNT_FROZEN\",\n" +
+ " \"openid\": \"o-MYE42l80oelYMDE34nYD456Xoy\",\n" +
+ " \"username\": \"757b340b45ebef5467rter35gf464344v3542sdf4t6re4tb4f54ty45t4yyry45\",\n" +
+ " \"initiate_time\": \"2015-05-20T13:29:35.120+08:00\",\n" +
+ " \"update_time\": \"2015-05-20T13:29:35.120+08:00\"\n" +
+ "}";
+
+ BatchDetailsResult result = GSON.fromJson(mockJson, BatchDetailsResult.class);
+
+ // 验证失败状态
+ assertEquals(result.getDetailStatus(), "FAIL");
+ assertEquals(result.getFailReason(), "ACCOUNT_FROZEN");
+
+ // 失败的情况下银行字段应为null
+ assertNull(result.getBankName());
+ assertNull(result.getBankCardNumberTail());
+ }
+}
From a23429c144e38e50966a84857555bd95e7e5e17b Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Tue, 20 Jan 2026 13:39:41 +0800
Subject: [PATCH 163/208] =?UTF-8?q?:art:=20#3859=20=E3=80=90=E4=BC=81?=
=?UTF-8?q?=E4=B8=9A=E5=BE=AE=E4=BF=A1=E3=80=91=E5=AE=A1=E6=89=B9=E8=AF=A6?=
=?UTF-8?q?=E6=83=85=E6=8E=A5=E5=8F=A3=E5=A2=9E=E5=8A=A0=E6=80=BB=E8=B4=B9?=
=?UTF-8?q?=E7=94=A8=E9=87=91=E9=A2=9D=E5=AD=97=E6=AE=B5?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../cp/bean/oa/WxCpApprovalDetailResult.java | 6 ++
.../cp/api/impl/WxCpOaServiceImplTest.java | 74 +++++++++++++++++++
2 files changed, 80 insertions(+)
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpApprovalDetailResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpApprovalDetailResult.java
index 7d55ff878f..fe77fcaeac 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpApprovalDetailResult.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/WxCpApprovalDetailResult.java
@@ -91,6 +91,12 @@ public static class WxCpApprovalDetail implements Serializable {
@SerializedName("comments")
private List
- * 文档:https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/laboruse/intro.html
+ * 服务端api文档:https://developers.weixin.qq.com/miniprogram/dev/server/API/laboruse/
+ * 整体流程文档: https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/laboruse/intro.html
*
* @return 用工关系服务对象WxMaEmployeeRelationService
*/
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/WxMaEmployeeRelationServiceImpl.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/WxMaEmployeeRelationServiceImpl.java
index 8f240e9151..08d29000ee 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/WxMaEmployeeRelationServiceImpl.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/WxMaEmployeeRelationServiceImpl.java
@@ -15,6 +15,7 @@
*
* @author Binary Wang
* created on 2025-12-19
+ * update on 2026-01-22 15:06:33
*/
@RequiredArgsConstructor
public class WxMaEmployeeRelationServiceImpl implements WxMaEmployeeRelationService {
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/employee/WxMaSendEmployeeMsgRequest.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/employee/WxMaSendEmployeeMsgRequest.java
index 2d50479817..d93d9beb77 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/employee/WxMaSendEmployeeMsgRequest.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/employee/WxMaSendEmployeeMsgRequest.java
@@ -12,11 +12,12 @@
/**
* 小程序推送用工消息请求实体
*
- * 字段名:用户openid
+ * 字段名:模板id
* 是否必填:是
- * 描述:需要接收消息的用户openid
+ * 描述:需要在微信后台申请用工关系权限,通过后创建的模板审核通过后可以复制模板ID
*
*/
- @SerializedName("openid")
- private String openid;
+ @SerializedName("template_id")
+ private String templateId;
/**
*
- * 字段名:企业id
+ * 字段名:页面
* 是否必填:是
- * 描述:企业id,小程序管理员在微信开放平台配置
+ * 描述:用工消息通知跳转的page小程序链接(注意 小程序页面链接要是申请模板的小程序)
*
*/
- @SerializedName("corp_id")
- private String corpId;
+ @SerializedName("page")
+ private String page;
+
+ /**
+ *
+ * 字段名:被推送用户的openId
+ * 是否必填:是
+ * 描述:被推送用户的openId
+ *
+ */
+ @SerializedName("touser")
+ private String touser;
/**
*
* 字段名:消息内容
* 是否必填:是
- * 描述:推送的消息内容,文本格式,最长不超过200个字符
+ * 描述:需要根据小程序后台审核通过的模板id的字段类型序列化json传递
+ *
+ *
+ *
+ * 参考组装代码
+ *
+ *
*/
- @SerializedName("msg")
- private String msg;
+
+ @SerializedName("data")
+ private String data;
public String toJson() {
return WxMaGsonBuilder.create().toJson(this);
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/employee/WxMaUnbindEmployeeRequest.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/employee/WxMaUnbindEmployeeRequest.java
index e56d84670c..e357f246a5 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/employee/WxMaUnbindEmployeeRequest.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/employee/WxMaUnbindEmployeeRequest.java
@@ -8,15 +8,17 @@
import lombok.NoArgsConstructor;
import java.io.Serializable;
+import java.util.List;
/**
* 小程序解绑用工关系请求实体
*
+ * // 使用 HashMap 构建数据结构
+ * Map
*
- * 字段名:用户openid
+ * 字段名:用户openid列表
* 是否必填:是
- * 描述:需要解绑的用户openid
+ * 描述:需要解绑的用户openid列表
*
*/
- @SerializedName("openid")
- private String openid;
-
- /**
- *
- * 字段名:企业id
- * 是否必填:是
- * 描述:企业id,小程序管理员在微信开放平台配置
- *
- */
- @SerializedName("corp_id")
- private String corpId;
+ @SerializedName("openid_list")
+ private List
+ * 文档地址: https://developers.weixin.qq.com/miniprogram/dev/server/API/laboruse/
+ *
+ */
public interface Employee {
/** 解绑用工关系 */
- String UNBIND_EMPLOYEE_URL = "https://api.weixin.qq.com/wxa/unbinduserb2cauthinfo";
+ String UNBIND_EMPLOYEE_URL = "https://api.weixin.qq.com/wxa/business/unbinduserb2cauthinfo";
/** 推送用工消息 */
- String SEND_EMPLOYEE_MSG_URL = "https://api.weixin.qq.com/wxa/sendemployeerelationmsg";
+ String SEND_EMPLOYEE_MSG_URL = "https://api.weixin.qq.com/cgi-bin/message/wxopen/employeerelationmsg/send";
}
}
diff --git a/weixin-java-miniapp/src/test/java/cn/binarywang/wx/miniapp/api/impl/WxMaEmployeeRelationServiceImplTest.java b/weixin-java-miniapp/src/test/java/cn/binarywang/wx/miniapp/api/impl/WxMaEmployeeRelationServiceImplTest.java
new file mode 100644
index 0000000000..53afad70f3
--- /dev/null
+++ b/weixin-java-miniapp/src/test/java/cn/binarywang/wx/miniapp/api/impl/WxMaEmployeeRelationServiceImplTest.java
@@ -0,0 +1,73 @@
+package cn.binarywang.wx.miniapp.api.impl;
+
+import cn.binarywang.wx.miniapp.api.WxMaService;
+import cn.binarywang.wx.miniapp.bean.employee.WxMaSendEmployeeMsgRequest;
+import cn.binarywang.wx.miniapp.bean.employee.WxMaUnbindEmployeeRequest;
+import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder;
+import cn.binarywang.wx.miniapp.test.ApiTestModule;
+import com.google.inject.Inject;
+import lombok.extern.slf4j.Slf4j;
+import me.chanjar.weixin.common.error.WxErrorException;
+import org.jetbrains.annotations.NotNull;
+import org.testng.annotations.Guice;
+import org.testng.annotations.Test;
+
+import java.util.*;
+
+@Slf4j
+@Test
+@Guice(modules = ApiTestModule.class)
+public class WxMaEmployeeRelationServiceImplTest {
+
+ @Inject
+ protected WxMaService wxService;
+
+ @Test
+ public void testSendEmployeeMsg() throws WxErrorException {
+ WxMaSendEmployeeMsgRequest wxMaSendEmployeeMsgRequest = new WxMaSendEmployeeMsgRequest();
+ wxMaSendEmployeeMsgRequest.setPage("/pages/index/index");
+ wxMaSendEmployeeMsgRequest.setTouser("o0uBr12b1zdgCk1qDoBivmSYb9GA");
+ wxMaSendEmployeeMsgRequest.setTemplateId("nmO-O4V33TOREVLAlumwPCsHssqkt7mea_cyWNE-IFmZqT9jh_LsERhzDOsOqa-3");
+
+ // 使用 HashMap 构建数据结构
+ Map
-
-
-
-
+
+ 赞助商招募中
From 780c24bda0ca46084e504c49a4b22439937a6fe8 Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Sat, 31 Jan 2026 00:53:44 +0800
Subject: [PATCH 167/208] =?UTF-8?q?:new:=20#3871=20=E3=80=90=E5=BE=AE?=
=?UTF-8?q?=E4=BF=A1=E6=94=AF=E4=BB=98=E3=80=91=E5=A2=9E=E5=8A=A0=E8=A7=86?=
=?UTF-8?q?=E9=A2=91=E4=B8=8A=E4=BC=A0=E6=8E=A5=E5=8F=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../wxpay/bean/media/VideoUploadResult.java | 29 +++++++++++++
.../wxpay/service/MerchantMediaService.java | 30 +++++++++++++
.../impl/MerchantMediaServiceImpl.java | 39 ++++++++++++++++-
.../wxpay/v3/WechatPayUploadHttpPost.java | 14 +++++--
.../impl/MerchantMediaServiceImplTest.java | 42 +++++++++++++++++++
5 files changed, 150 insertions(+), 4 deletions(-)
create mode 100644 weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/media/VideoUploadResult.java
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/media/VideoUploadResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/media/VideoUploadResult.java
new file mode 100644
index 0000000000..615cbbff5f
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/media/VideoUploadResult.java
@@ -0,0 +1,29 @@
+package com.github.binarywang.wxpay.bean.media;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import me.chanjar.weixin.common.util.json.WxGsonBuilder;
+
+/**
+ * 视频文件上传返回结果对象
+ *
+ * @author copilot
+ */
+@NoArgsConstructor
+@Data
+public class VideoUploadResult {
+
+ public static VideoUploadResult fromJson(String json) {
+ return WxGsonBuilder.create().fromJson(json, VideoUploadResult.class);
+ }
+
+ /**
+ * 媒体文件标识 Id
+ *
+ * 通用接口-视频上传API
+ * 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/tool/chapter3_2.shtml
+ * 接口链接:https://api.mch.weixin.qq.com/v3/merchant/media/video_upload
+ *
+ *
+ * @param videoFile 需要上传的视频文件
+ * @return VideoUploadResult 微信返回的媒体文件标识Id。示例值:6uqyGjGrCf2GtyXP8bxrbuH9-aAoTjH-rKeSl3Lf4_So6kdkQu4w8BYVP3bzLtvR38lxt4PjtCDXsQpzqge_hQEovHzOhsLleGFQVRF-U_0
+ * @throws WxPayException the wx pay exception
+ * @throws IOException the io exception
+ */
+ VideoUploadResult videoUploadV3(File videoFile) throws WxPayException, IOException;
+
+ /**
+ *
+ * 通用接口-视频上传API
+ * 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/tool/chapter3_2.shtml
+ * 接口链接:https://api.mch.weixin.qq.com/v3/merchant/media/video_upload
+ * 注意:此方法会将整个视频流读入内存计算SHA256后再上传,大文件可能导致OOM,建议大文件使用File方式上传
+ *
+ *
+ * @param inputStream 需要上传的视频文件流
+ * @param fileName 需要上传的视频文件名
+ * @return VideoUploadResult 微信返回的媒体文件标识Id。示例值:6uqyGjGrCf2GtyXP8bxrbuH9-aAoTjH-rKeSl3Lf4_So6kdkQu4w8BYVP3bzLtvR38lxt4PjtCDXsQpzqge_hQEovHzOhsLleGFQVRF-U_0
+ * @throws WxPayException the wx pay exception
+ * @throws IOException the io exception
+ */
+ VideoUploadResult videoUploadV3(InputStream inputStream, String fileName) throws WxPayException, IOException;
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/MerchantMediaServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/MerchantMediaServiceImpl.java
index 7952513f56..ee77f5e974 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/MerchantMediaServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/MerchantMediaServiceImpl.java
@@ -1,6 +1,7 @@
package com.github.binarywang.wxpay.service.impl;
import com.github.binarywang.wxpay.bean.media.ImageUploadResult;
+import com.github.binarywang.wxpay.bean.media.VideoUploadResult;
import com.github.binarywang.wxpay.exception.WxPayException;
import com.github.binarywang.wxpay.service.MerchantMediaService;
import com.github.binarywang.wxpay.service.WxPayService;
@@ -40,7 +41,7 @@ public ImageUploadResult imageUploadV3(File imageFile) throws WxPayException,IOE
@Override
public ImageUploadResult imageUploadV3(InputStream inputStream, String fileName) throws WxPayException, IOException {
String url = String.format("%s/v3/merchant/media/upload", this.payService.getPayBaseUrl());
- try(ByteArrayOutputStream bos = new ByteArrayOutputStream()) {
+ try (ByteArrayOutputStream bos = new ByteArrayOutputStream()) {
byte[] buffer = new byte[2048];
int len;
while ((len = inputStream.read(buffer)) > -1) {
@@ -57,4 +58,40 @@ public ImageUploadResult imageUploadV3(InputStream inputStream, String fileName)
}
}
+ @Override
+ public VideoUploadResult videoUploadV3(File videoFile) throws WxPayException, IOException {
+ String url = String.format("%s/v3/merchant/media/video_upload", this.payService.getPayBaseUrl());
+
+ try (FileInputStream s1 = new FileInputStream(videoFile)) {
+ String sha256 = DigestUtils.sha256Hex(s1);
+ try (InputStream s2 = new FileInputStream(videoFile)) {
+ WechatPayUploadHttpPost request = new WechatPayUploadHttpPost.Builder(URI.create(url))
+ .withVideo(videoFile.getName(), sha256, s2)
+ .build();
+ String result = this.payService.postV3(url, request);
+ return VideoUploadResult.fromJson(result);
+ }
+ }
+ }
+
+ @Override
+ public VideoUploadResult videoUploadV3(InputStream inputStream, String fileName) throws WxPayException, IOException {
+ String url = String.format("%s/v3/merchant/media/video_upload", this.payService.getPayBaseUrl());
+ try (ByteArrayOutputStream bos = new ByteArrayOutputStream()) {
+ byte[] buffer = new byte[2048];
+ int len;
+ while ((len = inputStream.read(buffer)) > -1) {
+ bos.write(buffer, 0, len);
+ }
+ bos.flush();
+ byte[] data = bos.toByteArray();
+ String sha256 = DigestUtils.sha256Hex(data);
+ WechatPayUploadHttpPost request = new WechatPayUploadHttpPost.Builder(URI.create(url))
+ .withVideo(fileName, sha256, new ByteArrayInputStream(data))
+ .build();
+ String result = this.payService.postV3(url, request);
+ return VideoUploadResult.fromJson(result);
+ }
+ }
+
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/v3/WechatPayUploadHttpPost.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/v3/WechatPayUploadHttpPost.java
index 5f5e52d2ff..3387f37e3d 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/v3/WechatPayUploadHttpPost.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/v3/WechatPayUploadHttpPost.java
@@ -35,7 +35,7 @@ public Builder(URI uri) {
this.uri = uri;
}
- public Builder withImage(String fileName, String fileSha256, InputStream inputStream) {
+ private Builder withMedia(String fileName, String fileSha256, InputStream inputStream) {
this.fileName = fileName;
this.fileSha256 = fileSha256;
this.fileInputStream = inputStream;
@@ -50,13 +50,21 @@ public Builder withImage(String fileName, String fileSha256, InputStream inputSt
return this;
}
+ public Builder withImage(String fileName, String fileSha256, InputStream inputStream) {
+ return withMedia(fileName, fileSha256, inputStream);
+ }
+
+ public Builder withVideo(String fileName, String fileSha256, InputStream inputStream) {
+ return withMedia(fileName, fileSha256, inputStream);
+ }
+
public WechatPayUploadHttpPost build() {
if (fileName == null || fileSha256 == null || fileInputStream == null) {
- throw new IllegalArgumentException("缺少待上传图片文件信息");
+ throw new IllegalArgumentException("缺少待上传文件信息");
}
if (uri == null) {
- throw new IllegalArgumentException("缺少上传图片接口URL");
+ throw new IllegalArgumentException("缺少上传文件接口URL");
}
String meta = String.format("{\"filename\":\"%s\",\"sha256\":\"%s\"}", fileName, fileSha256);
diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/MerchantMediaServiceImplTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/MerchantMediaServiceImplTest.java
index c8dd069b44..845992e43c 100644
--- a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/MerchantMediaServiceImplTest.java
+++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/MerchantMediaServiceImplTest.java
@@ -1,6 +1,7 @@
package com.github.binarywang.wxpay.service.impl;
import com.github.binarywang.wxpay.bean.media.ImageUploadResult;
+import com.github.binarywang.wxpay.bean.media.VideoUploadResult;
import com.github.binarywang.wxpay.exception.WxPayException;
import com.github.binarywang.wxpay.service.MerchantMediaService;
import com.github.binarywang.wxpay.service.WxPayService;
@@ -51,4 +52,45 @@ public void testImageUploadV3() throws WxPayException, IOException {
log.info("mediaId2:[{}]",mediaId2);
}
+
+ @Test
+ public void testVideoUploadV3() throws WxPayException, IOException {
+
+ MerchantMediaService merchantMediaService = new MerchantMediaServiceImpl(wxPayService);
+
+ String filePath = "你的视频文件的路径地址";
+// String filePath = "WxJava/test-video.mp4";
+
+ File file = new File(filePath);
+
+ VideoUploadResult videoUploadResult = merchantMediaService.videoUploadV3(file);
+ String mediaId = videoUploadResult.getMediaId();
+
+ log.info("视频上传成功,mediaId:[{}]", mediaId);
+
+ VideoUploadResult videoUploadResult2 = merchantMediaService.videoUploadV3(file);
+ String mediaId2 = videoUploadResult2.getMediaId();
+
+ log.info("视频上传成功2,mediaId2:[{}]", mediaId2);
+
+ }
+
+ @Test
+ public void testVideoUploadV3WithInputStream() throws WxPayException, IOException {
+
+ MerchantMediaService merchantMediaService = new MerchantMediaServiceImpl(wxPayService);
+
+ String filePath = "你的视频文件的路径地址";
+// String filePath = "WxJava/test-video.mp4";
+
+ File file = new File(filePath);
+
+ try (java.io.FileInputStream inputStream = new java.io.FileInputStream(file)) {
+ VideoUploadResult videoUploadResult = merchantMediaService.videoUploadV3(inputStream, file.getName());
+ String mediaId = videoUploadResult.getMediaId();
+
+ log.info("通过InputStream上传视频成功,mediaId:[{}]", mediaId);
+ }
+
+ }
}
From 3965823f0d5ac56159b746494d4abf7f77067f69 Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Sat, 31 Jan 2026 22:54:53 +0800
Subject: [PATCH 168/208] =?UTF-8?q?:art:=20#3872=20=E3=80=90=E5=BE=AE?=
=?UTF-8?q?=E4=BF=A1=E6=94=AF=E4=BB=98=E3=80=91=E8=A1=A5=E5=85=85=E5=BE=AE?=
=?UTF-8?q?=E5=B7=A5=E5=8D=A1=E6=89=B9=E9=87=8F=E8=BD=AC=E8=B4=A6=20API=20?=
=?UTF-8?q?=E7=BC=BA=E5=A4=B1=E7=9A=84=E5=BF=85=E8=A6=81=E5=AD=97=E6=AE=B5?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../PayrollTransferBatchesRequest.java | 70 +++++++++++++++++++
.../service/impl/PayrollServiceImplTest.java | 4 ++
2 files changed, 74 insertions(+)
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/payroll/PayrollTransferBatchesRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/payroll/PayrollTransferBatchesRequest.java
index 50954e70e5..7b7eff0233 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/payroll/PayrollTransferBatchesRequest.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/marketing/payroll/PayrollTransferBatchesRequest.java
@@ -142,6 +142,61 @@ public class PayrollTransferBatchesRequest implements Serializable {
@SerializedName(value = "total_num")
private Integer totalNum;
+ /**
+ *
+ * 字段名:用工类型
+ * 变量名:employment_type
+ * 是否必填:是
+ * 类型:string[1, 32]
+ * 描述:
+ * 微工卡服务仅支持用于与商户有用工关系的用户,需明确用工类型;参考值:
+ * LONG_TERM_EMPLOYMENT:长期用工,
+ * SHORT_TERM_EMPLOYMENT:短期用工,
+ * COOPERATION_EMPLOYMENT:合作关系
+ * 示例值:LONG_TERM_EMPLOYMENT
+ *
+ */
+ @SerializedName(value = "employment_type")
+ private String employmentType;
+
+ /**
+ *
+ * 字段名:用工场景
+ * 变量名:employment_scene
+ * 是否必填:否
+ * 类型:string[1, 32]
+ * 描述:
+ * 用工场景,参考值:
+ * LOGISTICS:物流;
+ * MANUFACTURING:制造业;
+ * HOTEL:酒店;
+ * CATERING:餐饮业;
+ * EVENT:活动促销;
+ * RETAIL:零售;
+ * OTHERS:其他
+ * 示例值:LOGISTICS
+ *
+ */
+ @SerializedName(value = "employment_scene")
+ private String employmentScene;
+
+ /**
+ *
+ * 字段名:特约商户授权类型
+ * 变量名:authorization_type
+ * 是否必填:是
+ * 类型:string[1, 32]
+ * 描述:
+ * 特约商户授权类型:
+ * INFORMATION_AUTHORIZATION_TYPE:特约商户信息授权类型,
+ * FUND_AUTHORIZATION_TYPE:特约商户资金授权类型,
+ * INFORMATION_AND_FUND_AUTHORIZATION_TYPE:特约商户信息和资金授权类型
+ * 示例值:INFORMATION_AUTHORIZATION_TYPE
+ *
+ */
+ @SerializedName(value = "authorization_type")
+ private String authorizationType;
+
/**
*
* 字段名:转账明细列表
@@ -235,5 +290,20 @@ public static class TransferDetail implements Serializable {
@SpecEncrypt
@SerializedName(value = "user_name")
private String userName;
+
+ /**
+ *
+ * 字段名:收款用户身份证
+ * 变量名:user_id_card
+ * 是否必填:否
+ * 类型:string[1, 1024]
+ * 描述:
+ * 收款用户身份证号。该字段需进行加密处理,加密方法详见敏感信息加密说明
+ * 示例值:8609cb22e1774a50a930e414cc71eca06121bcd266335cda230d24a7886a8d9f
+ *
+ */
+ @SpecEncrypt
+ @SerializedName(value = "user_id_card")
+ private String userIdCard;
}
}
diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/PayrollServiceImplTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/PayrollServiceImplTest.java
index 20bb33d7fd..a5421f5dc9 100644
--- a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/PayrollServiceImplTest.java
+++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/PayrollServiceImplTest.java
@@ -139,6 +139,9 @@ public void payrollCardTransferBatches() throws WxPayException {
.batchRemark("2019年1月深圳分部报销单")
.totalAmount(200000L)
.totalNum(1)
+ .employmentType("LONG_TERM_EMPLOYMENT")
+ .employmentScene("LOGISTICS")
+ .authorizationType("INFORMATION_AUTHORIZATION_TYPE")
.transferDetailList(Collections.singletonList(
PayrollTransferBatchesRequest.TransferDetail.builder()
.outDetailNo("x23zy545Bd5436" + System.currentTimeMillis())
@@ -146,6 +149,7 @@ public void payrollCardTransferBatches() throws WxPayException {
.transferRemark("2020年4月报销")
.openid("o-MYE42l80oelYMDE34nYD456Xoy")
.userName("张三")
+ .userIdCard("8609cb22e1774a50a930e414cc71eca06121bcd266335cda230d24a7886a8d9f")
.build()
))
.build();
From b259206bcbb6a4293e4df16a47c9cde5b388efea Mon Sep 17 00:00:00 2001
From: cbxbj <56364140+cbxbj@users.noreply.github.com>
Date: Mon, 9 Feb 2026 14:19:02 +0800
Subject: [PATCH 169/208] =?UTF-8?q?:art:=20#3876=20=E3=80=90=E4=BC=81?=
=?UTF-8?q?=E4=B8=9A=E5=BE=AE=E4=BF=A1=E3=80=91=E5=AE=A1=E6=89=B9=E8=AF=A6?=
=?UTF-8?q?=E6=83=85=E6=8E=A5=E5=8F=A3=E8=BF=94=E5=9B=9E=E9=87=8C=E7=9A=84?=
=?UTF-8?q?=20ContentValue=20=E6=95=B0=E6=8D=AE=E6=A8=A1=E5=9E=8B=E6=B7=BB?=
=?UTF-8?q?=E5=8A=A0=E4=BA=86=E9=83=A8=E5=88=86=E5=AE=98=E6=96=B9=E6=96=B0?=
=?UTF-8?q?=E5=A2=9E=E5=AD=97=E6=AE=B5?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Co-authored-by: cbxbj
-
-
From b89ff6a5af2d482109f1136f12d385bfb63937ae Mon Sep 17 00:00:00 2001
From: wuKong
+
+
+ * 字段名:商户订单号
+ * 是否必填:是
+ * 描述:
+ * 投诉单关联的商户订单号
+ *
+ */
+ @SerializedName("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 字段名:投诉时间
+ * 是否必填:是
+ * 描述:投诉时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,
+ * T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。
+ * 例如:2015-05-20T13:29:35.120+08:00表示北京时间2015年05月20日13点29分35秒
+ * 示例值:2015-05-20T13:29:35.120+08:00
+ *
+ */
+ @SerializedName("complaint_time")
+ private String complaintTime;
+
+ /**
+ *
+ * 字段名:订单金额
+ * 是否必填:是
+ * 描述:
+ * 订单金额,单位(分)
+ *
+ */
+ @SerializedName("amount")
+ private Integer amount;
+
+ /**
+ *
+ * 字段名:投诉人联系方式
+ * 是否必填:否
+ * 投诉人联系方式。该字段已做加密处理,具体解密方法详见敏感信息加密说明。
+ *
+ */
+ @SerializedName("payer_phone")
+ @SpecEncrypt
+ private String payerPhone;
+
+ /**
+ *
+ * 字段名:投诉详情
+ * 是否必填:是
+ * 投诉的具体描述
+ *
+ */
+ @SerializedName("complaint_detail")
+ private String complaintDetail;
+
+ /**
+ *
+ * 字段名:投诉单状态
+ * 是否必填:是
+ * 标识当前投诉单所处的处理阶段,具体状态如下所示:
+ * PENDING:待处理
+ * PROCESSING:处理中
+ * PROCESSED:已处理完成
+ *
+ */
+ @SerializedName("complaint_state")
+ private String complaintState;
+
+ /**
+ *
+ * 字段名:微信订单号
+ * 是否必填:是
+ * 描述:
+ * 投诉单关联的微信订单号
+ *
+ */
+ @SerializedName("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 字段名:商户处理状态
+ * 是否必填:是
+ * 描述:
+ * 触发本次投诉通知回调的具体动作类型,枚举如下:
+ * 常规通知:
+ * CREATE_COMPLAINT:用户提交投诉
+ * CONTINUE_COMPLAINT:用户继续投诉
+ * USER_RESPONSE:用户新留言
+ * RESPONSE_BY_PLATFORM:平台新留言
+ * SELLER_REFUND:商户发起全额退款
+ * MERCHANT_RESPONSE:商户新回复
+ * MERCHANT_CONFIRM_COMPLETE:商户反馈处理完成
+ * USER_APPLY_PLATFORM_SERVICE:用户申请平台协助
+ * USER_CANCEL_PLATFORM_SERVICE:用户取消平台协助
+ * PLATFORM_SERVICE_FINISHED:客服结束平台协助
+ *
+ * 申请退款单的附加通知:
+ * 以下通知会更新投诉单状态,建议收到后查询投诉单详情。
+ * MERCHANT_APPROVE_REFUND:商户同意退款
+ * MERCHANT_REJECT_REFUND:商户驳回退款
+ * REFUND_SUCCESS:退款到账
+ *
+ */
+ @SerializedName("complaint_handle_state")
+ private String complaintHandleState;
}
}
From 5ff4114b6c045b50925642b738f84761bb182500 Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Sat, 28 Feb 2026 16:53:17 +0800
Subject: [PATCH 172/208] =?UTF-8?q?:art:=20#3886=20=E3=80=90=E4=BC=81?=
=?UTF-8?q?=E4=B8=9A=E5=BE=AE=E4=BF=A1=E3=80=91=E5=AE=A2=E6=9C=8D=E6=B6=88?=
=?UTF-8?q?=E6=81=AF=E6=96=B0=E5=A2=9E=E8=A7=86=E9=A2=91=E5=8F=B7=E6=B6=88?=
=?UTF-8?q?=E6=81=AF=E7=B1=BB=E5=9E=8B=EF=BC=88channels=EF=BC=89=E6=94=AF?=
=?UTF-8?q?=E6=8C=81?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../weixin/cp/bean/kf/WxCpKfMsgListResp.java | 1 +
.../cp/bean/kf/msg/WxCpKfChannelsMsg.java | 52 +++++++++++++++++++
2 files changed, 53 insertions(+)
create mode 100644 weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfChannelsMsg.java
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfMsgListResp.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfMsgListResp.java
index f8f3275c46..a165c1c4cd 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfMsgListResp.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfMsgListResp.java
@@ -67,6 +67,7 @@ public static class WxCpKfMsgItem {
private WxCpKfChannelsShopProductMsg channelsShopProduct;
@SerializedName("channels_shop_order")
private WxCpKfChannelsShopOrderMsg channelsShopOrder;
+ private WxCpKfChannelsMsg channels;
}
/**
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfChannelsMsg.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfChannelsMsg.java
new file mode 100644
index 0000000000..db23c222f5
--- /dev/null
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/msg/WxCpKfChannelsMsg.java
@@ -0,0 +1,52 @@
+package me.chanjar.weixin.cp.bean.kf.msg;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * 视频号消息
+ *
+ * @author liuzhao created on 2024/2/25
+ */
+@NoArgsConstructor
+@Data
+public class WxCpKfChannelsMsg {
+
+ /**
+ * 视频号名称
+ */
+ @SerializedName("nickname")
+ private String nickname;
+
+ /**
+ * 视频/直播标题
+ */
+ @SerializedName("title")
+ private String title;
+
+ /**
+ * 视频/直播描述
+ */
+ @SerializedName("desc")
+ private String desc;
+
+ /**
+ * 封面图片url
+ */
+ @SerializedName("cover_url")
+ private String coverUrl;
+
+ /**
+ * 视频/直播链接
+ */
+ @SerializedName("url")
+ private String url;
+
+ /**
+ * 视频号账号名称
+ */
+ @SerializedName("find_username")
+ private String findUsername;
+
+}
From 3233384b17433de9c265cda32b1f6dcdbb449bf2 Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Sat, 28 Feb 2026 16:55:43 +0800
Subject: [PATCH 173/208] =?UTF-8?q?:art:=20#3880=20=E3=80=90=E4=BC=81?=
=?UTF-8?q?=E4=B8=9A=E5=BE=AE=E4=BF=A1=E3=80=91=E4=BF=AE=E5=A4=8DMemChange?=
=?UTF-8?q?List=E7=BE=A4=E6=88=90=E5=91=98=E5=8F=98=E6=9B=B4ID=E8=A7=A3?=
=?UTF-8?q?=E6=9E=90=E4=B8=BA=E7=A9=BA=E5=AD=97=E7=AC=A6=E4=B8=B2=E7=9A=84?=
=?UTF-8?q?=E9=97=AE=E9=A2=98?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../util/xml/XStreamCDataListConverter.java | 54 +++++++++++++++++++
.../cp/bean/message/WxCpXmlMessage.java | 3 +-
.../cp/bean/message/WxCpXmlMessageTest.java | 48 +++++++++++++++++
3 files changed, 104 insertions(+), 1 deletion(-)
create mode 100644 weixin-java-common/src/main/java/me/chanjar/weixin/common/util/xml/XStreamCDataListConverter.java
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/xml/XStreamCDataListConverter.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/xml/XStreamCDataListConverter.java
new file mode 100644
index 0000000000..0b55a9c037
--- /dev/null
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/xml/XStreamCDataListConverter.java
@@ -0,0 +1,54 @@
+package me.chanjar.weixin.common.util.xml;
+
+import com.thoughtworks.xstream.converters.Converter;
+import com.thoughtworks.xstream.converters.MarshallingContext;
+import com.thoughtworks.xstream.converters.UnmarshallingContext;
+import com.thoughtworks.xstream.io.HierarchicalStreamReader;
+import com.thoughtworks.xstream.io.HierarchicalStreamWriter;
+
+/**
+ * 兼容两种格式的字符串列表转换器:
+ *
+ *
+ * 解析结果统一为逗号分隔的字符串。
+ */
+public class XStreamCDataListConverter implements Converter {
+
+ @Override
+ public void marshal(Object source, HierarchicalStreamWriter writer, MarshallingContext context) {
+ if (source != null) {
+ writer.setValue("");
+ }
+ }
+
+ @Override
+ public Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context) {
+ if (reader.hasMoreChildren()) {
+ // 新格式:含有