Flutter自定义图片选择插件custom_image_picker的使用

custom_image_picker

custom_image_picker 是一个 Flutter 插件，允许您检索设备上的图片和相册，以便根据您的需求自定义图片选择器。

开始使用

添加依赖

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

dependencies:
  custom_image_picker: ^0.5.0

然后运行 flutter pub get 来安装依赖。

使用步骤

导入库

首先，导入 custom_image_picker 库：

import 'package:custom_image_picker/custom_image_picker.dart';

获取相册列表

通过调用 getAllImages 方法获取设备上的所有相册：

List<PhoneAlbum> albums = [];

// 初始化插件
final customImagePicker = CustomImagePicker();

// 获取相册列表
customImagePicker.getAllImages(callback: (retrievedAlbums) {
  albums = retrievedAlbums; // 存储相册数据
});

每个 PhoneAlbum 包含以下信息：

class PhoneAlbum {
  final String id;          // 相册 ID
  final String name;        // 相册名称
  final String coverUri;    // 封面图片 URI
  final int photosCount;    // 图片数量

  PhoneAlbum(this.id, this.name, this.coverUri, this.photosCount);
}

获取相册中的图片

通过调用 getPhotosOfAlbum 方法获取某个相册中的图片。默认每页返回 50 张图片，支持分页功能（仅限 Android）：

List<PhonePhoto> imagesOfAlbum = [];

// 初始化插件
final customImagePicker = CustomImagePicker();

// 获取指定相册的图片
customImagePicker.getPhotosOfAlbum(
  albumID, // 指定相册 ID
  page: page, // 分页参数，默认为 1
  callback: (images) {
    imagesOfAlbum.addAll(images); // 存储图片数据
  },
);

每个 PhonePhoto 包含以下信息：

class PhonePhoto {
  final String id;          // 图片 ID
  final String albumName;   // 所属相册名称
  final String photoUri;    // 图片 URI

  PhonePhoto(this.id, this.albumName, this.photoUri);
}

平台支持

该库支持 Android 和 iOS，但目前 iOS 不支持分页功能，我们正在努力尽快实现这一功能。

下一步计划

我们正在努力为插件添加更多功能，请随时在 GitHub 仓库 中提出建议。

完整示例代码

以下是一个完整的示例代码，展示如何使用 custom_image_picker 插件：

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

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

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

class _MyAppState extends State<MyApp> {
  List<PhoneAlbum> albums = [];
  List<PhonePhoto> imagesOfAlbum = [];

  [@override](/user/override)
  void initState() {
    super.initState();
    // 初始化插件
    final customImagePicker = CustomImagePicker();

    // 获取相册列表
    customImagePicker.getAllImages(callback: (retrievedAlbums) {
      setState(() {
        albums = retrievedAlbums;
      });
    });

    // 假设获取第一个相册的图片
    if (albums.isNotEmpty) {
      customImagePicker.getPhotosOfAlbum(
        albums[0].id,
        callback: (images) {
          setState(() {
            imagesOfAlbum = images;
          });
        },
      );
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Custom Image Picker Example')),
        body: Center(
          child: Column(
            children: [
              Text('相册列表：'),
              ListView.builder(
                shrinkWrap: true,
                itemCount: albums.length,
                itemBuilder: (context, index) {
                  return ListTile(
                    title: Text(albums[index].name),
                    subtitle: Text('${albums[index].photosCount} 张图片'),
                  );
                },
              ),
              SizedBox(height: 20),
              Text('相册图片：'),
              ListView.builder(
                shrinkWrap: true,
                itemCount: imagesOfAlbum.length,
                itemBuilder: (context, index) {
                  return Image.network(imagesOfAlbum[index].photoUri);
                },
              ),
            ],
          ),
        ),
      ),
    );
  }
}