Flutter Excel文件处理插件 flutter_excel 的使用指南

简介

flutter_excel 是一个用于读取、创建和更新 XLSX 文件的 Flutter 和 Dart 库。它支持多种功能，如读取现有 Excel 文件、创建新 Excel 文件、更新单元格值等。

开始使用

1. 添加依赖

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

dependencies:
  flutter_excel: any

2. 安装依赖

你可以通过命令行安装包：

• 使用 pub：

  $ pub get
  

• 使用 Flutter：

  $ flutter packages get
  

3. 导入库

在你的 Dart 代码中导入库：

import 'package:flutter_excel/excel.dart';

使用示例

读取现有的 Excel 文件

从本地文件系统读取

import 'dart:io';
import 'package:path/path.dart';
import 'package:flutter_excel/excel.dart';

void main() {
  var file = "Path_to_pre_existing_Excel_File/excel_file.xlsx";
  var bytes = File(file).readAsBytesSync();
  var excel = Excel.decodeBytes(bytes);

  for (var table in excel.tables.keys) {
    print(table); // sheet Name
    print(excel.tables[table].maxCols);
    print(excel.tables[table].maxRows);
    for (var row in excel.tables[table].rows) {
      print("$row");
    }
  }
}

在 Flutter Web 中读取

import 'package:flutter/material.dart';
import 'package:file_picker/file_picker.dart';
import 'package:flutter_excel/excel.dart';

Future<void> pickAndReadExcelFile() async {
  FilePickerResult? pickedFile = await FilePicker.platform.pickFiles(
    type: FileType.custom,
    allowedExtensions: ['xlsx'],
    allowMultiple: false,
  );

  if (pickedFile != null) {
    var bytes = pickedFile.files.single.bytes;
    var excel = Excel.decodeBytes(bytes!);
    for (var table in excel.tables.keys) {
      print(table); // sheet Name
      print(excel.tables[table].maxCols);
      print(excel.tables[table].maxRows);
      for (var row in excel.tables[table].rows) {
        print("$row");
      }
    }
  }
}

从 Flutter 的 Asset 文件夹读取

import 'package:flutter/services.dart' show ByteData, rootBundle;
import 'package:flutter_excel/excel.dart';

Future<void> readExcelFromAsset() async {
  ByteData data = await rootBundle.load("assets/existing_excel_file.xlsx");
  var bytes = data.buffer.asUint8List(data.offsetInBytes, data.lengthInBytes);
  var excel = Excel.decodeBytes(bytes);

  for (var table in excel.tables.keys) {
    print(table); // sheet Name
    print(excel.tables[table].maxCols);
    print(excel.tables[table].maxRows);
    for (var row in excel.tables[table].rows) {
      print("$row");
    }
  }
}

创建新的 Excel 文件

import 'package:flutter_excel/excel.dart';

void createNewExcelFile() {
  var excel = Excel.createExcel(); // 自动创建一个名为 Sheet1 的空工作表
}

更新单元格值

import 'package:flutter_excel/excel.dart';

void updateCellExample() {
  var excel = Excel.createExcel();
  Sheet sheetObject = excel['SheetName'];

  CellStyle cellStyle = CellStyle(
    backgroundColorHex: "#1AFF1A",
    fontFamily: getFontFamily(FontFamily.Calibri),
  );
  cellStyle.underline = Underline.Single; // 或者 Underline.Double

  var cell = sheetObject.cell(CellIndex.indexByString("A1"));
  cell.value = 8; // 动态支持的数据类型
  cell.cellStyle = cellStyle;

  print("CellType: ${cell.cellType}");
}

保存 Excel 文件

在 Flutter Web 中保存

import 'package:flutter_excel/excel.dart';

void saveExcelOnWeb() {
  var fileBytes = excel.save(fileName: "My_Excel_File_Name.xlsx");
}

在 Android/iOS 中保存

import 'package:flutter_excel/excel.dart';
import 'package:path_provider/path_provider.dart';

Future<void> saveExcelOnMobile() async {
  var fileBytes = excel.save();
  var directory = await getApplicationDocumentsDirectory();

  File(join("$directory/output_file_name.xlsx"))
    ..createSync(recursive: true)
    ..writeAsBytesSync(fileBytes!);
}