做搜狗网站快速排名,asp网站配置,学网站开发的书,贵州毕节建设局网站官网概述
首先阐述一下几个简单概念#xff1a;
UML#xff1a;是统一建模语言#xff08;Unified Modeling Language#xff09;的缩写#xff0c;它是一种用于软件工程的标准化建模语言#xff0c;旨在提供一种通用的方式来可视化软件系统的结构、行为和交互。UML由Grady…概述
首先阐述一下几个简单概念
UML是统一建模语言Unified Modeling Language的缩写它是一种用于软件工程的标准化建模语言旨在提供一种通用的方式来可视化软件系统的结构、行为和交互。UML由Grady Booch、Ivar Jacobson和James Rumbaugh三位软件工程专家在1990年代初共同开发并在1997年被对象管理组织Object Management Group, OMG正式采纳。PlantUML是一个开源工具它允许我们用文本形式来描绘和创建UML图。在VSCode中可以安装扩展来绘制而在语雀的MarkDown编辑器中则可以用“文本绘图”形式直接在文档中创建。UML类图在面向对象语言或开发中类图是最基础也最有用的一种图它可以描述类的成员以及多个类之间的关系。
在Godot中我们使用GDScript进行游戏或类库开发时也需要涉及面向对象开发和类图等用于清晰表达自己的思路或详实自己的文档。
因为语雀文档内部创建更方便所以本文主要介绍在语雀中绘制UML类图的方式。
在语雀中创建PlantUML类图
在语雀文档中在任意一行行首输入“/wbht”可以找到“文本绘图”回车即可插入“文本绘图”的Block。 默认插入的“文本绘图”块如下 点击顶部的“模板”在下拉列表中选择“类图” 会自动填充和渲染一个如下的类图 我们便可以在这个基础上进行UML类图的绘制。
PlantUML类图基础语法
起止标记
首先是起止标记绘图描述的内容必须包裹在一对startuml和enduml标记之间。
startumlenduml申明元素
在startuml和enduml标记之间我们可以使用特定的语法来申明类图的元素。PlantUML本身支持很多种元素申明详见类图的语法和功能 但在GDScript中最常用到的便是类和枚举其他的元素类型并不支持。
startuml
class a
enum skills
enduml其中
以class为关键字后面跟类名可以声明一个类以enum为关键字后面跟枚举名可以声明一个枚举
上面代码生成的类图如下
添加类或枚举的成员
以类为例我们可以使用:注意前后都有一个空格来为申明的类添加成员名称不带()的被视为是属性带()的被视为是方法。
startuml
class a
a : name
a : sex
a : age
a : say_hello()
enduml上面的代码生成的类图如下
也可以用花括号语法
startuml
class a{namesexagesay_hello()
}
enduml这样的写法更接近于真实代码的形式可以省去重复的类名和:。
申明成员类型
可以为类的成员申明数据类型。
startuml
class a{String namebool sexint agevoid say_hello()
}
enduml可以采用C风格的前置类型声明
也可以采用类似GDScript的冒号后置类型申明形式
startuml
class a{name:String sex:boolage:intsay_hello():void
}
enduml设定成员的可访问性
类图可以更具体的标记属性和方法的可访问性也就是private、protected、public如果是C之类的或许可以用上但是在GDScript中并不涉及这部分。 下面是具体的修饰符和意义。
字符图标(属性)图标(方法)可访问性-private 私有#protected 受保护~package private 包内可见public 公有
下面是一个简单的例子
startuml
class a{name:String -sex:bool~age:intsay_hello():void
}
enduml绘制效果如下 表示静态变量或方法
Godot3.x就支持静态函数Godot4.x更是支持了静态变量。 在PlantUML类图中我们可以精确的表示静态函数和静态变量成员以与非静态成员区分。 方法也很简单就是在静态成员之前添加{static}修饰符。
startuml
class a{ {static} name:String -sex:bool~age:int{static}say_hello():void
}
enduml绘制效果如下
可以看到静态成员的名称下添加了下划线。
使用分隔线对成员进行自定义分组
可以在成员之间用--、..、、__进行自定义分割线的绘制
startuml
class a{ame:String --sex:boolage:int..say_hello():void__say_yes():void
}
enduml实际效果如下
可以看到
--是一条比较粗的横线__是一条比较细的横线是双横线..是虚线
你也可以在分割线基础上进行分组的命名。
startuml
class a{ame:String -- 性别 --sex:bool 年龄 age:int.. 方法 ..say_hello():void__ 还是方法 __say_yes():void
}
enduml绘制效果如下
这样我们可以将成员进行分组让类的结构更清晰易懂。
多个类之间的关系表示
关系类型符号绘图泛化关系|–组合关系*–聚合关系o–
--代表实线可以用..替代表示虚线。|、*和o分别代表箭头的类型
类与类之间的关系可以查阅相关的视频或文档这里不做赘述这里只举例说明继承关系的表示。
startuml
Car |-- Bus
enduml这里我们直接省略class关键字申明了Car和Bus两个类并且使用|--连接它们。 生成的类图如下
它的含义就是Car作为父类Bus作为子类Bus继承自Car。
新手注意继承关系的箭头是由子类指向父类。
我们可以继续这个例子添加Car的其他子类型
startuml
Car |-- Bus
Car |-- motorcycle
Car |-- bicycle
enduml生成类图如下
在箭头连线上添加文本
可以在整个箭头连线关系的最后在:后面添加文本信息用于显示在连线上。
startuml
Car |-- Bus:继承自
Car |-- motorcycle:继承自
Car |-- bicycle:继承自
enduml生成类图如下
表示类之间的数量关系
也可以用双引号在连线的起始端和末尾端添加文本用于表示类似ER实体关系图中的“一对一”、“一对多”、“多对多”等关系。 在继承关系中可能使用这种描述不太恰当可以在“组合”或“聚合”等关系中使用。 下面的代码表示一个汽车有4个轮子组成
startuml
汽车 1 *-- 4 轮子:组成
enduml生成类图如下
控制类绘制的位置
在连线之间可以使用up、down、left和right关键字来手动控制类的绘制位置。 以之前的Car派生的例子为例
startuml
Car |-- Bus:继承自
Car |-- motorcycle:继承自
Car |-- bicycle:继承自
enduml默认绘制为
通过在表示实线的--之间指定上下左右方位的关键字
startuml
Car |-left- Bus:继承自
Car |-up- motorcycle:继承自
Car |-right- bicycle:继承自
enduml就可以将类图渲染为如下形式
绘制备注
note关键字用于绘制备注。 可以使用note 位置 of 元素的形式为类、枚举或者其他类图元素设定备注。
startuml
Car |-left- Bus:继承自
Car |-up- motorcycle:继承自
Car |-right- bicycle:继承自note bottom of Car:车基类
note bottom of Bus:公共汽车
note bottom of bicycle:自行车
note left of motorcycle:摩托车
enduml绘制效果如下
还有一种写法可以省略of 元素但是需要紧跟在class申明之后或者指定两个类的关系之后。
startuml
class Car
note bottom:车基类Car |-left- Bus:继承自
note bottom:公共汽车Car |-up- motorcycle:继承自
note left:摩托车Car |-right- bicycle:继承自
note bottom:自行车
enduml绘制效果如下
可以看到效果基本上无异。 还可以用note 备注内容 as 变量形式将备注申明为一个类似单独元素的东西。 再使用--或..进行连接
startuml
class Car
note 车基类 as N1
Car -- N1
enduml效果如下
另外在备注中可以使用\n进行多行文本的换行控制。
为类图添加标题
使用title关键字可以为类图添加标题。
startuml
title 车类的继承关系类图
Car |-left- Bus:继承自
Car |-up- motorcycle:继承自
Car |-right- bicycle:继承自note bottom of Car:车基类
note bottom of Bus:公共汽车
note bottom of bicycle:自行车
note left of motorcycle:摩托车
enduml绘制效果如下
为类图添加页脚
如果你不喜欢顶部的标题可以使用footer关键字指定一个底部的页脚。
startumlCar |-left- Bus:继承自
Car |-up- motorcycle:继承自
Car |-right- bicycle:继承自note bottom of Car:车基类
note bottom of Bus:公共汽车
note bottom of bicycle:自行车
note left of motorcycle:摩托车
footer 车类的继承关系类图
enduml绘制效果如下
Godot中的一些类图实例
上面我们已经学习了如何用PlantUML进行类图的绘制。下面就举一些Godot中的例子。
子类与父类继承关系
startumlControl |-- Button
note bottom:泛化关系继承关系\n子类指向父类\n实线空心三角箭头enduml绘图效果
成员引用一般关联关系
startumlclass class01{attr:class02
}class01 -- class02
note bottom:单向关联关系\n引用者指向被引用者class class03{attr:class04
}class class04{attr:class03
}class03 -- class04
note bottom:双向关联关系\n箭头消失class class05{sub_itm:class05
}class05 -- class05
note bottom:自关联关系\n自己的成员变量引用自己enduml绘制效果
部分与整体聚合与组合
startumlclass Player {
}
note left:玩家
Player -up-| CharacterBody2D
Player o-- CollisionShape2D
note bottom:碰撞形状
Player o-- Sprite
note bottom:玩家长相
enduml绘制效果
更复杂的可以有
startuml
title Godot中2D角色的节点组成结构2
class Player {
}
note left:玩家
Player -up-| CharacterBody2D
Player o-- CollisionShape2D
note bottom:碰撞形状
Shape2D -down- CollisionShape2D
Player o-- HitBox
note bottom:攻击判定区域
HitBox -up-| Area2D
CollisionShape2D2 -down-o HitBox
Shape2D -down- CollisionShape2D2Player o-- Sprite
note bottom:玩家长相
enduml组合关系
startuml
title Godot中的组合关系
class Tree {
}Tree *-- TreeItem
note right:组合关系\n父类由子类组成\n父类消失子类失去意义\n子类消失父类无法构成。enduml依赖关系
startuml
title Godot中类的依赖关系
class ShapePoints {
static rect():PackedVector2Array
}class myCanvas{draw_rect():void
}ShapePoints .. myCanvas
note right: 依赖关系\n一个类用**局部变量**、\n**方法参数**或者\n**对静态方法的调用**\n来访问另一个类enduml总结
本文带领Godot使用者学习和使用基础的PlantUML类图绘制技巧。 希望对Godoter们编写和设计自己的类以及类库有所帮助你也可以用来绘制和讲解设计模式等。 本文不详之处可以查阅其他大佬的文章或翻找PlantUML官方文档。 若有错误之处还请指正。
