Vapor 是 Swift 最流行的 Web 网络框架。它可以为你的网站或 API 提供精美的页面展示和简易的使用方式。
这是Vapor 博客搭建的开篇,我会跟着这部英文教程:practical-server-side-swift-using-vapor-4,用于记录从头开始学习到一步步完善基于 Vapor 框架的个人博客,这一系列文章会记录我学习中遇到的坑跟一些个人的想法,希望对Vapor有兴趣的同学可以一起交流。
因为我是一名iOS开发,swift也在项目中使用了3年了,不过之前也没系统得接触关于服务器端、web端的开发,所以下面的文章内容会以一个iOS开发者的视角去学习Vapor,希望能开拓更广的知识面。
环境
我使用的是 Macos Montetey
系统
swift
版本是:
swift-driver version: 1.26.21 Apple Swift version 5.5.2 (swiftlang-1300.0.47.5 clang-1300.0.29.30)
Target: x86_64-apple-macosx12.0
使用Xcode
版本是:Version 13.2.1 (13C100)
安装Vapor
安装的流程可以查看官方文档的中文翻译:https://cn.docs.vapor.codes/4.0/install/macos/
或者查看我之前的文章:https://www.jianshu.com/p/ffde61bcc9c9
新建项目
安装完成后,就可以通过vapor new 命令在当前文件夹下新建vapor 项目了,项目名称就叫a-Vapor-Blog
$ vapor new a-Vapor-Blog
会出现 Cloning template...
等待一会克隆模版完成后会询问:Would you like to use Fluent?
这里我们选择 y, 然后会展示几个db的选择,这里我们选择 SQLite
然后会继续询问:Would you like to use Leaf?
这里我们也选择 y,选择完后,新项目的配置也完成。
配置解释
Fluent
Fluent 是个ORM的库,ORM 是通过实例对象的语法,完成关系型数据库的操作的技术,是"对象-关系映射"(Object/Relational Mapping) 的缩写。使用这个库的话,做数据存储就不需要直接写SQL了。非常得方便,所以我们新建项目需要使用到这个库去管理数据。
Leaf
Leaf
是Vapor框架中使用的一种模板语言。模板语言允许传递信息给页面,然后根据所传递的页面信息来动态的生成最终的HTML。模板语言也为我们开发过程中节约代码提供了方法,我们可以使用模板语言来写页面展示代码,其中可以加入各种参数变量,不同页面间也可以复用之前写好的代码块。个性页面显示方式时,有时只需要更改一处地方就可以改变所有页面的显示方式了。我们可以在一个模板中嵌套另一个模板。
我理解是方便写html 页面的模版,对我们这个博客项目有用,所以我们也使用它。
项目目录
项目已经创建好了,让我们cd到 a-Vapor-Blog 文件夹然后输入 vapor xcode
打开新建的项目吧
$ cd a-Vapor-Blog
$ vapor xcode
打开项目后可以看到左边的项目目录,下面的package Dependencies 在自动的拉取依赖。
这是xcode 在自动得通过SPM帮我们处理对应的依赖库,依赖的设置文件在 Package
文件,可以打开看看。
// swift-tools-version:5.5
import PackageDescription
let package = Package(
name: "a-Vapor-Blog",
platforms: [
.macOS(.v10_15)
],
dependencies: [
// A server-side Swift web framework.
.package(url: "https://github.com/vapor/vapor.git", from: "4.0.0"),
.package(url: "https://github.com/vapor/fluent.git", from: "4.0.0"),
.package(url: "https://github.com/vapor/fluent-sqlite-driver", from: "4.1.0"),
.package(url: "https://github.com/vapor/leaf.git", from: "4.0.0"),
],
targets: [
.target(
name: "App",
dependencies: [
.product(name: "Vapor", package: "vapor")
],
swiftSettings: [
// Enable better optimizations when building in Release configuration. Despite the use of
// the `.unsafeFlags` construct required by SwiftPM, this flag is recommended for Release
// builds. See for details.
.unsafeFlags(["-cross-module-optimization"], .when(configuration: .release))
]
),
.executableTarget(name: "Run", dependencies: [.target(name: "App")]),
.testTarget(name: "AppTests", dependencies: [
.target(name: "App"),
.product(name: "XCTVapor", package: "vapor"),
])
]
)
可以看到dependencies
那行有四个依赖:
vapor
fluent
fluent-sqlite-driver
-
leaf
其中后面3个是我们新建项目时选择的,所以会加进 SPM 的dependencies
里面。所以新建项目时没有选择也没关系,后面可以更新这个package
文件去管理依赖。
这里的配置有一些问题,在后面会说到如何解决。
SPM
Swift Package Manager 是一个苹果官方出的管理源代码分发的工具,目的是更简单的使用别人共享的代码。它会直接处理包之间的依赖管理、版本控制、编译和链接。从总体功能上来说,与 iOS 平台上的 Cocoapods、Carthage 类似。
当前新版Xcode 已经内置SPM了,所以我们能很方便得使用它。
运行
等待Xcode
拉取完Shadow
后就可以cmd + R
直接运行项目了。不过Xcode这时候出现了编译报错:
No such module 'Fluent'
, 原来是模版里面的代码里面已经 import Fluent
了,但是spm
的 Package
文件虽然有引入fluent
的依赖,但是对应我们要运行的traget没有设置到依赖,所以才会报错没找到模块的异常。下面是修改后的Package
文件:
// swift-tools-version:5.5
import PackageDescription
let package = Package(
name: "a-Vapor-Blog",
platforms: [
.macOS(.v10_15)
],
dependencies: [
// A server-side Swift web framework.
.package(url: "https://github.com/vapor/vapor.git", from: "4.0.0"),
.package(url: "https://github.com/vapor/fluent.git", from: "4.0.0"),
.package(url: "https://github.com/vapor/fluent-sqlite-driver", from: "4.1.0"),
.package(url: "https://github.com/vapor/leaf.git", from: "4.0.0"),
],
targets: [
.target(
name: "App",
dependencies: [
.product(name: "Vapor", package: "vapor"),
.product(name: "Fluent", package: "fluent"),
.product(name: "FluentSQLiteDriver", package: "fluent-sqlite-driver"),
.product(name: "Leaf", package: "leaf")
],
swiftSettings: [
// Enable better optimizations when building in Release configuration. Despite the use of
// the `.unsafeFlags` construct required by SwiftPM, this flag is recommended for Release
// builds. See for details.
.unsafeFlags(["-cross-module-optimization"], .when(configuration: .release))
]
),
.executableTarget(name: "Run", dependencies: [.target(name: "App")]),
.testTarget(name: "AppTests", dependencies: [
.target(name: "App"),
.product(name: "XCTVapor", package: "vapor"),
])
]
)
可以看到 在target App
下已经补充了 "Fluent"、"FluentSQLiteDriver"、"Leaf" 的依赖了。修改完成保存后,Xcode
自动处理依赖,然后再次 Run
,成功运行了。会发现编译成功了,然后可以看到控制台打印出[ NOTICE ] Server starting on http://127.0.0.1:8080
在浏览器输入 http://127.0.0.1:8080
看到 It works!
就是成功啦!
后续
到这里项目已经创建好了,接下来我们就可以为它添砖加瓦了,一起努力吧!