登录
首页 >  文章 >  前端

Next.js图片导入Jest报错解决方法

时间:2026-03-03 22:36:57 289浏览 收藏

本文深入解析了 Next.js 项目中 Jest 测试因未正确 mock SVG 等静态资源(如图片)而频繁报错“SyntaxError: Unexpected token”的根本原因,并提供简洁可靠的解决方案——通过配置 Jest 的 moduleNameMapper 将资源文件映射为虚拟模块,彻底规避解析失败问题,让前端单元测试稳定运行、开箱即用。

Next.js + Jest 图片导入 mock 失败的根因与正确配置方案

本文详解 Next.js 项目中 Jest 测试因 SVG 等静态资源未被正确 mock 导致的 SyntaxError: Unexpected token '<' 错误,指出正则表达式书写缺陷是关键原因,并提供完整、可落地的模块映射配置与验证方案。

本文详解 Next.js 项目中 Jest 测试因 SVG 等静态资源未被正确 mock 导致的 `SyntaxError: Unexpected token '

在 Next.js 项目中集成 Jest 进行组件测试时,直接导入 SVG、PNG 等静态资源(如 import Logo from '@/assets/logo.svg')会触发 Jest 解析原始文件内容——而 SVG 是 XML 格式文本,以 开头,Jest 默认将其当作 JavaScript 代码执行,从而抛出经典的 SyntaxError: Unexpected token '<'。虽然你已按 Next.js 官方文档配置了 moduleNameMapper 并编写了 fileMock.js,但错误依然存在,根本原因往往藏在正则表达式的细节中。

? 问题定位:正则表达式未覆盖 SVG(关键陷阱)

你配置中的这一行:

"^.+\\.(png|jpg|jpeg|gif|webp|avif|ico|bmp|svg)$/i"

看似包含 svg,但实际无法匹配 .svg 文件路径。原因在于:

  • ^.+\\. 要求路径中必须存在 至少一个字符 + 字面量点号(如 logo.svg 中的 o.);
  • 但当文件位于 public/assets/Branch1.svg 时,Jest 内部解析的模块请求路径可能是 ./public/assets/Branch1.svg —— 此时 ^ 锚定开头,.+ 匹配 ./public/assets/Branch1,\\. 匹配最后一个点,随后 (png|...|svg) 尝试匹配 svg,看似合理。

⚠️ 真正的问题在于:Jest 的 moduleNameMapper 使用的是 Node.js 的 require.resolve() 语义,对 public/ 下的静态资源处理特殊。Next.js 推荐将图片等静态资源放在 public/ 目录下(通过 /assets/logo.svg URL 访问),而非 import 方式引入。但若你确需 import(例如用作 next/image 的 src),则该导入路径实际指向的是文件系统中的原始 SVG 文件,而你的正则未被触发,因为:

  • Jest 在匹配时可能对 public/ 路径做了特殊处理;
  • 更常见的是:/i 修饰符虽启用忽略大小写,但某些 Jest 版本(尤其搭配 ESM)对正则兼容性不佳,且 ^ 和 $ 在模块路径匹配中并非总是按字面意义工作

✅ 正确写法应更宽松、更鲁棒,推荐使用:

// jest.config.js
moduleNameMapper: {
  // ✅ 正确:移除 ^$ 锚点,用 .* 避免路径结构依赖,明确包含 svg
  "\\.(png|jpg|jpeg|gif|webp|avif|ico|bmp|svg)$": "<rootDir>/__mocks__/fileMock.js",
  // 其他映射保持不变...
}

✅ 完整可运行配置示例

1. 创建 __mocks__/fileMock.js(ESM 兼容写法)

// __mocks__/fileMock.js
// 注意:若 package.json 中有 "type": "module",此处必须用 export default
export default {
  src: '/mock-image.png',
  height: 24,
  width: 24,
  blurDataURL: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg==',
};

2. 更新 jest.config.js(关键修正)

// jest.config.js
export default {
  // ...其他配置保持不变
  moduleNameMapper: {
    "^.+\\.module\\.(css|sass|scss)$": "identity-obj-proxy",
    "^.+\\.(css|sass|scss)$": "<rootDir>/__mocks__/styleMock.js",

    // ✅ 重点修正:移除 ^ $,添加 svg,确保匹配所有目标扩展名
    "\\.(png|jpg|jpeg|gif|webp|avif|ico|bmp|svg)$": "<rootDir>/__mocks__/fileMock.js",

    "^@/components/(.*)$": "<rootDir>/components/$1",
    "^@/pages/(.*)$": "<rootDir>/pages/$1",
  },
  // ...其余配置
};

3. 验证测试用例(确保 mock 生效)

// __tests__/ImageComponent.test.tsx
import { render, screen } from '@testing-library/react';
import ImageComponent from '@/components/ImageComponent';

test('renders mocked image with correct props', () => {
  render(<ImageComponent />);
  const img = screen.getByRole('img');
  // fileMock.js 返回的对象属性会被透传
  expect(img).toHaveAttribute('src', '/mock-image.png');
  expect(img).toHaveAttribute('height', '24');
});

⚠️ 注意事项与最佳实践

  • 优先使用 public/ 目录 + URL 引用:Next.js 官方强烈建议将静态资源(SVG/PNG)放入 public/,通过 /assets/icon.svg 这类 URL 使用,而非 import。这既避免 mock 复杂性,又符合 SSR/SSG 优化逻辑。
  • ESM 项目需严格匹配导出语法:若 package.json 含 "type": "module",__mocks__/fileMock.js 必须用 export default,不可用 module.exports。
  • 清除缓存再测试:修改配置后务必运行 npx jest --clearCache,否则旧缓存可能导致 mock 不生效。
  • 调试技巧:在 fileMock.js 中加入 console.log('fileMock loaded'),若控制台无输出,说明正则未命中;若有输出但报错依旧,则检查 mock 返回值是否符合 next/image 所需 shape(src, width, height, blurDataURL)。

通过修正正则表达式并采用上述配置,即可彻底解决 Jest 解析 SVG 报 Unexpected token '<' 的问题,让 Next.js 组件测试稳定可靠。

终于介绍完啦!小伙伴们,这篇关于《Next.js图片导入Jest报错解决方法》的介绍应该让你收获多多了吧!欢迎大家收藏或分享给更多需要学习的朋友吧~golang学习网公众号也会发布文章相关知识,快来关注吧!

资料下载
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>