Flutter Yandex登录插件flutter_login_yandex的使用

Flutter Yandex登录插件flutter_login_yandex的使用

概述

flutter_login_yandex 是一个用于在iOS和Android平台上通过Yandex LoginSDK进行授权的Flutter插件。

开始使用

首先，你需要注册一个Yandex OAuth应用，请参考官方文档（链接已去掉）。

Android 配置

在你的 android/app/build.gradle 文件的 defaultConfig 部分添加以下内容，并将 yourClientId 替换为你的Yandex OAuth应用的客户端ID：

defaultConfig {
    applicationId "com.example.flutter_login_yandex_example"
    minSdkVersion flutter.minSdkVersion
    targetSdkVersion flutter.targetSdkVersion
    versionCode flutterVersionCode.toInteger()
    versionName flutterVersionName
    // 添加以下行
    manifestPlaceholders = [YANDEX_CLIENT_ID:"yourClientId"]
}

iOS 配置

在你的 Info.plist 文件中添加以下内容，并将 yourClientId 替换为你的Yandex OAuth应用的客户端ID：

<key>LSApplicationQueriesSchemes</key>
<array>
    <string>yandexauth</string>
    <string>yandexauth2</string>
    <string>yandexauth4</string>
</array>
<key>YAClientId</key>
<string>yourClientId</string>
<key>CFBundleURLTypes</key>
<array>
    <dict>
        <key>CFBundleURLName</key>
        <string>YandexLoginSDK</string>
        <key>CFBundleURLSchemes</key>
        <array>
            <string>yxyourClientId</string>
        </array>
    </dict>
</array>

在 AppDelegate.swift 中添加以下代码：

@available(iOS 8.0, *)
func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([Any]?) -> Void) -> Bool {
   YXLSdk.shared.processUserActivity(userActivity)
   return true
}

// Application delegate
override public func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    return YXLSdk.shared.handleOpen(url, sourceApplication: options[UIApplication.OpenURLOptionsKey.sourceApplication] as? String)
}

如果已有 OpenURL 处理器，需要将其与现有代码合并。

还需设置权限，添加“关联域名”功能，并输入替换后的域名：

applinks:yxyourClientId.oauth.yandex.ru

如果有编译时的弃用错误，可以使用 @MariyanskiDev 的修复方法。在 Podfile 的目标中添加：

pod 'YandexLoginSDK', :git => 'https://github.com/MariyanskiDev/yandex-login-sdk-ios', :branch => 'depreciation_fix'

应用中的使用

简单示例如下：

final flutterLoginYandexPlugin = FlutterLoginYandex();
final response = await _flutterLoginYandexPlugin.signIn();
saveToken(response['token'] as String);

完整示例 Demo

import 'dart:io';

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

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

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

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _token = 'empty';
  final _flutterLoginYandexPlugin = FlutterLoginYandex();

  [@override](/user/override)
  void initState() {
    super.initState();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('插件示例应用'),
        ),
        body: Center(
          child: Column(
            children: [
              Text('Token: $_token\n', textAlign: TextAlign.center),
              InkWell(
                onTap: () async {
                  // 调用signIn方法进行登录
                  final response = await _flutterLoginYandexPlugin.signIn();
                  if (response != null) {
                    setState(() {
                      if (response['token'] != null) {
                        _token = response['token'] as String;
                      } else {
                        _token = response['error'] as String;
                      }
                    });
                  }
                },
                child: const Padding(padding: EdgeInsets.all(15), child: Text('点击登录')),
              ),
              if (Platform.isIOS)
                InkWell(
                  onTap: () async {
                    // 调用signOut方法进行登出
                    final response = await _flutterLoginYandexPlugin.signOut();
                    setState(() {
                      _token = '';
                    });
                  },
                  child: const Padding(padding: EdgeInsets.all(15), child: Text('退出登录')),
                ),
            ],
          ),
        ),
      ),
    );
  }
}