UML软件开发与建模工具Enterprise Architect教程：创建项目特定的代码生成器（上）

---

Enterprise Architect是一个对于软件系统开发有着极好支持的CASE软件（Computer Aided Software Engineering）。EA不同于普通的UML画图工具（如VISIO），它将支撑系统开发的全过程。在需求分析阶段，系统分析与设计阶段，系统开发 及部署等方面有着强大的支持，同时加上对10种编程语言的正反向工程，项目管理，文档生成，数据建模等方面。可以让系统开发中各个角色都获得最好的开发效率。

点击下载Enterprise Architect最新试用版

您是否曾经想过从Enterprise Architect UML或SysML模型生成代码？您是否尝试过自定义Enterprise Architect的代码模板框架？不要放弃特定于项目的代码生成器的梦想，而要阅读它们实现起来的难易程度。

需要代码生成器

与实现相比，好的软件或系统架构具有更高的抽象级别。它应该是一个一致的模型，用于记录决策并忽略不必要的（通常是技术上的）细节。考虑一下图1中的类图。它显示了一个域模型，该模型定义了商店允许客户订购商品所需的数据结构。每个类的属性都进行了详细建模，但是省略了其他不必要的方面，例如访问属性的操作。

图1：示例UML模型

如果在开始实施之前先对软件体系结构/设计进行了准备，那么代码生成可以避免很多繁琐且容易出错的工作。商业开箱即用的代码生成器通常不会更改抽象程度。这就是为什么它们通常不符合项目需求的原因。

可以根据项目特定需求定制Enterprise Architect的代码模板框架。但这需要一些初步培训。通常，如基于Eclipse的Enterprise Architect Models的代码生成中所述，很难达到预期的结果。

一个简单的项目专用代码生成器

我更喜欢使用Java或Xtend之类的通用编程语言来实现代码生成器。由于Xtend具有模板表达，因此特别适合于实现模板。它们允许将可执行代码嵌入要生成的文本中。感觉就像在编程PHP，JSP或JSX。在代码清单1只显示了写的Xtend代码生成模板。它为图1的类图中声明的类生成Java类。

package com.yakindu.ea.examples.orderingsoftware.template

import com.yakindu.bridges.ea.examples.runtime.codegen.EACodegen
import org.eclipse.uml2.uml.Class
import org.eclipse.uml2.uml.NamedElement

class ClassTemplate {
   @EACodegen("Java")
   def String generate(Class element) '''
      package ?element.package.javaQualifiedName?;
      
      ?val superType = element.generals.findFirst[true]?.name?
      ?val extends = '''?IF !superType.isNullOrEmpty? extends ?superType??ENDIF?'''?
      public?IF element.isAbstract? abstract?ENDIF? class ?element.name??extends? {
         
         ?FOR attribute : element.ownedAttributes SEPARATOR System.lineSeparator?
            ?val type = attribute.type?.javaQualifiedName?
            ?IF 1 != attribute.upper?
               ?val defaultValue = '''new java.util.LinkedList<?type?>()'''?
               private final java.util.List<?type?> ?attribute.name? = ?defaultValue?;
            ?ELSE?
               private ?type? ?attribute.name?; 
            ?ENDIF?
         ?ENDFOR?
         
         ?FOR attribute : element.ownedAttributes SEPARATOR System.lineSeparator?
            ?val type = attribute.type?.javaQualifiedName?
            ?IF 1 != attribute.upper?
               public List<?type?> get?attribute.name.toFirstUpper?() {
                  return ?attribute.name?;
               }
            ?ELSE?
               public ?type? get?attribute.name.toFirstUpper?() {
                  return ?attribute.name?;
               }
            ?ENDIF?
            ?IF 1 == attribute.upper?
               
               ?val params = '''?type? ?attribute.name?'''?
               public void set?attribute.name.toFirstUpper?(?params?) {
                  this.?attribute.name? = ?attribute.name?;
               }
            ?ENDIF?
         ?ENDFOR?
      }
   '''
   
   protected def String getJavaQualifiedName(NamedElement element) {
      element.qualifiedName.replace("::", ".")
   } 
}

清单1：用Xtend编写的示例代码生成模板

在显示生成的Java代码清单2，  3  和  4看起来并不像手写的，因为合格的名称来代替进口。稍后将在图4中通过方法collectImports和进行改进printImports。

package com.example.orderingsoftware;

public abstract class AbstractIDObject {

   private java.util.UUID id; 

   public java.util.UUID getId() {
      return id;
   }
   
   public void setId(java.util.UUID id) {
      this.id = id;
   }
}

清单2：清单1中的代码生成模板生成的类AbstractIDObject的Java代码

package com.example.orderingsoftware;

public class OrderItem extends AbstractIDObject {

   private java.math.BigInteger amount; 
   
   private com.example.orderingsoftware.Article article; 

   public java.math.BigInteger getAmount() {
      return amount;
   }
   
   public void setAmount(java.math.BigInteger amount) {
      this.amount = amount;
   }
   
   public com.example.orderingsoftware.Article getArticle() {
      return article;
   }
   
   public void setArticle(com.example.orderingsoftware.Article article) {
      this.article = article;
   }
}

package com.example.orderingsoftware;

public class Order extends AbstractIDObject {

   private java.util.Date date; 
   
   private com.example.orderingsoftware.Customer customer; 
   
   private final java.util.List<OrderItem> items = new java.util.LinkedList<OrderItem>(); 

   public java.util.Date getDate() {
      return date;
   }
   
   public void setDate(java.util.Date date) {
      this.date = date;
   }
   
   public com.example.orderingsoftware.Customer getCustomer() {
      return customer;
   }
   
   public void setCustomer(com.example.orderingsoftware.Customer customer) {
      this.customer = customer;
   }
   
   public java.util.List<com.example.orderingsoftware.OrderItem> getItems() {
      return items;
   }
}

清单4：由清单1中的代码生成模板生成的Order类的Java代码

如果仔细查看清单1中的模板，您将意识到它对Enterprise Architect一无所知。取而代之的是，它处理UML元模型的实例，这要归功于Eclipse UML 2项目，它在Eclipse中可用。YAKINDU EA-Bridge是Enterprise Architect和UML之间缺少的连接。它是一个API，可提供对Enterprise Architect UML和SysML模型的符合UML的读写权限。Enterprise Architect项目背后的数据库会自动转换为UML元模型的实例。作为开发人员，这具有三大优势： 

• 您的代码与基于UML 2项目的其他工具（如Papyrus）兼容。
• 对Enterprise Architect模型的高性能读写访问，而无需对Enterprise Architect的数据库架构进行反向工程。
• 您无需了解有关YAKINDU EA-Bridge API的任何知识。作为开发人员，它完全是隐藏的，因为YAKINDU EA-Bridge会将自身集成到Eclipse Modeling Framework（EMF）的生态系统中。

YAKINDU EA-Bridge带有可选的Eclipse IDE集成，该集成允许一个人实现特定于项目的代码生成器。这些代码生成器通常是原型开发的，并且仅在特定上下文中执行。因此，至关重要的是，与手动编码相比，减少开发工作量。要实现特定于项目的代码生成器，您要做的就是将EAP文件放置在Eclipse项目中，并使用注释代码生成模板中的方法@EACodegen。带注释的方法应接受应为其生成代码的UML元素作为唯一参数，并返回生成的文本。如果您的Enterprise Architect模型由远程数据库（例如Microsoft SQL Server）托管，则可以使用快捷方式文件 而不是EAP文件。

例如，通过主菜单项“ Project，Clean ...”自动或手动构建项目时，将为所有EAP文件中声明的所有UML类启动模板。当然，仅考虑模板项目中存储的EAP文件。生成的代码保存在类的限定名称指定的文件中。文件扩展名由@EACodegen注释的参数指定。Eclipse项目的结构如图2所示。

图2：Eclipse中的示例项目结构

请注意，YAKINDU EA-Bridge是一个API。它允许您以任何方式处理Enterprise Architect模型。实际上，最初的用例是全面的代码生成器，例如基于UML架构的Autosar RTE生成器。 

=====================================================

想要了解或购买Enterprise Architect正版版权，请

关注下方微信公众号，及时获取产品最新消息和最新资讯