关于node.js:使用nodejs构建Docker-image最佳实践

14次阅读

共计 3225 个字符,预计需要花费 9 分钟才能阅读完成。

简介

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 directory
WORKDIR /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 directory
WORKDIR /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

# Example
REPOSITORY                      TAG        ID              CREATED
node                            12         1934b0b038d1    5 days ago
flydean/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 的博客

欢送关注我的公众号:「程序那些事」最艰深的解读,最粗浅的干货,最简洁的教程,泛滥你不晓得的小技巧等你来发现!

正文完
 0