Mixin 访问器 26.1.2

了解如何使用 Mixin 的访问器和调用器来访问方法和字段。

Mixin 通常用于修改现有代码以生成和调整行为。 然而，Mixin 同样提供了以访问器 Mixin 的形式，来访问无法直接访问的字段和方法的工具。

类修改器 以 访问拓宽器 的形式提供了类似的工具，但 Mixin 的访问器不需要重新加载 Gradle，并且可以应用于非 Minecraft 目标。

如果需要重写 final 方法、继承 final 类或引用 private 类，仍然需要使用访问拓宽，因为访问器只能针对字段和方法。

创建访问器接口

访问器 Mixin 必须始终是一个接口，且只能包含带有 @Accessor 或 @Invoker 注解的方法。 该接口必须像其他 Mixin 类一样，使用 @Mixin 注解进行标记。

按照惯例，访问器接口通常以其目标类名加上 Accessor 后缀来命名，并放置在 Mixin 包下的 accessor 子包中。 例如 your.package.mixin.accessor

字段访问器

字段可以通过带有 @Accessor 注解的 getter 和/或 setter 方法进行访问：

Getter/Setter 语法：

实例访问器方法应当带有你的模组 ID 前缀和一个分隔符（通常为 $ 或 _），以确保它不会与任何其他方法发生冲突。

@Accessor("<field name>")
FieldType example_mod$getFieldName();

@Accessor("<field name>")
void example_mod$setFieldName(FieldType value);

示例：

@Mixin(Gui.class)
public interface GuiAccessor {
	@Accessor("overlayMessageTime")
	int example_mod$getOverlayMessageTime();

	@Accessor("overlayMessageTime")
	void example_mod$setOverlayMessageTime(int messageTime);
}

用法：

void exampleInstanceFieldAccessorUsage(Gui gui, int newMessageTime) {
	int oldMessageTime = ((GuiAccessor) gui).example_mod$getOverlayMessageTime();

	((GuiAccessor) gui).example_mod$setOverlayMessageTime(newMessageTime);
}

设置 Final 字段

如果目标字段是 final 的，请在访问器的 setter 方法上添加 @Mutable 注解，以便在应用过程中移除 final 标记：

@Mixin(Villager.class)
public interface VillagerAccessor {
	@Accessor("FOOD_POINTS")
	@Mutable
	void example_mod$setItemFoodValues(Map<Item, Integer> items);
}

方法调用器

要调用无法直接访问的方法或构造函数，请创建一个签名匹配且带有 @Invoker 注解的方法：

语法：

实例调用器方法应当带有你的模组 ID 前缀和一个分隔符（通常为 $ 或 _），以确保它不会与任何其他方法发生冲突。

调用器方法通常直接以目标方法命名，或者使用 invoke 或 call 后跟目标方法名。

@Invoker("<method name>")
MethodReturnType example_mod$methodName(/* matching parameters */)

示例：

@Mixin(Inventory.class)
public interface InventoryAccessor {
	@Invoker("hasRemainingSpaceForItem")
	boolean example_mod$hasRemainingSpaceForItem(ItemStack slotItemStack, ItemStack newItemStack);
}

用法：

void exampleInstanceMethodInvokerUsage(Inventory inventory, ItemStack slotItemStack, ItemStack newItemStack) {
	if (((InventoryAccessor) inventory).example_mod$hasRemainingSpaceForItem(slotItemStack, newItemStack)) {
		/* ... */
	}
}

对 Final 类使用访问器

由于 Java 编译器对 final 类的限制更为严格，它不允许我们直接将 final 类的实例强制转换为访问器接口。

为了解决这个问题，我们只需要先将其转换为 Object，然后再转换为访问器接口即可：

((TargetClassAccessor) (Object) targetClassInstance).example_mod$accessorMethod(/* ... */)