Flutter图片保存到相册插件image_gallery_saver_plus的使用

发布于 1周前 作者 wuwangju 来自 Flutter

Flutter图片保存到相册插件image_gallery_saver_plus的使用

image_gallery_saver_plus

pub package license

我们开发了image_gallery_saver插件的更新版本,允许用户直接将图片和视频下载并保存到他们的图库中。这个新版本具有增强的性能、用于组织媒体的附加功能以及与各种设备的改进兼容性。

使用方法

要使用此插件,请在您的pubspec.yaml文件中添加image_gallery_saver_plus作为依赖项。例如:

dependencies:
  image_gallery_saver_plus: '^3.0.5'

iOS配置

您的项目需要使用Swift创建。 请向位于ios/Runner/Info.plist的文件中添加以下键值对:

<key>NSPhotoLibraryAddUsageDescription</key>
<string>我们需要权限来将照片和视频保存到您的图库,以方便您使用。</string>

<key>NSPhotoLibraryUsageDescription</key>
<string>我们需要访问您的照片库的权限,以便查看和选择您的照片和视频。</string>

Android配置

您需要请求存储权限以保存图像到图库。您可以使用flutter_permission_handler来处理存储权限。 对于Android 10及以上版本,在android/app/src/main/AndroidManifest.xml文件中的application标签内添加如下属性:

<application android:requestLegacyExternalStorage="true" .....>

示例代码

以下是一个完整的示例demo,展示了如何使用image_gallery_saver_plus插件保存不同类型的文件(如本地生成的图片、网络图片、GIF和视频)到相册。

import 'dart:typed_data';
import 'dart:ui' as ui;
import 'package:dio/dio.dart';
import 'package:flutter/material.dart';
import 'package:flutter/rendering.dart';
import 'package:image_gallery_saver_plus/image_gallery_saver_plus.dart';
import 'package:path_provider/path_provider.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Save image to gallery',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  GlobalKey _globalKey = GlobalKey();

  @override
  void initState() {
    super.initState();
    // 请求所有必要的权限
    // PermissionUtil.requestAll(); // 如果你有自定义的权限请求工具类
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("Save image to gallery"),
      ),
      body: Center(
        child: Column(
          children: <Widget>[
            SizedBox(height: 15),
            RepaintBoundary(
              key: _globalKey,
              child: Container(
                alignment: Alignment.center,
                width: 300,
                height: 300,
                color: Colors.blue,
              ),
            ),
            Container(
              padding: EdgeInsets.only(top: 15),
              child: ElevatedButton(
                onPressed: _saveLocalImage,
                child: Text("Save Local Image"),
              ),
              width: 300,
              height: 44,
            ),
            Container(
              padding: EdgeInsets.only(top: 15),
              child: ElevatedButton(
                onPressed: _saveNetworkImage,
                child: Text("Save Network Image"),
              ),
              width: 300,
              height: 44,
            ),
            Container(
              padding: EdgeInsets.only(top: 15),
              child: ElevatedButton(
                onPressed: _saveNetworkGifFile,
                child: Text("Save Network Gif Image"),
              ),
              width: 300,
              height: 44,
            ),
            Container(
              padding: EdgeInsets.only(top: 15),
              child: ElevatedButton(
                onPressed: _saveNetworkVideoFile,
                child: Text("Save Network Video"),
              ),
              width: 300,
              height: 44,
            ),
          ],
        ),
      ),
    );
  }

  _saveLocalImage() async {
    RenderRepaintBoundary boundary =
        _globalKey.currentContext!.findRenderObject() as RenderRepaintBoundary;
    ui.Image image = await boundary.toImage();
    ByteData? byteData =
        await (image.toByteData(format: ui.ImageByteFormat.png));
    if (byteData != null) {
      final result =
          await ImageGallerySaverPlus.saveImage(byteData.buffer.asUint8List());
      print(result);
      // 显示保存结果
      // Utils.toast(result.toString());
    }
  }

  _saveNetworkImage() async {
    var response = await Dio().get(
        "https://ss0.baidu.com/94o3dSag_xI4khGko9WTAnF6hhy/image/h%3D300/sign=a62e824376d98d1069d40a31113eb807/838ba61ea8d3fd1fc9c7b6853a4e251f94ca5f46.jpg",
        options: Options(responseType: ResponseType.bytes));
    final result = await ImageGallerySaverPlus.saveImage(
        Uint8List.fromList(response.data),
        quality: 60,
        name: "hello");
    print(result);
    // 显示保存结果
    // Utils.toast("$result");
  }

  _saveNetworkGifFile() async {
    var appDocDir = await getTemporaryDirectory();
    String savePath = appDocDir.path + "/temp.gif";
    String fileUrl =
        "https://hyjdoc.oss-cn-beijing.aliyuncs.com/hyj-doc-flutter-demo-run.gif";
    await Dio().download(fileUrl, savePath);
    final result =
        await ImageGallerySaverPlus.saveFile(savePath, isReturnPathOfIOS: true);
    print(result);
    // 显示保存结果
    // Utils.toast("$result");
  }

  _saveNetworkVideoFile() async {
    var appDocDir = await getTemporaryDirectory();
    String savePath = appDocDir.path + "/temp.mp4";
    String fileUrl =
        "https://s3.cn-north-1.amazonaws.com.cn/mtab.kezaihui.com/video/ForBiggerBlazes.mp4";
    await Dio().download(fileUrl, savePath, onReceiveProgress: (count, total) {
      print((count / total * 100).toStringAsFixed(0) + "%");
    });
    final result = await ImageGallerySaverPlus.saveFile(savePath);
    print(result);
    // 显示保存结果
    // Utils.toast("$result");
  }
}

注意事项

  • 在实际应用中,建议在执行保存操作之前检查并请求相应的权限。
  • Utils.toast是示例中用于显示提示信息的方法,如果你的应用中有类似的工具方法可以替换它,或者使用Flutter内置的SnackBar等组件来显示消息。

通过以上步骤,您可以轻松地将图片或视频保存到用户的相册中。希望这个指南对您有所帮助!如果有任何问题或需要进一步的帮助,请随时提问。


更多关于Flutter图片保存到相册插件image_gallery_saver_plus的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter图片保存到相册插件image_gallery_saver_plus的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然,以下是如何在Flutter项目中使用image_gallery_saver_plus插件将图片保存到相册的示例代码。

1. 添加依赖

首先,你需要在你的pubspec.yaml文件中添加image_gallery_saver_plus的依赖:

dependencies:
  flutter:
    sdk: flutter
  image_gallery_saver_plus: ^2.0.0  # 请检查最新版本号

2. 导入插件

在你的Dart文件中导入插件:

import 'package:image_gallery_saver_plus/image_gallery_saver_plus.dart';

3. 请求权限

在Android和iOS上,你需要请求存储权限。你可以使用permission_handler插件来请求这些权限。

首先,添加permission_handler依赖到你的pubspec.yaml

dependencies:
  flutter:
    sdk: flutter
  image_gallery_saver_plus: ^2.0.0  # 请检查最新版本号
  permission_handler: ^10.2.0  # 请检查最新版本号

然后,在你的Dart文件中请求权限:

import 'package:permission_handler/permission_handler.dart';

Future<void> requestPermissions() async {
  // 请求存储权限
  var status = await Permission.storage.status;
  if (!status.isGranted) {
    Map<Permission, PermissionStatus> statuses = await Permission.storage.request();
    status = statuses[Permission.storage] ?? status;
  }
  if (!status.isGranted) {
    // 处理权限被拒绝的情况
    throw Exception("需要存储权限才能保存图片到相册");
  }
}

4. 保存图片到相册

最后,你可以使用image_gallery_saver_plus插件来保存图片:

import 'dart:typed_data';
import 'dart:ui' as ui;
import 'package:flutter/material.dart';

Future<void> saveImageToGallery(BuildContext context, Uint8List imageData) async {
  try {
    await requestPermissions();
    
    // 将Uint8List转换为文件
    final result = await ImageGallerySaver.saveImageWithByteData(
      imageData: imageData,
      quality: 100, // 质量,范围为0到100
      isWithAlbumName: true, // 是否使用专辑名称
      albumName: 'MyAppImages', // 专辑名称
    );
    
    if (result) {
      ScaffoldMessenger.of(context).showSnackBar(
        SnackBar(content: Text('图片已保存到相册')),
      );
    } else {
      ScaffoldMessenger.of(context).showSnackBar(
        SnackBar(content: Text('保存图片到相册失败')),
      );
    }
  } catch (e) {
    ScaffoldMessenger.of(context).showSnackBar(
      SnackBar(content: Text('保存图片到相册时出错: ${e.message}')),
    );
  }
}

5. 获取图片数据

你可以使用RepaintBoundaryCanvas来捕获Widget的图像数据:

import 'dart:ui' as ui;
import 'package:flutter/rendering.dart';

Future<Uint8List?> capturePng(GlobalKey key) async {
  try {
    RenderRepaintBoundary boundary =
        key.currentContext?.findRenderObject() as RenderRepaintBoundary?;
    if (boundary == null) return null;

    ui.Image image = await boundary.toImage();
    ByteData? byteData = await image.toByteData(format: ui.ImageByteFormat.png);
    Uint8List pngBytes = byteData!.buffer.asUint8List();

    return pngBytes;
  } catch (e) {
    print("Error capturing image: $e");
    return null;
  }
}

示例使用

在你的Widget中:

import 'package:flutter/material.dart';

class MyApp extends StatelessWidget {
  final GlobalKey captureKey = GlobalKey();

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Save Image to Gallery')),
        body: Center(
          child: RepaintBoundary(
            key: captureKey,
            child: Image.network(
              'https://example.com/path/to/your/image.jpg',
              width: 300,
              height: 300,
              fit: BoxFit.cover,
            ),
          ),
        ),
        floatingActionButton: FloatingActionButton(
          onPressed: () async {
            Uint8List? imageData = await capturePng(captureKey);
            if (imageData != null) {
              await saveImageToGallery(context, imageData);
            }
          },
          child: Icon(Icons.save),
        ),
      ),
    );
  }
}

以上代码展示了如何使用image_gallery_saver_plus插件将捕获的图片保存到相册。请确保在实际项目中处理所有潜在的错误和异常,并根据需要进行调整。

回到顶部