Flutter认证授权插件kimko_auth的使用

Overview

kimko_auth 是一个用于管理 Flutter 应用程序用户认证的强大库。它支持多种操作，如登录、注册、注销、获取用户详细信息、更新个人资料信息、更新头像以及停用账户。

目录

1. 安装
2. 使用
3. 公共方法
4. 示例代码
5. 唯一应用ID

安装

在您的 Flutter 项目中使用 kimko_auth 库时，将其添加到 pubspec.yaml 文件中：

dependencies:
  kimko_auth: ^1.0.4

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

flutter pub get

使用

在项目中添加 kimko_auth 后，通过导入包并初始化 KimkoAuth 来开始使用。

初始化库

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

KimkoAuth kimkoAuth = KimkoAuth();

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await KimkoAuth.initialize(teamId: 'your-team-id'); // 替换为您的团队ID

  runApp(const MyApp());
}

kimiko 响应类

kimiko 提供了一个响应类 KimikoResponse 和异常类 KimikoException 来处理 API 返回的结果。

class KimikoResponse {
  final dynamic data;
  final String? error;
  final int? statusCode;

  KimikoResponse({this.data, this.error, this.statusCode});

  bool get isSuccess => error == null;
}

class KimikoException implements Exception {
  final String? error;

  KimikoException({this.error});
}

kimiko 用户 JSON 示例

返回的用户数据格式如下：

{
  "id": "",
  "first_name": "",
  "last_name": "",
  "is_active": true,
  "email": "somethingm@gmail.com",
  "avatar_url": ""
}

注册功能

返回值：

Future<KimikoResponse>
包含用户响应

示例代码：

TextEditingController emailController = TextEditingController();
TextEditingController passwordController = TextEditingController();
TextEditingController fNameController = TextEditingController();
TextEditingController lNameController = TextEditingController();
TextEditingController userNameController = TextEditingController();

Future<void> signUp() async {
  try {
    var res = await kimkoAuth.signup(
        username: userNameController.text.trim(),
        email: emailController.text.trim(),
        password: passwordController.text.trim(),
        firstName: fNameController.text.trim(),
        lastName: lNameController.text.trim());
    Navigator.of(context).pushReplacement(
        MaterialPageRoute(builder: (_) => const LoginScreen()));
  } on KimikoException catch (e) {
    print('Kimiko ${e.error}');
  } catch (e) {
    print("Another error $e");
  }
}

登录功能

返回值：

Future<KimikoResponse>
包含用户响应

示例代码：

TextEditingController emailController = TextEditingController();
TextEditingController passwordController = TextEditingController();

Future<void> signIn(BuildContext context) async {
  try {
    var res = await kimkoAuth.signIn(
        email: emailController.text.trim(),
        password: passwordController.text.trim());
  } on KimikoException catch (e) {
    print('Kimiko ${e.error}');
  } catch (e) {
    print("Another error $e");
  }
}

获取用户信息

从 API 获取用户详细信息。

返回值：

Future<KimikoResponse>
包含用户响应

示例代码：

Future<void> getUser() async {
  try {
    var res = await kimkoAuth.getUser();
    print(res.data);
    if (res.data != null) {
      setState(() {
        user.value = res.data['data'];
      });
      Navigator.of(context).push(MaterialPageRoute(builder: (_) => const ProfileScreen()));
    }
  } on KimikoException catch (e) {
    debugPrint('Kimiko ${e.error}');
    errorSnack(e.error.toString(), context: context);
  } catch (e) {
    debugPrint("Another error $e");
    errorSnack(e.toString(), context: context);
  }
}

获取已登录用户

获取当前已登录用户的详细信息。

返回值：

Future<KimikoResponse>
包含用户响应

示例代码：

var res = await kimkoAuth.getLoggedInUser();
print(res.data);

更新用户信息

更新用户的详细信息，包括名字、姓氏、头像 URL 和用户名。

返回值：

Future<KimikoResponse>
包含用户响应

示例代码：

Future<void> updateUser() async {
  try {
    var res = await kimkoAuth.updateUser(
      firstName: fNameController.text.trim(),
      lastName: lNameController.text.trim(),
      avatarUrl: newImageURL,
    );
    print(res.data);
  } on KimikoException catch (e) {
    debugPrint('Kimiko ${e.error}');
    errorSnack(e.error.toString(), context: context);
  } catch (e) {
    debugPrint("Another error $e");
    errorSnack(e.toString(), context: context);
  }
}

注销

此方法会删除所有用户数据并结束会话。

返回值：

Future<KimikoResponse>
包含用户响应

示例代码：

var res = await kimkoAuth.logOut();

团队ID

以下是不同团队及其对应的 ID：

示例代码完整 Demo

以下是一个完整的示例代码，展示如何集成 kimko_auth 的登录和注册功能：

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

KimkoAuth kimkoAuth = KimkoAuth();

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await KimkoAuth.initialize(teamId: 'your-team-id');
  runApp(const MyApp());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: const LoginScreen(),
    );
  }
}

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

  [@override](/user/override)
  State<LoginScreen> createState() => _LoginScreenState();
}

class _LoginScreenState extends State<LoginScreen> {
  final emailController = TextEditingController();
  final passwordController = TextEditingController();

  Future<void> signIn() async {
    try {
      final res = await kimkoAuth.signIn(
          email: emailController.text.trim(),
          password: passwordController.text.trim());
      print(res.data);
    } on KimikoException catch (e) {
      print('Kimiko ${e.error}');
    } catch (e) {
      print("Another error $e");
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text("Login")),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          children: [
            TextField(
              controller: emailController,
              decoration: const InputDecoration(labelText: "Email"),
            ),
            TextField(
              controller: passwordController,
              obscureText: true,
              decoration: const InputDecoration(labelText: "Password"),
            ),
            ElevatedButton(
              onPressed: signIn,
              child: const Text("Login"),
            ),
            TextButton(
              onPressed: () {
                Navigator.push(
                  context,
                  MaterialPageRoute(builder: (_) => const SignUpScreen()),
                );
              },
              child: const Text("Sign Up"),
            ),
          ],
        ),
      ),
    );
  }
}

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

  [@override](/user/override)
  State<SignUpScreen> createState() => _SignUpScreenState();
}

class _SignUpScreenState extends State<SignUpScreen> {
  final emailController = TextEditingController();
  final passwordController = TextEditingController();
  final firstNameController = TextEditingController();
  final lastNameController = TextEditingController();
  final usernameController = TextEditingController();

  Future<void> signUp() async {
    try {
      final res = await kimkoAuth.signup(
        username: usernameController.text.trim(),
        email: emailController.text.trim(),
        password: passwordController.text.trim(),
        firstName: firstNameController.text.trim(),
        lastName: lastNameController.text.trim(),
      );
      print(res.data);
    } on KimikoException catch (e) {
      print('Kimiko ${e.error}');
    } catch (e) {
      print("Another error $e");
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text("Sign Up")),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          children: [
            TextField(
              controller: firstNameController,
              decoration: const InputDecoration(labelText: "First Name"),
            ),
            TextField(
              controller: lastNameController,
              decoration: const InputDecoration(labelText: "Last Name"),
            ),
            TextField(
              controller: usernameController,
              decoration: const InputDecoration(labelText: "Username"),
            ),
            TextField(
              controller: emailController,
              decoration: const InputDecoration(labelText: "Email"),
            ),
            TextField(
              controller: passwordController,
              obscureText: true,
              decoration: const InputDecoration(labelText: "Password"),
            ),
            ElevatedButton(
              onPressed: signUp,
              child: const Text("Sign Up"),
            ),
          ],
        ),
      ),
    );
  }
}