com.github.binarywang.wxpay.bean.notify.WxPayOrderNotifyResult Maven / Gradle / Ivy
The newest version!
package com.github.binarywang.wxpay.bean.notify;
import com.github.binarywang.wxpay.bean.result.BaseWxPayResult;
import com.github.binarywang.wxpay.constant.WxPayConstants;
import com.github.binarywang.wxpay.converter.WxPayOrderNotifyResultConverter;
import com.github.binarywang.wxpay.exception.WxPayException;
import com.github.binarywang.wxpay.service.WxPayService;
import com.github.binarywang.wxpay.util.SignUtils;
import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
import me.chanjar.weixin.common.util.json.WxGsonBuilder;
import me.chanjar.weixin.common.util.xml.XStreamInitializer;
import org.w3c.dom.Document;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
/**
* 支付结果通知.
* 文档见：https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_7&index=8
* https://pay.weixin.qq.com/wiki/doc/api/external/native.php?chapter=9_7
*
* @author aimilin6688
* @since 2.5.0
*/
@Data
@EqualsAndHashCode(callSuper = true)
@NoArgsConstructor
@XStreamAlias("xml")
public class WxPayOrderNotifyResult extends BaseWxPayResult implements Serializable {
private static final long serialVersionUID = 5389718115223345496L;
/**
*
* 字段名：营销详情.
* 变量名：promotion_detail
* 是否必填：否，单品优惠才有
* 类型：String(6000)
* 示例值：[{"promotion_detail":[{"promotion_id":"109519","name":"单品惠-6","scope":"SINGLE","type":"DISCOUNT","amount":5,"activity_id":"931386","wxpay_contribute":0,"merchant_contribute":0,"other_contribute":5,"goods_detail":[{"goods_id":"a_goods1","goods_remark":"商品备注","quantity":7,"price":1,"discount_amount":4},{"goods_id":"a_goods2","goods_remark":"商品备注","quantity":1,"price":2,"discount_amount":1}]}]}
* 描述：单品优惠专用参数，详见https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_203&index=4
*
*/
@XStreamAlias("promotion_detail")
private String promotionDetail;
/**
*
* 字段名：设备号.
* 变量名：device_info
* 是否必填：否
* 类型：String(32)
* 示例值：013467007045764
* 描述：微信支付分配的终端设备号，
*
*/
@XStreamAlias("device_info")
private String deviceInfo;
/**
*
* 字段名：用户标识.
* 变量名：openid
* 是否必填：是
* 类型：String(128)
* 示例值：wxd930ea5d5a258f4f
* 描述：用户在商户appid下的唯一标识
*
*/
@XStreamAlias("openid")
private String openid;
/**
*
* 字段名：是否关注公众账号.
* 变量名：is_subscribe
* 是否必填：否
* 类型：String(1)
* 示例值：Y
* 描述：用户是否关注公众账号，Y-关注，N-未关注，仅在公众账号类型支付有效
*
*/
@XStreamAlias("is_subscribe")
private String isSubscribe;
/**
*
* 字段名：用户子标识.
* 变量名：sub_openid
* 是否必填：是
* 类型：String(128)
* 示例值：wxd930ea5d5a258f4f
* 描述：用户在子商户appid下的唯一标识
*
*/
@XStreamAlias("sub_openid")
private String subOpenid;
/**
*
* 字段名：是否关注子公众账号.
* 变量名：sub_is_subscribe
* 是否必填：否
* 类型：String(1)
* 示例值：Y
* 描述：用户是否关注子公众账号，Y-关注，N-未关注，仅在公众账号类型支付有效
*
*/
@XStreamAlias("sub_is_subscribe")
private String subIsSubscribe;
/**
*
* 字段名：交易类型.
* 变量名：trade_type
* 是否必填：是
* 类型：String(16)
* 示例值：JSAPI
* 描述：JSAPI、NATIVE、APP
*
*/
@XStreamAlias("trade_type")
private String tradeType;
/**
*
* 字段名：付款银行.
* 变量名：bank_type
* 是否必填：是
* 类型：String(16)
* 示例值：CMC
* 描述：银行类型，采用字符串类型的银行标识，银行类型见银行列表
*
*/
@XStreamAlias("bank_type")
private String bankType;
/**
*
* 字段名：订单金额.
* 变量名：total_fee
* 是否必填：是
* 类型：Int
* 示例值：100
* 描述：订单总金额，单位为分
*
*/
@XStreamAlias("total_fee")
private Integer totalFee;
/**
*
* 字段名：应结订单金额.
* 变量名：settlement_total_fee
* 是否必填：否
* 类型：Int
* 示例值：100
* 描述：应结订单金额=订单金额-非充值代金券金额，应结订单金额<=订单金额。
*
*/
@XStreamAlias("settlement_total_fee")
private Integer settlementTotalFee;
/**
*
* 字段名：货币种类.
* 变量名：fee_type
* 是否必填：否
* 类型：String(8)
* 示例值：CNY
* 描述：货币类型，符合ISO4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
*
*/
@XStreamAlias("fee_type")
private String feeType;
/**
*
* 字段名：现金支付金额.
* 变量名：cash_fee
* 是否必填：是
* 类型：Int
* 示例值：100
* 描述：现金支付金额订单现金支付金额，详见支付金额
*
*/
@XStreamAlias("cash_fee")
private Integer cashFee;
/**
*
* 字段名：现金支付货币类型.
* 变量名：cash_fee_type
* 是否必填：否
* 类型：String(16)
* 示例值：CNY
* 描述：货币类型，符合ISO4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
*
*/
@XStreamAlias("cash_fee_type")
private String cashFeeType;
/**
*
* 字段名：总代金券金额.
* 变量名：coupon_fee
* 是否必填：否
* 类型：Int
* 示例值：10
* 描述：代金券金额<=订单金额，订单金额-代金券金额=现金支付金额，详见支付金额
*
*/
@XStreamAlias("coupon_fee")
private Integer couponFee;
/**
*
* 字段名：代金券使用数量.
* 变量名：coupon_count
* 是否必填：否
* 类型：Int
* 示例值：1
* 描述：代金券使用数量
*
*/
@XStreamAlias("coupon_count")
private Integer couponCount;
private List couponList;
/**
*
* 字段名：微信支付订单号.
* 变量名：transaction_id
* 是否必填：是
* 类型：String(32)
* 示例值：1217752501201407033233368018
* 描述：微信支付订单号
*
*/
@XStreamAlias("transaction_id")
private String transactionId;
/**
*
* 字段名：商户订单号.
* 变量名：out_trade_no
* 是否必填：是
* 类型：String(32)
* 示例值：1212321211201407033568112322
* 描述：商户系统的订单号，与请求一致。
*
*/
@XStreamAlias("out_trade_no")
private String outTradeNo;
/**
*
* 字段名：商家数据包.
* 变量名：attach
* 是否必填：否
* 类型：String(128)
* 示例值：123456
* 描述：商家数据包，原样返回
*
*/
@XStreamAlias("attach")
private String attach;
/**
*
* 字段名：支付完成时间.
* 变量名：time_end
* 是否必填：是
* 类型：String(14)
* 示例值：20141030133525
* 描述：支付完成时间，格式为yyyyMMddHHmmss，如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则
*
*/
@XStreamAlias("time_end")
private String timeEnd;
/**
*
* 字段名：接口版本号.
* 变量名：version
* 类型：String(32)
* 示例值：1.0
* 更多信息，详见文档：https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_101&index=1
*
*/
@XStreamAlias("version")
private String version;
/**
*
* 字段名：汇率.
* 变量名：rate_value
* 类型：String(16)
* 示例值：650000000
* 标价币种与支付币种的兑换比例乘以10的8次方即为此值，例如美元兑换人民币的比例为6.5，则rate_value=650000000
*
*/
@XStreamAlias("rate_value")
private String rateValue;
/**
*
* 字段名：签名类型.
* 变量名：sign_type
* 类型：String(32)
* 示例值：HMAC-SHA256
* 签名类型，目前支持HMAC-SHA256和MD5，默认为MD5
*
*/
@XStreamAlias("sign_type")
private String signType;
@Override
public void checkResult(WxPayService wxPayService, String signType, boolean checkSuccess) throws WxPayException {
//防止伪造成功通知
if (WxPayConstants.ResultCode.SUCCESS.equals(getReturnCode()) && getSign() == null) {
throw new WxPayException("伪造的通知！");
}
super.checkResult(wxPayService, signType, checkSuccess);
}
/**
* From xml wx pay order notify result.
*
* @param xmlString the xml string
* @return the wx pay order notify result
*/
public static WxPayOrderNotifyResult fromXML(String xmlString) {
XStream xstream = XStreamInitializer.getInstance();
xstream.processAnnotations(WxPayOrderNotifyResult.class);
xstream.registerConverter(new WxPayOrderNotifyResultConverter(xstream.getMapper(), xstream.getReflectionProvider()));
WxPayOrderNotifyResult result = (WxPayOrderNotifyResult) xstream.fromXML(xmlString);
result.setXmlString(xmlString);
return result;
}
@Override
public Map toMap() {
Map resultMap = SignUtils.xmlBean2Map(this);
if (this.getCouponCount() != null && this.getCouponCount() > 0) {
for (int i = 0; i < this.getCouponCount(); i++) {
WxPayOrderNotifyCoupon coupon = couponList.get(i);
resultMap.putAll(coupon.toMap(i));
}
}
return resultMap;
}
@Override
protected void loadXml(Document d) {
promotionDetail = readXmlString(d, "promotion_detail");
deviceInfo = readXmlString(d, "device_info");
openid = readXmlString(d, "openid");
isSubscribe = readXmlString(d, "is_subscribe");
subOpenid = readXmlString(d, "sub_openid");
subIsSubscribe = readXmlString(d, "sub_is_subscribe");
tradeType = readXmlString(d, "trade_type");
bankType = readXmlString(d, "bank_type");
totalFee = readXmlInteger(d, "total_fee");
settlementTotalFee = readXmlInteger(d, "settlement_total_fee");
feeType = readXmlString(d, "fee_type");
cashFee = readXmlInteger(d, "cash_fee");
cashFeeType = readXmlString(d, "cash_fee_type");
couponFee = readXmlInteger(d, "coupon_fee");
couponCount = readXmlInteger(d, "coupon_count");
transactionId = readXmlString(d, "transaction_id");
outTradeNo = readXmlString(d, "out_trade_no");
attach = readXmlString(d, "attach");
timeEnd = readXmlString(d, "time_end");
version = readXmlString(d, "version");
rateValue = readXmlString(d, "rate_value");
signType = readXmlString(d, "sign_type");
composeCoupons();
}
/**
* 通过xml组装couponList属性内容.
*/
protected void composeCoupons() {
if (this.couponCount == null || this.couponCount == 0) {
return;
}
this.couponList = new ArrayList(couponCount);
for (int i = 0; i < this.couponCount; i++) {
WxPayOrderNotifyCoupon coupon = new WxPayOrderNotifyCoupon();
coupon.setCouponId(this.getXmlValue("xml/coupon_id_" + i));
coupon.setCouponType(this.getXmlValue("xml/coupon_type_" + i));
coupon.setCouponFee(this.getXmlValueAsInt("xml/coupon_fee_" + i));
couponList.add(coupon);
}
}
@Override
public String toString() {
return WxGsonBuilder.create().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy