Vapor Routing Kit 开源项目教程-优快云博客

Vapor Routing Kit 开源项目教程

routing-kit🚍 High-performance trie-node router.项目地址:https://gitcode.com/gh_mirrors/ro/routing-kit

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

Vapor Routing Kit 项目的目录结构如下：

routing-kit/
├── Sources/
│   ├── RoutingKit/
│   │   ├── Classes/
│   │   │   ├── Router.swift
│   │   │   ├── RouteCollection.swift
│   │   │   └── ...
│   │   ├── Extensions/
│   │   │   ├── String+Extensions.swift
│   │   │   └── ...
│   │   └── RoutingKit.swift
│   └── ...
├── Tests/
│   ├── LinuxMain.swift
│   ├── XCTestManifests.swift
│   └── RoutingKitTests/
│       ├── RouterTests.swift
│       └── ...
├── Package.swift
└── README.md

目录结构介绍

Sources/: 包含项目的源代码。
- RoutingKit/: 核心代码目录，包含路由相关的类和扩展。
  - Classes/: 包含路由器和路由集合等核心类。
  - Extensions/: 包含字符串等常用类型的扩展。
Tests/: 包含项目的测试代码。
- RoutingKitTests/: 包含路由相关的测试用例。
Package.swift: Swift 包管理文件，定义项目的依赖和目标。
README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 Sources/RoutingKit/RoutingKit.swift。该文件主要负责初始化路由器和加载路由集合。

import Vapor

public func boot(_ app: Application) throws {
    // 初始化路由器
    let router = Router()
    
    // 加载路由集合
    let routeCollection = MyRouteCollection()
    try routeCollection.boot(router: router)
    
    // 将路由器绑定到应用
    app.router = router
}

3. 项目的配置文件介绍

项目的配置文件主要是 Package.swift，该文件定义了项目的依赖和目标。

// swift-tools-version:5.3
import PackageDescription

let package = Package(
    name: "RoutingKit",
    platforms: [
       .macOS(.v10_15)
    ],
    products: [
        .library(name: "RoutingKit", targets: ["RoutingKit"]),
    ],
    dependencies: [
        .package(url: "https://github.com/vapor/vapor.git", from: "4.0.0"),
    ],
    targets: [
        .target(name: "RoutingKit", dependencies: [
            .product(name: "Vapor", package: "vapor")
        ]),
        .testTarget(name: "RoutingKitTests", dependencies: ["RoutingKit"]),
    ]
)