Flutter电子书阅读插件cosmos_epub的使用

Flutter电子书阅读插件cosmos_epub的使用

CosmosEpub 简介

CosmosEpub 是一个Flutter包，允许用户轻松打开和阅读EPUB文件。它提供了从资源（assets）或本地路径（local path）打开EPUB文件的功能，支持切换主题、调整字体样式和大小、访问章节内容等功能。该阅读器是响应式的，适用于普通智能手机和平板电脑。

展示

功能特性

• 从资源（assets）或本地路径（local path）打开EPUB文件
• 提供5种主题：灰色、紫色、白色、黑色和粉色
• 自定义字体样式和大小
• 访问目录并导航到特定章节
• 在屏幕底部显示当前章节名称
• 上一页和下一页按钮切换章节
• 调整屏幕亮度
• 保存书籍阅读进度
• 阅读时有漂亮的翻页动画

入门指南

在您的Flutter项目中添加依赖项：

dependencies:
  cosmos_epub: ^x.y.z

运行命令以获取依赖项：

flutter pub get

使用示例

首先，在Dart代码中导入包：

import 'package:cosmos_epub/cosmos_epub.dart';

在main.dart文件中初始化数据库：

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化并返回一个布尔值
  var _initialized = await CosmosEpub.initialize();
  
  if (_initialized) {
    // 获取书籍进度
    BookProgressModel bookProgress = CosmosEpub.getBookProgress('bookId');
    
    // 设置当前页面索引
    await CosmosEpub.setCurrentPageIndex('bookId', 1);
    
    // 设置当前章节索引
    await CosmosEpub.setCurrentChapterIndex('bookId', 2);
    
    // 删除书籍进度
    await CosmosEpub.deleteBookProgress('bookId');
    
    // 删除所有书籍进度
    await CosmosEpub.deleteAllBooksProgress();
  }

  runApp(MyApp());
}

打开来自资源的EPUB文件

await CosmosEpub.openAssetBook(
    assetPath: 'assets/book.epub',
    context: context,
    // 书籍ID是必需的，用于保存每本书的进度
    bookId: '3',
    // 回调函数是可选的
    onPageFlip: (int currentPage, int totalPages) {
      print(currentPage);
    },
    onLastPage: (int lastPageIndex) {
      print('我们到达了最后一页');
    });

打开来自本地存储的EPUB文件

await CosmosEpub.openLocalBook(
    localPath: book.path,
    context: context,
    // 书籍ID是必需的，用于保存每本书的进度
    bookId: '3',
    // 回调函数是可选的
    onPageFlip: (int currentPage, int totalPages) {
      print(currentPage);
    },
    onLastPage: (int lastPageIndex) {
      print('我们到达了最后一页');
    });

清除主题缓存

await CosmosEpub.clearThemeCache();

完整示例Demo

以下是一个完整的示例，展示了如何在Flutter应用中使用CosmosEpub插件：

import 'package:cosmos_epub/Model/book_progress_model.dart';
import 'package:cosmos_epub/cosmos_epub.dart';
import 'package:flutter/cupertino.dart';
import 'package:flutter/material.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化并返回一个布尔值
  var _initialized = await CosmosEpub.initialize();

  if (_initialized) {
    // 使用BookProgressModel实例在应用中访问特定书籍的当前进度
    BookProgressModel bookProgress = CosmosEpub.getBookProgress('bookId');
    await CosmosEpub.setCurrentPageIndex('bookId', 1);
    await CosmosEpub.setCurrentChapterIndex('bookId', 2);
    await CosmosEpub.deleteBookProgress('bookId');
    await CosmosEpub.deleteAllBooksProgress();
  }

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      useInheritedMediaQuery: true,
      title: 'CosmosEpub 💫 Reader Example',
      debugShowCheckedModeBanner: false,
      theme: ThemeData.dark().copyWith(
        appBarTheme: AppBarTheme(
          backgroundColor: Color(0xff0a0e21),
        ),
        scaffoldBackgroundColor: Color(0xff0a0e21),
      ),
      home: MyHomePage(),
    );
  }
}

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

class _MyHomePageState extends State<MyHomePage> {
  Future<void> readerFuture = Future.value(true);

  Future<void> _openEpubReader(BuildContext context) async {
    await CosmosEpub.openAssetBook(
        assetPath: 'assets/book.epub',
        context: context,
        bookId: '3',
        onPageFlip: (int currentPage, int totalPages) {
          print(currentPage);
        },
        onLastPage: (int lastPageIndex) {
          print('我们到达了最后一页');
        });
  }

  lateFuture() {
    setState(() {
      readerFuture = _openEpubReader(context);
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('CosmosEpub 💫 Reader Example'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            lateFuture();
          },
          style: ButtonStyle(
              backgroundColor: MaterialStateProperty.all(Colors.yellow),
              padding: MaterialStateProperty.all(EdgeInsets.all(20))),
          child: FutureBuilder<void>(
            future: readerFuture, // 设置异步操作的未来
            builder: (context, snapshot) {
              switch (snapshot.connectionState) {
                case ConnectionState.waiting:
                  {
                    // 在等待异步操作完成时，显示加载指示器
                    return CupertinoActivityIndicator(
                      radius: 15,
                      color: Colors.black, // 根据需要调整半径
                    );
                  }
                default:
                  // 默认情况下，显示按钮文本
                  return Text(
                    '打开书籍 🚀',
                    style: TextStyle(fontSize: 20, color: Colors.black),
                  );
              }
            },
          ),
        ),
      ),
    );
  }
}