`

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代码命名规范

    ### Java代码命名规范 在Java编程中,遵循良好的命名规范对于编写可读性强、易于维护的代码至关重要。尤其是对于Java初学者来说,培养正确的命名习惯能够有效减少后续开发中的问题,提升团队协作效率。本文将从变量...

    阿里巴巴Java开发命名规范

    阿里巴巴Java开发命名规范 阿里巴巴Java开发命名规范是Java开发中的一系列命名规范,旨在确保代码的可读性、可维护性和可扩展性。该规范涵盖了Java开发中的各个方面,包括类名、方法名、变量名、常量名、包名等。 ...

    java命名规范分享

    Java编程语言的命名规范是确保代码清晰、可读和易于维护的关键部分。这些规范不仅有助于团队成员之间的沟通,还能提高代码质量。以下是一些主要的Java命名规则: 1. **包名**: - 包名应全部使用小写字母。 - ...

    Java命名规范

    ### Java命名规范详解 #### 一、概述 Java命名规范是为了确保代码的可读性和一致性而制定的一套规则。遵循这些规范有助于提升团队合作效率,...希望本文介绍的Java命名规范能帮助您更好地理解和应用这些最佳实践。

    java命名规范 开发规范

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

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

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

    java关键字和java命名规范.pdf

    Java关键字和命名规范是Java编程语言中的基础概念,它们对于编写清晰、规范的代码至关重要。Java关键字是Java语言内置的、具有特殊用途的保留字,而命名规范则是关于如何给类、方法、变量等命名的约定。 ### Java...

    java常见编程及命名规范

    Java编程及命名规范是软件开发中的重要组成部分,它旨在提高代码的可读性、可维护性和团队协作效率。以下是对这些规范的详细说明: 一、Java编程规范 1. **编码字符集**: Java源代码应使用UTF-8编码,确保在不同...

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

    ### Java代码命名规范详解 #### 1. 引言 在Java编程中,代码命名规范的重要性不容忽视。良好的命名规范不仅提升代码的可读性和可维护性,还直接影响项目的开发效率和团队协作的顺畅性。遵循合理的命名规范,能够...

    编写代码命名规范

    ### 编程命名规范的综合应用 #### 命名空间 - **命名方式:** Pascal命名法,每个限定词均使用Pascal命名方式,如`ExcelQuicker.Work`。 #### 类和结构 - **命名方式:** Pascal命名法,每个逻辑断点首字母大写,...

    java编码规范、命名规范和优化规范

    Java编程语言以其强大的功能和广泛的应用领域而深受开发者喜爱。为了确保代码的可读性、可维护性和团队协作效率,遵循一套统一的编码规范、命名规范和优化规范至关重要。以下是一些关键点的详细说明: 1. **前言**...

    java开发命名规范总结

    Java开发中的命名规范是编程实践中至关重要的一环,它关乎代码的可读性、可维护性和团队协作效率。本文将详细阐述Java开发中的命名规范,主要包括包名、类名、变量名的规范。 首先,我们来看包名的命名规范。包...

    Java编程规范.pdf

    这些规范包括了包命名规范、类命名规范、接口命名规范、方法命名规范、变量命名规范和常量命名规范等。 包命名规范:包名全小写,中间可以由点分隔开,例如:java.awt.event。为了保障每个Java包命名的唯一性,通常...

    java好的命名规范

    Java编程语言的命名规范是确保代码清晰、可读性和易维护性的重要组成部分。遵循良好的命名规范可以帮助团队成员更快地理解代码,减少沟通成本,提高工作效率。以下是一些关键的Java命名规则: 1. **包(Package)...

    java 命名规范

    在Java编程语言中,命名规范是非常重要的,它不仅...虽然没有提供具体内容,但这些主题对于深入理解和应用Java命名规范同样至关重要。阅读华为培训资料.pdf文件,可能能获取更多关于命名规范以及与IT相关的实用知识。

    java命名规则

    Java编程语言以其严谨的规范和良好的可读性著称...Java命名规范是编程实践中的一项基本准则,遵守这些规则可以使代码更易于理解和维护,也利于团队间的合作。熟练掌握并应用这些规范,将有助于提升编程效率和代码质量。

    Java 2 EE开发命名规范

    本文将详细介绍Java 2 EE(现称为Java EE)开发中的命名规范,并结合具体的包名、类名等示例来阐述这些规则的实际应用。 #### 二、命名规范原则 Java 2 EE项目中的命名规范主要涵盖以下几个方面: 1. **包名**:...

    java命名规范

    ### Java命名规范详解 #### 一、概述 Java命名规范是一种约定俗成的代码书写标准,旨在提高程序的可读性和一致性。通过遵循统一的命名规范,开发人员能够更好地理解和维护代码,降低团队间的沟通成本。本文将详细...

Global site tag (gtag.js) - Google Analytics