Flutter静态资源管理插件angel3_static的使用

angel3_static 是一个用于Angel3框架的静态文件处理库，支持HTML、CSS和JS等静态资源的提供，并且能够处理Range请求，适合媒体流（如音乐、视频）的应用场景。

安装

在你的pubspec.yaml文件中添加依赖：

dependencies:
    angel3_static: ^8.0.0

确保你已经配置了正确的版本号。运行flutter pub get来安装这个包。

使用

为了从目录中提供文件服务，你需要创建一个VirtualDirectory实例。需要注意的是，angel3_static使用的是package:file而不是dart:io。

下面是一个基本的例子展示如何设置静态资源服务器：

import 'package:angel3_framework/angel3_framework.dart';
import 'package:angel3_framework/http.dart';
import 'package:angel3_static/angel3_static.dart';
import 'package:file/local.dart';

void main() async {
  var app = Angel();
  var fs = const LocalFileSystem();

  // 创建一个正常的静态服务器
  var vDir = VirtualDirectory(app, fs, source: Directory('./public'));

  // 如果你也想发送Cache-Control, ETag等头部信息，则可以使用CachingVirtualDirectory
  var cachingVDir = CachingVirtualDirectory(app, fs, source: Directory('./public'));

  // 挂载VirtualDirectory的请求处理器
  app.fallback(cachingVDir.handleRequest);

  // 启动服务器
  await AngelHttp(app).startServer('127.0.0.1', 3000);
}

Push State

VirtualDirectory还提供了一个pushState方法，返回一个请求处理器，在404错误发生时作为回退选项，除非用户正在请求那个特定的文件。这对于单页面应用(SPA)非常有用。

// 创建VirtualDirectory实例
var vDir = CachingVirtualDirectory(...);

// 挂载它
app.fallback(vDir.handleRequest);

// 当遇到404错误时，回退到index.html
app.fallback(vDir.pushState('index.html'));

选项

VirtualDirectory API接受几个命名参数：

• source: 包含要提供的文件的Directory。如果留空，则Angel3将根据环境变量ANGEL_ENV选择从web或build/web目录提供服务。
• indexFileNames: 应作为索引页提供的文件名列表，默认是['index.html']。
• publicPath: 为了提供索引文件，你需要指定虚拟路径下angel3_static提供文件的位置。如果不是在网站根目录提供静态文件，请包含此参数。
• callback: 在向客户端发送文件之前运行。可用于设置头部信息等。如果返回值不是null或true，则返回的结果将会代替文件内容发送给用户。

这里有一个更详细的示例代码，包括日志记录和MIME类型解析：

import 'package:angel3_framework/angel3_framework.dart';
import 'package:angel3_framework/http.dart';
import 'package:angel3_static/angel3_static.dart';
import 'package:file/local.dart';
import 'package:logging/logging.dart';

void main(List<String> args) async {
  var app = Angel();
  var http = AngelHttp(app);
  var fs = const LocalFileSystem();
  var vDir = CachingVirtualDirectory(
    app,
    fs,
    allowDirectoryListing: true,
    source: args.isEmpty ? fs.currentDirectory : fs.directory(args[0]),
    maxAge: const Duration(days: 24).inSeconds,
  );

  app.mimeTypeResolver
    ..addExtension('', 'text/plain')
    ..addExtension('dart', 'text/dart')
    ..addExtension('lock', 'text/plain')
    ..addExtension('markdown', 'text/plain')
    ..addExtension('md', 'text/plain')
    ..addExtension('yaml', 'text/plain');

  app.logger = Logger('example')
    ..onRecord.listen((rec) {
      print(rec);
      if (rec.error != null) print(rec.error);
      if (rec.stackTrace != null) print(rec.stackTrace);
    });

  app.fallback(vDir.handleRequest);
  app.fallback((req, res) => throw AngelHttpException.notFound());

  var server = await http.startServer('127.0.0.1', 3000);
  print('Serving from ${vDir.source.path}');
  print('Listening at http://${server.address.address}:${server.port}');
}

这段代码展示了如何配置一个简单的静态资源服务器，同时处理了MIME类型解析和日志记录。