Flutter macOS安全书签管理插件macos_secure_bookmarks的使用

macos_secure_bookmarks

macos_secure_bookmarks 是一个Flutter插件，用于创建安全书签以保持沙盒应用程序对文件的访问。

使用方法

安全书签简介

请参考苹果官方文档中关于 安全范围书签 的说明。

确保已启用必要的权限：

• com.apple.security.files.bookmarks.app-scope

创建安全范围书签

// 首先让用户选择一个文件，例如使用文件选择器插件。
showOpenPanel((result, files) {
  if (result != FileChooserResult.ok || files.isEmpty) {
    return;
  }
  
  // 现在创建一个安全范围书签
  final secureBookmarks = SecureBookmarks();
  final bookmark = await secureBookmarks.bookmark(File(_file));
  
  // 现在将书签存储在某个地方以便以后调用
});

解析和访问书签

// 从之前保存的 'bookmark' 字符串解析书签
final resolvedFile = await _secureBookmarks.resolveBookmark(_bookmark);
// resolvedFile 现在是一个文件对象，但在访问它之前，请调用:
await startAccessingSecurityScopedResource(resolvedFile);

// 现在可以读取/写入文件

// 并在稍后放弃访问。
await stopAccessingSecurityScopedResource(resolvedFile);

示例代码

下面是一个完整的示例demo，展示了如何使用macos_secure_bookmarks 插件：

import 'dart:io';
import 'package:file_selector/file_selector.dart';
import 'package:flutter/foundation.dart' show debugDefaultTargetPlatformOverride;
import 'package:flutter/material.dart';
import 'package:logging/logging.dart';
import 'package:logging_appenders/logging_appenders.dart';
import 'package:macos_secure_bookmarks/macos_secure_bookmarks.dart';

final MemoryAppender logMessages = MemoryAppender();
final _logger = Logger('main');

void main() {
  Logger.root.level = Level.ALL;
  PrintAppender().attachToLogger(Logger.root);
  logMessages.attachToLogger(Logger.root);
  _logger.fine('Application launched.');

  // 设置目标平台覆盖
  debugDefaultTargetPlatformOverride = TargetPlatform.fuchsia;

  FlutterError.onError = (errorDetails) {
    _logger.shout(
        'Unhandled Flutter framework (${errorDetails.library}) error.',
        errorDetails.exception,
        errorDetails.stack);
    _logger.fine(errorDetails.summary.toString());
  };

  runApp(ExampleApp());
}

class ExampleApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
        fontFamily: 'Roboto',
      ),
      home: MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key key, this.title}) : super(key: key);
  final String title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  static final SecureBookmarks _secureBookmarks = SecureBookmarks();
  String _file;
  String _bookmark;

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Row(
              children: [
                ElevatedButton(
                  child: Text('Select File'),
                  onPressed: () async {
                    _logger.fine('showOpenPanel..');
                    final result = await openFile();
                    _logger.fine('got result: $result');
                    if (result == null || result.path.isEmpty) {
                      return;
                    }
                    setState(() {
                      _file = result.path;
                    });
                    _logger.info('Selected file: $_file');
                  },
                ),
                ElevatedButton(
                  child: Text('Bookmark'),
                  onPressed: () async {
                    final bookmark =
                        await _secureBookmarks.bookmark(File(_file));
                    setState(() {
                      _bookmark = bookmark;
                    });
                    _logger.info('Got bookmark: $bookmark');
                  },
                ),
                ElevatedButton(
                  child: Text('Resolve Bookmark'),
                  onPressed: () async {
                    final resolved =
                        await _secureBookmarks.resolveBookmark(_bookmark);
                    _logger.info('Resolved to $resolved');
                  },
                ),
              ],
            ),
            Expanded(
              child: Container(
                color: Colors.white,
                constraints: BoxConstraints.expand(),
                child: SingleChildScrollView(
                  child: Container(
                    padding: const EdgeInsets.all(16),
                    child: AnimatedBuilder(
                      animation: logMessages.log,
                      builder: (context, _) => Text(
                        logMessages.log.toString(),
                      ),
                    ),
                  ),
                  reverse: true,
                ),
              ),
            ),
          ],
        ),
      ),
    );
  }
}

class ShortFormatter extends LogRecordFormatter {
  @override
  StringBuffer formatToStringBuffer(LogRecord rec, StringBuffer sb) {
    sb.write(
        '${rec.time.hour}:${rec.time.minute}:${rec.time.second} ${rec.level.name} '
        '${rec.message}');

    if (rec.error != null) {
      sb.write(rec.error);
    }
    final stackTrace = rec.stackTrace ??
        (rec.error is Error ? (rec.error as Error).stackTrace : null);
    if (stackTrace != null) {
      sb.write(stackTrace);
    }
    return sb;
  }
}

class StringBufferWrapper with ChangeNotifier implements ValueNotifier<String> {
  final StringBuffer _buffer = StringBuffer();

  void writeln(String line) {
    _buffer.writeln(line);
    notifyListeners();
  }

  @override
  String toString() => _buffer.toString();

  @override
  String get value => _buffer.toString();

  @override
  set value(String newValue) => _buffer
    ..clear()
    ..write(newValue);
}

class MemoryAppender extends BaseLogAppender {
  MemoryAppender() : super(ShortFormatter());

  final StringBufferWrapper log = StringBufferWrapper();

  @override
  void handle(LogRecord record) {
    log.writeln(formatter.format(record));
  }
}

这个示例程序展示了如何通过用户界面与 macos_secure_bookmarks 插件交互。用户可以选择文件、创建书签，并解析和访问这些书签。此外，还包含了一个简单的日志记录系统，用于跟踪应用程序的操作。