用户注册



邮箱:

密码:

用户登录


邮箱:

密码:
记住登录一个月忘记密码?

发表随想


还能输入:200字

小蜜锋    -  云代码空间

—— 技术宅拯救世界!

java应用的命名规范

2012-12-11|2447阅||

摘要:所有文件,变量统一采用英文单词表示。尽量避免简写和缩写。 一、 java类 java类根据java规范采用驼峰标示,java类首字母大写,类名中的各个单词首字母都大写。 Java类代表现实世界的一个事物,类名词最好是一个名词。最好采用现实的名称。如员工用Employee,而不是E

所有文件,变量统一采用英文单词表示。尽量避免简写和缩写。 

一、 java类 
java类根据java规范采用驼峰标示,java类首字母大写,类名中的各个单词首字母都大写。 
Java类代表现实世界的一个事物,类名词最好是一个名词。最好采用现实的名称。如员工用Employee,而不是Employ避免歧义。最好不是用缩写empl等。 

应用软件中经常应用分层,每一层的类的名称尽量带上该层后缀。 
推荐实体类没有后缀名。 
数据层使用SQLMapper后缀。 
数据层查询参数为Param 
服务层使用Service 
Web层使用Packager 
Web层form表单后缀为Form 

比如员工模块,分别为Employee(实体),EmployeeSQLMapper(数据层),EmployeeService(服务层),EmployeePackager(web层) 

常用英文名称(最好能整理一份常用词汇词典) 
员工:employee 
部门:department 
。。。。 


二、 字段 
根据java驼峰标示命名法,java字段以首字母以小写开头,每个单词首字母大写(第一个单词除外)。 
字段表示现实中一个事物的属性在类中的名称,最好用名词。字段名称应采用最精确的单词,尽量采用一个单词。没有必要把类名挂在字段前面,如employee的id字段,直接可以用id,不用使用employeeId,如果出现两个字段可能产生歧义,可以增加描述性单词来区分。 
字段命名最好能看词识意。 

三、 方法 
方法表示一种行为,它代表一种动作,最好是一个动词或者动词词组或者第一个单词为一个动词。 
属性方法,get/set开头,其后跟字段名称,字段名称首字母大写。 
数据层方法,只能以insert(插入),delete(删除),update(更新),select(查找),count(统计)开头,其他层方法避免以这个5个单词开头,以免造成误解。 
服务层方法,根据方法的行为命名,只描述方法的意义,而不采用方法的目的命名。比如系统的添加新用户,用户可以前台注册,也可以管理员后台添加,方法会被重用,所以最好不要用使用register,采用add会更好写。避免使用与web层相关的方法。 

Web层方法最好是贴近web的语言,如register,login,logout等方法。 

四、 变量 
变量是一方法中重要的元素,一个贴切的名称,能让这段代码优雅百倍(夸张一下)。变量名首字母小写。 

变量属于名称,避免用采用其他词性。 
采用名称要能代表在方法中的意义。如果员工列表: 
最好是使用List employees或则employeeList而不是去使用List list或则更糟糕的List l,如果应用了List employees和Map employees可以分别使用employeeList和employeeMap。 

自定义类型的变量可以采用本身的名称,把首字母改为小写。 

五、 Xml文件名 
Xml命名采用与类名相似的方法,采用首字母大写的驼峰标示。 
Ibatas映射文件:namespace名称为该模块实体类的名称,首字母大写,typealias采用该类simple name。resultMap和sql名称采用首字母小写的命名规则,方法名称与数据层方法名称一致。 
Form和FormItem文件名才用首字母大写的驼峰标示。Form名称也使用首字母大写的格式。Form中的item名称使用与form表单类的属性名称。采用驼峰标示(最好不使用_分隔) 
Action文件名称使用首字母大写,文件package和action name字段采用所有字母小写的格式。 

六、 URL命名 
url路径名称统一采用小写(所有字母都用小写),用get方法提交的参数名和url路径名一样使用小写。
顶 7踩 0收藏
文章评论
共1 条评论 1/1页
发表评论

个人资料

  • 昵称: 小蜜锋
  • 等级: 高级设计师
  • 积分: 7088
  • 代码: 757 个
  • 文章: 360 篇
  • 随想: 211 条
  • 访问: 1261 次
  • 关注

标签

设计模式(4)java(9)命名规范(2)广告创意(1)愤怒的小鸟(1)游戏(5)jsp(1)配置(1)Surface(1)windows(1)javabean(1)设计方法(1)开发工具(2)web(4)大数据(2)GPU(1)硬盘(1)内部结构(1)黑客(1)窃取(1)编码(1)解决方法(1)php(28)mysql(9)数据库备份(1)数据库还原(1)命令(2)数据库(1)安装(1)2012(2)世界末日(3)仙剑5前传(1)默哀(1)电源(1)女生(1)装饰器模式(2)古剑奇谭(1)电脑桌(1)史上最牛(1)编程语言(2)小米(3)电视机顶盒(1)营销策略(1)Android(8)手势(1)诺亚方舟(1)Eclipse(1)汽车(1)操作系统(1)软件(1)互联网(5)大事记(1)设计师(2)壁纸(1)古剑奇谭2(1)古剑奇谭网络版(1)云计算(2)服务器(1)框架(2)Socket(1)jquery(1)构造函数执行顺序(1)火车票(1)3D(1)数据中心(2)正则表达式(2)Web前端(1)开发框架(1)系统瘫痪(1)12306(2)cpu(1)javascript(2)开发日记(15)体育馆管理系统(15)网页设计(1)CSS3(3)腾讯(3)小游戏(1)interface(1)平板(2)面试(2)设计(5)摄影(2)数据挖掘(1)钢琴谱(1)情人节(1)陈欧体(1)程序员(3)漫画(1)UserAgent(1)iPhone(2)NoSQL(1)ui(9)越狱(1)指南(1)abstract(1)css(3)git(2)八核(2)三星(1)linux(11)数据类型(1)html5(2)UML(2)perftools(1)创意(1)logo(1)色谱(1)响应式(5)Metro(2)虚拟机(1)jvm(1)垃圾回收(1)left(1)join(1)连接查询(1)溯源系统(1)Override(1)SAE(2)WordPress(1)指针(1)链表(1)系统分析师(1)中间件(1)corba(1)static(1)无线(1)监控(1)iPad(1)Apache(2)比特币(2)命名规则(1)手机支付(1)curl(3)笔记(1)导航(1)thinkphp(1)异常导致本地路径泄漏(1)web设计(1)网络安全(1)诗句(1)4K对齐(1)代码库(1)色彩(1)动画片(1)struts2(3)漏洞(5)确认框(1)心情驿站(1)ArscEditor(1)resources.(1)apktool(1)AppKey(1)新浪微博(1)app(5)广告(3)赚钱(1)响应式布局(1)html(1)淘宝(2)微信(1)重构(5)缓存(1)破解(1)后门(1)七夕(1)SEO(2)概念设计(1)面向对象(1)bootstrap(1)性能(2)优化(1)iis(1)爬虫(1)采集(1)算法(2)文本相似度(2)cto(1)js(1)fsockopen(1)扁平化设计(2)网页(1)心情(7)小米电视(1)开箱(1)励志(2)招聘(3)命名(1)notepad++(1)python(1)配色(3)扁平化(4)ps(2)搞笑(2)创业(3)渲染(1)电影(1)模板(1)微博(1)企业家(1)公司(1)总结(1)前端(1)运营(1)变形(1)svn(4)教程(3)搜狗(1)泄密(1)双11(1)天猫(1)UC(1)启动界面(1)光棍节(1)双十一(2)物流(1)备份(1)更新(1)插入(1)插件(2)jsTree(1)(1)海量数据(1)分辨率(1)草图(1)手绘(1)速度(1)文本处理(1)实习(1)感想(1)文件(1)简历(1)65.49.2.17(1)yum(1)解决办法(1)阿里云(2)推广(1)来往(1)春运(1)LBS(1)gb2312(1)utf-8(1)log4j(1)详解(1)收购(1)私服(1)TortoiseGi(1)post(1)异常(2)flappyBird(1)应用创新大赛(1)宙斯杯(1)学习方法(1)xp(1)退役(1)安全(1)技术贴(1)flash(1)刷机(1)京东(1)电商(1)Tomcat(1)JDK(1)免费(1)长投影(1)图标(1)Photoshop(1)云端集成开发环境(1)软件开发(1)可视化(1)工具(2)OpenSSL(1)Heartbleed(1)vsftp(1)中国知网(1)学术论文(1)免费下载(1)开发(1)手册(1)速查表(1)追随战略(1)sdk(1)文章(1)发布(1)文件管理(1)沙画(1)动效(2)原型(1)感悟人生(1)哲理(1)Bash(1)类图(1)知识管理(1)Console(1)调试命令(1)rpm(1)报错(1)挂载(1)数据盘(1)云主机(1)产品经理(1)原型设计(1)mql4(1)mt4(1)ea(1)程序化交易(1)CURLOPT_PO(1)阿里云​(1)CentOS6(2)OpenSSH(1)漏洞修复(2)升级(1)安骑士(1)链克(1)

站长推荐