你的位置:首页 > ASP.net教程

[ASP.net教程]XSD文件生成C#VO实体类


  最近公司要做一个项目,需要和现有的其他项目对接,由于不知道他们的数据库,只有XSD文件。所以,我们在修改相应的程序时,就需要根据他们提供的XSD文件,来写我们的VO实体类,由于我写过根据Oracle数据库生成VO实体类,因此这次的这个活也就很自然的落在了我的头上。

一、XSD

  首先什么是XSD,我就不解释了,因为我也不是很清楚,第一次接触,具体的详解度娘一下很多,XSD是

二、解析的XSD文件

  我要解析的XSD文件是如下这个样子的,大家可以看到这个这个文件还需要加载两个xsd文件,但是通过我们的分析,对于我们这个项目来说,如果要生成实体类,除了需要解析下面这个图示XSD以外,还需要解析一个type类型xsd,也就是图中include的第二个xsd文件。

要解析的XSD

  先来看看上面这个VO实体类文件,通过截图,可以看出来,这个是一个VO实体类包含了好多个字段,但是每个字段的type又没有表示出来,因此需要到下面这个截图的xsd里去寻找,因为下图中的name对应着上图中的type,而下图中的base正是我们需要的字段类型。

<xs:simpleType name="acbfyhdcbfyze">    <xs:annotation>      <xs:documentation>按成本费用核定成本费用总额</xs:documentation>    </xs:annotation>    <xs:restriction base="xs:double"/>  </xs:simpleType>  <xs:simpleType name="acbfyhdhdlrl">    <xs:annotation>      <xs:documentation>按成本费用核定核定的利润率</xs:documentation>    </xs:annotation>    <xs:restriction base="xs:double"/>  </xs:simpleType>  <xs:simpleType name="acbfyhdhsdsre">    <xs:annotation>      <xs:documentation>按成本费用核定换算的收入额</xs:documentation>    </xs:annotation>    <xs:restriction base="xs:double"/>  </xs:simpleType>  <xs:simpleType name="acbfyhdynssde">    <xs:annotation>      <xs:documentation>按成本费用核定应纳税所得额</xs:documentation>    </xs:annotation>    <xs:restriction base="xs:double"/>  </xs:simpleType>

基础XSD

三、分析和解析

  通过分析上面的两个文件,由于要生成实体类文件,因此要解析的文件需要读取成功以后,生成一个List列表,而基础XSD则应该解析成一个Dictionary,而这个Dictionary中只需要包含name和base,然后通过循环List列表,依次进Dictionary中进行相应的替换,就可以得到字段的类型,从而生成一个最终需要的List集合。

有了分析以后,那就是付诸实践了,首先要能解析XSD文件,解析XSD和解析

  1、根据节点设置静态字段,方便在解析的时候进行调用

public static class ConstField  {    public const string Schema = "xs:schema";    public const string ComplexType = "xs:complexType";    public const string Element = "xs:element";    public const string Annotation = "xs:annotation";    public const string Documentation = "xs:documentation";    public const string Sequence = "xs:sequence";    public const string SimpleType = "xs:simpleType";    public const string Restriction = "xs:restriction";  }

静态字段

  2、写一个实体类,其中包含name(字段名),type(字段类型),note(注释),为了生存List时用

public class AnalysisVo  {    private string name;    private string note;    private string type;    private List<AnalysisVo> children;    /// <summary>    /// 名称    /// </summary>    public string Name    {      get      {        return name;      }      set      {        name = value;      }    }    /// <summary>    /// 备注    /// </summary>    public string Note    {      get      {        return note;      }      set      {        note = value;      }    }    /// <summary>    /// 类型    /// </summary>    public string Type    {      get      {        return type;      }      set      {        type = value;      }    }    /// <summary>    /// 子集    /// </summary>    public List<AnalysisVo> Children    {      get      {        return children;      }      set      {        children = value;      }    }  }

实体类

  3、解析XSD文件

public void Analysis()    {      = _document.DocumentElement;//获取根节点      //获取complexType子节点集合      foreach (in complexTypeNodes)      {        AnalysisVo vo = new AnalysisVo();        = (string nameVo = voElement.GetAttribute("name");//获取类的名字        string noteVo = voElement.FirstChild.InnerText;//获取类的注释        List<AnalysisVo> childrenList = new List<AnalysisVo>();        = voElement.GetElementsByTagName(ConstField.Element);//获取element子节点集合        foreach (in elementNodes)        {          AnalysisVo childVo = new AnalysisVo();          = (string nameField = fieldElement.GetAttribute("name");//获取字段名字          string typeField = fieldElement.GetAttribute("type");//获取字段类型          string noteField = ""; //获取字段注释          if(fieldElement.FirstChild!=null)            noteField= fieldElement.FirstChild.InnerText;          childVo.Name = nameField;          childVo.Type = typeField;          childVo.Note = noteField;          childrenList.Add(childVo);        }        vo.Name = nameVo;        vo.Note = noteVo;        vo.Children = childrenList;        VoList.Add(vo);      }         }    

解析实体类XSD文件
public void Analysis()    {      = _document.DocumentElement;//获取根结点      //获取simpleType子节点集合      foreach(in simpleTypeNodes)      {        = (string dicKey = dicElement.GetAttribute("name");//获取类型名字        string dicValue = (("base");//获取类型内容        dicValue = dicValue.Replace("xs:", "");        DicType.Add(dicKey, dicValue);      }    }

解析Type类型XSD

  4、将以上得到的两个文件进行整合,从而生成一个最终的List文件

private void ReplaceContent(AnalysisVo node)    {      //正常在基础的字段表中存在      if (DicType.ContainsKey(node.Type))      {        node.Type = DicType[node.Type];      }//要解析的里面没有type字段,只有name字段  yanc 20160304            else if (string.IsNullOrEmpty(node.Type) && DicType.ContainsKey(node.Name))      {        node.Type = DicType[node.Name];      }      else//List类型的没有存储在基础的字段表中,需要循环遍历本身的List列表        if(!string.IsNullOrEmpty(node.Type)&&(node.Type.Substring(node.Type.Length - 4, 4).Equals("Grid") || node.Type.Substring(node.Type.Length - 4, 4).Equals("List")))      {        foreach (var root in VoList)        {          if (root.Name.Equals(node.Type))          {            node.Type = root.Children.First().Type;          }        }      }//要解析的里面没有type字段,只有name字段  yanc 20160304      else if(string.IsNullOrEmpty(node.Type) && (node.Name.Substring(node.Name.Length - 4, 4).Equals("Grid") || node.Name.Substring(node.Name.Length - 4, 4).Equals("List")))      {        foreach (var root in VoList)        {          if (root.Name.Equals(node.Name))          {            node.Type = root.Children.First().Name;          }        }      }      else      {        Console.WriteLine("未能转化的内容" + node.Name);      }    }

View Code

  在替换的过程中,会有一种情况,即一个实体类中包含List<>泛型集合,我相信大家在开发过程中,见过这种情况,因此,在替换的时候,需要判断一下,通过我们的分析,一般这种的字段type是在基础类中找不到的,而是在当前的文件中进行查找,因此,当遇到的时候,还需要再次循环一遍自身集合,从而找到实体集合,将他的Name属性赋值给当前的Type字段。

四、生成CS文件

  最后一步,就是生成CS文件了,和我上一篇文章大同小异,不过有一点需要注意,因为数据库生成的实体类是没有List类型的,但是这个XSD生成的有,因此需要稍加变动一下生成方法。

注:以上解析方法,同样适用于下图的一般request和response文件,特殊的需要另当处理。

 五、Demo效果图

 代码在GitHub上,希望大家一起帮忙修改,毕竟foreach嵌套foreach效率不是很高。