uml - Web 服务调用序列图的好例子？

Question

我被要求制作一个序列图来记录我的应用程序进行的网络服务调用。

我不是很懂时序图。它们很难阅读 - 很多行，而不是很多文本。例如，如果我想显示我的应用程序调用了特定服务，传递了一组数据并返回了一组不同的数据，那么线路输出和线路返回上几乎没有足够的空间来显示所有这些数据并指出它是一个 GET 或一个 POST，如果没有这些信息，该图就非常简单到不是很有用的地步。我发现在文本文件或 wiki 上记录这样的东西要容易得多。但我看到序列图非常流行，所以我认为我没有“理解”它们。

所以我现在有三个问题:

(1) 谁能向我展示一些特别好的/有用的 Web 服务调用序列图示例，以便我了解这是如何正确完成的？

(2) 当流程具有导致不同 Web 服务调用的不同逻辑路径时，我应该在单个序列图中用 if/then/else 表示这些路径，还是为每种可能性创建不同的序列图？

(3) 我知道序列图是基于UML 的，但是UML 在什么方面是一种“语言”？没有它的文本表示，对吗？这似乎更像是一种绘制图表的方式，例如流程图。

Answer 1

在您的案例中，序列图的目的是将某些信息传达给您的同事(或 future 的自己)。真的没有“最好”的方式去做，就像没有最好的方式来写这个答案一样——我已经改写了这个答案，如果我在一年内重新阅读我的答案, 我可能会再次改写它以使其更清楚。

这里的图表也是如此；如果您自己不理解该图(假设您理解序列图的用途)，那么其他人也不会理解它。

也许在你的情况下这样的事情就足够了

首先关注沟通，稍后再考虑是否“符合”UML 规范。

(3)您是否认为手语是一种语言，即使它使用手势而不是文本？

同样，UML 具有代表各种概念的视觉元素的“词汇表”——带有生命线和消息的序列图表达了参与者(类)之间的一系列通信。此外，您可以在图表中添加注释以阐明您的意图。

(2) 你可以两者都做。同样，决定性因素是沟通的清晰度——如果单个图表太困惑，则将其分解并制作另一个或更多(就像拆分方法和类一样)。一条经验法则是在整个图表中保持相同的抽象级别——突然深入实现细节可能会很快使图表变得困惑。

(1) 最好的开始方式是先学习图表的“词汇”，例如uml-diagrams.org ，然后画点东西，看看自己看懂了还是别人看懂了；如果您觉得可以更好地“改写”图表，请不要害怕扔掉它。

there's hardly enough room on the line out and the line back to show all this data

听起来像是一个工具问题；只需将线分开，或使用类似 PlantUML 的东西那就是为你做的。 (或使用实际的 UML 工具。)

the diagram is minimalistic to the point of not being very useful

然后丰富它，添加文本注释，拆分它。将其用作文档的部分，仅说明某些要点；您不必将图表用作唯一的文档工件。