Flutter认证授权插件frog_auth的使用

Flutter认证授权插件frog_auth的使用

安装

dart pub add frog_auth

使用

基本认证

要支持基本认证（Basic authentication），只需添加basicAuthentication中间件：

Handler middleware(Handler handler) {
    return handler.use(
        basicAuthentication(
            retrieveUser: (username, password) async {
                // TODO 按用户名和密码检索用户
            },
        ),
    );
}

retrieveUser回调函数应被用来通过给定的用户名和密码查找用户。如果没有找到与给定凭据匹配的用户，则返回null。

如果retrieveUser回调函数返回一个非空用户对象，它将被提供给当前请求上下文，并且可以使用context.read()进行检索。

retrieveUser可以返回任何继承自Object的对象，因此应该足够灵活以适应任何数据库系统。

承载认证

要支持承载认证（Bearer authentication），只需添加bearerAuthentication中间件：

Handler middleware(Handler handler) {
    return handler.use(
        bearerAuthentication(
            retrieveUser: (token) async {
                // TODO 按令牌检索用户
            },
        ),
    );
}

retrieveUser回调函数应被用来通过给定的令牌查找用户。如果没有找到与给定令牌匹配的用户，则返回null。

如果retrieveUser回调函数返回一个非空用户对象，它将被提供给当前请求上下文，并且可以使用context.read()进行检索。

retrieveUser可以返回任何继承自Object的对象，因此应该足够灵活以适应任何数据库系统。

示例代码

以下是一个完整的示例，展示了如何在Flutter应用中使用frog_auth插件实现基本认证和承载认证。

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

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Frog Auth Example'),
        ),
        body: Center(
          child: Text('Frog Auth Example'),
        ),
      ),
    );
  }
}

// 假设我们有一个简单的用户数据库
Map<String, String> users = {
  'user1': 'password1',
  'user2': 'password2',
};

// 基本认证
Handler basicAuthMiddleware(Handler handler) {
  return handler.use(
    basicAuthentication(
      retrieveUser: (username, password) async {
        if (users.containsKey(username) && users[username] == password) {
          return {'id': username}; // 返回用户信息
        }
        return null; // 用户未找到
      },
    ),
  );
}

// 承载认证
Handler bearerAuthMiddleware(Handler handler) {
  return handler.use(
    bearerAuthentication(
      retrieveUser: (token) async {
        if (users.containsKey(token)) {
          return {'id': token}; // 返回用户信息
        }
        return null; // 用户未找到
      },
    ),
  );
}

// 主页面
class HomePage extends StatefulWidget {
  [@override](/user/override)
  _HomePageState createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Column(
      mainAxisAlignment: MainAxisAlignment.center,
      children: [
        ElevatedButton(
          onPressed: () {
            // 模拟基本认证登录
            Navigator.push(
              context,
              MaterialPageRoute(
                builder: (context) => BasicAuthPage(),
              ),
            );
          },
          child: Text('Basic Auth Login'),
        ),
        SizedBox(height: 20),
        ElevatedButton(
          onPressed: () {
            // 模拟承载认证登录
            Navigator.push(
              context,
              MaterialPageRoute(
                builder: (context) => BearerAuthPage(),
              ),
            );
          },
          child: Text('Bearer Auth Login'),
        ),
      ],
    );
  }
}

// 基本认证页面
class BasicAuthPage extends StatefulWidget {
  [@override](/user/override)
  _BasicAuthPageState createState() => _BasicAuthPageState();
}

class _BasicAuthPageState extends State<BasicAuthPage> {
  final TextEditingController _usernameController = TextEditingController();
  final TextEditingController _passwordController = TextEditingController();

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Basic Auth Page'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          children: [
            TextField(
              controller: _usernameController,
              decoration: InputDecoration(labelText: 'Username'),
            ),
            TextField(
              controller: _passwordController,
              obscureText: true,
              decoration: InputDecoration(labelText: 'Password'),
            ),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: () {
                // 登录逻辑
                String username = _usernameController.text;
                String password = _passwordController.text;

                // 检查用户是否存在
                if (users.containsKey(username) && users[username] == password) {
                  ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text('Login successful')));
                } else {
                  ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text('Invalid credentials')));
                }
              },
              child: Text('Login'),
            ),
          ],
        ),
      ),
    );
  }
}

// 承载认证页面
class BearerAuthPage extends StatefulWidget {
  [@override](/user/override)
  _BearerAuthPageState createState() => _BearerAuthPageState();
}

class _BearerAuthPageState extends State<BearerAuthPage> {
  final TextEditingController _tokenController = TextEditingController();

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Bearer Auth Page'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          children: [
            TextField(
              controller: _tokenController,
              decoration: InputDecoration(labelText: 'Token'),
            ),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: () {
                // 登录逻辑
                String token = _tokenController.text;

                // 检查用户是否存在
                if (users.containsKey(token)) {
                  ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text('Login successful')));
                } else {
                  ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text('Invalid credentials')));
                }
              },
              child: Text('Login'),
            ),
          ],
        ),
      ),
    );
  }
}