功能开启

项目提供统一的支付中心，提供微信、支付宝等支付渠道的支付、退款等能力，方便业务模块进行快速接入，无需关注各种繁琐的支付 API。

![统一接入](/media/202404/2024-04-26_0125050.40414626927447195.png)

## [#](https://doc.iocoder.cn/pay/build/#_1-%E6%A6%82%E8%BF%B0)1. 概述

它由如下 3 部分组成：

① [`yudao-spring-boot-starter-biz-pay` **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-framework/yudao-spring-boot-starter-biz-pay/)组件：对接微信、支付宝等支付，提供统一的 [PayClient 支付客户端 **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-framework/yudao-spring-boot-starter-biz-pay/src/main/java/cn/iocoder/yudao/framework/pay/core/client/PayClient.java)。

![PayClient 类图](/media/202404/2024-04-26_0125050.512633287554038.png)

② [`yudao-module-pay` **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/tree/master/yudao-module-pay)后端模块：实现支付中心的后端功能，包括支付、退款等能力。

* 基于 PayClient 支付客户端，对接微信、支付宝等支付渠道。
* 对内提供 [PayOrderApi **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-module-pay/yudao-module-pay-api/src/main/java/cn/iocoder/yudao/module/pay/api/order/PayOrderApi.java) 统一支付 API 能力、[PayRefundApi **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-module-pay/yudao-module-pay-api/src/main/java/cn/iocoder/yudao/module/pay/api/refund/PayRefundApi.java) 统一退款 API 能力。

③ 支付中心的前端，提供支付中心的管理后台，可进行支付渠道的配置、支付订单、退款单的查看等操作。

* Vue2 版本：[`@/views/pay` **(opens new window)**](https://github.com/yudaocode/yudao-ui-admin-vue2/tree/master/src/views/pay)目录
* Vue3 版本：[`@/views/pay` **(opens new window)**](https://github.com/yudaocode/yudao-ui-admin-vue3/tree/master/src/views/pay)目录

## [#](https://doc.iocoder.cn/pay/build/#_2-%E5%8A%9F%E8%83%BD%E5%BC%80%E5%90%AF)2. 功能开启

考虑到编译速度，默认 `yudao-module-pay` 模块是关闭的，需要手动开启。步骤如下：

* 第一步，开启 `yudao-module-pay` 模块
* 第二步，导入支付的 SQL 数据库脚本
* 第三步，重启后端项目，确认功能是否生效
* 第四步，开启支付相关的 Job 任务

### [#](https://doc.iocoder.cn/pay/build/#_2-1-%E5%BC%80%E5%90%AF-yudao-module-pay-%E6%A8%A1%E5%9D%97)2.1 开启 yudao-module-pay 模块

① 修改根目录的 [`pom.xml` **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/pom.xml)文件，取消 `yudao-module-pay` 模块的注释。如下图所示：

![取消  模块的注释](/media/202404/2024-04-26_0125050.6888579524216157.png)

② 修改 `yudao-server` 目录的 [`pom.xml` **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-server/pom.xml)文件，引入 `yudao-module-pay` 模块。如下图所示：

![引入  模块](/media/202404/2024-04-26_0125050.8201461211708794.png)

③ 点击 IDEA 右上角的【Reload All Maven Projects】，刷新 Maven 依赖。如下图所示：

![刷新 Maven 依赖](/media/202404/2024-04-26_0125050.22173256769912475.png)

### [#](https://doc.iocoder.cn/pay/build/#_2-2-%E7%AC%AC%E4%BA%8C%E6%AD%A5-%E5%AF%BC%E5%85%A5-sql)2.2 第二步，导入 SQL

点击 [`pay-2024-01-05.sql.zip` **(opens new window)**](https://t.zsxq.com/15mEuhfnK)下载附件，解压出 SQL 文件，然后导入到数据库中。

友情提示：↑↑↑ pay.sql 是可以点击下载的！ ↑↑↑

![表结构](/media/202404/2024-04-26_0125050.956540529741258.png)

### [#](https://doc.iocoder.cn/pay/build/#_2-3-%E7%AC%AC%E4%B8%89%E6%AD%A5-%E9%87%8D%E5%90%AF%E9%A1%B9%E7%9B%AE)2.3 第三步，重启项目

重启后端项目，然后访问前端的支付菜单，确认功能是否生效。如下图所示：

![确认功能是否生效](/media/202404/2024-04-26_0125050.938259584620207.png)

至此，我们就成功开启了支付的功能 🙂

### [#](https://doc.iocoder.cn/pay/build/#_2-4-%E7%AC%AC%E5%9B%9B%E6%AD%A5-%E5%BC%80%E5%90%AF%E6%94%AF%E4%BB%98-job)2.4 第四步，开启支付 Job

① 参考 [《定时任务》](https://doc.iocoder.cn/job/) 文档，将 Job 定时任务开启。

② 将 `pay` 开头的定时都进行开启，例如说：`payNotifyJob`、`payOrderSyncJob`、`payOrderExpireJob`、`payRefundSyncJob`。如下图所示：

![开启 Job 任务](/media/202404/2024-04-26_0125050.2643614096089538.png)

## [#](https://doc.iocoder.cn/pay/build/#_3-%E5%8A%9F%E8%83%BD%E4%BB%8B%E7%BB%8D)3. 功能介绍

### [#](https://doc.iocoder.cn/pay/build/#_3-1-%E5%BA%94%E7%94%A8%E4%BF%A1%E6%81%AF)3.1 应用信息

对应 [支付管理 -> 应用信息] 菜单，进行支付渠道、支付应用的管理。如下图所示：

![支付管理 -> 应用信息](/media/202404/2024-04-26_0125050.8705225513618615.png)

#### [#](https://doc.iocoder.cn/pay/build/#_3-1-1-%E6%94%AF%E4%BB%98%E5%BA%94%E7%94%A8)3.1.1 支付应用

每个要接入支付中心的业务，对应一个支付应用。例如说：商城订单算一个应用，预约订单算一个应用。

点击【新增】按钮，可以进行支付应用的配置，保存在 `pay_app` 表。如下图所示：

![支付应用](/media/202404/2024-04-26_0125050.6265432108560611.png)

* 支付结果的回调地址：每个业务需要实现一个支付回调接口，在用户支付成功时，支付中心会进行回调。[示例 1 **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/demo/PayDemoOrderController.java#L50-L58)、[示例 2(opens new window)](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/AppTradeOrderController.java#L64-L70)
* 退款结果的回调地址：每个业务需要实现一个退款回调接口，在用户退款成功时，支付中心会进行回调。[示例 1(opens new window)](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/demo/PayDemoOrderController.java#L68-L76)

为什么要有支付应用？直接配置支付渠道不行吗？

1. 一个系统中，可能有多个业务需要，每个业务的支付、退款回调地址不同。
2. 同时，每个业务的订单编号可能重复，需要使用支付应用进行隔离，只要求在每个支付应用下保持唯一即可。
3. 另外，每个业务可能想要配置不同的支付渠道。

#### [#](https://doc.iocoder.cn/pay/build/#_3-1-2-%E6%94%AF%E4%BB%98%E6%B8%A0%E9%81%93)3.1.2 支付渠道

每个支付应用下，可以配置多个支付渠道。例如说：这里“示例应用”就配置了支付宝 PC 网站支付、支付宝 Wap 网站支付等等。

点击【√】或者【×】图标，可以进行支付应用的配置，保存在 `pay_channel` 表。如下图所示：

![支付渠道](/media/202404/2024-04-26_0125050.47072419227112605.png)

### [#](https://doc.iocoder.cn/pay/build/#_3-2-%E6%94%AF%E4%BB%98%E8%AE%A2%E5%8D%95)3.2 支付订单

对应 [支付管理 -> 支付订单] 菜单，进行支付订单的查看。如下图所示：

![支付订单](/media/202404/2024-04-26_0125050.051176456515421354.png)

一般情况下，每个业务订单对应一条支付订单，保存在 `pay_order` 表，通过 `merchant_order_id` 字段关联。

### [#](https://doc.iocoder.cn/pay/build/#_3-3-%E9%80%80%E6%AC%BE%E8%AE%A2%E5%8D%95)3.3 退款订单

对应 [支付管理 -> 退款订单] 菜单，进行退款订单的查看。如下图所示：

![退款订单](/media/202404/2024-04-26_0125050.49606872394980195.png)

一般情况下，每个业务退款对应一条退款订单，保存在 `pay_refund` 表，通过 `merchant_refund_no` 字段关联。

### [#](https://doc.iocoder.cn/pay/build/#_3-4-%E5%9B%9E%E8%B0%83%E9%80%9A%E7%9F%A5)3.4 回调通知

对应 [支付管理 -> 回调通知] 菜单，查看支付、退款的回调业务的结果。如下图所示：

![回调通知](/media/202404/2024-04-26_0125050.47792712066701803.png)

### [#](https://doc.iocoder.cn/pay/build/#_3-5-%E6%94%AF%E4%BB%98%E5%9B%9E%E8%B0%83%E3%80%90%E9%87%8D%E8%A6%81%E3%80%91)3.5 支付回调【重要】

这里，我们要配置支付【 **中心** 】提供给支付【 **渠道** 】的回调地址，不同于上面支付【 **应用** 】的回调地址。整体的回调关系如下图所示：

![回调流程](/media/202404/2024-04-26_0125050.6752004658524898.png)

① 由于支付回调需要外网，可参考 [《内网穿透》](https://doc.iocoder.cn/natapp/) 文档，将本地的 48080 端口，转发到外网中。这里，我的域名是 `http://yunai.natapp1.cc`。

② 在 [`application-local.yaml` **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-server/src/main/resources/application-local.yaml#L196-L197)配置文件中，修改 `yudao.pay` 配置项，设置为支付【中心】的回调地址。如下图所示：

![配置回调地址](/media/202404/2024-04-26_0125050.305785598918346.png)

* `yudao.pay.order-notify-url` 配置项：对应 PayNotifyController 的 [`#notifyOrder(...)` **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/notify/PayNotifyController.java#L59-L98)方法
* `yudao.pay.refund-notify-url` 配置项：对应 PayNotifyController 的 [`#notifyRefund(...)` **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/notify/PayNotifyController.java#L59-L98)方法

如果你想理解的更深入，可以后续 debug 断条调试。

### [#](https://doc.iocoder.cn/pay/build/#_3-6-%E6%8E%A5%E5%85%A5%E7%A4%BA%E4%BE%8B)3.6 接入示例

对应 [支付管理 -> 接入示例 -> 支付&退款案例] 菜单，提供一个支付、退款的接入示例。如下图所示：

![支付&退款案例](/media/202404/2024-04-26_0125050.6395091906251779.png)

详细说明，可见如下文档：

* [《支付宝支付接入》](https://doc.iocoder.cn/pay/alipay-pay-demo)
* [《支付宝、微信退款接入》](https://doc.iocoder.cn/pay/refund-demo)