文档

Unity 引擎

Unity 引擎

Link XML 格式参考

了解如何Format化 XML括支持的 XML 元素和Attributes及其用法示例。
阅读时间10 分钟最后更新于 6 天前

此参考提供有关正确设置
link.xml
文件格式的信息,包括有效的 XML 元素和Attributes 以及使用示例。

支持的 XML 元素

XML以下 XML 元素:

元件

描述

<linker></linker>
必须在 All
link.xml
文件中用作包含所有其他元素的最外层元件。
<assembly></assembly>
声明程序集指定的代码保留 Annotations。
<type></type>
声明指定的于类型的代码保留Annotations。
<field></field>
声明指定的于Field的代码保留Annotations。
<method></method>
声明指定的于方法的代码保留Annotations。
<property></property>
声明指定的于属性的代码保留Annotations。
<event></event>
声明指定的于事件的代码保留Annotations。
有关所有这些元素的用法示例,请参阅用法示例。

支持的 XML Attributes

属性

描述

accessors
应用于
<property>
元素以指定要保留的属性访问器方法。
feature
根据当前版本的 Settings,排除不支持的功能的保留。有关更多信息和使用示例,请参阅功能排除。
fullname
按Name标识代码元件,包括其父程程序集Name作为前缀。只要
name
本身可能不明确,就使用
fullname
。
ignoreIfMissing
Apply to a
<assembly>
元件可声明在 All Player 构建期间不存在的程序集的保留。有关用法示例,请参阅忽略缺失程序集。
ignoreIfUnreferenced
Apply to a
<assembly>
element to preserve the Entities in a assembly only if the least one of its member is referenceed by another assembly. 应用于某个元素,仅当程序集的至少一个成员被另一个程序集引用时,才保留程序集内的 Entities。有关用法示例,请参阅忽略未引用程序集。
name
仅按Name标识代码元件,而不以父程序集作为前缀。如果已在父 XML 元件中使用
fullname
指定程序集名称,则子 XML 元素可以仅通过
name
来标识代码元件。
preserve
指定要保留的代码元素关卡以免受剥离。
signature
通过 signature 标识代码元件。方法 signature 包含返回类型、Name 和 Parameters。Field、属性或事件signature包含类型和Name。有关用法示例,请参阅用法示例。
windowsruntime
每当为 Windows 运行时元数据 (.winmd) 程序集定义保留时,都必须添加到
link.xml
文件中的
<assembly>
元件。有关用法示例,请参阅 Windows 运行时元数据程序集。
有关所有这些Attributes的用法示例,请参阅用法示例。

用法示例

以下示例演示了支持的 XML 元素和Attributes 的有效用法。

声明程序集根类型的不同方法

以下示例说明了使用
link.xml
文件声明 Project 程序集根类型的不同方法:
<linker> <!--Preserve types and members in an assembly--> <assembly fullname="AssemblyName"> <!--Preserve an entire type--> <type fullname="AssemblyName.TypeName" preserve="all"/> <!--No "preserve" attribute and no members specified means preserve all members--> <type fullname="AssemblyName.TypeName"/> <!--Preserve all fields on a type--> <type fullname="AssemblyName.TypeName" preserve="fields"/> <!--Preserve all methods on a type--> <type fullname="AssemblyName.TypeName" preserve="methods"/> <!--Preserve the type only--> <type fullname="AssemblyName.TypeName" preserve="nothing"/> <!--Preserving only specific members of a type--> <type fullname="AssemblyName.TypeName"> <!--Fields--> <field signature="System.Int32 FieldName" /> <!--Preserve a field by name rather than signature--> <field name="FieldName" /> <!--Methods--> <method signature="System.Void MethodName()" /> <!--Preserve a method with parameters--> <method signature="System.Void MethodName(System.Int32,System.String)" /> <!--Preserve a method by name rather than signature--> <method name="MethodName" /> <!--Properties--> <!--保留属性、其后备 Field(如果存在) getter 和资源库方法 --> <property signature="System.Int32 PropertyName" /> <property signature="System.Int32 PropertyName" accessors="all" /> <!--Preserve a property, its backing field (if present), and getter method--> <property signature="System.Int32 PropertyName" accessors="get" /> <!--Preserve a property, its backing field (if present), and setter method--> <property signature="System.Int32 PropertyName" accessors="set" /> <!--Preserve a property by name rather than signature--> <property name="PropertyName" /> <!--Events--> <!--Preserve an event, its backing field (if present), add, and remove methods--> <event signature="System.EventHandler EventName" /> <!--Preserve an event by name rather than signature--> <event name="EventName" /> </type> </assembly></linker>

将整个程序集声明为根

以下示例展示了如何声明整个程序集:
<!--Preserve an entire assembly--> <assembly fullname="AssemblyName" preserve="all"/> <!--No "preserve" attribute and no types specified means preserve all--> <assembly fullname="AssemblyName"/> <!--Fully qualified assembly name--> <assembly fullname="AssemblyName, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null"> <type fullname="AssemblyName.Foo" preserve="all"/> </assembly> <!--力对程序程序集进行根处理,但不显式保留任何内容。在未引用程序程序集When很有用。--> <assembly fullname="AssemblyName" preserve="nothing"/>

保留嵌套或 Generic 类型

以下示例展示了如何保留嵌套类型或 Generic 类型:
<!--Examples with generics--> <type fullname="AssemblyName.G`1"> <!--Preserve a field with generics in the signature--> <field signature="System.Collections.Generic.List`1<System.Int32> FieldName" /> <field signature="System.Collections.Generic.List`1<T> FieldName" /> <!--Preserve a method with generics in the signature--> <method signature="System.Void MethodName(System.Collections.Generic.List`1<System.Int32>)" /> <!--Preserve an event with generics in the signature--> <event signature="System.EventHandler`1<System.EventArgs> EventName" /> </type> <!--Preserve a nested type--> <type fullname="AssemblyName.H/Nested" preserve="all"/> <!--如果使用类型,请保留该类型的All字段。 如果未使用该类型,则将已移除 --> <type fullname="AssemblyName.I" preserve="fields" required="0"/> <!--如果使用类型,请保留该类型的All方法。如果未使用该类型,则将已移除 --> <type fullname="AssemblyName.J" preserve="methods" required="0"/> <!--Preserve all types in a namespace--> <type fullname="AssemblyName.SomeNamespace*" preserve="all"/> <!--Preserve all types with a common prefix in their name--> <type fullname="Prefix*" preserve="all"/>

忽略缺失的程序集

如果需要为 All Player 构建期间不存在的程序集声明保留,请使用
<assembly>
元素的
ignoreIfMissing
属性:
<linker> <assembly fullname="Foo" ignoreIfMissing="1"> <type name="TypeName"/> </assembly></linker>

忽略未引用的程序集

使用 ON
<assembly>
元件的
ignoreIfUnreferenced
属性,仅当另一个程序集引用至少一个类型时,才保留程序集中的实体:
<linker> <assembly fullname="Bar" ignoreIfUnreferenced="1"> <type name="TypeName"/> </assembly></linker>

Windows 运行时时元数据程序程序集

每当为 Windows 运行时元数据 (.winmd) 程序集定义保留时,都必须使用 ON
<assembly>
元素的
windowsruntime
属性:
<linker> <assembly fullname="Windows" windowsruntime="true"> <type name="TypeName"/> </assembly></linker>

功能排除

mscorlib.dll
中嵌入式的
mscorlib.xml
文件使用此属性,但 When appropriate 时可以在 Any
link.xml
文件中使用。
在高剥离关卡中,Unity 链接器根据当前版本的 Settings 排除不支持的功能的保留:
  1. remoting
    — 以 IL2CPP Scripting Backend 为目标时排除。
  2. sre
    — 以 IL2CPP Scripting Backend 为目标时排除。
  3. com
    — 当目标平台不支持 COM 时被排除。
例如,以下
link.xml
文件保留了 ON 支持 COM 的平台的一个类型方法以及 ON All 平台的一种方法:
<linker> <assembly fullname="Foo"> <type fullname="Type1"> <!--Preserve FeatureOne on platforms that support COM--> <method signature="System.Void FeatureOne()" feature="com"/> <!--Preserve FeatureTwo on all platforms--> <method signature="System.Void FeatureTwo()"/> </type> </assembly></linker>

其他资源