图像

Astro 为你提供了多种在网站上使用图像的方法，无论它们是本地存储在你的项目内，还是链接到外部 URL，或者在 CMS 或 CDN 中管理的！

在哪里存储图像

段落标题 在哪里存储图像

src/ vs public/

段落标题 src/ vs public/

我们建议尽可能将本地图像保存在 src/ 中，以便 Astro 可以对其进行转换、优化和打包。/public 目录中的文件始终按原样服务或复制到构建文件夹中，不进行任何处理。

你在 src/ 中存储的本地图像可以被项目中的所有文件使用：.astro、.md、.mdx、.mdoc 和其他 UI 框架。图像可以存储在任何文件夹中，包括与你的内容一起。

如果你想要避免对图像做任何处理或者想要直接公开链接到图像，请将图像存储在 public/ 文件夹中。

远程图像

段落标题 远程图像

你还可以选择将图像远程存储在内容管理系统（CMS）或数字资产管理（DAM）平台中。

在处理外部来源时，为了提供额外的保护，只有在配置中指定的 授权图像源 才会被处理。但是，任何远程图像都可以显示。

Astro 可以使用 API 远程获取数据，也可以显示来自其完整 URL 路径的图像。请参阅我们的 CMS 指南，了解集成常见服务的示例。

.astro 文件中的图像

段落标题 .astro 文件中的图像

在 .astro 文件中，本地图像必须被导入到文件中才能使用。远程和 public/ 图像不需要导入。

使用 astro:assets 导入并使用 Astro 内置的 <Image /> 组件来优化图像。或者，Astro 语法支持直接编写 HTML <img> 标签，这将跳过图像处理。

src/pages/blog/my-images.astro

---
import { Image } from 'astro:assets';
import localBirdImage from '../../images/subfolder/localBirdImage.png';
---
<Image src={localBirdImage} alt="一只鸟坐在蛋窝上。" />
<Image src="/images/bird-in-public-folder.jpg" alt="一只鸟" width="50" height="50" />
<Image src="https://example.com/remote-bird.jpg" alt="一只鸟" width="50" height="50" />

<img src={localBirdImage.src} alt="一只鸟坐在蛋窝上。">
<img src="/images/bird-in-public-folder.jpg" alt="一只鸟">
<img src="https://example.com/remote-bird.jpg" alt="一只鸟">

要从 src/ 文件夹中动态导入图像，请参阅下面的操作指南：

相关操作指南： 动态导入图片

<Image /> (astro:assets)

段落标题 <Image /> (astro:assets)

使用内置的 <Image /> Astro 组件来显示本地图像和 配置的远程图像 的优化版本。

public/ 文件夹中的图像以及未在项目中特别配置的远程图像也可以与 Image 组件一起使用，但不会被处理。

<Image /> 可以转换本地或授权的远程图像的尺寸、文件类型和质量，以便控制显示的图像。生成的 <img> 标签包括 alt、loading 和 decoding 属性，并推断图像尺寸以避免 累积布局偏移 Cumulative Layout Shift (CLS)。

什么是累积布局偏移（Cumulative Layout Shift）？

累积布局偏移 Cumulative Layout Shift (CLS) 是一种用于测量页面加载过程中内容移动量的核心 Web 指标。<Image /> 组件通过自动为本地图像设置正确的 width 和 height 来优化 CLS。

src/components/MyComponent.astro

---
// 导入 Image 组件和图像
import { Image } from 'astro:assets';
import myImage from '../assets/my_image.png'; // Image is 1600x900
---

<!-- 在 Image 组件上 `alt` 是必须的  -->
<Image src={myImage} alt="A description of my image." />

<!-- 输出 -->
<!-- 优化图像，强制实施适当的属性 -->
<img
  src="/_astro/my_image.hash.webp"
  width="1600"
  height="900"
  decoding="async"
  loading="lazy"
  alt="A description of my image."
/>

属性

段落标题 属性

src (必须)

段落标题 src (必须)

图像文件的 src 值的格式取决于图像文件的位置：

• src/ 中的本地图像 - 你必须同时导入图像，使用相对文件路径或配置并使用 导入别名。然后使用导入名称作为 src 值：

  src/pages/index.astro

  ---
  import { Image } from 'astro:assets';
  import myImportedImage from '../assets/my-local-image.png';
  ---
  <Image src={myImportedImage} alt="descriptive text" />

• public/ 文件夹中的图像 - 使用图像相对于 public 文件夹的文件路径作为属性值：

  src/pages/index.astro

  ---
  import { Image } from 'astro:assets';
  ---
  <Image
    src="/images/my-public-image.png"
    alt="descriptive text"
    width="200"
    height="150"
  />

• 远程图像 - 使用图像的完整 URL作为属性值：

  src/pages/index.astro

  ---
  import { Image } from 'astro:assets';
  ---
  <Image
    src="https://example.com/remote-image.jpg"
    alt="descriptive text"
    width="200"
    height="150"
  />

alt (必须)

段落标题 alt (必须)

不是所有用户都能以相同的方式看到图像，因此在使用图像时，无障碍性尤为重要。使用 alt 属性为图像提供 描述性的 alt 文本。

如果图像仅仅是装饰性的（即不会对页面的理解有所贡献），请设置 alt="" 以便屏幕阅读器和其他辅助技术知道忽略该图像。

width 和 height（对于 public/ 中的图像是必须的）

段落标题 width 和 height（对于 public/ 中的图像是必须的）

这些属性定义了要用于图像的尺寸。

当使用保持原始宽高比的图像时，width 和 height 是可选的。这些尺寸可以自动从位于 src/ 中的图像文件和设置了 inferSize 设置为 true 的远程图像中推断出来。

但是，对于存储在你的 public/ 文件夹中的图像，这两个属性都是必需的，因为 Astro 无法分析这些文件。

densities

段落标题 densities

添加于： astro@3.3.0

为图像生成的像素密度列表。

如果提供了该值，将会在 <img> 标签上生成一个 srcset 属性。在使用此值时，请不要提供 widths 的值。

与原始图像相同或大于原始图像宽度的像素密度会被忽略，以避免放大图像。

src/components/MyComponent.astro

---
import { Image } from 'astro:assets';
import myImage from '../assets/my_image.png';
---
<Image
  src={myImage}
  width={myImage.width / 2}
  densities={[1.5, 2]}
  alt="我的图片描述"
/>

<!-- 输出 -->
<img
  src="/_astro/my_image.hash.webp"
  srcset="
    /_astro/my_image.hash.webp 1.5x
    /_astro/my_image.hash.webp 2x
  "
  alt="我的图片描述"
  width="800"
  height="450"
  loading="lazy"
  decoding="async"
/>

widths

段落标题 widths

添加于： astro@3.3.0

为图像生成的宽度列表。

如果提供了该值，将会在 <img> 标签上生成一个 srcset 属性。但还需提供一个 sizes 属性。

在使用该值时，请不要提供 densities 的值。这两个值只能选择一个来生成 srcset 属性。

将忽略大于原始图像宽度的宽度值，以避免对图像进行放大。

src/components/MyComponent.astro

---
import { Image } from 'astro:assets';
import myImage from '../assets/my_image.png'; // Image is 1600x900
---
<Image
  src={myImage}
  widths={[240, 540, 720, myImage.width]}
  sizes={`(max-width: 360px) 240px, (max-width: 720px) 540px, (max-width: 1600px) 720px, ${myImage.width}px`}
  alt="我的图片描述"
/>

<!-- 输出 -->
<img
  src="/_astro/my_image.hash.webp"
  srcset="
    /_astro/my_image.hash.webp 240w,
    /_astro/my_image.hash.webp 540w,
    /_astro/my_image.hash.webp 720w,
    /_astro/my_image.hash.webp 1600w
  "
  sizes="
    (max-width: 360px) 240px,
    (max-width: 720px) 540px,
    (max-width: 1600px) 720px,
    1600px
  "
  alt="我的图片描述"
  width="1600"
  height="900"
  loading="lazy"
  decoding="async"
/>

format

段落标题 format

你可以选择指定要使用的 图像文件类型 输出。

默认情况下，<Image /> 组件将生成 .webp 文件。

quality

段落标题 quality

quality 是一个可选属性，可以是：

• 一个预设值（low、mid、high、max），可以在不同格式之间自动标准化。
• 一个从 0 到 100 的数字（在格式之间有不同的解释）。

inferSize

段落标题 inferSize

添加于： astro@4.4.0

允许你自动设置远程图像的原始 width 和 height。

默认情况下，这个值被设置为 false，你必须手动指定远程图片的宽度和高度。

在 <Image /> 组件中添加 inferSize（或者在 getImage() 中添加 inferSize: true），以便在获取时从图片内容中推断这些值。如果你不知道远程图片的尺寸，或者这些尺寸可能会变化，这个属性对你会很有帮助：

---
import { Image } from 'astro:assets';
---
<Image src="https://example.com/cat.png" inferSize alt="一只猫在阳光下睡觉。" />

inferSize 能够获取来自未经授权域的远程图片的尺寸，但图片本身将保持未处理状态。

附加属性

段落标题 附加属性

除了上面的属性之外，<Image /> 组件还接受 HTML <img> 标签接受的所有属性。

例如，你可以为最终的 <img> 元素提供一个 class。

src/pages/index.astro

---
import { Image } from 'astro:assets';
import myImage from '../assets/my_image.png';
---

<!-- 在 Image 组件上 `alt` 是必须的 -->
<Image src={myImage} alt="" class="my-class" />

<!-- 输出 -->
<img
  src="/_astro/my_image.hash.webp"
  width="1600"
  height="900"
  decoding="async"
  loading="lazy"
  class="my-class"
  alt=""
/>

设置默认值

段落标题 设置默认值

目前，没有办法为所有 <Image /> 组件指定默认值。必需的属性应该在每个单独的组件上设置。

作为替代方案，你可以在另一个 Astro 组件中封装这些组件以便重用。例如，你可以为博客文章图像创建一个组件：

src/components/BlogPostImage.astro

---
import { Image } from 'astro:assets';

const { src, ...attrs } = Astro.props;
---
<Image src={src} {...attrs} />

<style>
  img :global(img), svg {
    margin-block: 2.5rem;
    border-radius: 0.75rem;
  }
</style>

<Picture />

段落标题 <Picture />

添加于： astro@3.3.0

使用内置的 <Picture /> Astro 组件来显示具有多种格式和/或尺寸的响应式图像。

src/pages/index.astro

---
import { Picture } from 'astro:assets';
import myImage from '../assets/my_image.png'; // 图像分辨率为 1600x900
---
<!-- `alt` 属性在 `Picture` 组件中是必需的 -->
<Picture src={myImage} formats={['avif', 'webp']} alt="我的图片描述" />

<!-- 输出 -->
<picture>
  <source srcset="/_astro/my_image.hash.avif" type="image/avif" />
  <source srcset="/_astro/my_image.hash.webp" type="image/webp" />
  <img
    src="/_astro/my_image.hash.png"
    width="1600"
    height="900"
    decoding="async"
    loading="lazy"
    alt="我的图片描述"
  />
</picture>

属性

段落标题 属性

<Picture /> 支持 <Image /> 组件的所有属性，以及以下属性：

formats

段落标题 formats

用于 <source> 标签的图像格式数组。条目将按照它们在数组中的顺序作为 <source> 元素添加到标签中，这个顺序决定了显示的格式。为了最佳性能，请将最新的格式放在首位（例如 webp 或 avif）。默认情况下，设置为 ['webp']。

fallbackFormat

段落标题 fallbackFormat

用作 <img> 标签的回退格式值。

静态图像默认使用 .png 格式（如果图像是 JPG 格式，则默认为 .jpg），动画图像默认为 .gif 格式，SVG 文件默认为 .svg 格式。

pictureAttributes

段落标题 pictureAttributes

一个要添加到 <picture> 标签的属性对象。

使用此属性将属性应用于外部的 <picture> 元素本身。直接应用于 <Picture /> 组件的属性，除了那些图像转换属性，将应用于内部的 <img> 元素。

---
import { Picture } from "astro:assets";
import myImage from "../my_image.png"; // 图像分辨率为 1600x900
---
<Picture
  src={myImage}
  alt="我的图片描述"
  pictureAttributes={{style: "background-color: red;"}} />

<!-- 输出 -->
<picture style="background-color: red;">
  <source srcset="/_astro/my_image.hash.webp" type="image/webp" />
  <img
    src="/_astro/my_image.hash.png"
    alt="我的图片描述"
    width="1600"
    height="900"
    loading="lazy"
    decoding="async"
  />
</picture>

<img>

段落标题 <img>

Astro 模板语法 也支持直接编写 <img> 标签，完全控制其最终输出。这些图像不会被处理和优化。

它接受所有 HTML <img> 标签属性，唯一必需的属性是 src。

src/ 中的本地图像

段落标题 src/ 中的本地图像

本地图像必须从现有的 .astro 文件的相对路径导入，或者配置并使用 导入别名。然后，你可以访问图像的 src 和其他属性，以在 <img> 标签中使用。

例如，使用图像自己的 height 和 width 属性，以避免布局位移累计 CLS 并改善核心 Web 性能指标。

src/pages/posts/post-1.astro

---
// 导入本地图像
import myDog from '../../images/pets/local-dog.jpg';
---
// 访问图像的属性
<img src={myDog.src} width={myDog.width} height={myDog.height} alt="一只狂吠的狗。" />

导入的图像资源与以下签名相匹配：

interface ImageMetadata {
  src: string;
  width: number;
  height: number;
  format: string;
}

public/ 中的图像

段落标题 public/ 中的图像

对于位于 public/ 中的图像，请使用图像相对于 public 文件夹的文件路径作为 src 值：

<img src="/images/public-cat.jpg" alt="一只睡觉的猫。" >

远程图像

段落标题 远程图像

对于远程图像，请使用图像的完整 URL作为 src 值：

<img src="https://example.com/remote-cat.jpg" alt="一只睡觉的猫。">

选择 <Image /> 还是 <img>

段落标题 选择 <Image /> 还是 <img>

<Image /> 组件会优化图像，并根据原始宽高比推断宽度和高度（对于本地图像），以避免 CLS。

当你不能使用 <Image /> 组件时，请使用 HTML <img> 元素，例如：

• 不支持的图像格式
• 当你不想让 Astro 优化你的图像时
• 为了在客户端动态访问和更改 src 属性

授权远程图像

段落标题 授权远程图像

你可以使用 image.domains 和 image.remotePatterns 配置授权图像源 URL 域和模式列表，以进行图像优化。这个配置是一个额外的安全层，用于在显示来自外部源的图像时保护你的站点。

来自其他来源的远程图像不会被优化，但是使用 <Image /> 组件可以防止累积布局移位（CLS）。

例如，以下配置将只允许来自 astro.build 的远程图像进行优化：

astro.config.mjs

export default defineConfig({
  image: {
    domains: ["astro.build"],
  }
});

以下配置将只允许来自 HTTPS 主机的远程图像：

astro.config.mjs

export default defineConfig({
  image: {
    remotePatterns: [{ protocol: "https" }],
  }
});

使用 CMS 或 CDN 中的图像

段落标题 使用 CMS 或 CDN 中的图像

图像 CDN 与所有 Astro 图像选项兼容。在 <Image /> 组件、<img> 标签或 Markdown 表示法中，使用图像的完整 URL 作为 src 属性。对于远程图像的图像优化，还需要 配置授权域或 URL 模式。

或者，如果 CDN 提供了 Node.js SDK，你可以在项目中使用它。例如，Cloudinary 的 SDK 可以为你生成一个带有适当 src 的 <img> 标签。

Markdown 文件中的图像

段落标题 Markdown 文件中的图像

在 .md 文件中使用标准的 Markdown ![alt](src) 语法。这个语法可以与 Astro 的 图像服务 API 一起使用，来优化你在 src/ 目录下的本地图像。远程图像和 public/ 目录下的本地图像不会被优化。

src/pages/post-1.md

# 我的 Markdown 页面

<!-- 存储在 src/assets/ 中的本地图像 -->
<!-- 使用相对路径或者导入别名 -->
![繁星点点的夜空](../assets/stars.png)

<!-- 存储在 public/images/ 中的图像 -->
<!-- 使用相对 public/ 的文件路径-->
![繁星点点的夜空](/images/stars.png)

<!-- 其他服务上的远程图像 -->
<!-- 使用图像的完成 url -->
![Astro](https://example.com/images/remote-image.png)

本地图像不支持 <img> 标签，也不支持 <Image /> 组件。

如果你需要对图像属性做更多的控制，我们建议使用 .mdx 文件格式，除了 Markdown 语法，你还可以使用 Astro 的 <Image /> 组件或 JSX <img /> 标签。使用 MDX 集成 为 Astro 添加对 MDX 的支持。

MDX 文件中的图像

段落标题 MDX 文件中的图像

你可以通过导入组件和图像在你的 .mdx 文件中使用 Astro 的 <Image /> 组件 和 JSX <img /> 标签。使用它们就像 在 .astro 文件中使用 一样。

此外，还支持 标准的 Markdown ![alt](src) 语法，无需导入。

src/pages/post-1.mdx

---
title: 我的页面标题
---
import { Image } from 'astro:assets';
import rocket from '../assets/rocket.png';

# 我的 MDX 页面

// 存储在同一文件夹中的本地图像
![太空中的火箭飞船](houston.png)

// 存储在 src/assets/ 中的本地图像
<Image src={rocket} alt="太空中的火箭飞船" />
<img src={rocket.src} alt="太空中的火箭飞船" />
![太空中的火箭飞船](../assets/rocket.png)

// 存储在 public/images/ 中的图像
<Image src="/images/stars.png" alt="繁星点点的夜空" />
<img src="/images/stars.png" alt="繁星点点的夜空" />
![繁星点点的夜空](/images/stars.png)

// 其他服务上的远程图像
<Image src="https://example.com/images/remote-image.png" />
<img src="https://example.com/images/remote-image.png" />
![Astro](https://example.com/images/remote-image.png)

内容集合中的图像

段落标题 内容集合中的图像

内容集合中的图像将会按照你所使用的文件类型，以与 Markdown 和 MDX 中相同的方式处理。

此外，你还可以在 frontmatter 中为内容集合条目声明一个关联图像，例如博客文章的封面图像，使用其相对于当前文件夹的路径：

src/content/blog/my-post.md

---
title: "我的第一篇博客文章"
cover: "./firstpostcover.jpeg" # 将解析为 "src/content/blog/firstblogcover.jpeg"
coverAlt: "一张山脉后面的日落照片。"
---

这是一篇博客文章。

内容集合 schema 中的 image 助手允许你使用 Zod 验证图像元数据。

src/content/config.ts

import { defineCollection, z } from "astro:content";

const blogCollection = defineCollection({
  schema: ({ image }) => z.object({
    title: z.string(),
    cover: image().refine((img) => img.width >= 1080, {
      message: "封面图片必须至少 1080 像素宽！",
    }),
    coverAlt: z.string(),
  }),
});

export const collections = {
  blog: blogCollection,
};

图像将被导入并转换为元数据，允许你将其作为 src 传递给 <Image/>、<img> 或 getImage()。

下面的示例显示了一个博客索引页面，该页面从上面的模式中呈现了每篇博客文章的封面照片和标题：

src/pages/blog.astro

---
import { Image } from "astro:assets";
import { getCollection } from "astro:content";
const allBlogPosts = await getCollection("blog");
---

{
  allBlogPosts.map((post) => (
    <div>
      <Image src={post.data.cover} alt={post.data.coverAlt} />
      <h2>
        <a href={"/blog/" + post.slug}>{post.data.title}</a>
      </h2>
    </div>
  ))
}

框架组件中的图像

段落标题 框架组件中的图像

在 UI 框架组件中添加图像时，请使用框架自己的图像语法来渲染图像（例如，在 JSX 中使用 <img />，在 Svelte 中使用 <img>）。

本地图像必须先被导入，才能访问它们的 图像属性，例如 src。

src/components/ReactImage.jsx

import stars from "../assets/stars.png";

export default function ReactImage () {
  return (
    <img src={stars.src} alt="繁星点点的夜空。" />
  )
}

src/components/SvelteImage.svelte

<script>
  import stars from '../assets/stars.png';
</script>

<img src={stars.src} alt="繁星点点的夜空。" />

传递 Image 组件

段落标题 传递 Image 组件

<Image /> 组件，就像任何其他 Astro 组件一样，对 UI 框架组件不可用。

但是，你可以将 <Image /> 生成的静态内容作为子组件传递给 .astro 文件中的框架组件，或者使用 命名的 <slot/>。

src/components/ImageWrapper.astro

---
import ReactComponent from './ReactComponent.jsx';
import { Image } from 'astro:assets';
import stars from '~/stars/docline.png';
---

<ReactComponent>
  <Image src={stars} alt="繁星点点的夜空。" />
</ReactComponent>

使用 getImage() 生成图像

段落标题 使用 getImage() 生成图像

警告

getImage() 依赖于仅在服务端可用的 API，当在客户端使用时会导致构建失败。

getImage() 函数用于生成图像，这些图像将被用于除了直接在 HTML 中使用之外的其他地方，例如在 API 路由 中。它还允许你创建自己的自定义 <Image /> 组件。

相关操作指南： 构建自定义图像组件

getImage() 函数接受一个选项对象，其中包含与 Image 组件 相同的属性（除了 alt）。

---
import { getImage } from "astro:assets";
import myBackground from "../background.png";

const optimizedBackground = await getImage({src: myBackground, format: 'webp'});
---

<div style={`background-image: url(${optimizedBackground.src});`}></div>

它返回一个具有以下属性的对象：

{
  rawOptions: {...}, // 传递的原始参数
  options: {...}, // 经过验证的参数
  src: "..."， // 生成图像的路径
  srcSet: {
    values: [...], // srcset 的生成值，每个条目包含一个 URL 和一个尺寸描述符
    attribute: "", // 从生成的值生成的 srcset 属性
  },
  attributes: {...} // 渲染图像所需的附加 HTML 属性（宽度、高度、样式等）
}

替代文本

段落标题 替代文本

不是所有用户都能以相同的方式看到图像，因此在使用图像时，无障碍性尤为重要。使用 alt 属性为图像提供 描述性的 alt 文本。

这个属性对于 <Image /> 和 <Picture /> 组件都是必需的。如果没有提供 alt 文本，将提供一个有用的错误消息，提醒你包含 alt 属性。

如果图像仅仅是装饰性的（即不会对页面的理解有所贡献），请设置 alt="" 以便屏幕阅读器和其他辅助技术知道忽略该图像。

默认图像服务

段落标题 默认图像服务

Sharp 是 astro:assets 使用的默认图像服务。你可以使用 image.service 选项进一步配置图像服务。

注意

当使用像 pnpm 这样的严格包管理器时，即使 Sharp 已经是 Astro 的依赖项，你也可能需要手动安装 Sharp 到你的项目中：

pnpm add sharp

配置 Squoosh

段落标题 配置 Squoosh

如果你想使用 Squoosh 来转换你的图像，请使用以下配置更新你的配置：

astro.config.mjs

import { defineConfig, squooshImageService } from 'astro/config';

export default defineConfig({
  image: {
    service: squooshImageService(),
  },
});

配置 no-op 透传服务

段落标题 配置 no-op 透传服务

如果你的 server 或 hybrid 模式适配器不支持 Astro 内置的 Squoosh 和 Sharp 图片优化（如 Deno、Cloudflare），你可以配置一个 no-op 图像服务来使你可以使用 <Image /> 和 <Picture /> 组件。注意 Astro 在这些环境中不会执行任何图像转换和处理。不过你依旧可以享受使用 astro:assets 的其他好处，比如没有累积布局移位（CLS）、强制执行的 alt 属性和一致的创作体验。

配置 passthroughImageService() 来避免 Squoosh 和 Sharp 图像处理：

astro.config.mjs

import { defineConfig, passthroughImageService } from 'astro/config';

export default defineConfig({
  image: {
    service: passthroughImageService()
  }
});

社区集成

段落标题 社区集成

这里有几个第三方 社区图像集成，用于优化和处理 Astro 项目中的图像。