java杂谈（一）

开发规范与建议

1.变量命名按照Java通用方式Camel 命名法。

以下摘自百度百科

骆驼式命名法就是当变量名或函数名是由一个或多个单词连结在一起，而构成的唯一识别字时 ，第一个单词以小写字母开始；从第二个单词开始以后的每个单词的首字母大写都采用大写字母，例如：myFirstName、myLastName，这样的变量名看上去就像骆驼峰一样此起彼伏，故得名。

骆驼式命名法（Camel-Case）一词来自 Perl 语言中普遍使用的大小写混合格式，而 Larry Wall 等人所著的畅销书《Programming Perl》（O'Reilly 出版）的封面图片正是一匹骆驼。

骆驼式命名法的命名规则可视为一种惯例，并无绝对与强制，为的是增加识别和可读性。

小驼峰法

变量一般用小驼峰法标识。驼峰法的意思是：除第一个单词之外，其他单词首字母大写。譬如

int myStudentCount;

变量myStudentCount第一个单词是全部小写，后面的单词首字母大写。

大驼峰法

相比小驼峰法，大驼峰法（即帕斯卡命名法）把第一个单词的首字母也大写了。常用于 类名，命名空间等。譬如

public class DataBaseUser;

2.变量和类命名务必具有意义，能让人一眼看出表达的意思，如userList表示用户列表而不是用list

3.数据库的一个表对应一个领域类，以entity,domain或者meta作为包名都可以

4.数据访问层命名形如xxxDao

5.Service类是封装业务逻辑的类，其中的方法要和此业务逻辑相关。比如UserService就是和User相关的业务方法。

6.当一个东西具有缓存和实际值的时候，务必保证存储和获取的接口只有一个。

7.当一个方法的主逻辑代码超过30行，务必考虑封装方法或类。

8.CheckStyle：检查Java源文件是否与代码规范相符主要包括以下几项：

Javadoc注释

命名规则

多余没用的imports

Size度量

缺少viyao的空格

重复代码

9.FindBugs:基于bug Pattern概念，查找Java字节码（.class文件）中的潜在BUG，主要如NullPointerException、没有合理关闭资源、字符串相同判断错（==和equals）

10.务必撰写文档，尤其对于一些逻辑复杂的项目或者模块。

11.在代码无法阐释意图的时候，注释是必须的，但注释不宜过多，过多意味着代码可读性有问题。

12.防御性编程 处理异常。不要相信外部输入。不要相信外部依赖

13.抽象与简洁：最好的代码抽象是对现实概念的映射。即只要有相关知识，每个类的作用都能在第一视角令人明白。

14.代码的重用