2 Star 8 Fork 20

dobbinsoft / matrix-pay

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Matrix Pay Logo

一、Matrix 起源 (项目背景) 🍭

在developer开发需要包含支付模块的系统时,通常会同时适配微信、支付宝、云闪付等第三方支付平台。通常,developer需要对多个平台进行适配。这些工作具有类似的对接流程,但是API却各成一派,大不相同。对接三家支付平台,就意味着您需要同时阅读三份API文档,维护三套代码。

MatrixPay(目标): 使用一套文档,一套API同时对接三家支付平台。

图片,以前的对接方式。 现在的对接方式

二、Matrix API风格

Matrix API本质是对支付平台官方或第三方API进行二次封装,让其有相同的入参返回值(包括错误码)。这样的好处是可以享受SDK本身升级带来的红利。

Matrix 使用非常受欢迎的Java微信支付开发包 WxJava 相同的API风格,您可以无缝将自己的项目切换到Matrix Pay。并且对于熟悉 WxJava API的开发者更加友好。

三、快速开始

3.1. 下载代码

您可以在国内开源社区Gitee下载(推荐):https://gitee.com/iotechn/matrix-pay

您可以在国际开源社区Github下载:https://github.com/iotechn/matrix-pay

分支约定

① master: 基本可用的最新版本

② develop:正在开发的版本,不保证能用

③ release:发行版,经过测试过,较稳定版本

3.2. maven引入

请确定您已经将 JAVA_HOME 配置,并将mvn命令配置到PATH中,若出现找不到命令,或找不到JAVA_HOME,请参考此文档

在项目根目录,打开命令行。并执行 :

mvn install -Dmaven.test.skip=true

引入maven坐标到工程pom.xml文件中。

<groupId>com.dobbinsoft</groupId>
<artifactId>fw-pay</artifactId>
<version>1.0-SNAPSHOT</version>
3.3. 使用Spring集成
  1. 写一个实现类,实现 com.dobbinsoft.fw.pay.config.PayProperties,此类用于MatrixPay获取配置文件。

  2. // 编写支付成功回调通知处理类,实现Handler即可
    package com.dobbinsoft.fw.pay.handler.MatrixPayCallbackHandler;
    
    public interface MatrixPayCallbackHandler {
    
        /**
         * 在校验回调之前调用,可以在此添加上下文
         * @param request
         */
        void beforeCheckSign(HttpServletRequest request);
    
        /**
         * 默认入参 PayOrderNotifyResult
         * @param result
         * @param request 原始请求
         * @return
         */
        Object handle(MatrixPayOrderNotifyResult result, HttpServletRequest request);
    
    }
  3. // 将所有Handler加入到IoC中,并指派回调通知链接。并将MatrixPayService加入IoC
    @Configuration
    public class PayConfig {
    
        @Bean
        public PayProperties payProperties() {
            return new PayMerchantPropertiesImpl();
        }
    
        @Bean
        public MatrixPayService matrixPayService() {
            return new MatrixPayServiceImpl(payProperties());
        }
    
        @Bean
        public CheckstandMatrixPayCallbackHandler checkstandMatrixPayCallbackHandler() {
            return new CheckstandMatrixPayCallbackHandler();
        }
    
        @Bean
        public ServletRegistrationBean servletRegistrationBean() {
            Map<String, MatrixPayCallbackHandler> urlHandlerMap = new HashMap<>();
            urlHandlerMap.put("/cb/unify", checkstandMatrixPayCallbackHandler());
            return new ServletRegistrationBean(new PayHttpCallbackServlet(matrixPayService(), urlHandlerMap), urlHandlerMap.keySet().toArray(new String[]{}));
        }
    
    }
  4. 支付下单,matrixPayService.createOrder

四、完整文档

Matrix Pay API文档:

五、特别注意

Matrix 并没有接入支付全套API。仅仅接入了之前用到的API。

请查看以下列表是否满足您的业务需求:

  1. 统一下单 createOrder
  2. 查询订单 queryOrder
  3. 关闭订单 closeOrder
  4. 订单退款 refund
  5. 退款查询 refundQuery
  6. 当面付 micropay

...若需要其他接口,请自行适配,欢迎将您的贡献PR到本仓库。特别感谢!

六、贡献 & 社区

Matrix Pay 在API适配中,也许您所需要适配的字段,映射存在偏差或框架存在BUG,您可以直接在仓库中发布Pull Request。本项目欢迎所有开发者一起维护,并永久开源。

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

使用一套API同时集成支付宝、微信支付。无框架、无入侵。支持Spring集成。 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/iotechn/matrix-pay.git
git@gitee.com:iotechn/matrix-pay.git
iotechn
matrix-pay
matrix-pay
master

搜索帮助