Java 代码规范:异常处理、版本管理和命名规则

需积分: 0 1 下载量 137 浏览量 更新于2024-09-09 收藏 25KB DOCX 举报
Java代码规范 Java代码规范是为了保证后台各模块的代码统一,避免一些常见的错误写法,后端java编程人员应该满足以下要求。下面是Java代码规范的详细说明: 一、异常处理 异常处理是Java代码中非常重要的一部分,需要统一封装业务异常类,正确地处理异常,避免异常淹没,正确地处理RuntimeException。 二、代码版本管理–SVN 统一采用SVN作为代码版本管理的工具,需要明确以下几点: * 代码提交必须有功能点说明或bug号。 * 避免混合提交,避免不同功能点的代码混合提交,以防版本回退。 * 提交的代码可编译,要求每个提交代码的组员必须保证自身提交的代码没有编译错误问题。 * 不允许包含项目无关内容,若使用maven管理项目,则提交的代码中只有java源代码及配置文件、pom.xml文件以及项目用到的静态资源(页面、css、js)或jsp文件等。 三、如何处理共同修改同一个代码 在开发中经常碰到同一个代码被多个同时修改并分别提交的情况,这样就需要项目组内部做好沟通,分先后提交更新或合并工作。 四、发版节奏 一般在关键里程碑时间节点或重大功能整体完成时需要发版,要求发版的功能相对完整和开发自身内测完成。避免把所有测试工作交给测试来做。具体发版节奏需要由双方项目经理共同制定,开发中的小版本由乙方项目全权决定。 五、主线和分支管理 项目功能有时候为了版本需要,需要在主线版本上拉分支代码,明确一下主线和分支版本的定位: * 主线:囊括项目建设的主线代码,开发人员提交代码就到这个代码库,保证开发进度的正常进行。 * 分支:有时候为了出关键版本,又考虑不影响开发进度正常进行,这时需要从主线中的一个相对稳定版本中拉出一个分支代码库。同时注意,分支中有些代码是和主线中是公共的,这时要注意是否同步修改主线的对应代码更新。 六、SVN使用准则 SVN使用准则包括: * 提交的文件,应在本地进行初步检验确认后,再行提交。 * 每次提交必须书写明晰的标注。 * 禁止提交本地生成文件。 * 禁止提交项目配置文件。 * 禁止提交调试中的半成品代码。 * 慎用锁定功能。 * 所有项目需要按天更新,至少上午下载一次,下午下班前提交一次。 * 特殊情况时按实际需要进行更新。 七、命名规则 命名规则是Java代码中非常重要的一部分,需要遵守以下基本规则: * 所有命名使用字符集在26个英文字母、0到9的阿拉伯数字和下划线之中。 * Java中类、字段、方法、变量、常量尽量用字母表达,没有特别的理由不能用任何的其他字符命名需要有一定的意义,推荐采用问题域中的术语命名,使命名在一定程度上是自描述的命名尽量的短。