时间戳

首页 > 技术文章 > StarUML使用说明

StarUML使用说明

bogonogob 2019-02-22 18:17 原文

简介

StarUML是一个高级的软件建模工具，旨在支持敏捷而又简洁的建模。
描述版本：3.0.2

参考

参考：【官方文档】

Basic Concepts

项目(project)

项目是存储为单个文件的顶级元素，存储的文件后缀为: (.mdj).

  • 通常我们需要建立多个模型来描述一个软件系统：
    • 用例模型 Use-Case Model
    • 设计模型 Design Model
    • 组件模型 Component Model
    • 开发模型 Deployment Model
    • Others

Model vs View

很多人容易搞混 画图工具(诸如 Microsoft Visio) 和 建模工具(诸如 StarUML) ，首先你应当清楚，一个图表并不是一个模型。
模型或者说软件模型，是一个对软件系统各个方面的描述，这些方面包括：架构，行为，需求等。软件模型可以用文本、数学或视觉形式表示。模型元素是软件模型的构建块。
图表是软件模型的视觉几何符号表示。一张或者是多张图表能够表示一个软件模型的不同方面。例如：

  • 一个图表可以关注类层次结构，而另一个图表可以关注对象之间的交互。
  • 图表由视图元素组成，视图元素是模型元素的视觉表示。
  • 一个模型元素可能有对个对应的视图元素。
  • 模型元素有自己的数据，如名称、构造型、类型等等。
  • 视图元素只是在图表中呈现相应的模型元素。
  • 视图元素可能在一个图或不同的图中存在多次。
  • 如果模型元素的名称发生了更改，则所有相应的视图元素都会反映其关系图中的更改。

Fragment

片段是项目的一部分，另存为扩展名为.mfj的单独文件。任何元素都可以作为片段导出，但通常导出的是，umlPackage、umlModel和umlsubsystem。
一旦分片被导出为单独的文件，就可以在其他的项目中导入复用。
相关的操作：

  • File - Import Fragment - To import a fragment file。
  • File - Export Fragment - To export an element to a fragment file。

Profile

UML（统一建模语言）是一种通用的建模语言，可以用来表示各种软件密集型系统。
因此，对特定域或平台使用 UML 是不够的，因此您可能需要定义 UML 概要文件(UML Profile)。

StarUML 提供了可用于扩展 UML 的 UML profiles。例如，概要文件可以用于以下目的 UML profiles:

  • 用于特定的编程语言 (Profiles for specific programming languages (C/C++, Java, C#, Python, etc.))
  • 用于特定的开发方法 (Profiles for specific development methodologies (RUP, Catalysis, UML Components, etc.))
  • 用于特定的域 (Profiles for specific domains (EAI, CRM, SCM, ERP, etc.))

Extension

扩展是向 StarUML 添加新特性的包。扩展可以扩展菜单、UI、对话框、建模符号、首选项等。
扩展可以用JavaScript、CSS3和HTML5编写，也可以使用集成在StarUML中的node.js。
扩展可以通过主扩展注册表轻松安装、卸载和更新。

Managing Project

新建项目

  • 方法一：Ctrl+N
  • 方法二：File -> New

通过模板新建项目

  • File -> New From Template -> [TemplateName]

  • 5 个默认的模板：

    • UMLMinimal: 一个使用 UML 标准 profile 的简单模型。

    • UMLConventional: UML 标准 Profile，包括 Use Case Model, Analysis Model, Design Model, Implementation Model, and Deployment Model.

    • 4+1 View Model : Pilippe Kruchten设计的 4+1 Architectural View Model. 基于多个并发视图的使用，描述软件密集型系统的体系结构：
      4+1_Architectural_View_Model.svg.png

    • Rational: 软件 Rational Rose 的方法。

    • Data Model: 一个简单的数据建模项目。

  • 如果不想使用预先定义的模板，则需要创建自己的项目结构。

打开项目

  • 项目文件后缀： .mdj
  • 方法一： Ctrl+O
  • 方法二： File -> Open... and then select a file in Open Dialog

打开StarUML V1 File

  • 如果你拥有 StarUML V1 版本的文件(后缀为 .uml)
  • 使用 File -> Import -> StarUML 1 File (.uml).... 导入。

保存项目

  • 方法一： Ctrl+S
  • 方法二： FIle -> Save
  • 方法三： Ctrl+Shift+S
  • 方法四： File -> Save As

关闭项目

  • 保存
  • File -> Close

导出 Fragment

  • 导出项目的一部分为 fragment
  • File -> Export -> Fragment... -> 在元素选择对话框中选择一个元素导出

导入 Fragment

  • 将一个 fragment 导入到项目中
  • File -> Import -> Fragment.... -> 导入的 fragment 会成为当前项目的子项

应用 UML 标准 Profiles

  • 要包含标准 UML Profile，默认未包含。
  • Model -> Apply Profile -> UML Standard Profile (v2)

Editing Elements

Editing Diagrams

Create Diagram

  • 在右边 Model Explorer 中选择一个元素，默认名叫 Model，新建的图表将作为该元素的子项。
  • 在菜单栏中：Model -> Add Diagram -> [DiagramType]。
  • 或者右击选中的元素，在右击菜单中：Add Diagram -> [DiagramType]。

Delete Diagram

  • 右击选中 -> Delete From Model

Open Diagram

  • 在右边 Model Explorer中双击对应图表即可

Close Diagram

  • 在左侧 Working Diagrams 选中， 右击， 关闭或者是点击图表名前面的叉号。
  • Shift+F4 关闭所有的图表

切换当前工作的图表

  • 在左侧 Working Diagrams 中鼠标点击切换即可

Editing elements

Create Element

  • 使用 Toolbox 创建 Element

    • 在左下角 Toolbox 中选择选择元素类型。
    • 在图标中可以调节 element 的尺寸，连接两个元素等操作。
    • 注意：大多数情况下，使用该方法创建的元素意味着同时创建了 Model Element 和 View Element

  • 如果 Model Elelment 已经存在，则可以在视图上创建相关的 View Element

    • 通过拖放创建 View Element

      • 在右侧资源管理器(Explorer)中先选中一个 Model Element
      • 鼠标点击 Model Element 拖动到图表中释放即可

    • 在右侧资源管理器(Explorer)中创建 Model Element：

      • 首先选择一个元素，其中新的模型元素将作为子元素包含在资源管理器中。
      • 选中后右击 Add -> [ElementType]
      • 或者在菜单栏中 Model -> Add -> [ElementType]

Delete Elements

  • 删除元素前，首先要区分以下基本概念：

    • 模型元素 - Model Element.
    • 视图元素 - View Element.
    • 图表 - Diagram.

  • 在图表中删除 View Elements

    • 在图表中选中要删除的视图元素
    • 使用 Del 键删除
    • 或右击 Delete
    • 或 Edit -> Delete

  • 删除 Model Element

    • 在图表或者是 Explorer 中选中要删除的元素
    • Ctrl + Del
    • 或右击 Delete from Model
    • 或 Edit -> Delete from Mode

Select Elements

  • 在图表编辑区域：

    • Ctrl+A 或者Edit -> Select All 选中所有元素
    • 鼠标点击选中单个元素
    • Shift+鼠标单击选中多个元素
    • 鼠标拖选，选中拖动区域中的元素
    • 注意：在图表编辑区域中选中一个元素，意味着同时选中了Model Element 和 View Element

  • 在右侧资源管理器中：

    • 可以点击单独选中一个模型元素
    • 如果要在资源管理器中选择与关系图中所选元素对应的元素：
      • 图表编辑区域中选中，再在菜单栏中Edit -> Select In Explorer
      • 在图表编辑区域的对应元素上右击Select In Explorer

Copy and Paste

复制或剪切要粘贴的元素时，必须在模型元素和视图元素之间进行明确区分。 如果复制了模型元素，则必须将其粘贴到模型元素下。
在这种情况下选中元素的所有子元素都将会被一起复制。视图元素可以复制到同一个图表中，也可以复制到不同的图表中。复制的视
图元素只能粘贴到图表中；它们不能粘贴到模型元素。复制和粘贴也可能受到限制，具体取决于视图元素类型和图表类型。

  • 在图表编辑器中复制粘贴视图元素：

    • 在途表中选中一个或多个视图元素
    • Ctrl+C复制，Ctrl+X剪切
    • 在目标图表中 Ctrl+V 粘贴

  • 在资源管理器中复制粘贴模型元素：

    • 在资源管理器中 Ctrl+C 复制选中的模型元素，Ctrl+X剪切
    • 资源管理器中选中要粘贴到的目标模型元素
    • Ctrl+V 粘贴

  • 注意：有的元素不允许复制、剪切、粘贴

Undo and Redo

  • 撤销：Ctrl+Z
  • 重做：Ctrl+Y

编辑元素属性(Edit Properties)

  • 可以在右下角属性编辑器(Properties)中编辑模型元素的属性。

Documenting Elements

  • 可以在右下角模型编辑器(Documentation)中为模型元素添加文档说明

扩展元素(Extending Elements)

分配构造型(Assign Stereotype)

为元素分配已定义的构造型(Stereotype), 该构造型定义在 UML Standard Profile中

  • 选中要分配 stereotype 的模型元素

  • 单击右下边栏属性编辑器中构造型属性(stereotype)右侧的放大镜图标

  • 在元素选取器对话框中选择一个构造型

  • 为元素分配临时构造型：

    • 选择要分配构造型的模型元素
    • 在属性编辑器中的 stereotype 属性中输入构造型的名称

Add Constraints

  • 向元素添加约束：

    • 右侧选择要添加约束的模型元素
    • Model -> Add -> Constraint 或 右击 -> Add -> Constraint

Add Tags

标记是向模型元素添加扩展属性的元素

  • 右侧选择要添加 Tag 的模型元素

  • Model -> Add -> Tag 或 右击 -> Add -> Tag

  • Tag 的属性：

    • name： Tag 的名称

    • kind: Tag 的类型， 类型可能是：

      • string
      • reference
      • boolean
      • number
      • hidden

      如果选择了 hidden， 视图元素中将不会显示 Tag

    • value: 当 kind 为 string 时，Tag 的值

    • reference: 当 kind 为 reference 时，reference 的值

    • checked： 当 kind 为 boolean 时的布尔值

    • number： 当 kind 为 number 时的数值

  • 要在视图元素中展示或者是隐藏 Tag, 参看 Show Property

查找模型元素(Finding Model Elements)

  • Ctrl+F
  • 在查找对话框中填写关键字，大小写敏感
  • 查找结果显示在软件底部

推荐阅读