完善README文档

This commit is contained in:
dingzhiwei 2024-03-10 13:10:17 +08:00
parent 5329b682a5
commit 335070362d
1 changed files with 67 additions and 26 deletions

View File

@ -35,42 +35,51 @@
-------------------------------------------------------------------------------
## 📚 项目介绍
# 项目介绍
Jeepay是一套适合互联网企业使用的开源支付系统支持多渠道服务商和普通商户模式。已对接`微信支付``支付宝``云闪付`官方接口,支持聚合码支付。
Jeepay使用`Spring Boot`和`Ant Design Vue`开发,集成`Spring Security`实现权限管理功能是一套非常实用的web开发框架。
### 🎁 名称的由来
## 名称的由来
Jeepay = Jee + pay是由原XxPay支付系统作者带领团队开发“Jee”是公司计全科技名称的表示pay表示支付。中文名称为计全支付释为计出万全、支付安全让支付更加方便安全。
### 🍟 项目体验
- Jeepay支付流程体验[https://www.jeequan.com/demo/jeepay_cashier.html](https://www.jeequan.com/demo/jeepay_cashier.html "Jeepay支付体验")
- Jeepay运营平台和商户系统演体验[https://www.jeequan.com/doc/detail_84.html](https://www.jeequan.com/doc/detail_84.html "Jeepay支付系统体验")
- Jeepay项目文档[https://docs.jeequan.com/docs/jeepay](https://docs.jeequan.com/docs/jeepay "Jeepay项目文档")
- Jeepay快速使用[https://docs.jeequan.com/docs/jeepay/jeepay-1dbdn8bqgo270](https://docs.jeequan.com/docs/jeepay/jeepay-1dbdn8bqgo270 "Jeepay快速使用")
### 🍎 项目特点
* 支持多渠道对接,支付网关自动路由
## 项目特点
* 支持多渠道对接,多种支付产品
* 已对接`微信`服务商和普通商户接口,支持`V2`和`V3`接口
* 已对接`支付宝`服务商和普通商户接口支持RSA和RSA2签名
* 已对接`云闪付`服务商接口,可选择多家支付机构
* 提供http形式接口提供各语言的`sdk`实现,方便对接
* 接口请求和响应数据采用签名机制,保证交易安全可靠
* 系统安全,支持`分布式`部署,`高并发`
* 管理端包括`运营平台`和`商户系统`
* 支持`多商户模式`,商户多应用接入
* 管理平台操作界面简洁、易用
* 支付平台到商户系统的订单通知使用MQ实现保证了高可用消息可达
* 支付平台到商户系统的订单通知使用MQ实现保证了高可用消息可达支持多个产品MQ
* 支付渠道的接口参数配置界面自动化生成
* 使用`spring security`实现权限管理
* 前后端分离架构,方便二次开发
* 由原`XxPay`团队开发,有着多年支付系统开发经验
* 支持docker部署官方发布一键部署脚本10分钟部署完成
## 🥞 系统架构
## 接口市场
计全官方团队基于开源版代码,开发了对接各家三方支付和银行的对接代码。为了让用户能够快速接入支付,目前已将对接好的代码发布到官方接口市场,并不断更新。
如有需要,可前去接口市场购买。
接口市场https://www.jeequan.com/ifstore/list.html
安装说明https://docs.jeequan.com/docs/jeepay/jeepay-1ejdnsuhveb16
目前发布接口包括
三方汇付Adapay、斗拱支付、支付宝直付通、微信收付通、银盛支付、银联条码前置、银联支付、联动优势、国通星驿付、丰付支付、盛付通、乐刷、杉德支付、瑞银信、拉拉卡、汇聚支付、新生支付、河马支付、海科融通、富友支付、易生支付、支付宝云支付、通联支付
银行:工行支付、浦发银行、建行龙支付、交行支付、
四方:付呗支付、米花支付
# 系统架构
> Jeepay计全支付系统架构图
@ -80,8 +89,7 @@ Jeepay = Jee + pay是由原XxPay支付系统作者带领团队开发“Jee
![Jeepay计全支付聚合码支付流程图](https://jeequan.oss-cn-beijing.aliyuncs.com/jeepay/img/jeepay_qr.png "Jeepay计全支付聚合码支付流程图")
> 核心技术栈
## 核心技术栈
| 软件名称 | 描述 | 版本
|---|---|---
@ -92,17 +100,19 @@ Jeepay = Jee + pay是由原XxPay支付系统作者带领团队开发“Jee
|MQ | 消息中间件 | ActiveMQ 或 RabbitMQ 或 RocketMQ
|[Ant Design Vue](https://www.antdv.com/docs/vue/introduce-cn/) | Ant Design的Vue实现前端开发使用 | 2.1.2
|[MyBatis-Plus](https://mp.baomidou.com/) | MyBatis增强工具 | 3.4.2
|[WxJava](https://gitee.com/binary/weixin-java-tools) | 微信开发Java SDK | 4.1.0
|[Hutool](https://www.hutool.cn/) | Java工具类库 | 5.6.6
|[WxJava](https://gitee.com/binary/weixin-java-tools) | 微信开发Java SDK | 4.6.0
|[Hutool](https://www.hutool.cn/) | Java工具类库 | 5.8.26
> 项目结构
## 项目结构
```lua
jeepay-ui -- https://gitee.com/jeequan/jeepay-ui
jeepay
├── conf -- 存放系统部署使用的.yml文件
├── docker -- 存放docker相关文件
└── docs -- 存放项目相关文档说明
├── intsll -- 项目部署shell脚本
├── script -- 项目启动shell脚本
└── sql -- 初始化sql文件
└── jeepay-components -- 公共组件目录
@ -116,14 +126,43 @@ jeepay
└── jeepay-z-codegen -- mybatis代码生成
```
> 开发部署
# 项目体验
- 系统开发:[https://docs.jeequan.com/docs/jeepay/dev_serv](https://docs.jeequan.com/docs/jeepay/dev_serv)
## 支付体验
- Jeepay支付流程体验[https://www.jeequan.com/demo/jeepay_cashier.html](https://www.jeequan.com/demo/jeepay_cashier.html "Jeepay支付体验")
## 管理平台
- Jeepay运营平台和商户系统演体验[https://www.jeequan.com/doc/detail_84.html](https://www.jeequan.com/doc/detail_84.html "Jeepay支付系统体验")
# 如何使用
## 最佳实践
将Jeepay作为一个支付模块部署对外提供支付接入能力有支付需求的业务都可以接入使用。
CentOS 安装脚本 推荐Anolis OS 8.8
yum install -y wget && wget -O install.sh https://gitee.com/jeequan/jeepay/raw/master/docs/install/install.sh && sh install.sh
Ubuntu 安装脚本 (推荐 Ubuntu 22.04 64位
apt update && apt-get -y install docker.io && apt-get -y install git && wget -O install.sh https://gitee.com/jeequan/jeepay/raw/master/docs/install/install.sh && sh install.sh
## 项目文档
- 项目文档:[https://docs.jeequan.com/docs/jeepay](https://docs.jeequan.com/docs/jeepay "Jeepay项目文档")
- 开发指导:[https://docs.jeequan.com/docs/jeepay/dev_serv](https://docs.jeequan.com/docs/jeepay/dev_serv)
- 通道对接:[https://docs.jeequan.com/docs/jeepay/dev_channel](https://docs.jeequan.com/docs/jeepay/dev_channel)
- 线上部署:[https://docs.jeequan.com/docs/jeepay/deploy](https://docs.jeequan.com/docs/jeepay/deploy)
- 接口文档:[https://docs.jeequan.com/docs/jeepay/payment_api](https://docs.jeequan.com/docs/jeepay/payment_api)
- 常见问题:[https://docs.jeequan.com/docs/jeepay/jeepay-1d99ciatu11h5](https://docs.jeequan.com/docs/jeepay/jeepay-1d99ciatu11h5)
- 快速上手:[https://docs.jeequan.com/docs/jeepay/jeepay-1dbdn8bqgo270](https://docs.jeequan.com/docs/jeepay/jeepay-1dbdn8bqgo270 "Jeepay快速使用")
## SDK对接
Jeepay已经开发了java和python的sdk方便接入方开发对接。
- Java SDK[https://gitee.com/jeequan/jeepay-sdk-java](https://gitee.com/jeequan/jeepay-sdk-java "java sdk")
- Python SDK[https://gitee.com/jeequan/jeepay-sdk-python](https://gitee.com/jeequan/jeepay-sdk-python "python sdk")
## 🍿 功能模块
@ -165,12 +204,14 @@ jeepay
![Jeepay演示界面](http://jeequan.oss-cn-beijing.aliyuncs.com/jeepay/img/yanshi/022.png "Jeepay演示界面")
## 🥪 关于我们
## 🥪 更多支持
***
微信扫描下面二维码,关注官方公众号:计全科技,获取更多精彩内容。
![计全科技公众号](http://jeequan.oss-cn-beijing.aliyuncs.com/jeepay/img/jee-qrcode.jpg "计全科技公众号")
微信扫描下方二维码,邀请进官方微信交流群加好友备注邀请进群或jeepay咨询开源不易进群前请先点Star给与支持。
微信扫描下方二维码,邀请进官方微信交流群开源不易进群前请先点Star给与支持。
![Jeepay微信交流群](http://jeequan.oss-cn-beijing.aliyuncs.com/jeepay/img/wx_my.png "Jeepay微信交流群")
![Jeepay微信交流群](http://jeequan.oss-cn-beijing.aliyuncs.com/jeepay/img/jeepay_open_kf.png "Jeepay微信交流群")
微信客服咨询:[https://work.weixin.qq.com/kfid/kfcda262e9a7799f21c](https://work.weixin.qq.com/kfid/kfcda262e9a7799f21c "jeepay微信客服咨询")