Skip to content
BranchesTags
 
 

Repository files navigation

BeeCloud Android SDK (Open Source)

pass license version

简介

本项目的官方GitHub地址是 https://github.com/beecloud/beecloud-android

本SDK是根据BeeCloud Rest API 开发的 Android SDK。目前已经包含微信支付、支付宝支付、银联在线支付、PayPal支付和生成二维码方式支付，以及支付订单和退款订单的查询功能，可以作为调用BeeCloud Rest API的示例或者直接用于生产。

流程

pic

安装

  1. 添加依赖
  1. 对于通过添加model的方式（适用于gradle，推荐直接使用Android Studio） 引入sdk model，在project的settings.gradle中include ':sdk'，并在需要支付的model（比如本项目中的demo） build.gradle中添加依赖compile project(':sdk')。
  1. 对于需要以jar方式引入的情况
    添加第三方的支付类，在beecloud-android\sdk\libs目录下
    gson-2.2.4.jar为必须引入的jar，
    zxing-3.2.0.jar为生成二维码必须引入的jar，
    微信支付需要引入libammsdk.jar，
    支付宝需要引入alipaysdk.jar、alipayutdid.jar、alipaysecsdk.jar，
    银联需要引入UPPayAssistEx.jar、UPPayPluginEx.jar，
    PayPal需要引入PayPalAndroidSDK-2.9.11.jar，
    最后添加beecloud android sdk：beecloud-android\sdk\beecloud.jar

2.对于银联支付需要将银联插件beecloud-android\demo\src\main\assets\UPPayPluginEx.apk引入你的工程assets目录下

注册

  1. 注册开发者：猛击这里注册成为BeeCloud开发者。
  2. 注册应用：使用注册的账号登陆控制台后，点击"+创建App"创建新应用，并配置支付参数。

使用方法

具体使用请参考项目中的demo

1.初始化支付参数

请参考demo中的ShoppingCartActivity.java

  1. 在主activity的onCreate函数中初始化BeeCloud账户中的AppID和AppSecret，例如
BeeCloud.setAppIdAndSecret("c5d1cba1-5e3f-4ba0-941d-9b0a371fe719", "39a7a518-9ac8-4a9e-87bc-7885f33cf18c");

>2. 如果用到微信支付，在用到微信支付的Activity的onCreate函数里调用以下函数，第二个参数需要换成你自己的微信AppID，例如 ```java BCPay.initWechatPay(ShoppingCartActivity.this, "wxf1aa465362b4c8f1"); ``` >3. 如果用到PayPal，在用到PayPal的Activity的onCreate函数里调用函数，例如 ```java BCPay.initPayPal( //在PayPal官网申请的APP Client ID "AVT1Ch18aTIlUJIeeCxvC7ZKQYHczGwiWm8jOwhrREc4a5FnbdwlqEB4evlHPXXUA67RAAZqZM0H8TCR", //在PayPal官网申请的APP Secret "EL-fkjkEUyxrwZAmrfn46awFXlX-h2nRkyCVhhpeVdlSRuhPJKXx3ZvUTTJqPQuAeomXA8PZ2MkX24vF", //测试过程中使用BCPay.PAYPAL_PAY_TYPE.SANDBOX，生产环境使用BCPay.PAYPAL_PAY_TYPE.LIVE，不同的环境需要与Client ID和Secret相匹配 BCPay.PAYPAL_PAY_TYPE.SANDBOX, //是否显示收货地址，如果为TRUE，用户地址没有正确配置可能导致不能付款，该选项可以自行考量 Boolean.FALSE ); ````

2. 在AndroidManifest.xml中添加permission

<!-- for all -->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

<!-- for PayPal -->
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

3. 在AndroidManifest.xml中注册activity

对于微信支付，需要添加

<activity
    android:name="cn.beecloud.BCWechatPaymentActivity"
    android:launchMode="singleTop"
    android:theme="@android:style/Theme.Translucent.NoTitleBar" />
<activity-alias
    android:name=".wxapi.WXPayEntryActivity"
    android:exported="true"
    android:targetActivity="cn.beecloud.BCWechatPaymentActivity" />

对于支付宝，需要添加

<activity
    android:name="com.alipay.sdk.app.H5PayActivity"
    android:configChanges="orientation|keyboardHidden|navigation"
    android:exported="false"
    android:screenOrientation="behind"
    android:windowSoftInputMode="adjustResize|stateHidden" />

对于银联，需要添加

<activity
    android:name="cn.beecloud.BCUnionPaymentActivity"
    android:configChanges="orientation|keyboardHidden"
    android:excludeFromRecents="true"
    android:launchMode="singleTop"
    android:screenOrientation="portrait"
    android:theme="@android:style/Theme.Translucent.NoTitleBar"
    android:windowSoftInputMode="adjustResize" />

对于PayPal，需要添加

<service
    android:name="com.paypal.android.sdk.payments.PayPalService"
    android:exported="false" />
<activity android:name="com.paypal.android.sdk.payments.PaymentActivity" />
<activity android:name="com.paypal.android.sdk.payments.LoginActivity" />
<activity android:name="com.paypal.android.sdk.payments.PaymentMethodActivity" />
<activity android:name="com.paypal.android.sdk.payments.PaymentConfirmActivity" />
<activity
    android:name="cn.beecloud.BCPayPalPaymentActivity"
    android:configChanges="orientation|keyboardHidden"
    android:excludeFromRecents="true"
    android:launchMode="singleTop"
    android:screenOrientation="portrait"
    android:theme="@android:style/Theme.Translucent.NoTitleBar"
    android:windowSoftInputMode="adjustResize" />

4.支付

请查看doc中的API，支付类BCPay，参照demo中ShoppingCartActivity

原型：

通过BCPay的实例，以reqWXPaymentAsync方法发起微信支付请求。
通过BCPay的实例，以reqAliPaymentAsync方法发起支付宝支付请求。
通过BCPay的实例，以reqUnionPaymentAsync方法发起银联支付请求。
通过BCPay的实例，以reqPayPalPaymentAsync方法发起PayPal支付请求。

参数依次为

billTitle 商品描述, 32个字节内, 汉字以2个字节计
billTotalFee 支付金额，以分为单位，必须是正整数
billNum 商户自定义订单号，PayPal不需要该参数
optional 为扩展参数，可以传入任意数量的key/value对来补充对业务逻辑
callback 支付完成后的回调入口

在回调函数中将BCResult转化成BCPayResult之后做后续处理
调用：（以微信为例）

//定义回调
BCCallback bcCallback = new BCCallback() {
    @Override
    public void done(final BCResult bcResult) {
        //此处根据业务需要处理支付结果
        final BCPayResult bcPayResult = (BCPayResult)bcResult;

        ShoppingCartActivity.this.runOnUiThread(new Runnable() {
            @Override
            public void run() {
            	//对于JRE6的用户请参考demo中使用if else判断
                switch (bcPayResult.getResult()) {
                    case BCPayResult.RESULT_SUCCESS:
                        Toast.makeText(ShoppingCartActivity.this, "用户支付成功", Toast.LENGTH_LONG).show();
                        break;
                    case BCPayResult.RESULT_CANCEL:
                        Toast.makeText(ShoppingCartActivity.this, "用户取消支付", Toast.LENGTH_LONG).show();
                        break;
                    case BCPayResult.RESULT_FAIL:
                        Toast.makeText(ShoppingCartActivity.this, "支付失败, 原因: " + bcPayResult.getErrMsg()
                                + ", " + bcPayResult.getDetailInfo(), Toast.LENGTH_LONG).show();
                }
            }
        });
    }
};

//调用支付接口
Map<String, String> mapOptional = new HashMap<>();
String optionalKey = "testkey1";    //对key暂时不支持中文
String optionalValue = "测试value值1";

mapOptional.put(optionalKey, optionalValue);

//发起支付
BCPay.getInstance(ShoppingCartActivity.this).reqWXPaymentAsync(
    "微信支付测试",               //订单标题
    1,                           //订单金额(分)
    UUID.randomUUID().toString().replace("-", ""),  //订单流水号
    mapOptional,            //扩展参数(可以null)
    bcCallback);            //支付完成后回调入口
对于PayPal支付的补充说明（非强制，但建议执行）

PayPal回调返回的成功表示手机支付已经完成，但是PayPal官方推荐服务端进一步校验以防止非法欺诈行为，为此每次PayPal支付完成之后，SDK都会主动向服务端发送同步请求，所以在生产环境中建议以服务端的订单状态为标准。
另外在同步过程中为防止网络故障导致的同步失败，每次同步失败的PayPal订单都会保留在缓存，这种情况属于小概率事件，但是周全起见，可以参考demo中的PayPalUnSyncedListActivity如何进行手动同步，可以直接调用batchSyncPayPalPayment，例如

BCCache.executorService.execute(new Runnable() {
    @Override
    public void run() {
        //batch sync
        Map<String, Integer> result = BCPay.getInstance(PayPalUnSyncedListActivity.this).
                batchSyncPayPalPayment();

        //total cached number
        Integer allCached = result.get("cachedNum");
        //total successfully synced number
        Integer synced = result.get("syncedNum");

        if (allCached.equals(synced)) {
            //成功全部同步
        } else {
            //没有成功同步的订单
            Set<String> unSynced = BCCache.getInstance(activity).getUnSyncedPayPalRecords());
        }
    }
});

如果想手动清除未同步订单，调用BCCache.getInstance(activity).clearUnSyncedPayPalRecords()

5.生成支付二维码

请查看doc中的API，支付类BCPay，参照demo中GenQRCodeActivity

原型：

通过BCPay的实例，以reqWXQRCodeAsync方法请求生成微信支付二维码。
通过BCPay的实例，以reqAliQRCodeAsync方法请求生成支付宝内嵌支付二维码。
通过BCPay的实例，以reqAliOfflineQRCodeAsync方法请求生成支付宝线下支付二维码。

公用参数依次为

billTitle 商品描述, 32个字节内, 汉字以2个字节计
billTotalFee 支付金额，以分为单位，必须是正整数
billNum 商户自定义订单号
optional 为扩展参数，可以传入任意数量的key/value对来补充对业务逻辑
callback 支付完成后的回调入口

请求生成微信支付二维码和支付宝线下支付二维码的特有参数

genQRCode 是否生成QRCode Bitmap

如果为false，请自行根据getQrCodeRawContent返回的URL，使用BCPay.generateBitmap方法生成支付二维码，你也可以使用自己熟悉的二维码生成工具

qrCodeWidth 如果生成二维码(genQRCode为true), QRCode的宽度(以px为单位), null则使用默认参数360px

请求生成支付宝内嵌支付二维码的特有参数

returnUrl 支付成功后的同步跳转页面, 必填
qrPayMode 支付宝内嵌二维码类型

null则支付宝生成默认类型, 不建议
"0": 订单码-简约前置模式, 对应 iframe 宽度不能小于 600px, 高度不能小于 300px
"1": 订单码-前置模式, 对应 iframe 宽度不能小于 300px, 高度不能小于 600px
"3": 订单码-迷你前置模式, 对应 iframe 宽度不能小于 75px, 高度不能小于 75px

在回调函数中将BCResult转化成BCQRCodeResult之后做后续处理
调用：（以微信为例）

BCPay.getInstance(GenQRCodeActivity.this).reqWXQRCodeAsync("微信二维码支付测试",                     //商品描述
    1,                      //订单金额
    UUID.randomUUID().toString().replace("-", ""),  //订单流水号
    mapOptional,            //扩展参数，可以null
    true,                   //是否生成二维码的bitmap,
                            //如果为false，请自行根据getQrCodeRawContent返回的结果
                            //使用BCPay.generateBitmap方法生成支付二维码
                            //你也可以使用自己熟悉的二维码生成工具
    300,                   //二维码的尺寸, 以px为单位, 如果为null则默认为360
    new BCCallback() {     //回调入口
        @Override
        public void done(BCResult bcResult) {

            final BCQRCodeResult bcqrCodeResult = (BCQRCodeResult) bcResult;

            //resultCode为0表示请求成功
            if (bcqrCodeResult.getResultCode() == 0) {
                wxQRBitmap = bcqrCodeResult.getQrCodeBitmap();
                Log.w(Tag, "weixin qrcode url: " + bcqrCodeResult.getQrCodeRawContent());

            } else {

                GenQRCodeActivity.this.runOnUiThread(new Runnable() {
                    @Override
                    public void run() {
                        Toast.makeText(GenQRCodeActivity.this, "err code:" + bcqrCodeResult.getResultCode() +
                                "; err msg: " + bcqrCodeResult.getResultMsg() +
                                "; err detail: " + bcqrCodeResult.getErrDetail(), Toast.LENGTH_LONG).show();
                    }
                });

            }
        }
    });

6.查询

  • 查询支付订单

请查看doc中的API，支付类BCQuery，参照demo中BillListActivity

原型：

通过构造BCQuery的实例，使用queryBillsAsync方法发起支付查询，channel指代何种支付方式，为BCReqParams.BCChannelTypes.ALL时则查询所有的支付渠道订单；在回调函数中将BCResult转化成BCQueryBillOrderResult之后做后续处理

调用：

//回调入口
final BCCallback bcCallback = new BCCallback() {
    @Override
    public void done(BCResult bcResult) {
    	//根据需求处理结果数据

        final BCQueryBillOrderResult bcQueryResult = (BCQueryBillOrderResult) bcResult;

        //resultCode为0表示请求成功
        //count包含返回的订单个数
        if (bcQueryResult.getResultCode() == 0) {

			//订单列表
	        bills = bcQueryResult.getBills();
            Log.i(BillListActivity.TAG, "bill count: " + bcQueryResult.getCount());
        } else {
            bills = null;
            BillListActivity.this.runOnUiThread(new Runnable() {
                @Override
                public void run() {
                    //错误信息
                    Toast.makeText(BillListActivity.this, "err code:" + bcQueryResult.getResultCode() +
                            "; err msg: " + bcQueryResult.getResultMsg() +
                            "; err detail: " + bcQueryResult.getErrDetail(), Toast.LENGTH_LONG).show();
                }
            });
        }
    }
};

//发起查询请求
BCQuery.getInstance().queryBillsAsync(
    BCReqParams.BCChannelTypes.UN_APP,      //渠道
    null,                                   //订单号
    startTime.getTime(),                    //订单生成时间
    endTime.getTime(),                      //订单完成时间
    2,                                      //忽略满足条件的前2条数据
    15,                                     //最低返回满足条件的15条数据
    bcCallback);
  • 查询退款订单

请查看doc中的API，支付类BCQuery，参照demo中RefundOrdersActivity

原型：

通过构造BCQuery的实例，使用queryRefundsAsync方法发起退款查询，channel指代何种支付方式，为BCReqParams.BCChannelTypes.ALL时则查询所有的支付渠道退款订单；在回调函数中将BCResult转化成BCQueryRefundOrderResult之后做后续处理

调用：
同上，首先初始化回调入口BCCallback

BCQuery.getInstance().queryRefundsAsync(
    BCReqParams.BCChannelTypes.UN,          //渠道
    null,                                   //订单号
    null,                                   //商户退款流水号
    startTime.getTime(),                    //退款订单生成时间
    endTime.getTime(),                      //退款订单完成时间
    1,                                      //忽略满足条件的前1条数据
    15,                                     //只返回满足条件的15条数据
    bcCallback);
  • 查询订单退款状态

请查看doc中的API，支付类BCQuery，参照demo中RefundStatusActivity

原型：

通过构造BCQuery的实例，使用queryRefundStatusAsync方法发起支付查询，该方法所有参数都必填，channel指代何种支付方式，目前由于第三方API的限制仅支持微信；在回调函数中将BCResult转化成BCQueryRefundStatusResult之后做后续处理

调用：
同上，首先初始化回调入口BCCallback

BCQuery.getInstance().queryRefundStatusAsync(
    BCReqParams.BCChannelTypes.WX,     //目前仅支持微信
    "20150520refund001",                   //退款单号
    bcCallback);                           //回调入口

Demo

考虑到个人的开发习惯，本项目提供了Android Studio和Eclipse ADT两种工程的demo，为了使demo顺利运行，请注意以下细节

  1. 对于使用Android Studio的开发人员，下载源码后可以将demo_eclipse移除，Import Project的时候选择beecloud-android，sdk为demo的依赖model，gradle会自动关联。
  2. 对于使用Eclipse ADT的开发人员，Import Project的时候选择beecloud-android下的demo_eclipse，该demo下面已经添加所有需要的jar。

测试

TODO

常见问题

  • 微信支付返回一般错误，可能的原因：签名错误、未注册APPID、项目设置APPID不正确、注册的APPID与设置的不匹配、其他异常等，请按如下方法依次排查
  1. 项目包名与在微信申请的开发包名是否一致
  2. 订单流水号是否包含横杠-，如果有请去除
  3. 请尝试清除微信缓存，或者删除微信重新安装再试
  4. 项目签名与微信平台设置的签名是否一致，请到微信官网下载签名工具校验
  • demo中支付宝支付，跳转到支付后提示“系统繁忙”：
    由于支付宝对企业账号监控严格，故不再提供支付宝支付的测试功能，请在BeeCloud平台配置正确参数后，使用自行创建的APP的appID和appSecret。给您带来的不便，敬请谅解。

代码贡献

我们非常欢迎大家来贡献代码，我们会向贡献者致以最诚挚的敬意。

一般可以通过在Github上提交Pull Request来贡献代码。

Pull Request要求

  • 代码规范

  • 代码格式化

  • 必须添加测试！ - 如果没有测试（单元测试、集成测试都可以），那么提交的补丁是不会通过的。

  • 记得更新文档 - 保证README.md以及其他相关文档及时更新，和代码的变更保持一致性。

  • 创建feature分支 - 最好不要从你的master分支提交 pull request。

  • 一个feature提交一个pull请求 - 如果你的代码变更了多个操作，那就提交多个pull请求吧。

  • 清晰的commit历史 - 保证你的pull请求的每次commit操作都是有意义的。如果你开发中需要执行多次的即时commit操作，那么请把它们放到一起再提交pull请求。

联系我们

  • 如果有什么问题，可以到BeeCloud开发者1群:321545822 或 BeeCloud开发者2群:427128840 提问
  • 更详细的文档，见源代码的注释以及官方文档
  • 如果发现了bug，欢迎提交issue
  • 如果有新的需求，欢迎提交issue

代码许可

The MIT License (MIT).

About

BeeCloud Android SDK (Open Source)

beecloud.cn

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages