重寫yii2的數(shù)據(jù)提供器ArrayDataProvider類

xiaokai 發(fā)布于2019-06-27 13:56 / 1060人閱讀

摘要：再看看另一個(gè)方法，的提供的數(shù)據(jù)統(tǒng)計(jì)總條數(shù)的方法是的，默認(rèn)計(jì)算分頁(yè)總數(shù)是根據(jù)數(shù)組計(jì)算的，而的數(shù)據(jù)就是我們查詢賦值給提供器的。統(tǒng)計(jì)總數(shù)預(yù)處理函數(shù)直接獲取通過(guò)函數(shù)獲取傳遞給數(shù)據(jù)提供器的數(shù)據(jù)總和。

首先看看ArrayDataProvider官方的doc：

ArrayDataProvider implements a data provider based on a data array.
ArrayDataProvider實(shí)現(xiàn)了一個(gè)基于數(shù)據(jù)數(shù)組的數(shù)據(jù)提供器。
The [[allModels]] property contains all data models that may be sorted and/or paginated.
[[allModels]]包含了需要排序和（或）分頁(yè)的所有數(shù)據(jù)模型。
ArrayDataProvider will provide the data after sorting and/or pagination.
ArrayDataProvider提供排序和（或）分頁(yè)后的數(shù)據(jù)。
You may configure the [[sort]] and [[pagination]] properties to
 customize the sorting and pagination behaviors.
 你可以配置[[sort]]和[[pagination]]屬性自定義排序和分頁(yè)行為。
Elements in the [[allModels]] array may be either objects (e.g. model objects) or associative arrays (e.g. query results of DAO).
[[allModels]]數(shù)組中的元素也許是對(duì)象（如，model對(duì)象）也許是關(guān)聯(lián)數(shù)組（如，PDO的查詢結(jié)果）。
Make sure to set the [[key]] property to the name of the field that uniquely identifies a data record or false if you do not have such a field.
 確保設(shè)置的[[key]]屬性是唯一標(biāo)識(shí)一條記錄的字段的名字，如果沒(méi)有這樣的字段，則設(shè)為false。
Compared to [[ActiveDataProvider]], ArrayDataProvider could be less efficient because it needs to have [[allModels]] ready.
 與[[ActiveDataProvider]]比較，ArrayDataProvider可能效率較低，因?yàn)樗枰獪?zhǔn)備[[allModels]]。
ArrayDataProvider may be used in the following way:
ArrayDataProvider可以按照下面的方式使用：
$query = new Query;
$provider = new ArrayDataProvider([
    "allModels" => $query->from("post")->all(),
    "sort" => [
        "attributes" => ["id", "username", "email"],
    ],
    "pagination" => [
        "pageSize" => 10,
    ],
]);
// get the posts in the current page
$posts = $provider->getModels();
Note: if you want to use the sorting feature, you must configure the [[sort]] property
  so that the provider knows which columns can be sorted.
  注意：你給你想使用排序功能，你必須配置[[sort]]屬性。
@author Qiang Xue 
  @since 2.0

從上面的指南可以看出，使用ArrayDataProvider需要準(zhǔn)備好[[allModels]]數(shù)據(jù)，才開始渲染視圖，并實(shí)現(xiàn)分頁(yè)。

ArrayDataProvider是先把數(shù)據(jù)拉渠道內(nèi)存中，然后再根據(jù)已有數(shù)據(jù)進(jìn)行分頁(yè)，這一點(diǎn)感覺(jué)像JQuery的DataTables插件，但是DataTables插件支持異步獲取數(shù)據(jù)，也就是說(shuō)可以根據(jù)配置可以分頁(yè)從數(shù)據(jù)庫(kù)中獲取數(shù)據(jù)，顯然，yii2自帶的ArrayDataProvider明顯不提供此功能。

先看看，yii2的ArrayDataProvider提供預(yù)處理models的方法，該方法處理排序和分頁(yè)：

/**
     * @inheritdoc
     */
    protected function prepareModels()
    {
        if (($models = $this->allModels) === null) {
            return [];
        }

        if (($sort = $this->getSort()) !== false) {
            $models = $this->sortModels($models, $sort);
        }

        if (($pagination = $this->getPagination()) !== false) {
            $pagination->totalCount = $this->getTotalCount();

            if ($pagination->getPageSize() > 0) {
                $models = array_slice($models, $pagination->getOffset(), $pagination->getLimit());
            }
        }

        return $models;
    }

對(duì)于分頁(yè)代碼，如過(guò)設(shè)置了pagination對(duì)象，也就是設(shè)置了分頁(yè)，則統(tǒng)計(jì)數(shù)據(jù)總條數(shù)，然后根據(jù)每頁(yè)的大小分片。

if (($pagination = $this->getPagination()) !== false) {
  $pagination->totalCount = $this->getTotalCount();
  if ($pagination->getPageSize() > 0) {
      $models = array_slice($models, $pagination->getOffset(), $pagination->getLimit());
   }
}

再看看另一個(gè)方法，yii2的ArrayDataProvider提供的數(shù)據(jù)統(tǒng)計(jì)總條數(shù)的方法：

/**
     * @inheritdoc
     */
    protected function prepareTotalCount()
    {
        return count($this->allModels);
    }

是的，ArrayDataProvider默認(rèn)計(jì)算分頁(yè)總數(shù)是根據(jù)allModels數(shù)組計(jì)算的，而allModels的數(shù)據(jù)就是我們查詢賦值給提供器的。

這里面有兩個(gè)很重要的方法必須看看：

    public function getTotalCount()
    {
        if ($this->getPagination() === false) {
            return $this->getCount();
        } elseif ($this->_totalCount === null) {
            $this->_totalCount = $this->prepareTotalCount();
        }

        return $this->_totalCount;
    }

該方法就是統(tǒng)計(jì)數(shù)據(jù)總數(shù)的，相應(yīng)的應(yīng)該有一個(gè)設(shè)置數(shù)據(jù)總數(shù)的：

    public function setTotalCount($value)
    {
        $this->_totalCount = $value;
    }

而在ArrayDataProvider及其分類中，并沒(méi)有一個(gè)public的totalCount屬性，因此yii在處理的時(shí)候，將totalCount通過(guò)魔法函數(shù)進(jìn)行設(shè)置，因?yàn)閥ii2中所有的類都是Object的子類，關(guān)于魔法函數(shù)，這一塊內(nèi)容參考深入理解yii2.0，在此感謝作者帶我們走的這么深。

因此，不管你分頁(yè)不分頁(yè)，ArrayDataProvider并不是服務(wù)器端分頁(yè)的，而是將已有數(shù)據(jù)分頁(yè)處理的。

這種情況，如果數(shù)據(jù)量很大的時(shí)候，一點(diǎn)也不好，線上服務(wù)動(dòng)輒上百萬(wàn)的數(shù)據(jù)，一下子拿出來(lái)分頁(yè)，服務(wù)器吃不消，你也耗不起這個(gè)等待時(shí)間。

下面，我們需要重寫這兩個(gè)方法：

models預(yù)處理方法

取消對(duì)已有數(shù)據(jù)的分片處理，統(tǒng)計(jì)數(shù)據(jù)總數(shù)根據(jù)我們的方式統(tǒng)計(jì)，比如數(shù)據(jù)庫(kù)中的總條數(shù)。

     /*
     *  @inheritdoc
     */
    protected function prepareModels()
    {
        if (($models = $this->allModels) === null) {
            return [];
        }

        if (($sort = $this->getSort()) !== false) {
            $models = $this->sortModels($models, $sort);
        }

        if (($pagination = $this->getPagination()) !== false) {
            $pagination->totalCount = $this->getTotalCount();
        }

        return $models;
    }

統(tǒng)計(jì)總數(shù)預(yù)處理函數(shù)

直接獲取通過(guò)getTotalCount()函數(shù)獲取傳遞給數(shù)據(jù)提供器的數(shù)據(jù)總和。

     /*
     *       @inheritdoc
     */
    protected function prepareTotalCount()
    {
        return $this->getTotalCount();
    }

下面給出重寫后的完整ArrayDataProvider：

allModels) === null) {
            return [];
        }

        if (($sort = $this->getSort()) !== false) {
            $models = $this->sortModels($models, $sort);
        }

        if (($pagination = $this->getPagination()) !== false) {
            $pagination->totalCount = $this->getTotalCount();
        }

        return $models;
    }

    /*
     *       @inheritdoc
     */
    protected function prepareTotalCount()
    {
        return $this->getTotalCount();
    }

}

最后，來(lái)一個(gè)實(shí)際使用案例：

// TODO 業(yè)務(wù)邏輯
$data = ... // 數(shù)據(jù)數(shù)組或?qū)ο?$count = ... // 數(shù)據(jù)總條數(shù)，并不是count($data)的值，是數(shù)據(jù)庫(kù)中符合條件的所有數(shù)據(jù)總數(shù)
$dataProvider = new ackendextensionsArrayDataProvider([
"allModels" => $data,
"totalCount" => isset($count) ? $count : 0,
"key" => "ltime",
"sort" => [
    "attributes" => [
        "gmv",
        "ltime",
        "uv"
    ],
    "defaultOrder" => [
        "gmv" => SORT_DESC,
        "ltime" => SORT_DESC,
        "uv" => SORT_DESC,
    ],
],
"pagination" => [
    "pageSize" => 15,
],
]);

// 傳遞到test視圖渲染
return $this->render("test", ["model" => $model, "dataProvider" => $dataProvider]);

在視圖層接收該數(shù)據(jù)提供器，傳遞給一個(gè)數(shù)據(jù)渲染插件，比如GridView:

echo GridView::widget([
    "dataProvider" => $dataProvider,
    "columns" => [
        ["class" => "yiigridSerialColumn"],
        [
            "class" => "yiigridDataColumn",
            "value" => function ($data) {
                if (isset($data["ltime"]) && !empty($data["ltime"])) {
                    return date("Y-m-d", $data["ltime"]);
                }
            },
            "label" => "日期",
            "format" => "raw",
    ],
    "moneyPerUvOrder:raw:訂單UV單價(jià)",
    "moneyPerUvPurchase:raw:銷售UV單價(jià)"
    ]
]);

到此結(jié)束，如果幫到你，請(qǐng)點(diǎn)擊收藏！