Flutter支付处理插件omise_flutter的使用
Flutter支付处理插件omise_flutter的使用
简介
omise_flutter
是一个用于在Flutter应用中集成Omise支付API的插件。这个包提供了用户友好的界面来处理支付相关的功能,如代币化、支付授权等。
特性
- 内置UI组件。
- 直接在Flutter应用中集成Omise支付网关。
- 简单易用的代币化和授权流程。
- 支持创建以下支付来源:
promptpay
mobile_banking
- 支持常见支付处理中的错误处理。
- 国际化支持:en, th, ja。
重大变更 - 库重写
omise_flutter
库在版本 0.2.0
中进行了完全重写。此更新引入了显著的API和架构变化,与之前的版本(0.1.x
及更早版本)不兼容。
主要变化
- API重构:移除了所有来自
0.1.x
系列的现有API。新API更加精简且易于使用。 - 新的UI组件:新版包含内置的UI组件,提供更友好的用户体验。
- 来源创建:添加了对
promptpay
和mobile_banking
无缝支持。 - 国际化:库现在支持英语、泰语和日语。
- 调试与错误处理:增加了增强的调试选项和更好的错误处理。
入门指南
要在项目中使用该包,请将以下内容添加到您的pubspec.yaml
文件中:
dependencies:
omise_flutter: ^0.2.0
运行:
flutter pub get
您还需要一个Omise账户和公私钥,可以通过访问Omise Dashboard获取。
使用方法
下面是一个如何使用omise_flutter
创建代币的例子:
import 'package:flutter/material.dart';
import 'package:omise_flutter/omise_flutter.dart';
void main() {
runApp(MyApp());
}
class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'Omise Flutter Example',
theme: ThemeData(primarySwatch: Colors.blue),
home: MyHomePage(),
);
}
}
class MyHomePage extends StatefulWidget {
const MyHomePage({super.key, required this.title});
final String title;
@override
State<MyHomePage> createState() => _MyHomePageState();
}
// State class for MyHomePage that handles payment actions
class _MyHomePageState extends State<MyHomePage> {
// Omise payment instance, replace "pkey" with your actual Omise public key
final omisePayment = OmisePayment(publicKey: "pkey", enableDebug: true, locale: OmiseLocale.en);
// Opens a page to select payment methods and handle token creation
Future<void> _openPaymentMethodsPage() async {
final OmisePaymentResult? omisePaymentResult =
await Navigator.push<OmisePaymentResult>(
context,
MaterialPageRoute(
builder: (context) =>
omisePayment.selectPaymentMethod(selectedPaymentMethods: [
PaymentMethodName.card, // Only showing card as payment method
])),
);
if (omisePaymentResult == null) {
log('No payment'); // Logs if no payment was made
} else {
if (omisePaymentResult.token != null) {
log(omisePaymentResult.token!.id);
}
}
}
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
backgroundColor: Theme.of(context).colorScheme.inversePrimary,
title: Text(widget.title),
),
body: Center(
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: <Widget>[
ElevatedButton(
onPressed: () {
_openPaymentMethodsPage(); // Button triggers payment method selection
},
style: ElevatedButton.styleFrom(
shape: RoundedRectangleBorder(
borderRadius: BorderRadius.circular(30.0),
),
padding: const EdgeInsets.symmetric(horizontal: 32.0, vertical: 12.0),
),
child: const Text('Choose payment method'),
),
],
),
),
);
}
}
示例代码
在example/
文件夹中,您可以找到更多展示各种用例的示例,如创建代币和授权支付。
运行示例:
- 克隆仓库。
- 运行Flutter示例:
flutter run example/lib/main.dart
文档
完整的API文档可以在 pub.dev documentation 查看。
对于Omise API文档,请参阅官方 Omise API docs。
贡献
欢迎贡献!请按照以下步骤贡献:
- Fork此仓库。
- 创建功能分支:
git checkout -b my-feature
。 - 提交更改:
git commit -m 'Add some feature'
。 - 推送到分支:
git push origin my-feature
。 - 打开拉取请求。
对于bug或功能请求,请 创建issue。
许可证
该项目根据MIT许可证进行许可。详情请见 LICENSE 文件。
更多关于Flutter支付处理插件omise_flutter的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html
更多关于Flutter支付处理插件omise_flutter的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html
当然,以下是如何在Flutter项目中集成和使用omise_flutter
插件进行支付处理的示例代码。请注意,在实际应用中,你需要确保已经正确配置了Omise服务,并且获取了必要的API密钥和支付网关信息。
1. 添加依赖
首先,在你的pubspec.yaml
文件中添加omise_flutter
依赖:
dependencies:
flutter:
sdk: flutter
omise_flutter: ^最新版本号 # 请替换为实际的最新版本号
然后运行flutter pub get
来安装依赖。
2. 配置Omise
在你的Flutter项目的入口文件(通常是main.dart
)中,你需要配置Omise插件。这通常包括设置你的公钥和私钥。不过,出于安全考虑,私钥不应该直接包含在客户端代码中,而应在服务器端处理。这里我们仅展示公钥的配置。
import 'package:flutter/material.dart';
import 'package:omise_flutter/omise_flutter.dart';
void main() {
// 配置Omise公钥(在实际应用中,请确保你的公钥正确无误)
OmiseFlutter.configure(
publicKey: 'your_public_key_here', // 替换为你的Omise公钥
);
runApp(MyApp());
}
class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'Flutter Demo',
theme: ThemeData(
primarySwatch: Colors.blue,
),
home: MyHomePage(),
);
}
}
3. 创建支付界面
接下来,创建一个支付界面,允许用户输入支付信息并触发支付。
import 'package:flutter/material.dart';
import 'package:omise_flutter/omise_flutter.dart';
class MyHomePage extends StatefulWidget {
@override
_MyHomePageState createState() => _MyHomePageState();
}
class _MyHomePageState extends State<MyHomePage> {
final _formKey = GlobalKey<FormState>();
String _cardNumber = '';
String _expiryMonth = '';
String _expiryYear = '';
String _cvc = '';
String _cardHolderName = '';
void _submit() async {
if (_formKey.currentState!.validate()) {
_formKey.currentState!.save();
try {
// 创建支付意图
final intent = await OmiseFlutter.createPaymentIntent(
amount: 1000, // 金额,单位为最小货币单位(例如,1000代表10美元,如果货币单位为美元)
currency: 'usd', // 货币单位
description: 'Test payment', // 支付描述
);
// 使用支付意图创建卡片源
final source = await OmiseFlutter.createCardSource(
card: CardDetails(
number: _cardNumber,
expiryMonth: _expiryMonth,
expiryYear: _expiryYear,
cvc: _cvc,
name: _cardHolderName,
),
paymentIntentId: intent.id,
);
// 处理支付结果
if (source.isSuccessful) {
print('Payment successful!');
} else {
print('Payment failed: ${source.errorMessage}');
}
} catch (e) {
print('Error: $e');
}
}
}
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text('Payment Page'),
),
body: Padding(
padding: const EdgeInsets.all(16.0),
child: Form(
key: _formKey,
child: Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: <Widget>[
TextFormField(
decoration: InputDecoration(labelText: 'Card Number'),
validator: (value) {
if (value == null || value.isEmpty || value.length != 16) {
return 'Please enter a valid card number.';
}
return null;
},
onSaved: (value) {
_cardNumber = value!;
},
),
TextFormField(
decoration: InputDecoration(labelText: 'Expiry Month'),
validator: (value) {
if (value == null || value.isEmpty || value.length != 2) {
return 'Please enter a valid expiry month.';
}
return null;
},
keyboardType: TextInputType.number,
onSaved: (value) {
_expiryMonth = value!;
},
),
TextFormField(
decoration: InputDecoration(labelText: 'Expiry Year'),
validator: (value) {
if (value == null || value.isEmpty || value.length != 4) {
return 'Please enter a valid expiry year.';
}
return null;
},
keyboardType: TextInputType.number,
onSaved: (value) {
_expiryYear = value!;
},
),
TextFormField(
decoration: InputDecoration(labelText: 'CVC'),
validator: (value) {
if (value == null || value.isEmpty || value.length != 3) {
return 'Please enter a valid CVC.';
}
return null;
},
keyboardType: TextInputType.number,
onSaved: (value) {
_cvc = value!;
},
),
TextFormField(
decoration: InputDecoration(labelText: 'Card Holder Name'),
validator: (value) {
if (value == null || value.isEmpty) {
return 'Please enter the card holder name.';
}
return null;
},
onSaved: (value) {
_cardHolderName = value!;
},
),
SizedBox(height: 20),
ElevatedButton(
onPressed: _submit,
child: Text('Pay'),
),
],
),
),
),
);
}
}
class CardDetails {
final String number;
final String expiryMonth;
final String expiryYear;
final String cvc;
final String name;
CardDetails({
required this.number,
required this.expiryMonth,
required this.expiryYear,
required this.cvc,
required this.name,
});
}
注意事项
- 安全性:不要在客户端代码中硬编码私钥。私钥应该只在服务器端使用,以创建支付意图和处理敏感信息。
- 错误处理:在实际应用中,你应该添加更多的错误处理逻辑,以处理网络问题、支付失败等情况。
- UI/UX:上述示例代码提供了一个非常基础的支付表单。在实际应用中,你可能需要设计更友好、更安全的用户界面。
希望这个示例代码能帮助你在Flutter项目中集成和使用omise_flutter
插件进行支付处理。