keycloak_flutter_sdk 是一个用于在 Flutter 应用中集成 Keycloak 身份验证的插件。Keycloak 是一个开源的身份和访问管理解决方案，支持单点登录（SSO）、OAuth2、OpenID Connect 等协议。

以下是如何在 Flutter 项目中使用 keycloak_flutter_sdk 插件的步骤：

1. 添加依赖

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

dependencies:
  flutter:
    sdk: flutter
  keycloak_flutter_sdk: ^1.0.0  # 请使用最新版本

然后运行 flutter pub get 来安装依赖。

2. 初始化 Keycloak

在你的 Flutter 应用中初始化 Keycloak。通常，你可以在 main.dart 文件中进行初始化。

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

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化 Keycloak
  final keycloak = Keycloak();
  await keycloak.init(
    config: KeycloakConfig(
      url: 'https://your-keycloak-server.com/auth', // Keycloak 服务器地址
      realm: 'your-realm', // 你的 realm
      clientId: 'your-client-id', // 你的客户端 ID
    ),
  );

  runApp(MyApp(keycloak: keycloak));
}

class MyApp extends StatelessWidget {
  final Keycloak keycloak;

  MyApp({required this.keycloak});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Keycloak Demo',
      home: HomeScreen(keycloak: keycloak),
    );
  }
}

3. 登录和注销

在应用的某个页面（例如 HomeScreen）中，你可以实现登录和注销功能。

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

class HomeScreen extends StatelessWidget {
  final Keycloak keycloak;

  HomeScreen({required this.keycloak});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Keycloak Flutter Demo'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            ElevatedButton(
              onPressed: () async {
                try {
                  await keycloak.login();
                  print('Login successful');
                } catch (e) {
                  print('Login failed: $e');
                }
              },
              child: Text('Login'),
            ),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: () async {
                try {
                  await keycloak.logout();
                  print('Logout successful');
                } catch (e) {
                  print('Logout failed: $e');
                }
              },
              child: Text('Logout'),
            ),
          ],
        ),
      ),
    );
  }
}

4. 获取用户信息

你可以使用 keycloak 实例来获取当前用户的详细信息。

void getUserInfo() async {
  try {
    final userInfo = await keycloak.getUserInfo();
    print('User Info: $userInfo');
  } catch (e) {
    print('Failed to get user info: $e');
  }
}

5. 处理令牌

你可以使用 keycloak 实例来获取访问令牌、刷新令牌等。

void getTokens() async {
  try {
    final accessToken = await keycloak.getAccessToken();
    final refreshToken = await keycloak.getRefreshToken();
    print('Access Token: $accessToken');
    print('Refresh Token: $refreshToken');
  } catch (e) {
    print('Failed to get tokens: $e');
  }
}

6. 处理令牌刷新

你可以设置一个定时器或监听器来自动刷新令牌。

void setupTokenRefresh() {
  keycloak.onTokenExpired = () async {
    try {
      await keycloak.refreshToken();
      print('Token refreshed');
    } catch (e) {
      print('Failed to refresh token: $e');
    }
  };
}

7. 处理错误

在使用 keycloak_flutter_sdk 时，可能会遇到各种错误，例如网络问题、令牌过期等。确保在代码中正确处理这些错误。

void handleErrors() async {
  try {
    await keycloak.login();
  } catch (e) {
    print('Error: $e');
    // 处理错误，例如显示错误消息给用户
  }
}

8. 配置 Keycloak 服务器

确保你的 Keycloak 服务器已正确配置，并且客户端设置允许 Flutter 应用进行身份验证。

9. 运行应用

完成上述步骤后，运行你的 Flutter 应用，并测试登录、注销、获取用户信息等功能。

flutter run