C#中类型“object”带你一路走单骑

2017-09-26 本文已影响7人 Brent姜

前两天写的一个GUI程序Entity Model Creator，可以从XML文件读取程序数据结构模型，并在界面上添加和编辑字段类型和结构类型，然后再回写到XML模型文件中。
实现这个程序需要对XML文件所描述的数据结构定义方式进行meta分析，并定义一套对应的Classes。

其中有一个逻辑是meta类对象的Clone功能，这是为了便于在输出XML模型时的预处理，删除某些字段或结构中不相干的属性（因为meta类型会为每一个字段定义所有的属性字段），但又不影响原来正在GUI界面编辑的模型对象。

clone的时候，需要对模型以及内部包含的结构和字段进行一些额外的处理，clone函数提供了customAction回调参数（就是C=的delegate），这个delegate的参数是object。

最初这个参数类型是各个层次特定的类，但是这就导致无法在顺序Clone嵌套内部列表对象时将customAction传入。

而将其改为object，就解决了这个问题。

上代码。

原始模型

代码功能背景说明

使用XML定义数据模型，再通过xslt就可以自动生成C#、C++代码，便于在C#客户端和C++服务器之间交互数据。此处仅介绍XML内容，xslt自动生成代码暂且不表。

应用模型XML文件

以书籍管理程序为例，需要管理书籍和文章两个层次的数据内容。所以定义了Book和BookNote两个对应的类。

<?xml version="1.0" encoding="gb2312"?>
<EntityModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Entities>
    <Entity name="Book" title="书籍" description="一本书籍" isPartial="true" supportClone="true">
      <Field name="ID" />
      <Field name="Title" />
      <Field name="Author" />
      <Field name="Introduction" />
      <Field name="Tags" />
    </Entity>
    <Entity name="BookNote" title="文章" description="一个章节" isPartial="false" supportClone="true">
      <Field name="ID" />
      <Field name="Tags" />
      <Field name="Title" />
      <Field name="DetailTitle" />
      <Field name="Content" />
    </Entity>
  </Entities>
  <Fields>
    <Field name="ID" type="String" length="100" label="唯一编号" description="主键" />
    <Field name="Author" type="String" length="100" label="作者" description="作者的姓名" />
    <Field name="Tags" type="String" length="-1" label="标签" description="逗号分隔的标签列表" />
    <Field name="Title" type="String" length="100" label="标题" description="书籍或文章的标题" />
    <Field name="DetailTitle" type="String" length="100" label="标题" description="副标题" />
    <Field name="Introduction" type="String" length="-1" label="简介" description="" />
    <Field name="Content" type="String" length="-1" label="正文" description="" />
  </Fields>
</EntityModel>

其中，type字段支持String、Bool、Object、Int、List、Double、EnumChar等类型。EnumChar类型可以嵌套定义Char类型的多个枚举变量，下面的meta模型中会对此进行meta定义。
Entity的属性中，基本字如其名。需要特别说明的是：

“isPartial”表示从XSLT生成的类是否是partial类。使用partial类可以为自动化生成代码提供很多便利，方便自动化生成代码中类结构的扩展。
“supportClone”指示XSLT生成代码中是否为该Entity类添加Clone()。

meta XML模型

从上述模型中，提炼出meta XML模型。
使用“type”在C#的XSLT解析中会导致异常（属于内部关键字？），所以我对从XML读入的内容进行了预处理，将“type”定义为“mytype”。在输出XML之前进行恢复即可。

<?xml version="1.0" encoding="gb2312"?>
<EntityModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Entities>
    <Entity name="EntityModel" title="实体模型库" description="包含实体和字段列表" xsltMetaName="EntityModel" isPartial="true">
      <Field name="Entities" />
      <Field name="Fields" />
    </Entity>
    <Entity name="Entity" title="实体模型" description="" xsltMetaName="Entity" isPartial="true">
      <Field name="name" xsltMetaAttribute="true" />
      <Field name="title" xsltMetaAttribute="true" />
      <Field name="description" xsltMetaAttribute="true" />
      <Field name="isPartial" xsltMetaAttribute="true" />
      <Field name="EntityFields" xsltMetaAttribute="false" />
      <Field name="xsltMetaName" xsltMetaAttribute="true" />
    </Entity>
    <Entity name="Field" title="实体字段" description="" xsltMetaName="Field" isPartial="true">
      <Field name="name" xsltMetaAttribute="true" />
      <Field name="mytype" xsltMetaAttribute="true" />
      <Field name="length" xsltMetaAttribute="true" />
      <Field name="label" xsltMetaAttribute="true" />
      <Field name="description" xsltMetaAttribute="true" />
      <Field name="entity" xsltMetaAttribute="true" />
      <Field name="listContainer" xsltMetaAttribute="true" />
      <Field name="isPartial" xsltMetaAttribute="true" />
      <Field name="FieldEnums" xsltMetaAttribute="false" />
      <Field name="supportClone" xsltMetaAttribute="true" />
    </Entity>
    <Entity name="FieldDelegate" title="代理实体字段" description="" xsltMetaName="FieldDelegate" isPartial="true">
      <Field name="name" xsltMetaAttribute="true" />
    </Entity>
  </Entities>
  <Fields>
    <Field name="myvalue" type="String" length="-1" label="枚举量的值" description="" />
    <Field name="length" type="Int" length="0" label="字符串长度" description="用于定义字符串类型字段的字符串长度" />
    <Field name="title" type="String" length="30" label="标题" description="Entity标题" />
    <Field name="name" type="String" length="30" label="唯一名字" description="字段或模型的唯一名字" />
    <Field name="label" type="String" length="100" label="标签" description="字段或模型标题" />
    <Field name="description" type="String" length="-1" label="描述" description="详细描述" />
    <Field name="mytype" type="String" length="10" label="字段类型" description="字段类型. 这里把type定义为mytype是因为XmlSerializer不支持将type属性拿来普通使用" defaultValue="&quot;String&quot;" />
    <Field name="metatype" type="EnumChar" length="10" label="字段类型的元类型" description="字段类型的元类型，用于meta管理">
      <enum name="Bool" value="B" label="Bool" />
      <enum name="Int" value="I" label="Int" />
      <enum name="String" value="S" label="String" />
      <enum name="EnumChar" value="E" label="EnumChar" />
      <enum name="Double" value="D" label="Double" />
      <enum name="List" value="L" label="List" />
      <enum name="Object" value="O" label="Object" />
    </Field>
    <Field name="supportClone" type="Bool" label="支持克隆操作" description="如果支持克隆，则可以随父对象在Clone操作时进行深层次拷贝。仅当mytype为Object且entity类型填入时有效。" nullNoneOutput="true" defaultValue="CommonUtil.FALSE_BYTE" />
    <Field name="Entities" type="List" listContainer="ObservableCollection" entity="FfsEntity" label="模型实体类组" description="实体类的列表" />
    <Field name="Fields" type="List" listContainer="ObservableCollection" entity="FfsField" label="模型字段类组" description="字段类的列表" apiExclude="true" metaViewExtended="true" />
    <Field name="FieldEnums" type="List" listContainer="ObservableCollection" entity="FfsEnum" label="枚举类组" description="枚举类型的列表" metaViewExtended="true" xsltArrayAsElement="enum" />
    <Field name="EntityFields" type="List" listContainer="ObservableCollection" entity="FfsFieldDelegate" label="实体的字段类组" description="实体的字段列表" xsltArrayAsElement="FieldDelegate" />
    <Field name="entity" type="String" length="50" label="实体类名称" description="Object、List类型对象的实体类名称" nullNoneOutput="true" defaultValue="string.Empty" />
  </Fields>
</EntityModel>

可以看出meta模型比较复杂一些。其中Field的一些属性：

“entity”属性表示Object类型的具体类型名称；
“listContainer”表示List类型的具体容器类型名称；
“nullNoneOutput”用于表示若为默认值或null时则不输出相应的标签；
“xsltArrayAsElement”用于表示EnumChar类型的枚举量直接作为XML父元素的内部项，不再用root element of array。
“defaultValue”用于定义字段默认值。
Entity的一些属性：
“xsltMetaName”定义输出XML内容时Element的名称；
Entity内部的Field的属性：
“xsltMetaAttribute”表示这个内部Field在输出时表示为Attribute而不是Element。

这里需要说明的是Entity内部的Field和EntityModel直属的Field是不一样的。为此，在预处理的时候，将前者重命名为FieldDelegate，以此与后者做区分。

C#管理工具代码

自动生成的模型类中的Clone(）

public Entity Clone(Action<object, object> customAction)
{
    var newitem = new FfsEntity();
    newitem.Update(this, true, customAction);
    return newitem;
}
public void Update(FfsEntity other, bool notifyAll, Action<object, object> customAction)
{
    ...
    this.isPartial = other.isPartial;
    this.EntityFields.Clear();// = new ObservableCollection<FfsFieldDelegate>();
    var tempEntityFields = new List<FieldDelegate>();
    foreach (var item in other.EntityFields)
    {
        var newitem = item.Clone(customAction);
        tempEntityFields.Add(newitem);
    }
    this.EntityFields.AddRange(tempEntityFields);
    this.xsltMetaName = other.xsltMetaName;
    if(customAction != null) {
        customAction(other, this);
    }
    if(notifyAll){
        NotifyPropertyChanged("");
    }
}

在外部

public static partial class FfsStatic
{

    public static void customActionCloneEntityModel(object from, object to)
    {
        if (from == null || to == null)
            return;
        if (from is Entity && to is Entity)
        {
            (to as Entity).IsChecked = (from as Entity).IsChecked;
        }
        else if (from is Field && to is Field)
        {
            (to as Field).IsChecked = (from as Field).IsChecked;
        }
        if (from is FieldDelegate && to is FieldDelegate)
        {
            (to as FieldDelegate).IsChecked = (from as FieldDelegate).IsChecked;
        }
    }
}

此处的“IsChecked”属性是在自定义的partial类中为各个模型类添加的额外的属性，所以自动生成的Clone(）代码中无法拷贝该属性。需要在customAction中为各个类型进行额外的处理。这里就是object类型解决问题的地方了。