有许多不同的方法可用于捕获XML模型数据并且把它放到一个数据存储中,正如你所期望的,包括使用XSLT技术。但是我想使用一种不同的方法-使用C#语言。XSLT是一个用于改变XML文件的好选择,但是对于更广阔的不仅仅是转变数据的应用软件来说,C#或者另外的象Java这样的高级语言提供了更大的灵活性。
在本文中,我将展示如何通过使用XMI和C#来剖析一个UML发布图。首先,我展示一个该方法的简单的发布图,所在环境为一个虚构的汽车出租公司并使用 C#来捕获一些数据。这种数据可以被容易地加到一个数据库(它已经是ADO调用的相当容易的一部分)上去或者作为更大些的一个基于资产的管理系统的一部分。在每一个示例中,我将逐渐增加原始图和能够获取的信息的复杂性。
一、 示例1-查找方法的名字
我要做的第一件事情是捕获来自于汽车出租公司的所有方法的名字。共有五个方法,它们是以UML发布图形描述的(见图1)。在上一篇文章中,我展示了如何用一个XML文档来描述一个发布图。为此,首先要创建该图,然后把它输出到一个XMI文件(企业架构)或解压(MagicDraw)。(在这篇文章中,我再次使用了SparxSystems.com提供的企业架构。)
图1.五个方法:图中结点描述了汽车出租公司的方法。每一个结点为一个方法名字。
我将首先开发一简单main程序-它提示用户输入描述一个有效的XMI文档的XML文档的名字。一旦输入文件名字,它就被传递到一个分析XMI文档的对象并打印输出方法名字。
using System;
using System.Text;
namespace XMI_1{
public class ConsoleUtils{
public static string ReadString(string msg) {
Console.Write(msg); return System.Console.ReadLine();
}
public static void WriteString(string msg)
{ System.Console.WriteLine(msg); }
public static void Main(string[] args) {
string name = ReadString("Please enter the XMI filename : ");
NodeParse np = new NodeParse(name);
System.Console.ReadLine();
}
}
}
下一步是分析XMI文档。为此,我必须创建一个XMLTextReader的实例并循环操作直到没有结点为止。XMLNodeType.Element 检查每一个XML元素并且在元素是一个结点的情况下把它打印输出到控制台。该元素名字资格为"UML:Node",然而通过使用 _readXMI.LocalName只有元素名字的"Node"被读取。详细代码参见列表1。
二、 示例2-增加模板
第二个示例重构了第一个示例来捕获方法的名字和"pc server"模板-这是一个用来决定每个结点是一个方法的UML方法。图3显示增加了模板后的方法的发布图。
第一步是修改前面的代码以识别新的模板来操纵AddNode()方法。
图3.增加了模板之后:每个模板描述了结点的类型-不管它是一个PC服务器,PC客户端或者是另外一些描述该结点的目标。
private void AddNode(XmlTextReader p_readXMI)
{
string nodeID;
string nodeName;
string stereotypeName;
nodeID = p_readXMI.GetAttribute("name");
nodeName = p_readXMI.GetAttribute("xmi.id");
Console.Write(nodeID);
Console.Write(" -> ");
Console.WriteLine(nodeName);
while (p_readXMI.Read() && (p_readXMI.NodeType == XmlNodeType.Element ||
p_readXMI.NodeType== XmlNodeType.Whitespace))
{
switch (p_readXMI.LocalName)
{
case "ModelElement.stereotype":
while (p_readXMI.Read() && (p_readXMI.NodeType == XmlNodeType.Element ||
p_readXMI.NodeType == XmlNodeType.Whitespace))
{
if (p_readXMI.LocalName == "Stereotype")
{
stereotypeName = p_readXMI.GetAttribute("name");
Console.WriteLine("Stereotype = " + stereotypeName);
}
}
break;
}
}
}
特别要注意的是一个idiom(对某个语言特有的一个低级别的模式)-我用来查找在另外一些元素内部的XML元素。我在p_readXMI.Read循 环中增加了代码来检查元素或者空格(在XML文档中,这是些空格字符)。只有每个元素结点在XML文档中适当的层次上处理时,这个idiom才工作。
用这种方式对元素进行封装,结果不很理想。例如,在下面的UML中使用idiom代码将产生所不希望的结果:
第一个元素被作为一个结点处理,第二个元素被忽略并在初始循环中退出,而第三个元素被作为在同一级上的第一个正常结点处理。为了修正这个问题,你可以使 用XMLNodetype.Endelement来检查元素的结束标签。在本文中,这不是个问题而保存额外的代码要求检查结尾元素。
XMI中的模板被封装在结点元素中。该示例中的代码检查名字为"ModelElement.Stereotype"的元素并且使用刚才讨论的相同的idiom来处理一个"模板"类型的封装元素,然后把它打印输出到屏幕上(见图4)。(列表3列出了示例2的完全的源码。)
三、 示例3-添加硬件信息
从资产管理的角度来看,捕获方法的名字和它们的模板并没有多大用处。当然,另一方面,如果你的图包含了描述正在使用的硬件信息也可能是非常有用的:例如,基于UML发布图把你所有的硬件保存到一个数据库将能够使你跟踪方法、客户及其如何进行彼此联系的。
在UML中,硬件结点都贴有用来识别它们属性的"标签"。每一个标签都是在建模工具(这里是企业架构)中产生而且由建模器所定义(或者有时保存成一个 UML剖面文件)。在本示例中,我为CPU、磁盘大小、内存大小、目的、注意事项以及卖主等创建了标签(见图5)。每个标签具有一个值-或者被赋予一个基 本类型(字符串,整型……)或者从一个可用值列表中选择其一。无论如何,保持与所用值的一致性是很重要的。如果你把"GHT"用于CPU以描述 "gigahertz hyper-threaded",那么对每个CPU标签,你都要使用相同的约定。
新的重构的代码与以前的一样,但是增加了读取标签的代码。在此,XMI并没有如你所盼的那样封装结点内的标签。作为代替,每个属性是一个 "TaggedValue"元素-它通过使用"modelElement"属性来参考引用属性的结点标识符(XML.id)。这样做的困难在于结点元素必 须在标签元素之前被读取,并且每个结点元素必须被保存-为使标签元素依附于其上。
在XML中,存在两种读取文档的方法。第一种是读取 完整的文档并把它以一棵树保存到内存中-这里每个元素是从根元素开始构建的层次结构的一部分。这就是DOM模型,是较佳的适用于小型文档的方法。第二种方 法是,读取文档时,每次分析一个元素。SAX就是这种方法的一个示例并且它被当作推模型,因为由它分析文档并返回分析后的文档(推它)而不需要提示。
另外一种方法是微软的XMLReaders(XMLTextReader派生于它)-它是一个拉模型,因为当下一个元素被分析时,控制掌握在程序中。我 在此使用的XML文档很小,但是我分析过的一些文件是超过了500,000行的文本文件,这导致我求助于XMLReader方法。这种方法的一个不足是要 求结点应出现在标签元素之前。
为了保存结点我需要使用一个键/值容器。最易于使用的是Hashtable。在重构主程序中(见下),我使用了Hashtable中的枚举能力以及用IDictionary枚举器来打印方法结点。
我重构了nodeParse对象以用于检查元素"TaggedValue"并且调用AddAttributeNode-它负责在哈希表中查找正确的结点并且通过一个case语句把标签添加到该结点上。相应的类NodeParse显示于列表4中。
这个结点类仅仅是一个存储状态的对象。每一个标签都有它自己的属性。注意,这个结点类的构造器要求该对象必须用服务器名字初始化。
我并没有提供示例3和输出结果,因为它几乎和示例4的完全相同。(列表5列出了示例3的完整的源代码。)
四、 示例4-添加继承
在最后的示例中,我从一个Node类继承了结点实例。以前,我们每次只分析一个结点并对其进行遍历。Node实例描述了存在于UML结点和硬件之间的关系。Nodes给了我们一种从实例中抽象出公共元素的方法。
为此,有两种不同的方法。第一种方法是使用Nodes来描述一个通用硬件平台。可以设想这样的情形:我为一家公司工作,该公司想针对它们所有的方法(多 么奇怪!)订购相同的计算机配置。可以用一个结点来描述典型的计算机配置,然后该结点又会有多个结点实例。这将节省大量的输入时间!另外一种方法是在软件 架构师通知基础构件小组怎样分发组件的情形。该结点用针对于每个层的本地名字来描述不同的层。至于这些如何映射到实际的硬件是由结点实例所决定的而且由基 础构件小组所创建。
在该示例中(见图6),我展示了一个通用结点-"Fleet Management",它具有可以添加到它上面的组件。在一个多层系统中,Fleet Management是由软件架构师来定义成一个分离的层。为了说明问题,我可能还要应用"Purpose"标签。我有两个结点实例,"Trucks"和 "Persons",它们由基础构件小组来定义以把该层分成两个方法。既然"Trucks"和"Persons"是完全不同的两个域,那么架构师介入其中 并分解之是十分安全的。方法名字上还标记有":Fleet Management",以指明它们是在Fleet Management结点中实现的。
在这个示例中,没有用于继承的标签,但是可能在另外的图上存在一些其它关系-它们会连接到该结点实例上。
我又一次重构了main程序以打印出所有的,包括每一个结点实例派生的(tNode.classname)结点标签,还有结点的ID(tNode.classifier)。
类名和类标志符指明该结点实例继承自哪些结点。在XMI中,这是被象一个模板(就象一个封装在结点元素中的元素)一样描述的。
现在我将使用一个开关语句来检查"ModelElement.taggedValue",而代之以ModelElement.Stereotype,查 找"TaggedValue"元素(存在类名和类标志符上皆独立的元素),并把它们添加到结点对象上。在此,我再次使用了分析idiom。这些代码可以在 列表3中找到。
图7.Trucks和Persons:示例4的最后输出,Trucks和Persons各有一个它们可以参考的结点并且每个结点都有一个唯一的ID。
图7显示示例4最后的输出。
五、 总结
在本文中,我将展示如何通过使用XMI和C#来剖析一个UML发布图。首先,我展示一个该方法的简单的发布图,所在环境为一个虚构的汽车出租公司并使用 C#来捕获一些数据。这种数据可以被容易地加到一个数据库(它已经是ADO调用的相当容易的一部分)上去或者作为更大些的一个基于资产的管理系统的一部分。在每一个示例中,我将逐渐增加原始图和能够获取的信息的复杂性。
一、 示例1-查找方法的名字
我要做的第一件事情是捕获来自于汽车出租公司的所有方法的名字。共有五个方法,它们是以UML发布图形描述的(见图1)。在上一篇文章中,我展示了如何用一个XML文档来描述一个发布图。为此,首先要创建该图,然后把它输出到一个XMI文件(企业架构)或解压(MagicDraw)。(在这篇文章中,我再次使用了SparxSystems.com提供的企业架构。)
图1.五个方法:图中结点描述了汽车出租公司的方法。每一个结点为一个方法名字。
我将首先开发一简单main程序-它提示用户输入描述一个有效的XMI文档的XML文档的名字。一旦输入文件名字,它就被传递到一个分析XMI文档的对象并打印输出方法名字。
using System;
using System.Text;
namespace XMI_1{
public class ConsoleUtils{
public static string ReadString(string msg) {
Console.Write(msg); return System.Console.ReadLine();
}
public static void WriteString(string msg)
{ System.Console.WriteLine(msg); }
public static void Main(string[] args) {
string name = ReadString("Please enter the XMI filename : ");
NodeParse np = new NodeParse(name);
System.Console.ReadLine();
}
}
}
下一步是分析XMI文档。为此,我必须创建一个XMLTextReader的实例并循环操作直到没有结点为止。XMLNodeType.Element 检查每一个XML元素并且在元素是一个结点的情况下把它打印输出到控制台。该元素名字资格为"UML:Node",然而通过使用 _readXMI.LocalName只有元素名字的"Node"被读取。详细代码参见列表1。
二、 示例2-增加模板
第二个示例重构了第一个示例来捕获方法的名字和"pc server"模板-这是一个用来决定每个结点是一个方法的UML方法。图3显示增加了模板后的方法的发布图。
第一步是修改前面的代码以识别新的模板来操纵AddNode()方法。
图3.增加了模板之后:每个模板描述了结点的类型-不管它是一个PC服务器,PC客户端或者是另外一些描述该结点的目标。
private void AddNode(XmlTextReader p_readXMI)
{
string nodeID;
string nodeName;
string stereotypeName;
nodeID = p_readXMI.GetAttribute("name");
nodeName = p_readXMI.GetAttribute("xmi.id");
Console.Write(nodeID);
Console.Write(" -> ");
Console.WriteLine(nodeName);
while (p_readXMI.Read() && (p_readXMI.NodeType == XmlNodeType.Element ||
p_readXMI.NodeType== XmlNodeType.Whitespace))
{
switch (p_readXMI.LocalName)
{
case "ModelElement.stereotype":
while (p_readXMI.Read() && (p_readXMI.NodeType == XmlNodeType.Element ||
p_readXMI.NodeType == XmlNodeType.Whitespace))
{
if (p_readXMI.LocalName == "Stereotype")
{
stereotypeName = p_readXMI.GetAttribute("name");
Console.WriteLine("Stereotype = " + stereotypeName);
}
}
break;
}
}
}
特别要注意的是一个idiom(对某个语言特有的一个低级别的模式)-我用来查找在另外一些元素内部的XML元素。我在p_readXMI.Read循 环中增加了代码来检查元素或者空格(在XML文档中,这是些空格字符)。只有每个元素结点在XML文档中适当的层次上处理时,这个idiom才工作。
用这种方式对元素进行封装,结果不很理想。例如,在下面的UML中使用idiom代码将产生所不希望的结果:
<UML:Node name="Leasing"> <UML:TagName name="Test"> </UML:Node name="SmallLeasing"> </UML:TagName> </UML:Node> |
图4.示例2的输出结果:在示例1中的结点名字/id之后,列出每个模板。 |
第一个元素被作为一个结点处理,第二个元素被忽略并在初始循环中退出,而第三个元素被作为在同一级上的第一个正常结点处理。为了修正这个问题,你可以使 用XMLNodetype.Endelement来检查元素的结束标签。在本文中,这不是个问题而保存额外的代码要求检查结尾元素。
XMI中的模板被封装在结点元素中。该示例中的代码检查名字为"ModelElement.Stereotype"的元素并且使用刚才讨论的相同的idiom来处理一个"模板"类型的封装元素,然后把它打印输出到屏幕上(见图4)。(列表3列出了示例2的完全的源码。)
三、 示例3-添加硬件信息
从资产管理的角度来看,捕获方法的名字和它们的模板并没有多大用处。当然,另一方面,如果你的图包含了描述正在使用的硬件信息也可能是非常有用的:例如,基于UML发布图把你所有的硬件保存到一个数据库将能够使你跟踪方法、客户及其如何进行彼此联系的。
在UML中,硬件结点都贴有用来识别它们属性的"标签"。每一个标签都是在建模工具(这里是企业架构)中产生而且由建模器所定义(或者有时保存成一个 UML剖面文件)。在本示例中,我为CPU、磁盘大小、内存大小、目的、注意事项以及卖主等创建了标签(见图5)。每个标签具有一个值-或者被赋予一个基 本类型(字符串,整型……)或者从一个可用值列表中选择其一。无论如何,保持与所用值的一致性是很重要的。如果你把"GHT"用于CPU以描述 "gigahertz hyper-threaded",那么对每个CPU标签,你都要使用相同的约定。
图5.示例2的增加硬件到方法/模板图,我添加了描述每个结点的硬件的标签。我把一个客户添加到示例"Mary Machine"来说明还有一个"pc client"模板。 |
新的重构的代码与以前的一样,但是增加了读取标签的代码。在此,XMI并没有如你所盼的那样封装结点内的标签。作为代替,每个属性是一个 "TaggedValue"元素-它通过使用"modelElement"属性来参考引用属性的结点标识符(XML.id)。这样做的困难在于结点元素必 须在标签元素之前被读取,并且每个结点元素必须被保存-为使标签元素依附于其上。
在XML中,存在两种读取文档的方法。第一种是读取 完整的文档并把它以一棵树保存到内存中-这里每个元素是从根元素开始构建的层次结构的一部分。这就是DOM模型,是较佳的适用于小型文档的方法。第二种方 法是,读取文档时,每次分析一个元素。SAX就是这种方法的一个示例并且它被当作推模型,因为由它分析文档并返回分析后的文档(推它)而不需要提示。
另外一种方法是微软的XMLReaders(XMLTextReader派生于它)-它是一个拉模型,因为当下一个元素被分析时,控制掌握在程序中。我 在此使用的XML文档很小,但是我分析过的一些文件是超过了500,000行的文本文件,这导致我求助于XMLReader方法。这种方法的一个不足是要 求结点应出现在标签元素之前。
为了保存结点我需要使用一个键/值容器。最易于使用的是Hashtable。在重构主程序中(见下),我使用了Hashtable中的枚举能力以及用IDictionary枚举器来打印方法结点。
public static void Main(string[] args){ Hashtable mainHash; IDictionaryEnumerator ienum; Node tNode; string name = ReadString("Please enter the XMI filename : "); NodeParse np = new NodeParse(name); mainHash = np.getNodes(); ienum = mainHash.GetEnumerator(); while (ienum.MoveNext()) { tNode = (Node)ienum.Value; System.Console.WriteLine("Node ="+tNode.name+" CPU= "+tNode.CPU); } System.Console.ReadLine(); } |
我重构了nodeParse对象以用于检查元素"TaggedValue"并且调用AddAttributeNode-它负责在哈希表中查找正确的结点并且通过一个case语句把标签添加到该结点上。相应的类NodeParse显示于列表4中。
这个结点类仅仅是一个存储状态的对象。每一个标签都有它自己的属性。注意,这个结点类的构造器要求该对象必须用服务器名字初始化。
using System; using System.Text; namespace XMI_1 { class Node{ string _name,_id = "",_CPU,_MemorySize,_DiskSize,_Note,_Purpose, _Stereotype,Vendor; public Node(string p_id) {this._name = p_id;} public string id {get { return _id;} public string name{get {return _name;} set {_name = value;}} public string CPU {get { return _CPU;} set {_CPU = value;}} public string MemorySize{get {return _MemorySize;} set {_MemorySize = value;}} public string DiskSize {get {return _DiskSize;}set {_DiskSize = value;}} public string Notes{get {return _Notes;}set {_Notes = value;}} public string Purpose{get {return _Purpose;} set {_Purpose = value;}} public string Stereotype {get {return _Stereotype;} set {_Stereotype = value;}} public string Vendor {get {return _Vendor;} set {_Vendor = value;}} } } |
我并没有提供示例3和输出结果,因为它几乎和示例4的完全相同。(列表5列出了示例3的完整的源代码。)
四、 示例4-添加继承
在最后的示例中,我从一个Node类继承了结点实例。以前,我们每次只分析一个结点并对其进行遍历。Node实例描述了存在于UML结点和硬件之间的关系。Nodes给了我们一种从实例中抽象出公共元素的方法。
为此,有两种不同的方法。第一种方法是使用Nodes来描述一个通用硬件平台。可以设想这样的情形:我为一家公司工作,该公司想针对它们所有的方法(多 么奇怪!)订购相同的计算机配置。可以用一个结点来描述典型的计算机配置,然后该结点又会有多个结点实例。这将节省大量的输入时间!另外一种方法是在软件 架构师通知基础构件小组怎样分发组件的情形。该结点用针对于每个层的本地名字来描述不同的层。至于这些如何映射到实际的硬件是由结点实例所决定的而且由基 础构件小组所创建。
在该示例中(见图6),我展示了一个通用结点-"Fleet Management",它具有可以添加到它上面的组件。在一个多层系统中,Fleet Management是由软件架构师来定义成一个分离的层。为了说明问题,我可能还要应用"Purpose"标签。我有两个结点实例,"Trucks"和 "Persons",它们由基础构件小组来定义以把该层分成两个方法。既然"Trucks"和"Persons"是完全不同的两个域,那么架构师介入其中 并分解之是十分安全的。方法名字上还标记有":Fleet Management",以指明它们是在Fleet Management结点中实现的。
图6.Trucks与Persons结点实例都继承自Fleet Management结点。 |
在这个示例中,没有用于继承的标签,但是可能在另外的图上存在一些其它关系-它们会连接到该结点实例上。
我又一次重构了main程序以打印出所有的,包括每一个结点实例派生的(tNode.classname)结点标签,还有结点的ID(tNode.classifier)。
public static void Main(string[] args) { Hashtable mainHash; IDictionaryEnumerator ienum; Node tNode; string name = ReadString("Please enter the XMI filename : "); NodeParse np = new NodeParse(name); mainHash = np.getNodes(); ienum = mainHash.GetEnumerator(); while (ienum.MoveNext()){ tNode = (Node)ienum.Value; System.Console.WriteLine("Node = " + tNode.name); //Add "if (tNode. != null)" for each Writeline() System.Console.WriteLine(" CPU = " + tNode.CPU); System.Console.WriteLine(" DiskSize = " + tNode.DiskSize); System.Console.WriteLine(" MemorySize = " + tNode.MemorySize); System.Console.WriteLine(" Purpose = " + tNode.Purpose); System.Console.WriteLine(" Notes = " + tNode.Notes); System.Console.WriteLine("Node refers to = " + tNode.classname); System.Console.WriteLine("Node addr is " + tNode.classifier); System.Console.WriteLine(); } System.Console.ReadLine(); } |
类名和类标志符指明该结点实例继承自哪些结点。在XMI中,这是被象一个模板(就象一个封装在结点元素中的元素)一样描述的。
现在我将使用一个开关语句来检查"ModelElement.taggedValue",而代之以ModelElement.Stereotype,查 找"TaggedValue"元素(存在类名和类标志符上皆独立的元素),并把它们添加到结点对象上。在此,我再次使用了分析idiom。这些代码可以在 列表3中找到。
图7.Trucks和Persons:示例4的最后输出,Trucks和Persons各有一个它们可以参考的结点并且每个结点都有一个唯一的ID。
图7显示示例4最后的输出。
五、 总结
在本文中,我讨论了可以从图中读取硬件资产的方法。还讨论了读取名字、模板、属性以及读取结点之间及结点实例(继承)之间的关系。尽管我没有给出把这种信息放入数据库中的显式代码,我将在后面的文章中讨论这些技术-当然不止是添加信息到数据库中。
本文转自朱先忠老师51CTO博客,原文链接: http://blog.51cto.com/zhuxianzhong/60100,如需转载请自行联系原作者