LZ 最近一直在研究虛擬機(jī)源碼，可惜目前還只是稍微有一點(diǎn)點(diǎn)頭緒，無(wú)法與各位分享，龐大的 JAVA 虛擬機(jī)源碼果然不是一朝一夕能搞定的，LZ 汗顏。
本次我們拋開(kāi) JAVA 虛擬機(jī)源碼這些相對(duì)底層的東西，LZ 來(lái)與各位探討一下幾個(gè)代碼重構(gòu)的小技巧，這些內(nèi)容部分來(lái)自于書(shū)籍當(dāng)中，部分來(lái)自于 LZ 維護(hù)項(xiàng)目當(dāng)中的一些實(shí)踐經(jīng)驗(yàn)。如果猿友們?cè)?jīng)用過(guò)這種手法，也不妨參與到文章的留言當(dāng)中，將你的小心得、小體會(huì)共享與他人，也可以拿來(lái)沖擊 LZ 自己定義的排行榜，LZ 不甚歡迎。
重構(gòu)的手法有很多種，相對(duì)而言，一篇文章的涵蓋量自然是無(wú)法提到所有，LZ 這里也只能提出一些平時(shí)會(huì)經(jīng)常使用的一些手法，像一些比較高端的手法，各位有興趣的可以去找一些專門的書(shū)籍涉獵。
另外還有一點(diǎn)，由于 LZ 是做 JAVA 開(kāi)發(fā)的，因此部分重構(gòu)小技巧可能與 JAVA 語(yǔ)言，或者說(shuō)與面向?qū)ο蟮恼Z(yǔ)言息息相關(guān)，不過(guò)大多數(shù)技巧，無(wú)論是面向過(guò)程的語(yǔ)言，還是面向?qū)ο蟮恼Z(yǔ)言，都是可以相互通用的。
廢話不多說(shuō)，我們來(lái)看看實(shí)用重構(gòu)技巧的排行榜吧。
No.1：重復(fù)代碼的提煉
重復(fù)代碼是重構(gòu)收效最大的手法之一，進(jìn)行這項(xiàng)重構(gòu)的原因不需要多說(shuō)。它有很多很明顯的好處，比如總代碼量大大減少，維護(hù)方便，代碼條理更加清晰易讀。
它的重點(diǎn)就在于尋找代碼當(dāng)中完成某項(xiàng)子功能的重復(fù)代碼，找到以后請(qǐng)毫不猶豫將它移動(dòng)到合適的方法當(dāng)中，并存放在合適的類當(dāng)中。
小實(shí)例
class BadExample {
public void someMethod1(){
//code
System.out.println("重復(fù)代碼");/* 重復(fù)代碼塊 */
//code
}
public void someMethod2(){
//code
System.out.println("重復(fù)代碼");/* 重復(fù)代碼塊 */
//code
}
}
/* ---------------------分割線---------------------- */
class GoodExample {
public void someMethod1(){
//code
someMethod3();
//code
}
public void someMethod2(){
//code
someMethod3();
//code
}
public void someMethod3(){
System.out.println("重復(fù)代碼");/* 重復(fù)代碼塊 */
}
}
No.2：冗長(zhǎng)方法的分割
有關(guān)冗長(zhǎng)方法的分割，其實(shí)有時(shí)候與重復(fù)代碼的提煉是有著不可分割的關(guān)系的，往往在我們提煉重復(fù)代碼的過(guò)程中，就不知不覺(jué)的完成了對(duì)某一個(gè)超長(zhǎng)方法的分割。倘若在你提煉了大部分的重復(fù)代碼之后，某一些冗長(zhǎng)方法依然留存，此時(shí)就要靜下心來(lái)專門處理這些冗長(zhǎng)方法了。
這其中有一點(diǎn)是值得注意的，由于我們?cè)诜指钜粋€(gè)大方法時(shí)，大部分都是針對(duì)其中的一些子功能分割，因此我們需要給每一個(gè)子功能起一個(gè)恰到好處的方法名，這很重要?？梢哉f(shuō)，能否給方法起一個(gè)好名字，有時(shí)候能體現(xiàn)出一個(gè)程序猿的大致水準(zhǔn)。
小實(shí)例
class BadExample {
public void someMethod(){
//function[1]
//function[2]
//function[3]
}
}
/* ---------------------分割線---------------------- */
class GoodExample {
public void someMethod(){
function1();
function2();
function3();
}
private void function1(){
//function[1]
}
private void function2(){
//function[2]
}
private void function3(){
//function[3]
}
}
No.3：嵌套條件分支的優(yōu)化（1）
大量的嵌套條件分支是很容易讓人望而卻步的代碼，我們應(yīng)該極力避免這種代碼的出現(xiàn)。盡管結(jié)構(gòu)化原則一直在說(shuō)一個(gè)函數(shù)只能有一個(gè)出口，但是在這么大量的嵌套條件分支下，讓我們忘了這所謂的規(guī)則吧。
有一個(gè)專業(yè)名詞叫衛(wèi)語(yǔ)句，可以治療這種恐怖的嵌套條件語(yǔ)句。它的核心思想是，將不滿足某些條件的情況放在方法前面，并及時(shí)跳出方法，以免對(duì)后面的判斷造成影響。經(jīng)過(guò)這項(xiàng)手術(shù)的代碼看起來(lái)會(huì)非常的清晰，下面 LZ 就給各位舉一個(gè)經(jīng)典的例子，各位可以自行評(píng)判一下這兩種方式，哪個(gè)讓你看起來(lái)更清晰一點(diǎn)。
小實(shí)例
class BadExample {
public void someMethod(Object A,Object B){
if (A != null) {
if (B != null) {
//code[1]
}else {
//code[3]
}
}else {
//code[2]
}
}
}
/* ---------------------分割線---------------------- */
class GoodExample {
public void someMethod(Object A,Object B){
if (A == null) {
//code[2]
return;
}
if (B == null) {
//code[3]
return;
}
//code[1]
}
}
No.4：嵌套條件分支的優(yōu)化（2）
此處所說(shuō)的嵌套條件分支與上面的有些許不同，它無(wú)法使用衛(wèi)語(yǔ)句進(jìn)行優(yōu)化，而應(yīng)該是將條件分支合并，以此來(lái)達(dá)到代碼清晰的目的。由這兩條也可以看出，嵌套條件分支在編碼當(dāng)中應(yīng)當(dāng)盡量避免，它會(huì)大大降低代碼的可讀性。
下面請(qǐng)尚且不明覺(jué)厲的猿友看下面這個(gè)典型的小例子。
小實(shí)例
class BadExample {
public void someMethod(Object A,Object B){
if (A != null) {
if (B != null) {
//code
}
}
}
}
/* ---------------------分割線---------------------- */
class GoodExample {
public void someMethod(Object A,Object B){
if (A != null && B != null) {
//code
}
}
}
No.5：去掉一次性的臨時(shí)變量
生活當(dāng)中我們都經(jīng)常用一次性筷子，這無(wú)疑是對(duì)樹(shù)木的摧殘。然而在程序當(dāng)中，一次性的臨時(shí)變量不僅是對(duì)性能上小小的摧殘，更是對(duì)代碼可讀性的褻瀆。因此我們有必要對(duì)一些一次性的臨時(shí)變量進(jìn)行手術(shù)。
小實(shí)例
class BadExample {
private int i;
public int someMethod(){
int temp = getVariable();
return temp * 100;
}
public int getVariable(){
return i;
}
}
/* ---------------------分割線---------------------- */
class GoodExample {
private int i;
public int someMethod(){
return getVariable() * 100;
}
public int getVariable(){
return i;
}
}
No.6：消除過(guò)長(zhǎng)參數(shù)列表
對(duì)于一些傳遞了大批參數(shù)的方法，對(duì)于追求代碼整潔的程序猿來(lái)說(shuō)，是無(wú)法接受的。我們可以嘗試將這些參數(shù)封裝成一個(gè)對(duì)象傳遞給方法，從而去除過(guò)長(zhǎng)的參數(shù)列表。大部分情況下，當(dāng)你嘗試尋找這樣一個(gè)對(duì)象的時(shí)候，它往往已經(jīng)存在了，因此絕大多數(shù)情況下，我們并不需要做多余的工作。
小實(shí)例
class BadExample {
public void someMethod(int i,int j,int k,int l,int m,int n){
//code
}
}
/* ---------------------分割線---------------------- */
class GoodExample {
public void someMethod(Data data){
//code
}
}
class Data{
private int i;
private int j;
private int k;
private int l;
private int m;
private int n;
//getter&&setter
}
No.7：提取類或繼承體系中的常量
這項(xiàng)重構(gòu)的目的是為了消除一些魔數(shù)或者是字符串常量等等，魔數(shù)所帶來(lái)的弊端自不用說(shuō)，它會(huì)讓人對(duì)程序的意圖產(chǎn)生迷惑。而對(duì)于字符串等類型的常量的消除，更多的好處在于維護(hù)時(shí)的方便。因?yàn)槲覀冎恍枰薷囊粋€(gè)常量，就可以完成對(duì)程序中所有使用該常量的代碼的修改。
順便提一句，與此類情況類似并且最常見(jiàn)的，就是 Action 基類中，對(duì)于 INPUT、LIST、SUCCESS 等這些常量的提取。
小實(shí)例
class BadExample {
public void someMethod1(){
send("您的操作已成功！");
}
public void someMethod2(){
send("您的操作已成功！");
}
public void someMethod3(){
send("您的操作已成功！");
}
private void send(String message){
//code
}
}
/* ---------------------分割線---------------------- */
class GoodExample {
protected static final String SUCCESS_MESSAGE = "您的操作已成功！";
public void someMethod1(){
send(SUCCESS_MESSAGE);
}
public void someMethod2(){
send(SUCCESS_MESSAGE);
}
public void someMethod3(){
send(SUCCESS_MESSAGE);
}
private void send(String message){
//code
}
}
No.8：讓類提供應(yīng)該提供的方法
很多時(shí)候，我們經(jīng)常會(huì)操作一個(gè)類的大部分屬性，從而得到一個(gè)最終我們想要的結(jié)果。這種時(shí)候，我們應(yīng)該讓這個(gè)類做它該做的事情，而不應(yīng)該讓我們替它做。而且大部分時(shí)候，這個(gè)過(guò)程最終會(huì)成為重復(fù)代碼的根源。
小實(shí)例
class BadExample {
public int someMethod(Data data){
int i = data.getI();
int j = data.getJ();
int k = data.getK();
return i * j * k;
}
public static class Data{
private int i;
private int j;
private int k;
public Data(int i, int j, int k) {
super();
this.i = i;
this.j = j;
this.k = k;
}
public int getI() {
return i;
}
public int getJ() {
return j;
}
public int getK() {
return k;
}
}
}
/* ---------------------分割線---------------------- */
class GoodExample {
public int someMethod(Data data){
return data.getResult();
}
public static class Data{
private int i;
private int j;
private int k;
public Data(int i, int j, int k) {
super();
this.i = i;
this.j = j;
this.k = k;
}
public int getI() {
return i;
}
public int getJ() {
return j;
}
public int getK() {
return k;
}
public int getResult(){
return i * j * k;
}
}
}
No.9：拆分冗長(zhǎng)的類
這項(xiàng)技巧其實(shí)也是屬于非常實(shí)用的一個(gè)技巧，只不過(guò)由于它的難度相對(duì)較高，因此被 LZ 排在了后面。針對(duì)這個(gè)技巧，LZ 很難像上面的技巧一樣，給出一個(gè)即簡(jiǎn)單又很容易說(shuō)明問(wèn)題的小例子，因?yàn)樗呀?jīng)不僅僅是小手段了。
大部分時(shí)候，我們拆分一個(gè)類的關(guān)注點(diǎn)應(yīng)該主要集中在類的屬性上面。拆分出來(lái)的兩批屬性應(yīng)該在邏輯上是可以分離的，并且在代碼當(dāng)中，這兩批屬性的使用也都分別集中于某一些方法當(dāng)中。如果實(shí)在有一些屬性同時(shí)存在于拆分后的兩批方法內(nèi)部，那么可以通過(guò)參數(shù)傳遞的方式解決這種依賴。
類的拆分是一個(gè)相對(duì)較大的工程，畢竟一個(gè)大類往往在程序中已經(jīng)被很多類所使用著，因此這項(xiàng)重構(gòu)的難度相當(dāng)之大，一定要謹(jǐn)慎，并做好足夠的測(cè)試。
No.10：提取繼承體系中重復(fù)的屬性與方法到父類
這項(xiàng)技巧大部分時(shí)候需要足夠的判斷力，很多時(shí)候，這其實(shí)是在向模板方法模式邁進(jìn)的過(guò)程。它的實(shí)例 LZ 這里無(wú)法給出，原因是因?yàn)樗男?shí)例會(huì)毫無(wú)意義，無(wú)非就是子類有一樣的屬性或者方法，然后刪除子類的重復(fù)屬性或方法放到父類當(dāng)中。
往往這一類重構(gòu)都不會(huì)是小工程，因此這一項(xiàng)重構(gòu)與第九種類似，都需要足夠的謹(jǐn)慎與測(cè)試。而且需要在你足夠確認(rèn)，這些提取到父類中的屬性或方法，應(yīng)該是子類的共性的時(shí)候，才可以使用這項(xiàng)技巧。
結(jié)束語(yǔ)
由于 LZ 目前的工作就是維護(hù)一個(gè)相對(duì)古老的項(xiàng)目，因此上面這十種手法，LZ 幾乎都已經(jīng)一一嘗試過(guò)了，可喜的是效果都還不錯(cuò)。
限于最后兩種與實(shí)際情況的聯(lián)系太過(guò)緊密，因此 LZ 無(wú)法給出簡(jiǎn)單的實(shí)例，不過(guò)后面兩種畢竟不是常用的重構(gòu)手法，因此也算是可以接受了。不過(guò)不常用不代表不重要，各位猿友還是要知道這一點(diǎn)的。另外 LZ 還要說(shuō)的是，上面的實(shí)例只是手法的一種簡(jiǎn)單展示，實(shí)際應(yīng)用當(dāng)中，代碼的結(jié)構(gòu)可能是千奇百怪，但卻萬(wàn)變不離其宗。因此只要抓住每種手法的核心，就不難從這些亂軍叢中安然穿過(guò)。
好了，本次的小分享到此結(jié)束，希望各位猿友如果覺(jué)得有所收獲，可以推薦一下鼓勵(lì)下 LZ，順便也讓更多的人看到。這樣的話，或許我們每一個(gè)接手的項(xiàng)目代碼，都不至于十分的糟糕了，也算是給像 LZ 這樣的項(xiàng)目維護(hù)者一條生路吧。
- END -
最后，祝大家技術(shù)在沉淀中升華。
最新熱文
15 個(gè)優(yōu)秀開(kāi)源的 Spring Boot 學(xué)習(xí)項(xiàng)目，一網(wǎng)打盡！
總有小驚喜
關(guān)注公眾號(hào):「Java 知己」，每天更新Java知識(shí)哦，期待你的到來(lái)！
發(fā)送「Idea」，獲取最新Idea激活工具。
發(fā)送「Group」，加入無(wú)廣告微信Java技術(shù)群。
發(fā)送「面試」，領(lǐng)取BATJ面試資料、面試視頻攻略。
發(fā)送「玩轉(zhuǎn)算法」，領(lǐng)取《玩轉(zhuǎn)算法》系列視頻教程。
千萬(wàn)不要發(fā)送「1024」…
