Flutter书籍管理或阅读插件bookfx_mz的使用

Flutter书籍管理或阅读插件bookfx_mz的使用

模拟纸质书籍翻页效果

本项目主要模拟了我们在看书籍时的翻页动作,并支持了电子书直接预览。如果你阅读文本电子书,可以直接使用EBook组件;如果你用来阅读其他例如插画等不需要计算字数的内容,请使用BookFx组件。

目前支持的功能

  1. 支持直接读取txt文件文本阅读,调整字号,模拟翻页。
  2. 支持自定义当前页、下一页、指定页面的Widget布局内容。
  3. 支持手势横向滑动翻页,优化了手势控制区域,支持返回上一页。
  4. 支持翻页动画自定义设置。
  5. 支持跳到指定页。

使用

导入:

import 'package:bookfx_mz/bookfx.dart';

如果你想用在书籍需要计算文字的场景,可以使用EBook;如果你想用在其他场景,例如插画,可以使用BookFx,自定义布局。

效果

电子书: image

插画: image

示例代码

电子书:

EBook(
  maxWith: MediaQuery.of(context).size.width,
  eBookController: eBookController,
  bookController: bookController,
  data: data,
  fontSize: eBookController.fontSize,
  padding: const EdgeInsetsDirectional.all(15),
  maxHeight: 600,
)

插画:

BookFx(
  size: Size(MediaQuery.of(context).size.width, 600),
  pageCount: images.length,
  currentPage: (index) {
    return Image.asset(
      images[index],
      fit: BoxFit.fill,
      width: MediaQuery.of(context).size.width,
    );
  },
  lastCallBack: (index) {
    if (index == 0) {
      return;
    }
    setState(() {});
  },
  nextPage: (index) {
    return Image.asset(
      images[index],
      fit: BoxFit.fill,
      width: MediaQuery.of(context).size.width,
    );
  },
  controller: bookController,
)

完整示例Demo

import 'dart:ui';

import 'package:flutter/material.dart';
import 'package:bookfx_mz/bookfx.dart';
import 'package:stack_trace/stack_trace.dart';

void main() {
  // 设置 Flutter 错误处理
  FlutterError.onError = (FlutterErrorDetails details) {
    FlutterError.presentError(details);
    
    // 格式化错误信息和堆栈跟踪
    final stack = details.stack;
    if (stack != null) {
      // 使用 Trace 来解析堆栈
      final trace = Trace.from(stack);
      final frames = trace.frames;
      
      debugPrint('=== Error ===');
      debugPrint('${details.exception}');
      debugPrint('=== Stack trace ===');
      for (var frame in frames) {
        // 只打印应用代码相关的堆栈(排除框架代码)
        if (frame.library.contains('package:') || frame.library.startsWith('dart:')) {
          debugPrint('${frame.uri}:${frame.line}:${frame.column} - ${frame.member}');
        }
      }
    }
  };

  // 捕获异步错误
  PlatformDispatcher.instance.onError = (error, stack) {
    debugPrint('=== Async Error ===');
    debugPrint('$error');
    
    // 格式化堆栈跟踪
    final trace = Trace.from(stack);
    final frames = trace.frames;
    
    debugPrint('=== Stack trace ===');
    for (var frame in frames) {
      if (frame.library.contains('package:') || frame.library.startsWith('dart:')) {
        debugPrint('${frame.uri}:${frame.line}:${frame.column} - ${frame.member}');
      }
    }
    
    return true;
  };
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'BookFX Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final BookController _bookController = BookController();
  final EBookController _eBookController = EBookController();

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('BookFX Demo'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            SizedBox(
              width: 500,
              height: 200,
              child: BookFx(
                size: const Size(500, 200),
                pageCount: 5,
                currentBgColor: Colors.grey.shade200,
                duration: const Duration(milliseconds: 800),
                currentPage: (index) => Container(
                  color: Colors.white,
                  child: Center(
                    child: Text(
                      'Page ${index + 1}',
                      style: const TextStyle(fontSize: 24),
                    ),
                  ),
                ),
                nextPage: (index) => Container(
                  color: Colors.white,
                  child: Center(
                    child: Text(
                      'Page ${index + 1}',
                      style: const TextStyle(fontSize: 24),
                    ),
                  ),
                ),
                controller: _bookController,
              ),
            ),
            const SizedBox(height: 20),
            Row(
              mainAxisAlignment: MainAxisAlignment.center,
              children: [
                ElevatedButton(
                  onPressed: () => _bookController.last(),
                  child: const Text('Previous'),
                ),
                const SizedBox(width: 20),
                ElevatedButton(
                  onPressed: () => _bookController.next(),
                  child: const Text('Next'),
                ),
              ],
            ),
          ],
        ),
      ),
    );
  }

  [@override](/user/override)
  void dispose() {
    _bookController.dispose();
    _eBookController.dispose();
    super.dispose();
  }
}

更多关于Flutter书籍管理或阅读插件bookfx_mz的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter书籍管理或阅读插件bookfx_mz的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


bookfx_mz 是一个用于 Flutter 应用的书籍管理和阅读插件。它可以帮助开发者快速集成书籍管理和阅读功能到他们的应用中。以下是如何使用 bookfx_mz 插件的基本步骤和示例代码。

1. 添加依赖

首先,你需要在 pubspec.yaml 文件中添加 bookfx_mz 插件的依赖。

dependencies:
  flutter:
    sdk: flutter
  bookfx_mz: ^1.0.0  # 请使用最新版本

然后运行 flutter pub get 来获取依赖。

2. 导入插件

在你的 Dart 文件中导入 bookfx_mz 插件。

import 'package:bookfx_mz/bookfx_mz.dart';

3. 初始化插件

在使用 bookfx_mz 插件之前,通常需要对其进行初始化。你可以在 main.dart 文件中进行初始化。

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await BookFxMZ.initialize();
  runApp(MyApp());
}

4. 使用插件功能

bookfx_mz 提供了多种功能,如书籍管理、阅读器、书签管理等。以下是一些常用的功能示例。

4.1 添加书籍

你可以使用 BookFxMZ.addBook 方法来添加一本书。

Book book = Book(
  id: '1',
  title: 'Flutter in Action',
  author: 'Eric Windmill',
  coverUrl: 'https://example.com/cover.jpg',
  filePath: '/path/to/book.pdf',
);

await BookFxMZ.addBook(book);

4.2 获取书籍列表

你可以使用 BookFxMZ.getBooks 方法来获取所有书籍。

List<Book> books = await BookFxMZ.getBooks();

4.3 打开阅读器

你可以使用 BookFxMZ.openReader 方法来打开阅读器。

await BookFxMZ.openReader(bookId: '1');

4.4 添加书签

你可以使用 BookFxMZ.addBookmark 方法来添加书签。

Bookmark bookmark = Bookmark(
  bookId: '1',
  pageNumber: 10,
  note: 'This is an important page.',
);

await BookFxMZ.addBookmark(bookmark);

4.5 获取书签列表

你可以使用 BookFxMZ.getBookmarks 方法来获取指定书籍的书签。

List<Bookmark> bookmarks = await BookFxMZ.getBookmarks(bookId: '1');

5. 示例应用

以下是一个简单的示例应用,展示了如何使用 bookfx_mz 插件来管理书籍和打开阅读器。

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

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await BookFxMZ.initialize();
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: BookListScreen(),
    );
  }
}

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

class _BookListScreenState extends State<BookListScreen> {
  List<Book> books = [];

  [@override](/user/override)
  void initState() {
    super.initState();
    loadBooks();
  }

  Future<void> loadBooks() async {
    books = await BookFxMZ.getBooks();
    setState(() {});
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Books'),
      ),
      body: ListView.builder(
        itemCount: books.length,
        itemBuilder: (context, index) {
          final book = books[index];
          return ListTile(
            title: Text(book.title),
            subtitle: Text(book.author),
            onTap: () async {
              await BookFxMZ.openReader(bookId: book.id);
            },
          );
        },
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () async {
          Book newBook = Book(
            id: '2',
            title: 'Dart Programming',
            author: 'John Doe',
            coverUrl: 'https://example.com/dart.jpg',
            filePath: '/path/to/dart.pdf',
          );
          await BookFxMZ.addBook(newBook);
          loadBooks();
        },
        child: Icon(Icons.add),
      ),
    );
  }
}
回到顶部