软件架构之美_05_架构解剖欣赏

《软件架构之美_05_架构解剖欣赏》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、架构解剖之美-类-“编码规范”头顶三尺有神灵：写代码是在和电脑交流;是在和背后的人交流架构示意图编码规范代码质量三要素：可读、可维护、高效率1.可读性规范而且好看2.可维护性可读性支撑了可维护性，但进一步要求代码易于维护、易于变更3.高效率在关键应用场景中，我们要关注代码效率1.类组织元素声明1-1：包名：com.[企业名称].[项目名称].[一级模块名称].[二级模块名称].[层次名称]1-2：类名与接口名：业务名词+层次后缀1-3:常量属性、变量属性1-4:方法名1-5：局部变量：禁止使用单个字符，命名要清晰、明了，有

2、明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。1-6：用正确的反义词组命名具有互斥意义的变量或相反动作的方法等。2.必要的属性及变量2-1：去掉没必要的属性变量。2-2：仔细定义并明确属性变量的含义、作用、取值范围及属性变量间的关系。2-3：明确属性变量与操作此属性变量的方法的关系，如访问、修改及创建等。2-4：当向属性变量赋值时，要十分小心，防止赋与不合理的值或越界等现象发生。2-5：防止局部变量与属性变量同名。2-6：给所有变量赋初始值2-7：合理地设计数据类型，尽量减少没有必要的数据类型默认转

3、换与强制转换。3.必要的方法3-1：方法访问权限声明，要有明确的权限控制。3-2：方法声明的完整性，对返回类型、参数、例外都要有明确的说明。3-3：明确方法功能，精确地实现方法设计3-4：明确规定对接口方法参数的合法性检查应由方法的调用者负责还是由接口方法本身负责，缺省是由方法调用者负责。3-5：防止将方法的参数作为工作变量。3-6：方法的规模尽量限制在200行以内3-7：避免方法中不必要语句，防止程序中的垃圾代码。3-8：避免重复代码：如果多段代码重复做同一件事情，那么在方法的划分上可能存在问题。3-9：功能不明确的较小的

4、方法，特别是仅有一个上级方法调用它时，应考虑把它合并到上级方法中，而不必单独存在3-10：设计高扇入、合理扇出（小于7）的方法。3-11：减少递归算法：减少方法本身或方法间的递归调用。4.必要的注释4-0：支持自注释，通过对类，方法、变量等正确的命名以及合理地组织代码的结构，使代码成为自注释的。4-1：一般情况下，源程序有效注释量必须在20％以上4-2：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。4-3：注释的内容要清楚、明了，含义准确，防止注释二义性。4-4：避免在注释中

5、使用缩写，特别是非常用缩写。4-5：java程序文件应该包涵下列头文件：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等。4-6：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量的注释应放在其上方相邻位置或右方4-7：方法头部应进行注释，列出：方法的目的/功能、输入参数、返回值、调用关系、例外情况等。4-8：方法内注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其

6、上面的代码用空行隔开。4-9：注释与所描述内容进行同样的缩排4-10：对条件分支、循环语句必须编写注释4-11：避免在一行代码或表达式的中间插入注释4-12：在代码的功能、意图层次上进行注释，提供有用、额外的信息。4-13：在程序块的结束行右方加注释标记，以表明某程序块的结束。4-14：注释格式：尽量统一，建议使用“/*……*/”。4-15：注释语言：建议多使用中文，除非能用非常流利准确的英文表达。5.排版规范5-1：程序块要采用缩进风格编写，缩进的空格数为4个。5-2：相对独立的程序块之间、变量说明之后必须加空行。5-3：

7、较长的语句（>120字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。5-4：循环、判断等语句中若有较长的表达式或语句，则要进行适当的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。5-5：若方法中的参数较长，则要进行适当的划分。5-6：不允许把多个短语句写在一行中，即一行只写一条语句。5-7：if、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部

8、分无论多少都要加括号{}。5-8：对齐只使用空格键，不使用TAB键。5-9：方法声明，循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求。5-10：程序块的分界符‘{’和‘}’应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在方法体的开始、类