Trtr:注解编程:修订间差异
小 修正错误的代码... |
小无编辑摘要 |
||
第73行: | 第73行: | ||
=== 方块物品 === |
=== 方块物品 === |
||
方块物品(BlockItem)约定名称为"ITEM"、备选"BLOCK_ITEM",类型为: |
方块物品(BlockItem)约定名称为"ITEM"、备选"BLOCK_ITEM",类型为:[[Minecraft:net.minecraft.item.BlockItem|net.minecraft.item.BlockItem]]或其子类<ref>{{cite web |url=https://github.com/cao-awa/the-road-to-reality/blob/main/src/main/java/com/github/cao/awa/trtr/framework/block/item/BlockItemAccessor.java |title=BlockItemAccessor.java at main · cao-awa/the-road-to-reality |publisher=草awa |date=2023-03-16 |archiveurl=https://github.com/cao-awa/the-road-to-reality/blob/f9934c5c7fd078bf80b7effc50cd346cea6d3027/src/main/java/com/github/cao/awa/trtr/framework/block/item/BlockItemAccessor.java |archivedate=2023-03-16 |accessdate=2023-03-16 }}</ref>。 |
||
或者以形如Class<? extends BlockItem>的方式声明类型。<ref name="example_block"></ref> |
或者以形如Class<? extends BlockItem>的方式声明类型。<ref name="example_block"></ref> |
2023年3月17日 (五) 07:34的版本
注解编程,是指在Trtr:Trtr的代码中,使用注解替代手动编写过多重复代码的设计模式,本质上是由一个IoC框架代替完成。
约束
任何需要被自动处理的字段必须被"static"修饰[1],这也包括已经自行初始化的字段。方法的修饰与正常开发时无异。
示例
在任意位置(合理的软件包下)编写如下代码,而后直接运行Minecraft,此时不需要自行去注册这个方块,Trtr:方块反射框架会处理好这一切。
以下字段"IDENTIFIER"和"SETTINGS"必须存在,必须大写。
@Auto
public class TestBlock extends TrtrBlock {
@Auto
public static final Identifier IDENTIFIER = Identifier.of("trtr", "test");
@Auto
public static final Settings SETTINGS = FabricBlockSettings.of(Material.STONE, MapColor.GRAY);
@Auto
public TestBlock(Settings settings) {
super(settings);
}
}
任何被支持的字段都可以以类似以上的方式被自动处理,而开发者只需要写更少量的重复代码。
自动初始化
Trtr的IoC框架支持自动初始化字段,例如此处有一方块物品:
@Auto
public class TestBlockItem extends TrtrBlockItem {
@Auto
public static final FabricItemSettings SETTINGS = new FabricItemSettings();
@Auto
public AluniteOreItem(Block block, Settings settings) {
super(block, settings);
}
}
这时候可以直接在TestBlock中加入字段"ITEM"或"BLOCK_ITEM",而不需要任何的赋值。如下所示:
@Auto
public class TestBlock extends TrtrBlock {
@Auto
public static final Identifier IDENTIFIER = Identifier.of("trtr", "test");
@Auto
public static final Settings SETTINGS = FabricBlockSettings.of(Material.STONE, MapColor.GRAY);
@Auto
public static TestBlockItem ITEM;
// 另一种方式声明方块物品
// @Auto
// public static Class<TestBlockItem> ITEM = TestBlockItem.class;
@Auto
public TestBlock(Settings settings) {
super(settings);
}
}
约定
在使用注解编程时,只有匹配约定字段的名称和类型才会被自动处理。
字段
标识符
标识符(Identifier)约定名称为"IDENTIFIER"、类型为:Minecraft:net.minecraft.util.Identifier[2]。
设置(方块)
方块设置(Settings)约定名称为"SETTINGS"、备选"SETTING",类型为:Minecraft:net.minecraft.block.AbstractBlock.Settings的子类[3],如net.fabricmc.fabric.api.object.builder.v1.block.FabricBlockSetting。[4]
方块物品
方块物品(BlockItem)约定名称为"ITEM"、备选"BLOCK_ITEM",类型为:net.minecraft.item.BlockItem或其子类[5]。
或者以形如Class<? extends BlockItem>的方式声明类型。[4]
方块战利品(数据生成)
方块战利品(Loot)约定名称为"LOOT"、备选"LOOT_PROVIDER",类型为Minecraft:net.fabricmc.fabric.api.datagen.v1.provider.SimpleFabricLootTableProvider的子类或Trtr:com.github.cao.awa.trtr.framework.data.gen.loot.LootFactory的实现[6],如Trtr:com.github.cao.awa.trtr.data.gen.loot.GenericBlockLootProvider。
或者以形如Class<? extends SimpleFabricLootTableProvider>或LootFactory<? extends SimpleFabricLootTableProvider>的方式声明类型。[4]
方块模型(数据生成)
方块模型(models)约定名称为"MODEL"、备选"MODEL_PROVIDER",类型为Minecraft:net.fabricmc.fabric.api.datagen.v1.provider.FabricModelProvider的子类[7],如Trtr:com.github.cao.awa.trtr.data.gen.model.GenericBlockModelProvider。
或者以形如Class<? extends BlockItem>的方式声明类型。[4]
方法
样式
在代码中,@Auto注解最好在每一个会被自动处理的字段、方法和类上出现,以统一标准样式。但这一要求不是强制性的,只需要至少在类上添加注解即可使用注解编程,其他位置只是建议添加而非强制。
参考
- ↑ "FieldAccessor.java at main · cao-awa/the-road-to-reality". 草awa. 2023-03-16. Archived from the original on 2023-03-16. Retrieved 2023-03-16.
- ↑ "IdentifierAccessor.java at main · cao-awa/the-road-to-reality". 草awa. 2023-03-15. Archived from the original on 2023-03-15. Retrieved 2023-03-16.
- ↑ "BlockSettingAccessor.java at main · cao-awa/the-road-to-reality". 草awa. 2023-03-16. Archived from the original on 2023-03-16. Retrieved 2023-03-16.
- ↑ 4.0 4.1 4.2 4.3 "ExampleBlock.java at main · cao-awa/the-road-to-reality". 草二号机. 2023-03-15. Archived from the original on 2023-03-15. Retrieved 2023-03-16.
- ↑ "BlockItemAccessor.java at main · cao-awa/the-road-to-reality". 草awa. 2023-03-16. Archived from the original on 2023-03-16. Retrieved 2023-03-16.
- ↑ "LootDataGeneratorAccessor.java". 草awa. 2023-03-16. Archived from the original on 2023-03-16. Retrieved 2023-03-16.
- ↑ "ModelDataGeneratorAccessor.java at main · cao-awa/the-road-to-reality". 草awa. 2023-03-15. Archived from the original on 2023-03-15. Retrieved 2023-03-16.