编码前准备——UML图工具PlantUML

Bertha 。 2024-04-24 14:40 56阅读 0赞

**PlantUML**是一个可以快速编写UML图的组件，画出来的图感觉比visio好看且专业；

可以内置Java开发工具IDEA插件，使用代码画图，逻辑更符合程序员思维；

如下：

![f4c57317c1f746b68bb1bf8d52fb782b.png][]

### 1. 安装 ###

插件在线下载地址：[PlantUML Integration - IntelliJ IDEs Plugin | Marketplace][PlantUML Integration - IntelliJ IDEs Plugin _ Marketplace]

运行库地址：[Download | Graphviz][Download _ Graphviz]

配置方式：

![99d0cbdcddd742f7b32c9d4423f368ac.png][]

IDEA的插件market：

![34f6ee87454541f3b41c7cea45e3c2c5.png][]

### 2. 使用示例 ###

安装好后邮件新增文件可选：

![8ef74b15c4cb4d06a584a29c3a690708.png][]

![83dd40abd7a949ed99cd9142a32e9e8a.png][]

#### 2.1 一般时序图 ####

**样式1：**

![d9b1c844165f409cb24a4e7cca73e771.png][]代码：

@startuml
    participant 联运客户端 order 1
    participant 支付服务端 order 2
    participant 大会员服务端 order 3 #99FF99
    
    'skinparam responseMessageBelowArrow true
    
    联运客户端 -> 支付服务端: 1.[HTTP]查询收银台信息
    支付服务端 -> 大会员服务端: 2.[DUBBO]查询大会员产品信息及收银台样式
    大会员服务端 -> 大会员服务端: 3.条件过滤/组装信息
    
    支付服务端 <-- 大会员服务端: [DUBBO]返回收银台大会员产品渲染信息
    联运客户端 <-- 支付服务端: [HTTP]返回收银台信息
    
    @enduml

**样式2：**

![624fc927fd53409289bbaa6cd1a3cfcb.png][]

代码：

@startuml
    participant 游戏CP order 1 #99FF99
    participant 开平API order 2
    participant 数据库 order 3
    
    autonumber
    游戏CP -> 开平API: 创建测试计划 填写信息 保存
    开平API -> 数据库: 查询是否存在流程中计划
    开平API <-[#0000FF]- 数据库: 返回结果
    
    alt 不存在流程中计划
        开平API -> 数据库: 入库内测游戏测试计划表
        开平API <-- 数据库: 返回测试计划ID
        游戏CP -> 开平API: 继续填写问卷 提交保存
        开平API -> 数据库: 入库问卷表
        开平API <-- 数据库: 返回问卷ID
        activate 开平API
        开平API --> 开平API: 测试计划关联问卷ID
        开平API -> 数据库: 更新内测游戏测试计划表记录
        deactivate 开平API
        开平API <-- 数据库: 更新成功
        游戏CP <-- 开平API: 返回测试计划提交成功
    autonumber stop
    
    else 存在流程中计划
    autonumber 5
    游戏CP <-- 开平API: 返回测试计划提交失败
    
    end
    
    @enduml

#### 2.2 活动图 ####

**样式1：**

![315e13704b644c199afc972a665ff6a3.png][]

代码：

@startuml
    (*)  --> "byType-按照类型装配Bean"
    
    If "" then
    note right
    是否找到bean?
    end note
    
    --> [Yes] If "" then
    note right
    是否使用@Qualifier?
    end note
    
    --> [Yes] "根据@Qualifier的名称找bean"
    --> If "" then
    note right
    是否找到对应名称的bean?
    end note
    --> [Yes] "装配成功" #99FF99
    else
    --> [No] "装配失败" #9fc5e8
    Endif
    
    else
    --> [No] If "" then
    note right
    是否仅找到1个bean?
    end note
    --> [Yes] "装配成功"
    else
    --> [No 找到多个] If "" then
    note right
    是否有配置@Primary的bean?
    end note
    ---> [Yes] "装配成功"
    else
    ---> [No] "装配失败"
    Endif
    
    Endif
    Endif
    
    "装配成功"-->(*)
    "装配失败"-->(*)
    Endif
    @enduml

**样式2：**

![99ee4f90d3ee4118a88ad3c42f448ab3.png][]

代码：

@startuml
    (*)  --> "byName-@Resource默认按照名称装配Bean"
    
    --> [4种配置方式] "@Resource属性配置" #f4cccc
    
    "@Resource属性配置" --> [case1:未配置] "默认使用name查找bean"
    if "" then
    note left
    通过name找到bean?
    end note
    --> [yes] "装配成功" #99FF99
    else
    --> [No] if "" then
    note left
    通过type找到bean?
    end note
    --> [yes] "装配成功" #99FF99
    else
    --> [No] "装配失败" #9fc5e8
    Endif
    Endif
    
    "@Resource属性配置" --> [case2:配置type和name] "使用name和type一起查找bean"
    if "" then
    note left
    通过name和type找到bean?
    end note
    --> [yes] "装配成功" #99FF99
    else
    --> [No] "装配失败" #9fc5e8
    Endif
    
    "@Resource属性配置" --> [case3:仅配置name] "仅使用name查找bean"
    if "" then
    note left
    通过name找到bean?
    end note
    ---> [yes] "装配成功" #99FF99
    else
    ---> [No] "装配失败" #9fc5e8
    Endif
    
    "@Resource属性配置" --> [case4:仅配置type] "仅使用type查找bean"
    if "" then
    note left
    通过type找到bean?
    end note
    ---> [yes] "装配成功" #99FF99
    else
    ---> [No] "装配失败" #9fc5e8
    Endif
    
    "装配成功"-->(*)
    "装配失败"-->(*)
    @enduml

**样式3：**

![c277a6dea94942afb0199de941127f63.png][]

代码：

@startuml
    note right #cc3333
      [起始]
    end note
    (*)  --> "扫描新游内测申请表"
    partition LOOP所有有效记录 #CCDDEE {
    --> "通过内测新游包名查询(游戏中心)上下架状态"
    If "" then
    note right #99EE99
      是否与当前上下架状态不一致？
    end note
    
    --> [Yes] "更新该条记录"
    --> If "" then
    note right #99EE99
      上架变更/下架变更？
    end note
    --> [上架变更] "通知用户运营平台创建通知II计划(幂等)"
    
    else
    --> [下架变更] "V消息告知运营"
    Endif
    
    If "" then
    note right #99EE99
      内测计划是否已经开始？
    end note
    --> [Yes] "不做处理"
    
    else
    --> [No] "通知用户运营平台取消通知II计划(幂等)"
    Endif
    
    else
    
    }
    -------> [No] ===B1===
    Endif
    
    "不做处理" --> ===B1===
    "通知用户运营平台创建通知II计划(幂等)" ---> ===B1===
    "通知用户运营平台取消通知II计划(幂等)" ---> ===B1===
    
    ===B1=== -->"任务结束"
    -->(*)
    note right #cc3333
      [终止]
    end note
    @enduml

**样式4：**

![21741b7f89a64b9e9bce1acb787144d6.png][]

代码：

@startuml
    note right #cc3333
      [起始]
    end note
    (*) --> "已提交审核的测试计划列表"
    "已提交审核的测试计划列表"--> "查看已提交审核的测试计划详情"
    note right
      角色:游戏运营
    end note
    If "" then
    note right #99EE99
      是否审核通过？
    end note
    
    partition 通知 #CCDDEE {
    --> [Yes]===B1===
    ---> [通知CP]"(站内信)通知CP该计划审核通过"
    --->===B2===
    
    ===B1=== ---> [通知下游]"1.通知C端-同步测试计划物料 2.通知用户运营平台-创建问卷通知计划"
    --->===B2===
    
    }
    --->(*)
    note right #cc3333
      [终止]
    end note
    
    else
    --> [No] "(站内信)通知CP审核不通过及原因"
    If "" then
    note right #99EE99
      当前审核计划是否过期(不可编辑)？
    end note
    --> [Yes](*)
    else
    -----> [No] "重新提交"
    note right
      角色:游戏CP
    end note
    "重新提交" ---> "已提交审核的测试计划列表"
    Endif
    
    
    @enduml

**样式5：**

![ea0dc59edd4c437d97da0ccff81952ed.png][]

代码：

@startuml
    (*)  --> "收银台支付结果消息"
    note right #99EE99
      [入参]:
      用户openid
      扣减金额deductAmount
      订单号orderNo
      业务类型bizType
    end note
    
    If "" then
    note left
    deductAmount = 0?
    end note
    partition "收银台未使用预支礼券" {
    --> [Yes] "[ 现有逻辑 ]\n1. 用户身份信息更新 (立即成为会员/延长1个月周期)\n2. member_period记录状态为'1-待发放'\n3. 当前购买的会员月 发放N张无门槛券"
    -->(*)
    }
    else
        partition "收银台使用预支礼券" {
        --> [No] If "" then
        note left
        deductAmount等于bizType配置下无门槛券面额?
        end note
            --> [Yes] If "" then
            note left
            用户是否已经是大会员生效状态? (如跳转H5开通)
            end note
            --> [Yes] "1. 监控异常用户行为\n2. member_period记录状态为'6-待发放-已用虚拟礼券'\n3. 当前购买的会员月到来时由定时任务发放N-1张无门槛券"
            -->(*)
            else
            --> [No] "[ 现有逻辑 ]\n1. 用户身份信息更新成为会员\n2. member_period记录状态为'1-待发放'\n3. 立即发放N-1张无门槛券"
            -->(*)
            end if
        else
        --> [No] "1. 监控异常数据\n2. 系统告警"
        "1. 监控异常数据\n2. 系统告警"-->"[ 现有逻辑 ]\n1. 用户身份信息更新 (立即成为会员/延长1个月周期)\n2. member_period记录状态为'1-待发放'\n3. 当前购买的会员月 不发放门槛券(告警) 仅发放其他会员权益"
        -->(*)
        }
        end if
    end if
    
    
    @enduml

**样式6：**

![25b6dbf66f0b4d9c9af2550cfb583349.png][]

代码：

@startuml
    (*)  --> "下单请求"
    note right
      入参:
      用户openid
      产品id productId
    end note
    If "" then
    note left
    用户身份满足下单条件?
    end note
    partition 下单成功 {
    --> [Yes] If "" then
    note left
    根据productId判断是否签约订单?
    end note
    --> [Yes] "返回订单号+签约单号（签约标识）"
    
    --> "返回下单成功"
    else
    --> [No] "返回订单号"
    }
    Endif
    --> "返回下单成功"
    -->(*)
    else
    --> [No] "返回因身份互斥导致下单失败的状态码"
    --> "返回下单失败"
    -->(*)
    Endif
    @enduml

####  ####

#### 导出 ####

建议导出格式为svg格式，可以使用浏览器打开，也可以使用visio打开继续编辑，不失真；

![9496d9df15044d6b813b5f482a1dfaaa.png][]

### 3. 教程 ###

参考：[开源工具PlantUML官网 使用手册][PlantUML_]

[f4c57317c1f746b68bb1bf8d52fb782b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/24/036e17ff28b848ef938631dacb4b3e68.png
[PlantUML Integration - IntelliJ IDEs Plugin _ Marketplace]: https://plugins.jetbrains.com/plugin/7017-plantuml-integration/versions
[Download _ Graphviz]: http://www.graphviz.org/download/
[99d0cbdcddd742f7b32c9d4423f368ac.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/24/5d8f3e3143c7494e8f778eda9cb5675c.png
[34f6ee87454541f3b41c7cea45e3c2c5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/24/78de75d75c0c4b2eaa6d9d4eff1822d0.png
[8ef74b15c4cb4d06a584a29c3a690708.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/24/d83ff7723a5c4e8a8cad884cb77a232f.png
[83dd40abd7a949ed99cd9142a32e9e8a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/24/d5c8c0152ccb46ecbfc1409f32a11c03.png
[d9b1c844165f409cb24a4e7cca73e771.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/24/df4989959b69441ba43ef5cab4c1831c.png
[624fc927fd53409289bbaa6cd1a3cfcb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/24/8a1cddb8b3f44db9b166fa0afab8b16f.png
[315e13704b644c199afc972a665ff6a3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/24/3ccfdb7de391420e8c19e3c21a675bb8.png
[99ee4f90d3ee4118a88ad3c42f448ab3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/24/374491486c8c400c8578fa2025f717c9.png
[c277a6dea94942afb0199de941127f63.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/24/8a6e87252c714e88a7d110d496eb97e8.png
[21741b7f89a64b9e9bce1acb787144d6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/24/a583428181204d04a9523870c2ffe838.png
[ea0dc59edd4c437d97da0ccff81952ed.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/24/0b7651c7ce124d2a9e41cc9b79f2d74f.png
[25b6dbf66f0b4d9c9af2550cfb583349.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/24/c1fe1d7331a14b4c8e866d1088ee0733.png
[9496d9df15044d6b813b5f482a1dfaaa.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/24/30af9bc2edc24a21a2d6d388cd025e78.png
[PlantUML_]: https://plantuml.com/zh/