com.github.binarywang.wxpay.bean.request

类 BaseWxPayRequest

java.lang.Object

com.github.binarywang.wxpay.bean.request.BaseWxPayRequest

所有已实现的接口:

Serializable

直接已知子类:

EntPayBankRequest, EntPayQueryRequest, EntPayRedpackQueryRequest, EntPayRedpackRequest, EntPayRequest, EntWxEmpPayRequest, ProfitSharingMerchantRatioQueryRequest, ProfitSharingOrderAmountQueryRequest, ProfitSharingQueryRequest, ProfitSharingReceiverRequest, ProfitSharingRequest, ProfitSharingReturnQueryRequest, ProfitSharingReturnRequest, ProfitSharingUnfreezeRequest, WxH5EntrustRequest, WxMaEntrustRequest, WxMpEntrustRequest, WxPayAuthcode2OpenidRequest, WxPayCouponInfoQueryRequest, WxPayCouponSendRequest, WxPayCouponStockQueryRequest, WxPayDefaultRequest, WxPayDownloadBillRequest, WxPayDownloadFundFlowRequest, WxPayEntrustRequest, WxPayFaceAuthInfoRequest, WxPayFacepayRequest, WxPayMicropayRequest, WxPayOrderCloseRequest, WxPayOrderQueryRequest, WxPayOrderReverseRequest, WxPayQueryCommentRequest, WxPayQueryExchangeRateRequest, WxPayRedpackQueryRequest, WxPayRefundQueryRequest, WxPayRefundRequest, WxPayReportRequest, WxPaySendMiniProgramRedpackRequest, WxPaySendRedpackRequest, WxPayShorturlRequest, WxPayUnifiedOrderRequest, WxSignQueryRequest, WxTerminatedContractRequest, WxWithholdOrderQueryRequest, WxWithholdRequest

public abstract class BaseWxPayRequest
extends Object
implements Serializable

  微信支付请求对象共用的参数存放类
 Created by Binary Wang on 2016-10-24.
 

作者:

Binary Wang

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
protected String	appid 字段名：公众账号ID.
protected String	mchId 字段名：商户号.
protected String	nonceStr 字段名：随机字符串.
protected String	sign 字段名：签名.
protected String	subAppId 字段名：服务商模式下的子商户公众账号ID.
protected String	subMchId 字段名：服务商模式下的子商户号.

构造器概要

构造器

构造器和说明
BaseWxPayRequest()

方法概要

限定符和类型	方法和说明
void	checkAndSign(WxPayConfig config) 检查参数，并设置签名. 1、检查参数（注意：子类实现需要检查参数的而外功能时，请在调用父类的方法前进行相应判断） 2、补充系统参数，如果未传入则从配置里读取 3、生成签名，并设置进去
protected abstract void	checkConstraints() 检查约束情况.
static BigDecimal	fen2Yuan(BigDecimal fen) 分转元
protected String[]	getIgnoredParamsForSign() 签名时，忽略的参数.
Map<String,String>	getSignParams() 获取签名时需要的参数.
String	getWorkWxSign()
protected boolean	ignoreAppid() 签名时，是否忽略appid.
protected boolean	ignoreSubAppId() 签名时，是否忽略sub_appid.
protected boolean	ignoreSubMchId()
protected boolean	isWxWorkSign() 是否是企业微信字段
protected boolean	needNonceStr() 是否需要nonce_str
void	setAppid(String appid) 如果配置中已经设置，可以不设置值.
void	setMchId(String mchId) 如果配置中已经设置，可以不设置值.
void	setNonceStr(String nonceStr) 默认采用时间戳为随机字符串，可以不设置.
void	setWorkWxSign(String workWxSign)
protected abstract void	storeMap(Map<String,String> map) 将属性组装到一个Map中，供签名和最终发送XML时使用.
String	toString()
String	toXML() To xml string.
protected String	xmlRootTagName() 返回xml结构的根节点名称
static Integer	yuan2Fen(BigDecimal yuan) 元转分
static Integer	yuanToFen(String yuan) 将单位为元转换为单位为分.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料

appid

protected String appid

 字段名：公众账号ID.
 变量名：appid
 是否必填：是
 类型：String(32)
 示例值：wxd678efh567hg6787
 描述：微信分配的公众账号ID（企业号corpid即为此appId）
 

mchId

protected String mchId

 字段名：商户号.
 变量名：mch_id
 是否必填：是
 类型：String(32)
 示例值：1230000109
 描述：微信支付分配的商户号
 

subAppId

protected String subAppId

 字段名：服务商模式下的子商户公众账号ID.
 变量名：sub_appid
 是否必填：是
 类型：String(32)
 示例值：wxd678efh567hg6787
 描述：微信分配的子商户公众账号ID
 

subMchId

protected String subMchId

 字段名：服务商模式下的子商户号.
 变量名：sub_mch_id
 是否必填：是
 类型：String(32)
 示例值：1230000109
 描述：微信支付分配的子商户号，开发者模式下必填
 

nonceStr

protected String nonceStr

 字段名：随机字符串.
 变量名：nonce_str
 是否必填：是
 类型：String(32)
 示例值：5K8264ILTKCH16CQ2502SI8ZNMTM67VS
 描述：随机字符串，不长于32位。推荐随机数生成算法
 

sign

protected String sign

 字段名：签名.
 变量名：sign
 是否必填：是
 类型：String(32)
 示例值：C380BEC2BFD727A4B6845133519F3AD6
 描述：签名，详见签名生成算法
 

构造器详细资料

BaseWxPayRequest

public BaseWxPayRequest()

方法详细资料

getWorkWxSign

public String getWorkWxSign()

setWorkWxSign

public void setWorkWxSign(String workWxSign)

yuanToFen

public static Integer yuanToFen(String yuan)

将单位为元转换为单位为分.

参数:

yuan - 将要转换的元的数值字符串

返回:

the integer

yuan2Fen

public static Integer yuan2Fen(BigDecimal yuan)

元转分

fen2Yuan

public static BigDecimal fen2Yuan(BigDecimal fen)

分转元

checkConstraints

protected abstract void checkConstraints()
                                  throws WxPayException

检查约束情况.

抛出:

WxPayException - the wx pay exception

needNonceStr

protected boolean needNonceStr()

是否需要nonce_str

setAppid

public void setAppid(String appid)

如果配置中已经设置，可以不设置值.

参数:

appid - 微信公众号appid

setMchId

public void setMchId(String mchId)

如果配置中已经设置，可以不设置值.

参数:

mchId - 微信商户号

setNonceStr

public void setNonceStr(String nonceStr)

默认采用时间戳为随机字符串，可以不设置.

参数:

nonceStr - 随机字符串

toString

public String toString()

覆盖:

toString 在类中 Object

toXML

public String toXML()

To xml string.

返回:

the string

xmlRootTagName

protected String xmlRootTagName()

返回xml结构的根节点名称

返回:

默认返回"xml", 特殊情况可以在子类中覆盖

ignoreAppid

protected boolean ignoreAppid()

签名时，是否忽略appid.

返回:

the boolean

ignoreSubAppId

protected boolean ignoreSubAppId()

签名时，是否忽略sub_appid.

返回:

the boolean

ignoreSubMchId

protected boolean ignoreSubMchId()

isWxWorkSign

protected boolean isWxWorkSign()

是否是企业微信字段

getIgnoredParamsForSign

protected String[] getIgnoredParamsForSign()

签名时，忽略的参数.

返回:

the string [ ]

getSignParams

public Map<String,String> getSignParams()

获取签名时需要的参数. 注意：不含sign属性

storeMap

protected abstract void storeMap(Map<String,String> map)

将属性组装到一个Map中，供签名和最终发送XML时使用. 这里需要将所有的属性全部保存进来，签名的时候会自动调用getIgnoredParamsForSign进行忽略， 不用担心。否则最终生成的XML会缺失。

参数:

map - 传入的属性Map

checkAndSign

public void checkAndSign(WxPayConfig config)
                  throws WxPayException

 检查参数，并设置签名.
 1、检查参数（注意：子类实现需要检查参数的而外功能时，请在调用父类的方法前进行相应判断）
 2、补充系统参数，如果未传入则从配置里读取
 3、生成签名，并设置进去
 

参数:

config - 支付配置对象，用于读取相应系统配置信息

抛出:

WxPayException - the wx pay exception