java编程规约

一、命名风格

1、代码中的命名不能以下划线和美元符号开始和结束。

2、代码中严禁使用拼音和英文混合的方式,更加不能使用中文。

3、类名必须使用驼峰形式(UpperCamelCase),一下例外:BO、DO、DTO。

4、方法名、参数名、成员变量名、局部变量名都统一使用lowerCamelCase。

5、常量名全部大写,各个单词之间用 _ 分开,比如:MAX_STOCK_COUNT。

6、抽象类命名必须以Abstract或者Base开头,异常类命名以Exception结尾,测试类以Test结尾。

7、中括号是数组类型的一部分,String[] args。

8、POJO中布尔类型的变量都不要加is,否则会引起序列化错误。

9、包名一律使用小写,点分符之间使用有自然语义的单词,不允许使用复数形式,类名可以使用复数形式。

10、杜绝完全不规范的简写,避免望文不知义。

11、如果使用了设计模式,要在类名中体现具体的设计模式,比如:OrderFactory/LoginProxy

12、枚举类名要以Enum结尾,枚举统一使用大写各个单词以下划线分开。

13、各层的命名规约:

A)Service、DAO层方法命名:

1)获取单个对象以get作为前缀;

2)获取多个对象以list作为前缀;

3)删除用remove所为前缀;

4)保存用save作为前缀;

5)更新用update作为前缀;

B)领域模型命名:

1)数据对象:xxxDO,xxx即为数据表名;

2)数据传输对象:xxxDTO,xxx为业务领域相关名称;

3)展示对象;xxxVO,xxx为网页的名称;

二、常量定义

1、不允许任何魔法值,直接出现在代码中,比如:“JRXJ”+xxx。

2、long赋初始值时必须用L结尾。

3、不要使用一个常量类维护所有常量,根据功能进行区分,比如缓存相关的用CacheConstant,系统相关的用ConfigConstant。

4、常量的复用层次:跨应用常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量,

跨应用共享常量:保存在二方库中,通常是client jar;

应用内共享常量:保存在一方库中,通常在modules的constant目录下面;

子工程内共享常量:在子工程的constant目录下面;

包内共享常量:当前包单独的constant目录下面;

类内共享常量:直接在类内部 private static final ...

5、如果一个变量在一定的范围内变化,而且带有一定的延生属性,那么使用枚举。

时间: 2024-10-22 23:05:06

java编程规约的相关文章

java编程规约二

四.OOP规约(Object Oriented Programming,面向对象设计) 1.静态变量和静态方法直接用类名访问,不要再new 对象去访问 2.方法覆盖必须加@Override注解 3.尽量不要用可变参数做参数列表,尽量不要用Object作为参数类型 4.老方法接口不要轻易删除或修改,你永远不知道以前是给谁用的,现在还有没有在用 5.equals用法新技能:java.util.Objects.equals(Object a,Object b) 老方法:.equals()的调用者优先用

java编程规约三

七.集合处理 1.尽量使用String对象做Map的key 2.list转数组,用list的toArray(T[] array),传入的参数array是类型完全一样的数组,大小是list.size() 示例:(无参的toArray返回的是Object[]类) List<String> list = new ArrayList<String>(2); list.add("guan"); list.add("bao"); String[] arr

阿里Java开发手册之编程规约

阿里Java开发手册之编程规约 对于程序员来说,编程规范可以养成良好的编程习惯,提高代码质量,降低沟通成本.就在2月9号,阿里出了一份Java开发手册(正式版),分为编程规约,异常日志,MySQL规约,工程规约,安全规约五个章节.这里我根据阿里的编程规约,重点记录(黑色加粗部分)自己还未做好的一些规范,同时方便查阅. ++阿里Java开发手册下载地址++ 编程规约 一.命名规约 [强制]代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束. 反例: _name / __name

读阿里巴巴Java开发手册v1.2.0之编程规约有感【架构篇】

 不为过去蹉跎,改变当下. 为什么开篇就送这么一句话给大家,我相信很多处于1-3年码龄的哥们儿们,在平时的编码历程中编码的个性可能是多彩的,每个人都有每个人特定的风格,但是我们现在这么随意写,以后这么随意写,好没问题,但是等你离开这个公司了或者是去开发别的项目了,再等别人过来接手维护你一手写出来的这段个性十足的代码时,那么你的右眼皮时不时地就会跳,因果我就不说了~~ 所以我建议看到这篇博文的朋友们,或许你稍微改变一下你的编码风格,遵从一套好的编码规约对己对人都是有好处的.可能朋友的公司也有专门的

阿里Java开发手冊之编程规约

对于程序猿来说,编程规范能够养成良好的编程习惯,提高代码质量,减少沟通成本.就在2月9号,阿里出了一份Java开发手冊(正式版),分为编程规约.异常日志.MySQL规约,project规约.安全规约五个章节. 这里我依据阿里的编程规约,重点记录(黑色加粗部分)自己还未做好的一些规范,同一时候方便查阅. 编程规约 一.命名规约 [强制]代码中的命名均不能下面划线或美元符号開始.也不能下面划线或美元符号结束. 反例: _name / __name / $Object / name_ / name$

IDEA集成java编程规范插件

第一种:如图所示搜索 Alibaba Java Coding Guidelines(阿里巴巴) 安装完成后,重启idea,点击tools>阿里巴巴编程>编程规约扫描 即可 原文地址:https://www.cnblogs.com/dqcer/p/9123373.html

异常笔记--java编程思想

开一个新的系列,主要记一些琐碎的重要的知识点,把书读薄才是目的...特点: 代码少,概念多... 1. 基本概念 异常是在当前环境下无法获得必要的信息来解决这个问题,所以就需要从当前环境跳出,就是抛出异常.抛出异常后发生的几件事: 1.在堆上创建异常对象. 2.当前的执行路径中止                                          3. 当前环境抛出异常对象的引用.                                         4. 异常处理机制接

《Java编程思想》第十三章 字符串

<Java编程思想>读书笔记 1.String作为方法的参数时,会复制一份引用,而该引用所指的对象其实一直待在单一的物理位置,从未动过. 2.显式地创建StringBuilder允许预先为他指定大小.如果知道字符串多长,可以预先指定StringBuilder的大小避免多次重新分配的冲突. 1 /** 2 * @author zlz099: 3 * @version 创建时间:2017年9月1日 下午4:03:59 4 */ 5 public class UsingStringBuilder {

Java编程练习之输出考试成绩的前三名

在慕课网学习的时候遇到了这样一个Java编程练习题,正好对所学习的Java基础知识检验一下: 请根据所学知识,编写一个Java程序,实现输出考试成绩的前三名 要求: 1考试成绩已保存在数组scores中,数组元素依次为89 , -23 , 64 , 91 , 119 , 52 , 73 2要求通过自定义方法来实现成绩排名并输出操作,将成绩数组作为参数传入 3要求判断成绩的有效性( 0-100 ),如果成绩无效,则忽略此成绩 我自己分析了一下这个程序的过程: (1)首先是定义一个包含整型数组参数的