Flutter GitHub登录插件github_sign_in的使用

在本教程中，我们将介绍如何使用Flutter的github_sign_in插件实现GitHub登录功能。通过简单的步骤，您可以轻松集成GitHub登录到您的Flutter应用中。

获取开始

首先，在pubspec.yaml文件中添加github_sign_in依赖：

dependencies:
  github_sign_in: ^0.0.1

然后运行以下命令以安装依赖：

flutter pub get

使用步骤

1. 初始化 GitHubSignIn

在使用插件之前，您需要在GitHub开发者平台创建一个OAuth应用程序，并获取clientId、clientSecret和redirectUrl。

• clientId: 您的应用程序的唯一标识符。
• clientSecret: 您的应用程序的密码。
• redirectUrl: 用户授权后重定向的URL。

初始化GitHubSignIn对象：

final GitHubSignIn gitHubSignIn = GitHubSignIn(
  clientId: 'YOUR_CLIENT_ID', // 替换为您的GitHub clientId
  clientSecret: 'YOUR_CLIENT_SECRET', // 替换为您的GitHub clientSecret
  redirectUrl: 'YOUR_REDIRECT_URL', // 替换为您的GitHub redirectUrl
);

2. 调用登录方法

在需要触发登录的地方调用signIn方法。例如，在按钮点击事件中：

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

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('GitHub Login Example')),
        body: Center(
          child: ElevatedButton(
            onPressed: () async {
              final GitHubSignIn gitHubSignIn = GitHubSignIn(
                clientId: 'YOUR_CLIENT_ID',
                clientSecret: 'YOUR_CLIENT_SECRET',
                redirectUrl: 'YOUR_REDIRECT_URL',
              );

              var result = await gitHubSignIn.signIn(context);

              // 处理登录结果
              switch (result.status) {
                case GitHubSignInResultStatus.ok:
                  print('登录成功！Token: ${result.token}');
                  break;

                case GitHubSignInResultStatus.cancelled:
                  print('用户取消了登录');
                  break;

                case GitHubSignInResultStatus.failed:
                  print('登录失败！错误信息: ${result.errorMessage}');
                  break;
              }
            },
            child: Text('GitHub 登录'),
          ),
        ),
      ),
    );
  }
}

3. 测试登录流程

运行应用并点击“GitHub 登录”按钮，系统将跳转到GitHub的授权页面。用户可以输入凭据完成授权。授权完成后，您将在控制台中看到返回的Token或错误信息。

完整示例代码

以下是完整的示例代码，您可以直接复制并在项目中运行：

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

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('GitHub Login Example')),
        body: Center(
          child: ElevatedButton(
            onPressed: () async {
              final GitHubSignIn gitHubSignIn = GitHubSignIn(
                clientId: 'YOUR_CLIENT_ID', // 替换为您的GitHub clientId
                clientSecret: 'YOUR_CLIENT_SECRET', // 替换为您的GitHub clientSecret
                redirectUrl: 'YOUR_REDIRECT_URL', // 替换为您的GitHub redirectUrl
              );

              var result = await gitHubSignIn.signIn(context);

              // 处理登录结果
              switch (result.status) {
                case GitHubSignInResultStatus.ok:
                  print('登录成功！Token: ${result.token}');
                  break;

                case GitHubSignInResultStatus.cancelled:
                  print('用户取消了登录');
                  break;

                case GitHubSignInResultStatus.failed:
                  print('登录失败！错误信息: ${result.errorMessage}');
                  break;
              }
            },
            child: Text('GitHub 登录'),
          ),
        ),
      ),
    );
  }
}