2023-12-11 如何优化 Docker 下 Node.js 项目的体积

参考链接:

docker-minimize:https://github.com/CaoMeiYouRen/docker-minimize

RSSHub:https://github.com/DIYgod/RSSHub

Docker 镜像体积优化:https://blog.cmyr.ltd/archives/e0dc9e5a.html

前言

在很久以前,我写过一篇博客 Docker 镜像体积优化 来说明如何 Docker 镜像体积,但实际上,那篇文章有一个遗漏的地方,那就是:只说明了如何优化 Node.js 运行时的体积,而没有说明如何优化包含 node_modules 依赖的体积

现在,本文将补上这最后一个关键点。

在开始解释 RSSHub 的 Dockerfile 之前,先看下常见的优化 Docker 下 Node.js 项目的体积的方案。

一、分段构建

对比以下两个 Dockerfile 的差异

方案一

FROM caomeiyouren/alpine-nodejs:1.1.0 as builder

WORKDIR /home/app

COPY package.json .npmrc /home/app/

RUN pnpm i

COPY . /home/app

RUN pnpm run build

EXPOSE 3000

CMD ["pnpm", "start"]

方案二

# 阶段一:构建阶段
FROM caomeiyouren/alpine-nodejs:1.1.0 as builder

WORKDIR /home/app

COPY package.json .npmrc /home/app/

RUN pnpm i

COPY . /home/app

RUN pnpm run build

# 阶段二:生产阶段
FROM node:20-alpine

WORKDIR /home/app

COPY --from=builder /home/app /home/app

EXPOSE 3000

CMD ["node", "dist/main"]

可以看到,相比方案一,方案二采用了分阶段构建的方法。

在这种情况下,最终的构建产物中将只保留生产环境所需的依赖,而不需要开发环境、构建环境下的依赖

具体的体积差异参考下图。

392MB vs 338MB,可见还是有一定差距的。

image-20231211221209680
image-20231211221538801

二、精简依赖

例如,将

npm i 

替换为

npm i --production

此时会只下载生产环境依赖,可以减少部分体积。

但在这里,我要揭示一个真相,那就是,在 Node.js 生态中,使用 npm i --production替换npm i无法减小多少镜像体积!!!

有图为证。

此处以 docker-minimize 项目作为例子。

虽然实际上用的 pnpm ,但原理类似。

caomeiyouren/alpine-nodejs 是我个人封装的一个精简版 Node.js 镜像,比官方的 node:alpine 体积还小。

1. npm i 的情况

# 阶段一:构建阶段
FROM caomeiyouren/alpine-nodejs:1.1.0 as builder

WORKDIR /home/app

COPY package.json .npmrc /home/app/

RUN pnpm i

使用 docker images 查看镜像体积可见,体积达到了 391MB!

image-20231211215320042

那么接下来我们来看看使用 npm i --production会不会减小镜像体积。

2. npm i --production

# 阶段一:构建阶段
FROM caomeiyouren/alpine-nodejs:1.1.0 as builder

WORKDIR /home/app

COPY package.json .npmrc /home/app/

RUN pnpm i --production

可以看到,在使用了pnpm i --production后,镜像体积为 390MB,相比之前的镜像体积竟然只减少了1MB

image-20231211215558921

要知道, docker-minimize 中使用的devDependencies数目是非常多的,在减去这些之后居然还没有减少!

问题出在了哪里?

通过 npm i --production 精简依赖存在的问题

实际上,在 Node.js 项目中,node_modules 的体积一般是随项目对数增长的,即依赖越多,node_modules 体积增长的越缓慢。

这又是为什么?

202312112200292.jpeg

原因在于,无论是 npm、yarn 还是 pnpm,无一例外的都采用了多种方案来复用 node_modules 中存在的相同依赖 ,以减少 node_modules 的总体积,故 node_modules 的体积不是随依赖数目线性增加的,而是对数增长。

可以简单的理解为,安装的依赖越多,新增的依赖和原有依赖存在相同依赖的可能性更大。

读者可以点开 node_modules 看看,依赖的数目是不是惊人的多。如果使用 pnpm 请点开 node_modules/.pnpm。

所以,这就导致了明明使用了npm i --production,减少的体积却没多少。

RSSHub 精简依赖的思路

那么问题来了,RSSHub 是做了什么才让他们的镜像体积这么小的?

image-20231211221713421

答案就在他们的这个 minify-docker.js 脚本里。

/* eslint-disable no-console */
const fs = require('fs-extra');
const path = require('path');
const { nodeFileTrace } = require('@vercel/nft');
// !!! if any new dependencies are added, update the Dockerfile !!!

const projectRoot = path.resolve(process.env.PROJECT_ROOT || path.join(__dirname, '../..'));
const resultFolder = path.join(projectRoot, 'app-minimal'); // no need to resolve, ProjectRoot is always absolute
const files = ['lib/index.js', 'api/vercel.js'].map((file) => path.join(projectRoot, file));

(async () => {
    console.log('Start analyzing, project root:', projectRoot);
    const { fileList: fileSet } = await nodeFileTrace(files, {
        base: projectRoot,
    });
    let fileList = Array.from(fileSet);
    console.log('Total touchable files:', fileList.length);
    fileList = fileList.filter((file) => file.startsWith('node_modules/')); // only need node_modules
    console.log('Total files need to be copied (touchable files in node_modules/):', fileList.length);
    console.log('Start copying files, destination:', resultFolder);
    return Promise.all(fileList.map((e) => fs.copy(path.join(projectRoot, e), path.join(resultFolder, e))));
})().catch((err) => {
    // fix unhandled promise rejections
    console.error(err, err.stack);
    process.exit(1);
});

接下来让我们看一下这个脚本做了什么。

const { nodeFileTrace } = require('@vercel/nft');
const { fileList: fileSet } = await nodeFileTrace(files, {
    base: projectRoot,
});
fileList = fileList.filter((file) => file.startsWith('node_modules/'));
return Promise.all(fileList.map((e) => fs.copy(path.join(projectRoot, e), path.join(resultFolder, e))));

整体而言,这个脚本就做了一件事,使用 @vercel/nft分析依赖,获取所有真正使用到的依赖,然后保留其中以node_modules/开头的文件,复制到指定的目录。

而这个脚本,才是今天要说的重点!

正确的精简依赖的方法

本人在 RSSHub 脚本的基础上又改了下, 使之可以适配更多的项目,做到开箱即用!具体参考:minify-docker.js

minify-docker.js放在项目根目录的 scripts 文件夹下,例如scripts/minify-docker.js

然后在 Dockerfile 中这样写。

# 阶段一:构建阶段
FROM caomeiyouren/alpine-nodejs:1.1.0 as builder

WORKDIR /home/app

COPY package.json .npmrc /home/app/

RUN pnpm i

COPY . /home/app

RUN pnpm run build

# 阶段二:缩小阶段
FROM caomeiyouren/alpine-nodejs:1.1.0 as docker-minifier

WORKDIR /home/app

RUN pnpm add @vercel/nft@0.24.4 fs-extra@11.2.0 --save-prod

COPY --from=builder /home/app /home/app

RUN export PROJECT_ROOT=/home/app/ && \
    node /home/app/scripts/minify-docker.js && \
    rm -rf /home/app/node_modules /home/app/scripts && \
    mv /home/app/app-minimal/node_modules /home/app/ && \
    rm -rf /home/app/app-minimal

# 阶段三:生产阶段
FROM caomeiyouren/alpine-nodejs:1.1.0

ENV NODE_ENV production

WORKDIR /home/app

COPY --from=docker-minifier /home/app /home/app

EXPOSE 3000

CMD ["pnpm","run", "start"]

此时你就能得到一个体积非常小的 Node.js 镜像!仅仅 106MB!,差不多是之前的四分之一!

image-20231211222830121

完整的项目请参考:docker-minimize 。可以自动动手试试!

总结

本文介绍了如何优化 Docker 下 Node.js 项目的体积。首先,通过分段构建和精简依赖的方法可以减小镜像体积。分段构建可以通过多个阶段构建来只保留生产环境所需的依赖,而精简依赖可以通过只下载生产环境依赖来减少体积。然而,仅使用npm i --production无法显著减小镜像体积,因为在 Node.js 生态中,依赖的体积是随项目对数增长的。为了解决这个问题,可以使用工具如@vercel/nft来分析真正使用到的依赖,并复制到指定目录,从而减小镜像体积。最终,通过正确的精简依赖的方法,可以得到一个体积更小的 Node.js 镜像。

【总结由 Chat LangChain 生成】

本文作者:草梅友仁
本文地址:https://blog.cmyr.ltd/archives/be640cee.html
版权声明:转载请注明出处!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,319评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,801评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,567评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,156评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,019评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,090评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,500评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,192评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,474评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,566评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,338评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,212评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,572评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,890评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,169评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,478评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,661评论 2 335

推荐阅读更多精彩内容