在Flex/Flash中自定义Metadata tag

　　经常使用flex进行开发的朋友肯定对metadata tag不会陌生，比如大家常用的[Bindable],[Event]都是metadata，它的作用是为Flex编译器提供组件如何使用的信息。比如说你在组件中定义了一个事件，如果你想让flex编译器知道这个事件，从而在其他MXML中引用它，你就应该插入一个[Event]的metadata tag，代码应该像下面这样。

[Event(name="myEvent", type="flash.events.Event")]

我们已经习惯了官方提供的metadata，那我们能否自定义metadata呢，答案是肯定的，现在我们就自定义一个metadata。

用flex（我用的是flex4）新建一个AS项目，然后创建一个类TestClass，在类中编写如下代码。

　　

package
{
    public class TestClass
    {
        [MyMetadata(param = "param value")]
        public var name:String;
        public function TestClass()
        {
        }
    }
}

上面代码中我们自定义的一个metadata，叫MyMetadata，它还包含了一个param的变量，值是"param value".请注意name变量的修饰符是public。

然后我们打开flex的项目属性，在附加的编译器参数中增加

-keep-as3-metadata+=MyMetadata

这句的作用是告诉编译器，除了flex自带的metadata，我们自定义的MyMetadata也需要被使用。因此这里是+=，如果你写成了=，那flex自带的metadata将被忽略。

值得注意的是，当我使用flexSDK4.0以上版本时，即使不添加上面的编译器参数，仍然可以正常工作。

那到这里，我们如何使用自定义的Metadata呢。请看我们在TestClass构造函数中添加的的代码：

public function TestClass()
{
    var xml:XML = flash.utils.describeType(this)
    trace(xml.toXMLString())
}

describeType方法可以将一个类实例的所有公共非静态成员取出来（因此我们设name属性是public的）， 存在一个XML中。如果你需要取出静态成员，可以传入类本身（比如本例中的TestClass）而非类的实例。在项目启动的类里new一个 TestClass，使其构造函数能执行（如果你是一个flash项目而非flex项目，请在发布设置中勾选导出swc，不然无法获得metadata信 息），运行时将打印如下信息到控制台：

<type name="TestClass" base="Class" isDynamic="true" isFinal="true" isStatic="true">
  <extendsClass type="Class"/>
  <extendsClass type="Object"/>
  <accessor name="prototype" access="readonly" type="*" declaredBy="Class"/>
  <factory type="TestClass">
    <extendsClass type="Object"/>
    <variable name="name" type="String">
      <metadata name="MyMetadata">
        <arg key="param" value="param value"/>
      </metadata>
      <metadata name="__go_to_definition_help">
        <arg key="file" value="E:\study\CustomizeMetatag\src\TestClass.as"/>
        <arg key="pos" value="125"/>
      </metadata>
    </variable>
    <metadata name="__go_to_ctor_definition_help">
      <arg key="file" value="E:\study\CustomizeMetatag\src\TestClass.as"/>
      <arg key="pos" value="157"/>
    </metadata>
    <metadata name="__go_to_definition_help">
      <arg key="file" value="E:\study\CustomizeMetatag\src\TestClass.as"/>
      <arg key="pos" value="50"/>
    </metadata>
  </factory>
</type>

大家可以看到，8-10行是我们自定义的metadata的完整描述，它处于name变量的子节点，表示它作用于name属 性。这意味着我们可以在运行时获得metadata的信息。在我们这个例子中metadata貌似没有任何实际的作用，但metadata的信息可以帮助 我们完成一些有趣的事情，比如看下面这个：

[ClickEvent(target="this.button",event="flash.events.MouseEvent.CLICK")]
public function clickEventHandler(event:MouseEvent):void
{
}

不在这个类中添加任何事件侦听，让clickEventHandler方法也能相应button的CLICK事件，大家想想怎么去实现吧。