Как использовать нативный платежный сервис SberPay в кроссплатформенном приложении на Flutter01.11.2023 18:31

/**
* Плагин для оплаты с использованием SberPay. Для работы нужен установленный Сбербанк (либо Сбол).
*/
class SberPayPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {

   private lateinit var channel: MethodChannel
   private lateinit var binding: FlutterPluginBinding
   private lateinit var activity: Activity
   private lateinit var context: Context

   /** Кнопка для управления оплатой **/
   private lateinit var button: SPayButton

   override fun onAttachedToEngine(flutterPluginBinding: FlutterPluginBinding) {
       channel = MethodChannel(flutterPluginBinding.binaryMessenger, "sber_pay")
       binding = flutterPluginBinding
       context = flutterPluginBinding.applicationContext
       channel.setMethodCallHandler(this)
   }

   override fun onMethodCall(call: MethodCall, result: Result) {
       when (call.method) {
           // Инициализация
           "init" -> {
               initialize(call, result)
           }
           // Проверка готовности к оплате
           "isReadyForSPaySdk" -> {
               /**
                * Метод для проверки готовности к оплате.
                * Зависит от переданного аргумента [env] при инициализации через метод [initialize]
                * (см. комментарий к методу). Запрос может выполняться долго.
                *
                * @return Если у пользователя нет установленного сбера в режимах
                * SPayStage.SandboxRealBankApp, SPayStage.prod - вернет false.
                */
               result.success(button.isReadyForSPaySdk())
           }
           // Оплата
           "payWithBankInvoiceId" -> {
               showSberPaymentModal(call, result)
           }

           else -> {
               result.notImplemented()
           }
       }
   }

   /**
    * Метод для оплаты, в аргументы которого обязательно необходимо передать:
    * @property apiKey ключ, выдаваемый по договору, либо создаваемый в личном кабинете;
    * @property merchantLogin логин, выдаваемый по договору, либо создаваемый в личном кабинете;
    * @property appPackage пакет вашего приложения;
    * @property language использовано по умолчанию "RU";
    * @property bankInvoiceId параметр, который получаем после запроса для регистрации заказа в
    * шлюзе Сбера.
    */
   private fun showSberPaymentModal(call: MethodCall, result: Result) {
       val args = call.arguments as Map<*, *>
       var responseSent = false // Флаг для отслеживания отправки ответа
       var hasError = false // Флаг для отслеживания отправки ошибки

       try {
           val apiKey = args["apiKey"] as String
           val merchantLogin = args["merchantLogin"] as String
           val bankInvoiceId = args["bankInvoiceId"] as String
           val appPackage = context.packageName
           val language = "RU"

           if (!responseSent) {
               button.payWithBankInvoiceId(apiKey, merchantLogin, bankInvoiceId, appPackage, language) { response ->
                   when (response) {
                       // Оплата не завершена
                       is PaymentResult.Processing ->
                           result.success("processing")
                       // Оплата прошла успешно
                       is PaymentResult.Success ->
                           result.success("success")
                       // Оплата прошла с ошибкой
                       is PaymentResult.Error -> {
                           if (!hasError) {
                               hasError = true
                               if (response.merchantError is MerchantError.SdkClosedByUser) {
                                   result.success("cancel")
                                   return@payWithBankInvoiceId
                               }
                               result.error("-", "MerchantError", response.merchantError?.description
                                       ?: "Ошибка выполнения оплаты")
                               return@payWithBankInvoiceId
                           }
                       }
                   }
                   responseSent = true
               }
           }
       } catch (error: Exception) {
           result.error("-", error.localizedMessage, error.message)
       }
   }

   /**
    * Метод инициализации, выполняется перед стартом приложения.
    * [env], полученный из FLutter, Тесты со всеми типами [env] лучше всего проводить на реальном
    * устройстве. Он определяет тип запуска:
    *
    * @property SPayStage.SandboxRealBankApp устройство с установленным Сбером;
    * @property SPayStage.SandBoxWithoutBankApp устройство без Сбера;
    * @property SPayStage.prod устройство с установленным Сбером, работает с продовыми данными.
    */
   private fun initialize(call: MethodCall, result: Result) {
       val args = call.arguments as Map<*, *>
       val sPayStage = when (args["env"] as String) {
           "sandboxRealBankApp" -> SPayStage.SandboxRealBankApp
           "sandboxWithoutBankApp" -> SPayStage.SandBoxWithoutBankApp
           else -> {
               SPayStage.Prod
           }
       }
       // Оплата частями
       val enableBnpl = args["enableBnpl"] as Boolean? ?: false

       try {
           SPaySdkApp.getInstance().initialize(application = activity.application, stage = sPayStage, enableBnpl = enableBnpl)
           result.success(true)
       } catch (e: Exception) {
           result.error("-", e.localizedMessage, e.message)
       }
   }

   override fun onDetachedFromEngine(binding: FlutterPluginBinding) {
       channel.setMethodCallHandler(null)
   }

   override fun onAttachedToActivity(activityBinding: ActivityPluginBinding) {
       activity = activityBinding.activity
       button = SPayButton(activity, null)
   }

   override fun onReattachedToActivityForConfigChanges(activityBinding: ActivityPluginBinding) {
       activity = activityBinding.activity
       button = SPayButton(activity, null)
   }

   override fun onDetachedFromActivity() {}

   override fun onDetachedFromActivityForConfigChanges() {}
}

// Плагин для оплаты с использованием SberPay.
public class SberPayPlugin: NSObject, FlutterPlugin {

   public static func register(with registrar: FlutterPluginRegistrar) {
       let channel = FlutterMethodChannel(name: "sber_pay", binaryMessenger: registrar.messenger())
       let instance = SberPayPlugin()
       registrar.addMethodCallDelegate(instance, channel: channel)
       /// Создание [addApplicationDelegate] для перехода по диплинку обратно в приложение
       registrar.addApplicationDelegate(instance)
   }

   public func application(_ app: UIApplication,open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {
       /// Если при открытии приложения с диплинком если он содержит хост "spay", то такой диплинк
       /// попадает в нативный плагин. Таким образом работает возврат в приложение и получение данных нативным
       /// SDK от приложения Сбербанк онлайн/СБОЛ
       if  url.host == "spay" {
           SPay.getAuthURL(url)
       }

       return true
   }

   public func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) {
       switch call.method {
           /// Инициализация
       case "init":
           initialize(call, result:result)
           /// Проверка готовности к оплате
       case "isReadyForSPaySdk":
           /**
            Метод для проверки готовности к оплате.
            Зависит от переданного аргумента [env] при инициализации через метод [initialize]
            (см. комментарий к методу). Запрос может выполняться долго.

            - Returns Если у пользователя нет установленного сбера в режимах SEnvironment.sandboxRealBankApp,
            SEnvironment.prod - вернет false.
            */
           result(SPay.isReadyForSPay)
           // Оплата
       case "payWithBankInvoiceId":
           payWithBankInvoiceId(call, result: result)
       default:
           result(FlutterMethodNotImplemented)
       }
   }

   /**
    Метод для оплаты, в аргументы которого обязательно необходимо передать:
    - Parameter apiKey ключ, выдаваемый по договору, либо создаваемый в личном кабинете;
    - Parameter merchantLogin логин, выдаваемый по договору, либо создаваемый в личном кабинете;
    - Parameter bankInvoiceId параметр, который получаем после запроса для регистрации заказа в
    шлюзе Сбера.
    - Parameter redirectUri диплинк обратно в приложение после перехода в Сбербанк
    */
   private func payWithBankInvoiceId(_ call: FlutterMethodCall, result: @escaping FlutterResult) {
       guard let args = call.arguments as? [String: Any],
             let apiKey = args["apiKey"] as? String,
             let merchantLogin = args["merchantLogin"] as? String,
             let bankInvoiceId = args["bankInvoiceId"] as? String,
             let redirectUri = args["redirectUri"] as? String
       else {
           result(FlutterError(code: "INVALID_ARGUMENTS", message: "Invalid arguments", details: nil))
           return
       }

       if bankInvoiceId.count != 32 {
           result(FlutterError(code: "-", message: "MerchantError", details: "Длина bankInvoiceId должна быть 32 символа"))
           return
       }

       guard let topController = getTopViewController() else {
           result(FlutterError(code: "PluginError", message: "SberPay: Failed to implement controller", details: nil))
           return
       }

       let request = SBankInvoicePaymentRequest(
           merchantLogin: merchantLogin,
           bankInvoiceId: bankInvoiceId,
           language: "RU",
           redirectUri: redirectUri,
           apiKey: apiKey)

       SPay.payWithBankInvoiceId(with: topController, paymentRequest: request) { state, info  in
           switch state {
           case .success:
               result("success")
           case .waiting:
               result("processing")
           case .cancel:
               result("cancel")
           case .error:
               result(FlutterError(code: "-", message: "Ошибка оплаты", details: info))
           @unknown default:
               result(FlutterError(code: "-", message: "Неопределенная ошибка", details: info))
           }
       }
   }

   /**
    Метод инициализации, выполняется перед стартом приложения.
    [env], полученный из FLutter, Тесты со всеми типами [env] лучше всего проводить на реальном устройстве. Он
    определяет тип запуска:

    - Parameter SEnvironment.sandboxRealBankApp устройство с установленным Сбером;
    - Parameter SEnvironment.sandboxWithoutBankApp устройство без Сбера;
    - Parameter SEnvironment.prod устройство с установленным Сбером, работает с продовыми данными.
    - Parameter enableBnpl Функционал Оплата частями
    */
   private func initialize(_ call: FlutterMethodCall, result: @escaping FlutterResult) {
       guard let args = call.arguments as? [String: Any],
             let env = args["env"] as? String
       else {
           result(FlutterError(code: "INVALID_ARGUMENTS", message: "Invalid arguments", details: nil))
           return
       }

       let enableBnpl = args["enableBnpl"] as? Bool ?? false

       let sPayStage: SEnvironment
       switch env {
       case "sandboxRealBankApp":
           sPayStage = .sandboxRealBankApp
       case "sandboxWithoutBankApp":
           sPayStage = .sandboxWithoutBankApp
       default:
           sPayStage = .prod
       }

       SPay.setup(bnplPlan: enableBnpl, environment: sPayStage)
       result(true)
   }

   private func getTopViewController() -> UIViewController? {
       var topController = UIApplication.shared.keyWindow?.rootViewController

       while let presentedViewController = topController?.presentedViewController {
           topController = presentedViewController
       }

       return topController
   }
}

/// Плагин для отображения нативной кнопки SberPay SDK
///
/// Все исключения (Exceptions) приходящие из методов этого класса должны
/// обрабатываться уровнем выше.
class SberPayPlugin {
 static const methodChannel = MethodChannel('sber_pay');

 /// Инициализация SberPay SDK.
 ///
 /// Необходимо выполнить для начала работы с библиотекой.
 /// На платформе Android этот метод является асинхронным, однако у
 /// него нет API (коллбека) для выполнения кода после завершения
 /// инициализации.
 ///
 /// * [env] - среда запуска, которая определяется через [SberPayEnv].
 /// * [enableBnpl] - функционал оплаты частями
 static Future initSberPay({
   required String env,
   bool? enableBnpl,
 }) async {
   final result = await methodChannel.invokeMethod('init', {
     'env': env,
     'enableBnpl': enableBnpl,
   });
   return result ?? false;
 }

 /// Метод для проверки готовности к оплате.
 ///
 /// Зависит от переданного аргумента [env] при инициализации через метод
 /// [initSberPay] (см. комментарий к методу).
 ///
 /// Запрос может выполняться долго, поэтому здесь стоит искусственная
 /// задержка, чтобы дождаться инициализации SDK.
 ///
 /// Если у пользователя нет установленного сбера в режимах
 /// [SberPayEnv.sandboxRealBankApp], [SberPayEnv.prod] - вернет false.
 static Future isReadyForSPaySdk() async {
   final result = await methodChannel.invokeMethod('isReadyForSPaySdk');
   if (result == null || result == false) {
     await Future.delayed(
       const Duration(seconds: 2),
       () async {
         return await methodChannel.invokeMethod('isReadyForSPaySdk');
       },
     );
   }
   return result ?? false;
 }

 /// Метод оплаты через SberPay SDK.
 /// * [apiKey] - ключ, выдаваемый по договору, либо создаваемый в личном
 /// кабинете;
 /// * [merchantLogin] - логин, выдаваемый по договору, либо создаваемый в
 /// личном кабинете;
 /// * [bankInvoiceId] - параметр, который получаем после запроса для
 /// регистрации заказа в шлюзе Сбера.
 /// * [redirectUri] - диплинк для перехода обратно в приложение после открытия
 /// Сбербанка (только на iOS).
 ///
 /// Возвращает статус оплаты [SberPayPaymentStatus]
 static Future payWithBankInvoiceId({
   required String apiKey,
   required String merchantLogin,
   required String bankInvoiceId,
   required String redirectUri,
 }) async {
   final result = await methodChannel.invokeMethod(
     'payWithBankInvoiceId',
     {
       'apiKey': apiKey,
       'merchantLogin': merchantLogin,
       'bankInvoiceId': bankInvoiceId,
       'redirectUri': redirectUri,
     },
   );
   return SberPayPaymentStatus.fromString(result);
 }
}

/// Необходимо указать по данным из договора
const _apiKey = '';
const _merchantLogin = '';

/// Диплинк на переход в приложение
const _redirectUri = 'sbersdk://spay';

void main() => runApp(const SberPayExampleApp());

class SberPayExampleApp extends StatefulWidget {
 const SberPayExampleApp({super.key});

 @override
 State createState() => _SberPayExampleAppState();
}

class _SberPayExampleAppState extends State {
 late final TextEditingController _controller;
 late String _paymentStatus;
 late bool _isPluginLoading;
 late bool _isAppReadyForPay;
 late bool _isPluginInitialized;
 late SberPayEnv _selectedInitType;
 late Color _color;

 @override
 void initState() {
   super.initState();
   _controller = TextEditingController();
   _paymentStatus = '';
   _selectedInitType = SberPayEnv.sandboxWithoutBankApp;
   _isPluginLoading = false;
   _isAppReadyForPay = false;
   _isPluginInitialized = false;
   _color = Colors.grey;
   _readyForPay();
 }

 Future _readyForPay() async {
   setState(() => _isPluginLoading = true);
   _isPluginInitialized = await SberPayPlugin.initSberPay(
     env: _selectedInitType.name,
   );
   if (mounted) setState(() {});

   _isAppReadyForPay = await SberPayPlugin.isReadyForSPaySdk();
   if (!_isAppReadyForPay) {
     _isAppReadyForPay = await SberPayPlugin.isReadyForSPaySdk();
   }
   if (mounted) setState(() => _isPluginLoading = false);
 }

 void _setEnv(SberPayEnv env) {
   _selectedInitType = env;
   _paymentStatus = '';
   _color = Colors.grey;
   _readyForPay();
 }

 @override
 void dispose() {
   _controller.dispose();
   super.dispose();
 }

 @override
 Widget build(BuildContext context) {
   return MaterialApp(
     theme: ThemeData(
       colorScheme: ColorScheme.fromSeed(seedColor: const Color(0xFF21A038)),
       useMaterial3: true,
     ),
     home: Scaffold(
       appBar: AppBar(
         title: const Text('SberPay plugin example'),
         backgroundColor: const Color(0xFF21A038),
         centerTitle: true,
       ),
       body: Builder(
         builder: (context) {
           return Padding(
             padding: const EdgeInsets.all(8.0),
             child: SingleChildScrollView(
               child: Column(
                 mainAxisSize: MainAxisSize.min,
                 children: [
                   Table(
                       border: TableBorder.all(),
                       defaultVerticalAlignment:
                           TableCellVerticalAlignment.middle,
                       children: [
                         _tableRowWrapper(
                           'Тип запуска',
                           Column(
                             children: [
                               ChoiceChip(
                                 label: const Text('Прод'),
                                 selected:
                                     _selectedInitType == SberPayEnv.prod,
                                 onSelected: (_) => _setEnv(SberPayEnv.prod),
                               ),
                               const SizedBox(
                                 width: 10,
                               ),
                               ChoiceChip(
                                 label: const Text('Песочница/Банк'),
                                 selected: _selectedInitType ==
                                     SberPayEnv.sandboxRealBankApp,
                                 onSelected: (_) => _setEnv(
                                   SberPayEnv.sandboxRealBankApp,
                                 ),
                               ),
                               const SizedBox(
                                 width: 10,
                               ),
                               ChoiceChip(
                                 label: const Text('Песочница'),
                                 selected: _selectedInitType ==
                                     SberPayEnv.sandboxWithoutBankApp,
                                 onSelected: (_) => _setEnv(
                                   SberPayEnv.sandboxWithoutBankApp,
                                 ),
                               ),
                             ],
                           ),
                         ),
                         _tableRowWrapper(
                           'Плагин проинициализирован',
                           Text(_isPluginLoading
                               ? 'Загрузка'
                               : _isPluginInitialized
                                   ? "ДА"
                                   : "НЕТ"),
                         ),
                         _tableRowWrapper(
                           'Оплата доступна',
                           Text(_isPluginLoading
                               ? 'Загрузка'
                               : _isAppReadyForPay
                                   ? "ДА"
                                   : "НЕТ"),
                         ),
                         _tableRowWrapper(
                           'Статус операции оплаты',
                           SizedBox(
                             height: 80,
                             child: Row(
                               children: [
                                 CircleAvatar(
                                   backgroundColor: _color,
                                   radius: 10.0,
                                 ),
                                 Flexible(
                                   child: Text(
                                     _paymentStatus.isEmpty
                                         ? "Оплата не производилась"
                                         : _paymentStatus,
                                     textAlign: TextAlign.center,
                                   ),
                                 )
                               ],
                             ),
                           ),
                         ),
                       ]),
                   const SizedBox(height: 16),
                   Padding(
                     padding: const EdgeInsets.symmetric(horizontal: 16),
                     child: TextField(
                       controller: _controller,
                       textInputAction: TextInputAction.done,
                       decoration: InputDecoration(
                         hintText: 'Введите bankInvoiceID',
                         suffixIcon: GestureDetector(
                           onTap: () {
                             _controller.clear();
                             _color = Colors.grey;
                             setState(() => _paymentStatus = '');
                           },
                           child: const Icon(Icons.close, size: 32),
                         ),
                       ),
                     ),
                   ),
                   const SizedBox(height: 16),
                   Padding(
                     padding: const EdgeInsets.symmetric(horizontal: 16),
                     child: _isPluginLoading
                         ? Container(
                             height: 48,
                             decoration: BoxDecoration(
                               color: const Color(0xFF21A038),
                               borderRadius: BorderRadius.circular(12),
                             ),
                             child: const Center(
                               child: CircularProgressIndicator(
                                 color: Colors.white,
                               ),
                             ),
                           )
                         : SberPayButton(
                             onPressed: () async {
                               if (_apiKey.isEmpty || _merchantLogin.isEmpty) {
                                 ScaffoldMessenger.of(context).showSnackBar(
                                   const SnackBar(
                                     content: Text(
                                       'Не заданы apiKey и/или merchantLogin',
                                     ),
                                     duration: Duration(seconds: 2),
                                   ),
                                 );
                                 return;
                               }
                               if (_controller.text.isEmpty) {
                                 ScaffoldMessenger.of(context).showSnackBar(
                                   const SnackBar(
                                     content: Text('Введите bankInvoiceID'),
                                     duration: Duration(seconds: 2),
                                   ),
                                 );
                               } else {
                                 try {
                                   final result = await SberPayPlugin
                                       .payWithBankInvoiceId(
                                     apiKey: _apiKey,
                                     merchantLogin: _merchantLogin,
                                     bankInvoiceId: _controller.text,
                                     redirectUri: _redirectUri,
                                   );
                                   switch (result) {
                                     case SberPayPaymentStatus.success:
                                       _color = Colors.green;
                                       _paymentStatus =
                                           'Оплата прошла успешно';
                                       break;
                                     case SberPayPaymentStatus.processing:
                                       _color = Colors.yellow;
                                       _paymentStatus =
                                           'Необходимо проверить статус оплаты';
                                       break;
                                     case SberPayPaymentStatus.cancel:
                                       _color = Colors.blue;
                                       _paymentStatus =
                                           'Пользователь отменил оплату';
                                       break;
                                     case SberPayPaymentStatus.unknown:
                                       _color = Colors.purple;
                                       _paymentStatus =
                                           'Неизвестное состояние';
                                   }
                                   setState(() {});
                                 } on PlatformException catch (e) {
                                   setState(
                                     () {
                                       _color = Colors.red;
                                       _paymentStatus = e.details ?? '';
                                     },
                                   );
                                 }
                               }
                             },
                           ),
                   ),
                 ],
               ),
             ),
           );
         },
       ),
     ),
   );
 }

 TableRow _tableRowWrapper(String title, Widget secondChild) {
   return TableRow(
     children: [
       TableCell(child: Text(title, textAlign: TextAlign.center)),
       Padding(
         padding: const EdgeInsets.all(4.0),
         child: Center(child: secondChild),
       ),
     ],
   );
 }
}