Swift 后端开发

Swift 2020-06-15

原文来自静雅斋，转载请注明出处。

作为一门新兴的现代化语言，Swift 可以说是苹果在开发语言上的一次集大成之作，吸收了很多语言的优点。而且苹果还期望 Swift 能在服务端开发上能发挥作用。更加诱人的是，作为一种编译型语言，有着 C++ 一般的性能，并且相比 Golang、Java 来说使用 ARC 管理内存避免了 GC 导致进程停顿。可以说 Swift 就是程序员梦寐以求的语言。

Swift 目前在后端开发的缺点

虽然 Swift 本身有很多优点，但是在后端开发上依旧任重道远，比如有以下问题：

目前只适配了 Ubuntu 下的二进制包，没有 RHEL 等其他 Linux 下的二进制包
缺乏非 Mac 系统下的 IDE 开发，这个目前看起来好像只能指望 Jetbrains 了
没有其他语言那么完善的生态系统
缺乏的文档，比如包管理系统的语法文档，必须自行查看源代码
没有交叉编译链，不能在 Mac 上面编译出 Linux 可用的二进制文件
缺乏好用的单元测试

但是这些问题目前都有方法克服，比如使用 Docker 作为承载 Swift 程序的容器，而使用 Mac 来开发 Swift 程序也不是很大的问题，因为大多数的后端开发都是用 Mac 开发的。

Docker 的作用

笔者个人认为 Docker 解决的最大的问题就是开发环境和生产环境的矛盾，对于开发人员来说，追新永远是必备素质，而测试和运维不会希望环境变更导致的问题，比如线上服务器跑的是 CentOS，而 Swift 则是必须在 Ubuntu 上运行，但是 Docker 的出现就能解决这个问题。笔者认为最适合运行在 Docker 中的就是像 Web 这样的服务，Nginx 和数据库之类的就不适合放在 Docker 中，因为它们是有状态的，而且 Docker 这样的快速消亡快速创建的模式也不适合数据库这样对数据有着严格要求的应用。当然，Kubernetes 目前推出的 petset 就很适合数据库这样的有状态的应用。

Perfect 框架

Perfect 框架是 Swift 开发的 Web 应用服务器，它支持包括 Redis、sqlite、Postgresql、MysqL、MongoDB、FileMaker 这样的数据库，并且能以 fastcgi 或者 Web 服务器的形式提供服务。更加美妙的是，还有高质量的中文文档。

HelloWorld

Perfect 提供了基础模板工程，可以使用以下命令下载

> git clone git@github.com:PerfectlySoft/PerfectTemplate.git

然后安装依赖

> swift package fetch

然后就能编译运行了

# 以 Debug 方式编译
> swift build
# 以 Release 方式编译
> swift build -c release

分析 HelloWorld

HelloWorld 工程依赖了 Perfect-HTTPServer 模块，然后其中有两个源文件，arguments.swift 和 main.swift
main.swift

import PerfectLib
import PerfectHTTP
import PerfectHTTPServer

// Create HTTP server.
let server = HTTPServer()

// Register your own routes and handlers
var routes = Routes()
routes.add(method: .get,uri: "/",handler: {
        request,response in
        response.setHeader(.contentType,value: "text/html")
        response.appendBody(string: "<html><title>Hello,world!</title><body>Hello,world!</body></html>")
        response.completed()
    }
)

// Add the routes to the server.
server.addRoutes(routes)

// Set a listen port of 8181
server.serverPort = 8181

// Set a document root.
// This is optional. If you do not want to serve static content then do not set this.
// Setting the document root will automatically add a static file handler for the route /**
server.documentRoot = "./webroot"

// Gather command line options and further configure the server.
// Run the server with --help to see the list of supported arguments.
// Command line arguments will supplant any of the values set above.
configureServer(server)

do {
    // Launch the HTTP server.
    try server.start()
} catch PerfectError.networkError(let err,let msg) {
    print("Network error thrown: \(err) \(msg)")
}

用过 Node 的 express 框架的朋友是不是感觉很熟悉，使用事件循环处理 HTTP 请求，事实上早期的 Perfect 框架用的就是 libev 框架来处理事件循环的 HTTP 请求。
arguments.swift

import PerfectHTTPServer
import PerfectLib

#if os(Linux)
    import SwiftGlibc
#else
    import Darwin
#endif

// Check all command line arguments used to configure the server.
// These are all optional and you can remove or add arguments as required.
func configureServer(_ server: HTTPServer) {
    
    var sslCert: String?
    var sslKey: String?
    
    var args = CommandLine.arguments
    
    func argFirst() -> String {
        guard let frst = args.first else {
            print("Argument requires value.")
            exit(-1)
        }
        return frst
    }
    
    let validArgs = [
        "--sslcert": {
            args.removeFirst()
            sslCert = argFirst()
        },"--sslkey": {
            args.removeFirst()
            sslKey = argFirst()
        },"--port": {
            args.removeFirst()
            server.serverPort = UInt16(argFirst()) ?? 8181
        },"--address": {
            args.removeFirst()
            server.serverAddress = argFirst()
        },"--root": {
            args.removeFirst()
            server.documentRoot = argFirst()
        },"--name": {
            args.removeFirst()
            server.serverName = argFirst()
        },"--runas": {
            args.removeFirst()
            server.runAsUser = argFirst()
        },"--help": {
            print("Usage: \(CommandLine.arguments.first!) [--port listen_port] [--address listen_address] [--name server_name] [--root root_path] [--sslcert cert_path --sslkey key_path] [--runas user_name]")
            exit(0)
        }]
    
    while args.count > 0 {
        if let closure = validArgs[args.first!.lowercased()] {
            closure()
        }
        args.removeFirst()
    }
    
    if sslCert != nil || sslKey != nil {
        if sslCert == nil || sslKey == nil {
            print("Error: if either --sslcert or --sslkey is provided then both --sslcert and --sslkey must be provided.")
            exit(-1)
        }
        if !File(sslCert!).exists || !File(sslKey!).exists {
            print("Error: --sslcert or --sslkey file did not exist.")
            exit(-1)
        }
        server.ssl = (sslCert: sslCert!,sslKey: sslKey!)
    }
}

这里就很简单了，就是提供参数用于 HTTP 服务器的创建，而这个好处就是能通过参数获得更多功能。

创建自己的工程

首先使用 swift package init 命令创建工程，一般来说如下

> swift package init --type executable

然后在 Package.swift 中增加依赖，但是 Swift 目前所有的 IDE 都没有提供对 PackageDescription 模块的代码提示，估计是因为这是 Swift 內建模块。具体内容得到 Swift 源代码中可以找到。
一般来说只要增加如下内容

import PackageDescription

let package = Package(
    name: "XXXX",dependencies: [
        .Package(url: "https://github.com/PerfectlySoft/Perfect-HTTPServer.git",majorVersion: 2,minor: 0)
    ]
)

然后创建 main.swift 文件，并且创建 HTTPServer 侦听端口，就能创建自己的工程了。

Docker

一般来说，Docker 目前想要运行 Swift 必须使用 Ubuntu 的镜像，因为 Swift 的预编译包只提供 Ubuntu 的压缩包，但是很多 Docker 镜像存在很多问题，比如缺少支持库，所以需要作出以下修改，下面提供一个样例

FROM swiftdocker/swift:3.0.1
MAINTAINER ChasonTang <chasontang@gmail.com>

RUN apt-get update \
    && apt-get install -y uuid-dev libcurl4-openssl-dev libssl-dev \ 
    && git clone https://github.com/PerfectlySoft/PerfectTemplate /usr/src/PerfectTemplate \
    && apt-get clean \
    && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
WORKDIR /usr/src/PerfectTemplate
RUN swift build -c release
CMD .build/release/PerfectTemplate --port 80

Perfect 需要 libcurl 是因为 swift build 获取依赖的时候是使用 curl 来获取代码的，uuid 是因为 Perfect 框架内置函数库所需，而 openssl 则是 Perfect 依赖的库所需。这里使用的是 git clone 的方式获取工程代码，但是也可以通过 COPY 指令复制当前目录下的文件。