您好,欢迎来到暴趣科技网。
搜索
您的当前位置:首页Java开发设计规范

Java开发设计规范

来源:暴趣科技网
Java开发设计规范

1. 命名规范

标示符类型 命名约定 全部小写。 标识符用点号分隔开来。 包 包名使用com.gzbilin 开头 。 业务逻辑的包名以com.gzbilin.bo开头 系统框架的包名以com.gzbilin.framework开头 公用工具类的包名以com.gzbilin.utils开头 类的名字应该使用名词。 类,接口 每个单词第一个字母应该大写。 避免使用单词的缩写,除非它的缩写已经广为人知,如HTTP。 方法 第一个单词一般是动词。 第一个字母是小写,其他单词的第一个字母是大写。 Class HelloWorld ; Interface Apple; 例子 方法名称规则: 使用get+成员变量获取成员变量,使用set+成员变量设置成员变量。 涉及到数据库更新功能,使用update* 查询或报表功能,使用query* 删除功能,使用delete* 其他业务功能,如果不需要事务,则可以按自己的理解命名 第一个字母小写,中间单词的第一个字母大写。 不要用特殊符号作为第一个字母。 变量 尽量使用具有意义的单词。 单字符的变量名一般只用于生命期非常短暂的变量。i,j,k,m,n一般用于integers;c,d,e一般用于characters。 如果变量是集合,则变量名应用复数。 常量 所有常量名均全部大写,单词间以‘_’隔开。 页面名称第一单词首字母使用小写,其他单词第一个字母是大写 JSP文件命名 大部分情况下,单模块一文件夹,其中 列表页面使用 实例名称+List.jsp 新建或编辑页面使用 实例名称+View.jsp int MAX_NUM; 导入使用 实例名称+Import.jsp 选择使用 实例名称+Select.jsp 报表功能的 查询条件页面 报表功能+ Condition.jsp命名 结果页面以 报表功能+Report.jsp命名 命名规则:EntityClassName+Action.java URL规则:路径/ActionName!方法名称.action?参数 方法名称规则: 查看单个对象,使用view Action 查询功能,使用query 新增功能,使用create 修改功能,使用update 审批功能,使用approve 删除功能,使用delete 如果需要有所区分实体,在按照功能划分后,使用上述前缀

2. 编程惯例

 特定业务逻辑使用的变量在方法体本身内定义,不允许定义为类的实例变量。  方法体不宜过长,应控制在40行以内。  类与方法加上注释,介绍类与方法的作用/** */。  变量较多时,需要给变量分别加上注释。  代码逻辑过于复杂时,需要加上注释。

 注释需要简明扼要,用简单的语句清楚的表达代码的逻辑。

 两段逻辑不同的代码(如变量定义与逻辑代码)中间使用空行分开,提高代码阅读性。  If语句总是用大括号“{”和“}”括起来,避免出错,即使只有一行代码。

 当一个变量是boolean型时,应该使用if(booleanExpression){},而不是if(booleanExpression==true){}。  表达式较长时,需要注意用小括号控制表达式的优先级。

3. 编程注意事项

 对于String类型的操作,使用org.apache.commons.lang.StringUtils类,如:StringUtils.trim(result)清空字符串两边的空格、

StringUtils.equals(result, \"Result\")比较字符串相等。

 从JSP页面传值到Action时,使用ParamUtils进行参数的取值,不要使用原有的Request。

 对于日期的操作,使用org.believe.core.utils.DateUtils类,如:DateUtils.formatDate(new Date(), \"yyyyMMdd\")将Date转化为yyyyMMdd

格式的字符串、DateUtils.formatStringToDate(\"20110503\将字符串按照yyyyMMdd的格式转化为Date。  对于数组的操作,使用org.believe.core.utils.ArrayUtils类,如:public static String[] toArray(List list)将list转化为数组。  对于一些字段的操作,请参考org.believe.core.utils.FieldUtils中是否有相应的方法,如:public static String ToSBC(String input)将全

角字符转化成半角,public static boolean isInteger(String value)判断字符串是否为整型。  尽量不要书写嵌套循环,如果循环必须嵌套,将循环次数多的放在里层。

4. 组件约定

 所有的功能,增删改查涉及的数据库操作或某些固有逻辑定义在 *Manager.java 类中,对外开放的访问定义在*Service中,*Service

需要包含接口以及实现类。

 *Action中的方法,使用logger输出信息,特别是放方法的开始与结束需要用 if(Debug){//输出方法开始与结束 }方便在Debug状

态下对方法进行跟踪。

5. Pojo约定

 字段类型

 与各自的类型对应,布尔值使用Boolean,数据库使用bit。  不使用基本数据类型,如int的使用Integer。

 字段名称

名称 中文名 英文名 创建者 更新者 创建时间 更新时间

命名 chinName engName createBy updateBy createTime updateTime

因篇幅问题不能全部显示,请点此查看更多更全内容

Copyright © 2019- baoquwan.com 版权所有 湘ICP备2024080961号-7

违法及侵权请联系:TEL:199 18 7713 E-MAIL:2724546146@qq.com

本站由北京市万商天勤律师事务所王兴未律师提供法律服务