增加一个提供程序（Adding a Provider）

向您的应用程序添加一个提供程序需要2-3个步骤。

添加包（Add Package）

所有的Vapor提供者都以-provider的语法结束。通过在GitHub上搜索，您可以看到一个available providers列表。

要将提供者添加到您的包中，请将其添加为您的Package.swift文件中的依赖项。

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

警告
在编辑您的Package.swift文件后，总需要运行vapor update或vapor clean。

包含（Import）

一旦添加了提供程序，您可以使用import VaporFoo来导入它，其中Foo是提供程序的名称。

以下是导入MySQL提供商的情况:

import Vapor
import MySQLProvider

添加到Droplet（Add to Droplet）

每个提供者都有一个名为Provider的类。使用addProvider方法将这个类添加到您的Droplet中。

let config = try Config()
try config.addProvider(MySQLProvider.Provider.self)

let drop = try Droplet(config)

// ...

drop.run()

配置（Configuration）

一些驱动程序可能需要配置文件。例如，MySQLProvider需要一个Config/mysql.json文件，如下:

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

如果需要配置文件，则在Droplet的初始化过程中会收到一个错误。

提示
在Config/secrets文件夹中存储敏感的配置文件(包含密码的文件)将防止它们被git跟踪。

手册（Manual）

一些提供程序可以通过使用提供者的init方法手动配置。可以使用此方法代替配置文件。

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

创建一个提供程序（Create a Provider）

创建一个提供程序是很容易的，您只需创建一个与Vapor.Provider相匹配的类Provider包。

例子（Example）

下面是一个示例Foo包的提供者是什么样子的。所有提供者所做的都是获取消息，然后在Droplet开始时打印消息。

import Vapor

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

    public convenience init(config: Config) throws {
        guard let message = config["foo", "message"].string else {
            throw ConfigError.missing(key: ["message"], file: "foo", desiredType: String.self)
        }

        self.init(message: message)
    }

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

    public func boot(_ drop: Droplet) { }

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

这个提供程序需要一个看起来像这样的Config/foo.json文件:

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

还可以使用init(message: String)init手动初始化提供程序。

最后编辑于：2017.12.09 22:25:17

Vapor 2.0 - 供应商（Provider）