究竟应该在类图中表示什么

Question

我正在撰写我的Bsc IT年终项目，并且对于在类图中究竟应该表示什么以及什么不是真正必要的内容感到困惑。

在我的情况下使用spring with MVC+hibernate。我只是代表我的实体类与他们之间的关系。现在我想创建一个活动图，我意识到可能涉及MVC controller类，我没有包含在我的class diagram中。

第二个问题：在activity，sequence和data flow diagrams之间哪一个更好document a flow of process（不是必要的数据）。假设我想记录authentication的工作原理（由signup，verification和login组成）

非常感谢

Answer 1

UML是一种通信工具。您的目标是让其他开发人员明白您的意图。明确需要多少详细信息取决于您想要沟通的内容。

如果您将UML视为工程图，您可能需要每个类，每个方法签名，每次调用。您可以将这样的东西放在开发人员的桌面上，让他们为您的愿景编写代码。我认为这种情况很少发生。它与编写代码一样多，但它不可测试。

我认为将类及其交互包含在一个足够简单的级别以显示高级意图更为现实。让开发人员填写其余的细节。

Answer 2

类图显示了类之间的关系，对于每个类，显示了重要的成员变量和函数。这样，它们显示了角色和职责，允许设计人员确定哪些软件模块应包含哪些功能。使用继承时，它们对于显示层次结构非常有用，在浏览代码时需要花费更长的时间来识别。对于属性和方法，请显示受众群体所需的详细信息量。

当有多个合作的类/组件达到目的时，我喜欢序列图。每个序列显示一个且仅一个场景，因此具有前提条件，单个流程序列（例如，不代表决策）和后置条件。活动图更适合用于显示具有决策，错误处理等的顺序算法。如果存在合作和同步点，我还在一个图中使用多个活动。