PlayerWX (commons-weixin 1.0.0.RELEASE API)

java.lang.Object
- com.cloud.boot.weixin.PlayerWX

```
public class PlayerWX
extends Object
```
微信相关类

版本:

1.0 2016年11月23日

作者:

Mr-Wu

另请参阅:

需要配置 weixinpay.properties 文件,放在resources下面文件属性:{ *weixinpay.appid = appid *weixinpay.mchid = mchid商户号 *weixinpay.key = 商户key *weixinpay.domain = 项目访问域名 weixinpay.notityUrl = 回调地址 weixinpay.certificateKey = 证书密码 weixinpay.certificateFile = 证书地址 } need jar{ org.springframeworkspring-context-support4.2.6.RELEASE org.apache.logging.log4jlog4j-core2.5 redis.clientsjedis2.8.1 org.springframework.dataspring-data-redis1.7.1.RELEASE com.alibabafastjson1.2.11 org.apache.httpcomponentshttpclient4.3.5 com.thoughtworks.xstreamxstream1.4.7 }

字段概要

字段
限定符和类型字段和说明

private static PlayerWX playerWX

private WXInfo wxInfo

字段
限定符和类型	字段和说明
`private static PlayerWX`	`playerWX`
`private WXInfo`	`wxInfo`

构造器概要

构造器
限定符构造器和说明

private PlayerWX(WXInfo wxInfo)

构造器
限定符	构造器和说明
`private`	`PlayerWX(WXInfo wxInfo)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`com.cloud.boot.util.datawrap.ResultDataWrap`	`closeOrder(String out_trade_no)` 关闭订单
`com.cloud.boot.util.datawrap.ResultDataWrap`	`downloadBill(String bill_date, String bill_type, String tar_type)` 下载对账单(参数四选一)
`WXAuthorization`	`getAccessToken(String code)` 获取网页授权access_token
`String`	`getBasicsAccessToken()` 获取普通access_token
`static PlayerWX`	`getInstance()` 初始化PlayerWX
`static PlayerWX`	`getInstance(String properties)` 带指定读取配置文件初始化PlayerWX
`WXAuthorizationUser`	`getUserInfo(String access_token, String openid)` 通过网页授权access_token获取用户信息
`WXInfo`	`getWxInfo()`
`com.cloud.boot.util.datawrap.ResultDataWrap`	`pay(Map<String,Object> paramsMap, boolean nativeReturn, String logoPath)` 微信支付
`com.cloud.boot.util.datawrap.ResultDataWrap`	`pay(WXPayInfo wxPayInfo, boolean nativeReturn, String logoPath)` 微信支付注意：需要先调用构建微信支付对象方法
`com.cloud.boot.util.datawrap.ResultDataWrap`	`queryRefund(String transaction_id, String out_trade_no, String out_refund_no, String refund_id)` 查询退款详情(参数四选一)
`com.cloud.boot.util.datawrap.ResultDataWrap`	`queryWXOrderInfo(String transaction_id, String out_trade_no)` 查询订单
`com.cloud.boot.util.datawrap.ResultDataWrap`	`refund(String transaction_id, String out_trade_no, String out_refund_no, int total_fee, int refund_fee, String op_user_id)` 商户提交退款申请(微信订单号和商户订单号任选其一,如果都传微信订单号优先)
`Object`	`returnFail()` 通知微信失败了
`Object`	`returnSuccess()` 通知微信成功了
`com.cloud.boot.util.datawrap.ResultDataWrap`	`sendredpack(Map<String,Object> paramsMap)` 企业发红包给用户
`void`	`setNotityUrl(String url)` 设置回调地址
`com.cloud.boot.util.datawrap.ResultDataWrap`	`transfers(Map<String,Object> paramsMap)` 企业付款给用户
`Map<String,Object>`	`valiPayLegitimate()` 微信付款成功,调用该方法验证签名等信息微信返回数据(不要做任何处理)
`WXPayInfo`	`wxPayInfo(String device_info, String body, String detail, String attach, String out_trade_no, int total_fee, String spbill_create_ip, String notify_url, String trade_type, String time_start, String time_expire, String goods_tag, String product_id, String openid)` 构建微信支付对象

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - playerWX
```
private static volatile PlayerWX playerWX
```
  - wxInfo
```
private WXInfo wxInfo
```
- 构造器详细资料
  - PlayerWX
```
private PlayerWX(WXInfo wxInfo)
```
- 方法详细资料
  - getWxInfo
```
public WXInfo getWxInfo()
```
  - getInstance
```
public static PlayerWX getInstance()
```
    初始化PlayerWX
  - getInstance
```
public static PlayerWX getInstance(String properties)
```
    带指定读取配置文件初始化PlayerWX
  - setNotityUrl
```
public void setNotityUrl(String url)
```
    设置回调地址
  - getBasicsAccessToken
```
public String getBasicsAccessToken()
                            throws com.cloud.boot.exception.ExceptionRedisInvalid
```
    获取普通access_token
    
    抛出:
    
    com.cloud.boot.exception.ExceptionRedisInvalid
  - getAccessToken
```
public WXAuthorization getAccessToken(String code)
```
    获取网页授权access_token
  - getUserInfo
```
public WXAuthorizationUser getUserInfo(String access_token,
                                       String openid)
```
    通过网页授权access_token获取用户信息
  - wxPayInfo
```
public WXPayInfo wxPayInfo(String device_info,
                           String body,
                           String detail,
                           String attach,
                           String out_trade_no,
                           int total_fee,
                           String spbill_create_ip,
                           String notify_url,
                           String trade_type,
                           String time_start,
                           String time_expire,
                           String goods_tag,
                           String product_id,
                           String openid)
```
    构建微信支付对象
    
    参数:
    
    device_info - 设备(N) maxLength:32
    
    body - 内容(Y) maxLength:128
    
    detail - 详情(N) maxLength:6000
    
    attach - 附加数据(N) maxLength:127
    
    out_trade_no - 商户订单号(Y) maxLength:32
    
    total_fee - 总金额(Y) 单位:分
    
    spbill_create_ip - 用户ip(Y) maxLength:16
    
    notify_url - 异步回调地址(Y) maxLength:256 不可携带任何参数
    
    trade_type - 交易类型(Y) maxLength:16 JSAPI(公众号支付)NATIVE(原生扫码支付)APP(app支付)
    
    time_start - 交易起始时间(N) maxLength:14 订单生成时间，格式为yyyyMMddHHmmss，如2009年12月25日9点10分10秒表示为20091225091010
    
    time_expire - 交易结束时间(N) maxLength:14 订单失效时间，格式为yyyyMMddHHmmss，如2009年12月27日9点10分10秒表示为20091227091010 注意：最短失效时间间隔必须大于5分钟
    
    goods_tag - 商品标记(N) maxLength:32 代金券或立减优惠功能的参数，说明详见代金券或立减优惠(微信文档)
    
    product_id - 商户商品id(trade_type = NATIVE ? Y : N) maxLength:32
    
    openid - 用户表示(trade_type = JSAPI ? Y : N) maxLength:128
    
    返回:
  - pay
```
public com.cloud.boot.util.datawrap.ResultDataWrap pay(Map<String,Object> paramsMap,
                                                       boolean nativeReturn,
                                                       String logoPath)
```
    微信支付
    
    参数:
    
    paramsMap - {
    device_info 设备(N) maxLength:32
    body 内容(Y) maxLength:128
    detail 详情(N) maxLength:6000
    attach 附加数据(N) maxLength:127
    out_trade_no 商户订单号(Y) maxLength:32
    total_fee 总金额(Y) 单位:分
    spbill_create_ip 用户ip(Y) maxLength:16
    notify_url 异步回调地址(Y) maxLength:256 不可携带任何参数
    trade_type 交易类型(Y) maxLength:16 JSAPI(公众号支付)NATIVE(原生扫码支付)APP(app支付)
    time_start 交易起始时间(N) maxLength:14 订单生成时间，格式为yyyyMMddHHmmss，如2009年12月25日9点10分10秒表示为20091225091010
    time_expire 交易结束时间(N) maxLength:14 订单失效时间，格式为yyyyMMddHHmmss，如2009年12月27日9点10分10秒表示为20091227091010 注意：最短失效时间间隔必须大于5分钟
    product_id 商户商品id(trade_type = NATIVE ? Y : N) maxLength:32
    openid 用户表示(trade_type = JSAPI ? Y : N) maxLength:128
    }
    
    nativeReturn - 扫码支付返回类型. 默认false false:返回图片相对路径 true:直接输出图片流
    
    logoPath - 二维码附加logo图片,不传则不加,路径需全路径
    
    返回:
    
    Object
  - pay
```
public com.cloud.boot.util.datawrap.ResultDataWrap pay(WXPayInfo wxPayInfo,
                                                       boolean nativeReturn,
                                                       String logoPath)
```
    微信支付注意：需要先调用构建微信支付对象方法
    
    参数:
    
    wxPayInfo - 微信支付对象
    
    nativeReturn - 扫码支付返回类型. 默认false false:返回图片相对路径 true:直接输出图片流
    
    logoPath - 二维码附加logo图片,不传则不加,路径需全路径
    
    返回:
  - queryWXOrderInfo
```
public com.cloud.boot.util.datawrap.ResultDataWrap queryWXOrderInfo(String transaction_id,
                                                                    String out_trade_no)
```
    查询订单
    
    参数:
    
    transaction_id - 微信订单号(任选其一，微信订单号优先)
    
    out_trade_no - 商户订单号(任选其一，微信订单号优先)
    
    返回:
    
    Object
  - closeOrder
```
public com.cloud.boot.util.datawrap.ResultDataWrap closeOrder(String out_trade_no)
```
    关闭订单
    
    参数:
    
    out_trade_no - 商户订单号
    
    返回:
    
    Object
  - refund
```
public com.cloud.boot.util.datawrap.ResultDataWrap refund(String transaction_id,
                                                          String out_trade_no,
                                                          String out_refund_no,
                                                          int total_fee,
                                                          int refund_fee,
                                                          String op_user_id)
```
    商户提交退款申请(微信订单号和商户订单号任选其一,如果都传微信订单号优先)
    
    参数:
    
    transaction_id - 微信订单号
    
    out_trade_no - 商户订单号
    
    out_refund_no - 退款单号(商户内部标示)
    
    total_fee - 订单金额(单位分)
    
    refund_fee - 退款金额(单位分)
    
    op_user_id - 操作员
    
    返回:
    
    Object
  - queryRefund
```
public com.cloud.boot.util.datawrap.ResultDataWrap queryRefund(String transaction_id,
                                                               String out_trade_no,
                                                               String out_refund_no,
                                                               String refund_id)
```
    查询退款详情(参数四选一)
    
    参数:
    
    transaction_id - 微信订单
    
    out_trade_no - 商户订单号
    
    out_refund_no - 商户退款单号
    
    refund_id - 微信退款单号
    
    返回:
    
    Object
  - downloadBill
```
public com.cloud.boot.util.datawrap.ResultDataWrap downloadBill(String bill_date,
                                                                String bill_type,
                                                                String tar_type)
```
    下载对账单(参数四选一)
    
    参数:
    
    bill_date - (y) 下载对账单的日期，格式：20140603
    
    bill_type - (n) ALL，返回当日所有订单信息，默认值SUCCESS，返回当日成功支付的订单REFUND，返回当日退款订单
    
    tar_type - (n) 非必传参数，固定值：GZIP，返回格式为.gzip的压缩包账单。不传则默认为数据流形式。
    
    返回:
    
    Object
    
    另请参阅:
    
    1、微信侧未成功下单的交易不会出现在对账单中。支付成功后撤销的交易会出现在对账单中，跟原支付单订单号一致，bill_type为REVOKED； 2、微信在次日9点启动生成前一天的对账单，建议商户10点后再获取； 3、对账单中涉及金额的字段单位为“元”。 4、对账单接口只能下载三个月以内的账单。
  - transfers
```
public com.cloud.boot.util.datawrap.ResultDataWrap transfers(Map<String,Object> paramsMap)
```
    企业付款给用户
    
    参数:
    
    paramsMap - {
    device_info 设备(N) maxLength:32
    partner_trade_no 商户订单号(Y) maxLength:32
    openid 用户opedid(Y)
    check_name 效验用户名选项(N) NO_CHECK(默认)：不校验真实姓名 FORCE_CHECK：强校验真实姓名（未实名认证的用户会校验失败，无法转账） OPTION_CHECK：针对已实名认证的用户才校验真实姓名（未实名认证用户不校验，可以转账成功）
    re_user_name 收款人真实姓名(check_name = FORCE_CHECK或OPTION_CHECK ? Y : N)
    amount 企业付款金额(Y) 单位：分
    desc 企业付款描述信息(Y)
    spbill_create_ip ip(Y) }
    
    返回:
    
    Object
  - sendredpack
```
public com.cloud.boot.util.datawrap.ResultDataWrap sendredpack(Map<String,Object> paramsMap)
```
    企业发红包给用户
    
    参数:
    
    paramsMap - {
    send_name 发放者名(Y) maxLength:32
    re_openid 用户openid(Y) maxLength:32
    total_amount 金额(Y) 单位分(Y)
    wishing 红包祝福语(Y)
    client_ip ip(Y)
    act_name 活动名(Y) 单位：分
    remark 备注(Y)
    scene_id ip(Y) 发放红包使用场景，红包金额大于200时必传 PRODUCT_1:商品促销 PRODUCT_2:抽奖 PRODUCT_3:虚拟物品兑奖 PRODUCT_4:企业内部福利 PRODUCT_5:渠道分润 PRODUCT_6:保险回馈 PRODUCT_7:彩票派奖 PRODUCT_8:税务刮奖 }
    
    返回:
    
    Object
  - returnSuccess
```
public Object returnSuccess()
```
    通知微信成功了
    
    返回:
  - returnFail
```
public Object returnFail()
```
    通知微信失败了
    
    返回:
  - valiPayLegitimate
```
public Map<String,Object> valiPayLegitimate()
```
    微信付款成功,调用该方法验证签名等信息微信返回数据(不要做任何处理)
    
    返回:
    
    Map

类 PlayerWX

字段概要

构造器概要

方法概要

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

字段详细资料

playerWX

wxInfo

构造器详细资料

PlayerWX

方法详细资料

getWxInfo

getInstance

getInstance

setNotityUrl

getBasicsAccessToken

getAccessToken

getUserInfo

wxPayInfo

pay

pay

queryWXOrderInfo

closeOrder

refund

queryRefund

downloadBill

transfers

sendredpack

returnSuccess

returnFail

valiPayLegitimate