如何为SPA和REST API创建类图?

时间:2016-03-22 07:36:45

标签: rest uml single-page-application class-diagram

上下文

我创建了一个SPA(单页面应用程序)和一个REST API。 Backbone.js用于开发SPA,Codeigniter用于REST API的服务器端实现。

问题

对于MVC应用程序,我们可以像往常一样绘制单个类图。但是,如何为具有SPA和REST API的系统创建类图?您是为每个应用程序创建两个单独的类图还是为两个应用程序创建单个类图?如果有一个图表,可以使用哪些关系/关联来连接SPA和REST API?

1 个答案:

答案 0 :(得分:1)

如何组织服务器和客户端的类图

  1. 如果组件没有公共类,则公共类图是没有意义的。
  2. 很可能你有一些共同的类,因为客户端和服务器使用现实世界的相同对象,并且适当的类应该是相同的。每个这样的类也应该只有一个代码实现。由于这些常见类将属于域区域(方法,通常用于您的主题),因此您可以将它们全部分成另一个。因此,您将有两个相交的组件,但有三个不相交的包。您也可以绘制原始包图。
  3. 如果组件的类图很大,请始终使用它们中的两个(或更多),以某种特殊方式标记公共类。 (蓝色表示与组件A相同的类,红色表示与组件B相同的类...)。
  4. 类图不用于对行为进行建模,例如调用组件和事物。这将是一个糟糕的风格。如果您仍想撰写有助于理解的行为细节,请在评论中进行。
  5. 为了对组件的行为连接进行建模,请使用通信或序列图。