在這篇文章中,我想提出一種基于抽象級別的技術,可以將晦澀的代碼片段轉換為富有表現力的優雅代碼。
示例
這里是挑戰的代碼。我們將使用將不清晰的代碼轉換為具有表現力和優雅的代碼的技術來解決這個問題。如果你已經接受了挑戰,那么你可以跳到下一節,那里會展示這項技術。
你的應用程序的用戶正在計劃一次橫跨全國幾個城市的旅行。
如果兩座城市的距離足夠近(比如在100公里以下),他就會開車從一個城市直穿另一個城市,否則他會在兩座城市之間的公路上休息一下。用戶不會在兩個城市之間多于一次休息。
假設我們有計劃路線,以城市集合的形式出現。
你的目標是確定駕駛員必須休息多少次,例如,這對于他們的預算時間很有用。
該應用程序具有現有的組件,例如代表路線上給定城市的城市類。 城市可以提供其地理屬性,其中可以用位置類來表示其位置。 位置類型的對象本身可以計算到地圖上任何其他位置的行駛距離:
class Location
{
public:
double distanceTo(const Location& other) const;
...
};
class GeographicalAttributes
{
public:
Location getLocation() const;
...
};
class City
{
public:
GeographicalAttributes const& getGeographicalAttributes() const;
...
};
現在,這里是用于計算用戶必須休息的次數的當前實現:
#include <vector>
int computeNumberOfBreaks(const std::vector<City>& route)
{
static const double MaxDistance = 100;
int nbBreaks = 0;
for (std::vector<City>::const_iterator it1 = route.begin(), it2 = route.end();
it1 != route.end();
it2 = it1, ++it1)
{
if (it2 != route.end())
{
if(it1->getGeographicalAttributes().getLocation().distanceTo(
it2->getGeographicalAttributes().getLocation()) > MaxDistance)
{
++nbBreaks;
}
}
}
return nbBreaks;
}
你可能會承認這段代碼是相當晦澀的,而且普通讀者可能需要花一些時間來了解其中的情況。 不幸的是,在現實世界中你可能經常遇到。 而且,如果這段代碼位于經常讀取或更新的代碼行的位置,那么它將成為一個真正的問題。
讓我們來研究這段代碼,將其轉換為你的代碼資產。
使代碼富有表現力
使代碼具有表現力是尊重抽象級別所發生的一件好事,我認為這是設計良好代碼的最重要原則。
在許多不尊重抽象級別的情況下,問題出在較高層抽象的代碼中夾雜著較低層抽象代碼。 換句話說,問題是描述其如何執行動作而不是執行什么動作的代碼。 為了改進這樣的代碼,你需要提高其抽象級別。
為此,你可以應用以下技術:
確定代碼在做什么,并挨個用標簽替換他們
這具有顯著提高代碼表達能力的效果。
上面這段代碼的問題在于它沒有說明含義——該代碼沒有表現力。 讓我們使用之前的指南來提高表達能力,也就是說,讓我們確定代碼的作用,并在每個代碼上加上標簽。
讓我們從迭代邏輯開始:
for (std::vector<City>::const_iterator it1 = route.begin(), it2 = route.end();
it1 != route.end();
it2 = it1, ++it1)
{
if (it2 != route.end())
{
也許你之前已經看過這種技術。 這是一種操縱容器中相鄰元素的技巧。 it1從begin處開始,并且it2一直沿遍歷指向it1之前的元素。 為了初始化它,我們首先把它設在容器的末尾,并檢查它是否不再在循環主體的末尾以實際開始工作。
無需說這段代碼并不完全具有表達力。 但是現在我們已經確定了它的含義:它旨在一起操縱連續的元素。
讓我們在以下情況下處理下一部分代碼:
it1->getGeographicalAttributes().getLocation().distanceTo(
it2->getGeographicalAttributes().getLocation()) > MaxDistance
單獨考慮這一點,就很容易分析其含義。 它確定兩個城市的距離是否比MaxDistance更遠。
讓我們用代碼的其余部分變量nbBreaks完成分析:
int nbBreaks = 0;
for (...)
{
if(...)
{
++nbBreaks;
}
}
return nbBreaks;
此處,代碼根據條件使變量遞增。 這意味著要計算滿足條件的次數。
因此,總而言之,下面是描述函數功能的標簽:
- 一起處理連續的元素,
- 確定城市之間距離是否比MaxDistance更遠,
- 計算滿足條件的次數。
一旦完成了這一分析,模糊的代碼變成有意義的代碼只是時間問題。
準則是在代碼執行的每件事上都貼上標簽,并用它替換相應的代碼。 在這里,我們將執行以下操作:
-
對操作連續元素,我們可以創建一個稱為“consecutive”的組件,該組件會將一組元素轉換成一組元素對,每一對都有初始容器中的一個元素和它的下一個元素。例如,如果路由包含{A,B,C,D,E},則consecutive將包含{(A,B),(B,C),(C,D),(D,E)}。
你可以查看我在這里的實現。一種創建相鄰元素的適配器,最近才加入到很流行的range-v3庫中。更多相關的話題可以看這篇文章Fluent C++:Ranges:STL的高級用法。
-
為了確定兩個連續的城市是否比MaxDistance距離更遠,我們可以簡單地使用一個函數對象(functor),我們將其稱為FartherThan。我認識到,由于C ++ 11函子已被lambda取代,但是在這里我們需要給它起個名字。用lambda優雅地進行此操作需要做更多的工作,我們將在專門的文章中對此進行詳細探討:
class FartherThan { public: explicit FartherThan(double distance) : m_distance(distance) {} bool operator()(const std::pair<City, City>& cities) { return cities.first.getGeographicalAttributes().getLocation().distanceTo( cities.second.getGeographicalAttributes().getLocation()) > m_distance; } private: double m_distance; };
為了計算滿足條件的次數,我們可以僅使用STL算法count_if。
這是通過用相應的標簽替換代碼而獲得的最終結果:
int computeNumberOfBreaks(const std::vector<City>& route)
{
static const double MaxDistance = 100;
return count_if(consecutive(route), FartherThan(MaxDistance));
}
(注意:原始的count_if C ++函數會將兩個迭代器指向容器的begin和end位置。此處使用的一個迭代器僅使用傳遞range的begin和end來調用原始版本)。
這段代碼明確顯示了它在做什么,并尊重抽象級別。 因此,它比最初版本的更具表達力。 最初的版本只告訴了它是如何工作的,剩下的工作留給了讀者。
可以將這種技術應用于許多不清楚的代碼段,以將它們變成非常有表現力的代碼段。 它甚至可以用C ++以外的其他語言來應用。 因此,下次你偶然發現想要重構的晦澀的代碼時,請考慮確定代碼的作用,并在每個代碼上加上標簽。 你應該會對結果感到驚喜。