Vapor文档学习四 :Config

应用的配置通常都是基于他们部署的环境。Vapor为用户自定义提供了灵活的配置选择。

QuickStart

Vapor应用的配置文件放在Config文件夹里,下面以servers的配置为例:

./
├── Config/
│   ├── servers.json

文件内容如下:

{
    "default": {
        "port": "$PORT:8080",
        "host": "0.0.0.0",
        "securityLayer": "none"
    }
}

默认配置serverhttp服务器host:0.0.0.0端口号:8080,那么请求的地址就是:http://localhost:8080

Custom Keys(自定义键值)

打开servers.json文件,在json里添加自定义键值对

{
  "http": {
    "host": "0.0.0.0",
    "port": 8080,
    "custom-key": "custom value"
  }
}

采用如下代码可以在应用里获取自定义的配置:

let customValue = drop.config["servers", "http", "custom-key"]?.string ?? "default"

Config Syntax(配置语法)

可以使用app.config[<#file-name#>, <#path#>, <#to#>, <#file#>]这样的语法直接访问配置内容,假设我们创建了一个keys.json文件,并且有如下代码:

{
  "test-names": [
    "joe",
    "jane",
    "sara"
  ],
  "mongo": {
    "url" : "www.customMongoUrl.com"
  }
}

我可以通过将第一个下标设置为keys来访问这个文件,获取第一个名字或者获取mongo url:

let name = drop.config["keys", "test-names", 0]?.string ?? "default"
let mongoUrl = drop.config["keys", "mongo", "url"]?.string ?? "default"

Advanced Configurations(高级配置)

默认配置可以满足基本需求,但是在复杂环境下就不能只采用默认配置了,比如开发和生产环境使用不同的host。在这种复杂的环境下我们需要在Config/目录下传创建不同的配置文件。下面的目录就是针对不同的环境设置不同的配置:

WorkingDirectory/
├── Config/
│   ├── servers.json
│   ├── production/
│   │   └── servers.json
│   ├── development/
│   │   └── servers.json
│   └── secrets/
│       └── servers.json

可以使用--env=指定运行环境。自定义的环境也是支持的,production, development, 和testingVapor默认提供的。

$ vapor run --env=production

优先级:从上到下依次降低。

  1. CLI (see below)
  2. Config/secrets/
  3. Config/name-of-environment/
  4. Config/
    也就是说,如果用户使用app.config["servers", "host"],程序会优先从CLI中搜索对应的key,然后是secrets/,然后往下继续搜索。
    例如:
    servers.json
{
  "http": {
    "host": "0.0.0.0",
    "port": 9000
  }
}

production/servers.json

{
  "http": {
    "host": "127.0.0.1",
    "port": "$PORT"
  }
}

“$ NAME”语法可用于访问环境变量的所有值

请注意,servers.jsonproduction/servers.json中定义了相同的key:“host”,“post”,在我们的应用中会访问:

// 根据上面的配置会加载 0.0.0.0 or 127.0.0.1 
let host = drop.config["servers", "http", "host"]?.string ?? "0.0.0.0"
// 会加载9000或者环境变量中可以获取的port
let port = drop.config["servers", "http", "port"]?.int ?? 9000

COMMAND LINE(命令行)

除了Config/文件夹下的json文件外,我们也可以使用命令行传参的方法进行配置,这些值默认保存在“cli”文件中,但是也可以获取更丰富的选项。

  1. --KEY=VALUE

通过CLI命令行设置的参数可以通过configcli文件访问,例如:

 --mongo-password=$MONGO_PASSWORD

在程序中我们可以这样访问:

let mongoPassword = drop.config["cli", "mongo-password"]?.string
  1. --CONFIG:FILE-NAME.KEY=CUSTOM-VALUE
    如果你希望将命令行参数设置为除“cli”之外的文件,则可以使用此更高级的规范。例如,以下CLI命令:
--config:keys.analytics=124ZH61F

在程序中我们可以这样访问:

let analyticsKey = drop.config["keys", "analytics"]?.string

<b>总结:</b>Config文档主要是介绍了如何进行Config、Config的语法(json),根据环境分别配置、配置文件的优先级、以及使用CLI命令行进行配置等内容。(CLI命令行配置我也不懂,暂时放这,有空再研究吧。)

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

推荐阅读更多精彩内容