j2ee开发文档

**J2EE编码规范详解** J2EE（Java 2 Platform, Enterprise Edition）是一种用于构建企业级应用程序的Java平台，其编码规范对于确保代码的可读性、可维护性和团队协作至关重要。以下是对J2EE编码规范的详细解读： ### 1. **命名规范** #### 1.1 包命名 - 包名应全为小写，由业务领域名、公司名、项目名和模块名组成，例如：`com.light.dao` #### 1.2 类命名 - 类名应使用驼峰式命名，首字母大写，多个单词间用大写字母间隔，避免使用缩写，例如：`StudentPo` #### 1.3 属性/局部变量命名 - 属性应按访问权限顺序（public, protected, package, private）放置 - 局部变量应在代码块开始处定义 - 变量名应使用有意义的英文单词，避免使用下划线或减号，如：`custName` - 单字符变量通常用于短期变量，如循环中的`i`, `j`, `k` - 集合变量以复数形式表示，如：`names`, `fileCounts` #### 1.4 常量命名 - 常量名全为大写，单词间用下划线分隔，例如：`MAX_NUM` ### 2. **方法命名** - 非REST风格的方法名遵循"动作+属性"的模式 - 动作以小写字母开头，属性以大写字母开头，如：`getName`, `setName`, `isSysManager` ### 3. **编码规范** #### 2.1 程序基本构成 - 公用元素的使用需谨慎，避免过多的公共变量 - 函数返回值应初始化 - 注释清晰，临时代码删除使用`/*...*/` - 变量应设定初始值 - 检查并处理错误返回值 - 释放不再需要的内存 - 提供Eclipse配置的类和方法注释 #### 2.2 异常处理 - 下层异常向上层抛出同一类异常，如业务处理层向请求处理层抛`ApplicationException` - 底层异常信息应包含在新异常中 - 统一继承父类异常，方便捕获 - 异常处理集中在请求处理层，记录日志由框架自动处理 ### 3. **异常处理策略** - **I. 异常处理总原则** - 下层只向上层抛特定异常 - 系统异常信息需保留在抛出的异常中 - 使用统一的父类异常进行封装 - **II. 请求处理层的异常处理** - 所有Controller继承统一异常处理类，集中处理异常 遵循这些编码和异常处理规范，能提高J2EE应用的代码质量和稳定性，降低维护成本，同时提升团队合作效率。在实际开发中，团队成员应共同遵守这些标准，以确保项目的整体质量。