Flutter未知功能插件khqr_sdk的使用

简介

KHQR SDK 是一个用于处理柬埔寨国家银行（NBC）提供的支付二维码标准（KHQR）的Flutter插件。它允许开发者生成和验证KHQR码，以及创建深度链接和展示KHQR卡片组件。

注意: 此插件并非由NBC官方发布，而是一个连接Dart代码与原生平台特定SDK的简单接口层，以无缝桥接Flutter和原生功能。

文档参考

支持的平台

• ✅ iOS
• ✅ Android

特性支持

平台特定设置

iOS

1. 添加源到Podfile (ios/Podfile)

   source "https://sambo:ycfXmxxRbyzEmozY9z6n@gitlab.nbc.gov.kh/khqr/khqr-ios-pod.git"
   

   注意: 如果您没有看到Podfile，请在pubspec.yaml中禁用Swift Package Manager。

   flutter:
     disable-swift-package-manager: true
   

   保存后，Podfile将自动生成。
2. 运行pod install（确保您的终端在ios文件夹中）

   pod install
   

Android

无需任何操作，开箱即用。

使用方法

创建KHQR SDK实例

import 'package:khqr_sdk/khqr_sdk.dart';

final _khqrSdk = KhqrSdk();

生成个人KHQR码

final info = IndividualInfo(
  bakongAccountId: 'kimhak@dev',
  merchantName: 'Kimhak',
  accountInformation: '123456789',
);
final khqrData = await _khqrSdk.generateIndividual(info);

生成商户KHQR码

final info = MerchantInfo(
  bakongAccountId: 'kimhak@dev',
  acquiringBank: 'Dev Bank',
  merchantId: '123456',
  merchantName: 'Kimhak',
);
final khqrData = await _khqrSdk.generateMerchant(info);

验证KHQR码

const qrCode = '00020101021129270010kimhak@dev01091234567895204599953031165802KH5906Kimhak6010Phnom Penh9917001317324625358296304B59E';
final isValid = await _khqrSdk.verify(qrCode);

解析KHQR码

const qrCode = '00020101021129270010kimhak@dev01091234567895204599953031165802KH5906Kimhak6010Phnom Penh9917001317324625358296304B59E';
final khqrDecodeData = await _khqrSdk.decode(qrCode);

生成KHQR深度链接

const qrCode = '00020101021129270010kimhak@dev01091234567895204599953031165802KH5906Kimhak6010Phnom Penh9917001317324625358296304B59E';

final sourceInfo = SourceInfo(
  appName: 'Example App',
  appIconUrl: 'http://cdn.example.com/icons.logo.png',
  appDeepLinkCallBack: 'http://app.example.com/callback',
);

final deeplinkInfo = DeeplinkInfo(
  qr: qrCode,
  url: 'http://api.example.com/v1/generate_deeplink_by_qr',
  sourceInfo: sourceInfo,
);

final deeplinkData = await _khqrSdk.generateDeepLink(deeplinkInfo);

显示KHQR卡片组件

KhqrCardWidget(
  width: 300.0,
  receiverName: 'Kimhak',
  amount: 0.00,
  keepIntegerDecimal: false,
  currency: KhqrCurrency.khr,
  qr: khqrContent,
),

示例项目

以下是完整的示例项目代码，展示了如何在Flutter应用中使用khqr_sdk：

import 'package:flutter/material.dart';
import 'package:khqr_sdk/khqr_sdk.dart';

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'KHQR SDK Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: HomeScreen(),
    );
  }
}

class HomeScreen extends StatefulWidget {
  @override
  _HomeScreenState createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {
  final _khqrSdk = KhqrSdk();
  String _result = '';

  Future<void> _generateIndividual() async {
    try {
      final info = IndividualInfo(
        bakongAccountId: 'kimhak@dev',
        merchantName: 'Kimhak',
        accountInformation: '123456789',
      );
      final khqrData = await _khqrSdk.generateIndividual(info);
      setState(() {
        _result = 'Generated Individual QR: $khqrData';
      });
    } catch (e) {
      setState(() {
        _result = 'Error: $e';
      });
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('KHQR SDK Demo'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            ElevatedButton(
              onPressed: _generateIndividual,
              child: Text('Generate Individual QR'),
            ),
            SizedBox(height: 20),
            Text(_result),
          ],
        ),
      ),
    );
  }
}

此示例项目展示了如何生成个人KHQR码，并在界面上显示结果。您可以根据需要扩展此示例，添加其他功能如生成商户KHQR码、验证和解析KHQR码等。

Bug或请求

如果您遇到任何问题，请自由地在GitHub上提交issue。如果您觉得库缺少某些特性，请提交feature request。

支持

不要忘记给这个项目点赞👍 或加星⭐。

希望这些信息能帮助您更好地理解和使用khqr_sdk插件！