背景

看到一段古董代碼，注釋沒注釋，格式亂糟糟，心里那滋味，怎一個難字了得。可能一看署名，戲劇化的發(fā)現(xiàn)，原來這是自己寫的代碼。那真的是啞巴吃黃連——有苦說不出。只能對自己說，我以前寫的代碼真爛！周星馳因為對電影極致的要求，不放過任何一個細節(jié)，最終封神被稱為星爺，如果你對代碼也進行極致的打磨，養(yǎng)成代碼“潔癖”，那你在成為大神的道路上已經(jīng)邁出了很重要的一步。我個人認為要做到代碼“潔癖”，要分為兩個方面，格式上的“潔癖”和編碼上的“潔癖”。下面來具體聊下。

格式上的“潔癖”

工程結(jié)構(gòu)要統(tǒng)一

基本模板如下，也是小編經(jīng)常用的：

spring-boot-format
└─── src
     └─── main
          └─── java
               └─── com.lyj.format
                    └─── aspect                       aop切面目錄
                    └─── common                       通用類目錄
                         └─── contant                 靜態(tài)類目錄
                         └─── exception               異常目錄
                         └─── utils                   工具目錄
                    └─── config                       配置類目錄
                    └─── controller                   對外api目錄
                    └─── dao                          dao類
                    └─── entity                       實體類
                    └─── filter                       過濾器
                    └─── service                      接口類及接口實現(xiàn)類目錄
                         └─── impl                    接口實現(xiàn)類目錄
                         └─── 接口                    接口
                    └─── SpringBootFormatApplication  啟動類
          └─── resources                              配置文件目錄
               └─── mapper                            mybatis的mapper文件目錄
               └─── static                            靜態(tài)資源目錄（比如js，css等）
               └─── templates                         靜態(tài)頁面目錄（比如html,jsp等）
               └─── application.properties            默認配置文件
               └─── application-dev.properties        開發(fā)環(huán)境配置文件
               └─── application-prod.properties       生產(chǎn)環(huán)境配置文件
               └─── application-test.properties       測試環(huán)境配置文件 
     └─── test                                        接口測試目錄
└─── .gitignore                                       排除提交git的配置文件
└─── pom.xml                                          pom文件
└─── spring-boot-format.iml                           

image.png

注釋要規(guī)范

類注釋

類注釋不需要太多，如下即可

image.png

方法注釋

方法注釋需要標明方法的功能，入?yún)?，出參，異常?/p>

image.png

屬性注釋

image.png

編碼上的“潔癖”

1. 屬性，方法命名規(guī)范，盡量做到見名知義，方便別人閱讀
2. 使類盡可能短小精悍，而且只解決一個特定的問題
3. 盡可能的優(yōu)雅的使用if--else等，不要過多的嵌套使用
   （有很多規(guī)范，小編這里只列出了最基本的幾個）

編碼規(guī)范工具的使用

以上提到的都需要自己嚴格要求自己才能做到，也可以借助一些工具來規(guī)范的要求自己，前端的同學可以使用eslint，后端的同學可以使用阿里的Alibaba Java Coding Guidelines，具體安裝和使用，網(wǎng)上有很多教程，小編這里就不過多贅述了。

需要源碼的可以關注公眾號【溫故知新之java】，更多干活與你分享。