铝注射剂

铝注射剂

基于依赖注入的框架模组,用于简化Minecraft模组的创建

Aluminis Inject

一个基于依赖注入的框架模组,用于简化 Minecraft 模组的创建。 要理解如何使用此模组,需要具备 面向对象编程和 依赖注入的基础知识。

为什么

在深入了解功能之前,我们先谈谈为什么你可能想使用此模组……而不是标准的 Fabric 开发。 Fabric 的一个缺点是没有自动注入:Fabric 不会将对象“注入”到你的类中。 你需要自己显式地实例化和注册所有内容。基本上,你需要创建许多不同的类, 然后手动实例化它们,最后将它们连接起来。对于小型模组来说这没问题,因为不需要太多连接/注册, 但当你开发更大、更复杂的模组时……它很快就会变得混乱且令人困惑。

1. 手动样板代码

在 Fabric 中,你必须显式注册每一个物品、方块、事件监听器等,没有任何抽象层。 这意味着会有更多重复代码,尤其是随着模组规模扩大。

2. 扩展之痛

一个小型 Fabric 模组感觉干净而简单。

一个大型 Fabric 模组?现在你要应付几十甚至上百个手动 Registry.register() 调用、 事件注册等等。如果没有一个中央容器或自动化系统(比如 DI 容器),扩展到大型 项目就需要构建你自己的抽象层。

核心功能

自动依赖注入(自动装配)

自动装配是一项功能,它可以自动将依赖注入到类中,而无需 显式配置或手动连接。框架不会通过编写配置代码来指定应该注入哪个实现, 而是根据某些规则(在本例中是一个注解)自动推断出来。

当然,如果你想使用基于非类的提供者,可能仍然需要一些配置。 更多信息请查看 Google Guice Wiki。

入门

首先,设置名为 aluminis-inject:bootstrap 的 Fabric 入口点,指向一个继承 net.aluminis.inject.model.AbstractModule 的类。Aluminis Inject 将实例化此类, 并使用它来自动加载你的服务。

"aluminis-inject:bootstrap": [
  "net.aluminis.inject.test.module.TestModule"
]

在你的模块入口点中,务必实现 provideModId() 方法以提供你的 modId。 它可以被注入

import com.google.inject.Provides;
import net.aluminis.inject.api.annotation.ModId;
import net.aluminis.inject.api.model.AbstractModule;

public class TestModule extends AbstractModule {

    @Provides // 可选(告诉自动加载器将此值作为提供者)
    @ModId    // 可选(告诉自动加载器通过注解 @ModId 提供此值)
    public String provideModId() {
        return "aluminis-inject";
    }

    public TestModule() {
        LoggerFactory.getLogger(MOD_ID).info("TestModuleInit worked!");
    }
}

创建你的服务!任何带有 @AutoLoad 注解的类都将被自动加载到模组容器中。

@AutoLoad()
public class TestService {
    public TestService() {
        
    }
}

服务可以被注入其他服务或提供者。自动装配会自动完成!更多信息, 请查看 Google Guice Wiki

@AutoLoad()
public class TestService {
    @Inject
    public TestService(@ModId String modId) {
        LoggerFactory.getLogger(modId).info("TestService worked!");
    }
}