J2EE 开发规范文档

目录

附录: ............................................................................................................................................... 3一、 命名约定 ............................................................................................................................... 4

1. 源代码文件中的几个基本包 . ..................................................................................................... 4

2. 所有包名均用小写字母来命名 . ................................................................................................. 4

3. 类中的变量应该使用骆驼命名法 . ............................................................................................. 4

4. 类中的方法命名同变量。 . ......................................................................................................... 4

5. S TRUTS 的命名 .............................................................................................................................. 4

6. S TRUTS 的跳转页 JSP 命名应与请求路径相同 . ........................................................................... 4二、 STRUTS 使用以及类使用约定 ............................................................................................... 4

1. 在整个 STRUTS 2 FAMEWORK中的一般流程如下:. ....................................................................... 4

2. 关于 PO (持久对象 P ERSISTENT O BJECT ) .................................................................................... 5

3. 所有 ACTION 类都应该继承 COM . GOLDPALM . TOUR . COMMON . ACTION 中的相关父 B ASE A CTION 类 ...... 5

4. A CTION 主要负责控制器任务 ...................................................................................................... 5

5. 关于不同子模块调用同一个 A CTION 的情况 ............................................................................. 6

6. 关于 S TRUTS 的 FORWARD 配置 ...................................................................................................... 6

7. 方法类中的参数设定 . ................................................................................................................. 6三、 自定义异常类使用约定 ........................................................................................................ 6

1. 必须继承 COM . GOLDPALM . TOUR . EXCEPTION .G OLDPALM E XCEPTION 异常类 .......................................... 6

2. 必须重写默认构造方法以及带 S TRING 参数的构造方法 .......................................................... 6

3. 默认构造方法必须有一个默认的异常抛出说明 . ..................................................................... 6四、 SPRING 使用约定 .................................................................................................................. 7

1. 所有业务逻辑 BEAN 都配置在相关的 APPLICATION C ONTEXT -SERVICE *.XML 中 ................................. 7

2. 所有 STRUTS 的 ACTION 都配置在相关的 APPLICATION C ONTEXT -ACTION *.XML 中 ............................... 7

3. 所有持久层 D AO 都配置在 APPLICATION C ONTEXT -DAO . XML 中 . ........................................................ 7

4. 所有公共业务类都配置在 APPLICATION C ONTEXT -COMMON . XML 中 ................................................. 7

5. 事务声明使用 A NNOTATION 在相关实现类的方法名上配置,不应配置在接口内 . .................. 7

6. 项目中事务管理必须写在业务逻辑层或者持久层中 .............................................................. 7

7. 事务管理须使用 S PRING 的 A NNOTATION 来管理 .......................................................................... 7五、 注释使用约定 . ....................................................................................................................... 7

1. 类中的开头注释 .......................................................................................................................... 7

2. XML 中的注释 ............................................................................................................................. 8

3. P ROPERTY FILE中的注释 ................................................................................................................. 8

4. JSP 标签定义注释 ....................................................................................................................... 8六、 JSP 页面约定 ......................................................................................................................... 9 1. \WEB-INF\JSP \COMMON 下存放公共的 JSP 页面 . .......................................................................... 9

4. JSP 标签定义注释 ....................................................................................................................... 8六、 JSP 页面约定 ......................................................................................................................... 9 1. \WEB-INF\JSP \COMMON 下存放公共的 JSP 页面 . .......................................................................... 9