众所周知,Node.js项目在部署的时候,无论是在虚拟机部署,还是使用docker
进行部署,无非都是要先npm install
,然后把整个node_modules
丢上去,最后启动服务,但是有些开发依赖在生产环境部署的时候是不需要的。如果能每次打包只打包生产依赖,那就极大的减少node_modules
大小,所以当时我在优化公司的nestjs项目时,苦苦寻找解决方案,就找到了这一篇文章,英文版原本在这里 www.tomray.dev/nestjs-dock…,这是一篇手把手的教程,教你如何在制作nestjs
镜像时,能够编写出一个优化生产依赖的Dockerfile
,有了这个Dockerfile
,无论是在本地开发环境,还是在容器环境都能很轻松完成部署,P.S 如果你想直接复制最终的Dockerfile
,请直接跳到文章末尾,每个镜像都可以视为一个单独的软件包,你可以通过编写Dockerfile
告诉docker
如何来打包镜像,让我们开始编写吧,首先,先创建一个空的文件,然后把我们的指令添加到Dockerfile
里面,并且注释每一步是干什么,同样的,创建.gitignore
文件,我们可以把那些不需要经过docker
打包的文件给忽略掉,把一下文件给排除忽略掉,如果你在本地安装了docker
,可以在本地进行打包测试,让我们来瞧瞧是否如预期中那样打包镜像,在命令行中执行以下命令,当然,你也可以把nest-app-demo
换成你想要的镜像名,需要注意的是,不要忘记后面的.
号!,接着你可以在你本机执行以下命令,查看是否已经成功打包了镜像,噢,感谢上帝,已经成功打包成镜像了,可以看到我们的命名nest-app-demo
就像只肥硕的土拨鼠静静的躺在镜像列表里面,紧接着让我们来把镜像给跑起来,映射到本机80
端口,如果端口被占用可以使用其他端口,这时候你就在浏览器中输入http://localhost
进行访问,可以看到容器正常启动。 如果你想删除那些正在运行的容器,可以使用以下命令进行删除,好了,现在我们对镜像包进行压缩了,因为可以看到,目前镜像大小是1.24G,噢,上帝,真是太大了!,让我们来看看之前编写的Dockerfile
,看如何对它进行优化,强烈推荐使用node:18-alpine
而不是node:18
,使用alpine
的镜像可以直接把镜像体积从1.24g减少到466MB!,很多依赖包会根据当前的NODE_ENV
环境变量而进行判断是否优化压缩,所以我们可以在Dockerfile
里面把环境变量加进去,设置为production
,顺便提一句,如果你不知道如何在Nestjs里面通过配置文件进行环境变量设置的话,可以看下这篇入门文章www.tomray.dev/nestjs-conf…,npm 比较推荐使用npm ci
而不是npm install
来打包镜像,至于原因可以点击这里查看docs.npmjs.com/cli/v8/comm…,正好符合我们现在的情况,所以我们要使用npm ci
来替换npm install
,默认情况下,Dockerfile
会使用root
权限来构建你的镜像,这会存在一定的安全风险,在这里,我们已经拥有一个叫node
的用户,我们可以直接使用它,当你在使用COPY
指令时,添加标志以确保用户能够拥有正确的权限也是一种好做法,比如可以使用--chown=node:node
,在Dockerfile
中,你可以定义多阶段构建,这是一种通过多个镜像构建出最优镜像的方式,可以使得最后生成的镜像最小化,上面是多阶段构建的3个阶段:,如果你不需要在本地环境使用docker
启动你的Nestjs应用,可以把前两个阶段合二为一,上述多阶段设置的好处在于,这样你就有了一个可以在本地开发中使用的Dockerfile
(与docker-compose
组合在一起)。同时创建一个用于生产的优化Docker
镜像。,如果你对使用Docker Compose
的多阶段Dockerfile
进行本地开发(热加载)有兴趣,可以点击看这篇文章www.tomray.dev/nestjs-dock…,通过上述使用的方案进行优化后,最终的Dockerfile
如下,他可以帮助我们构建出最优的镜像,可以看到,最后打包的镜像只有189MB大小