Vapor文档学习一 :Droplet

Vapor文档学习一 :Droplet_第1张图片
图片源于网络

官网: http://qutheory.io
参考文章: http://www.appcoda.com/server-side-swift-vapor/
吐槽一下:1,markdown不支持锚点,所以搞不了目录;
2,Vapor的中文文档404了,还是读原生英文的吧。

说明:这系列文章都是基于Vapor文档的理解与翻译,仅供个人学习使用。

Hello world

关于如何安装Vapor,我不打算写了,按照文档来吧,还是建议使用Toolbox,省心省力,这个安装好了就等于安装好了Vapor。我使用$ brew install vapor安装总是失败,最后是使用如下命令手动安装的:

git clone [email protected]:vapor/toolbox.git
cd toolbox
swift build -c release
mv .build/release/Executable /usr/local/bin/vapor

安装成功后,可以查看vapor的所有指令:

$ vapor

会显示:

Usage: vapor 

假设你的xcode、swift都是更新到了最新版本就可以创建Hello项目了。
终端,cd到合适的目录:

$ vapor new Hello

Vapor文档学习一 :Droplet_第2张图片
Hello.png

出现上面的图片就证明新建 Hello项目成功了。实际上是从github上拉取框架基础模板。
如果你想使用 xcode编辑,执行下面的命令:

$ cd Hello
$ vapor xcode -y   //-y表示立即打开xcode

运行看看?
在项目根目录,也就是Hello目录下:

$ vapor build

首次运行等待时间比较长,然后

$ vapor run  //或:  $ vapor run serve

如果是使用xcode开发则不用使用命令行运行服务器。如下图将targets切换为app,然后cmd + R即可运行。

Vapor文档学习一 :Droplet_第3张图片
切换targets

然后浏览器打开:http://localhost:8080
会显示如下页面:

Vapor文档学习一 :Droplet_第4张图片
It works

GUIDE

这部分介绍了Vapor框架的基础知识,我现在是是Swift3.1版本,如何查看?终端输入下面的指令:

$ swift -version

输出结果:

Apple Swift version 3.1 (swiftlang-802.0.51 clang-802.0.41)
Target: x86_64-apple-macosx10.9

关于切换swift版本,还是别折腾了,下载最新的Xcode,使用的最新的swift版本就可以了。
再次强调下,如果想往下看,先看官方文档 GETTING STARTED部分,先了解Vapor的安装和运行。如过遇到任何问题,欢迎留言一起探讨。

1,Droplet

旧版本中是Application这个类,现在使用的是Droplet类,这个类管理着Vapor的很多特性,包括路由的注册、server的运行、拼接middleware等等。

1.1,初始化Droplet

创建一个空的Drolet实例,找到工程目录中的main.swift文件(里面有默认的代码,你可以删掉自己写),首先引入Vapor,然后直接实例化。

import Vapor
let drop = Droplet()
// your magic here
drop.run()
1.2,Environment

运行环境属性,包括:development(默认), testing, production三种,分别是开发环境、测试环境、生产环境。用法也很简单,就是根据不同的运行环境进行日志打印、配置参数等操作,方便在开发时调试、生产时精简应用包。

if drop.environment == .production
       ...
}

通过以下指令指定运行环境:

$vapor run serve --env=production

如果使用Xcode进行开发,可以通过scheme editor传递运行环境的参数

Note: Debug输出会降低应用每秒的请求量,所以生产环境下可以提高这方面的表现。

1.3,Working Directory

workDir属性,指定应用起始运行的文件夹,默认是应用的跟目录。
可以再Droplet初始化时设置,也可以单独设置,如下:

vapor run serve --workdir="/var/www/my-project"

启动应用:

vapor run serve --workdir="/var/www/my-project"
1.4,Modifying Prperties(属性修改)

Droplet的属性可以通过程序或者配置来进行更改

1.4.1 Pragrammtic(程序中修改)

Droplet初始化之后,可以更改其属性。

let drop = Droplet()
drop.server = MyServerType.self

上面的代码就是采用自定义的Server,替换了默认的server。Dropletrun的时候就会启动自定义的server。

1.4.2 Configurable(配置项修改)

如果是在某种特定情况下更改Droplet的属性,可以使用addConfigrable。下面的例子就是实现在生产环境下打印邮件错误日志,但是不会在开发环境下向你的邮箱发送垃圾邮件。

let drop = Droplet()
drop.addConfigurable(log: MyEmailLogger.self, name: "email")

Droplet会继续使用默认的日志打印,除非你修改了Config/droplet.json文件来指定为邮件错误打印 . 在Config/production/droplet.json进行如下修改后,这个错误打印只会在生产环境下起作用。

{
    "log": "email"
}
1.4.3 Initialization(初始化修改)

Droplet的初始化十分简单并且提供了大多数属性的修改,这个Xcode编程的话可以点击Droplet查看源码。
大多数Vapor的插件都是来自Provider,这个可以查看Provider的章节。

Droplet(
       arguments: <#T##[String]?#>,
       workDir: <#T##String?#>, 
       environment: <#T##Environment?#>, 
       config: <#T##Config?#>, 
       localization: <#T##Localization?#>, 
       log: <#T##LogProtocol?#>
)

Note: 记住初始化时使用的是默认的属性,这也就是说在你修改属性之前要确保其他部分的代码还没有使用你要修改的属性,否则会造成时而使用默认属性、时而使用修改的属性而产生的混乱的结果。(没事别瞎改,改要改完全。)

总结:Droplet大概就介绍了其初始化方法、Environment、workDir等属性以及如何修改器属性。

你可能感兴趣的:(Vapor文档学习一 :Droplet)