用SwiftWeb(Perfect)开发一个SwiftChina
前言
对于Swift开发者来说也许大家也听说过SwiftWeb服务开发,我自己也是个爱折腾的人下面记录了我折腾SwiftWeb最终弄出来的东西(Demo)。
github: https://github.com/SwiftFS/SwiftFSChina
效果图 http://swiftfs.org/
框架选择
总所周知,在swiftWeb服务器框架比较出名的是Perfect,Vapor,Kitura,我花了2天对比最终选择了主(http)框架选择了perfecr原因如下:
1.首先忽略了Kitura,原因是虽然IMB是一个很出名的公司,但他的SwiftWeb框架组件并不丰富,没有slack。
2.在vapor和perfect中,vapor最大的优势是社区活跃度非常高,slack加入人数也是最多的,开发人员也是对外的,而且经常文档写的非常好,而他出的项目也非常的人性化如:他有一个vapor cli可以非常轻松的在linux下安装swift环境,leaf模板也是非常强大。不足的地方我感觉就是功能没perfect强大了。当然这个项目也集成了他的几个子package
3.perfect据我了解主开发人员比较少(可以到github上看到)而且他的团队是公司性质的,全部项目几个人一手包办,羡慕他们这些技术牛人。perfect的优势是他家出的产品非常强大如:用swift玩转tensorflow,swift版kafka,swift版ZooKeeper,而且perfect公司还弄了个用swift开发android的,具体可以自己谷歌。
web功能也是比较丰富的例如:
1.session的处理 perfect 分别集成了 mysql,postgressql,redis,
2.可以自己添加过滤器
3.后面文章也会提及
不足的地方就是虽然有中文文档但文档并不人性化,有点乱,几个模板项目运行都有问题
ps:这里不讨论性能那个快那个慢,在框架不成熟的情况比这些没意义。
模块选择
这个项目用到的模块要有 数据库连接,网页模板,日志,加密,session,redis,json...
下面列举用到的相应package 顺带吐槽一下。
1.数据库用的是mysql,这里本来是应该用perfect家提供的mysql链接库的和orm的,但是在实践中发现该框架并没有支持连接池技术。而且没有时间的认证,我没有选择ORM框架。无可厚非这东西并不成熟,这并不是rails, hibernat。最终选择mysql-swift
2.日志功能直接使用perfect提供的,perfect提供了比较全面的日志方案
3.session 处理的perfect是提供比较好的方案,像上面提及的 它家提供了mysql,postgressql,redis解决方案,便于以后做集群方案处理。但是因为mysql-session与mysql-swiftpackage会冲突的原因,最后选择用redis作为session存储方案
4.模板的话,本来是用Perfect-Mustache的,但考虑到Mustache模板逻辑处理能力太弱了也不便于开发,最后对比leaf和stencil,最后选择stencil,这里介绍一下stencil模板,stencil非常强大,start数也很多,支持继承,支持自定义语法,大家可以了解一下。
5.加密技术用到bcrypt package由vapor提供
6.OAuth2 这里用perfect提供的
7.模型转->JSON处理 因为是swift3的关系(swift4官方会提供方法)这里选择了阿里的handyjson,但是handyjson并不能在linux下运行,所以要修改他的源码,可以用handyjson的好处是支持自定添加转换类型,可以将Date和各种自定义类型进行转换处理
在linux上运行
直接使用vapor 提供的 vapor cli 然后使用它安装swift配置环境 下载本项目他会提示你所需要的包你只需要 按照其提示即可,如果报了 #<uuid/uuid>的错误 需要安装uuid相关库.
代码分析:
创建一个filter 用于验证用户
configuration/Filter.swift
filters.append(["type":"request","priority":"high","name":CheckLogin])
filter/CheckLogin
//检查有没登录
public func CheckLogin(data: [String:Any]) throws -> HTTPRequestFilter {
return checklogin()
}
struct checklogin:HTTPRequestFilter {
func is_login(req:HTTPRequest) -> [String:Any]? {
guard req.session != nil else {
return nil
}
guard let user:[String:Any] = req.session!.data["user"] as? [String : Any] else{
return nil
}
return user
}
func filter(request: HTTPRequest, response: HTTPResponse, callback: (HTTPRequestFilterResult) -> ()) {
guard let st = request.header(HTTPRequestHeader.Name.accept) else{
callback(.execute(request, response))
return
}
guard st.components(separatedBy: "text/html").count > 1 else {
callback(.execute(request, response))
return
}
let requestPath = request.path
var in_white_list = false
var islogin = false //已经登录
if requestPath == "//" {
in_white_list = true
}else{
for address in whitelist{
if address.components(separatedBy: requestPath).count > 1
{
in_white_list = true
break
}
}
}
//判断是否登录
let user = is_login(req: request)
if (user != nil) {
if user?["username"] != nil && user?["userid"] != nil && (user!["username"] as? String != "") && (user!["userid"] as? Int != 0){
islogin = true
}
}
//域对象 PageHandlers处理
let dic:[String:Any] = [ "login":islogin
,"username":user?["username"] ?? ""
,"userid":user?["userid"] ?? 0
,"create_time":user?["create_time"] ?? ""]
if in_white_list {
request.scratchPad["locals"] = dic
callback(.continue(request, response))
}else{
if islogin {
request.scratchPad["locals"] = dic
request.session!.data.updateValue(true, forKey: "login")
callback(.continue(request, response))
}else{
if let st = request.header(HTTPRequestHeader.Name.accept){
//如果是接口请求
if st.components(separatedBy: "application/json").count > 1 {
callback(.execute(request, response))
do{
try response.setBody(json: ["success":false,"msg":"该操作需要先登录"])
response.completed()
}catch{
Log.error(message: "\(error)")
}
}else{
response.redirect(path: "/login")
}
}
}
}
}
}
使用sctencil 作为模板
原理 使用responet.setbody 输出http
extension HTTPResponse {
public func render(template: String, context: [String: Any] = [String: Any]()) {
//设置路径
let fsLoader = FileSystemLoader(paths: ["webroot/views"])
let environment = Environment(loader: fsLoader)
do{
let stencil = try environment.renderTemplate(name: "\(template)"+".html", context: context)
self.setBody(string: stencil)
self.completed()
}catch{
Log.error(message: "\(error)")
}
}
}
因为是.html 文件 所以在xcode上编辑有颜色,强烈推荐sctencil
上传图片
static func avatar(data:[String:Any]) throws -> RequestHandler{
return {
req,res in
do{
let fileDir = Dir(Dir.workingDir.path + "webroot/avatar")
do {
try fileDir.create()
} catch {
Log.error(message: "\(error)")
}
let upload = uploads[0]
let thisFile = File(upload.tmpFileName)
let date = NSDate()
let timeInterval = date.timeIntervalSince1970
let hashName = "\(timeInterval.hashValue)"
var type:String?
let typeArray = upload.contentType.components(separatedBy: "/")
guard typeArray.count >= 2 else {
try res.setBody(json: ["success":false,"msg":"获取类型出错"])
res.completed()
return
}
type = typeArray[1]
let picName = hashName + "." + type!
let _ = try thisFile.moveTo(path: fileDir.path + picName, overWrite: true)
let judge = try UserServer.update_avatar(avatar: picName, userid: user_id)
guard judge != false else {
try res.setBody(json: ["success":false,"msg":"上传失败"])
res.completed()
return
}
try res.setBody(json: ["success":true,"originFilename":upload.tmpFileName,"filename":picName])
res.completed()
}catch{
Log.error(message: "\(error)")
}
}
}
后记
对swiftWeb有兴趣的小伙伴们可以加入qq群:514517311