简介

docker 容器的出现，彻底的改变了应用程序的运行方式，而 nodejs 同样的也颠覆了后端应用程序的开发模式。两者结合起来，就会产生意想不到的作用。

本文将会以一个常用的 nodejs 程序为例，分析怎么使用 docker 来构建 nodejs image.

准备 nodejs 应用程序

一个标准的 nodejs 程序，需要一个 package.json 文件来描述应用程序的元数据和依赖关系，然后通过 npm install 来安装应用的依赖关系，最后通过 node app.js 来运行程序。

本文将会创建一个简单的 koa 应用程序，来说明 docker 的使用。

首先创建 package.json 文件：

{  "name": "koa-docker",  "description": "怎么将nodejs koa程序打包成docker应用",  "version": "0.0.1",  "dependencies": {    "ejs": "^2.5.6",    "fs-promise": "^2.0.3",    "koa": "^2.2.0",    "koa-basic-auth": "^2.0.0",    "koa-body": "^4.0.8",    "koa-compose": "^4.0.0",    "koa-csrf": "^3.0.6",    "koa-logger": "^3.0.0",    "@koa/router": "^8.0.5",    "koa-session": "^5.0.0",    "koa-static": "^3.0.0",    "koa-views": "^6.0.2"  },  "scripts": {    "test": "NODE_ENV=test mocha --harmony --reporter spec --require should */test.js",    "lint": "eslint ."  },  "engines": {    "node": ">= 7.6"  },  "license": "MIT"}

上面的 package.json 文件制定了项目的依赖。

接下来，我们需要使用 npm install 来安装项目的依赖，安装好的项目依赖文件将会放在本地的 node_modules 文件夹中。

然后我们就可以编写服务程序了：

const Koa = require('koa');const app = module.exports = new Koa();
app.use(async function(ctx) {  ctx.body = 'Hello www.flydean.com';});
if (!module.parent) app.listen(3000);

上面是一个非常简单的 koa 服务端程序，监听在 3000 端口，并且对每次请求都会返回‘Hello www.flydean.com’。

运行 node app.js 我们就可以开启 web 服务了。

好了，我们的服务程序搭建完毕，接下来，我们看一下 docker 打包 nodejs 程序的最佳实践。

创建 Dockerfile 文件

为了创建 docker image，我们需要一个 Dockerfile 文件，作为该 image 的描述。

我们一步一步的讲解，如何创建这个 Dockerfile 文件。

1. 引入 base image。

为了运行 docker 程序，我们需要指定一个基本的 image，比如操作系统，node 为我们提供了一个封装好的 image，我们可以直接引用：

FROM node:12

我们指定了 node 的 12 版本，这个版本已经安装好了最新的 LTS node 12，使用这个 image 我们就可以不需要自己来安装 node 的相关环境，非常的方便。

1. 指定工作目录

有了 image，接下来就需要我们指定 docker 中的工作目录：

# Create app directoryWORKDIR /data/app

1. 安装 node_modules

接下来我们需要将 package*.json 文件拷贝进 image 中，并且运行 npm install 来安装依赖库：

COPY package*.json ./
RUN npm install

上面我们拷贝的是 package*.json，因为如果我们本地运行过 npm install 命令的话，将会生成一个 pacakge-lock.json 文件。这个文件是为了统一依赖包版本用的。我们需要一并拷贝。

拷贝完之后就可以运行 npm install 来安装依赖包了。

问题？为什么我们只拷贝了 pacakge.json,而不是拷贝整个工作目录呢？

回答：docker file 中的每一个命令，都会导致创建一个新的 layer，上面的 docker file 中，只要 pakage.json 没有被修改，新创建的 docker image 其实是可以共享 layer 缓存的。

但是如果我们直接添加本地的工作目录，那么只要我们的工作目录有文件被修改，会导致整个 docker image 重新构建。所以为了提升构建效率和速度，我们只拷贝 package.json。

1. 拷贝应用程序并运行

最后的工作就是拷贝应用程序 app.js 然后运行了：

# 拷贝应用程序COPY app.js .
# 暴露端口EXPOSE 8080
# 运行命令CMD [ "node", "app.js" ]

最后，我们的 dockerfile 文件应该是这样的：

FROM node:12
# Create app directoryWORKDIR /data/app
COPY package*.json ./
RUN npm install
# 拷贝应用程序COPY app.js .
# 暴露端口EXPOSE 8080
# 运行命令CMD [ "node", "app.js" ]

创建.dockerignore 文件

我们知道 git 会有一个.gitignore 文件，同样的 docker 也有一个.dockerignore 文件，这个文件的作用就是避免你的本地文件被拷贝到 docker image 中。

node_modules

比如我们可以在其中指定 node_modules，使其不会被拷贝。

创建 docker image

创建 docker image 很简单，我们可以使用下面的命令：

docker build -t flydean/koa-web-app .

创建完毕之后，我们可以使用 docker images 来查看刚刚创建好的 image :

docker images
# ExampleREPOSITORY                      TAG        ID              CREATEDnode                            12         1934b0b038d1    5 days agoflydean/koa-web-app             latest     d64d3505b0d2    1 minute ago

运行 docker 程序

最后，我们可以通过 docker run 命令来运行应用程序

docker run -p 54321:8080 -d flydean/koa-web-app

然后我们就可以通过本地的 54321 端口来访问应用程序了。

node 的 docker image 需要注意的事项

这里我们来探讨一下创建 docker image 需要注意的事项。

1. 不要使用 root 用户来运行应用程序

默认情况下，docker 中的应用程序会以 root 用户来运行，为了安全起见，建议大家以普通用户来运行应用程序，我们可以在 docker file 中指定：

FROM node:12...# 在最后，以node用户来运行应用程序USER node

或者我们在运行的时候以 -u “node” 作为启动参数来指定运行的用户。

docker run \  -u "node"  flydean/koa-web-app 

1. 指定运行时候的 NODE_ENV

node 的应用程序很多时候需要依赖于 NODE_ENV 来指定运行时环境，我们可以以参数的形式传递给 docker run 命令：

docker run \-e "NODE_ENV=production"  flydean/koa-web-app 

本文作者：flydean 程序那些事

本文链接：http://www.flydean.com/nodejs-docker-best-practices/

本文来源：flydean 的博客

欢迎关注我的公众号:「程序那些事」最通俗的解读，最深刻的干货，最简洁的教程，众多你不知道的小技巧等你来发现！