[emacs] Drawing uml under emacs org-mode using plantUML - 类图

 

[emacs] Drawing uml under emacs org-mode using plantUML - 类图

1 准备工作

 

1.2 搭建plantuml环境

  1. 安装plantuml, 参考
  2. 下载相关lisp文件, ob-plantuml.el
  3. 将plantuml的安装路径, 加入到 ob-plantuml.el 文件中
    # line 44
    (defcustom org-plantuml-jar-path "/your/install/path/plantuml.jar"
    "Path to the plantuml.jar file."
    :group 'org-babel
    :version "24.1"
    :type 'string)
  4. (require 'ob-plantuml) 加入到init.el或是.emacs内

1.3 先爽一下

当上述的工作都完成之后, 就可以happy的使用plantuml这个神奇的工具了. 需要编辑的代码如下:

Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response

在上述代码内部使用 <ctrl-c> <ctrl-c> 的快捷键就能够在下面获得相应的图像. 是不是很爽呀, ;)

2 PlantUML使用说明

 

2.1 PlantUML 简介

PlantUML 允许使用简单的直观的语言实现, 能够用来绘制:

  1. 序列图
  2. 用例
  3. 类图
  4. 行为图
  5. 结构图
  6. 状态图
  7. 对象图

2.2 类图

由于对于一个程序员而言, 类的设计相对于其他的绘图而言更为重要, 因此此处首先介绍了plantUML在类图绘制中的使用方法

2.2.1 类之间的关系

此处, 类之间的关系以及所使用的符号如下:

 
联合, association <–
扩展, extension <(竖线)–
组成, composition *–
聚集, agregation o–

将表格中的 -- 替换成 .. 就能够获得相应的点线, 其中一个短线"<-"表示横向, 两个短线"<–"表示竖向

对于上述的关系表示非常困惑, 不急, 慢慢看来, ;)

  1. Association 1 2 有两个类, A 和 B, 如果A够根据将消息发送给B, 或是B的实例能够影响A, 那么就称两者之间的关系为Association, 并且在一般情况下两者是相互的. 如下所示:

    class class1 as "A"
    class class2 as "B"
    class1 --> class2

    class B {...}
    class A {
    B* itsB;
    }
  2. extension3, 也被称为继承关系, 或is-a关系.
    class food {
    };
    class apple : public food{
    };

    上面的关系就可以理解为, apple是food

    class class1 as "food"
    class class2 as "apple" class2 --|> class1

  3. composition and aggregation. 对于这两者的理解wikpedia中有一段很好的描述 4:

    一个大学里面有很多的学院, 每个学院又有很多的教授. 当这个大学倒闭关门的时候, 原来存在的学院也就随着大学的关门而不存在了, 但是这些教授却依然活着. 因此, 学校是由学院组成的, 即compostition, 学院是教授的集合地, aggregation

    class Professor;
    
    class Department
    {
    private:
    // Aggregation
    Professor* members[5];
    }; class University
    {
    private:
    std::vector<Department> faculty;
    create_dept() { // Composition
    faculty.push_back(Department());
    faculty.push_back(Department());
    }
    };
    class class1 as "University"
    class class2 as "Department"
    class class3 as "Professor" class3 -right--o class2
    class2 -right--* class1

2.2.2 添加label

在关系的后面加个":", 而后添加相应的label, 在连接符两边用""可以添加对应类的label, 如

Class01 "1" *-- "many" Class02 : contains
Class03 o-- Class04 : agregation

2.2.3 添加方法

在类名后面添加":", 如:

Object <|-- ArrayList

Object : equals(0
ArrayList : Object[] elementData
ArrayList : size()

另一种方法为:

class Dummy {
String data
void methods()
}

在类中添加不同的方法的时候, 往往需要给出相应的方法的属性, 如private, protected, public等:

 
- private
# protected
~ package private
+ public

2.2.4 注释以及定型

对图中的类进行注释, 采用"..", 定型(即, 给类一个特定的分类), 采用""和" ".

在注释中还可以使用html标签对注释的内容的格式进行美化.

  • <b> 加粗
  • <u> 加下划线
  • <i> 斜体
  • <s>, <del>, <strike> 删除线
  • <font color="#AAAAAA"> or <font color="colorname"> 字体颜色
  • <color:#AAAAAA> or <color:colorName> 字体颜色
  • <size: nn> 字体大小
  • <img src="file"> or <img:file> 添加图片
note top of Object
In java, every <u>class</u>
<b>extends</b>
<i>this</i> one
end note note as N1
This <size:10>note</size> is <u>also</u>
<b><color:royalBlue>on several</color></b>
<s>words</s> lines
end note

2.2.5 抽象类以及接口

抽象类使用"abstract"或"abstract class"关键字, 接口用"interface"关键字, 枚举用"enum"关键字

abstract class AbstractList
abstract AbstractConllection
interface List
interface Collection List <|-- AbstractList
Collection <|-- AbstractConllection Collection <|- List
AbstractConllection <|- AbstractList
AbstractList <|- ArrayList ArrayList : Object[] elementData
ArrayList : size() enum TimeUnit
TimeUnit : DAYS
TimeUnit : HOURS
TimeUnit : MINUTES

2.2.6 方法属性的隐藏

可以使用 "hide/show" 命令实现对方法以及属性的隐藏, 常用的命令如下:

  • hide empty members
  • hide empty fields or hide empty attributes
  • hide fields or hide attributes
  • hide methods
  • hide members
  • hide circle 隐藏类名前面圆形的字符
  • hide stereotype 通过""和" "增加的标识
  • hide class
  • hide interface
  • hide enum
  • hide foo1 隐藏所有foo1标识的类
  • hide classname
class Dummy1 {
+myMethods()
} class Dummy2 {
+hiddenMethod()
} class Dummy3 <<tag>> {
string name
} hide members
hide <<tag>> circle
show Dummy1 method
show <<tag>> members

2.2.7 packages

包的定义可以使用关键词"package"

package "Classic Collections" #DDDDDD {
Object <|-- ArrayList
} package net.sourceforge.plantuml #Snow {
Object <|-- Demo1
Demo1 *- Demo2
}

包之间的关系也可以通过类似的方式给出:

package foo1.foo2 {
} package foo1.foo2.foo3 {
class Object
} foo1.foo2 +-- foo1.foo2.foo3

2.2.8 命名空间

引用当前默认命名空间中的类时, 只要在类名前增加一个"."即可.

class BaseClass

namespace net.dummy #DDDDDD {
.BaseClass <|-- Person
Meeting o-- Person .BaseClass <|- Meeting
} namespace net.foo {
net.dummy.Person <|- Person
.BaseClass <|-- Person net.dummy.Meeting o-- Person
} BaseClass <|-- net.unused.Person

2.2.9 箭头方向的控制

  <- or -left-> 向左
-> or -right-> 向右
<-- or -up-> 向上
--> or -down-> 向下
foo1 -left-> dummyLeft
foo1 -right-> dummyRight
foo1 -up-> dummyUp
foo1 -down-> dummyDown foo2 -> right
left <- foo2
up <-- foo2
foo2 --> down

Date: 2014-04-18 Fri

Author: Zhong Xiewei

Org version 7.8.11 with Emacs version 24

Validate XHTML 1.0

[emacs] Drawing uml under emacs org-mode using plantUML - 类图的更多相关文章

  1. UML系列02之 UML类图(一)

    概要 本章介绍类图中类的UML表示方法.内容包括:类图介绍实体类的UML表示抽象类和接口的UML表示 转载请注明出处:http://www.cnblogs.com/skywang12345/p/352 ...

  2. UML图学习之二 类图

    类图(ClassDiagrams)是根据系统中的类以及各类之间的关系描述系统的静态视图.类图不仅显示系统内信息的结构,还描述系统内这些信息的行为.类图的一个重要目的是为其他图(如顺序图.交互图)定义一 ...

  3. 设计模式学习(二):面向对象设计原则与UML类图

    一.UML类图和面向对象设计原则简介 在学习设计模式之前,需要找我一些预备知识,主要包括UML类图和面向对象设计原则. UML类图可用于描述每一个设计模式的结构以及对模式实例进行说明,而模式结构又是设 ...

  4. 创建.emacs.d目录和.emacs文件

    1.双击bin下的addpm.exe 2.HKEY_CURRENT_USER->Software->GNU->Emacs 新建字符串值HOME,数值数据为emacs的安装路径 3.创 ...

  5. Emacs学习阶段小结-Emacs常用快捷键总结

    首先推荐一下Emacs自带的Emacs Tutorial,跟着这个做一边,两三个小时,基本的使用就能掌握了.之后的神教程就有很多了,比如<Sams.Teach.Yourself.Emacs.in ...

  6. 我的Emacs折腾经验谈(二) Emacs上手难的原因

    既然之前说过要写我怎么继续折腾Emacs的,过了一个星期这里就是第二篇了,突然觉得我把blog这样分节不是很好,每次可能要凑一些东西才有该有的篇幅,而且说的东西可能东一点西一点,这样一篇看下来不利于检 ...

  7. CentO7-使用plantuml绘制UML类图

    准备工作 到PlantUml官网(http://plantuml.com/download)下载plantuml.jar.官网上还有一个在线的demof服务.plantuml的官网真的很挫! 到官网下 ...

  8. 练习UML类图中的类的表示

    第一部分:UML类图(class diagram) 类图用来展现一组类.类的特性以及其类相互之间的关系,一个类图由一组类以及它们之间的关系构成,类图用来对系统的领域概念以及静态结构进行建模. 在软件模 ...

  9. UML类图(下):关联、聚合、组合、依赖

    前言 上一篇文章UML类图(上):类.继承.实现,讲了UML类图中类.继承.实现三种关系及其在UML类图中的画法,本文将接着上文的内容,继续讲讲对象之间的其他几种关系,主要就是关联.聚合.组合.依赖, ...

随机推荐

  1. GNU Makefile编写

    [Introduction] make 是程序员很好用的工具,如果存在makefile存在,每次更新代码,执行shell命令 shell 就可以执行所有需要编译的文件,make是根据你编写的Makef ...

  2. 写了一个简单的NodeJS实现的进程间通信的例子

    1. cluster介绍 大家都知道nodejs是一个单进程单线程的服务器引擎,不管有多么的强大硬件,只能利用到单个CPU进行计算.所以,有人开发了第三方的cluster,让node可以利用多核CPU ...

  3. 【星路演】DeviceOne:跨平台APP开发平台

    视频 DeviceOne是一个跨Android.IOS.Windows三个平台的一个PAAS平台,主要是提供给开发者一个节省70%的成本一个开发. 我们原来想做一个APP,我们会去找三个平台的原生人员 ...

  4. 作业二:Github注册过程

    第一步.打开Github官网https://github.com/ ,在相应位置填写注册名.注册邮箱.注册密码完成后点击注册. 第二步.这时会弹出一个界面,让你选择你的私人计划(personal pl ...

  5. Host is not allowed to connect to this MySQL server 错误的处理方法

    1. mysql>use mysql; mysql>update user set host = '%' where user = 'root'; mysql>select host ...

  6. java实现输入一行字符,分别统计出其中英文字母、空格、数字和其它字符的个数。

    package JingDian; import java.util.Scanner; public class charKind { public static void main(String[] ...

  7. IOS上架流程

    来个简易版本的.此版本针对用于初次上架的MAC以及在别的本上上架过,但是新换MAC但不换开发者帐号的MAC. 1:首先确认本机没有老旧的开发和distribution证书,有的话,删除: 2:在本机打 ...

  8. 绝对干货:自定义msi安装包的执行过程

    有时候我们需要在程序中执行另一个程序的安装,这就需要我们去自定义msi安装包的执行过程. 比如我要做一个安装管理程序,可以根据用户的选择安装不同的子产品.当用户选择了三个产品时,如果分别显示这三个产品 ...

  9. AngularJS快速入门指南20:快速参考

    thead>tr>th, table.reference>tbody>tr>th, table.reference>tfoot>tr>th, table ...

  10. java 堆栈分析4

    jprofiler ,又是一款好工具... —— 不过显然,我觉得有了jvisualvm就足够了,难道它会比jvisualvm还强大很多!?? 什么时候需要它呢?它有什么特别好用的地方吗? 带来什么方 ...