FieryCrucible 项目使用教程

FieryCrucible 项目使用教程

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

FieryCrucible 项目的目录结构如下：

FieryCrucible/
├── Sources/
│   ├── FieryCrucible/
│   │   ├── Core/
│   │   │   ├── Injector.swift
│   │   │   ├── Resolver.swift
│   │   │   └── Scope.swift
│   │   ├── Extensions/
│   │   │   ├── Array+Extensions.swift
│   │   │   └── Dictionary+Extensions.swift
│   │   └── Utilities/
│   │       ├── Logger.swift
│   │       └── Utils.swift
│   └── FieryCrucibleTests/
│       ├── FieryCrucibleTests.swift
│       └── TestHelpers.swift
├── Package.swift
├── README.md
└── LICENSE

目录结构介绍

• Sources/FieryCrucible/: 包含项目的主要源代码。
  • Core/: 核心功能模块，包括依赖注入的主要实现。
    • Injector.swift: 依赖注入器的主要逻辑。
    • Resolver.swift: 解析依赖的具体实现。
    • Scope.swift: 定义不同的依赖作用域。
  • Extensions/: 扩展模块，提供一些常用的扩展方法。
    • Array+Extensions.swift: 数组扩展方法。
    • Dictionary+Extensions.swift: 字典扩展方法。
  • Utilities/: 工具模块，包含一些辅助功能。
    • Logger.swift: 日志记录工具。
    • Utils.swift: 其他通用工具方法。
• Sources/FieryCrucibleTests/: 测试模块，包含项目的单元测试。
  • FieryCrucibleTests.swift: 主要测试文件。
  • TestHelpers.swift: 测试辅助工具。
• Package.swift: Swift 包管理文件，定义项目的依赖和目标。
• README.md: 项目说明文档。
• LICENSE: 项目许可证文件。

2. 项目的启动文件介绍

项目的启动文件位于 Sources/FieryCrucible/Core/Injector.swift。这个文件包含了依赖注入器的主要逻辑，是整个项目启动的核心。

Injector.swift 文件介绍

import Foundation

public class Injector {
    private var bindings: [String: Any] = [:]

    public init() {}

    public func bind<T>(_ type: T.Type, to creator: @escaping () -> T) {
        let key = String(describing: type)
        bindings[key] = creator
    }

    public func resolve<T>(_ type: T.Type) -> T {
        let key = String(describing: type)
        guard let creator = bindings[key] as? () -> T else {
            fatalError("No dependency found for \(key)!")
        }
        return creator()
    }
}

• Injector 类: 提供依赖注入的主要功能。
  • bind 方法: 绑定一个类型到具体的创建函数。
  • resolve 方法: 解析并返回一个类型的实例。

3. 项目的配置文件介绍

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

Package.swift 文件介绍

// swift-tools-version:5.3
import PackageDescription

let package = Package(
    name: "FieryCrucible",
    platforms: [
        .macOS(.v10_15),
        .iOS(.v13),
        .tvOS(.v13),
        .watchOS(.v6)
    ],
    products: [
        .library(
            name: "FieryCrucible",
            targets: ["FieryCrucible"]
        )
    ],
    dependencies: [
        // 依赖项
    ],
    targets: [
        .target(
            name: "FieryCrucible",
            dependencies: []
        ),
        .testTarget(
            name: "FieryCrucibleTests",
            dependencies: ["FieryCrucible"]
        )
    ]
)

• name: 项目名称。
• platforms: 支持的平台。
• products: