搜索插件、代码仓与 APP 分类

插件详情v0.1.2

shelf_session

`shelf_session` 是 `shelf` 的 `cookiesMiddleware` 和 `sessionMiddleware` 的实现。

AndroidiOSmacOSWindowsLinux
近 30 天下载
22
喜欢数
2
Pub 分数
160

安装插件

flutter pub add shelf_session

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

shelf_session 包为 Dart 中的 Shelf HTTP 服务器框架提供会话管理和 cookie 处理中间件。它通过使用 cookies 存储和检索会话数据,实现有状态的交互,使使用 Shelf 构建的 Web 应用程序更容易管理用户会话。该包与 Shelf 的中间件架构无缝集成,为身份验证、用户追踪以及跨请求的持久状态提供轻量级解决方案。它支持安全的 cookie 设置,适用于简单的和复杂的服务器端逻辑。

适合场景

  • 在基于 Shelf 的服务器中管理用户会话
  • 在HTTP请求之间存储用户特定数据
  • 实现身份验证流程
  • 处理有状态的Web交互
  • 使用会话支持构建 REST API

主要特点

  • Shelf 的会话中间件
  • 基于 Cookie 的会话存储
  • 安全的 cookie 配置
  • 与 Shelf 中间件轻松集成
  • 支持会话数据的序列化

适合对象

  • 基于书架的Web服务器
  • 有状态的Web应用程序
  • 认证系统
  • 需要会话管理的后端服务
  • 使用 Shelf 框架的 Dart 开发人员

使用建议

  • 需要正确的 Cookie 安全设置
  • 存储在服务器端的会话数据可能需要持久化
  • 不适用于需要额外协调的高规模分布式系统
  • 仅限货架生态系统
  • 会话过期和清理必须手动管理

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

shelf_session

The shelf_session is the implementation of cookiesMiddleware and sessionMiddleware for shelf.

Version: 0.1.0

About

Adds two middleware for shelf:

  • cookiesMiddleware
  • sessionMiddleware

The cookiesMiddleware can be used independently.
The sessionMiddleware depends on cookiesMiddleware and must be used after it.

final pipeline = const Pipeline()
    .addMiddleware(cookiesMiddleware())
    .addMiddleware(sessionMiddleware())
    .addHandler(handler);

A small workable example:

import 'dart:io' show Cookie;

import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart' as io;
import 'package:shelf_router/shelf_router.dart';
import 'package:shelf_session/cookies_middleware.dart';
import 'package:shelf_session/session_middleware.dart';
import 'package:shelf_static/shelf_static.dart';

void main(List<String> args) async {
  final router = Router();
  router.get('/', _handleHome);
  router.get('/login', _handleLogin);
  router.get('/login/', _handleLogin);
  router.post('/login', _handleLogin);
  router.post('/login/', _handleLogin);
  router.get('/logout', _handleLogout);
  router.get('/logout/', _handleLogout);
  final staticHandler =
      createStaticHandler('web', defaultDocument: 'index.html');
  final handler = Cascade().add(staticHandler).add(router).handler;
  final pipeline = const Pipeline()
      .addMiddleware(logRequests())
      .addMiddleware(cookiesMiddleware())
      .addMiddleware(sessionMiddleware())
      .addHandler(handler);
  const address = 'localhost';
  const port = 8080;
  final server = await io.serve(pipeline, address, port);
  print('Serving at http://${server.address.host}:${server.port}');
}

const _menu = '''
<a href="/">Home</a><br />
<a href="/login">Log in</a><br />
<a href="/logout">Log out</a><br />''';

Future<Response> _handleHome(Request request) async {
  final userManager = UserManager();
  final user = userManager.getUser(request);
  var body = '$_menu{{message}}<br />{{cookies}}';
  if (user == null) {
    body = body.replaceAll('{{message}}', 'You are not logged in');
  } else {
    body = body.replaceAll('{{message}}', 'You are logged in as ${user.name}');
  }

  final cookies = request.getCookies();
  body = body.replaceAll('{{cookies}}',
      cookies.entries.map((e) => '${e.key}: ${e.value}').join('<br />'));
  request.addCookie(Cookie('foo', 'Foo'));
  if (!cookies.containsKey('baz')) {
    request.addCookie(Cookie('baz', 'Baz'));
  } else {
    request.removeCookie(Cookie('baz', ''));
  }

  return _render(body);
}

Future<Response> _handleLogin(Request request) async {
  const html = '''
<form action="" method="post">
<label>Login</label><br />
<input name="login" type="text" /><br />
<label>Password</label><br />
<input name="password" type="password" /><br /><br />
<button>Log in</button>
</form>
''';

  if (request.method == 'GET') {
    return _render(_menu + html);
  }

  final body = await request.readAsString();
  final queryParameters = Uri(query: body).queryParameters;
  final login = queryParameters['login'] ?? ''
    ..trim();
  final password = queryParameters['password'] ?? ''
    ..trim();
  if (login.isEmpty || password.isEmpty) {
    return _render(_menu + html);
  }

  final user = User(login);
  final userManager = UserManager();
  userManager.setUser(request, user);
  return Response.found('/');
}

Future<Response> _handleLogout(Request request) async {
  Session.deleteSession(request);
  return Response.found('/');
}

Response _render(String body) {
  return Response.ok(body, headers: {
    'Content-type': 'text/html; charset=UTF-8',
  });
}

class User {
  final String name;

  User(this.name);
}

class UserManager {
  User? getUser(Request request) {
    final session = Session.getSession(request);
    if (session == null) {
      return null;
    }

    final user = session.data['user'];
    if (user is User) {
      return user;
    }

    return null;
  }

  User setUser(Request request, User user) {
    var session = Session.getSession(request);
    session ??= Session.createSession(request);
    session.data['user'] = user;
    return user;
  }
}

Session data is stored in a hash map at runtime.
This implementation implies that session data should only be created for authorized users.
This approach eliminates memory overflow in the case of various types of attacks.
After the expiration of the lifetime, the session data is deleted automatically (which causes the memory to be freed).
Timers are not used for these purposes. This happens during the creation of new sessions.

所属分类

依赖

依赖清单 1 项

源码仓库

使用此插件的项目

暂无相关数据。