添加资源和图像

Flutter 应用可以包含代码和资源（有时称为资源文件）。资源是指与应用一起打包和部署，并在运行时可访问的文件。常见的资源类型包括静态数据（例如 JSON 文件）、配置文件、图标和图像（JPEG、WebP、GIF、动画 WebP/GIF、PNG、BMP 和 WBMP）。

Flutter 使用项目根目录下的 pubspec.yaml 文件来识别应用所需的资源。

以下是一个示例

flutter:
  assets:
    - assets/my_icon.png
    - assets/background.png

要包含目录下的所有资源，请在目录名称后添加 / 字符

flutter:
  assets:
    - directory/
    - directory/subdirectory/

flutter 部分下的 assets 子部分指定了应包含在应用中的文件。每个资源由其所在位置的明确路径（相对于 pubspec.yaml 文件）标识。资源的声明顺序无关紧要。所使用的实际目录名称（第一个示例中的 assets 或上述示例中的 directory）也不重要。

在构建过程中，Flutter 会将资源放入一个称为资源包 (asset bundle) 的特殊存档中，应用在运行时会从中读取这些资源。

Flutter 支持在构建应用时使用 Dart 包来转换资源文件。为此，请在您的 pubspec 文件中指定资源文件和转换器包。要了解如何执行此操作并编写自己的资源转换包，请参阅 在构建时转换资源。

您的应用可以通过 AssetBundle 对象访问其资源。

资源包上的两个主要方法允许您根据逻辑键从包中加载字符串/文本资源 (loadString()) 或图像/二进制资源 (load())。逻辑键映射到构建时在 pubspec.yaml 文件中指定的资源路径。

每个 Flutter 应用都有一个 rootBundle 对象，用于轻松访问主资源包。可以直接使用来自 package:flutter/services.dart 的 rootBundle 全局静态变量来加载资源。

但是，建议使用 DefaultAssetBundle 获取当前 BuildContext 的 AssetBundle，而不是使用随应用构建的默认资源包；这种方法允许父级 widget 在运行时替换不同的 AssetBundle，这对于本地化或测试场景非常有用。

通常，您会使用 DefaultAssetBundle.of() 来间接加载资源（例如 JSON 文件）到应用的运行时 rootBundle 中。

在 Widget 上下文之外，或者当无法获得 AssetBundle 的句柄时，可以使用 rootBundle 直接加载此类资源。例如

import 'package:flutter/services.dart' show rootBundle;
​
Future<String> loadAsset() async {
  return await rootBundle.loadString('assets/config.json');
}

要加载图像，请在 widget 的 build() 方法中使用 AssetImage 类。

例如，您的应用可以从之前示例中的资源声明中加载背景图像

return const Image(image: AssetImage('assets/background.png'));

Flutter 可以根据当前 设备像素比 加载适配分辨率的图像。

AssetImage 会将请求的逻辑资源映射到最接近当前 设备像素比 的资源上。

为了使此映射生效，资源应按照特定的目录结构进行排列

.../image.png
.../Mx/image.png
.../Nx/image.png
...etc.

其中 M 和 N 是与所包含图像的标称分辨率相对应的数值标识符。换句话说，它们指定了图像旨在用于的设备像素比。

在此示例中，image.png 被视为主资源，而 Mx/image.png 和 Nx/image.png 被视为变体。

假设主资源对应于 1.0 的分辨率。例如，考虑以下名为 my_icon.png 的图像资源布局

.../my_icon.png       (mdpi baseline)
.../1.5x/my_icon.png  (hdpi)
.../2.0x/my_icon.png  (xhdpi)
.../3.0x/my_icon.png  (xxhdpi)
.../4.0x/my_icon.png  (xxxhdpi)

在设备像素比为 1.8 的设备上，会选择资源 .../2.0x/my_icon.png。对于设备像素比为 2.7 的设备，会选择资源 .../3.0x/my_icon.png。

如果未在 Image widget 上指定渲染图像的宽度和高度，则会使用标称分辨率对资源进行缩放，使其占据与主资源相同的屏幕空间，只是具有更高的分辨率。也就是说，如果 .../my_icon.png 是 72px x 72px，那么 .../3.0x/my_icon.png 应该是 216px x 216px；但如果未指定宽度和高度，它们都将渲染为 72px x 72px（逻辑像素）。

您只需要在 pubspec.yaml 的 assets 部分指定主资源或其父目录即可。Flutter 会自动为您打包变体。每个条目都应对应一个真实文件，主资源条目除外。如果主资源条目未对应真实文件，则分辨率最低的资源将用作设备像素比低于该分辨率的设备的后备资源。不过，该条目仍应包含在 pubspec.yaml 清单中。

任何使用默认资源包的内容在加载图像时都会自动继承分辨率感知。（如果您使用一些较低级别的类，如 ImageStream 或 ImageCache，您也会注意到与缩放相关的参数。）

要从 package 依赖中加载图像，必须向 AssetImage 提供 package 参数。

例如，假设您的应用程序依赖于一个名为 my_icons 的包，它具有以下目录结构

.../pubspec.yaml
.../icons/heart.png
.../icons/1.5x/heart.png
.../icons/2.0x/heart.png
...etc.

要加载图像，请使用

return const AssetImage('icons/heart.png', package: 'my_icons');

包本身使用的资源也应按上述方式使用 package 参数进行获取。

如果所需的资源在包的 pubspec.yaml 文件中指定，它会自动与应用程序打包在一起。特别是，包本身使用的资源必须在其 pubspec.yaml 中指定。

包也可以选择在其 lib/ 文件夹中包含未在 pubspec.yaml 文件中指定的资源。在这种情况下，要打包这些图像，应用程序必须在其 pubspec.yaml 中指定要包含哪些图像。例如，一个名为 fancy_backgrounds 的包可能包含以下文件

.../lib/backgrounds/background1.png
.../lib/backgrounds/background2.png
.../lib/backgrounds/background3.png

要包含第一个图像，应用程序的 pubspec.yaml 应在其 assets 部分中指定它

flutter:
  assets:
    - packages/fancy_backgrounds/backgrounds/background1.png

lib/ 是隐含的，因此不应包含在资源路径中。

如果您正在开发一个包，要加载包内的资源，请在包的 pubspec.yaml 中指定它

flutter:
  assets:
    - assets/images/

要在您的包内加载图像，请使用

return const AssetImage('packages/fancy_backgrounds/backgrounds/background1.png');

Flutter 资源可通过 Android 上的 AssetManager 和 iOS 上的 NSBundle 在平台代码中轻松访问。

在 Android 上，资源可通过 AssetManager API 访问。例如，在 openFd 中使用的查找键是从 PluginRegistry.Registrar 上的 lookupKeyForAsset 或 FlutterView 上的 getLookupKeyForAsset 获取的。开发插件时可以使用 PluginRegistry.Registrar，而在开发包含平台视图的应用时，FlutterView 将是更好的选择。

作为示例，假设您在 pubspec.yaml 中指定了以下内容

flutter:
  assets:
    - icons/heart.png

这反映了您的 Flutter 应用中的以下结构。

.../pubspec.yaml
.../icons/heart.png
...etc.

要从 Java 插件代码访问 icons/heart.png，请执行以下操作

AssetManager assetManager = registrar.context().getAssets();
String key = registrar.lookupKeyForAsset("icons/heart.png");
AssetFileDescriptor fd = assetManager.openFd(key);

在 iOS 上，资源可通过 mainBundle 访问。例如，在 pathForResource:ofType: 中使用的查找键是从 FlutterPluginRegistrar 上的 lookupKeyForAsset 或 lookupKeyForAsset:fromPackage: 获取的，或者是从 FlutterViewController 上的 lookupKeyForAsset: 或 lookupKeyForAsset:fromPackage: 获取的。开发插件时可以使用 FlutterPluginRegistrar，而在开发包含平台视图的应用时，FlutterViewController 将是更好的选择。

作为示例，假设您有上述的 Flutter 设置。

要从 Objective-C 插件代码访问 icons/heart.png，您可以执行以下操作

NSString* key = [registrar lookupKeyForAsset:@"icons/heart.png"];
NSString* path = [[NSBundle mainBundle] pathForResource:key ofType:nil];

要从 Swift 应用访问 icons/heart.png，您可以执行以下操作

let key = controller.lookupKey(forAsset: "icons/heart.png")
let mainBundle = Bundle.main
let path = mainBundle.path(forResource: key, ofType: nil)

有关更完整的示例，请参阅 pub.dev 上 Flutter video_player 插件 的实现。

当通过 将 Flutter 添加到现有的 iOS 应用 中来实现 Flutter 时，您可能拥有想要在 Flutter 中使用的 iOS 托管图像。要实现这一点，请使用 平台通道 将图像数据以 FlutterStandardTypedData 的形式传递给 Dart。

在其他情况下，您可能需要直接在平台项目中处理资源。以下是两种在 Flutter 框架加载并运行之前使用资源的常见情况。

更新 Flutter 应用的启动图标与更新原生 Android 或 iOS 应用中的启动图标方式相同。

在 Flutter 项目的根目录中，导航到 .../android/app/src/main/res。各种位图资源文件夹（如 mipmap-hdpi）已经包含了名为 ic_launcher.png 的占位符图像。请按照 Android 开发者指南 指定的每种屏幕密度的建议图标尺寸，用您所需的资源替换它们。

在 Flutter 项目的根目录中，导航到 .../ios/Runner。Assets.xcassets/AppIcon.appiconset 目录中已经包含了占位符图像。请按照 Apple 人机界面指南 指定的文件名，用相应尺寸的图像替换它们。请保持原始文件名不变。

Flutter 还使用原生平台机制在 Flutter 框架加载时为您的 Flutter 应用绘制过渡启动屏幕。此启动屏幕将持续显示，直到 Flutter 渲染您的应用程序的第一帧。

要向您的 Flutter 应用添加启动屏幕（也称为“闪屏”），请导航到 .../android/app/src/main。在 res/drawable/launch_background.xml 中，使用此 图层列表 drawable XML 来自定义启动屏幕的外观。现有的模板在注释代码中提供了一个在白色启动屏幕中间添加图像的示例。您可以取消注释该代码或使用其他 drawables 来达到预期的效果。

有关更多详细信息，请参阅 向您的 Android 应用添加闪屏。

要将图像添加到“闪屏”中心，请导航到 .../ios/Runner。在 Assets.xcassets/LaunchImage.imageset 中，放入名为 LaunchImage.png、LaunchImage@2x.png、LaunchImage@3x.png 的图像。如果您使用不同的文件名，请更新同一目录中的 Contents.json 文件。

您也可以通过打开 .../ios/Runner.xcworkspace 在 Xcode 中完全自定义您的启动屏幕故事板。在项目导航器中导航到 Runner/Runner，并通过打开 Assets.xcassets 放入图像，或者使用 LaunchScreen.storyboard 中的界面构建器进行任何自定义。

有关更多详细信息，请参阅 向您的 iOS 应用添加闪屏。