PerfectTemplate 项目安装与使用教程

PerfectTemplate 项目安装与使用教程

PerfectTemplate Empty Perfect Starter Project. 项目地址: https://gitcode.com/gh_mirrors/pe/PerfectTemplate

1. 项目的目录结构及介绍

PerfectTemplate/
├── Package.swift
├── Sources/
│   └── PerfectTemplate/
│       └── main.swift
├── Tests/
│   └── LinuxMain.swift
├── .gitignore
├── .swift-version
├── LICENSE
└── README.md

目录结构介绍

• Package.swift: 项目的 Swift Package Manager 配置文件，定义了项目的依赖和目标。
• Sources/: 包含项目的源代码。
  • PerfectTemplate/: 项目的主要源代码目录。
    • main.swift: 项目的入口文件，负责启动服务器。
• Tests/: 包含项目的测试代码。
  • LinuxMain.swift: 用于 Linux 环境下的测试入口文件。
• .gitignore: Git 忽略文件，定义了哪些文件或目录不需要被 Git 管理。
• .swift-version: 指定项目使用的 Swift 版本。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档，通常包含项目的简介、安装和使用说明。

2. 项目的启动文件介绍

main.swift

main.swift 是 PerfectTemplate 项目的启动文件，负责初始化并启动服务器。以下是 main.swift 的主要内容：

import PerfectHTTP
import PerfectHTTPServer

// 创建 HTTP 服务器
let server = HTTPServer()

// 配置服务器端口
server.serverPort = 8080

// 配置服务器根目录
server.documentRoot = "./webroot"

// 添加路由
var routes = Routes()
routes.add(method: .get, uri: "/") {
    request, response in
    response.setBody(string: "Hello, world!")
    response.completed()
}

server.addRoutes(routes)

do {
    // 启动服务器
    try server.start()
} catch PerfectError.networkError(let err, let msg) {
    print("网络错误: \(err) \(msg)")
}

启动文件介绍

• 导入模块: 导入了 PerfectHTTP 和 PerfectHTTPServer 模块，这是 Perfect 框架的核心模块。
• 创建服务器: 使用 HTTPServer() 创建了一个 HTTP 服务器实例。
• 配置服务器: 设置了服务器的端口和服务器的根目录。
• 添加路由: 定义了一个简单的路由，当访问根路径 / 时，返回 "Hello, world!"。
• 启动服务器: 使用 server.start() 启动服务器，并捕获可能的网络错误。

3. 项目的配置文件介绍

Package.swift

Package.swift 是 Swift Package Manager 的配置文件，定义了项目的依赖和目标。以下是 Package.swift 的主要内容：

// swift-tools-version:5.3
import PackageDescription

let package = Package(
    name: "PerfectTemplate",
    dependencies: [
        .package(url: "https://github.com/PerfectlySoft/Perfect-HTTPServer.git", from: "3.0.0")
    ],
    targets: [
        .target(
            name: "PerfectTemplate",
            dependencies: ["PerfectHTTPServer"]),
        .testTarget(
            name: "PerfectTemplateTests",
            dependencies: ["PerfectTemplate"])
    ]
)

配置文件介绍

• Swift 工具版本: 指定了使用的 Swift 工具版本为 5.3。
• 包名: 定义了包的名称为 PerfectTemplate。
• 依赖: 定义了项目的依赖，这里依赖了 Perfect-HTTPServer 包，版本从 3.0.0 开始。
• 目标: 定义了两个目标：
  • PerfectTemplate: 主目标，依赖 PerfectHTTPServer。
  • PerfectTemplateTests: 测试目标，依赖 PerfectTemplate。

通过以上配置，Swift Package Manager 可以自动管理项目的依赖和构建过程。

PerfectTemplate Empty Perfect Starter Project. 项目地址: https://gitcode.com/gh_mirrors/pe/PerfectTemplate