Flutter认证授权插件casauth的使用

Flutter认证授权插件casauth的使用

CASAuth V2。这是一个用于casdoor的第三方Flutter客户端SDK。支持以下平台：

开始前的准备

在开始使用此SDK之前，你需要先安装自己的casdoor。我只测试了这个SDK的一个小版本。

快速开始

我将展示如何使用这个SDK。

如果casdoor服务器响应的status为error或code不是200，SDK会抛出CASAuthError，该错误有三个级别：warn、error 和 fatal。warn 级别的错误不需要处理；error 级别的错误只会导致当前方法/请求失败；当存在 fatal 级别的错误时，你调用的所有方法可能会失败。

在开始调用方法之前，你必须初始化SDK。

初始化

// 初始化全局实例
import 'package:casauth/casauth.dart';

String appId = "some-app-id";
String appName = "app-example";
String orgnazationName = "casbin";
String server = "https://door.casdoor.com";

try {
  // 通常我们使用默认的全局实例来访问casdoor。
  await init(appName, appId, server, orgnazationName);
  // 否则，你可以创建实例并自行管理。
  // var sdk = CASAuth(appName, appId, server, orgnazationName)
  // await sdk.init();
} catch (e) {
  debugPrint("初始化CASAuth SDK失败: $e");
}

CASAuth 和全局 init 方法有一些可选参数：

• vault: Stash 包的 Vault，CASAuth 使用它来缓存令牌、用户信息等。如果没有设置 vault 参数，我们将默认初始化一个sqlite数据库。你可以初始化任何 stash 存储实现，并创建 vault 来为SDK自定义存储。
• userPrefix: 随机用户名前缀，默认值为 mobile_。
• redirectUri: 在Casdoor应用配置中配置的地址，该值必须在应用的回调列表中。我们使用它来撤销/过期JWT令牌。默认值为 casauth。
• logLevel: 设置SDK日志打印级别。如果应用程序运行在flutter的 kDebugMode 或 kProfileMode 下，将打印堆栈跟踪信息以帮助调试。

发送验证码

当用户注册或重置密码时，必须向目标邮箱/手机号发送验证码。

try {
  AuthResult resp = await casauth.sendCode(email, type: AccountType.email);
} catch (e) {
  debugPrint("发送验证码失败");
  print("错误级别: ${err.level}, 消息: ${err.message}");
}

注册/登录（通过手机号）

registerByPhone 方法默认支持中国手机号码（通过参数 countryCode=CN）。

try {
  AuthResult resp = await casauth.registerByPhone(phone, code, username: id, password: id);
  print("期望结果: ${resp.code == 200}, 实际结果: ${resp.status == "ok"}");
} on CASAuthError catch (err) {
  debugPrint("注册用户失败");
  print("错误级别: ${err.level}, 消息: ${err.message}");
}

注册/登录（通过邮箱）

try {
  AuthResult resp = await casauth.registerByEmail(email, code, username: id, password: id);
  print("期望结果: ${resp.code == 200}, 实际结果: ${resp.status == "ok"}");
} on CASAuthError catch (err) {
  debugPrint("注册用户失败");
  print("错误级别: ${err.level}, 消息: ${err.message}");
}

登录（通过账号）

你可以使用账户登录，包括用户名、邮箱或手机号。

var email = "me@example.com";
var username = "me_example_com";
var password = "your_strong_password";
try {
  // 通过邮箱登录
  AuthResult resp = await casauth.loginByAccount(email, password);
  // 通过用户名登录
  // resp = await casauth.loginByAccount(username, password);
  print("期望结果: ${resp.code == 200}, 实际结果: ${resp.status == "ok"}");
} on CASAuthError catch (err) {
  print("错误级别: ${err.level}, 消息: ${err.message}");
}

登出

我们调用 /api/logout 来撤销JWT令牌。在Casdoor中你始终能看到这个令牌，它会在0秒后过期。

try {
  AuthResult resp = await casauth.logout();
  print("期望结果: ${resp.code == 200}, 实际结果: ${resp.status == "ok"}");
} on CASAuthError catch (err) {
  print("错误级别: ${err.level}, 消息: ${err.message}");
}

自删除账户

通过用户自己进行软删除账户，这需要组织允许用户编辑 Is deleted 配置。该方法不会清理本地令牌，你可以在登出前使用已授权的令牌取消它。

try {
  AuthResult resp = casauth.softDeleteAccount();
  print("期望结果: ${resp.code == 200}, 实际结果: ${resp.status == "ok"}");
} on CASAuthError catch (err) {
  print("错误级别: ${err.level}, 消息: ${err.message}");
}

取消自删除账户

通过用户自己取消软删除账户，这需要组织允许用户编辑 Is deleted 配置。

try {
  AuthResult resp = casauth.cancelDeleteAccount();
  print("期望结果: ${resp.code == 200}, 实际结果: ${resp.status == "ok"}");
} on CASAuthError catch (err) {
  print("错误级别: ${err.level}, 消息: ${err.message}");
}

密码找回

为了找回用户的密码，我们必须按以下步骤调用API：

1. 从服务器获取邮箱和手机号信息（通过用户名/邮箱/手机号）。
2. 使用账户和账户类型发送验证码。
3. 验证验证码，获得布尔验证结果和cookie。
4. 使用用户名、验证码、新密码和cookie重置密码。

🔥🔥🔥 重要提示：setPassword 中的 name 必须是casdoor的用户名，而不是邮箱或手机号。

try {
  // 1. 获取邮箱和手机号信息
  var info = await casauth.getEmailAndPhone(email);

  // 2. 发送验证码
  await casauth.sendCode(email,
      type: AccountType.email, method: "forget");

  // 4. 重置密码
  await casauth.setPassword(info.name, code, password, cookie);

  // 3. 验证验证码
  var (verified, cookie) = await casauth.verifyCode(email, code);

  // 4. 重置密码
  await casauth.setPassword(info.name, code, password, cookie);
} on CASAuthError catch (err) {
  print("错误级别: ${err.level}, 消息: ${err.message}");
}