metro.config.js

Metro 可用配置参考。

For the complete documentation index, see llms.txt. Use this Use this file to discover all available pages.

有关 metro.config.js 的更多信息，请参阅 自定义 Metro 指南。

环境变量

Expo CLI 可以从 .env 文件中加载环境变量。有关如何在 Expo CLI 中使用环境变量的更多信息，请参阅 环境变量指南。

EAS CLI 使用不同的环境变量机制，但当它调用 Expo CLI 进行编译和打包时除外。有关 EAS 中的环境变量 的更多信息。

如果你正在迁移较旧的项目，那么你应该通过在 .gitignore 中添加以下内容来忽略本地 env 文件：

# 本地 env 文件
.env*.local

禁用 dotenv 文件

在调用任何 Expo CLI 命令之前，通过启用 EXPO_NO_DOTENV 环境变量，可以在 Expo CLI 中完全禁用 dotenv 文件加载。

禁用带有 EXPO_PUBLIC_ 前缀的客户端环境变量

带有 EXPO_PUBLIC_ 前缀的环境变量会在构建时暴露给应用。例如，EXPO_PUBLIC_API_KEY 将可用作 process.env.EXPO_PUBLIC_API_KEY。

可以通过环境变量 EXPO_NO_CLIENT_ENV_VARS=1 禁用客户端环境变量内联，此变量必须在执行任何打包之前定义。

CSS

CSS 支持正在开发中，目前仅适用于 web。

Expo 支持你项目中的 CSS。你可以从任何组件导入 CSS 文件。也支持 CSS Modules。

默认情况下已启用 CSS 支持。你可以在 Metro 配置中设置 isCSSEnabled 来禁用此功能。

/** @type {import('expo/metro-config').MetroConfig} */
const config = getDefaultConfig(__dirname, {
  // 禁用 CSS 支持。
  isCSSEnabled: false,
});

全局 CSS

全局样式仅适用于 web，使用它会导致你的应用在原生端出现视觉差异。

你可以从任何组件导入 CSS 文件。该 CSS 将应用到整个页面。

这里，我们将为类名 .container 定义一个全局样式：

.container {
  background-color: red;
}

然后，我们可以通过导入样式表并使用 .container 在组件中使用该类名：

import './styles.css';
import { View } from 'react-native';

export default function App() {
  return (
    <>
      {/* 使用 `className` 将样式分配给 React DOM 组件。 */}
      <div className="container">你好，世界</div>

      {/* 在 React Native for web 中，使用以下语法通过 `style` 追加类名。 */}
      <View
        style={{
          $$css: true,
          _: 'container',
        }}>
        你好，世界
      </View>
    </>
  );
}

你也可以导入库中捆绑提供的样式表，就像导入任何 node 模块一样：

// 将样式应用于整个应用。
import 'emoji-mart/css/emoji-mart.css';

• 在原生端，所有全局样式表都会被自动忽略。
• 全局样式表支持热重载，只需保存文件，修改就会生效。

CSS Modules

原生端的 CSS Modules 正在开发中，目前仅适用于 web。

CSS Modules 是一种将 CSS 作用域限制在特定组件的方法。这对于避免命名冲突以及确保样式只应用于目标组件很有用。

在 Expo 中，CSS Modules 通过创建一个扩展名为 .module.css 的文件来定义。该文件可以从任何组件导入。导出的值是一个对象，其中类名作为键，而仅适用于 web 的作用域名称作为值。可以使用导入 unstable_styles 来访问对 react-native-web 安全的样式。

CSS Modules 支持平台扩展名，允许你为不同平台定义不同样式。例如，你可以定义 module.ios.css 和 module.android.css 文件，分别为 Android 和 iOS 定义样式。你需要在导入时不带扩展名，例如：

例如，翻转扩展名，如 App.ios.module.css 将不起作用，并会生成一个名为 App.ios.module 的通用模块。

你不能将样式传递给 React Native 或 React Native for web 组件的 className 属性。相反，你必须使用 style 属性。

import styles, { unstable_styles } from './App.module.css';

export default function Page() {
  return (
    <>
      <Text
        style={{
          // 这是 react-native-web 类名的应用方式
          $$css: true,
          _: styles.text,
        }}>
        Hello World
      </Text>
      <Text style={unstable_styles.text}>Hello World</Text>
      {/* 仅适用于 web 的用法： */}
      <p className={styles.text}>Hello World</p>
    </>
  );
}

.text {
  color: red;
}

• 在 web 上，所有 CSS 值都可用。CSS 不会像 React Native Web 的 StyleSheet API 那样被处理或自动添加浏览器前缀。你可以使用 postcss.config.js 为你的 CSS 自动添加前缀。
• CSS Modules 在底层使用 lightningcss，有关不受支持的功能，请查看 issues。

PostCSS

可以通过在项目根目录添加 postcss.config.json 文件来自定义 PostCSS。该文件应导出一个返回 PostCSS 配置对象的函数。例如：

{
  "plugins": {
    "autoprefixer": {}
  }
}

postcss.config.json 和 postcss.config.js 都受支持，但 postcss.config.json 可实现更好的缓存。

更新后重置缓存

更改 Post CSS 或 browserslist 配置将需要你清除 Metro 缓存：

SASS

Expo Metro 对 SCSS/SASS 提供了 部分 支持。

要进行设置，请在项目中安装 sass 包：

然后，确保在 metro.config.js 文件中已完成 CSS 设置。

• 安装 sass 后，不带扩展名的模块将按以下顺序解析：scss、sass、css。
• 仅对 sass 文件使用预期的语法。
• 当前不支持从 scss/sass 文件内部导入其他文件。

Tailwind

标准 Tailwind CSS 仅支持 web 平台。若需通用支持，请使用类似 NativeWind 的库，它允许使用 Tailwind CSS 创建带样式的 React Native 组件。

扩展 Babel 转换器

Expo 的 Metro 配置使用自定义的 transformer.babelTransformerPath 值，以确保始终使用 expo-babel-preset 并支持 web/Node.js 环境。

如果你想扩展 Babel 转换器，请改为从 @expo/metro-config/babel-transformer 导入上游转换器，而不是 metro-react-native-babel-transformer。例如：

const upstreamTransformer = require('@expo/metro-config/babel-transformer');

module.exports.transform = async ({ src, filename, options }) => {
  // 对 SVG 文件执行一些自定义逻辑...
  if (filename.endsWith('.svg')) {
    src = '...';
  }
  // 将源码传递给上游 Expo 转换器。
  return upstreamTransformer.transform({ src, filename, options });
};

自定义解析

Expo CLI 扩展了默认的 Metro 解析器，以添加 Web、Server 和 tsconfig 别名支持等功能。你也可以通过串联 config.resolver.resolveRequest 函数来类似地自定义 Metro 的默认解析行为。

const { getDefaultConfig } = require('expo/metro-config');

/** @type {import('expo/metro-config').MetroConfig} */
const config = getDefaultConfig(__dirname);

config.resolver.resolveRequest = (context, moduleName, platform) => {
  if (moduleName.startsWith('my-custom-resolver:')) {
    // 将模块名解析为文件路径的逻辑...
    // 注意：如果无法解析，请抛出错误。
    return {
      filePath: 'path/to/file',
      type: 'sourceFile',
    };
  }

  // 确保你调用默认解析器。
  return context.resolveRequest(context, moduleName, platform);
};

module.exports = config;

与传统打包器不同，Metro 在所有平台上共享同一个解析器函数。因此，你可以使用 context 对象在每次请求时动态修改解析设置。

模拟模块

如果你希望某个平台上的某个模块为空，可以从解析器返回一个 type: 'empty' 对象。以下示例会使 web 上的 lodash 为空：

const { getDefaultConfig } = require('expo/metro-config');

/** @type {import('expo/metro-config').MetroConfig} */
const config = getDefaultConfig(__dirname);

config.resolver.resolveRequest = (context, moduleName, platform) => {
  if (platform === 'web' && moduleName === 'lodash') {
    return {
      type: 'empty',
    };
  }

  // 确保你调用默认解析器。
  return context.resolveRequest(context, moduleName, platform);
};

module.exports = config;

这种技术等同于在 Webpack 或 Vite 中使用空外部依赖，但额外的好处是可以针对特定平台。

虚拟模块

目前 Metro 不支持虚拟模块。你可以使用的一种类似方案是在 node_modules/.cache/... 目录中创建一个模块，并将解析重定向到该文件。

以下示例将在 node_modules/.cache/virtual/virtual-module.js 中创建一个模块，并将 virtual:my-module 的解析重定向到该文件：

const path = require('path');
const fs = require('fs');

const { getDefaultConfig } = require('expo/metro-config');

/** @type {import('expo/metro-config').MetroConfig} */
const config = getDefaultConfig(__dirname);

const virtualPath = path.resolve(__dirname, 'node_modules/.cache/virtual/virtual-module.js');

// 在生成目录中创建虚拟模块...
fs.mkdirSync(path.dirname(virtualPath), { recursive: true });
fs.writeFileSync(virtualPath, 'export default "Hello World";');

config.resolver.resolveRequest = (context, moduleName, platform) => {
  if (moduleName === 'virtual:my-module') {
    return {
      filePath: virtualPath,
      type: 'sourceFile',
    };
  }

  // 确保你调用默认解析器。
  return context.resolveRequest(context, moduleName, platform);
};

module.exports = config;

这可以用来通过自定义导入模拟 externals。例如，如果你想将 require('expo') 重定向到类似 SystemJS.require('expo') 的自定义内容，你可以创建一个导出 SystemJS.require('expo') 的虚拟模块，并将 expo 的解析重定向到该文件。

自定义转换

转换在 Metro 中会被大量缓存。如果你更新了某些内容，请使用 --clear 标志查看更新。例如，npx expo start --clear。

Metro 没有一个非常强大的用于转换文件的插件系统，因此改为使用 babel.config.js 和 caller 对象来自定义转换。

module.exports = function (api) {
  // 获取 Expo CLI 正在为其执行转换的平台。
  const platform = api.caller(caller => (caller ? caller.platform : 'ios'));

  // 检测打包操作是否针对 Hermes 引擎，例如 `'hermes'` | `undefined`。
  const engine = api.caller(caller => (caller ? caller.engine : null));

  // 是否正在为服务器环境打包，例如 API Routes。
  const isServer = api.caller(caller => (caller ? caller.isServer : false));

  // 是否正在为开发环境或生产环境打包。
  const isDev = api.caller(caller =>
    caller
      ? caller.isDev
      : process.env.BABEL_ENV === 'development' || process.env.NODE_ENV === 'development'
  );

  // 确保配置不会被缓存，否则平台将不会更新。
  api.cache(false);
  // 你也可以改为提供更健壮的 CONFIG 缓存失效策略：
  // api.cache.invalidate(() => platform);

  return {
    presets: ['babel-preset-expo'],
    plugins: [
      // 基于平台添加一个插件...
      platform === 'web' && 'my-plugin',

      // 确保过滤掉假值。
    ].filter(Boolean),
  };
};

如果 caller 没有 engine、platform、bundler 等字段，那么请确保你在转换器中使用的是 @expo/metro-config/babel-transformer。如果你使用的是自定义转换器，那么它可能需要继承 Expo 转换器。

尽可能始终把自定义逻辑实现到 resolver 中，因为缓存更简单，也更容易理解。例如，如果你需要重映射一个导入，使用 resolver 解析到静态文件会比解析所有可能的导入方式并用转换器重映射它们更简单也更快。

始终使用 babel-preset-expo 作为默认的 Babel 预设，这可以确保转换始终与 Expo 运行时兼容。babel-preset-expo 会在内部使用所有 caller 输入，以针对给定的平台、引擎和环境进行优化。

Node.js 内置模块

当为服务器环境打包时，Expo 的 Metro 配置会根据当前 Node.js 版本自动支持外部化 Node.js 内置模块（fs、path、node:crypto 等）。如果 CLI 正在为浏览器环境打包，那么内置模块会先检查该模块是否已在本地安装，然后再回退到一个空的 shim。例如，如果你安装了 path 供浏览器中使用，那么它就可以被使用；否则，该模块会自动被跳过。

环境设置

这些环境变量不会在测试环境中定义。

Expo 的 Metro 配置会注入构建设置，这些设置可以通过环境变量在客户端 bundle 中使用。所有变量都会被内联，因此不能动态使用。例如，process.env["EXPO_BASE_URL"] 将不起作用。

• process.env.EXPO_BASE_URL 暴露在 experiments.baseUrl 中定义的基础 URL。这在 Expo Router 中用于在部署时遵守生产环境的基础 URL。

Bundle 拆分

Expo CLI 会在生产环境中根据异步导入自动将 web bundle 拆分为多个 chunk。此功能要求安装 @expo/metro-runtime，并且在入口 bundle 中的某处被导入（在 Expo Router 中默认可用）。

异步 bundle 的共享依赖会合并为一个单独的 chunk，以减少请求数量。例如，如果你有两个异步 bundle 都导入了 lodash，那么该库会合并到一个初始 chunk 中。

chunk 拆分启发式规则无法自定义。例如：

export function add(a, b) {
  return a + b;
}

import '@expo/metro-runtime';

// 这将被拆分到一个单独的 chunk 中。
import('./math').then(math => {
  console.log(math.add(1, 2));
});

当你运行 npx expo export -p web 时，这些 bundle 会被拆分为多个文件，入口 bundle 会被添加到主 HTML 文件中。@expo/metro-runtime 会添加用于加载并执行异步 bundle 的运行时代码。

Source map 调试 ID

如果一个 bundle 导出时带有外部 source map，则会在文件末尾添加一个 Debug ID 注释，并在 source map 中添加对应的 debugId，以便将这些文件关联起来。如果没有导出 source map，或者使用的是内联 source map，则不会添加此注释。

// <所有源代码>

//# debugId=<确定性的 chunk hash>

关联的 *.js.map 或 *.hbc.map source map 将是一个包含等效 debugId 属性的 JSON 文件。debugId 会在 Hermes 字节码生成之前注入，以确保在所有情况下都能匹配。

debugId 是 bundle 内容的确定性哈希值，不包含外部 bundle 拆分引用。这与用于创建 chunk 文件名的值相同，但格式化为 UUID。例如，431b98e2-c997-4975-a3d9-2987710abd44。

@expo/metro-config 会在 npx expo export 和 npx expo export:embed 期间注入 debugId。在 npx expo export:embed 中的任何额外优化步骤，比如 Hermes 字节码生成，都需要手动注入 debugId。

Metro require 运行时

你可以通过环境变量 EXPO_USE_METRO_REQUIRE=1 可选地启用自定义 Metro require 实现。此运行时具有以下特性：

• 字符串模块 ID，便于人工阅读，并使缺失模块错误更容易追踪。
• 确定性 ID，在不同运行之间以及跨模块保持一致（开发中的 React Server Components 需要此特性）。
• 移除了对旧版 RAM bundles 的支持。

魔法导入注释

自 SDK 52 起在所有平台可用。

Workers、Node.js 等服务器环境支持在运行时导入任意文件，因此你可能希望保留 import 语法不变，而不是使用 Metro 的 require 系统。你可以在 import() 语句中使用 /* @metro-ignore */ 注释来选择不使用动态导入。

// 手动确保 `./my-module.js` 被包含在相对于该模块的正确位置。
const myModule = await import(/* @metro-ignore */ './my-module.js');

Expo CLI 会跳过 ./my-module.js 依赖，并假定开发者已将其手动添加到输出 bundle 中。在内部，这用于导出自定义服务器代码，该代码会根据请求在不同文件之间动态切换。请避免在原生 bundle 中使用此语法，因为在启用 Hermes 的 React Native 中，import() 通常不可用。

许多 React 库使用 Webpack 的 /* webpackIgnore: true */ 注释来实现类似行为。为了弥合差异，我们也添加了对 Webpack 注释的支持，但仍建议在你的应用中使用 Metro 对应的写法。

ES 模块解析

本节从 SDK 53 起适用于所有平台。

Metro 会使用不同的解析策略分别解析 ES Module 的 import 和 CommonJS 的 require。

在此之前，Metro 采用经典的 Node.js 模块解析策略（与 v12 之前的 Node.js 版本一致），并增加了一些对 ES Modules 的支持。在这种解析策略下，Metro 会从 node_modules 和 JS 文件中解析模块，可选择省略扩展名（如 .js），并使用 package.json 中的 main、module 和 react-native 等字段。

现在，采用现代 ES Modules 解析策略后，Metro 会先从 node_modules 解析模块，然后匹配不同的 package.json 字段，例如 exports、包暴露的子路径的嵌套映射 和 main。

根据包的导入方式，这两种解析策略之一会被使用。通常，通过 Node 模块中的 import（而不是 require）导入的文件会使用 ES Modules 解析策略，并回退到常规的经典 Node.js 解析。未通过 ES Modules 解析到的文件，或者通过 CommonJS require 导入的文件，会使用经典解析策略。

package.json:exports

在执行 ES Modules 解析时，Metro 会查看 package.json:exports 条件映射。这是将导入子路径和条件映射到 Node 模块包中文件的方式。

例如，一个始终暴露 index.js 文件，并与 Metro 的经典 CommonJS 模块解析相匹配的包，可以通过 default 条件指定一个映射。

{
  "exports": {
    "default": "./index.js"
  }
}

不过，同时提供 CommonJS 和 ES Modules 入口点的包，可以通过 import 和 require 条件提供一个映射。

{
  "exports": {
    "import": "./index.mjs",
    "require": "./index.cjs"
  }
}

默认情况下，Metro 会根据平台以及解析是从 CommonJS require 调用还是从 ES Modules import 语句开始，来匹配不同的条件，并相应地更改条件。

对于原生平台，会添加 react-native 条件；对于 web 导出，会添加 browser 条件；对于服务器导出（例如 API routes 或 React Server functions），会添加 node、react-server 和 workerd 条件。这些条件的匹配顺序不是按照它们在定义中的顺序，而是按照 package.json:exports 映射中属性的顺序来匹配。

TypeScript 会独立于 Metro 执行 ES Module 解析，并且在其 compilerOptions.moduleResolution 配置选项设置为 "bundler"（与 Metro 的行为更接近）或 "node16" / "nodenext" 时，也会遵守 package.json:exports 映射。不过，TypeScript 还会匹配 types 条件。因此，当包没有把 types 条件放在 exports 映射的最前面时，类型可能无法正确解析。

由于 exports 映射可以包含子路径，包导入不再一定需要匹配包 modules 文件夹中的文件，而可能是一个“重定向”的导入。导入 'package/submodule' 时，如果在 package.json:exports 中进行了指定，可能会匹配到不同于 node_modules/package/submodule.js 的文件。

{
  "exports": {
    ".": "./index.js",
    "./submodule": "./submodule/submodule.js"
  }
}

如果你遇到与新的 ES Modules 解析策略不兼容或尚未准备好的包，你可以通过修补其 package.json 文件并添加或修正其 package.json:exports 条件映射来解决问题。不过，也可以通过禁用 unstable_enablePackageExports 选项来阻止 Metro 在解析中使用 package.json:exports 映射。

const { getDefaultConfig } = require('expo/metro-config');

/** @type {import('expo/metro-config').MetroConfig} */
const config = getDefaultConfig(__dirname);

config.resolver.unstable_enablePackageExports = false;

module.exports = config;

资源导入

当资源被导入时，会创建一个虚拟模块来表示导入该资源所需的数据。

在原生平台上，资源将是一个数字 ID：1、2、3 等，可以通过 require("@react-native/assets-registry/registry").getAssetByID(<NUMBER>) 查找。在 web 和 server 平台上，资源会根据文件类型而变化。如果文件是图片，那么资源将是 { uri: string, width?: number, height?: number }，否则资源将是一个表示该资源远程 URL 的 string。

资源可以如下使用：

import { Image } from 'react-native';

import asset from './img.png';

function Demo() {
  return <Image source={asset} />;
}

在 API 路由中，你可以始终假设资源的类型不会是数字：

import asset from './img.png';

export async function GET(req: Request) {
  const ImageData = await fetch(
    new URL(
      // 访问资源 URI。
      asset.uri,
      // 追加到当前请求 URL 的 origin。
      req.url
    )
  ).then(res => res.arrayBuffer());

  return new Response(ImageData, {
    headers: {
      'Content-Type': 'image/png',
    },
  });
}

Web workers

此功能处于 alpha 阶段，且可能会发生破坏性变更。

new Worker(new URL('./worker', window.location.href));

Expo Metro 在 SDK 53 及更高版本中提供了实验性的 web worker 支持。此功能目前仅适用于 web，不能在原生端使用；在原生端使用会触发错误 "Property 'Worker' doesn't exist"。

Web workers 可用于将工作卸载到 web 上的单独线程，使主线程保持响应。这对于计算开销较大的任务很有用，例如图像处理、加密或其他原本会阻塞主线程的任务。

Worker 可以使用 Blob 以内联方式生成，但有时你可能希望利用 TypeScript 或导入其他模块等现代特性。

Web workers 依赖于 Expo 的 bundle 拆分支持，这意味着你需要使用 Expo Router，或者安装并导入 @expo/metro-runtime。你也不能在使用 web workers 时设置环境变量 EXPO_NO_METRO_LAZY=1。

请看下面一个将数字翻倍的 worker 示例：

self.onmessage = ({ data }) => {
  const result = data * 2; // 示例：将数字翻倍
  self.postMessage(result);
};

这个 worker 文件可以在主应用中作为 Worker 导入：

// worker 的类型是 `Worker`
const worker = new Worker(new URL('./worker', window.location.href));

worker.onmessage = ({ data }) => {
  console.log(`Worker 响应：${data}`);
};

worker.postMessage(5);

在幕后，Expo CLI 正在生成如下代码：

const worker = new Worker(
  new URL('/worker.bundle?platform=web&dev=true&etc', window.location.href)
);

生成的 bundle URL 会根据开发/生产环境而变化，以确保 worker 被正确加载并打包。与传统的 bundle 拆分不同，worker 文件需要包含其自身对所有模块的副本，且不能依赖主 bundle 中的公共模块。

原生 API Worker 传统上在 React Native 中不可用，也未由 Expo SDK 提供，因此尽管这个打包特性在技术上适用于所有平台，但它实际上只对 web 有用。如果你想同时支持原生平台，理论上可以编写一个原生 Expo 模块来为 Worker API 提供 polyfill。或者，你也可以在 React Native Reanimated 中使用 “worklet” API，将工作卸载到原生端的单独线程。

另外，你也可以通过公共路径导入 Worker：先将一个转换后的 JS 文件放入 public 目录，然后在 worker 导入中使用变量引用它：

// 将避免转换，并直接使用 public 路径。
const worker = new Worker('/worker.js');

// 变量会破坏转换，从而导致使用字面路径而不是转换后的路径。
const path = '/worker.js';

const anotherWorker = new Worker(new URL(path, window.location.href));

在 Worker 构造函数中使用变量不支持打包。若要检查内部 URL，你可以使用内部语法 require.unstable_resolveWorker('./path/to/worker.js') 来获取 URL 片段。

裸工作流设置

本指南是有版本区分的，在升级/降级 Expo 时需要重新查看。或者，使用 Expo Prebuild 进行完全自动化的设置。

不使用 Expo Prebuild 的项目必须配置原生文件，以确保始终使用 Expo Metro 配置来打包项目。

这些修改旨在分别将 npx react-native bundle 和 npx react-native start 替换为 npx expo export:embed 和 npx expo start。

metro.config.js

确保 metro.config.js 继承自 expo/metro-config：

const { getDefaultConfig } = require('expo/metro-config');

const config = getDefaultConfig(__dirname);

module.exports = config;

android/app/build.gradle

Android 的 app/build.gradle 必须配置为在生产打包时使用 Expo CLI。修改 react 配置对象：

ios/<Project>.xcodeproj/project.pbxproj

在你的 ios/<Project>.xcodeproj/project.pbxproj 文件中，替换以下脚本：

“Start Packager” 脚本

移除 “Start Packager” 脚本。开发服务器必须在运行应用前后通过 npx expo 启动。

“Bundle React Native code and images” 脚本

或者，在 Xcode 项目中，选择 “Bundle React Native code and images” 构建阶段并添加以下修改：

你可以设置 CLI_PATH、BUNDLE_COMMAND 和 ENTRY_FILE 环境变量来覆盖这些默认值。

自定义入口文件

默认情况下，React Native 只支持使用根目录下的 index.js 文件作为入口文件（或平台特定变体，如 index.ios.js）。Expo 项目允许使用任意入口文件，但这需要额外的裸工作流设置。

开发

可以通过使用 expo-dev-client 包来启用开发模式入口文件。或者，你也可以添加以下配置：

生产

在你的 ios/<Project>.xcodeproj/project.pbxproj 文件中，替换 “Bundle React Native code and images” 脚本，以根据 Metro 设置 $ENTRY_FILE：

Android 的 app/build.gradle 必须配置为使用 Metro 模块解析来查找根入口文件。修改 react 配置对象：