springboot快速开发微信支付

偏执的太偏执、 2022-04-24 02:16 590阅读 0赞

# springboot快速开发微信支付 #

# 1. POM文件添加依赖 #

<properties>
    	<wechat.sdk.version>3.3.7.B</wechat.sdk.version>
    </properties>
    
    <dependency>
       <groupId>com.github.binarywang</groupId>
       <artifactId>weixin-java-pay</artifactId>
       <version>${ wechat.sdk.version}</version>
    </dependency>

# 2.yml文件中添加配置 #

wx:
      pay:
        appId: 
        mchId: 
        mchKey: 
        subAppId: #服务商模式下的子商户公众账号ID
        subMchId: #服务商模式下的子商户号
        keyPath: # p12证书的位置，可以指定绝对路径，也可以指定类路径（以classpath:开头）

# 3. config文件中加载yml文件的微信支付参数 #

/** * 支付请求参数配置,如果yml文件的参数配置不够，可自行添加，比如回调url * * @author yanhuada */
    @Data
    @ConfigurationProperties(prefix = "weixin.pay")
    public class WxPayProperties { 
    
        /** * 设置微信公众号或者小程序等的appid */
        private String appId;
    
        /** * 微信支付商户号 */
        private String mchId;
    
        /** * 微信支付商户密钥 */
        private String mchKey;
    
        /** * 微信支付交易类型 */
        private String tradeType;
    
        /** * 通知地址 */
        private String notifyUrl;
      
    }

# 4. 业务逻辑编写 #

这里只给出如何调用com.github.binarywang中的方法，具体业务逻辑，需要自己自行添加

package com.github.binarywang.demo.wx.pay.controller;
    
    import java.io.File;
    import java.util.Date;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.bind.annotation.RestController;
    
    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.WxPayNotifyResponse;
    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.WxPayDownloadBillRequest;
    import com.github.binarywang.wxpay.bean.request.WxPayMicropayRequest;
    import com.github.binarywang.wxpay.bean.request.WxPayOrderCloseRequest;
    import com.github.binarywang.wxpay.bean.request.WxPayOrderQueryRequest;
    import com.github.binarywang.wxpay.bean.request.WxPayOrderReverseRequest;
    import com.github.binarywang.wxpay.bean.request.WxPayRefundQueryRequest;
    import com.github.binarywang.wxpay.bean.request.WxPayRefundRequest;
    import com.github.binarywang.wxpay.bean.request.WxPayReportRequest;
    import com.github.binarywang.wxpay.bean.request.WxPaySendRedpackRequest;
    import com.github.binarywang.wxpay.bean.request.WxPayUnifiedOrderRequest;
    import com.github.binarywang.wxpay.bean.result.WxPayBillResult;
    import com.github.binarywang.wxpay.bean.result.WxPayMicropayResult;
    import com.github.binarywang.wxpay.bean.result.WxPayOrderCloseResult;
    import com.github.binarywang.wxpay.bean.result.WxPayOrderQueryResult;
    import com.github.binarywang.wxpay.bean.result.WxPayOrderReverseResult;
    import com.github.binarywang.wxpay.bean.result.WxPayRedpackQueryResult;
    import com.github.binarywang.wxpay.bean.result.WxPayRefundQueryResult;
    import com.github.binarywang.wxpay.bean.result.WxPayRefundResult;
    import com.github.binarywang.wxpay.bean.result.WxPaySendRedpackResult;
    import com.github.binarywang.wxpay.bean.result.WxPayUnifiedOrderResult;
    import com.github.binarywang.wxpay.exception.WxPayException;
    import com.github.binarywang.wxpay.service.WxPayService;
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiOperation;
    
    
    /** * @author yanhuada */
    @Api("微信支付")
    @RestController
    @RequestMapping("/pay")
    public class WxPayController { 
      private WxPayService wxService;
    
      @Autowired
      public WxPayController(WxPayService wxService) { 
        this.wxService = wxService;
      }
    
      /** * <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时需要传这个。 */
      @ApiOperation(value = "查询订单")
      @GetMapping("/queryOrder")
      public WxPayOrderQueryResult queryOrder(@RequestParam(required = false) String transactionId,
                                              @RequestParam(required = false) String outTradeNo)
          throws WxPayException { 
        return this.wxService.queryOrder(transactionId, outTradeNo);
      }
    
      @ApiOperation(value = "查询订单")
      @PostMapping("/queryOrder")
      public WxPayOrderQueryResult queryOrder(WxPayOrderQueryRequest wxPayOrderQueryRequest) throws WxPayException { 
        return this.wxService.queryOrder(wxPayOrderQueryRequest);
      }
    
      /** * <pre> * 关闭订单 * 应用场景 * 以下情况需要调用关单接口： * 1. 商户订单支付失败需要生成新单号重新发起支付，要对原订单号调用关单，避免重复支付； * 2. 系统下单后，用户支付超时，系统退出不再受理，避免用户继续，请调用关单接口。 * 注意：订单生成后不能马上调用关单接口，最短调用时间间隔为5分钟。 * 接口地址：https://api.mch.weixin.qq.com/pay/closeorder * 是否需要证书： 不需要。 * </pre> * * @param outTradeNo 商户系统内部的订单号 */
      @ApiOperation(value = "关闭订单")
      @GetMapping("/closeOrder/{outTradeNo}")
      public WxPayOrderCloseResult closeOrder(@PathVariable String outTradeNo) throws WxPayException { 
        return this.wxService.closeOrder(outTradeNo);
      }
    
      @ApiOperation(value = "关闭订单")
      @PostMapping("/closeOrder")
      public WxPayOrderCloseResult closeOrder(WxPayOrderCloseRequest wxPayOrderCloseRequest) throws WxPayException { 
        return this.wxService.closeOrder(wxPayOrderCloseRequest);
      }
    
      /** * 调用统一下单接口，并组装生成支付所需参数对象. * * @param request 统一下单请求参数 * @param <T> 请使用{@link com.github.binarywang.wxpay.bean.order}包下的类 * @return 返回 {@link com.github.binarywang.wxpay.bean.order}包下的类对象 */
      @ApiOperation(value = "统一下单，并组装所需支付参数")
      @PostMapping("/createOrder")
      public <T> T createOrder(@RequestBody WxPayUnifiedOrderRequest request) throws WxPayException { 
        return this.wxService.createOrder(request);
      }
    
      /** * 统一下单(详见https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_1) * 在发起微信支付前，需要调用统一下单接口，获取"预支付交易会话标识" * 接口地址：https://api.mch.weixin.qq.com/pay/unifiedorder * * @param request 请求对象，注意一些参数如appid、mchid等不用设置，方法内会自动从配置对象中获取到（前提是对应配置中已经设置） */
      @ApiOperation(value = "原生的统一下单接口")
      @PostMapping("/unifiedOrder")
      public WxPayUnifiedOrderResult unifiedOrder(@RequestBody WxPayUnifiedOrderRequest request) throws WxPayException { 
        return this.wxService.unifiedOrder(request);
      }
    
      /** * <pre> * 微信支付-申请退款 * 详见 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_4 * 接口链接：https://api.mch.weixin.qq.com/secapi/pay/refund * </pre> * * @param request 请求对象 * @return 退款操作结果 */
      @ApiOperation(value = "退款")
      @PostMapping("/refund")
      public WxPayRefundResult refund(@RequestBody WxPayRefundRequest request) throws WxPayException { 
        return this.wxService.refund(request);
      }
    
      /** * <pre> * 微信支付-查询退款 * 应用场景： * 提交退款申请后，通过调用该接口查询退款状态。退款有一定延时，用零钱支付的退款20分钟内到账， * 银行卡支付的退款3个工作日后重新查询退款状态。 * 详见 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_5 * 接口链接：https://api.mch.weixin.qq.com/pay/refundquery * </pre> * 以下四个参数四选一 * * @param transactionId 微信订单号 * @param outTradeNo 商户订单号 * @param outRefundNo 商户退款单号 * @param refundId 微信退款单号 * @return 退款信息 */
      @ApiOperation(value = "退款查询")
      @GetMapping("/refundQuery")
      public WxPayRefundQueryResult refundQuery(@RequestParam(required = false) String transactionId,
                                                @RequestParam(required = false) String outTradeNo,
                                                @RequestParam(required = false) String outRefundNo,
                                                @RequestParam(required = false) String refundId)
          throws WxPayException { 
        return this.wxService.refundQuery(transactionId, outTradeNo, outRefundNo, refundId);
      }
    
      @ApiOperation(value = "退款查询")
      @PostMapping("/refundQuery")
      public WxPayRefundQueryResult refundQuery(WxPayRefundQueryRequest wxPayRefundQueryRequest) throws WxPayException { 
        return this.wxService.refundQuery(wxPayRefundQueryRequest);
      }
    
      @ApiOperation(value = "支付回调通知处理")
      @PostMapping("/notify/order")
      public String parseOrderNotifyResult(@RequestBody String xmlData) throws WxPayException { 
        final WxPayOrderNotifyResult notifyResult = this.wxService.parseOrderNotifyResult(xmlData);
        // TODO 根据自己业务场景需要构造返回对象
        return WxPayNotifyResponse.success("成功");
      }
    
      @ApiOperation(value = "退款回调通知处理")
      @PostMapping("/notify/refund")
      public String parseRefundNotifyResult(@RequestBody String xmlData) throws WxPayException { 
        final WxPayRefundNotifyResult result = this.wxService.parseRefundNotifyResult(xmlData);
        // TODO 根据自己业务场景需要构造返回对象
        return WxPayNotifyResponse.success("成功");
      }
    
      @ApiOperation(value = "扫码支付回调通知处理")
      @PostMapping("/notify/scanpay")
      public String parseScanPayNotifyResult(String xmlData) throws WxPayException { 
        final WxScanPayNotifyResult result = this.wxService.parseScanPayNotifyResult(xmlData);
        // TODO 根据自己业务场景需要构造返回对象
        return WxPayNotifyResponse.success("成功");
      }
    
      /** * 发送微信红包给个人用户 * <pre> * 文档详见: * 发送普通红包 https://pay.weixin.qq.com/wiki/doc/api/tools/cash_coupon.php?chapter=13_4&index=3 * 接口地址：https://api.mch.weixin.qq.com/mmpaymkttransfers/sendredpack * 发送裂变红包 https://pay.weixin.qq.com/wiki/doc/api/tools/cash_coupon.php?chapter=13_5&index=4 * 接口地址：https://api.mch.weixin.qq.com/mmpaymkttransfers/sendgroupredpack * </pre> * * @param request 请求对象 */
      @ApiOperation(value = "发送红包")
      @PostMapping("/sendRedpack")
      public WxPaySendRedpackResult sendRedpack(@RequestBody WxPaySendRedpackRequest request) throws WxPayException { 
        return this.wxService.sendRedpack(request);
      }
    
      /** * <pre> * 查询红包记录 * 用于商户对已发放的红包进行查询红包的具体信息，可支持普通红包和裂变包。 * 请求Url https://api.mch.weixin.qq.com/mmpaymkttransfers/gethbinfo * 是否需要证书 是（证书及使用说明详见商户证书） * 请求方式 POST * </pre> * * @param mchBillNo 商户发放红包的商户订单号，比如10000098201411111234567890 */
      @ApiOperation(value = "查询红包")
      @GetMapping("/queryRedpack/{mchBillNo}")
      public WxPayRedpackQueryResult queryRedpack(@PathVariable String mchBillNo) throws WxPayException { 
        return this.wxService.queryRedpack(mchBillNo);
      }
    
      /** * <pre> * 扫码支付模式一生成二维码的方法 * 二维码中的内容为链接，形式为： * weixin://wxpay/bizpayurl?sign=XXXXX&appid=XXXXX&mch_id=XXXXX&product_id=XXXXXX&time_stamp=XXXXXX&nonce_str=XXXXX * 其中XXXXX为商户需要填写的内容，商户将该链接生成二维码，如需要打印发布二维码，需要采用此格式。商户可调用第三方库生成二维码图片。 * 文档详见: https://pay.weixin.qq.com/wiki/doc/api/native.php?chapter=6_4 * </pre> * * @param productId 产品Id * @param logoFile 商户logo图片的文件对象，可以为空 * @param sideLength 要生成的二维码的边长，如果为空，则取默认值400 * @return 生成的二维码的字节数组 */
      public byte[] createScanPayQrcodeMode1(String productId, File logoFile, Integer sideLength) { 
        return this.wxService.createScanPayQrcodeMode1(productId, logoFile, sideLength);
      }
    
      /** * <pre> * 扫码支付模式一生成二维码的方法 * 二维码中的内容为链接，形式为： * weixin://wxpay/bizpayurl?sign=XXXXX&appid=XXXXX&mch_id=XXXXX&product_id=XXXXXX&time_stamp=XXXXXX&nonce_str=XXXXX * 其中XXXXX为商户需要填写的内容，商户将该链接生成二维码，如需要打印发布二维码，需要采用此格式。商户可调用第三方库生成二维码图片。 * 文档详见: https://pay.weixin.qq.com/wiki/doc/api/native.php?chapter=6_4 * </pre> * * @param productId 产品Id * @return 生成的二维码URL连接 */
      public String createScanPayQrcodeMode1(String productId) { 
        return this.wxService.createScanPayQrcodeMode1(productId);
      }
    
      /** * <pre> * 扫码支付模式二生成二维码的方法 * 对应链接格式：weixin：//wxpay/bizpayurl?sr=XXXXX。请商户调用第三方库将code_url生成二维码图片。 * 该模式链接较短，生成的二维码打印到结账小票上的识别率较高。 * 文档详见: https://pay.weixin.qq.com/wiki/doc/api/native.php?chapter=6_5 * </pre> * * @param codeUrl 微信返回的交易会话的二维码链接 * @param logoFile 商户logo图片的文件对象，可以为空 * @param sideLength 要生成的二维码的边长，如果为空，则取默认值400 * @return 生成的二维码的字节数组 */
      public byte[] createScanPayQrcodeMode2(String codeUrl, File logoFile, Integer sideLength) { 
        return this.wxService.createScanPayQrcodeMode2(codeUrl, logoFile, sideLength);
      }
    
      /** * <pre> * 交易保障 * 应用场景： * 商户在调用微信支付提供的相关接口时，会得到微信支付返回的相关信息以及获得整个接口的响应时间。 * 为提高整体的服务水平，协助商户一起提高服务质量，微信支付提供了相关接口调用耗时和返回信息的主动上报接口， * 微信支付可以根据商户侧上报的数据进一步优化网络部署，完善服务监控，和商户更好的协作为用户提供更好的业务体验。 * 接口地址： https://api.mch.weixin.qq.com/payitil/report * 是否需要证书：不需要 * </pre> */
      @ApiOperation(value = "提交交易保障数据")
      @PostMapping("/report")
      public void report(@RequestBody WxPayReportRequest request) throws WxPayException { 
        this.wxService.report(request);
      }
    
      /** * <pre> * 下载对账单 * 商户可以通过该接口下载历史交易清单。比如掉单、系统错误等导致商户侧和微信侧数据不一致，通过对账单核对后可校正支付状态。 * 注意： * 1、微信侧未成功下单的交易不会出现在对账单中。支付成功后撤销的交易会出现在对账单中，跟原支付单订单号一致，bill_type为REVOKED； * 2、微信在次日9点启动生成前一天的对账单，建议商户10点后再获取； * 3、对账单中涉及金额的字段单位为“元”。 * 4、对账单接口只能下载三个月以内的账单。 * 接口链接：https://api.mch.weixin.qq.com/pay/downloadbill * 详情请见: <a href="https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_6">下载对账单</a> * </pre> * * @param billDate 对账单日期 bill_date 下载对账单的日期，格式：20140603 * @param billType 账单类型 bill_type ALL，返回当日所有订单信息，默认值，SUCCESS，返回当日成功支付的订单，REFUND，返回当日退款订单 * @param tarType 压缩账单 tar_type 非必传参数，固定值：GZIP，返回格式为.gzip的压缩包账单。不传则默认为数据流形式。 * @param deviceInfo 设备号 device_info 非必传参数，终端设备号 * @return 保存到本地的临时文件 */
      @ApiOperation(value = "下载对账单")
      @GetMapping("/downloadBill/{billDate}/{billType}/{tarType}/{deviceInfo}")
      public WxPayBillResult downloadBill(@PathVariable String billDate,
                                          @PathVariable String billType,
                                          @PathVariable String tarType,
                                          @PathVariable String deviceInfo) throws WxPayException { 
        return this.wxService.downloadBill(billDate, billType, tarType, deviceInfo);
      }
    
      @ApiOperation(value = "下载对账单")
      @PostMapping("/downloadBill")
      public WxPayBillResult downloadBill(WxPayDownloadBillRequest wxPayDownloadBillRequest) throws WxPayException { 
        return this.wxService.downloadBill(wxPayDownloadBillRequest);
      }
    
      /** * <pre> * 提交刷卡支付 * 文档地址：https://pay.weixin.qq.com/wiki/doc/api/micropay.php?chapter=9_10&index=1 * 应用场景： * 收银员使用扫码设备读取微信用户刷卡授权码以后，二维码或条码信息传送至商户收银台，由商户收银台或者商户后台调用该接口发起支付。 * 提醒1：提交支付请求后微信会同步返回支付结果。当返回结果为“系统错误”时，商户系统等待5秒后调用【查询订单API】，查询支付实际交易结果；当返回结果为“USERPAYING”时，商户系统可设置间隔时间(建议10秒)重新查询支付结果，直到支付成功或超时(建议30秒)； * 提醒2：在调用查询接口返回后，如果交易状况不明晰，请调用【撤销订单API】，此时如果交易失败则关闭订单，该单不能再支付成功；如果交易成功，则将扣款退回到用户账户。当撤销无返回或错误时，请再次调用。注意：请勿扣款后立即调用【撤销订单API】,建议至少15秒后再调用。撤销订单API需要双向证书。 * 接口地址： https://api.mch.weixin.qq.com/pay/micropay * 是否需要证书：不需要。 * </pre> */
      @ApiOperation(value = "提交刷卡支付")
      @PostMapping("/micropay")
      public WxPayMicropayResult micropay(@RequestBody WxPayMicropayRequest request) throws WxPayException { 
        return this.wxService.micropay(request);
      }
    
      /** * <pre> * 撤销订单API * 文档地址：https://pay.weixin.qq.com/wiki/doc/api/micropay.php?chapter=9_11&index=3 * 应用场景： * 支付交易返回失败或支付系统超时，调用该接口撤销交易。如果此订单用户支付失败，微信支付系统会将此订单关闭；如果用户支付成功，微信支付系统会将此订单资金退还给用户。 * 注意：7天以内的交易单可调用撤销，其他正常支付的单如需实现相同功能请调用申请退款API。提交支付交易后调用【查询订单API】，没有明确的支付结果再调用【撤销订单API】。 * 调用支付接口后请勿立即调用撤销订单API，建议支付后至少15s后再调用撤销订单接口。 * 接口链接 ：https://api.mch.weixin.qq.com/secapi/pay/reverse * 是否需要证书：请求需要双向证书。 * </pre> */
      @ApiOperation(value = "撤销订单")
      @PostMapping("/reverseOrder")
      public WxPayOrderReverseResult reverseOrder(@RequestBody WxPayOrderReverseRequest request) throws WxPayException { 
        return this.wxService.reverseOrder(request);
      }
    
      @ApiOperation(value = "获取沙箱环境签名key")
      @GetMapping("/getSandboxSignKey")
      public String getSandboxSignKey() throws WxPayException { 
        return this.wxService.getSandboxSignKey();
      }
    
      @ApiOperation(value = "发放代金券")
      @PostMapping("/sendCoupon")
      public WxPayCouponSendResult sendCoupon(@RequestBody WxPayCouponSendRequest request)
          throws WxPayException { 
        return this.wxService.sendCoupon(request);
      }
    
      @ApiOperation(value = "查询代金券批次")
      @PostMapping("/queryCouponStock")
      public WxPayCouponStockQueryResult queryCouponStock(@RequestBody WxPayCouponStockQueryRequest request)
          throws WxPayException { 
        return this.wxService.queryCouponStock(request);
      }
    
      @ApiOperation(value = "查询代金券信息")
      @PostMapping("/queryCouponInfo")
      public WxPayCouponInfoQueryResult queryCouponInfo(@RequestBody WxPayCouponInfoQueryRequest request)
          throws WxPayException { 
        return this.wxService.queryCouponInfo(request);
      }
    
      @ApiOperation(value = "拉取订单评价数据")
      @PostMapping("/queryComment")
      public String queryComment(Date beginDate, Date endDate, Integer offset, Integer limit) throws WxPayException { 
        return this.wxService.queryComment(beginDate, endDate, offset, limit);
      }
    }

最后的最后，需要demo的可私聊我！