基于Java的微信开发SDK设计源码——WxJava

package com.github.binarywang.wxpay.service; import java.io.File; import java.util.Date; import java.util.Map; import com.github.binarywang.wxpay.bean.WxPayApiData; import com.github.binarywang.wxpay.bean.coupon.WxPayCouponInfoQueryRequest; import com.github.binarywang.wxpay.bean.coupon.WxPayCouponInfoQueryResult; import com.github.binarywang.wxpay.bean.coupon.WxPayCouponSendRequest; import com.github.binarywang.wxpay.bean.coupon.WxPayCouponSendResult; import com.github.binarywang.wxpay.bean.coupon.WxPayCouponStockQueryRequest; import com.github.binarywang.wxpay.bean.coupon.WxPayCouponStockQueryResult; import com.github.binarywang.wxpay.bean.notify.WxPayOrderNotifyResult; import com.github.binarywang.wxpay.bean.notify.WxPayRefundNotifyResult; import com.github.binarywang.wxpay.bean.notify.WxScanPayNotifyResult; import com.github.binarywang.wxpay.bean.request.*; import com.github.binarywang.wxpay.bean.result.*; import com.github.binarywang.wxpay.config.WxPayConfig; import com.github.binarywang.wxpay.exception.WxPayException; /** * <pre> * 微信支付相关接口. * Created by Binary Wang on 2016/7/28. * </pre> * * @author <a href="https://github.com/binarywang">Binary Wang</a> */ public interface WxPayService { /** * 获取微信支付请求url前缀，沙箱环境可能不一样. * * @return the pay base url */ String getPayBaseUrl(); /** * 发送post请求，得到响应字节数组. * * @param url 请求地址 * @param requestStr 请求信息 * @param useKey 是否使用证书 * @return 返回请求结果字节数组 byte [ ] * @throws WxPayException the wx pay exception */ byte[] postForBytes(String url, String requestStr, boolean useKey) throws WxPayException; /** * 发送post请求，得到响应字符串. * * @param url 请求地址 * @param requestStr 请求信息 * @param useKey 是否使用证书 * @return 返回请求结果字符串 string * @throws WxPayException the wx pay exception */ String post(String url, String requestStr, boolean useKey) throws WxPayException; /** * 获取企业付款服务类. * * @return the ent pay service */ EntPayService getEntPayService(); /** * 设置企业付款服务类，允许开发者自定义实现类. * * @param entPayService the ent pay service */ void setEntPayService(EntPayService entPayService); /** * <pre> * 查询订单. * 详见https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_2 * 该接口提供所有微信支付订单的查询，商户可以通过查询订单接口主动查询订单状态，完成下一步的业务逻辑。 * 需要调用查询接口的情况： * ◆ 当商户后台、网络、服务器等出现异常，商户系统最终未接收到支付通知； * ◆ 调用支付接口后，返回系统错误或未知交易状态情况； * ◆ 调用被扫支付API，返回USERPAYING的状态； * ◆ 调用关单或撤销接口API之前，需确认支付状态； * 接口地址：https://api.mch.weixin.qq.com/pay/orderquery * </pre> * * @param transactionId 微信订单号 * @param outTradeNo 商户系统内部的订单号，当没提供transactionId时需要传这个。 * @return the wx pay order query result * @throws WxPayException the wx pay exception */ WxPayOrderQueryResult queryOrder(String transactionId, String outTradeNo) throws WxPayException; /** * <pre> * 查询订单（适合于需要自定义子商户号和子商户appid的情形）. * 详见https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_2 * 该接口提供所有微信支付订单的查询，商户可以通过查询订单接口主动查询订单状态，完成下一步的业务逻辑。 * 需要调用查询接口的情况： * ◆ 当商户后台、网络、服务器等出现异常，商户系统最终未接收到支付通知； * ◆ 调用支付接口后，返回系统错误或未知交易状态情况； * ◆ 调用被扫支付API，返回USERPAYING的状态； * ◆ 调用关单或撤销接口API之前，需确认支付状态； * 接口地址：https://api.mch.weixin.qq.com/pay/orderquery * </pre> * * @param request 查询订单请求对象 * @return the wx pay order query result * @throws WxPayException the wx pay exception */ WxPayOrderQueryResult queryOrder(WxPayOrderQueryRequest request) throws WxPayException; /** * <pre> * 关闭订单. * 应用场景 * 以下情况需要调用关单接口： * 1. 商户订单支付失败需要生成新单号重新发起支付，要对原订单号调用关单，避免重复支付； * 2. 系统下单后，用户支付超时，系统退出不再受理，避免用户继续，请调用关单接口。 * 注意：订单生成后不能马上调用关单接口，最短调用时间间隔为5分钟。 * 接口地址：https://api.mch.weixin.qq.com/pay/closeorder * 是否需要证书： 不需要。 * </pre> * * @param outTradeNo 商户系统内部的订单号 * @return the wx pay order close result * @throws WxPayException the wx pay exception */ WxPayOrderCloseResult closeOrder(String outTradeNo) throws WxPayException; /** * <pre> * 关闭订单（适合于需要自定义子商户号和子商户appid的情形）. * 应用场景 * 以下情况需要调用关单接口： * 1. 商户订单支付失败需要生成新单号重新发起支付，要对原订单号调用关单，避免重复支付； * 2. 系统下单后，用户支付超时，系统退出不再受理，避免用户继续，请调用关单接口。 * 注意：订单生成后不能马上调用关单接口，最短调用时间间隔为5分钟。 * 接口地址：https://api.mch.weixin.qq.com/pay/closeorder * 是否需要证书： 不需要。 * </pre> * * @param request 关闭订单请求对象 * @return the wx pay order close result * @throws WxPayException the wx pay exception */ WxPayOrderCloseResult closeOrder(WxPayOrderCloseRequest request) throws WxPayException; /** * 调用统一下单接口，并组装生成支付所需参数对象. * * @param <T> 请使用{@link com.github.binarywang.wxpay.bean.order}包下的类 * @param request 统一下单请求参数 * @return 返回 {@link com.github.binarywang.wxpay.bean.order}包下的类对象 * @throws WxPayException the wx pay exception */ <T> T createOrder(WxPayUnifiedOrderRequest request) throws WxPayException; /** * 统一下单(详见https://pay.weixin.qq.com/wiki/doc/api/app/app.php?chapter=9_1) * 在发起微信支付前，需要调用统一下单接口，获取"预支付交易会话标识" * 接口地址：https://api.mch.weixin.qq.com/pay/unifiedorder * * @param request 请求对象，注意一些参数如appid、mchid等不用设置，方法内会自动从配置对象中获取到（前提是对应配置中已经设置） * @return the wx pay unified order result * @throws WxPayException the wx pay exception */ WxPayUnifiedOrderResult unifiedOrder(WxPayUnifiedOrderRequest request) throws WxPayException; /** * 该接口调用“统一下单”接口，并拼装发起支付请求需要的参数. * 详见https://pay.weixin.qq.com/wiki/doc/api/app/app.php?chapter=8_5 * * @param request 请求对象，注意一些参数如appid、mchid等不用设置，方法内会自动从配置对象中获取到（前提是对应配置中已经设置） * @return the pay info * @throws WxPayException the wx pay exception * @deprecated 建议使用 {@link com.github.binarywang.wxpay.service.WxPayService#createOrder(WxPayUnifiedOrderRequest)} */ @Deprecated Map<String, String> getPayInfo(WxPayUnifiedOrderRequest request) throws WxPayException; /** * 获取配置. * * @return the config */ WxPayConfig getConfig();