PHPer這樣寫程式碼也許更優雅

TIGERB發表於2018-06-21

前言

轉眼間成為一名PHPer已經快整整兩年了，在這期間也對如何寫出可讀性高，便於擴充套件的程式碼有了一些自己的想法。

使用引用

場景一：遍歷一個陣列獲取新的資料結構

也許你會這樣寫：

// 申明一個新的陣列,組裝成你想要的資料
$tmp = [];
foreach ($arr as $k => $v) {
    // 取出你想要的資料
    $tmp[$k]['youwant'] = $v['youwant'];
    ...
    // 一系列判斷得到你想要的資料
    if (...) {
        $tmp[$k]['youwantbyjudge'] = 'TIGERB';
    }
    ...
}
// 最後得要你想要的陣列$tmp

-------------------------------------------------------

// 也許你覺著上面的寫法不是很好，那我們下面換種寫法
foreach ($arr as $k => $v) {
    // 一系列判斷得到你想要的資料
    if (...) {
        // 複寫值為你想要的
        $arr[$k]['youwantbyjudge'] = 'TIGERB'
    }
    ...
    // 幹掉你不想要的結構
    unset($arr[$k]['youwantdel']);
}
// 最後我們得到我們的目標陣列$arr
複製程式碼

接下來我們使用引用值：

foreach ($arr as ＆$v) {
    // 一系列判斷得到你想要的資料
    if (...) {
        // 複寫值為你想要的
        $v['youwantbyjudge'] = 'TIGERB'
    }
    ...
    // 幹掉你不想要的結構
    unset($v['youwantdel']);
}
unset($v);
// 最後我們得到我們的目標陣列$arr
複製程式碼

使用引用是不是使我們的程式碼更加的簡潔，除此之外相對於第一種寫法，我們節省了記憶體空間，尤其是再操作一個大陣列時效果是及其明顯的。

場景二：傳遞一個值到一個函式中獲取新的值

基本和陣列遍歷一致，我們只需要宣告這個函式的這個引數為引用即可，如下：

function decorate(&$arr = []) {
    # code...
}

$arr = [
    ....
];
// 呼叫函式
decorate($arr);
// 如上即得到新的值$arr，好處還是節省記憶體空間

複製程式碼

使用try...catch...

假如有下面一段邏輯：

class UserModel
{
    public function login($username = '', $password = '')
    {
        code...
        if (...) {
            // 使用者不存在
            return -1;
        }
        code...
        if (...) {
            // 密碼錯誤
            return -2;
        }
        code...
    }
}

class UserController
{
    public function login($username = '', $password = '')
    {
        $model = new UserModel();
        $res   = $model->login($username, $password);
        if ($res === -1) {
            return [
                'code' => '404',
                'message' => '使用者不存在'
            ];
        }
        if ($res === -2) {
            return [
                'code' => '400',
                'message' => '密碼錯誤'
            ];
        }
        code...
    }
}
複製程式碼

我們用try...catch...改寫後：

class UserModel
{
    public function login($username = '', $password = '')
    {
        code...
        if (...) {
            // 使用者不存在
            throw new Exception('使用者不存在', '404');
        }
        code...
        if (...) {
            // 密碼錯誤
            throw new Exception('密碼錯誤', '400');
        }
        code...
    }
}

class UserController
{
    public function login($username = '', $password = '')
    {
        try {
            $model = new UserModel();
            $res   = $model->login($username, $password);
            // 如果需要的話，我們可以在這裡統一commit資料庫事務
            // $db->commit();
        } catch (Exception $e) {
            // 如果需要的話，我們可以在這裡統一rollback資料庫事務
            // $db->rollback();
            return [
                'code'    => $e->getCode(),
                'message' => $e->getMessage()
            ]
        }
    }
}
複製程式碼

通過使用try...catch...使我們的程式碼邏輯更加清晰，try...裡只需要關注業務正常的情況，異常的處理統一在catch中。所以，我們在寫上游程式碼時異常直接丟擲即可。

使用匿名函式

** 構建函式或方法內部的程式碼塊 **

假如我們有一段邏輯，在一個函式或者方法裡我們需要格式化資料,但是這個格式化資料的程式碼片段出現了多次，如果我們直接寫可能會想下面這樣：

function doSomething(...) {
    ...
    // 格式化程式碼段
    ...
    ...
    // 格式化程式碼段[重複的程式碼]
    ...
}
複製程式碼

我相信大多數的人應該不會像上面這麼寫，可能都會像下面這樣：

function doSomething(...) {
    ...
    format(...);
    ...
    format(...);
    ...
}

// 再宣告一個格式花程式碼的函式或方法
function format() {
    // 格式化程式碼段
    ...
}
複製程式碼

上面這樣的寫法沒有任何的問題，最小單元化我們的程式碼片段，但是如果這個format函式或者方法只是doSomething使用呢？我通常會像下面這麼寫，為什麼？因為我認為在這種上下文的環境中format和doSomething的一個子集。

function doSomething() {
    ...
    $package = function (...) use (...) {&emsp;// 同樣use後面的引數也可以傳引用
        // 格式化程式碼段
        ...
    };
    ...
    package(...);
    ...
    package(...);
    ...
}
複製程式碼

** 實現類的【懶載入】和實現設計模式的【最少知道原則】 **

假如有下面這段程式碼：

class One
{
    private $instance;

    // 類One內部依賴了類Two
    // 不符合設計模式的最少知道原則
    public function __construct()
    {  
        $this->intance = new Two();
    }

    public function doSomething()
    {
        if (...) {
            // 如果某種情況呼叫類Two的例項方法
            $this->instance->do(...);
        }
        ...
    }
}
...

$instance = new One();
$instance->doSomething();
...
複製程式碼

上面的寫法有什麼問題？

不符合設計模式的最少知道原則,類One內部直接依賴了類Two
類Two的例項不是所有的上下文都會用到，所以浪費了資源，有人說搞個單例，但是解決不了例項化了不用的尷尬

所以我們使用匿名函式解決上面的問題，下面我們這麼改寫：

class One
{
    private $closure;

    public function __construct(Closure $closure)
    {  
        $this->closure = $closure;
    }

    public function doSomething()
    {
        if (...) {
            // 用的時候再例項化
            // 實現懶載入
            $instance = $this->closure();
            $instance->do(...)
        }
        ...
    }
}
...

$instance = new One(function () {
    // 類One外部依賴了類Two
    return new Two();
});
$instance->doSomething();
...
複製程式碼

減少對if...else...的使用

如果你碰見下面這種型別的程式碼，那一定是個黑洞。

function doSomething() {
    if (...) {
        if (...) {
            ...
        } esle {
            ...
        }
    } else {
        if (...) {
            ...
        } esle {
            ...
        }
    }
}

複製程式碼

** 提前return異常 **

細心的你可能會發現上面這種情況，可能絕大多數else程式碼裡都是在處理異常情況，更有可能這個異常程式碼特別簡單，通常我會這麼去做：

//&emsp;如果是在一個函式裡面我會先處理異常的情況，然後提前return程式碼，最後再執行正常的邏輯
function doSomething() {
    if (...) {
        // 異常情況
        return ...;
    }
    if (...) {
        // 異常情況
        return ...;
    }
    //&emsp;正常邏輯
    ...
}

//&emsp;同樣，如果是在一個類裡面我會先處理異常的情況，然後先丟擲異常
class One
{
    public function doSomething()
    {
        if (...) {
            // 異常情況
            throw new Exception(...);
        }
        if (...) {
            // 異常情況
            throw new Exception(...);
        }
        //&emsp;正常邏輯
        ...
    }
}

複製程式碼

** 關聯陣列做map **

如果我們在客戶端做決策，通常我們會判斷不同的上下文在選擇不同策略，通常會像下面一樣使用if或者switch判斷:

class One
{
    public function doSomething()
    {
        if (...) {
            $instance = new A();
        }&emsp;elseif (...) {
            $instance = new A();
        } else {
            $instance = new C();
        }
        $instance->doSomething(...);
        ...
    }
}
複製程式碼

上面的寫法通常會出現大量的if語句或者switch語句，通常我會使用一個map來對映不同的策略，像下面這樣：

class One
{
    private $map = [
        'a' => 'namespace\A', // 帶上名稱空間，因為變數是動態的
        'b' => 'namespace\B',
        'c' => 'namespace\C'
    ];
    public function doSomething()
    {
        ...
        $instance = new $this->map[$strategy];// $strategy是'a'或'b'或'c'
        $instance->doSomething(...);
        ...
    }
}
複製程式碼

使用介面

為什麼要使用介面？極大的便於後期的擴充套件和程式碼的可讀性，例如設計一個優惠系統，不同的商品只是在不同的優惠策略下具備不同的優惠行為，我們定義一個優惠行為的介面，最後對這個介面程式設計即可，虛擬碼如下

Interface Promotion
{
    public function promote(...);
}

class OnePromotion implement Promotion
{
    public function doSomething(...)
    {
        ...
    }
}

class TwoPromotion implement Promotion
{
    public function doSomething(...)
    {
        ...
    }
}
複製程式碼

控制器拒絕直接的DB操作

最後我想說的是永遠拒絕在你的Controller裡直接操作DB，為什麼？我們的程式絕大多數的操作基本都是增刪改查，可能是查詢的where條件和欄位不同，所以有時候我們可以抽象的把對資料庫增刪改查的方法寫到model中，通過引數暴露我們的where，fields條件。通常這樣可以很大程度的提高效率和程式碼複用。比如像下面這樣：

class DemoModel implement Model
{
    public function getMultiDate($where = [], $fields = ['id'], $orderby = 'id asc')
    {
        $this->where($where)
             ->field($fields)
             ->orderby($orderby)
             ->get();
    }
}
複製程式碼

最後

如果有寫的不對的地方，歡迎大家指正,THX～

編寫更優雅的 JavaScript 程式碼
2018-09-05
JavaScript
也許這是最優雅的前端請求方案
2019-04-01
前端
【優雅寫程式碼系統】springboot+mybatis+pagehelper+mybatisplus+druid教你如何優雅寫程式碼
2020-06-11
Spring BootMyBatisUI
如何寫出優雅的程式碼？
2019-04-10
寫出優雅的js程式碼
2018-11-28
JS
如何用 SpringBoot 優雅的寫程式碼
2018-04-05
Spring Boot
怎麼讓程式碼不再臃腫，寫的像詩一樣優雅
2019-05-07
玩轉 React（三）- JavaScript程式碼裡寫HTML一樣可以很優雅
2019-03-01
ReactJavaScriptHTML
如何提高Java程式碼質量-優雅的寫程式碼
2018-08-28
Java
如何寫出優雅耐看的JavaScript程式碼
2019-09-20
JavaScript
編寫優雅程式碼的最佳實踐
2018-04-24
用 Node 抓站（二）：Promise 使程式碼更優雅
2019-03-03
Promise
如何寫出更優質的程式碼
2023-02-11
MyBatis 動態 SQL 最全教程，這樣寫 SQL 太優雅了！
2024-04-26
MyBatisSQL
這也許是Android一句話許可權適配的更優解決方案
2019-04-25
Android
9條消除if...else的錦囊妙計，助你寫出更優雅的程式碼
2021-01-31
幾個簡單的技巧讓你寫出的vue.js程式碼更優雅
2018-12-04
Vue.js
golang如何優雅的編寫事務程式碼
2020-05-25
Golang
Go Interface 的優雅使用，讓程式碼更整潔更容易測試
2020-10-20
Go
想寫出優雅的程式碼？試試這些ES6小tips
2018-07-15
使用Async，讓你的Node.js程式碼更優雅
2021-09-09
Node.js
一些技巧讓你的 Laravel 程式碼更優雅
2018-06-06
Laravel
優雅的程式碼
2021-07-01
有什麼更優雅的凡是來處理這樣一對陣列！
2020-11-08
陣列
優雅地減少redux請求樣板程式碼
2019-03-02
Redux
教你更優雅地寫 API 之「列舉使用」
2020-12-26
API
JavaScript複雜判斷的更優雅寫法
2018-11-13
JavaScript
JavaScript 複雜判斷的更優雅寫法
2018-11-14
JavaScript
30個python教你學會優雅的寫程式碼
2022-07-13
Python
我是如何將業務程式碼寫優雅的
2019-04-30
十年架構師：我是這樣手寫Spring的，用300行程式碼體現優雅之道
2019-06-21
架構Spring行程
大牛的程式碼是這樣寫的
2019-05-11
怎樣寫出優雅的HTML結構？
2024-12-09
HTML
Java列舉類，這樣使用優雅、易懂
2021-09-06
Java
教你更優雅地寫 API 之「記錄日誌」
2021-01-18
API
助您寫出優雅的Java程式碼七點建議
2019-01-15
Java
如何用 es6+ 寫出優雅的 js 程式碼
2018-12-07
JS
看promise教你如何優雅的寫js非同步程式碼
2018-05-20
PromiseJS非同步