Java开发中的命名规范

本文详细介绍了Java开发中的命名规范,包括工程包结构、类名、变量名、方法名及常量名的命名规则,并强调了良好的命名习惯对于提高代码可读性和维护性的重要性。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

      在软件开发中,命名是非常重要的一个方面。尤其是在团队开发中大型的项目中,命名的规范不可忽视。开发过大型项目的的软件工程师都可能遇过这种情况,在项目的命名不规范,导致代码的可读性下降,看不懂其他工程师写的代码,这是个很严重的问题。对于项目后续维护来说,也是不可想像的。除此之外,注释也一样不可忽视,尤其在Java开发中。时间久了,有可能你再回头看你写的代码,由于没有注释,你也看不懂是什么意思。所以在此,收集了一些关于在Java开发中命名规范的细节,希望对于Java开发的工程师来说,有点帮助。

1、Java工程包结构命名规范:

     所有的包都以类似于com.accp.ssh06为前缀,组成的单词全部都要小写,单词与单词之间以点号分隔。
     注:com代表你属于什么组织,比如公司就用com,如果是个人开发的一班用net,如果是开源组织一般用org等。以此类推,accp代表你的公司是什么名字,比如accp就是一个公司名称代号,如果是个人的一搬用个人的名字,ssh06代表项目名称,是什么项目就用什么项目名称。我很喜欢用org开头,因为Java是开源免费的。
     当前缀包写好后就到了具体的功能包结构,以下以com.accp.ssh06为前缀的例子:

     (1)servlet可以放到com.accp.ssh06.web.servlet包下面;
   (2)struts的action放到com.accp.ssh06.web.action包下面;
     (3)struts的form放到com.accp.ssh06.web.form包下面;
     (4)filter可以放到com.accp.ssh06.web.filter包下面;
   (5)所有的web工程监听器类放到com.accp.ssh06.web.listener包下面,也就是说所有与web层相关的内容都放到com.accp.ssh06.web下面的子包中;

     (6)所有的业务接口类(包括所有的spring的业务接口)都放到com.accp.ssh06.biz包下面;
     (7)所有业务类的实现类都放到com.accp.ssh06.biz.impl下面;

     (8)所有的数据库访问接口都放到com.accp.ssh06.dao包下面;
     (10)所有的数据库访问实现类都放到com.accp.ssh06.dao.impl包下面;

     (11)所有的实体类都放到com.accp.ssh06.entity包;

     (12)所有自己构建的值对象(VO)都放到com.accp.ssh06.vo包下面;

     (13)一搬所有的工具类都放到com.accp.ssh06.util包下面;
     (14)一般所有的通用类都放到com.accp.ssh06.common包下面;

     (15)如果工程中有启动功能的类放到com.accp.ssh06.context包下面。

2、Java类名的命名规范:

     组成类名的每个单词的首字母要大写,如: AccpTeacher。而且类的取名要有一定的实在意义,让人一看就懂,明白你写的这个类是什么意思,有什么用。如:TeacherDaoImpl表示老师类的数据访问层接口的实现类,里面实现了Dao中的所有方法。

3、Java变量名和方法名的命名规范:

     组成变量名和方法名的第一个单词首字母小写,第二个单词以后首字母大写,如:firstChild、createElement()。与Java类名的命名规范一样,变量名和方法名的命名也要有一定的实际意义,让团队成员一看就懂。

4、Java常量名的命名规范:

     组成常量名的所有单词都要大写,多个单词中间用下划线分隔,如:MAX_NUM。与前面Java类名、变量名和方法名一样,命名也有实际意义。如:MAX_NUM表示一个数字的最大值,因为MAX是最大的意思,NUM是数字的意思。这样,团队中的其他成员一看就明白。

1. 模块命名数据库命名、域模型命名、各分层的类/方法命名、页面的命名; 模块命名: a. 包命名com.project_name.module_name.action/service/dao/ws; service的实现都置于com.project_name.module_name.service.impl下; b. 接口命名遵守XxxxService,接口实现遵守XxxxServiceImpl; 2. 包的设计、页面的层次结构设计(jsp/css/js等文件的结构); 3. log、异常(声明式异常)的约定设计; 4. 链接、按钮、表单提交的统一方式;通用式Ajax调用与页面跳转统一模型; 5. 响应一个请求的分层结构约定,列举几个示例(常规调用、Ajax调用、WebService调用、提供WebService暴露、硬件设备接口调用); 6. 验证代码质量的约定,如JUnit、EMMA、FindBugs、CheckStyle、PMD的使用;Hudson持续集成需注意的; 7. 压力测试、防内存泄漏测试; 基础CSS:标签的各种状态的样式;表格单双行的样式; 开发一个Action请求的响应: 前置条件:该Action涉及的Entity及EntityName.hbm.xml已经准备好。 步骤: a. 前端页面触发Action的请求; 统一采用全路径请求,URL格式: 1> basePath/web/moduleName/*_ *.action {1}  EntityName,{2}  ActionMethodName 2> basePath/web/moduleName/gotoXxx.action (无需调用Service,直接跳转) 包括jQuery的Ajax方式和非Ajax方式; 包括表单提交; 参数设值的方式: 1> URL参数: basePath/web/moduleName/*_*.action?entity.propertyName=paramValue&paramName=paramValue 2> 或 另外,对于表单的提交,前后台都必须做数据校验,SWDF已提供了此能力,进行简单的配置即可,前台直接提供类似以下代码即可,点此查看前端校验详细规则说明。 前端校验示例; 后台数据校验,点此查看校验详细说明. b. 配置struts-moduleName.xml; 直接跳转示例; 调用Service示例; c. 开发对应的{EntityName}Action类; 该类必须继承com.hikvision.swdf.xx.BaseAction,该Action类有一个关键属性entity,即泛型Entity类的一个实体,该属性默认填充好了请求提交过来的entity对应参数(即entity.propertyName); d. 开发Service接口和Service接口实现,并在Action中通过set方法注入该Service; 接口文件:UserService 接口实现:UserServiceImpl 注入Service e. 开发DAODAO继承com.hikvision.xxx.HibernateBaseDAO; 示例 f. 配置applicationContext-*.xml; 配置DAO bean、Service Bean、Action Bean及注入的配置; g. 测试; 备注: 1. Action建议统一遵守通配符的约定,basePath/web/moduleName/*_ *.action {1}  EntityName,{2}  ActionMethodName 2. 统一命名规则:接口类似UserService,接口实现类型UserServiceImpl;(IUserService和UserServiceImpl) 开发一个Action调用关联应用提供的WebService 前置条件:该WebService?WSDL可正常获取 步骤: a. 配置applicationContext-wsclient.xml; Spring管理第三方WebService实例bean Jaxws-client配置代码 b. 生成第三方WebService接口文件;(提供系统自动生成) 自动生成代码 c. 页面调用Action请求,Action中注入WebService实例bean; Action对应方法直接调用第三方WebService的相关方法; d. 测试; 备注: 1. 步骤b,接口文件必须同包名同类名置于src目录下; 开发一个Action调用关联应用开放的HTTP请求 步骤: 1. 页面调用Action请求; 2. Action类相应方法使用封装好的HttpClient相关工具类,准备好HTTP请求的相关参数header参数和body参数并以xml的方式提交HTTP请求; 3. 解析该HTTP请求返回值(XML或JSON); 4. 响应结果; 5. 测试; 备注: 开发一个需要对第三方应用发布的WebService 步骤: a. 开发WebService接口,@WebService进行注解该接口; b. 开发WebService接口实现类,@WebService注解该实现类,并制定endpointInterface; c. 配置applicationContext-ws.xml d. 测试 备注: 开发一个需要对第三方应用发布的RESTful Service 步骤: a. 开发RS接口,提供如下Annotation; b. 开发RS接口实现,并提供如下Annotation; c. 配置applicationContext-rs.xml 备注: 所有Annotation的涵义解释如下:
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值