架构组-文档总结

简介: 架构组-文档总结

包图规范

1. 格式

2. 关系

  • 泛化
  • 依赖

3. 元素

  • 接口
  • 构件
  • 节点
  • 协作
  • 用例
  • 其他包或图

4. 可见性

  • “+” :public
  • “-” :private
  • “#” :protected

5. 绘制原则

  • 每个包都必须有一个唯一的包名
  • 包图中拥有的元素不得超出规范中的六种元素
  • 最小化包间的依赖,最小化每个包中的 public , protected 元素个数,最大化每个包中 private 元素个数
  • 包间关系不能出现循环依赖的情况
  • 包中可以嵌套子包
  • 包图需体现出包间的层级关系,一个层级的包放到一张图。一般情况下,只绘制第一层级的包关系即可。
    6. 示例

类图规范

1. 格式

  • 接口
  • 抽象类

2. 关系

  • 继承:实线+空心三角 继承父类
  • 实现:虚线+空心三角 实现接口
  • 组合:实线+实心菱形 成员变量
  • 聚合:实线+空心菱形 成员变量
  • 关联:实线+箭头 成员变量
  • 依赖:虚线+箭头 局部变量、方法的参数或者对静态方法的调用

3. 标准

  • 1.类间关系的格式与描述要做到准确无误,紧密贴合代码,与代码保持一致。
  • 2.符合UML规范。
  • 3.在UML基础上,不能有二义性,图要能表达出来明确的含义。
  • 4.统一,整体看着整洁,一致,比如关系:继承和实现关系纵向画,其他关系横向画。

NS图规范

1. 结构

  • 顺序结构
    表示程序中的个操作是按照他们出现的先后顺序执行的
  • 选择结构
    表示程序的处理步骤出现了分支,他需要根据某一特定的条件选择其中的一个分支执行。选择结构有单选择、双选择的多选择三种形式
  • 循环结构

直到型循环:表示从结构入口处直接执行循环体,在循环终端处判断条件,如果条件不满足,返回入口处继续执行循环体,直到条件为真时再退出循环到达流程出口处,是先执行后判断。因为是"直到条件为真时为止",所以称为直到型循环。

当型循环:表示先判断条件,当满足给定的条件时执行循环体,并且在循环终端处流程自动返回到循环入口;如果条件不满足,则退出循环体直接到达流程出口处。因为是"当条件满足时执行循环",即先判断后执行,所以称为当型循环。

  1. 注意事项
  • 图形清晰、整齐
  • 全局到局部思路来画
  • 必须要有返回的结果,并且返回内容显示明确
  • 不允许出现不属于图的元素,如指向线和注释标签

架构图规范

宏观出发

  1. 整体结构
  2. 色彩搭配

局部细节

  1. 用词表达
  2. 是否全面
  3. 模块划分粒度
  4. 模块摆放以及层级关系
  5. 图形间距离适中,避免间距过大、过小,影响美观
目录
相关文章
|
2天前
|
SQL NoSQL 前端开发
基于BS架构的饰品购物平台设计与实现(程序+文档+数据库)
基于BS架构的饰品购物平台设计与实现(程序+文档+数据库)
|
7月前
|
缓存 运维 NoSQL
GitHub开源大厂缓存架构Redis优化的文档被警告,900页全是干货
掌握Redis对Java程序员来说很有必要了。实际上,很少有人真的掌握了Redis的全部技巧,有些甚至连面试题都很难应付。那么,如何全面系统地学习Redis呢?
|
7月前
|
设计模式 架构师 Java
阿里P8架构师都要学习研究的java加强版23种设计模式神级PDF文档
说在前面的话 Java作为老牌纯正的编程语言,在规范性上有着天然优势。因此本版的设计模式讲解全部用Java语言来描述,并针对Java语言的特性对讲解内容做了相当大的改动。 不知道大家是否听过编程界的一段话:掌握设计模式相当于华山派的"气宗",是程序员的内功修为,虽然在同样的学习时间下,类似Python这种"剑宗"的开发模式见效更快,但是长远来看,"气宗"才是走向软件架构师以上级别的必由之路。 所以,掌握气宗就掌握了编程命脉,然而学习设计模式有四大境界: 接下来给大家分享的就是java溢彩加强版大话设计模式包含的内容知识点。 总目录 主要内容 本文是百万销量的经典畅销书《
131 0
|
7月前
|
Cloud Native 架构师 Java
谷歌架构师分享gRPC与云原生应用开发Go和Java为例文档
随着微服务和云原生相关技术的发展,应用程序的架构模式已从传统的单体架构或分层架构转向了分布式的计算架构。尽管分布式架构本身有一定的开发成本和运维成本,但它所带来的收益是显而易见的。
|
存储 运维 Kubernetes
终于读完了阿里云p9专家分享云原生Kubernetes全栈架构师实战文档
Kubernetes(简称K8s)发布至今已经被越来越多的公司所接纳,其受欢迎程度更是超过了人们的想象,已逐渐成为很多公司的标配,尤为重要的是掌握Kubernetes几乎成为所有互联网技术人员必备的一项技能。 Kubernetes的诞生象征着下一代云计算的时代已经来临,它的出现让很多应用和架构逐步实现了统一化、标准化、简单化,降低了公司因为架构设计不合理带来的问题,而且也大大减少了运维成本,使用Kubernetes可以轻轻松松管理上千台服务器、上万个容器节点。
|
8月前
|
开发框架 架构师 Java
Java程序员不掌握SpringBoot怎么进大厂,阿里架构师推荐实战文档
Spring Boot作为Java编程语言的一个全新开发框架,在国内外才刚刚兴起时,还未得到普及使用。相比于以往的一些开发框架,Spring Boot不但使用更加简单,而且功能更加丰富,性能更加稳定而健壮。使用Spring Boot开发框架,不仅能提高开发速度,增强生产效率,从某种意义上,可以说是解放了程序员的劳动,而且一种新技术的使用,更能增强系统的稳定性和扩展系统的性能指标。本书就是本着提高开发效率,增强.系统性能,促进新技术的普及使用这一目的而写的。
|
9月前
|
XML 架构师 Java
公司刚来的京东架构师:看完我写的spring笔记,甩给了我一份文档
Spring 是分层的 full-stack(全栈) 轻量级开源框架,以 IoC 和 AOP 为内核,提供了展现层 SpringMVC 和业务层事务管理等众多的企业级应⽤技术,还能整合开源世界众多著名的第三⽅框架和类库,已经成为使⽤最多的 Java EE 企业应⽤开源框架。
|
9月前
|
Java 应用服务中间件 Redis
十年架构师总结:SSM+微服务+Nginx+Redis+MySQL的PDF文档
SSM 第1部分入门和技术基础 第1章认识SSM框架和Redis 第2章Java设计模式 第2部分互联网持久框架- -MyBatis 第3章认识MyBatis核心组件 第4章MyBatis配置 第5章映射器 第6章动态SQL 第7章MyBatis的解析和运行原理 第8章插件 第3部分Spring基础 第9章Spring IoC的概念 第10章装配Spring Bean 第11章面向切面编程 第12章Spring和数据库编程 第13章深入Spring数据库事务管理 第4部分Spring MVC框架 第14章Spring MVC的初始化和流程 第15章深入Spring MVC组件开发 ......
|
2天前
|
开发框架 架构师 Java
Java程序员不掌握SpringBoot怎么进大厂,阿里架构师推荐实战文档
Spring Boot作为Java编程语言的一个全新开发框架,在国内外才刚刚兴起时,还未得到普及使用。
|
2天前
|
安全 Java 应用服务中间件
全网最新架构实战文档:高并发+分布式+微服务+SpringBoot+Nginx
关于一线互联网大厂网站的一些特点:用户多,分布广泛、大流量,高并发、海量数据,服务高可用、安全环境恶劣,易受网络攻击、功能多,变更快,频繁发布、从小到大,渐进发展、以用户为中心。