夜雨聆风学习资料网

ARTICLE · 1278371

Obsidian 插件 P11:PlantUML 图表

Obsidian 插件 P11:PlantUML 图表

插件简介

PlantUML 插件允许你在笔记中使用 PlantUML 语法创建各种图表,包括流程图、时序图、类图、用例图、状态图等。只需编写文本描述,即可自动生成专业的 UML 图表。

安装与启用

•

插件已安装并启用

•

需要安装 PlantUML 渲染器(内置或外部)

基本语法

流程图

MARKDOWN

@startuml

start

:开始;

if (条件?) then (是)

  :操作A;

else (否)

  :操作B;

endif

:结束;

stop

@enduml

时序图

MARKDOWN

@startuml

用户 -> 系统: 发送请求

系统 -> 数据库: 查询数据

数据库 --> 系统: 返回结果

系统 --> 用户: 返回响应

@enduml

类图

MARKDOWN

@startuml

class Animal {

  +name: String

  +age: int

  +eat(): void

  +sleep(): void

}

class Dog {

  +breed: String

  +bark(): void

}

Animal <|-- Dog

@enduml

用例图

MARKDOWN

@startuml

left to right direction

actor 用户 as u

actor 管理员 as a

rectangle 系统 {

  usecase 登录 as UC1

  usecase 查看数据 as UC2

  usecase 管理用户 as UC3

}

u --> UC1

u --> UC2

a --> UC1

a --> UC3

@enduml

支持的图表类型

图表类型
说明
Flowchart
流程图/活动图
Sequence
时序图
Class
类图
Use Case
用例图
State
状态图
Component
组件图
Deployment
部署图
Gantt
甘特图
Mindmap
思维导图
WBS
工作分解结构

配置选项

设置项
说明
Renderer
渲染方式(内置/外部/服务器)
Theme
图表主题
Scale
缩放比例
Image format
图片格式(PNG/SVG)

渲染方式

•

内置渲染:使用内置的 PlantUML 引擎(推荐)

•

外部服务:使用 PlantUML 服务器

•

本地安装:使用本地安装的 PlantUML

使用场景

软件设计

•

绘制系统架构图

•

设计类关系图

•

描述业务流程

项目管理

•

甘特图展示项目进度

•

流程图描述工作流

•

用例图描述系统功能

知识整理

•

思维导图整理知识点

•

状态图描述状态变化

•

时序图描述交互过程

高级功能

自定义主题

PLANTUML

@startuml

skinparam backgroundColor #EEEBD5

skinparam componentStyle uml2

skinparam component {

  BackgroundColor #FEFECE

  BorderColor #A80036

  ArrowColor #A80036

}

@enduml

包含外部文件

PLANTUML

@startuml

!include common.puml

@enduml

与其他插件配合

配合 Excalidraw

•

PlantUML 适合结构化图表

•

Excalidraw 适合手绘风格图表

配合 Diagrams.net

•

PlantUML 适合快速生成

•

Diagrams.net 适合精细调整

常见问题

•

Q: 图表没有显示?

A: 检查 PlantUML 语法是否正确,确保有 @startuml 和 @enduml

•

Q: 渲染很慢?

A: 使用内置渲染器,或配置本地 PlantUML 服务器

•

Q: 中文显示乱码?

A: 配置支持中文的字体

我是 风云梦,感谢阅读,欢迎交流。

相关学习资料