Flutter身份验证插件releans_verify的使用

在本插件中，你可以通过releans API发送和验证一次性密码（OTP）。

导入

import 'package:releans_verify/releans.dart';

初始化releans

1. 复制API密钥从releans仪表板并设置apiKey。
2. 从releans仪表板创建发送者并设置sender。
3. 设置重新发送延迟时间（以秒为单位），默认延迟时间为15秒。

void main() async {
  ReleansVerify().init(
      apiKey: "XXXXXXXXXXXXXXXXX",
      sender: "XXXXXXXXX",
      resendingDelayInSeconds: 30
  );

  runApp(MyApp());
}

发送OTP

1. 使用手机号调用sendCode方法。
2. 手机号应包含国家代码。
3. 指定通道，默认为短信。

ReleansResult result =
await ReleansVerify().sendCode(mobile: "+9715200000");

ReleansResult result = await ReleansVerify()
  .sendCode(mobile:"+9715200000",channel: Channel.voice);

监听剩余倒计时时间

1. 监听ReleansVerify().remainingSeconds以显示剩余秒数。
2. 如果你想手动取消计时器，调用disposeTimer()。

ValueListenableBuilder<int>(
      valueListenable: ReleansVerify().remainingSeconds,
      builder: (context, value, _) {
      return Text("resend after $value sec");
  }),

ReleansVerify().disposeTimer();

验证OTP

1. 使用用户输入的代码和手机号调用verifyCode方法。

ReleansResult result = await ReleansVerify().verifyCode(
                      code: "0000", mobile:"+9715200000");

处理结果

1. ReleansResult对象将在sendCode和verifyCode方法后返回。
2. 通过使用result.message查看响应消息。
3. 通过使用result.isSuccess()检查请求是否成功。

//打印消息
log("message ${result.message}");
//打印状态码
log("status ${result.status}");
//检查请求是否成功
log("isSuccess ${result.isSuccess()}");

完整示例

以下是一个完整的示例，展示了如何使用releans_verify插件进行身份验证。

import 'dart:developer';

import 'package:flutter/material.dart';
import 'package:releans_verify/releans.dart';

void main() {
  //初始化releans SMS，使用API密钥和发送者
  //如果不存在，请在仪表板中创建新的发送者
  ReleansVerify().init(
      apiKey: "xxxxxxxxxxxxxxxxxxxxxxxx",
      sender: "xxxxx",
      resendingDelayInSeconds: 30);
  runApp(const MyApp());
}

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

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

class _MyAppState extends State<MyApp> {
  var mobileNumberTextField = TextEditingController();
  var codeTextField = TextEditingController();

  String sendingMsg = "";
  String verifyMsg = "";

  bool isErrorSending = false;
  bool isErrorVerify = false;
  bool isVerified = false;

  [@override](/user/override)
  void initState() {
    mobileNumberTextField.text = "+971527827667";
    super.initState();
  }

  send() async {
    if (mobileNumberTextField.text.trim().isEmpty) return;
    //发送OTP，使用手机号
    //设置通道，默认为Channel.voice
    ReleansResult result = await ReleansVerify()
        .sendCode(mobile: mobileNumberTextField.text.trim());
    //打印消息
    log("message ${result.message}");
    //打印状态码
    log("status ${result.status}");
    //检查请求是否成功
    log("isSuccess ${result.isSuccess()}");
    setState(() {
      sendingMsg = result.message!;
      isErrorSending = !result.isSuccess();
    });
  }

  verify() async {
    if (mobileNumberTextField.text.trim().isEmpty ||
        codeTextField.text.trim().isEmpty) return;
    //验证代码，使用用户输入的代码和手机号
    ReleansResult result = await ReleansVerify().verifyCode(
        code: codeTextField.text.trim(),
        mobile: mobileNumberTextField.text.trim());
    //打印消息
    log("message ${result.message}");
    //打印状态码
    log("status ${result.status}");
    //检查请求是否成功
    log("isSuccess ${result.isSuccess()}");
    setState(() {
      verifyMsg = result.message!;
      isErrorVerify = !result.isSuccess();
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Releans Verify'),
        ),
        body: Padding(
          padding: const EdgeInsets.all(10.0),
          child: Column(
            children: [
              const SizedBox(height: 20),
              Row(
                children: [
                  Expanded(
                      child: TextField(
                    controller: mobileNumberTextField,
                    decoration: const InputDecoration(
                      focusedBorder: OutlineInputBorder(
                        borderSide: BorderSide(color: Colors.grey, width: 1.0),
                      ),
                      enabledBorder: OutlineInputBorder(
                        borderSide: BorderSide(color: Colors.grey, width: 1.0),
                      ),
                      hintText: 'Mobile Number',
                    ),
                  )),
                  const SizedBox(width: 15),
                  ElevatedButton(
                    onPressed: send,
                    child: const Text("Send"),
                  ),
                ],
              ),
              const SizedBox(height: 20),
              Row(
                mainAxisAlignment: MainAxisAlignment.center,
                children: [
                  ValueListenableBuilder<int>(
                      valueListenable: ReleansVerify().remainingSeconds,
                      builder: (context, value, _) {
                        return Text("remaining $value sec");
                      }),
                  const SizedBox(width: 20),
                  ElevatedButton(
                    onPressed: () {
                      ReleansVerify().disposeTimer();
                    },
                    child: const Text("Cancel Timer"),
                  ),
                ],
              ),
              Padding(
                padding: const EdgeInsets.all(8.0),
                child: Text(
                  sendingMsg,
                  style: TextStyle(
                      color: isErrorSending ? Colors.red : Colors.green),
                ),
              ),
              const Divider(),
              Row(
                children: [
                  Expanded(
                      child: TextField(
                    controller: codeTextField,
                    decoration: const InputDecoration(
                      focusedBorder: OutlineInputBorder(
                        borderSide: BorderSide(color: Colors.grey, width: 1.0),
                      ),
                      enabledBorder: OutlineInputBorder(
                        borderSide: BorderSide(color: Colors.grey, width: 1.0),
                      ),
                      hintText: 'Code',
                    ),
                  )),
                  const SizedBox(width: 15),
                  ElevatedButton(
                    onPressed: verify,
                    child: const Text("Verify"),
                  ),
                ],
              ),
              Padding(
                padding: const EdgeInsets.all(8.0),
                child: Text(
                  verifyMsg,
                  style: TextStyle(
                      color: isErrorVerify ? Colors.red : Colors.green),
                ),
              ),
              const SizedBox(height: 20),
              Row(
                crossAxisAlignment: CrossAxisAlignment.center,
                mainAxisAlignment: MainAxisAlignment.center,
                children: [
                  Text(isVerified ? "Verified" : "Unverified"),
                  Icon(isVerified
                      ? Icons.verified_user
                      : Icons.verified_user_outlined),
                ],
              ),
            ],
          ),
        ),
      ),
    );
  }
}