teloc

Teloc 是一个简单的 Rust 编译时依赖注入框架，灵感来源于 C# 依赖注入框架。

什么是 DI？

维基百科链接

依赖注入（DI）是一种技术，其中对象接收它所依赖的其他对象。这些其他对象称为依赖项。在典型的“使用”关系中，接收对象被称为客户端，传递（即“注入”）的对象称为服务。将服务传递给客户端的代码可以是许多不同的事物，被称为注入器。客户端不指定它将使用哪种服务，而是注入器告诉客户端使用哪种服务。“注入”指的是将依赖项（服务）传递给将使用它的对象（客户端）。

亮点

• 编译时 - teloc 使用强大的 Rust 类型系统在编译时检查依赖项的存在，这些依赖项具有适当的生存期。这意味着如果所需的依赖项尚未注册或其生存期比请求的短，则无法编译您的代码。如果您的代码可以编译，则意味着它将运行！
• 无开销 - teloc 仅使用无开销的抽象，如特质、泛型、新类型和单元类型，以及编译时依赖项解析，因此您不必担心运行时的开销。
• 简单的 API - teloc 为您提供一个简单的 API，只需要一个结构和一个属性宏即可与库一起使用。
• 与现有环境集成 - teloc 可以与任何现有框架（如 actix-web、warp、rocket）一起使用。现在只支持 actix-web，如您在 示例 中所见。

如何使用

存在一种可以作为服务提供者的类型：ServiceProvider。它用作存储具有Instance和Singleton生命周期的依赖项，并用于声明所有依赖项，使用.add_*()方法。它可以分支创建具有本地实例的本地作用域。

依赖项有四种生命周期

1. Transient。服务将在解析时创建。可以依赖于任何生命周期的依赖项。
2. Singleton。服务将在解析时在ServiceProvider中创建一次（延迟）。可以依赖于任何生命周期的依赖项。不能依赖于来自分支的ServiceProvider实例的服务。
3. Instance。依赖项是在ServiceProvider外部创建的，可以被任何其他依赖项使用。

如何工作

1. 声明你的结构体。
2. 创建构造函数并在其上添加#[inject]宏。
3. 创建一个ServiceProvider对象。
4. 使用ServiceProvider::add_*方法添加你的服务和依赖项。
5. 如果需要创建本地作用域，请分支ServiceProvider。
6. 使用.resolve()方法从提供者获取服务。
7. 使用服务。

示例

use teloc::*;

// Declare your structs
struct ConstService {
    number: i32,
}
// #[inject] macro is indicate that dependency can be constructed using this function
#[inject]
impl ConstService {
    pub fn new(number: i32) -> Self {
        ConstService { number }
    }
}

// Derive macro can be used when all fields implement `Dependency` trait, but 
// we recommend using the #[inject] macro it in production code instead.
#[derive(Dependency)]
struct Controller {
    number_service: ConstService,
}

fn main() {
    // Create `ServiceProvider` struct that store itself all dependencies
    let sp = ServiceProvider::new()
        // Add dependency with `Singleton` lifetime. More about lifetimes see above.
        .add_singleton::<ConstService>()
        // Add dependency with `Transient` lifetime. More about lifetimes see above.
        .add_transient::<Controller>();
    // Fork `ServiceProvider`. It creates a new `ServiceProvider` which will have
    // access to the dependencies from parent `ServiceProvider`.
    let scope = sp
        // .fork() method creates a local mutable scope with self parent immutable `ServiceProvider`.
        .fork()
        // Add an instance of `i32` that will be used when `ConstService` will be initialized.
        .add_instance(10);
    // Get dependency from `ServiceProvider`
    let controller: Controller = scope.resolve();
    assert_eq!(controller.number_service.number, 10);
}

有关文档，请参阅docs.rs上的页面。

有关更多示例，请参阅示例文件夹或测试文件夹。

与其他DI框架的比较

如何读取错误

有时teloc会给出奇怪的大的错误。但别慌！你可以通过阅读错误阅读手册来定义你的问题。

专业技巧

本节包含了一些你可能希望在处理库时使用的专业技巧。

获取ServiceProvider实例的类型

当您想在结构体中存储ServiceProvider的实例，或从函数返回或作为参数传递时，这将很有用。

你需要什么

1. 在ServiceProvider初始化后粘贴以下代码：let () = service_provider;。
2. 编译器将给出一个非常大的可怕的类型，以teloc::ServiceProvider<...>开始。
3. 将此类型复制到类型别名中，例如：type ConcreteSP = /*compiler output*/;。
4. 当您想要编写ServiceProvider实例类型时使用ConcreteSP。
5. 如果更改ServiceProvider初始化，请重复步骤1-4。

许可