Vapor 项目教程

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

Vapor 项目的目录结构通常如下：

Vapor/
├── Sources/
│   ├── App/
│   │   ├── Controllers/
│   │   ├── Models/
│   │   ├── Migrations/
│   │   ├── Routes/
│   │   └── configure.swift
│   └── Run/
│       └── main.swift
├── Tests/
│   └── AppTests/
├── Public/
├── Package.swift
├── README.md
└── Config/
    ├── secrets/
    ├── docker/
    └── vapor/

目录结构介绍

• Sources/: 包含项目的所有源代码。
  • App/: 包含应用程序的主要代码，如控制器、模型、迁移和路由。
    • Controllers/: 存放处理请求的控制器类。
    • Models/: 存放数据库模型类。
    • Migrations/: 存放数据库迁移文件。
    • Routes/: 存放定义应用程序路由的文件。
    • configure.swift: 配置应用程序的文件，如数据库连接、中间件等。
  • Run/: 包含启动应用程序的入口文件。
    • main.swift: 应用程序的启动文件。
• Tests/: 包含项目的测试代码。
  • AppTests/: 存放应用程序的单元测试和集成测试。
• Public/: 存放静态文件，如图片、CSS 和 JavaScript 文件。
• Package.swift: 定义项目的依赖关系和目标。
• README.md: 项目的介绍文档。
• Config/: 包含项目的配置文件。
  • secrets/: 存放敏感配置文件，如数据库密码等。
  • docker/: 存放 Docker 相关的配置文件。
  • vapor/: 存放 Vapor 框架的配置文件。

2. 项目的启动文件介绍

main.swift

main.swift 是 Vapor 应用程序的启动文件。它负责初始化并运行应用程序。以下是一个典型的 main.swift 文件内容：

import Vapor

@main
struct Run {
    static func main() throws {
        var env = try Environment.detect()
        try LoggingSystem.bootstrap(from: &env)
        
        let app = Application(env)
        defer { app.shutdown() }
        
        try configure(app)
        try app.run()
    }
}

启动文件介绍

• Environment.detect(): 检测当前的运行环境（如开发、测试、生产）。
• LoggingSystem.bootstrap(from: &env): 初始化日志系统。
• Application(env): 创建 Vapor 应用程序实例。
• configure(app): 调用 configure.swift 文件中的配置函数，配置应用程序。
• app.run(): 启动应用程序。

3. 项目的配置文件介绍

configure.swift

configure.swift 文件负责配置 Vapor 应用程序的各种组件，如数据库连接、路由、中间件等。以下是一个典型的 configure.swift 文件内容：

import Vapor
import Fluent
import FluentSQLiteDriver

public func configure(_ app: Application) throws {
    // 配置数据库
    app.databases.use(.sqlite(.file("db.sqlite")), as: .sqlite)
    
    // 注册路由
    let router = app.routes
    try routes(router)
    
    // 配置中间件
    app.middleware.use(FileMiddleware(publicDirectory: app.directory.publicDirectory))
    
    // 配置迁移
    app.migrations.add(CreateTodo())
    
    // 启动定时任务
    app.schedulers.use(.default)
}

配置文件介绍

• 数据库配置: 使用 app.databases.use 配置数据库连接。
• 路由注册: 使用 routes(router) 注册应用程序的路由。
• 中间件配置: 使用 app.middleware.use 配置中间件，如静态文件中间件。
• 迁移配置: 使用 app.migrations.add 配置数据库迁移。
• 定时任务配置: 使用 app.schedulers.use 配置定时任务调度器。

通过以上配置，Vapor 应用程序可以正常启动并运行。