第2章基础设施即服务（IaaS）-3-Docker Compose

最新推荐文章于 2024-08-22 11:45:22 发布

ClearloveMe

最新推荐文章于 2024-08-22 11:45:22 发布

阅读量165

点赞数

分类专栏： Java微服务架构文章标签： docker 运维容器 Powered by 金山文档

原文链接：www.funtl.com

版权

Java微服务架构专栏收录该内容

9 篇文章 0 订阅

订阅专栏

什么是Docker Compose

Docker Compose 是Docker官方编排（Orchestration）项目之一，负责快速的部署分布式应用。

Docker Compose简介

Compose项目是Docker官方的开源项目，负责实现对Docker容器集群的快速编排。从功能上看，跟OpenStack 中的Heat 十分类似。

其代码目前在https: //github.com/docker/compose上开源。

Compose定位是「定义和运行多个Docker容器的应用( Defining and running multi-container Docker applications)」，其前身是开源项目Fig。

通过第一部分中的介绍 ,我们知道使用一个Dockerfile 模板文件，可以让用户很方便的定义一个单独的应用容器。然而，在日常工作中，经常会碰到需要多个容器相互配合来完成某项任务的情况。例如要实现一一个Web项目，除了Web服务容器本身，往往还需要再加上后端的数据库服务容器，甚至还包括负载均衡容器等。

Compose恰好满足了这样的需求。它允许用户通过一个单独的docker-compose.yml模板文件( YAML格式)来定义一组相关联的应用容器为一个项目( project)。

Compose中有两个重要的概念:

服务(service): 一个应用的容器，实际上可以包括若干运行相同镜像的容器实例。

项目(project): 由一组关联的应用容器组成的一个完整业务单元，在docker-compose .yml文件中定义。

Compose的默认管理对象是项目，通过子命令对项目中的一组容器进行便捷地生命周期管理。

Compose项目由Python编写，实现上调用了Docker服务提供的API来对容器进行管理。因此,只要所操作的平台支持Docker API，就可以在其上利用Compose来进行编排管理。

Docker Compose安装与卸载

Compose支持Linux、macOS、 Windows 10三大平台。

Compose可以通过Python的包管理工具pip 进行安装，也可以直接下载编译好的进制文件使用，甚至能够直接在Docker容器中运行。

前两种方式是传统方式，适合本地环境下安装使用;最后一种方式则不破坏系统环境，更适合云计算场景。

Docker for Mac、Docker for Windows 自带docker-compose二进制文件,安装Docker之后可以直接使用。

$ docker-compose --version
docker-compose version 1.17.1, build 6d101fb

Linux系统请使用以下介绍的方法安装。

二进制包

在Linux上的也安装十分简单，从官方GitHub Release处直接下载编译好的二进制文件即可。

例如，在Linux 64位系统上直接下载对应的二进制包。

$ sudo curl -L https://github.com/docker/compose/releases/down1oad/1.17.1/docker-compose-'uname -s'-'uname -m' > /usr/1ocal/bin/docker-compose
$ sudo chmod +x /usr/1ocal/bin/docker-compose

PIP安装

注: x86_64架构的Linux建议按照上边的方法下载二进制包进行安装,如果您计算机的架构是ARM (例如，树莓派)，再使用pip 安装。

这种方式是将Compose当作一个Python应用来从pip源中安装。

执行安装命令:

$ sudo pip install -U docker-compose

可以看到类似如下输出，说明安装成功。

Collecting docker-compose
 Downloading docker-compose-1.17.1.tar.gz (149kB): 149kB downloaded
...
Successfully installed docker-compose cached-property requests texttable websocket-client docker-py dockerpty six enum34 backports.ssl -match-hostname ipad
dress

bash补全命令

$ curl -L https://raw.githubusercontent.com/docker/compose/1.8.0/contrib/completion/bash/docker-compose > /etc/bash_completion.d/docker-compose

容器内执行

Compose既然是一个Python应用，自然也可以直接用容器来执行它。

$ curl -L https://github.com/docker/compose/releases/download/1.8.0/run.sh > /usr/1oca1/bin/docker-compose
$ chmod +x /usr/local/bin/ docker-compose

实际上，查看下载的run.sh 脚本内容，如下

set -e

VERSION="1.8.0"
IMAGE="docker/compose:$VERSION"

# Setup options for connecting to docker host
if [ -Z "$DOCKER_ HOST" ]; then
    DOCKER HOST="/var/run/docker.sock"
fi
if [ -S“$DOCKER_ _HOST" ]; then
    DOCKER_ADDR="-v $DOCKER_HOST:$DOCKER_HOST -e DOCKER_HOST"
else
    DOCKER_ADDR="-e DOCKER_HOST -e DOCKER_TLS_VERIFY -e DOCKER_CERT PATH"
fi

# Setup volume mounts for compose config and context
if [“$(pwd)”!= '/' ]; then
    VOLUMES="-V $(pwd):$(pwd)"
fi
if [ -n "$COMPOSE_FILE” ]; then
    compose_dir=$(dirname $COMPOSE_FILE)
fi
# TODO: also check --file argument
if [ -n "$compose_dir" ]; then
    VOLUMES= "$VOLUMES -V $compose_dir:$compose_dir"
fi
if [ -n“$HOME" ]; then
    VOLUMES= "$VOLUMES -v $HOME:$HOME -V $HOME:/root" # mount $HOME in /root to share docker.config
fi

# Only allocate tty if we detect one
if [ -t 1]; then
    DOCKER_RUN_OPTIONS="-t"
fi
if[ -t 0 ];then
    DOCKER_RUN_OPTIONS= "$DOCKER RUN_OPTIONS -1”
fi
exec docker run --rm $DOCKER_RUN_OPTIONS $DOCKER_ADDR $COMPOSE_OPTIONS $VOLUMES -W "$(pwd)” $IMAGE “$@”

可以看到，它其实是下载了docker/compose镜像并运行。

卸载

如果是二进制包方式安装的,删除二进制文件即可。

$ sudo rm /usr/1ocal/bin/ docker-compose

如果是通过pip 安装的，则执行如下命令即可删除。

$ sudo pip uninstall docker-compose

Docker Compose使用

术语

首先介绍几个术语。

服务(service):一个应用容器,实际上可以运行多个相同镜像的实例。

项目(project): 由一组关联的应用容器组成的一个完整业务单元。

可见，一个项目可以由多个服务(容器)关联而成，Compose 面向项目进行管理。

场景

最常见的项目是web网站，该项目应该包含web应用和缓存。

下面我们用Python 来建立一个能够记录页面访问次数的 web网站。

web应用

新建文件夹，在该目录中编写app.py 文件

from flask import Flask
from redis import Redis

app = Flask(_name_)
redis = Redis(host='redis', port=6379)

@app.route('/')
def hello():
    count = redis.incr('hits')
    return 'Hello World!该页面已被访问{}次。\n'.format(count)
if _name__ == "_ main_ ":
    app.run(host="0.0.0.0", debug=True)

Dockerfile

编写Dockerfile文件，内容为

FROM python:3.6-alpine
ADD . /code
RUN pip install redis flask
CMD ["python","app.py"]

docker-compose.yml

编写docker-compose.yml文件，这个是Compose使用的主模板文件。

version:'3'
service:
 web:
    build:.
    ports:
    - "5000:5000"

 redis:
    image:"redis:alpine"

运行compose项目

$ docker-compose up

此时访问本地5000端口，每次刷新页面，计数就会加1.

Docker Compose命令说明

命令对象与格式

对于Compose来说，大部分命令的对象既可以是项目本身，也可以指定为项目中的服务或者容器。如果没有特别的说明，命令对象将是项目，这意味着项目中所有的服务都会受到命令影响。

执行docker -compose [COMAND] --help 或者docker-compose help [COMMAND] 可以查看具体某个命令的使用格式。

docker-compose命令的基本的使用格式是

docker-compose [-f=<arg>...] [options] [COMMAND] [ARGS...]

命令选项

-f，--file FILE指定使用的Compose模板文件，默认为docker-compose.yml，可以多次指定。

-p，--project-name NAME指定项目名称，默认将使用所在目录名称作为项目名。

--x-networking使用Docker的拔插网络后端特性。

--x-network-driver DRIVER指定网络后端的驱动，默认为bridge。

--verbose输出更多调试信息。

-v，--version打印版本并退出。

命令使用说明

build

格式为docker-compose build [options] [SERVICE...]。

构建（重新构建）项目中的服务容器。

服务容器一旦构建后，将会带上一个标记名，例如对于web项目中的一个db容器，可能试web db。

可以随时在项目目录下运行docker-compose build来重新构建服务。

选项包括：

--force-rm删除构建过程中的临时容器。

--no-cache 构建镜像过程中不适用cache（这将加长构建过程）。

--pull 始终尝试通过pull来获取更新版本的镜像。

config

验证Compose文件格式是否正确，若正确则显示配置，若格式错误显示错误原因。

down

此命令将会停止up命令所启动的容器，并移除网络。

exec

进入指定容器。

help

获得一个命令的帮助。

images

列出Compose文件中包含的镜像。

kill

格式为docker-compose kill [options] [SERVICE...]。

通过发送SIGKILL信号来强制停止服务容器。

支持通过-s参数来指定发送的信号，例如通过如下指令发送SIGINT信号。

$ docker-compose kill -s SIGINT

logs

格式为docker-compose logs [options] [SERVICE...]。

查看服务容器的输出。默认情况下，docker-compose将对不同的服务输出使用不同的颜色来区分。可以通过--no-color来关闭颜色。

该命令在调试问题的时候十分有用。

pause

格式为docker-compose pause [SERVICE...]。

暂停一个服务容器。

port

格式为docker-compose port [options] SERVICE PRIVATE_PORT。

打印某个容器端口所映射的公共端口。

选项：

--protocol=proto 指定端口协议，tcp（默认值）或者udp。

--index=index 如果同一服务存在多个容器，指定命令对象容器的序号（默认为1）。

ps

格式为docker-compose ps [options] [SERVICE...]。

列出项目中目前的所有容器。

选项：

-q 只打印容器的ID信息。

pull

格式为docker-compose pull [options] [SERVICE...]。

拉取服务依赖的镜像。

选项：

--ignore-pull-failures 忽略拉取镜像过程中的错误。

push

推送服务依赖的镜像到Docker镜像仓库。

restart

格式为docker-compose restart [options] [SERVICE...]。

重启项目中的服务。

选项：

-t，--timeout TIMEOUT 指定重启前停止容器的超时（默认为10秒）。

rm

格式为docker-compose rm [options] [SERVICE...]。

删除所有（停止状态的）服务容器。推荐先执行docker-compose stop命令来停止容器。

选项：

Docker Compose模板文件

模板文件是使用Compose的核心，涉及到的指令关键字也比较多。但大家不用担心，这里面大部分指令跟docker run相关参数的含义都是类似的。

默认的模板文件名称为docker-compose.yml，格式为YAML格式。

version: "3"

services:
 webapp: 
  image: examples/web
  ports:
   -"80: 80"
  volumes:
   - "/data"

注意每个服务都必须通过image 指令指定镜像或build指令(需要Dockerfile )等来自动构建生成镜像。

如果使用build 指令，在Dockerfile中设置的选项(例如: CMD, EXPOSE，VOLUME, ENV等)将会自动被获取，无需在docker-compose.yml中再次设置。

下面分别介绍各个指令的用法。

build

指定Dockerfile所在文件夹的路径(可以是绝对路径，或者相对docker-compose.yml文件的路径)。Compose 将会利用它自动构建这个镜像，然后使用这个镜像。

version: '3'
services:

 webapp: 
  build: ./dir

你也可以使用context 指令指定Dockerfile 所在文件夹的路径。

使用dockerfile 指令指定Dockerfile 文件名。

使用arg指令指定构建镜像时的变量。

version:‘3'
services:

 webapp:
  build:
   context: ./dir
   dockerfile: Dockerfile-alternate
   args:
    buildno: 1

使用cache_from指定构建镜像的缓存

cap_add,cap_frop

指定容器的内核能力（capacity）分配。

例如，让容器拥有所有能力可以指定为：

cap_add:
 - ALL

去掉NET_ADMIN能力可以指定为：

cap_drop:
 - NET_ADMIN

command

覆盖容器启动后默认执行的命令。

command:echo "hello world"

configs

仅用于Swarm mode

cgroup_parent

指定父cgroup组，意味着将继承该组的资源限制。

例如，创建了一个cgroup组名称为cgroups_1。

cgroup_parent:cgroups_1

container_name

指定容器名称。默认将会使用项目名称_服务名称_序号这样的格式。

container_name:docker-web-container

注意：指定容器名称后，该服务将无法进行扩展（scale），因为Docker不允许多个容器具有相同的名称。

deploy

仅用于Swarm mode

devices

指定设备映射关系。

devices:
 - "/dev/ttyUSB1:/dec/ttyUSB0"

depengs_on

解决容器的依赖、启动先后的问题。以下例子中会先启动redis db再启动web

version:'3'

sevices:
 web:
  build:.
  depends_on:
   - db
   - redis

 redis:
  image:redis

 db:
  image:postgres

注意：web服务不会等待redis db [完全启动]之后才会启动。

dns

自定义DNS服务器。可以是一个值，也可以是一个列表。

dns:8.8.8.8

dns:
 - 8.8.8.8
 - 114.114.114.114

dns_search

配置DNS搜索域。可以是一个值，也可以是一个列表。

dns_search:example.com

dns_search:
 - domain1.example.com
 - domain2.example.com

tmpfs

挂载一个tmpfs文件系统到容器。

tmpfs:/run
tmpfs:
 - /run
 - /tmp

env_file

从文件中获取环境变量，可以为单独的文件路径或列表。

如果通过docker-compose -f FILE 方式来指定Compose模板文件，则env_file中变量的路径会基于模板文件路径。

如果有变量名称与enviroment指令冲突，则按照惯例，以后者为准。

env_file: .env

env_file:
 - ./common.env
 - ./apps/web.env
 - /opt/secrets.env

环境变量文件中每一行必须符合格式，支持#开头的注释行。

# common.env: Set development environment
PROG_ENV=development

environment

设置环境变量。你可以使用数组或字典两种格式。

只给定名称的变量会自动获取运行Compose主机上对应变量的值，可以用来防止泄露不必要的数据。

environment:
 RACK_ENV：development
 SESSION_SECRET:

environment:
 - RACK_ENV=development
 - SESSION_SECRET

如果变量名称或者值中用到true|false，yes|no等表达布尔含义的词汇，最好放到引号里，避免YAML自动解析某些内容为对应的布尔语义。这些特定词汇，包括

y|Y|yes|Yes|YES|n|N|no|No|NO|true|True|TRUE|false|False|on|On|ON|off|Off|OFF

expose

暴露端口，但不映射到宿主机，只被连接的服务访问。

仅可以指定内部端口为参数

expose:
 - "3000"
 - "8000"

external_links

注意：不建议使用该指令。

连接到dcoker-compose.yml外部的容器，甚至并非Compose管理的外部容器。

external_links:
 - redis_1
 - project_db_1:mysql
 - project_db_1:postgresql

extra_hosts

类似Docker中的--add-host参数，指定额外的host名称映射信息。

extra_hosts:
 - "googledns:8.8.8.8"
 - "dockerhub:52.1.157.61"

会在启动后的服务容器中 /etc/hosts 文件中添加如下两条条目。

8.8.8.8 googledns
52.1.157.61 dockerhub

healthcheck

通过命令检查容器是否健康运行。

healthcheck:
 test: ["CMD","curl","-f","http:localhost"]
 interval: 1m30s
 timeout: 10s
 retries: 3

image

指定为镜像名称或镜像ID。如果镜像在本地不存在，Compose将会尝试拉取这个镜像。

image:ubuntu
image:orchardup/postgresql
image:a4bc65fd

labels

为容器添加Docker元数据（metadata）信息。例如可以为容器添加辅助说明信息。

labels:
 com.startupteam.description: "webapp for a startup team"
 com.startupteam.department: "devops department"
 com.startupteam.release: "rc3 for v1.0
"

links

注意：不推荐使用该指令。

logging

配置日志选项。

logging:
 driver:syslog
 options:
  syslog-address: "tcp://192.168.0.42:123"

目前支持三种日志驱动类型。

driver: "json-file"
driver: "syslog"
driver: "none"

options配置日志驱动的相关参数。

options:
 max-size: "200k"
 max-file: "10"

network_mode

设置网络模式。使用和docker run的--network参数一样的值。

network_ mode: "bridge"
network_ mode: "host"
network_ mode: "none"
network_ mode: "service:[service name]”
network_ mode: ”container : [container name/id]"

networks

配置容器连接的网络。

version: "3"
services:

  some-service:
    networks:
      - some-network
      - other-network
networks:
  some-network:
  other-network:

pid

跟主机系统共享进程命名空间。打开该选项的容器之间，以及容器和宿主机系统之间可以通过进程ID来相互访问和操作。

pid: "host"

ports

暴露端口信息。

使用宿主端口：容器端口（HOST:CONTAINER）格式，或者仅仅指定容器的端口（宿主将会随机选择端口）都可以。

ports:
  - "3000"
  - "8000:8000"
  - "49100:22"
  - "127.0.0.1:8001:8001"

注意：当使用HOST:CONTAINER格式来映射端口时，如果你是用的容器端口小于60并且没放到引号里，可能会得到错误结果，因为YAML会自动解析xx:yy这种数字格式为60进制。为避免出现这种问题，建议数字串都采用引号包括起来的字符串格式。

secrets

存储敏感数据，例如mysql 服务密码。

version: "3.1"
services:

mysql:
  image: mysql
  environment:
    MYSQL_ROOT_PASSWORD_FILE: /run/secrets/db_root_password
  secrets:
    - db_root_password
    - my_other_secret
secrets:
  my_secret:
    file: ./my_secret.txt
  my_other_secret:
    external: true

security_opt

指定容器模板标签（label）机制的默认属性（用户、角色、类型、级别等）。例如配置标签的用户名和角色名。

security_opt: 
  - label:user:UsER
  - label:role:ROLE

stop_signal

设置另一个信号来停止容器。在默认情况下使用的是SIGTERM停止容器。

stop_signal: SIGUSR1

sysctls

配置容器内核参数。

sysctls:
  net.core.somaxconn: 1024
  net.ipv4.tcp_syncookies: 0

sysctls:
  - net.core.somaxconn=1024
  - net.ipv4.tcp_syncookies=0

ulimits

指定容器的ulimits限制值。

例如，指定最大进程数为65535，指定文件句柄数为20000 (软限制，应用可以随时修改，不能超过硬限制)和40000 (系统硬限制，只能root用户提高)。

ulimits:
  nproc: 65535
  nofile:
    soft: 20000
    hard: 40000

volumes

数据卷所挂载路径设置。可以设置宿主机路径( HOST:CONTAINER )或加上访问模式( HOST:CONTAINER:ro )。

该指令中路径支持相对路径。

volumes: 
  - /var/lib/mysql
  - cache/:/tmp/cache
  - ~/ configs:/etc/configs/:ro

其他指令

此外，还有包括domainname, entrypoint, hostname, ipc, mac_address, privileged, read_only, shm_size, restart, stdin_open, tty, user, working_dir等指令，基本跟docker run 中对应参数的功能一致。

指定服务容器启动后执行的入口文件。

entrypoint: /code/ entrypoint.sh

指定容器中运行应用的用户名。

user:nginx

指定容器中工作目录。

working_dir: /code

Docker Compose实战Tomcat

version: '3'
service:
  web:
    restart: always
    image: tomcat
    container_name: web
    ports:
      - 8080:8080
    volumes:
      - /usr/local/docker/myshop/ROOT:/usr/local/tomcat/webapps/ROOT

mysql:
  restart:always
  image: mysql:5.7.22
  container_name: mysql
  ports:
    - 3306:3306
  environment:
    TZ:Asia/Shanghai
    MYSQL_ROOT_PASSWORD: 123456
  command:
    --character-set-server=utf8mb4
    --collation-server=utf8mb4_general_ci
    --explicit_defaults_for_timestamp=true
    --lower_case_table_names=1
    --max_allowed_packet=128M
    --sql-mode="STRICT_TRANS_TABLES,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE,ERROR_FOR_DIVISION_BY_ZERO"
  volumes:
    - mysql-data:/var/lib/mysql

volumes:
  mysql-data:

Docker Compose实战MySQL

Docker Compose常用命令

YAML配置文件语言

简介

YAML是专门用来写配置文件的语言，非常简洁和强大，远比JSON格式方便。

YAML语言的设计目标，就是方便人类读写。它实质上是一种通用的数据串行化格式。它的基本语法规则如下:

大小写敏感

使用缩进表示层级关系

缩进时不允许使用Tab键，只允许使用空格。

缩进的空格数目不重要，只要相同层级的元素左侧对齐即可

# 表示注释，从这个字符一直到行尾，都会被解析器忽略。

YAML支持的数据结构有三种:

对象:键值对的集合，又称为映射( mapping) /哈希( hashes) /字典( dictionary )

数组:一组按次序排列的值，又称为序列( sequence) /列表(list )

纯量(scalars) :单个的、不可再分的值

对象

对象的一组键值对，使用冒号结构表示

animal:pets

数组

一组连词线开头的行，构成一个数组

- Cat
- Dog
- Goldfish

复合结构

对象和数组可以结合使用，形成复合结构

languages:
  - Ruby
  - Perl
  - Python
websites:
  YAML: yaml.org
  Ruby: ruby-lang.org
  Python: python.org
  Perl: use.perl.org

纯量

纯量是最基本的、不可再分的值。以下数据类型都属于JavaScript的纯量

字符串

布尔值

整数

浮点数

Null

时间

日期

附：为什么说JSON不适合做配置文件？

很多项目使用JSON作为配置文件，最明显的例子就是npm和yarn使用的package.json文件。当然,还有很多其他文件，例如CloudFormation (最初只有JSON，但现在也支持YAML )和composer (PHP )。

但是，JSON实际上是一种非常糟糕的配置语言。别误会我的意思，我其实是喜欢JSON的。它是一种相对灵活的文本格式，对于机器和人类来说都很容易阅读，而且是一种非常好的数据交换和存储格式。但作为一种配置语言，它有它的不足。

为什么流行使用JSON作为配置语言?

将JSON用作配置文件有几个方面的原因，其中最大的原因可能是它很容易实现。很多编程语言的标准库都支持JSON，开发人员或用户可能已经很熟悉JSON，所以不需要学习新的配置格式就可以使用那些产品。现在几乎所有的工具都提供JSON支持，包括语法突出显示、自动格式化、验证工具等。

这些都是很好的理由，但这种无处不在的格式其实不适合用作配置。

JSON的问题

缺乏注释

注释对于配置语言而言绝对是一个重要的功能。注释可用于标注不同的配置选项、解释为什么要配置成特定的值,更重要的是，在使用不同的配置进行测试和调试时需要临时注释掉部分配置。当然,如果只是把JSON当作是一种数据交换格式，那么就不需要用到注释。

我们可以通过一些方法给JSON添加注释。一种常见的方法是在对象中使用特殊的键作为注释，例如“//"或“__ comment"。但是，这种语法的可读性不高，并且为了在单个对象中包含多个注释，需要为每个注释使用唯一的键。 David Crockford ( JSON的发明者)建议使用预处理器来删除注释。如果你的应用程序需要使用JSON作为配置，那么完全没问题，不过这确实带来了一些额外的工作量。

一些 JSON库允许将注释作为输入。例如，Ruby的JSON模块和启用了JsonParser.Feature.ALLOW_ COMMENTS功能的Java Jackson库可以处理JavaScript风格的注释。但是,这不是标准的方式,而且很多编辑器无法正确处理JSON文件中的注释，这让编辑它们变得更加困难。

过于严格

JSON规范非常严格，这也是为什么实现JSON解析器会这么简单，但在我看来，它还会影响可读性，并且在较小程度上会影响可写性。

低信噪比

与其他配置语言相比，JSON显得非常嘈杂。JSON 的很多标点符号对可读性毫无帮助，况且，对象中的键几乎都是标识符,所以键的引号其实是多余的。

此外，JSON需要使用花括号将整个文档包围起来，所以JSON是JavaScript 的子集，并在流中发送多个对象时用于界定不同的对象。但是,对于配置文件来说，最外面的大括号其实没有任何用处。在配置文件中，键值对之间的逗号也是没有必要的。通常情况下，每行只有一个键值对，所以使用换行作为分隔符更有意义。

说到逗号，JSON居然不允许在结尾出现逗号。如果你需要在每个键值对之后使用逗号，那么至少应该接受结尾的逗号，因为有了结尾的逗号，在添加新条目时会更容易，而且在进行commit diff时也更清晰。

长字符串

JSON作为配置格式的另一个问题是，它不支持多行字符串。如果你想在字符串中换行,必须使用“\n”进行转义，更糟糕的是，如果你想要一个字符串在文件中另起一行显示，那就彻底没办法了。如果你的配置项里没有很长的字符串，那就不是问题。但是，如果你的配置项里包括了长字符串，例如项目描述或GPG密钥，你可能不希望只是使用“\n”来转义而不是使用真实的换行符。

数字

此外，在某些情况下，JSON对数字的定义可能会有问题。JSON 规范中将数字定义成使用十进制表示的任意精度有限浮点数。对于大多数应用程序来说，这没有问题。但是，如果你需要使用十六进制表示法或表示无穷大或NaN等值时,那么TOML或YAML将能够更好地处理它们。

{
  name": "example",

  "description": "A really long description that needs multiple lines.\nThis is a sample project to illustrate why ISON is not a good configuration forma
t. This description is pretty long, but it doesn't have any way to go onto multiple lines.",
  "version": "0.0.1",
  "main": "index.js" ,
  "//": "This is as close to a coment as you are going to get"，
  "keywords": ["example", "config"],
  "scripts": {
  "test": "./test.sh",
  "do_ stuff": "./do_stuff.sh"
  },
  "bugs": {
    "url": "https://example.com/bugs"
  },
  "contributors": [{
    "name" :
    "email": "johndoe@example.com"
  }，{
    "name": "Ivy Lane",
    "url": "https://example.com/ivylane"
  }]，
  "dependencies": {
    "dep1":“^1.0.0"，
    "dep2": "3.40",
    "dep3": "6.7"
  }
}

JSON的替代方案

选择哪一种配置语言取决于你的应用程序。每种语言都有各自的优缺点，下面列出了一些可以考虑的选项。它们都是为配置而设计的语言，每一种都比JSON这样的数据语言更好。

name ="example"
description ="""

A really long description that needs multiple lines.
This is a sample project to illustrate why JSON is not a \
good configuration format. This description is pretty long, \
but it doesn't have any way to go onto multiple lines.""

version = "0.0.1"
main = "index.js"
# This is a comment
keywords = ["example", "config"]

[bugs]
url = "https://example.com/bugs"

[scripts]
test = "./test.sh'
do_stuff = "./do_stuff.sh"

[[contributors]]
name = "John Doe"
email = "johndow@example.com'

[[contributors]]
name = "Ivy Lane""
url = "https ://example.com/ivylane"

[dependencies]
dep1 =“^1.0.0" 
# Why we depend on dep2
dep2 = "3.40"
dep3 = "6.7"

HJSON

HJSON是一种基于JSON的格式，但具有更大的灵活性，可读性也更强。它支持注释、多行字符串、不带引号的键和字符串，以及可选的逗号。如果你想要JSON结构的简单性，同时对配置文件更好，那么可以考虑HJSON。有一些可以将HJSON转换为JSON的命令行工具，如果你使用的工具是基于JSON的，可以先用HISON编写配置，然后再转换成JSON。JSON5 是另一个与HJSON非常相似的配置语言。

{
  name: example
  description:''
  A really long description that needs multiple lines.
  This is a sample project to illustrate why ISON is
  not a good configuration format. This description
  is pretty long, but it doesn't have any way to go
  onto multiple lines. 
  ...

  version: 0.0.1
  main: index.js
  # This is a a comment
  keywords: ["example", "config” ]
  scripts: {
    test: ./test.sh
    do_stuff: ./do_stuff.sh
  }
  bugs:{
    url: https://example.com/bugs
  }
  contributors: [{
    name: John Doe
    email: johndoe@example.com
  }{
  name: Ivy Lane
  url: https://example.com/ivylane
  }]
  dependencies: {
  dep1: ^1.0.0
  # Why we have this dependency
  dep2: "3.40”
  dep3:“6.7"
  }
}

HOCON

HOCON是为Play框架设计的配置格式，在Scala项目中非常流行。它是JSON的超集，因此可以使用现有的JSON文件。除了注释、可选逗号和多行字符串这些标准特性外，HOCON还支持从其他文件导入和引用其他值的键，避免重复代码，并使用以点作为分隔符的键来指定值的路径，因此用户可以不必将所有值直接放在花括号对象中。

name = example
description =”””
A really long description that needs multiple lines.

This is a sample project to illustrate why JSON is
not a good configuration format. This description 
is pretty long, but it doesn't have any way to go
onto multiple lines.
"""

version = 0.0.1
main = index.js
# This is a a comment
keywords = ["example", "config"]
scripts {
  test = ./test.sh
  do_stuff = ./do_stuff.sh
}
bugs.url = "https://example .com/bugs
contributors =[
  {
    name = John Doe
    email = johndoe@example.com
  }
  {
    name = Ivy Lane
    ur1 = "https ://example. com/ivylane"
  }
]
dependencies {
  dep1 = ^1.0.0
  # Why we have this dependency
  dep2 =“3.40"
  dep3 = "6.7"
}

YAML

YAMI( YAML不是标记语言)是一种非常灵活的格式,几乎是JSON的超集，已经被用在一些著名的项目中，如Travis CI、Circle CI和AWS CloudFormation。YAML的库几乎和JSON 一样无处不在。除了支持注释、换行符分隔、多行字符串、裸字符串和更灵活的类型系统之外, YAML也支持引用文件，以避免重复代码。

YAML的主要缺点是规范非常复杂,不同的实现之间可能存在不一致的情况。它将缩进视为严格语法的一部分(类似于Python)，有些人喜欢，有些人不喜欢。

这会让复制和粘贴变得很麻烦。

脚本语言

如果你的应用程序是使用Python或Ruby等脚本语言开发的，并且你知道配置的来源是可靠的，那么最好的选择可能就是使用这些语言进行配置。如果你需要一个真正灵活的配置选项，也可以在编译语言中嵌入诸如Lua之类的脚本语言。这样可以获得脚本语言的灵活性，而且比使用不同的配置语言更容易实现。使用脚本语言的缺点是它可能过于强大，当然，如果配置来源是不受信任的，可能会引入严重的安全问题。

自定义配置格式

如果由于某种原因，键值配置格式不能满足你的要求，并且由于性能或大小限制而无法使用脚本语言，那么可以考虑自定义配置格式。如果是这种情况，那么在做出选择之前要想清楚，因为你不仅要编写和维护一个解析器，还要让你的用户熟悉另一种配置格式。

结论

有了这么多更好的配置语言，没有理由还要使用JSON。如果要创建需要用到配置的新应用程序、框架或库，请选择JSON以外的其他选项。

英文原文: https: //www.lucidchart.com/techblog/2018/07/16/why-json-isnt-a-good-configuration-language/

ClearloveMe

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
第2章基础设施即服务（IaaS）-3-Docker Compose

是Docker官方编排（Orchestration）项目之一，负责快速的部署分布式应用。Compose项目是Docker官方的开源项目，负责实现对Docker容器集群的快速编排。从功能上看，跟OpenStack中的Heat十分类似。其代码目前在https:上开源。Compose定位是「定义和运行多个Docker容器的应用( Defining and running multi-container Docker applications)」，其前身是开源项目Fig。
复制链接

扫一扫