背景
看到一段古董代码，注释没注释，格式乱糟糟，心里那滋味，怎一个难字了得。可能一看署名，戏剧化的发现，原来这是自己写的代码。那真的是哑巴吃黄连——有苦说不出。只能对自己说，我以前写的代码真烂！周星驰因为对电影极致的要求，不放过任何一个细节，最终封神被称为星爷，如果你对代码也进行极致的打磨，养成代码“洁癖”，那你在成为大神的道路上已经迈出了很重要的一步。我个人认为要做到代码“洁癖”，要分为两个方面，格式上的“洁癖”和编码上的“洁癖”。下面来具体聊下。
格式上的“洁癖”
工程结构要统一
基本模板如下，也是小编经常用的：
spring-boot-format
└─── src
└─── main
└─── java
└─── com.lyj.format
└─── aspect aop切面目录
└─── common 通用类目录
└─── contant 静态类目录
└─── exception 异常目录
└─── utils 工具目录
└─── config 配置类目录
└─── controller 对外api目录
└─── dao dao类
└─── entity 实体类
└─── filter 过滤器
└─── service 接口类及接口实现类目录
└─── impl 接口实现类目录
└─── 接口 接口
└─── SpringBootFormatApplication 启动类
└─── resources 配置文件目录
└─── mapper mybatis的mapper文件目录
└─── static 静态资源目录（比如js，css等）
└─── templates 静态页面目录（比如html,jsp等）
└─── application.properties 默认配置文件
└─── application-dev.properties 开发环境配置文件
└─── application-prod.properties 生产环境配置文件
└─── application-test.properties 测试环境配置文件
└─── test 接口测试目录
└─── .gitignore 排除提交git的配置文件
└─── pom.xml pom文件
└─── spring-boot-format.iml
image.png
注释要规范
类注释
类注释不需要太多，如下即可
image.png
方法注释
方法注释需要标明方法的功能，入参，出参，异常等
image.png
属性注释
image.png
编码上的“洁癖”
- 属性，方法命名规范，尽量做到见名知义，方便别人阅读
- 使类尽可能短小精悍，而且只解决一个特定的问题
- 尽可能的优雅的使用if--else等，不要过多的嵌套使用
（有很多规范，小编这里只列出了最基本的几个）
编码规范工具的使用
以上提到的都需要自己严格要求自己才能做到，也可以借助一些工具来规范的要求自己，前端的同学可以使用eslint，后端的同学可以使用阿里的Alibaba Java Coding Guidelines，具体安装和使用，网上有很多教程，小编这里就不过多赘述了。
需要源码的可以关注公众号【温故知新之java】，更多干活与你分享。
