系统开发规范

1、系统开发规范 TOC o 1-5 h z HYPERLINK l bookmark0 o Current Document 第1章公共类使用说明3 HYPERLINK l bookmark2 o Current Document SysStatus 类 3 HYPERLINK l bookmark4 o Current Document 类路径3 HYPERLINK l bookmark6 o Current Document 类描述3 HYPERLINK l bookmark8 o Current Document Constats 类 3 HYPERLINK l bookmark10 o

2、Current Document 类路径3 HYPERLINK l bookmark12 o Current Document 类描述3 HYPERLINK l bookmark14 o Current Document GlobalResult 类3 HYPERLINK l bookmark16 o Current Document 类路径3 HYPERLINK l bookmark18 o Current Document 类描述3 HYPERLINK l bookmark20 o Current Document 第2章开发规范4 HYPERLINK l bookmark22 o Cur

3、rent Document 命名规范4 HYPERLINK l bookmark24 o Current Document 注释规范4 HYPERLINK l bookmark26 o Current Document 日志记录规范6第1章公共类使用说明SysStatus 类类路径mon.status.SysStatus类描述该类为定义的系统级状态码及中文含义的说明类，在此类中，将状态码划分为三种类 型，分别是：系统级：S+三位数字成功例外，为000参数级：p+三位数字业务流程级：B+三位数字后续开发人员可根据实际使用情况在开发过程中对该类进行扩展与修改，建议各类型 状态码是连续的(例：S10

4、1、S102、S103；.)Constats 类类路径mon.utils.Constats 数据格式类描述该类为系统常量类，所有常量需统一再该类中配置。GlobalResult 类类路径mon.global.GlobalResult类描述该类为对返回数据结果进行统一封装的类，将要返回的数据放入到该类中，调用其toJSONString方法，则其返回标准格式的JSON字符串。示例如下：GlobalResult result=new GlobalResult();result.setCode( 1” );result.setMsg( 2” );result.putData(key, 3);调用res

5、ult. toJSONString方法，返回结果如下：code:1Tmsg:2,data:key:3第2章开发规范命名规范命名规范使程序更易读，从而更易于理解。它们也可以提供一些有关标识符 功能的信息，以助于理解代码，不论它是一个常量，包，还是类。1,包命名：包命名前缀总是全部小写的 ASCII字母。2,类命名：类名是个一名词，采用大小写混合的方式，每个单词的首字母大写尽量使类名简洁而富于描述。使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像URL, HTML)。3,方法：方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小 写，其后单词的首字母大写。4,变量：变量名采用大小写混

6、合的方式，第一个单词的首字母小写，其后单词 的首字母大写；变量名不应以下划线或美元符号开头。变量名应简短且富于描述、 易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的 临时变量。临时变量通常被取名为i, j, k, m和n,它们一般用于整型；c, d, e,它们一般用于字符型。常量名应该全部大写，单词间用下划线隔开。注释规范注释应被用来给出代码的总括，并提供代码自身没有提供的附加信息。注释 应该仅包含与阅读和理解程序有关的信息。类注释：应该有一个空行，用于把块注释和代码分割开来：/*类功能说明author 作者version 创建日期*/方法注释：应该有一个空行，用于把块

7、注释和代码分割开来/*方法说明param参数说明return返回值说明*/行末注释：注释界定符/,可以注释掉整行或者一行中的一部分。它一般不用于连续 多行的注释文本。在以下场景中需增加行末注释：1.,有逻辑判断的代码：例：if(a=1)/分支注释)else if(a=2)/分支注释 else/分支注释2,在程序中扮演重要角色的变量或方法返回值：例：/a的注释Stirng a;/b的注释String b=dealWith(a);3,决定程序走向的外部方法：例：/ getParam 的注释If(getParam()else)2.3日志记录规范日记级别分为debug info、error三个级别对于调试信息采用debug级别的日志；但建议不宜加的过多以免后续日志文 件过大，或记录debug日志前加上if (logger.isDebugEnabled()判断。Info：对于关键业务数据采用info级别日志进行记录，便于系统投产后系统 跟踪或问题分析。error:在系统发生异常时建议采用 error日志级别进行记录异常信息，更多应 用于catch语句块中。Info日志使用场景：1,对外提供的主要方法的进入与退出，需使用info日志进行记录。2,外部系统输入的josn字符串，必须使用info日志进行打印3,系统返回的数据，必须使用info日志进行打印。4,关键业务数据。