Flutter App Essentials #

Flutter App Essentials 是一个综合性的包，旨在通过提供基本的功能和实用工具来加速应用程序开发。它包括认证管理、API 集成、异常处理等。使用 Flutter App Essentials，开发者可以快速启动他们的项目，并专注于构建优秀的用户体验。

功能 #

• 认证仓库：用于管理用户认证，包括登录、注册、密码重置和用户资料管理。
• 用户管理器：用于管理与用户相关的数据和交互，如用户偏好设置、资料更新和访问控制。
• 令牌管理器：一个安全的令牌管理系统，用于处理用户认证令牌并刷新过期令牌。
• API 层：抽象化的层，用于处理 API 请求和响应，包括身份验证头和错误处理。
• 简洁的 main.dart 文件：包含样板代码、应用程序初始化和路由设置的精简 main.dart 文件。
• 认证逻辑：预先实现的认证逻辑，用于处理登录、注册、会话管理和用户状态。
• 异常处理器：一个集中的异常处理机制，用于统一捕获和处理错误。
• SnackBar 处理器：用于显示 SnackBars 和 Toast 消息的工具，提供一致的用户反馈机制。

安装 #

要在您的 Flutter 项目中使用 App Essentials，请将以下依赖项添加到您的 pubspec.yaml 文件中：

dependencies:
  app_essentials: ^1.0.0

开始使用 #

TODO: 列出先决条件并提供或指向如何开始使用该包的信息。

使用 #

import 'package:flutter/material.dart';
import 'package:app_essentials/app_essentials.dart';
void main() {
AppEssentials().main();
}

贡献 #

欢迎贡献！如果您发现任何问题或有改进建议，请在 GitHub 仓库上创建一个新的问题或提交拉取请求。

许可证 #

该项目根据 MIT 许可证授权。

完整示例 Demo

下面是一个完整的示例，展示了如何使用 app_essentials 包来实现一个简单的登录和注册功能。

pubspec.yaml

name: app_essentials_demo
description: A demo application using the app_essentials package.
version: 1.0.0
environment:
  sdk: ">=2.12.0 <3.0.0"
dependencies:
  flutter:
    sdk: flutter
  app_essentials: ^1.0.0

main.dart

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

void main() {
  AppEssentials().main();
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'App Essentials Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: LoginPage(),
    );
  }
}

class LoginPage extends StatefulWidget {
  [@override](/user/override)
  _LoginPageState createState() => _LoginPageState();
}

class _LoginPageState extends State<LoginPage> {
  final TextEditingController _emailController = TextEditingController();
  final TextEditingController _passwordController = TextEditingController();

  void _login() async {
    // 假设这是登录逻辑
    String email = _emailController.text;
    String password = _passwordController.text;

    // 调用 app_essentials 的登录方法
    bool success = await AppEssentials().authRepository.login(email, password);
    if (success) {
      ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text('Login successful')));
      Navigator.pushReplacement(context, MaterialPageRoute(builder: (_) => HomePage()));
    } else {
      ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text('Login failed')));
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Login Page'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          children: [
            TextField(
              controller: _emailController,
              decoration: InputDecoration(labelText: 'Email'),
            ),
            TextField(
              controller: _passwordController,
              obscureText: true,
              decoration: InputDecoration(labelText: 'Password'),
            ),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: _login,
              child: Text('Login'),
            ),
            TextButton(
              onPressed: () {
                Navigator.push(
                  context,
                  MaterialPageRoute(builder: (context) => RegisterPage()),
                );
              },
              child: Text('Register'),
            ),
          ],
        ),
      ),
    );
  }
}

class RegisterPage extends StatefulWidget {
  [@override](/user/override)
  _RegisterPageState createState() => _RegisterPageState();
}

class _RegisterPageState extends State<RegisterPage> {
  final TextEditingController _emailController = TextEditingController();
  final TextEditingController _passwordController = TextEditingController();

  void _register() async {
    // 假设这是注册逻辑
    String email = _emailController.text;
    String password = _passwordController.text;

    // 调用 app_essentials 的注册方法
    bool success = await AppEssentials().authRepository.register(email, password);
    if (success) {
      ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text('Registration successful')));
      Navigator.pop(context);
    } else {
      ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text('Registration failed')));
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Register Page'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          children: [
            TextField(
              controller: _emailController,
              decoration: InputDecoration(labelText: 'Email'),
            ),
            TextField(
              controller: _passwordController,
              obscureText: true,
              decoration: InputDecoration(labelText: 'Password'),
            ),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: _register,
              child: Text('Register'),
            ),
          ],
        ),
      ),
    );
  }
}

class HomePage extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Home Page'),
      ),
      body: Center(
        child: Text('Welcome to Home Page'),
      ),
    );
  }
}