PHP下的非同步嘗試四：PHP版的Promise

Object發表於2018-09-29

PHP下的非同步嘗試系列

如果你還不太瞭解PHP下的生成器和協程，你可以根據下面目錄翻閱

Promise 實現

程式碼結構

│  │  autoload.php
│  │  promise1.php
│  │  promise2.php
│  │  promise3.php
│  │  promise4.php
│  │  promise5.php
│  │
│  └─classes
│          Promise1.php
│          Promise2.php
│          Promise3.php
│          Promise4.php
│          Promise5.php
│          PromiseState.php

嘗試一 (Promise基礎)

classess/PromiseState.php

final class PromiseState
{
    const PENDING = 'pending';
    const FULFILLED = 'fulfilled';
    const REJECTED = 'rejected';
}

classess/Promise1.php

// 嘗試一
class Promise1
{
    private $value;
    private $reason;
    private $state;

    public function __construct(\Closure $func = null)
    {
        $this->state = PromiseState::PENDING;

        $func([$this, 'resolve'], [$this, 'reject']);
    }

    /**
     * 執行回撥方法裡的resolve繫結的方法
     * @param null $value
     */
    public function resolve($value = null)
    {
        // 回撥執行resolve傳參的值，賦值給result
        $this->value = $value;

        if ($this->state == PromiseState::PENDING) {
            $this->state = PromiseState::FULFILLED;
        }
    }

    public function reject($reason = null)
    {
        // 回撥執行resolve傳參的值，賦值給result
        $this->reason = $reason;

        if ($this->state == PromiseState::PENDING) {
            $this->state = PromiseState::REJECTED;
        }
    }

    public function getState()
    {
        return $this->state;
    }

    public function getValue()
    {
        return $this->value;
    }

    public function getReason()
    {
        return $this->reason;
    }
}

promise1.php

require "autoload.php";

$promise = new Promise1(function($resolve, $reject) {
    $resolve("列印我");
});

var_dump($promise->getState());
var_dump($promise->getValue());

結果：

string(9) "fulfilled"
string(9) "列印我"

結論或問題：

我們在這裡建構了最基礎的Promise模型

嘗試二 (增加鏈式then)

classess/Promise2.php

<?php
// 嘗試二 （增加鏈式then）
class Promise2
{
    private $value;
    private $reason;
    private $state;

    public function __construct(\Closure $func = null)
    {
        $this->state = PromiseState::PENDING;

        $func([$this, 'resolve'], [$this, 'reject']);
    }

    public function then(\Closure $onFulfilled = null, \Closure $onRejected = null)
    {
        // 如果狀態是fulfilled，直接回撥執行並傳參value
        if ($this->state == PromiseState::FULFILLED) {
            $onFulfilled($this->value);
        }

        // 如果狀態是rejected，直接回撥執行並傳參reason
        if ($this->state == PromiseState::REJECTED) {
            $onRejected($this->reason);
        }

        // 返回物件自身，實現鏈式呼叫
        return $this;

    }

    /**
     * 執行回撥方法裡的resolve繫結的方法
     * 本狀態只能從pending->fulfilled
     * @param null $value
     */
    public function resolve($value = null)
    {
        if ($this->state == PromiseState::PENDING) {
            $this->state = PromiseState::FULFILLED;
            $this->value = $value;
        }
    }

    /**
     * 執行回撥方法裡的rejected繫結的方法
     * 本狀態只能從pending->rejected
     * @param null $reason
     */
    public function reject($reason = null)
    {
        if ($this->state == PromiseState::PENDING) {
            $this->state = PromiseState::REJECTED;
            $this->reason = $reason;
        }
    }

    public function getState()
    {
        return $this->state;
    }

    public function getValue()
    {
        return $this->value;
    }

    public function getReason()
    {
        return $this->reason;
    }
}

promise2.php

<?php

require "autoload.php";

$promise = new Promise2(function($resolve, $reject) {
    $resolve("列印我");
});

$promise->then(function ($value) {
    var_dump($value);
}, function ($reason) {
    var_dump($reason);
})->then(function ($value) {
    var_dump($value);
}, function ($reason) {
    var_dump($reason);
});

結果：

string(9) "列印我"
string(9) "列印我"

結論或問題：

我們實現了鏈式then方法

如果我們的構造裡的回撥是非同步執行的話，那麼狀態在沒有變成fulfilled之前，我們then裡的回撥方法就永遠沒法執行

嘗試三（真正的鏈式then）

classess/Promise3.php

// 解決思路：我們肯定要把then傳入的回撥，放到Promise構造裡回撥程式碼執行完後resolve呼叫後改變了state狀態後再呼叫，所以我們必須儲存到一個地方並方便後續呼叫
// 我們需要改造then、resolve和reject方法
class Promise3
{
    private $value;
    private $reason;
    private $state;
    private $fulfilledCallbacks = [];
    private $rejectedCallbacks = [];

    public function __construct(\Closure $func = null)
    {
        $this->state = PromiseState::PENDING;

        $func([$this, 'resolve'], [$this, 'reject']);
    }

    public function then(\Closure $onFulfilled = null, \Closure $onRejected = null)
    {
        // 如果是非同步回撥，狀態未變化之前，then的回撥方法壓入相應的陣列方便後續呼叫
        if ($this->state == PromiseState::PENDING) {
            $this->fulfilledCallbacks[] = static function() use ($onFulfilled, $value){
                $onFulfilled($this->value);
            };

            $this->rejectedCallbacks[] = static function() use ($onRejected, $reason){
                $onRejected($this->reason);
            };
        }

        // 如果狀態是fulfilled，直接回撥執行並傳參value
        if ($this->state == PromiseState::FULFILLED) {
            $onFulfilled($this->value);
        }

        // 如果狀態是rejected，直接回撥執行並傳參reason
        if ($this->state == PromiseState::REJECTED) {
            $onRejected($this->reason);
        }

        // 返回物件自身，實現鏈式呼叫
        return $this;

    }

    /**
     * 執行回撥方法裡的resolve繫結的方法
     * 本狀態只能從pending->fulfilled
     * @param null $value
     */
    public function resolve($value = null)
    {
        if ($this->state == PromiseState::PENDING) {
            $this->state = PromiseState::FULFILLED;
            $this->value = $value;

            array_walk($this->fulfilledCallbacks, function ($callback) {
                $callback();
            });
        }
    }

    /**
     * 執行回撥方法裡的rejected繫結的方法
     * 本狀態只能從pending->rejected
     * @param null $reason
     */
    public function reject($reason = null)
    {
        if ($this->state == PromiseState::PENDING) {
            $this->state = PromiseState::REJECTED;
            $this->reason = $reason;
        }
    }

    public function getState()
    {
        return $this->state;
    }

    public function getValue()
    {
        return $this->value;
    }

    public function getReason()
    {
        return $this->reason;
    }
}

promise3.php

require "autoload.php";

$promise = new Promise3(function($resolve, $reject) {
    $resolve("列印我");
});

$promise->then(function ($value) {
    var_dump($value);
}, function ($reason) {
    var_dump($reason);
})->then(function ($value) {
    var_dump($value);
}, function ($reason) {
    var_dump($reason);
});

結果：

string(9) "列印我"
string(9) "列印我"

結論或問題：

我們這次基本實現了真正的鏈式then方法

不過在Promise/A+裡規範，要求then返回每次都要求是一個新的Promise物件
then方法成功執行，相當於返回一個例項一個Promise回撥裡執行resolve方法，resolve值為then裡return的值
then方法執行失敗或出錯，相當於返回一個例項一個Promise回撥裡執行rejected方法，rejected值為then裡return的值

嘗試四（then返回pormise物件, 並傳遞上一次的結果給下一個Promise物件）

classess/Promise4.php

class Promise4
{
    private $value;
    private $reason;
    private $state;
    private $fulfilledCallbacks = [];
    private $rejectedCallbacks = [];

    public function __construct(\Closure $func = null)
    {
        $this->state = PromiseState::PENDING;

        $func([$this, 'resolve'], [$this, 'reject']);
    }

    public function then(\Closure $onFulfilled = null, \Closure $onRejected = null)
    {
        $thenPromise = new Promise4(function ($reslove, $reject) use (&$thenPromise, $onFulfilled, $onRejected) {

            //$this 代表的當前的Promise物件，不要混淆了

            // 如果是非同步回撥，狀態未變化之前，then的回撥方法壓入相應的陣列方便後續呼叫
            if ($this->state == PromiseState::PENDING) {
                $this->fulfilledCallbacks[] = static function() use ($thenPromise, $onFulfilled, $reslove, $reject){
                    $value = $onFulfilled($this->value);
                    $this->resolvePromise($thenPromise, $value, $reslove, $reject);
                };

                $this->rejectedCallbacks[] = static function() use ($thenPromise, $onRejected, $reslove, $reject){
                    $reason = $onRejected($this->reason);
                    $this->resolvePromise($thenPromise, $reason, $reslove, $reject);
                };
            }

            // 如果狀態是fulfilled，直接回撥執行並傳參value
            if ($this->state == PromiseState::FULFILLED) {
                $value = $onFulfilled($this->value);
                $this->resolvePromise($thenPromise, $value, $reslove, $reject);
            }

            // 如果狀態是rejected，直接回撥執行並傳參reason
            if ($this->state == PromiseState::REJECTED) {
                $reason = $onRejected($this->reason);
                $this->resolvePromise($thenPromise, $reason, $reslove, $reject);
            }

        });

        // 返回物件自身，實現鏈式呼叫
        return $thenPromise;

    }

    /**
     * 解決Pormise鏈式then傳遞
     * 可參考 [Promises/A+]2.3 [https://promisesaplus.com/#the-promise-resolution-procedure]
     * @param $thenPromise
     * @param $x            $x為thenable物件
     * @param $resolve
     * @param $reject
     */
    private function resolvePromise($thenPromise, $x, $resolve, $reject)
    {
        $called = false;

        if ($thenPromise === $x) {
            return $reject(new \Exception('迴圈引用'));
        }

        if ( is_object($x) && method_exists($x, 'then')) {

            $resolveCb = function ($value) use($thenPromise, $resolve, $reject, $called) {
                if ($called) return ;
                $called = true;
                // 成功值y有可能還是promise或者是具有then方法等，再次resolvePromise，直到成功值為基本型別或者非thenable
                $this->resolvePromise($thenPromise, $value, $resolve, $reject);
            };

            $rejectCb = function($reason) use($thenPromise, $resolve, $reject, $called) {
                if ($called) return ;
                $called = true;
                $reject($reason);
            };

            call_user_func_array([$x, 'then'], [$resolveCb, $rejectCb]);

        } else {
            if ($called) return ;
            $called = true;
            $resolve($x);
        }
    }

    /**
     * 執行回撥方法裡的resolve繫結的方法
     * 本狀態只能從pending->fulfilled
     * @param null $value
     */
    public function resolve($value = null)
    {
        if ($this->state == PromiseState::PENDING) {
            $this->state = PromiseState::FULFILLED;
            $this->value = $value;

            array_walk($this->fulfilledCallbacks, function ($callback) {
                $callback();
            });
        }
    }

    /**
     * 執行回撥方法裡的rejected繫結的方法
     * 本狀態只能從pending->rejected
     * @param null $reason
     */
    public function reject($reason = null)
    {
        if ($this->state == PromiseState::PENDING) {
            $this->state = PromiseState::REJECTED;
            $this->reason = $reason;
        }
    }

    public function getState()
    {
        return $this->state;
    }

    public function getValue()
    {
        return $this->value;
    }

    public function getReason()
    {
        return $this->reason;
    }
}

promise4.php

require "autoload.php";

$promise1 = new Promise4(function($resolve, $reject) {
    $resolve("列印我");
});

$promise2 = $promise1->then(function ($value) {
    var_dump($value);
    return "promise2";
}, function ($reason) {
    var_dump($reason);
});

$promise3 = $promise2->then(function ($value) {
    var_dump($value);
    return new Promise4(function($resolve, $reject) {
        $resolve("promise3");
    });
}, function ($reason) {
    var_dump($reason);
});

$promise4 = $promise3->then(function ($value) {
    var_dump($value);
    return "promise4";
}, function ($reason) {
    var_dump($reason);
});

var_dump($promise4);

結果：

string(9) "列印我"
string(8) "promise2"
string(8) "promise3"
object(Promise4)#15 (5) {
  ["value":"Promise4":private]=>
  string(8) "promise4"
  ["reason":"Promise4":private]=>
  NULL
  ["state":"Promise4":private]=>
  string(9) "fulfilled"
  ["fulfilledCallbacks":"Promise4":private]=>
  array(0) {
  }
  ["rejectedCallbacks":"Promise4":private]=>
  array(0) {
  }
}

結論或問題：

一個基本的Pormise，不過我們上面都是基於成功fulfilled狀態的實現
下面我們來增加錯誤捕獲

嘗試五（錯誤捕獲）

classess/Promise5.php

class Promise5
{
    private $value;
    private $reason;
    private $state;
    private $fulfilledCallbacks = [];
    private $rejectedCallbacks = [];

    public function __construct(\Closure $func = null)
    {
        $this->state = PromiseState::PENDING;

        $func([$this, 'resolve'], [$this, 'reject']);
    }

    public function then(\Closure $onFulfilled = null, \Closure $onRejected = null)
    {
        // 此處作用是相容then方法的以下四種引數變化，catchError就是第二種情況
        // 1. then($onFulfilled, null)
        // 2. then(null, $onRejected)
        // 3. then(null, null)
        // 4. then($onFulfilled, $onRejected)
        $onFulfilled = is_callable($onFulfilled) ? $onFulfilled :  function ($value) {return $value;};
        $onRejected = is_callable($onRejected) ? $onRejected :  function ($reason) {throw $reason;};

        $thenPromise = new Promise5(function ($reslove, $reject) use (&$thenPromise, $onFulfilled, $onRejected) {

            //$this 代表的當前的Promise物件，不要混淆了

            // 如果是非同步回撥，狀態未變化之前，then的回撥方法壓入相應的陣列方便後續呼叫
            if ($this->state == PromiseState::PENDING) {
                $this->fulfilledCallbacks[] = static function() use ($thenPromise, $onFulfilled, $reslove, $reject){
                    try {
                        $value = $onFulfilled($this->value);
                        $this->resolvePromise($thenPromise, $value, $reslove, $reject);
                    } catch (\Exception $e) {
                        $reject($e);
                    }
                };

                $this->rejectedCallbacks[] = static function() use ($thenPromise, $onRejected, $reslove, $reject){
                    try {
                        $reason = $onRejected($this->reason);
                        $this->resolvePromise($thenPromise, $reason, $reslove, $reject);
                    } catch (\Exception $e) {
                        $reject($e);
                    }
                };
            }

            // 如果狀態是fulfilled，直接回撥執行並傳參value
            if ($this->state == PromiseState::FULFILLED) {
                try {
                    $value = $onFulfilled($this->value);
                    $this->resolvePromise($thenPromise, $value, $reslove, $reject);
                } catch (\Exception $e) {
                    $reject($e);
                }
            }

            // 如果狀態是rejected，直接回撥執行並傳參reason
            if ($this->state == PromiseState::REJECTED) {
                try {
                    $reason = $onRejected($this->reason);
                    $this->resolvePromise($thenPromise, $reason, $reslove, $reject);
                } catch (\Exception $e) {
                    $reject($e);
                }
            }

        });

        // 返回物件自身，實現鏈式呼叫
        return $thenPromise;

    }

    public function catchError($onRejected)
    {
        return $this->then(null, $onRejected);
    }

    /**
     * 解決Pormise鏈式then傳遞
     * 可參考 [Promises/A+]2.3 [https://promisesaplus.com/#the-promise-resolution-procedure]
     * @param $thenPromise
     * @param $x            $x為thenable物件
     * @param $resolve
     * @param $reject
     */
    private function resolvePromise($thenPromise, $x, $resolve, $reject)
    {
        $called = false;

        if ($thenPromise === $x) {
            return $reject(new \Exception('迴圈引用'));
        }

        if ( is_object($x) && method_exists($x, 'then')) {
            try {
                $resolveCb = function ($value) use ($thenPromise, $resolve, $reject, $called) {
                    if ($called) return;
                    $called = true;
                    // 成功值y有可能還是promise或者是具有then方法等，再次resolvePromise，直到成功值為基本型別或者非thenable
                    $this->resolvePromise($thenPromise, $value, $resolve, $reject);
                };

                $rejectCb = function ($reason) use ($thenPromise, $resolve, $reject, $called) {
                    if ($called) return;
                    $called = true;
                    $reject($reason);
                };

                call_user_func_array([$x, 'then'], [$resolveCb, $rejectCb]);
            } catch (\Exception $e) {
                if ($called) return ;
                $called = true;
                $reject($e);
            }

        } else {
            if ($called) return ;
            $called = true;
            $resolve($x);
        }
    }

    /**
     * 執行回撥方法裡的resolve繫結的方法
     * 本狀態只能從pending->fulfilled
     * @param null $value
     */
    public function resolve($value = null)
    {
        if ($this->state == PromiseState::PENDING) {
            $this->state = PromiseState::FULFILLED;
            $this->value = $value;

            array_walk($this->fulfilledCallbacks, function ($callback) {
                $callback(); //因為回撥本身攜帶了作用於，所以直接呼叫，無法引數
            });
        }
    }

    /**
     * 執行回撥方法裡的rejected繫結的方法
     * 本狀態只能從pending->rejected
     * @param null $reason
     */
    public function reject($reason = null)
    {
        if ($this->state == PromiseState::PENDING) {
            $this->state = PromiseState::REJECTED;
            $this->reason = $reason;

            array_walk($this->rejectedCallbacks, function ($callback) {
                $callback(); //因為回撥本身攜帶了作用於，所以直接呼叫，無法引數
            });
        }
    }

    public function getState()
    {
        return $this->state;
    }

    public function getValue()
    {
        return $this->value;
    }

    public function getReason()
    {
        return $this->reason;
    }
}

promise5.php

require "autoload.php";

$promise1 = new Promise5(function($resolve, $reject) {
    $resolve("列印我");
});

$promise2 = $promise1->then(function ($value) {
    var_dump($value);
    throw new \Exception("promise2 error");
    return "promise2";
}, function ($reason) {
    var_dump($reason->getMessage());
    return "promise3 error return";
});

//我們可以簡寫then方法，只傳入$onFulfilled方法，然後錯誤會自己冒泡方式到下一個catchError或then裡處理。
//$promise3 = $promise2->then(function ($value) {
//    var_dump($value);
//    return new Promise5(function($resolve, $reject) {
//        $resolve("promise3");
//    });
//})->catchError(function ($reason) {
//    var_dump($reason->getMessage());
//    return "promise3 error return";
//});

$promise3 = $promise2->then(function ($value) {
    var_dump($value);
    return new Promise5(function($resolve, $reject) {
        $resolve("promise3");
    });
}, function ($reason) {
    var_dump($reason->getMessage());
    return "promise3 error return";
});

$promise4 = $promise3->then(function ($value) {
    var_dump($value);
    return "promise4";
}, function ($reason) {
    echo $reason->getMessage();
});

var_dump($promise4);

結果：

string(9) "列印我"
string(14) "promise2 error"
string(21) "promise3 error return"
object(Promise4)#10 (5) {
  ["value":"Promise4":private]=>
  string(8) "promise4"
  ["reason":"Promise4":private]=>
  NULL
  ["state":"Promise4":private]=>
  string(9) "fulfilled"
  ["fulfilledCallbacks":"Promise4":private]=>
  array(0) {
  }
  ["rejectedCallbacks":"Promise4":private]=>
  array(0) {
  }
}

結論或問題：

這裡我們基礎實現了一個可以用於生產環境的Promise
後續我們會接續完善這個Promise的特有方法，比如：finally, all, race, resolve, reject等
後續再介紹用Promise實現的自動執行器等

附錄參考

Promises/A+
Promises/A+ 中文
 Promise 物件 - ECMAScript 6 入門阮一峰

MAC下嘗試PHP7 alpha版本的安裝
2015-06-14
MacPHP
Windows環境下嘗試安裝並配置PHP PEAR
2015-09-23
WindowsPHP
嘗試手寫promise
2019-07-17
Promise
zan正式開源，非同步+非阻塞的PHP框架
2017-06-02
非同步PHP框架
PHP版的jQuery
2014-11-19
PHPjQuery
PHP下的cURL庫
2014-03-29
PHP
初試php中的curl
2011-01-22
PHP
並非PHP Frameworks而是WordPress讓PHP更加流行！
2013-08-02
PHPFramework
SSD 下的 MySQL IO 優化嘗試
2015-09-01
MySql優化
非同步 PHP:為什麼? ( Asynchronous PHP: Why?)
2019-11-14
非同步PHP
PHP 並非好的入門程式語言
2019-08-16
PHP
一直讓 PHP 程式設計師懵逼的同步阻塞非同步非阻塞，終於搞明白了
2024-08-05
PHP程式設計師非同步
多主一從mysql replication同步表的大膽嘗試.
2010-03-18
MySql
測試PHP
2008-09-11
PHP
PHP實現非同步
2021-01-16
PHP非同步
2017 非標準 PHP 框架效能測試比較
2017-10-27
PHP框架
適用PHP5.2的php.ini中文註釋版
2012-01-10
PHP
PHP多程式非阻塞模式下結合原生Mysql與單程式效率測試對比
2018-07-03
PHP模式MySql
php常用的四種排序演算法
2017-09-30
PHP排序演算法
自學PHP筆記(四) PHP變數和常量
2021-04-12
PHP筆記變數
自學PHP筆記(四) PHP常量和變數
2021-04-10
PHP筆記變數
php Guzzle，非同步請求的重要性
2021-09-09
PHP非同步
AutoCRUD - PHP 下的透明持久層
2008-01-03
PHP
php非同步程式設計
2019-02-16
PHP非同步程式設計
PHP面試試題
2016-12-01
PHP面試
在 PHP 中使用 Promise + co/yield 協程
2019-02-16
PHPPromise
PHP實踐之路（四）PHP中常量和變數
2013-06-28
PHP變數
MVC、MVP、BloC、Redux四種架構在Flutter上的嘗試
2019-07-15
MVCMVPBloCRedux架構Flutter
高併發下的php.int及PHP-fpm設定
2021-02-09
PHP
【OSX】OSX下采用MAMP的PHP替換系統自帶PHP
2016-07-06
PHP
PHP 變數的四大作用域
2020-01-14
PHP變數
PHP的SPL擴充套件庫（四）函式
2021-10-27
PHP套件函式
PHP-四種解析XML檔案的方法
2014-11-10
PHPXML
AVA測試框架內部的Promise非同步流程控制模型
2018-03-23
框架Promise非同步模型
async-helper，一個 PHP 的非同步程式助手
2019-02-16
PHP非同步
php中用來可以做非同步呼叫的程式碼
2021-09-09
PHP非同步
PHP單元測試框架PHPUnit的使用
2019-02-16
PHP框架
3 個主流 PHP 框架的效能測試
2016-05-11
PHP框架

PHP下的非同步嘗試四：PHP版的Promise

PHP下的非同步嘗試系列

Promise 實現

程式碼結構

嘗試一 (Promise基礎)

結果：

結論或問題：

嘗試二 (增加鏈式then)

結果：

結論或問題：

嘗試三（真正的鏈式then）

結果：

結論或問題：

嘗試四（then返回pormise物件, 並傳遞上一次的結果給下一個Promise物件）

結果：

結論或問題：

嘗試五（錯誤捕獲）

結果：

結論或問題：

附錄參考

相關文章