Fabric Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== 访问加宽 ======

访问加宽（Access wideners）提供了一种放宽类、方法、字段访问权限的方式。访问加宽类似于著名的 Access Transformers.

访问加宽应该**仅在**使用 Mixin 无法实现时使用。目前只有以下两种情景 Mixin 无法做到：
  * 需要访问一个（包内）的私有类，尤其是为了 @Shadow 修饰或在 Mixin 类内访问一个字段或方法。
  * 需要重写使用 final 修饰的子类。
    * 在你考虑重写使用 final 修饰的方法之前，使用注入器等方法修改。
    * 如果你想为一个包含私有构造方法的类创建子类，wideners 是个不错的选择

为了让 access widener 造成的的变化显示在反编译的源代码中，请运行 ''genSources'' gradle任务。

===== 需求 =====
  * Fabric-loader 0.8.0 或更高
  * Loom 0.2.7 或更高
===== 文件格式 =====


需要在你的模组里包含一个声明修改访问权限的特殊文件，为了帮助，你应该在IDE中使用 ''.accesswidener'' 文件扩展名。

该文件首行应该遵循下述格式，''命名空间'' 应该与你模组源码使用混淆命名空间匹配，通常是 ''named''。 Loom 将会为你重新映射 access widener 文件，使其更改为 ''intermediary''。如果你使用自定义的 ''RemapJarTask''，设置 ''remapAccessWidener'' 为 ''true'' 来确保上述行为发生。

<code [enable_line_numbers="true"]>
accessWidener	v1	<命名空间>
</code>

**再次提醒，命名空间应该在你使用 yarn 命名时设置为 ''named''， 使用中间名命名时设置为 ''intermediary''。**

Access widener 文件允许使用空行和和以 # 开头的注释。

<code [enable_line_numbers="true"]>
# 这样的注释是支持的，当它被放在行尾也是这样的
</code>

任何空白字符都作为 access widener 文件的分隔符，推荐制表符 tab。

类名应该使用 / 分隔，而不是 .

对于内部类，你应该使用 ''$'' 来代替 ''/''

== 类 ==

类的访问权限可以通过指定 访问权 和 类的名称 来改变，就像第一行定义命名空间那样。

<code [enable_line_numbers="true"]>
<访问权>   class   <类名>
</code>

  - 访问权可以是 //accessible// 或 //extendable//

== 方法 ==

可以通过指定访问权限、类名称、方法名称和方法描述符来改变方法访问权，就像上面定义的映射命名空间一样。

<code [enable_line_numbers="true"]>
<access>   method   <className>   <methodName>   <methodDesc>
</code>

  - access 可以是 //accessible// 或 //extendable//
  - classname 是拥有者类
  - methodName 是方法名称
  - methodDesc 是方法描述符

== 字段 ==

字段的访问权可以通过指定访问权、类名称、字段名称和字段描述符来修改，就像上面定义的映射命名空间一样。

<code [enable_line_numbers="true"]>
<access>   field   <className>   <fieldName>   <fieldDesc>
</code>

  - access 可以是 //accessible// 或 //mutable//
  - className 是拥有者类
  - fieldName 是字段名称
  - fieldDesc 是字段描述符

===== 访问权变更 =====

=== Extendable（可继承） ===

需要继承最终类或者覆盖最终方法时，用 extendable。

  * 类将会改成 public 并移除 final 修饰符
  * 方法会改成 protected 并移除 final 修饰符

将方法改为 extendable 的同时也会使类变为 extendable。

=== Accessible（可访问） ===

需要访问另一个类的类、字段或方法时，用 accessible。

  * 类将变为 public
  * 方法将变为 public，并且若为 private，还会变为 final
  * 字段将会变为 public

将方法或者字段改为 accessible 将会使得类也 accessible。

=== Mutable（可修改） ===

需要修改常量字段时，用 mutable。

  * 字段将会移除 final 修饰符

===== 指定文件位置 =====

访问加宽文件位置必须在 build.gradle 和 fabric.mod.json 文件中指定。该文件应该存在 resources 中，且需要包括在导出的 jar 文件中。

Loom 0.9 或更高版本：

<code groovy [enable_line_numbers="true"]>
loom {
	accessWidenerPath = file("src/main/resources/modid.accesswidener")
}
</code>

Loom 0.8 或更低版本：

<code groovy [enable_line_numbers="true"]>
loom {
	accessWidener = file("src/main/resources/modid.accesswidener")
}
</code>

fabric.mod.json：

<code json [enable_line_numbers="true"]>
...

"accessWidener" : "modid.accesswidener",

...
</code>