java代码规范

目录

 编程规范

数据规范

---

 

意义： 编码规范对于程序员而言尤为重要，做好代码规范，我们将获益良多：

1. 一个软件的生命周期中，80%的花费在于维护，代码规范降低了金钱成本和时间成本；
2. 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护，代码规范减少了工作交接过程中的交流成本。

    3.  规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的设计和代码，节约了时间，提高了工作效率。

    4.  良好的编码规范可以有效避免一些低级错误，赢得同事的夸奖和上司的认可。

 编程规范

命名规范；

1. 名字应该能够标识事物的特性，并且与业务挂钩。
2. 名字一律使用英文单词，而不能为拼音。
3. 名字可以有两个或三个单词组成，但不应多于4个，控制在3至30个字母以内。
4. 在名字中，多个单词用大写第一个字母（其它字母小写）来分隔。例如：IsSuperUser。
5. 命名避免和以下关键字冲突

如：Base，Date，Class……

1. 方法名、参数名统一使用驼峰命名法（Camel命名法），除首字母外，其他单词的首字母大写，其他字母小写，类名每个组合的单词都要大写；

正例：localValue/getHttpMessage()/inputUserId

注释规范；

1. 一般情况下，源程序的有效注释量必须在30%以上。

1. 避免使用装饰性内容，保持注释的简洁。
2. 注释信息不仅要包括代码的功能，还应给出原因，不要为注释而注释。
3. 除变量定义等较短语句的注释可用行尾注释外，其他注释当避免使用行尾注释。
4. 注释类型：javadoc注释，失效代码注释(eclipse下ctrl+shift+/),代码细节注释 //。
5. 对类、方法、变量等的注释需要符合JavaDoc规范，对每个类、方法都应详细说明其功能、条件、参数等，并使用良好的HTML标记
6. 格式化注释，以使生成的JavaDoc易阅读和理解。
7. 如果注释太复杂说明程序需要修改调整，使设计更加合理。
8. getter、setter方法不用注释
9. 注释不能嵌套
10. 生成开发文档的需要用中文编写
11. 如果需要注释的内容太多，需附加文档进行说明， 注释时加上"参见《****》"
12. 距离较远的}必须注释
13. 复杂的分支流程必须注释
14. 代码质量不高但能正常运行，或者还没有实现的代码用//TODO:声明

1. 存在错误隐患的代码用//FIXME:声明

 

格式规范 

1. 采用eclipse作为开发工具，编码风格总体和eclipse编码风格一致。

2. 写代码时，不必特意设定空格、对齐等；写完一个方法或一个类后，用eclipse的格式化工具完成格式化即可，快捷键：CTRL+Shift+F

3. 注意：Eclipse格式化工具默认会进行空格、缩进排版，会自动在两个函数间加入空行，但不会自动修改函数体内的空行——即：函数

4. 体内语句间如果需要空行，则要手工加入。

数据规范

命名；

（1）只允许使用内网域名，而不是ip连接数据库

（2）线上环境、开发环境、测试环境数据库内网域名遵循命名规范

业务名称：xxx

线上环境：dj.xxx.db

开发环境：dj.xxx.rdb

测试环境：dj.xxx.tdb

从库在名称后加-s标识，备库在名称后加-ss标识

线上从库：dj.xxx-s.db

线上备库：dj.xxx-sss.db    

（3）库名、表名、字段名：小写，下划线风格，不超过32个字符，必须见名知意，禁止拼音英文混用

（4）表名t_xxx，非唯一索引名idx_xxx，唯一索引名uniq_xxx

表设计；

（1）单实例表数目必须小于500

（2）单表列数目必须小于30

（3）表必须有主键，例如自增主键

说明：

a）主键递增，数据行写入可以提高插入性能，可以避免page分裂，减少表碎片提升空间和内存的使用

b）主键要选择较短的数据类型， Innodb引擎普通索引都会保存主键的值，较短的数据类型可以有效的减少索引的磁盘空间，提高索引的缓存效率

c） 无主键的表删除，在row模式的主从架构，会导致备库夯

（4）禁止使用外键，如果有外键完整性约束，需要应用程序控制

说明：外键会导致表与表之间耦合，update与delete操作都会涉及相关联的表，十分影响sql 的性能，甚至会造成死锁。高并发情况下容易造成数据库性能，大数据高并发业务场景数据库使用以性能优先

索引；

（1）单表索引建议控制在5个以内

（2）单索引字段数不允许超过5个

说明：字段超过5个时，实际已经起不到有效过滤数据的作用了

（3）禁止在更新十分频繁、区分度不高的属性上建立索引

说明：

a）更新会变更B+树，更新频繁的字段建立索引会大大降低数据库性能

b）“性别”这种区分度不大的属性，建立索引是没有什么意义的，不能有效过滤数据，性能与全表扫描类似

（4）建立组合索引，必须把区分度高的字段放在前面

说明：能够更加有效的过滤数据

SQL

（1）禁止使用SELECT *，只获取必要的字段，需要显示说明列属性

说明：

a）读取不需要的列会增加CPU、IO、NET消耗

b）不能有效的利用覆盖索引

c）使用SELECT *容易在增加或者删除字段后出现程序BUG

（2）禁止使用INSERT INTO t_xxx VALUES(xxx)，必须显示指定插入的列属性

说明：容易在增加或者删除字段后出现程序BUG

（3）禁止使用属性隐式转换

说明：SELECT uid FROM t_user WHERE phone=13812345678 会导致全表扫描，而不能命中phone索引。

（4）禁止在WHERE条件的属性上使用函数或者表达式

说明：SELECT uid FROM t_user WHERE from_unixtime(day)>='2017-02-15' 会导致全表扫描

正确的写法是：SELECT uid FROM t_user WHERE day>= unix_timestamp('2017-02-15 00:00:00')

（5）禁止负向查询，以及%开头的模糊查询

说明：

a）负向查询条件：NOT、!=、<>、!<、!>、NOT IN、NOT LIKE等，会导致全表扫描

b）%开头的模糊查询，会导致全表扫描

（6）禁止大表使用JOIN查询，禁止大表使用子查询

说明：会产生临时表，消耗较多内存与CPU，极大影响数据库性能

（7）禁止使用OR条件，必须改为IN查询

说明：旧版本Mysql的OR查询是不能命中索引的，即使能命中索引，为何要让数据库耗费更多的CPU帮助实施查询优化呢？

（8）应用程序必须捕获SQL异常，并有相应处理

（9）sql语句不能放在service层，要放在eao层中，不能把eao层架空

（10）sql语句查询时必须包含“isDelete ==0”这个条件 

 来自java代码规范文档。