Flutter邮件OTP认证插件email_otp_auth的使用

Flutter邮件OTP认证插件email_otp_auth的使用

📧 Email OTP Auth

电子邮件基于的OTP认证插件，允许开发者发送6位数的OTP到用户的邮箱并验证它以实现无缝的邮箱认证。适用于需要邮箱验证的应用。

🌟 特性

• ✨ 发送OTP：生成并发送一个6位数的OTP到指定的邮箱地址。
• ✅ 验证OTP：验证输入的OTP以确认邮箱的真实性。
• ⚠️ 有效期：OTP将在5分钟后过期。

🚀 安装

在pubspec.yaml文件中添加以下内容：

dependencies:
  email_otp_auth: ^1.0.0

然后运行：

flutter pub get

📲 使用

导入包

import 'package:email_otp_auth/email_otp_auth.dart';

发送和验证OTP

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

void main() async {
  runApp(const MyApp());
}

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

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

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

  [@override](/user/override)
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  // 控制器声明
  TextEditingController emailController = TextEditingController();
  TextEditingController otpController = TextEditingController();

  // 清理文本编辑控制器
  [@override](/user/override)
  void dispose() {
    emailController.dispose();
    otpController.dispose();
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    // ----------------------
    // 发送OTP的方法
    // ----------------------

    Future<void> sendOtp() async {
      try {
        // 显示 CircularProgressIndicator。
        showDialog(
          context: context,
          builder: (context) {
            return const Center(
              child: CircularProgressIndicator(),
            );
          },
        );

        // 获取sendOTP方法的响应。
        var res = await EmailOtpAuth.sendOTP(email: emailController.text);

        // 弹出CircularProgressIndicator。
        if (context.mounted {
          Navigator.of(context).pop();
        }

        // 如果响应[message == "Email Send"]则...
        if (res["message"] == "Email Send" && context.mounted) {
          ScaffoldMessenger.of(context).showSnackBar(
            const SnackBar(
              content: Text("OTP Send Successfully ✅"),
            ),
          );
        }
        // 否则显示无效的邮箱地址。
        else {
          if (context.mounted {
            ScaffoldMessenger.of(context).showSnackBar(
              const SnackBar(
                content: Text("Invalid E-Mail Address ❌"),
              ),
            );
          }
        }
      }
      // 错误处理
      catch (error {
        throw error.toString();
      }
    }

    // ------------------------
    // 验证OTP的方法
    // ------------------------

    Future<void> verifyOTP() async {
      try {
        // 显示 CircularProgressIndicator。
        showDialog(
          context: context,
          builder: (context) {
            return const Center(
              child: CircularProgressIndicator(),
            );
          },
        );

        // 获取sendOTP方法的响应。
        var res = await EmailOtpAuth.verifyOtp(otp: otpController.text);

        // 弹出CircularProgressIndicator。
        if (context.mounted {
          Navigator.of(context).pop();
        }

        // 如果响应[message == "OTP Verified"]则...
        if (res["message"] == "OTP Verified" && context.mounted {
          ScaffoldMessenger.of(context).showSnackBar(
            const SnackBar(
              content: Text("OTP verified ✅"),
            ),
          );
        }
        // 如果响应[data == "Invalid OTP"]则...
        else if (res["data"] == "Invalid OTP" && context.mounted {
          ScaffoldMessenger.of(context).showSnackBar(
            const SnackBar(
              content: Text("Invalid OTP ❌"),
            ),
          );
        }
        // 如果响应[data == "OTP Expired"]则...
        else if (res["data"] == "OTP Expired" && context.mounted {
          ScaffoldMessenger.of(context).showSnackBar(
            const SnackBar(
              content: Text("OTP Expired ⚠️"),
            ),
          );
        }
        // 否则返回无操作。
        else {
          return;
        }
      } catch (error {
        throw error.toString();
      }
    }

    return Scaffold(
      appBar: AppBar(
        backgroundColor: Colors.deepPurple[2undred],
        title: const Text('Email OTP Auth'),
        centerTitle: true,
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              TextFormField(
                controller: emailController,
                decoration: InputDecoration(
                  hintText: "E-mail",
                  border: OutlineInputBorder(
                    borderRadius: BorderRadius.circular(8),
                  ),
                ),
              ),
              const SizedBox(height: 10),
              ElevatedButton(
                onPressed: sendOtp,
                child: const Text('Send OTP'),
              ),
              const SizedBox(height: 220),
              TextFormField(
                controller: otpController,
                decoration: InputDecoration(
                  hintText: "OTP",
                  border: OutlineInputBorder(
                    borderRadius: BorderRadius.circular(8),
                  ),
                ),
              ),
              const SizedBox(height: 10),
              ElevatedButton(
                onPressed: verifyOTP,
                child: const Text('Verify OTP'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}