软件设计规范

软件设计规范

软件设计规范第一章概述软件设计是将需求转化为软件系统的最重要环节。它包括体系结构设计、界面设计、数据结构和算法设计、数据库设计、接口设计、安全设计等。软件设计的优劣决定了软件系统的质量。然而，由于历史原因，软件设计在开发中的重要性没有得到合理的体现。很多软件的设计工作都是有名无实，设计文档更是五花八门，几乎完全依赖于设计人员个人的设计水平与经验。很多设计文档几乎没有使用价值，开发人员都是直接看需求。这样，最终软件的质量完全依赖于开发人员的水平。为了解决这一问题，制定一份软件设计规范，就成为最好的选择。本规范对软件设计过程、设计方法、设计工具以及设计要做到的程度进行了规定。同时，特别对逻辑设计进行了详细规定，物理设计在本阶段暂不做要求。第二章适用范围本规范适用于开发部所负责的项目，其它部门的项目可进行参考。技术类项目，必须全部符合本规范。对于Dephi技术类项目，可以进行取舍。对于完全新建项目，必须全部符合本规范，对于在旧系统之上进行扩展的项目，可以对本规范进行取舍，对于维护类项目，可以不按本规范进行。由于项目的特殊原因，可以对设计过程进行取舍，但不得降低所执行设计过程的规范要求。一旦设计过程确认后，必须严格执行设计规范。此规范的符合，是评审通过的唯一依据。未通过设计评审的项目，可以继续进行后续工作，但评审委员会不再对此项目的软件质量负责。第三章名词解释逻辑设计是将用户业务语言转化为项目组语言的关键。它是指在需求的基础上，从业务逻辑和当前用户应用环境中抽象出系统对象的组成结构、流程和各个部分相互关系，另外还要设计数据库的逻辑结构和界面的逻辑关系。在逻辑设计中的对象只是抽象的系统对象，而不是物理实现中采用的类、组件、模块和页面。物理设计是指在逻辑设计的基础上，从系统的逻辑对象、数据实体和界面逻辑关系中进一步整理和细化得到的设计方案。物理设计将确定系统采用的技术方案、平台，并明确实际开发的组件、数据库表、窗口以及页面等，并考虑到实现的可能性和最终系统的性能。面向对象的软件设计方法从对象的角度出发，将系统分解成若干个对象，然后定义对象之间的关系，最终实现整个系统。在这种方法中，每个对象都有自己的属性和方法，对象之间通过消息传递进行通信和交互。这种方法能够更好地应对需求的变化，具有灵活性和可重用性，适用于需要快速迭代开发的项目。在使用这两种方法进行设计时，需要注意以下几点：1.明确需求，避免过度设计和不必要的复杂性；2.尽可能使用设计模式，提高代码的可读性和可维护性；3.在设计过程中进行验证和测试，确保设计的可行性和正确性；4.遵循统一的设计规范和标准，提高团队协作效率。总之，软件设计是一个非常重要的环节，直接影响到软件的质量和开发效率。采用合适的设计方法和过程裁减策略，能够更好地应对不同类型的项目需求，提高软件开发的成功率和效果。面向对象的设计方法是一种工程化规范，它是用于解决软件问题的设计范式。这种方法通过使用对象来表现问题领域的实体，每个对象都有相应的状态和行为。核心思想是面向自然的设计，即通过识别和表达出系统中对象、对象间的关系、对象的状态迁移等关键因素，软件设计达到自然的、正确的描述目标系统的目的。在过去的十多年里，面向对象方法对软件行业起到了极大的推动作用，并且在可以预测的将来，它仍将是软件设计的主要方法。第四章逻辑设计中，系统设计是指以系统为主要设计对象，关注系统可由哪些子系统或模块构成，这些子系统或模块之间的关系如何，系统与其它系统之间的接口有哪些，接口之间如何进行通信。系统设计的要求包括使用公司的统一架构，在架构不满足的情况下，如何进行扩充，可以分为几个模块，各个模块之间关系如何，模块是如何通信的，每个模块的外部接口是什么，接口的参数是什么，返回值是什么。如果系统较为庞大，可将系统分为子系统，必须明确定义各个子系统之间的关系，系统与其它系统的接口有哪些，接口的参数是什么，返回值是什么。系统设计前，必须编写软件功能规格说明书，以明确功能需求。在UML中，绘制包图，用来表示子系统或模块；在包图上绘制类图，用来表示接口；绘制序列图，用来描述系统与外部系统之间、子系统之间、模块之间的通信。系统级的业务流程用序列图来描述，业务规则可在序列图或类图之上用文本框进行说明。系统设计中所有的交互形为只描述到接口一级。如果有无法使用UML进行说明的内容，可使用其它格式的文档，但必须将相关文档与UML进行链接或嵌入。系统设计中不考虑人机交互的设计。业务数据表记录了业务过程和结果，如加油流水、销售单、出库单、凭证、业务账。基本编码表描述了业务基本信息和编码，一般变化很慢，如油品、组织机构、人员。辅助编码表描述了属性的列表值，如销售类型、付款方式。系统信息表存放与系统操作、业务控制有关的参数，如用户信息、权限、用户配置信息、成本核算方式。累计数据表存放业务的当前值和累计值，如当前库存、当前存款、累计销售、累计支出、应收账款。结算数据表存放各个时期末的结存数，如月末库存、月末银行存款、应收账款月结。决策数据表存放各个时期内发生的统计值，如月销售统计、月回款统计、出入库统计。数据库设计要求符合第三范式，必须设计到表、视图、存储过程、关系。表的设计必须明确字段数据类型、长度、默认值、是否非空，存储过程必须明确参数和返回值，关系必须明确增、删、改时的处理方式。对于一年内记录会超出百万的数据，必须考虑性能的问题。表必须有唯一明确业务的字段，此字段可以不是主键，但应尽可能使用本字段作为主键。此字段不允许使用自增字段。接口设计是指系统与外部系统之间和系统各子系统、模块之间的关系的设计。接口设计工作的好坏，直接影响着系统今后维护和扩展的难易程度，必须高度重视。接口设计要充分体现强内聚低耦合的要求，不能出现到处关联的现象。系统外部接口的设计是所有设计工作的第一步，只有通过外部接口设计，才能明确系统的外部边界。外部接口设计要求明确说明系统与其他系统的数据库、应用服务、界面各个部分之间的接口。明确说明每个外部接口是什么，接口的参数是什么，返回值是什么。参数与返回值必须明确定义，不能有二义性。系统不得通过已设计的外部接口以外的任何方式进行外部通信。接口参数是复杂对象、字符串、文件时，必须对这些参数内