Vapor文档学习十:Provider

Provider协议为Vapor项目添加功能和第三方Package提供了一种简单而可预测的方法。

Adding a Provider

添加一个provider需要2~3步:Add Package、Import、Config(选)。

Add Package

Vapor的provider都以-provider结尾,你可以在GitHub上搜索所有支持的Provider
要将provider添加到你的程序中,需要在Package.swift文件中将它作为依赖库添加进来:

let package = Package(
    name: "MyApp",
    dependencies: [
        .Package(url: "https://github.com/vapor/vapor.git", majorVersion: 1, minor: 0),
        .Package(url: "https://github.com/vapor/mysql-provider.git", majorVersion: 1, minor: 0)
    ]
)

添加新的package后,需要使用vapor clean或者vapor build --clean

Import

provider被添加之后,就可以使用import VaporFoo来引入它,Foo就是provider的名称。

比如引入MYSQL provider:

import Vapor
import VaporMySQL

let drop = Droplet()

try drop.addProvider(VaporMySQL.Provider.self)

// ...

drop.run()

每个provider都有一个Provider类,在Dropletinit方法中,将这个类的类型添加到providers数组中。

Config

有一些provider需要进行配置,比如VaporMySQL需要一个Config/mysql.json文件,内容如下:

{
    "host": "localhost",
    "user": "root",
    "password": "",
    "database": "vapor"
}

如果需要配置文件,你需要在Droplet初始化的时候接收错误异常。

Advanced

你可以选择自己初始化provider(初始化配置信息)。

import Vapor
import VaporMySQL

let drop = Droplet()

let mysql = try VaporMySQL.Provider(host: "localhost", user: "root", password: "", database: "vapor")
drop.addProvider(mysql)

...

drop.run()

Create a Provider

创建Provider很简单,你只需要创建一个遵守Vapor.Provider协议的Provider类的包。

🌰:这是一个Foopackage的provider,接收一条消息,然后在Droplet启动的时候打印消息

import Vapor

public final class Provider: Vapor.Provider {
    public let message: String
    public let provided: Providable

    public convenience init(config: Config) throws {
        guard let message = config["foo", "message"].string else {
            throw SomeError
        }

        try self.init(message: message)
    }

    public init(message: String) throws {
        self.message = message
    }

    public func afterInit(_ drop: Droplet) {

    }

    public func beforeServe(_ drop: Droplet) {
        drop.console.info(message)
    }
}

这个provider需要一个Config/foo.json文件进行配置:

{
    "message": "The message to output"
}

也可以通过初始化方法init(message: String)手动设置。

<b>总结</b>:Provider提供了引入外部文件的方法,这章也介绍了如何创建自定义的包文件。

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,647评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,801评论 6 342
  • 前往 Vapor 2.0 - 文档目录 Provider协议为向您的Vapor项目添加功能和第三方库创建了一种简单...
    韩云智VL阅读 439评论 0 0
  • 说明:这系列文章都是基于Vapor文档的理解与翻译,仅供个人学习使用。 Hello world 关于如何安装Vap...
    Supremodeamor阅读 1,672评论 0 1
  • 我家也想有张琴,或在高山或在林。 每欲兴来声袅袅,但思财力暗喑喑。 清风明月骚人趣,材米油盐我辈心。 梦想自然不敢...
    指间听琴阅读 253评论 0 3