Flutter存储路径获取插件flutter_storage_path的使用

StoragePath

flutter_storage_path 是一个Flutter插件，用于以JSON格式获取所有图片、音频、视频和文件的位置路径。它基于 StoragePath 实现。

注意

• 该插件仅适用于Android平台。
• 在iOS上将返回一个空数组 []。

安装

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

dependencies:
  flutter_storage_path: ^1.0.4

使用示例

获取图片路径

import 'package:flutter_storage_path/flutter_storage_path.dart';

try {
  String imagePath = await StoragePath.imagesPath; // 包含图片路径和文件夹名称的JSON格式
} on PlatformException {
  print('Failed to get path');
}

获取视频路径

try {
  String videoPath = await StoragePath.videoPath; // 返回视频路径
} on PlatformException {
  print('Failed to get path');
}

获取音频路径

try {
  String audioPath = await StoragePath.audioPath; // 返回音频路径
} on PlatformException {
  print('Failed to get path');
}

获取文件路径

try {
  String filePath = await StoragePath.filePath; // 返回文件路径
} on PlatformException {
  print('Failed to get path');
}

JSON格式示例

图片JSON示例

[
  {
    "files": [
      "path/screenshot/abc.png",
      "path/screenshot/pqr.png"
    ],
    "folderName": "screenshot"
  }
]

文件JSON示例

[
  {
    "files": [
      {
        "mimeType": "application/pdf",
        "size": "34113",
        "title": "C001-SP-2719^201902",
        "path": "/storage/emulated/0/Download/abc.pdf"
      }
    ],
    "folderName": "Download"
  }
]

音频JSON示例

[
  {
    "files": [
      {
        "album": "ABC",
        "artist": "PQR",
        "path": "/storage/emulated/0/Download/todo.mp3",
        "dateAdded": "1515060080",
        "displayName": "todo.mp3",
        "duration": "235986",
        "size": "9506989"
      }
    ],
    "folderName": "Download"
  }
]

视频JSON示例

[
  {
    "files": [
      {
        "path": "/storage/emulated/0/DCIM/Camera/VID_20190304_112455.mp4",
        "dateAdded": "1551678904",
        "displayName": "VID_20190304_112455.mp4",
        "duration": "7147",
        "size": "12787914"
      }
    ],
    "folderName": "Camera"
  }
]

完整示例代码

以下是一个完整的示例应用，展示了如何使用flutter_storage_path插件来获取图片路径并在GridView中显示这些图片。

import 'dart:async';
import 'dart:convert';
import 'dart:io';

import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:flutter_storage_path/flutter_storage_path.dart';
import 'package:storage_path_example/file_model.dart';

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

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  List<FileModel> _files = [];
  FileModel? _selectedModel;

  @override
  void initState() {
    super.initState();
    getImagesPath();
  }

  Future<void> getImagesPath() async {
    try {
      String imagePath = await StoragePath.imagesPath;
      var images = jsonDecode(imagePath) as List;
      _files = images.map<FileModel>((e) => FileModel.fromJson(e)).toList();
      if (_files.isNotEmpty) {
        setState(() {
          _selectedModel = _files[0];
        });
      }
    } on PlatformException {
      print('Failed to get path');
    }
  }

  Future<void> getVideoPath() async {
    try {
      String videoPath = await StoragePath.videoPath;
      var response = jsonDecode(videoPath);
      print(response);
    } on PlatformException {
      print('Failed to get path');
    }
  }

  Future<void> getAudioPath() async {
    try {
      String audioPath = await StoragePath.audioPath;
      var response = jsonDecode(audioPath);
      print(response);
    } on PlatformException {
      print('Failed to get path');
    }
  }

  Future<void> getFilePath() async {
    try {
      String filePath = await StoragePath.filePath;
      var response = jsonDecode(filePath);
      print(response);
    } on PlatformException {
      print('Failed to get path');
    }
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: _selectedModel == null || (_selectedModel != null && _selectedModel.files.isEmpty)
            ? Center(child: Text('No files found'))
            : GridView.builder(
                itemCount: _selectedModel!.files.length,
                gridDelegate: SliverGridDelegateWithFixedCrossAxisCount(
                  crossAxisCount: 4,
                  crossAxisSpacing: 4,
                  mainAxisSpacing: 4,
                ),
                itemBuilder: (_, i) {
                  var file = _selectedModel!.files[i];
                  return Container(
                    child: Image.file(
                      File(file),
                      fit: BoxFit.cover,
                    ),
                  );
                },
              ),
      ),
    );
  }
}

FileModel类

为了更好地处理JSON数据，你可以定义一个FileModel类：

class FileModel {
  final String folderName;
  final List<String> files;

  FileModel({required this.folderName, required this.files});

  factory FileModel.fromJson(Map<String, dynamic> json) {
    return FileModel(
      folderName: json['folderName'] as String,
      files: (json['files'] as List).map((file) => file.toString()).toList(),
    );
  }
}

通过以上步骤，你可以轻松地在Flutter应用中使用flutter_storage_path插件来获取和显示存储路径中的媒体文件。希望这个示例对你有所帮助！