Flutter安卓存储访问插件`android_x_storage`的使用

android_x_storage 是一个用于访问Android设备存储路径的Flutter插件。它支持获取外部存储路径、USB和SD卡路径，并且可以在Android手机和电视上工作。

功能

获取外部存储路径
获取USB和SD卡路径
在Android手机和电视上工作
获取下载、DCIM等公共文件夹路径

安装

运行以下命令来安装该插件：

flutter pub add android_x_storage

如何使用

创建实例

首先，创建一个 AndroidXStorage 类的实例：

final _androidXStorage = AndroidXStorage();

获取外部存储路径

通过调用 getExternalStorageDirectory() 方法获取外部存储路径：

_androidXStorage.getExternalStorageDirectory();

获取公共文件夹路径

可以通过调用以下方法获取不同类型的公共文件夹路径：

_androidXStorage.getDownloadsDirectory();
_androidXStorage.getDocumentsDirectory();
_androidXStorage.getPicturesDirectory();
_androidXStorage.getDCIMDirectory();
_androidXStorage.getAlarmsDirectory();
_androidXStorage.getRingtonesDirectory();
_androidXStorage.getNotificationsDirectory();
_androidXStorage.getMusicDirectory();
_androidXStorage.getMoviesDirectory();
_androidXStorage.getPodcastsDirectory();

获取USB路径列表

通过调用 getUSBStorageDirectories() 方法获取USB路径列表：

_androidXStorage.getUSBStorageDirectories();

获取SD卡路径

通过调用 getSDCardStorageDirectory() 方法获取SD卡路径：

_androidXStorage.getSDCardStorageDirectory();

示例代码

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

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

import 'package:flutter/services.dart';
import 'package:android_x_storage/android_x_storage.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final _androidXStoragePlugin = AndroidXStorage();

  int _platform = 0;
  String _x = "empty";
  String _download = "empty";
  String _documents = "empty";
  String _pictures = "empty";
  String _dcim = "empty";
  String _alarms = "empty";
  String _ringtones = "empty";
  String _notifications = "empty";
  String _music = "empty";
  String _movies = "empty";
  String _podcasts = "empty";
  String _sdcard = "empty";
  List<String?> _usb = [];

  @override
  void initState() {
    super.initState();
    platform();
    x();
    download();
    documents();
    pictures();
    dcim();
    alarms();
    ringtones();
    notifications();
    music();
    movies();
    podcasts();
    sdcard();
    usb();
  }

  Future<void> platform() async {
    int platform;
    try {
      platform = await _androidXStoragePlugin.getPlatformVersion() ?? 0;
    } on PlatformException {
      platform = 0;
    }
    if (!mounted) return;

    setState(() {
      _platform = platform;
    });
  }

  Future<void> x() async {
    String x;
    try {
      x = await _androidXStoragePlugin.getExternalStorageDirectory() ?? "no external";
    } on PlatformException {
      x = "error";
    }
    if (!mounted) return;
    setState(() {
      _x = x;
    });
  }

  Future<void> download() async {
    String download;
    try {
      download = await _androidXStoragePlugin.getDownloadsDirectory() ?? "no download";
    } on PlatformException {
      download = "error";
    }
    if (!mounted) return;
    setState(() {
      _download = download;
    });
  }

  Future<void> documents() async {
    String documents;
    try {
      documents = await _androidXStoragePlugin.getDocumentsDirectory() ?? "no documents";
    } on PlatformException {
      documents = "error";
    }
    if (!mounted) return;
    setState(() {
      _documents = documents;
    });
  }

  Future<void> pictures() async {
    String pictures;
    try {
      pictures = await _androidXStoragePlugin.getPicturesDirectory() ?? "no pictures";
    } on PlatformException {
      pictures = "error";
    }
    if (!mounted) return;
    setState(() {
      _pictures = pictures;
    });
  }

  Future<void> dcim() async {
    String dcim;
    try {
      dcim = await _androidXStoragePlugin.getDCIMDirectory() ?? "no dcim";
    } on PlatformException {
      dcim = "error";
    }
    if (!mounted) return;
    setState(() {
      _dcim = dcim;
    });
  }

  Future<void> alarms() async {
    String alarms;
    try {
      alarms = await _androidXStoragePlugin.getAlarmsDirectory() ?? "no alarms";
    } on PlatformException {
      alarms = "error";
    }
    if (!mounted) return;
    setState(() {
      _alarms = alarms;
    });
  }

  Future<void> ringtones() async {
    String ringtones;
    try {
      ringtones = await _androidXStoragePlugin.getRingtonesDirectory() ?? "no ringtones";
    } on PlatformException {
      ringtones = "error";
    }
    if (!mounted) return;
    setState(() {
      _ringtones = ringtones;
    });
  }

  Future<void> notifications() async {
    String notifications;
    try {
      notifications = await _androidXStoragePlugin.getNotificationsDirectory() ?? "no notifications";
    } on PlatformException {
      notifications = "error";
    }
    if (!mounted) return;
    setState(() {
      _notifications = notifications;
    });
  }

  Future<void> music() async {
    String music;
    try {
      music = await _androidXStoragePlugin.getMusicDirectory() ?? "no music";
    } on PlatformException {
      music = "error";
    }
    if (!mounted) return;
    setState(() {
      _music = music;
    });
  }

  Future<void> movies() async {
    String movies;
    try {
      movies = await _androidXStoragePlugin.getMoviesDirectory() ?? "no movies";
    } on PlatformException {
      movies = "error";
    }
    if (!mounted) return;
    setState(() {
      _movies = movies;
    });
  }

  Future<void> podcasts() async {
    String podcasts;
    try {
      podcasts = await _androidXStoragePlugin.getPodcastsDirectory() ?? "no podcasts";
    } on PlatformException {
      podcasts = "error";
    }
    if (!mounted) return;
    setState(() {
      _podcasts = podcasts;
    });
  }

  Future<void> sdcard() async {
    String sdcard;
    try {
      sdcard = await _androidXStoragePlugin.getSDCardStorageDirectory() ?? "no sdcard";
    } on PlatformException {
      sdcard = "error";
    }
    if (!mounted) return;
    setState(() {
      _sdcard = sdcard;
    });
  }

  Future<void> usb() async {
    List<String?> usb;
    try {
      usb = await _androidXStoragePlugin.getUSBStorageDirectories();
    } on PlatformException {
      usb = ["error"];
    }
    if (!mounted) return;
    setState(() {
      _usb = usb;
    });
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      theme: ThemeData(useMaterial3: true),
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Android Storage Plugin'),
        ),
        body: Center(
          child: Padding(
            padding: const EdgeInsets.symmetric(horizontal: 10.0),
            child: SingleChildScrollView(
              physics: const BouncingScrollPhysics(),
              child: Column(
                mainAxisAlignment: MainAxisAlignment.center,
                crossAxisAlignment: CrossAxisAlignment.start,
                children: [
                  Text('Running on SDK : ${_platform.toString()}\n'),
                  Text('USB Paths : $_usb\n'),
                  Text('External Storage Path : $_x\n'),
                  Text('Download Path : $_download\n'),
                  Text('Documents Path : $_documents\n'),
                  Text('DCIM Path : $_dcim\n'),
                  Text('Pictures Path : $_pictures\n'),
                  Text('Podcasts Path : $_podcasts\n'),
                  Text('Music Path : $_music\n'),
                  Text('Movies Path : $_movies\n'),
                  Text('Notifications Path : $_notifications\n'),
                  Text('Alarms Path : $_alarms\n'),
                  Text('Ringtones Path : $_ringtones\n'),
                  Text('SDCard Path : $_sdcard\n'),
                ],
              ),
            ),
          ),
        ),
      ),
    );
  }
}

这个示例应用展示了如何初始化插件并获取各种存储路径。希望这些信息对你有所帮助！

更多关于Flutter安卓存储访问插件android_x_storage的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

sinazl 1楼•1 天前

更多关于Flutter安卓存储访问插件android_x_storage的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

当然，以下是如何在Flutter项目中使用android_x_storage插件来访问安卓存储的一个示例。需要注意的是，android_x_storage这个插件名称可能不太准确，因为Flutter社区中更常见的存储访问插件是path_provider和permission_handler。但为了符合你的要求，我将假设存在一个名为android_x_storage的插件，并提供一个类似的实现方法。

首先，确保你已经在pubspec.yaml文件中添加了必要的依赖项（假设android_x_storage是存在的插件名称）：

dependencies:
  flutter:
    sdk: flutter
  android_x_storage: ^x.y.z  # 替换为实际版本号
  permission_handler: ^8.3.0  # 用于请求存储权限

然后运行flutter pub get来获取这些依赖项。

接下来，在你的Flutter项目中，你需要请求存储权限并使用存储访问功能。以下是一个简单的示例代码：

import 'package:flutter/material.dart';
import 'package:android_x_storage/android_x_storage.dart';  // 假设这是插件的导入路径
import 'package:permission_handler/permission_handler.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: StorageAccessExample(),
    );
  }
}

class StorageAccessExample extends StatefulWidget {
  @override
  _StorageAccessExampleState createState() => _StorageAccessExampleState();
}

class _StorageAccessExampleState extends State<StorageAccessExample> {
  String _filePath = '';

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

  Future<void> _requestStoragePermission() async {
    var status = await Permission.storage.status;
    if (!status.isGranted) {
      var result = await Permission.storage.request();
      if (result.isGranted) {
        // 存储权限已授予，现在我们可以访问存储
        _getFilePath();
      } else {
        // 存储权限被拒绝
        print('存储权限被拒绝');
      }
    } else {
      // 存储权限已授予
      _getFilePath();
    }
  }

  Future<void> _getFilePath() async {
    // 假设android_x_storage提供了获取文件路径的方法
    // 注意：这里的代码是基于假设的，实际插件可能有不同的API
    String? directoryPath = await AndroidXStorage.getExternalStorageDirectory();
    if (directoryPath != null) {
      String filePath = '$directoryPath/example_file.txt';
      setState(() {
        _filePath = filePath;
      });
      print('文件路径: $filePath');
      // 在这里，你可以进一步操作文件，如写入、读取等
    } else {
      print('无法获取存储目录路径');
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('存储访问示例'),
      ),
      body: Center(
        child: Text('文件路径: $_filePath'),
      ),
    );
  }
}

注意：

上面的代码示例是基于假设的android_x_storage插件API的。实际插件可能有不同的方法名称和参数。
permission_handler插件用于请求存储权限。在实际应用中，存储访问通常需要用户授予相应的权限。
由于android_x_storage可能不是一个真实存在的Flutter插件，你可能需要查找并使用类似功能的插件，如path_provider，它提供了获取应用内部和外部存储目录路径的方法。

如果你使用的是path_provider插件，获取外部存储目录的代码可能会有所不同，如下所示：

import 'package:path_provider/path_provider.dart';

Future<String?> _getExternalStoragePath() async {
  if (Platform.isAndroid) {
    Directory? externalDir = await getExternalStorageDirectory();
    return externalDir?.path;
  } else {
    // 对于iOS，处理可能不同
    return null;
  }
}

请根据你的实际需求和插件文档调整代码。