`

java应用命名规范(自己总结的哈)

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

一、 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路径名一样使用小写。


刚写出来,还有不妥的地方,希望大家多多给意见哈。
分享到:
评论

相关推荐

    java命名规范 开发规范

    1. 模块命名、数据库表命名、域模型命名、各分层的类/方法命名、页面的命名; 模块命名: a. 包命名:com.project_name.module_name.action/service/dao/ws; service的实现都置于...

    Java代码命名规范详解含详细示例

    希望通过本文的介绍,能够帮助读者更加深入地理解Java代码命名规范,并在实际的软件开发中加以应用。 Java代码命名规范是编写高质量、可维护代码的基础。通过遵循有意义的名称、使用适当的命名约定(如小驼峰和大...

    java_访问控制权限及命名规范笔记

    java_命名规范是直接体现出一个web应用的好坏,是每一个程序员必备的知识!

    Java Web应用开发规范

    Java Web应用开发规范。 为了使软件开发过程有章可循,保证软件质量,加强开发管理 开发管理 项目周期 命名规范

    JAVA 编码规范

    1.4 子系统命名规范 5 1.5 层次命名规范 6 1.6 JNDI命名规则 6 1.7 主机名命名规则 7 2程序的版式 8 2.1 空行 8 2.2 代码行 8 2.3 代码行内的空格 9 2.4 对齐 10 2.5 长行拆分 10 2.6 注释 11 3表达式和基本语句 12 ...

    Java EE 编码规范.docx

    目 录 2 一、规范存在的意义 3 ...七、应用命名总结 7 1、 java类 8 2、 字段 8 3、 方法 8 4、 变量 9 5、 Xml文件名 9 6、 URL命名 9 八、J2EE规范 9 1、J2EE规范 9 2、J2EE组件层次 10 3、J2EE的分布应用技术 12

    阿里巴巴java开发规范

    阿里巴巴java开发规范手册详细规范了java以及mysql数据库创建时的具体要求。分为编程规约、异常处理、Mysql规约、工程规约、安全规约等。编程规约包含命名规约、常量定义、格式规约、oop规约、集合处理、并发处理、...

    java版电影销售系统有后台包含三层架构,命名规范(内含数据库)

    java版电影销售系统有后台包含三层架构,命名规范(内含数据库),并且包含javadoc例子。

    Java基础课程

    知识点:自定义动画、选择器高级应用、响应式网站开发、行业命名规范、域名注册-搭建个人网站 让学员熟练掌握css、js、JQuery等技术,可做到独立编写PC+移动端网站页面。并且能够独立开发web应用,样式框架、js库等...

    数据中心数据仓库建设规范模板.pdf

    5 APP 应用层,用于生成报表 6 XX XX 数据层级按照自己数据仓库规划的命名即可~ 2.2 表、视图、存储过程、函数命名规范 <对象类型>模型层次>主题>对象描述>[_汇总类型][_存储类 型] 说明:<> 尖括号中的内容为必须...

    java编程规范

    为了便于管理Java开发的应用,Java开发的应用包命名要求带有前缀com,采用“com.包名.子功能包名”的形式,如com.bcl表示基础工具包。在日常项目应用中积累的公共的内容希望能够形成通用的工具包,供项目组使用,...

    经典JAVA.EE企业应用实战.基于WEBLOGIC_JBOSS的JSF_EJB3_JPA整合开发.pdf

    ejb 3、jpa规范都属于sun公司所制订的java ee规范,因此把基于ejb 3+jpa的应用称为经典java ee架构,目前这种架构在java开发领域也有极大的市场占有率。  本书介绍了java ee规范的三大主要规范jsf、ejb 3和jpa,...

    JAVA_API1.6文档(中文)

    java.awt.datatransfer 提供在应用程序之间和在应用程序内部传输数据的接口和类。 java.awt.dnd Drag 和 Drop 是一种直接操作动作,在许多图形用户界面系统中都会遇到它,它提供了一种机制,能够在两个与 GUI 中...

    Java高级程序设计实战教程第一章-Java编码规范.pptx

    1.2 相关知识 1.2.1 文件后缀名 1.2.2 源文件样式约定 1.2.3 注释规范 1.2.4 命名规范 Java高级程序设计实战教程第一章-Java编码规范全文共13页,当前为第3页。 1.2.1 文件后缀名 表1-1 Java程序使用的文件后缀名 ...

    Java_EE_6规范中文版

    2.1 体系结构 2.2 Profile(自定义规范) 2.3 应用程序组件 2.4 容器 2.5 资源适配器 2.6 数据库 2.7 Java EE标准服务 2.8 互用性 2.9 产品标准的灵活性 2.10 Java EE产品的扩展 2.11 平台角色 2.12 平台协议 2.13...

    java 面试题 总结

    Java Bean 是可复用的组件,对Java Bean并没有严格的规范,理论上讲,任何一个Java类都可以是一个Bean。但通常情况下,由于Java Bean是被容器所创建(如Tomcat)的,所以Java Bean应具有一个无参的构造器,另外,...

    Java 1.6 API 中文 New

    java.awt.datatransfer 提供在应用程序之间和在应用程序内部传输数据的接口和类。 java.awt.dnd Drag 和 Drop 是一种直接操作动作,在许多图形用户界面系统中都会遇到它,它提供了一种机制,能够在两个与 GUI 中显示...

    Javashop开发规范V2.2

    1 命名规范 1.1 包命 1. 小写字母 2. 以com.enation.javashop开头 3. 组件以com.enation.compoent开头 1.2 类名 一、 action 以Action结尾,如:UserAction 二、 业务类 1.接口: 以I开头,以Manager结尾,如:...

    java api最新7.0

    java.awt.datatransfer 提供在应用程序之间和在应用程序内部传输数据的接口和类。 java.awt.dnd Drag 和 Drop 是一种直接操作动作,在许多图形用户界面系统中都会遇到它,它提供了一种机制,能够在两个与 GUI 中显示...

Global site tag (gtag.js) - Google Analytics