PlantUML非功能性标注实战指南

在系统架构设计中，非功能性需求的可视化表达与功能性需求同等重要。本文将深入讲解如何使用PlantUML进行性能、安全、可靠性和事务方面的标注，让您的架构图更具工程价值。

1. 性能指标注释

性能指标是架构设计中必须明确的关键要素，PlantUML提供了多种方式来标注性能特征。

@startuml
participant Client
participant "API Gateway" as Gateway
participant "OrderService" as Order

Client -> Gateway : POST /orders
note right: 平均响应时间 <200ms\n峰值负载 1000TPS
Gateway -> Order : 创建订单(异步)
... 订单处理耗时 ...
Order --> Gateway : 处理结果
note over Order #FFAAAA: 数据库操作耗时\n需优化索引设计
@enduml

实践建议：

使用note right标注接口级SLA指标
通过...虚线表示已知的延迟时段
用颜色区分性能热点（如红色表示瓶颈）

2. 安全约束标记

安全标注能有效提醒开发人员注意敏感操作，推荐结合图标增强可视化效果。

@startuml
participant User
participant AuthService
database DB

User -> AuthService : 登录请求
hnote over AuthService #lightgreen
<color:red>🔒</color> TLS 1.2+强制加密
end hnote

AuthService -> DB : 验证凭据
hnote over DB
<color:red>🔐</color> 敏感数据\nAES-256加密存储
end hnote
@enduml

关键技巧：

使用hnote创建横向标注框
插入Unicode锁图标(🔒/🔐)增强视觉提示
敏感操作建议使用红色强调

3. 可靠性标注

重试机制和熔断策略是可靠性设计的核心，可通过组合图形清晰表达。

@startuml
participant "Client" as C
participant "OrderService" as O

group 订单创建 [重试策略]
    C -> O : 创建订单
    alt 请求成功
        O --> C : 确认响应
    else 临时故障
        loop 3次重试
            C -> O : 重试请求
            O --> C : 响应
        end
    end
    opt 最终失败
        C -> O : 降级处理
    end
end
@enduml

最佳实践：

用group包裹相关可靠性逻辑
loop块明确标注重试次数
opt表示降级处理路径

4. 事务边界标识

分布式事务可视化是微服务架构设计的难点，PlantUML能清晰界定事务范围。

@startuml
participant "OrderService" as OS
participant "PaymentService" as PS
participant "InventoryService" as IS

group 分布式事务 [Saga模式]
    OS -> PS : 预授权支付
    activate PS
    PS --> OS : 授权结果
    
    alt 支付成功
        OS -> IS : 预留库存
        activate IS
        IS --> OS : 预留结果
    else 支付失败
        OS --> PS : 取消授权
        deactivate PS
    end
    
    opt 库存不足
        OS --> PS : 退款处理
        deactivate IS
        deactivate PS
    end
end
@enduml

设计要点：

使用group明确定义事务边界
activate/deactivate显示服务激活状态
通过alt/opt表达补偿事务路径

综合应用示例

@startuml
participant "Mobile App" as App
participant "API Gateway" as Gateway
participant "PaymentService" as Payment

box "高安全区" #LightBlue
    participant "AuthService" as Auth
    database "UserDB" as DB
end box

App -> Gateway : 提交支付
note right: 要求99.9%可用性\n超时时间3s

group 支付事务 [最大努力通知]
    Gateway -> Auth : 验证令牌
    hnote over Auth #pink
    <color:red>🔑</color> JWT RS256签名验证
    end hnote
    
    Auth -> DB : 查询用户权限
    ... 权限验证耗时 ...
    
    Gateway -> Payment : 处理支付
    loop 3次重试
        Payment --> Gateway : 处理结果
    end
end

App <-- Gateway : 支付结果
@enduml

架构标注原则：

安全域用box隔离并着色
混合使用note和hnote标注不同维度需求
关键路径明确性能指标
事务边界内包含可靠性设计

通过合理运用这些标注技术，您的架构图将同时传达功能和非功能性设计意图，显著提升团队沟通效率和技术决策质量。

PlantUML非功能性需求标注实战指南