com.github.binarywang.wxpay.bean.request

类 WxPayBaseRequest

java.lang.Object

com.github.binarywang.wxpay.bean.request.WxPayBaseRequest

直接已知子类:

WxEntPayQueryRequest, WxEntPayRequest, WxPayAuthcode2OpenidRequest, WxPayCouponInfoQueryRequest, WxPayCouponSendRequest, WxPayCouponStockQueryRequest, WxPayDefaultRequest, WxPayDownloadBillRequest, WxPayMicropayRequest, WxPayOrderCloseRequest, WxPayOrderQueryRequest, WxPayOrderReverseRequest, WxPayRedpackQueryRequest, WxPayRefundQueryRequest, WxPayRefundRequest, WxPayReportRequest, WxPaySendRedpackRequest, WxPayShorturlRequest, WxPayUnifiedOrderRequest

public abstract class WxPayBaseRequest
extends Object

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

作者:

binarywang(Binary Wang)

字段概要

字段

限定符和类型	字段和说明
protected String	appid 字段名：公众账号ID 变量名：appid 是否必填：是 类型：String(32) 示例值：wxd678efh567hg6787 描述：微信分配的公众账号ID（企业号corpid即为此appId）
protected String	mchId 字段名：商户号 变量名：mch_id 是否必填：是 类型：String(32) 示例值：1230000109 描述：微信支付分配的商户号
protected String	nonceStr 字段名：随机字符串 变量名：nonce_str 是否必填：是 类型：String(32) 示例值：5K8264ILTKCH16CQ2502SI8ZNMTM67VS 描述：随机字符串，不长于32位。
protected String	sign 字段名：签名 变量名：sign 是否必填：是 类型：String(32) 示例值：C380BEC2BFD727A4B6845133519F3AD6 描述：签名，详见签名生成算法
protected String	subAppId 字段名：服务商模式下的子商户公众账号ID 变量名：sub_appid 是否必填：是 类型：String(32) 示例值：wxd678efh567hg6787 描述：微信分配的子商户公众账号ID
protected String	subMchId 字段名：服务商模式下的子商户号 变量名：sub_mch_id 是否必填：是 类型：String(32) 示例值：1230000109 描述：微信支付分配的子商户号，开发者模式下必填

构造器概要

构造器

构造器和说明
WxPayBaseRequest()

方法概要

限定符和类型	方法和说明
void	checkAndSign(WxPayConfig config) 检查参数，并设置签名 1、检查参数（注意：子类实现需要检查参数的而外功能时，请在调用父类的方法前进行相应判断） 2、补充系统参数，如果未传入则从配置里读取 3、生成签名，并设置进去
protected abstract void	checkConstraints() 检查约束情况
protected void	checkFields() 检查请求参数内容，包括必填参数以及特殊约束
String	getAppid()
String	getMchId()
String	getNonceStr()
String	getSign()
String	getSubAppId()
String	getSubMchId()
void	setAppid(String appid) 如果配置中已经设置，可以不设置值
void	setMchId(String mchId) 如果配置中已经设置，可以不设置值
void	setNonceStr(String nonceStr) 默认采用时间戳为随机字符串，可以不设置
void	setSign(String sign)
void	setSubAppId(String subAppId)
void	setSubMchId(String subMchId)
String	toString()
String	toXML()
static Integer	yuanToFee(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
 描述：签名，详见签名生成算法
 

构造器详细资料

WxPayBaseRequest

public WxPayBaseRequest()

方法详细资料

yuanToFee

public static Integer yuanToFee(String yuan)

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

参数:

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

checkFields

protected void checkFields()
                    throws WxPayException

检查请求参数内容，包括必填参数以及特殊约束

抛出:

WxPayException

checkConstraints

protected abstract void checkConstraints()
                                  throws WxPayException

检查约束情况

抛出:

WxPayException

getAppid

public String getAppid()

setAppid

public void setAppid(String appid)

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

参数:

appid - 微信公众号appid

getMchId

public String getMchId()

setMchId

public void setMchId(String mchId)

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

参数:

mchId - 微信商户号

getNonceStr

public String getNonceStr()

setNonceStr

public void setNonceStr(String nonceStr)

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

参数:

nonceStr - 随机字符串

getSign

public String getSign()

setSign

public void setSign(String sign)

getSubAppId

public String getSubAppId()

setSubAppId

public void setSubAppId(String subAppId)

getSubMchId

public String getSubMchId()

setSubMchId

public void setSubMchId(String subMchId)

toString

public String toString()

覆盖:

toString 在类中 Object

toXML

public String toXML()

checkAndSign

public void checkAndSign(WxPayConfig config)
                  throws WxPayException

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

参数:

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

抛出:

WxPayException