JAVA编程规范v1.0.docVIP

JAVA编程规范 编 号： 版 本 号： 受控状态： 作 者： 分 发 号： 文档修改历史记录 文档修改记录 日 期 版本号 更改人 更改内容 文档审核记录 日 期 版本号 审核人 审核意见 目 录 1.Java 编程规范 3 1.1 排版 3 1.2 注释 5 1.3 命名 9 1.4 编码 11 1.5 性能与可靠性 15 2.基于Struts和EJB编程规约 16 2.1 总体原则 16 2.1.1 每个子系统纵向划分为五层），分别是：界面层、控制层、业务层、数据层 16 2.1.2 界面层负责页面的展现,使用ExtJS 16 2.1.3 控制层负责请求的转发，使用Struts Action 16 2.1.5 业务层负责业务的实现，使用EJB中的Session Bean 16 2.1.6 数据层负责数据的存取，使用EJB中的Hibernate 16 2.1.7 系统应严格遵循纵向分层的原则，在不同的层次中实现不同的功能 16 2.2 Struts编程规约 16 2.2.1 Struts配置文件定义 16 2.2.2 struts2中减少action数量（通配符使用） 16 2.2.3 事件定义 17 2.2.4 参数信息获取 17 2.2.5 命名规约 18 2.3 EJB编程规约 19 2.3.1 数据库连接 19 2.3.3 命名规约 19 1.Java 编程规范 1.1 排版 分界符（如大括号‘{’和‘}’）应各独占一行，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序或者static、,synchronized等语句块中都要采用如上的缩进方式。 示例: if (ab) { doStart(); } 较长的语句、表达式或参数（80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。 示例： if (logger.isDebugEnabled()) { logger.debug(Session destroyed,call-id + event.getSession().getCallId()); } 不允许把多个短语句写在一行中，即一行只写一条语句 说明：阅读代码更加清晰 示例：如下例子不符合规范。 Object o = new Object(); Object b = null; if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while,switch等语句的执行语句无论多少都要加括号{},case 的执行语句中如果定义变量必须加括号{}。 说明：阅读代码更加清晰，减少错误产生 示例： if (ab) { doStart(); } case x: { int i = 9; } 相对独立的程序块之间、变量说明之后必须加空行。 说明:阅读代码更加清晰 示例： if(a b) { doStart(); } //此处是空行 return; 在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格。 说明：阅读代码更加清晰 示例： if (a == b) { objectA.doStart(); } a *= 2; 类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。 格式： 类定义 { 类的公有属性定义 类的保护属性定义 类的私有属性定义 类的公有方法定义 类的保护方法定义 类的私有方法定义 } 修饰词按照指定顺序书写：[访问权限][static][final] 。 示例： public static final String str = “abc”; 1.2 注释 类和接口的注释放在class 或者 interface 关键字之前，import 关键字之后。注释主要是一句话功能简述与功能详细描述。类注释使用“/** */”注释方式 说明：方便JavaDoc收集,没有import可放在package之后。注释可根据需要列出：作者、内容、功能、与其它类的关系等。功能详