3.7 KiB
7.13 ONBUILD 为他人做嫁衣裳
本节涵盖了相关内容与详细描述，主要探讨以下几个方面：
基本语法
如下代码块所示，展示了相关示例：
ONBUILD <其它指令>
ONBUILD 是一个特殊的指令，它后面跟的是其它指令 (如 RUN，COPY 等)，这些指令在当前镜像构建时不会执行，只有当以当前镜像为基础镜像去构建下一级镜像时才会被执行。
为什么需要 ONBUILD
ONBUILD 主要用于制作语言栈基础镜像或框架基础镜像。
场景：维护 Node.js 项目
假设你有多个 Node.js 项目，它们的构建流程都一样：
- 创建目录
- 复制
package.json - 执行
npm install - 复制源码
- 启动应用
如果不使用 ONBUILD，每个项目的 Dockerfile 都要重复这些步骤，且通过 COPY 复制文件时，基础镜像无法预知子项目的文件名。
使用 ONBUILD 的解决方案
基础镜像 (my-node-base)：
FROM node:20-alpine
WORKDIR /app
## 这些指令将在子镜像构建时执行
ONBUILD COPY package*.json ./
ONBUILD RUN npm install
ONBUILD COPY . .
CMD ["npm", "start"]
子项目 Dockerfile：
FROM my-node-base
## 只需要一行！
## 构建时会自动执行 COPY 和 RUN
...
执行机制
如下代码块所示，展示了相关示例：
基础镜像构建：
Dockerfile (含 ONBUILD) ──build──> 基础镜像 (记录了 ONBUILD 触发器)
(指令未执行)
子镜像构建：
FROM 基础镜像 ──build──> 读取基础镜像触发器 ──> 执行触发器指令 ──> 继续执行子 Dockerfile
常见使用场景
本节涵盖了相关内容与详细描述，主要探讨以下几个方面：
1。自动处理依赖安装
如下代码块所示，展示了相关示例：
## Python 基础镜像
ONBUILD COPY requirements.txt ./
ONBUILD RUN pip install -r requirements.txt
2。自动编译代码
如下代码块所示，展示了相关示例：
## Go 基础镜像
ONBUILD COPY . .
ONBUILD RUN go build -o app main.go
3。处理静态资源
如下代码块所示，展示了相关示例：
## Nginx 静态网站基础镜像
ONBUILD COPY dist/ /usr/share/nginx/html/
注意事项
本节涵盖了相关内容与详细描述，主要探讨以下几个方面：
1。继承性限制
ONBUILD 指令只会继承一次。
- 镜像 A (含 ONBUILD)
- 镜像 B (FROM A) -> 触发 ONBUILD
- 镜像 C (FROM B) -> 不会再次触发 ONBUILD
2。构建上下文
子镜像构建时，ONBUILD COPY . . 中的 . 指的是子项目的构建上下文，而不是基础镜像的上下文。
3。不允许级联
ONBUILD ONBUILD 是非法的。你不能写 ONBUILD ONBUILD COPY ...。
4。可能会导致构建失败
由于 ONBUILD 实际上是在子镜像中执行指令，如果子项目的上下文不满足要求 (例如缺少 package.json)，会导致子镜像构建失败，且错误信息可能比较隐晦。
最佳实践
本节涵盖了相关内容与详细描述，主要探讨以下几个方面：
1。命名规范
建议在镜像标签中添加 -onbuild 后缀，明确告知使用者该镜像包含触发器。
node:20-onbuild
python:3.12-onbuild
2。避免执行耗时操作
尽量不要在 ONBUILD 中执行过于耗时或不确定的操作 (如更新系统软件)，这会让子镜像构建变得缓慢且不可控。
3。清理工作
如果 ONBUILD 指令产生了临时文件，最好在同一个指令链中清理，或者提供机制让子镜像清理。