作为一名程序员，代码规范的重要性不言而喻，特别是在项目中特别能感受到这点，经常遇到代码不规范给大家带来的麻烦，所以我们应该从开始学的时候就应该养成良好的习惯，即使自己不想得到什么方便，也要在为他人方便。我在没有学习之前认为代码规范嘛，无非就是些大小驼峰的问题，学完以后确实让自己感受到了一种无知的感觉。
思维导图
编程规约
一、命名总体原则和概述
- 名字应该能够标识事物的特性，并且与业务挂钩。
- 名字一律使用英文单词，而不能为拼音。
- 名字可以有两个或三个单词组成，但不应多于4个，控制在3至30个字母以内。
- 在名字中，多个单词用大写第一个字母（其它字母小写）来分隔。例如：IsSuperUser。
- 命名避免和以下关键字冲突。如：Base，Date，Class……
- 方法名、参数名统一使用驼峰命名法（Camel命名法），除首字母外，其他单词的首字母大写，其他字母小写，类名每个组合的单词都要大写； 正例：localValue/getHttpMessage()/inputUserId
二、注释原则
- 避免使用装饰性内容，保持注释的简洁。
- 注释信息不仅要包括代码的功能，还应给出原因，不要为注释而注释。
- 除变量定义等较短语句的注释可用行尾注释外，其他注释当避免使用行尾注释。
- 注释类型：javadoc注释，失效代码注释(eclipse下ctrl+shift+/),代码细节注释 //。
- 对类、方法、变量等的注释需要符合JavaDoc规范，对每个类、方法都应详细说明其功能、条件、参数等，并使用良好的HTML标记
- 格式化注释，以使生成的JavaDoc易阅读和理解。
- 如果注释太复杂说明程序需要修改调整，使设计更加合理。
- getter、setter方法不用注释
- 注释不能嵌套
- 生成开发文档的需要用中文编写
- 如果需要注释的内容太多，需附加文档进行说明， 注释时加上"参见《****》"
- 距离较远的}必须注释
- 复杂的分支流程必须注释
- 代码质量不高但能正常运行，或者还没有实现的代码用//TODO:声明
- 一般情况下，源程序的有效注释量必须在30%以上。
三、格式规约总原则
1. 采用eclipse作为开发工具，编码风格总体和eclipse编码风格一致。
2. 写代码时，不必特意设定空格、对齐等；写完一个方法或一个类后，用eclipse的格式化工具完成格式化即可，快捷键： CTRL+Shift+F
3. 注意：Eclipse格式化工具默认会进行空格、缩进排版，会自动在两个函数间加入空行，但不会自动修改函数体内的空行——即：函数
4. 体内语句间如果需要空行，则要手工加入。
数据库规范
1.必须使用InnoDB存储引擎
说明：支持事务、行级锁、并发性能更好、CPU及内存缓存页优化使得资源利用率更高
2.必须使用UTF8字符集
说明：万国码，无需转码，无乱码风险，节省空间
3.数据表、数据字段必须加入中文注释
说明：N年后谁tm知道这个r1,r2,r3字段是干嘛的
4.禁止使用存储过程、视图、触发器、Event
说明：高并发大数据的互联网业务，架构设计思路是“解放数据库CPU，将计算转移到服务层”，并发量大的情况下，这些功能很可能将数据库拖死，业务逻辑放到服务层具备更好的扩展性，能够轻易实现“增机器就加性能”。数据库擅长存储与索引，CPU计算还是上移吧
5.禁止存储大文件或者大照片
说明：为何要让数据库做它不擅长的事情？大文件和照片存储在文件系统，数据库里存URI多好
异常日志规范
1. Java类库中定义的一类RuntimeException可以通过预先检查进行规避，而不应该通过catch来处理，比如：IndexOutOfBoundsException /，NullPointerException等等。
说明：无法通过预检查的异常除外，如在解析一个外部传来的字符串形式数字时，通过catchnumberFormatException来实现。
正例：if (obj != null) {...}
反例：try { obj.method() } catch(NullPointerException e){…}
2. 异常不要用来做流程控制，条件控制，因为异常的处理效率比条件分支低。
3. 对大段代码进行try-catch，这是不负责任的表现。catch时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的catch尽可能进行区分异常类型，再做对应的异常处理。
4. 捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。
5. 有try块放到了事务代码中，catch异常后，如果需要回滚事务，一定要注意手动回滚事务。
6. finally块必须对资源对象、流对象进行关闭，有异常也要做try-catch。
说明：如果JDK7，可以使用try-with-resources方法。
7. 不能在finally块中使用return，finally块中的return返回后方法结束执行，不
会再执行try块中的return语句。
8. 捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。
说明：如果预期抛的是绣球，实际接到的是铅球，就会产生意外情况。
9. 方法的返回值可以为null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回null值。调用方需要进行null判断防止NPE（Null Pointer Exception，空指针异常）问题。
说明：本规约明确防止NPE是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也并非高枕无忧，必须考虑到远程调用失败，运行时异常等场景返回null的情况。
10. 防止NPE，是程序员的基本修养，注意NPE产生的场景：
1） 返回类型为包装数据类型，有可能是null，返回int值时注意判空。
反例：public int f(){ return Integer对象}，如果为null，自动解箱抛NPE。
2） 数据库的查询结果可能为null。
3） 集合里的元素即使isNotEmpty，取出的数据元素也可能为null。
4） 远程调用返回对象，一律要求进行NPE判断。
5） 对于Session中获取的数据，建议NPE检查，避免空指针。
6） 级联调用obj.getA().getB().getC()；一连串调用，易产生NPE。
正例：可以使用JDK8的Optional类来防止NPE问题。
11. 在代码中使用“抛异常”还是“返回错误码”，对于公司外的http/api开放接口必须使用“错误码”；而应用内部推荐异常抛出；跨应用间RPC调用优先考虑使用Result方式，封装isSuccess、“错误码”、“错误简短信息”。
说明：关于RPC方法返回方式使用Result方式的理由：
1）使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。
2）如果不加栈信息，只是new自定义异常，加入自己的理解的error message，对于调用
端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输的性能损耗也是问题。
12. 定义时区分unchecked / checked 异常，避免直接使用RuntimeException抛出，更不允许抛出Exception或者Throwable，应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常，如：DaoException / ServiceException等。
13. 避免出现重复的代码（Don’t Repeat Yourself），即DRY原则。
说明：随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是共用模块。
正例：一个类中有多个public方法，都需要进行数行相同的参数校验操作，这个时候请抽取：
private boolean checkParam(DTO dto){...}
