用Swift寫服務端 — Perfect框架

ZY_FlyWay發表於2018-09-29

用Swift寫服務端 — Perfect框架學習（一）

一、Perfect簡介

Perfect是一組完整、強大的工具箱、軟體框架體系和Web應用伺服器，可以在Linux、iOS和macOS (OS X)上使用。該軟體體系為Swift工程師量身定製了一整套用於開發輕量、易維護、規模可擴充套件的Web應用及其它REST服務的解決方案，這樣Swift工程師就可以實現同時在伺服器和客戶端上採用同一種語言開發軟體專案。

由於建立在一個高效能非同步網路引擎基礎上，Perfect還能夠在FastCGI上執行，支援安全套接字加密（SSL）。該軟體體系還包含很多其它網際網路伺服器所需要的特點，包括WebSockets和iOS訊息推送，而且很快會有更多強大的功能支援。

無論您是資深程式設計師還是入門級的軟體工程師，本文都能夠幫助您快速啟動Perfect實現伺服器專案開發執行。

二、Perfect專案快速上手

1.編譯入門專案

我們在Perfect官網的git上直接下載一個入門專案。編譯後就可以啟動一個本地的服務，監聽你的8181埠：

git clone https://github.com/PerfectlySoft/PerfectTemplate.git
cd PerfectTemplate
swift build
.build/debug/PerfectTemplate

我們可以在控制檯看到以下內容：

Starting HTTP server on 0.0.0.0:8181 with document root ./webroot

伺服器現在已經執行並等待連線。從瀏覽器開啟http://localhost:8181/ 可以看到歡迎資訊。

在終端控制檯中輸入組合鍵“control-c”可以隨時終止伺服器執行。

2.Xcode管理

Swift軟體包管理器（SPM）能夠建立一個Xcode專案，並且能夠執行PerfectTemplate模板伺服器，還能為您的專案提供完全的原始碼編輯和除錯。在您的終端命令列內輸入：

swift package generate-xcodeproj

然後開啟產生的檔案“PerfectTemplate.xcodeproj”，確定選擇了可執行的目標檔案，並選擇在“我的Mac”執行。現在您可以執行並除錯伺服器了。

直接執行XCode，然後在瀏覽器中輸入0.0.0.0:8181也是能直接執行的！

三、搭建HTTP伺服器

編輯main.swift檔案

import PerfectLib
import PerfectHTTP
import PerfectHTTPServer
//HTTP服務
var routesArr = [Dictionary<String, Any>]()
var someDict1 : [String:String] = ["method":"GET","url":"/api"]
routesArr.append(someDict1)
let networkServer = NetworkServerManager(root: "webroot", port: 8080, routesArr: routesArr)
networkServer.startServer()

建立NetworkServerManager.swift檔案

//
// NetworkServerManager.swift
// PerfectTemplatePackageDescription
//
// Created by ZFJ on 2018/1/9.
//
import PerfectLib
import PerfectHTTP
import PerfectHTTPServer
open class NetworkServerManager {
fileprivate var server: HTTPServer
internal init(root: String, port: UInt16, routesArr: Array<Dictionary<String, Any>>) {
server = HTTPServer.init() //建立HTTPServer伺服器
for dict: Dictionary in routesArr {
let baseUri : String = dict["url"] as! String //跟地址
let method : String = dict["method"] as! String //方法
var routes = Routes.init(baseUri: baseUri) //建立路由器
let httpMethod = HTTPMethod.from(string: method)
configure(routes: &routes, method: httpMethod) //註冊路由
server.addRoutes(routes) //路由新增進服務
}
server.serverName = "localhost" //伺服器名稱
server.serverPort = port //埠
server.documentRoot = root //根目錄
server.setResponseFilters([(Filter404(), .high)]) //404過濾
}
//MARK: 開啟服務
open func startServer() {
do {
print("啟動HTTP伺服器")
try server.start()
} catch PerfectError.networkError(let err, let msg) {
print("網路出現錯誤：\(err) \(msg)")
} catch {
print("網路未知錯誤")
}
}
//MARK: 註冊路由
fileprivate func configure(routes: inout Routes,method: HTTPMethod) {
routes.add(method: .get, uri: "/selectUserInfor") { (request, response) in
let path = request.path
print(path)
let jsonDic = ["hello": "world"]
let jsonString = self.baseResponseBodyJSONData(code: 200, message: "成功", data: jsonDic)
response.setBody(string: jsonString) //響應體
response.completed() //響應
}
// if method == .get{
// //get請求
// }else if method == .post{
// //post請求
// let postParams = request.postParams
// print(postParams)
// }
}
//MARK: 通用響應格式
func baseResponseBodyJSONData(code: Int, message: String, data: Any!) -> String {
var result = Dictionary<String, Any>()
result.updateValue(code, forKey: "code")
result.updateValue(message, forKey: "message")
if (data != nil) {
result.updateValue(data, forKey: "data")
}else{
result.updateValue("", forKey: "data")
}
guard let jsonString = try? result.jsonEncodedString() else {
return ""
}
return jsonString
}
//MARK: 404過濾
struct Filter404: HTTPResponseFilter {
func filterBody(response: HTTPResponse, callback: (HTTPResponseFilterResult) -> ()) {
callback(.continue)
}
func filterHeaders(response: HTTPResponse, callback: (HTTPResponseFilterResult) -> ()) {
if case .notFound = response.status {
response.setBody(string: "404 檔案\(response.request.path)不存在。")
response.setHeader(.contentLength, value: "\(response.bodyBytes.count)")
callback(.done)
} else {
callback(.continue)
}
}
}
}

執行結果

介面訪問

四、搭建MySql伺服器

我的電腦上安裝的有Homebrew，所以我直接通過Homebrew安裝MySql，安裝命令：

brew install mysql

配置MySql

#開啟MySQL服務
mysql.server start
#初始化MySQL配置嚮導
mysql_secure_installation

我電腦上資料庫已經而配置好了，這裡面我就不演示了，如果有不瞭解的可以加我QQ或者QQ群；

五、安裝Navicat Premium

Navicat premium是一款資料庫管理工具,是一個可多重連線資料庫的管理工具，它可以讓你以單一程式同時連線到 MySQL、SQLite、Oracle 及 PostgreSQL 資料庫，讓管理不同型別的資料庫更加的方便。

Navicat Premium_12.0.22破解版下載

這裡面下載好了以後會讓你輸入安裝密碼，密碼為：xclient.info

如下圖：

安裝成功以後如果開啟出現如下圖的錯誤，只需要在終端輸入以下程式碼就好；

執行以下命令開啟
sudo spctl --master-disable

這樣就可以開啟了，然後連結MySQL資料庫，如下圖

然後建立資料庫userInforsTable，然後建立了一個userTable表，並向userTable表中新增了三條資料；如下圖：

這樣你就可以操作MySQL資料庫了，當然你也可以通過終端直接運算元據庫；

六、編輯Perfect服務端

建立DataBaseManager.swift資料庫管理類，在這裡我們對資料庫進行增刪改查操作；

//
// DataBaseManager.swift
// PerfectTemplatePackageDescription
//
// Created by ZFJ on 2018/1/17.
//
import MySQL
//MARK: 資料庫資訊
let mysql_host = "127.0.0.1"
let mysql_user = "root"
let mysql_password = "12345678"
let mysql_database = "userInforsTable"
//MARK: 表資訊
let userTable = "userTable" //使用者資訊表
open class DataBaseManager {
fileprivate var mysql : MySQL
internal init() {
mysql = MySQL.init() //建立MySQL物件
guard connectDataBase() else{ //開啟MySQL連線
return
}
}
//MARK:開啟連結
private func connectDataBase() -> Bool{
let connected = mysql.connect(host: mysql_host, user: mysql_user, password: mysql_password, db: mysql_database)
guard connected else{
print("MySql連結失敗" + mysql.errorMessage())
return false
}
print("MySql連結成功")
return true
}
//MARK: 執行SQL語句
/// 執行SQL語句
///
/// - Parameter sql: sql語句
/// - Returns: 返回元組(success:是否成功 result:結果)
@discardableResult
func mysqlStatement(_ sql:String) -> (success:Bool,mysqlResult:MySQL.Results?,errorMsg:String) {
guard mysql.selectDatabase(named:mysql_database) else {
//指定操作的資料庫
let msg = "未找到\(mysql_database)資料庫"
print(msg)
return(false, nil, msg)
}
let successQuery = mysql.query(statement:sql) //sql語句
guard successQuery else{
let msg = "SQL失敗:\(sql)"
print(msg)
return(false, nil, msg)
}
let msg = "SQL成功:\(sql)"
print(msg)
return (true, mysql.storeResults(), msg) //sql執行成功
}
/// 增
///
/// - Parameters:
/// - tableName: 表
/// - keyValueDict: 鍵:值對字典
func insertDataBaseSQL(tableName:String, keyValueDict:Dictionary<String, Any>) -> (success: Bool, mysqlResult: MySQL.Results?, errorMsg: String) {
var keys: [String] = []
var values: [String] = []
for (key, value) in keyValueDict {
if let str = value as? String {
keys.append(key)
values.append(str)
}
}
let fieldNameAll: String = keys.joined(separator: ",")
let valueAll: String = values.joined(separator: ",")
let SQL = "insert into \(tableName)(\(fieldNameAll)) values(\(valueAll))"
return mysqlStatement(SQL)
}
/// 刪
///
/// - Parameters:
/// - tableName: 表
/// - key: 鍵
/// - value: 值
func deleteDatabaseSQL(tableName: String, key: String, value: String) -> (success: Bool, mysqlResult: MySQL.Results?, errorMsg: String) {
let SQL = "DELETE FROM \(tableName) WHERE \(key) = '\(value)'"
return mysqlStatement(SQL)
}
/// 改
///
/// - Parameters:
/// - tableName: 表
/// - keyValue: 鍵值對( 鍵='值', 鍵='值', 鍵='值' )
/// - whereKey: 查詢key
/// - whereValue: 查詢value
func updateDatabaseSQL(tableName: String, keyValue: String, whereKey: String, whereValue: String) -> (success: Bool, mysqlResult: MySQL.Results?, errorMsg: String) {
let SQL = "UPDATE \(tableName) SET \(keyValue) WHERE \(whereKey) = '\(whereValue)'"
return mysqlStatement(SQL)
}
/// 查所有
///
/// - Parameters:
/// - tableName: 表
/// - key: 鍵
func selectAllDatabaseSQL(tableName: String) -> (success: Bool, mysqlResult: MySQL.Results?, errorMsg: String) {
let SQL = "SELECT * FROM \(tableName)"
return mysqlStatement(SQL)
}
/// 查
///
/// - Parameters:
/// - tableName: 表
/// - keyValue: 鍵值對
func selectAllDataBaseSQLwhere(tableName: String, keyValue: String) -> (success: Bool, mysqlResult: MySQL.Results?, errorMsg: String) {
let SQL = "SELECT * FROM \(tableName) WHERE \(keyValue)"
return mysqlStatement(SQL)
}
//獲取表中所有資料
func mysqlGetHomeDataResult() -> [Dictionary<String, String>]? {
let result = selectAllDatabaseSQL(tableName: userTable)
var resultArray = [Dictionary<String, String>]()
var dic = [String:String]()
result.mysqlResult?.forEachRow(callback: { (row) in
dic["userid"] = row[0]
dic["userNumber"] = row[1]
dic["userName"] = row[2]
dic["userSex"] = row[3]
dic["userBirthday"] = row[4]
resultArray.append(dic)
})
return resultArray
}
}

然後在NetworkServerManager中呼叫DataBaseManager，註冊子路由/selectUserInfor查詢使用者表裡的所以資訊；

//MARK: 註冊路由
fileprivate func configure(routes: inout Routes,method: HTTPMethod) {
routes.add(method: .get, uri: "/selectUserInfor") { (request, response) in
let path = request.path
print(path)
// let jsonDic = ["hello": "world"]
// let jsonString = self.baseResponseBodyJSONData(code: 200, message: "成功", data: jsonDic)
// response.setBody(string: jsonString) //響應體
// response.completed() //響應
let queryParams = request.queryParams
if queryParams.count == 0{
let result = DataBaseManager().mysqlGetHomeDataResult()
let jsonString = self.baseResponseBodyJSONData(code: 200, message: "成功", data: result)
response.setBody(string: jsonString)
response.completed()
}else{
//有引數
//let value : String
for i in 0...queryParams.count - 1{
let partArr = queryParams[i]
print(partArr)
}
let jsonString = self.baseResponseBodyJSONData(code: 200, message: "成功", data: nil)
response.setBody(string: jsonString)
response.completed()
}
}
}

然後調取介面訪問資料http://0.0.0.0:8080/api/selectUserInfor；如下圖：

注意事項

1.如果你在NetworkServerManager中無法呼叫DataBaseManager，或者說呼叫DataBaseManager查詢不到，那是因為你建立DataBaseManager的時候沒有選擇在專案中引用，預設選擇了第一個第三方庫了；

如果你建立完成只需要稍微修改一下就好；

2.如果提示MySQL找不到，那是因為你的工程中，或者我們開始下載的那個示例工程沒有匯入MySQL，你需要引用一下就好；

首先修改Package.swift檔案，引用https://github.com/PerfectlySoft/Perfect-MySQL.git

示例如下：

import PackageDescription
let package = Package(
name: "PerfectTemplate",
targets: [],
dependencies: [
.Package(url: "https://github.com/PerfectlySoft/Perfect-HTTPServer.git", majorVersion: 3),
.Package(url: "https://github.com/PerfectlySoft/Perfect-MySQL.git", majorVersion: 2),
]
)