Flutter支付集成插件payhere_flutter的使用

Payhere插件简介

Payhere是一款为Flutter开发者提供的支付网关插件。它模仿了原生Payhere Android SDK的功能，使支付流程与原生SDK保持一致。

以下是插件的一些截图：

安装插件

在您的项目pubspec.yaml文件中添加以下依赖项：

dependencies:
  payhere_flutter: ^0.1.1

运行flutter pub get以安装插件。

使用插件进行支付

导入插件包

首先需要导入payhere_flutter包：

import 'package:payhere_flutter/payhere_flutter.dart';

创建支付请求对象

创建一个InitRequest对象，并设置必要的参数：

InitRequest req = new InitRequest();

// 必填参数
req.setMerchantId("1210XXX"); // 您的商户PayHere ID
req.setMerchantSecret("ugknesnvn"); // 您的商户密钥（在Settings > Domains & Credentials中获取）
req.setCurrency("LKR"); // 货币代码，例如LKR/USD/GBP/EUR/AUD
req.setAmount(1000.00); // 最终支付金额
req.setOrderId("230000123"); // 唯一订单ID
req.setItemsDescription("门铃无线"); // 商品描述
req.setCustom1("这是自定义消息1");
req.setCustom2("这是自定义消息2");

// 设置客户信息
req.getCustomer().setFirstName("张");
req.getCustomer().setLastName("三");
req.getCustomer().setEmail("zhangsan@example.com");
req.getCustomer().setPhone("+8613800138000");
req.getCustomer().getAddress().setAddress("北京市朝阳区");
req.getCustomer().getAddress().setCity("北京");
req.getCustomer().getAddress().setCountry("中国");

// 可选参数：设置配送地址
req.getCustomer().getDeliveryAddress().setAddress("上海市浦东新区");
req.getCustomer().getDeliveryAddress().setCity("上海");
req.getCustomer().getDeliveryAddress().setCountry("中国");

// 添加商品
req.getItems().add(new Item(null, "门铃无线", 1, 1000.0));

发起支付请求

调用oneTimePaymentSandbox或oneTimePaymentLive方法来发起支付请求。示例如下：

RaisedButton(
  onPressed: () async {
    // 测试环境
    PhResponse response =
        await PayhereFlutter.oneTimePaymentSandbox(request: req);
    
    // 生产环境
    // PhResponse response =
    //     await PayhereFlutter.oneTimePaymentLive(request: req);

    print("支付状态: ${response.status}");
    print("支付信息: ${response.data?.toJson()}");
  },
  child: Text("发起一次支付"),
),

返回结果解析

PhResponse对象包含以下字段：

• status: 支付状态。
• data: 包含交易详细信息。
• message: 交易简要说明。

示例返回值：

{
  "status": 1,
  "data": {
    "status": 2,
    "paymentNo": 123456789,
    "currency": "LKR",
    "price": 1000.0,
    "sign": "abcdef123456",
    "message": "支付成功"
  },
  "message": "支付成功"
}

支付状态代码：

示例代码

以下是一个完整的示例代码，展示了如何在Flutter应用中集成Payhere插件：

import 'package:flutter/cupertino.dart';
import 'package:flutter/material.dart';
import 'package:payhere_flutter/payhere_flutter.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: PaymentPage(),
    );
  }
}

class PaymentPage extends StatefulWidget {
  @override
  _PaymentPageState createState() => _PaymentPageState();
}

class _PaymentPageState extends State<PaymentPage> {
  InitRequest req = InitRequest();
  String responseText = "";

  @override
  void initState() {
    super.initState();
    initRequest();
  }

  void initRequest() {
    req.setMerchantId("YOUR_MERCHANT_ID");
    req.setMerchantSecret("YOUR_MERCHANT_SECRET");
    req.setCurrency("LKR");
    req.setAmount(1000.00);
    req.setOrderId("ORDER12345");
    req.setItemsDescription("门铃无线");
    req.setCustom1("自定义消息1");
    req.setCustom2("自定义消息2");

    req.getCustomer().setFirstName("张");
    req.getCustomer().setLastName("三");
    req.getCustomer().setEmail("zhangsan@example.com");
    req.getCustomer().setPhone("+8613800138000");
    req.getCustomer().getAddress().setAddress("北京市朝阳区");
    req.getCustomer().getAddress().setCity("北京");
    req.getCustomer().getAddress().setCountry("中国");

    req.getCustomer().getDeliveryAddress().setAddress("上海市浦东新区");
    req.getCustomer().getDeliveryAddress().setCity("上海");
    req.getCustomer().getDeliveryAddress().setCountry("中国");

    req.getItems().add(new Item(null, "门铃无线", 1, 1000.0));
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("Payhere支付示例"),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            ElevatedButton(
              onPressed: () async {
                PhResponse response =
                    await PayhereFlutter.oneTimePaymentSandbox(request: req);

                setState(() {
                  responseText = "支付状态: ${response.status}\n支付信息: ${response.data?.toJson()}";
                });
              },
              child: Text("发起支付"),
            ),
            SizedBox(height: 20),
            Text(responseText),
          ],
        ),
      ),
    );
  }
}

配置代码缩减

如果您启用了R8代码缩减器，请确保配置proguard-rules.pro文件以保留Payhere相关的类：

buildTypes {
  release {
    minifyEnabled true
    useProguard true
    proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
    signingConfig signingConfigs.debug
  }
}

在proguard-rules.pro中添加以下规则：

-keep class lk.payhere.** { *; }

或者禁用代码缩减：

flutter build --no-shrink