文档章节

Resource 方法

在全局资源、页面资源或远程资源对象上使用这些方法。

这一页解决什么问题

Hugo 把 assets/ 目录里的文件、页面包(leaf bundle)里的文件,以及 resources.GetRemote 抓回来的文件统一称作 Resource 对象。这些方法就是「拿到这个对象之后能对它做什么」的清单:读出它的名字、类型、内容、尺寸、元数据,对它做图像变换,或者把它发布到 public。

读懂本章的关键是先分清资源的三种来源——同一个方法在不同来源上返回值可能不同,个别方法只对其中一两种来源有效:

来源 怎么拿到 典型限制
global resource(全局资源) resources.Get / resources.GetMatch 路径相对 assets/ 目录
page resource(页面资源) .Resources.Get / .Resources.Match 路径相对页面包;可带前置元数据里声明的 name、title、params
remote resource(远程资源) resources.GetRemote 需要联网;Name、Title 是带哈希的文件名

读完本章你应该能够

  • 判断一个方法能不能用在手头的资源上(例如 Params 只对页面资源有意义);
  • 读出图像资源的宽高、媒体类型、主要颜色与元数据,并在取值前做存在性判断;
  • 用 Resize、Fit、Fill、Crop、Filter、Process 之一完成图像变换,并说清它们之间怎么选;
  • 知道什么情况下资源是 nil、方法会返回零值还是直接让构建失败。

阅读顺序

先认脸,再取内容,最后变换与发布:

  1. 识别资源:Name → Title → ResourceType → MediaType;
  2. 取内容与元数据:Content → Params → Data → Meta → Colors;
  3. 输出与发布:RelPermalink → Permalink → Publish;
  4. 图像变换:Width / Height(读取尺寸)→ Resize / Fit / Fill / Crop → Filter → Process(一条字符串完成多种变换);
  5. 已弃用:Err(0.141.0 已移除)、Exif(0.155.0 弃用,改用 Meta)——只在维护老项目时查看。

只做常规图像处理的话,先读 图像处理 一章,再回来查具体方法的边界。

本章内容

  • Colors 用简易直方图方法返回图像最主要颜色的切片,从最主要到最次要排序。 (今天)
  • Content 返回给定资源的内容。 (今天)
  • Crop 返回按给定处理规格裁剪后的新图像资源。 (今天)
  • Data 返回 resources.GetRemote、css.Build 与 js.Build 函数所产生资源的补充信息。 (今天)
  • Err 远程资源的 HTTP 请求失败时返回错误消息,否则返回 nil。 (今天)
  • Exif 返回一个对象,其中包含受支持图像格式的 Exif 元数据。 (今天)
  • Fill 返回按给定处理规格裁剪并缩放后的新图像资源。 (今天)
  • Filter 返回应用了一个或多个图像滤镜后的新图像资源。 (今天)
  • Fit 返回按给定处理规格缩小适配后的新图像资源。 (今天)
  • Height 返回给定图像资源的高度。 (今天)
  • MediaType 返回给定资源的媒体类型对象。 (今天)
  • Meta 返回图像的 Exif、IPTC 与 XMP 元数据(格式支持时)。 (今天)
  • Name 返回给定资源的名称,可以是在前置元数据中定义的名称,未定义时回退到其文件路径。 (今天)
  • Params 返回前置元数据中定义的资源参数映射。 (今天)
  • Permalink 返回给定资源的永久链接,并在返回过程中发布该资源。 (今天)
  • Process 返回按给定处理规格处理后的新图像资源。 (今天)
  • Publish 发布给定资源。 (今天)
  • RelPermalink 返回给定资源的相对永久链接,并在返回过程中发布该资源。 (今天)
  • Resize 返回按给定处理规格缩放后的新图像资源。 (今天)
  • ResourceType 返回给定资源媒体类型的主类型。 (今天)
  • Title 返回给定资源的标题,可以是在前置元数据中定义的标题,未定义时按资源类型回退到相对路径或带哈希值的文件名。 (今天)
  • Width 返回给定图像资源的宽度。 (今天)