Yii 2 ArrayDataProvider的一些心得

Posted 2020-10-25

概述

在Yii 2中，页面上用表格显示数据时，一般是用数据提供器（Data Provider）来给表格作为数据源，这个思路就是不管你数据来源是什么，但是最终提供给页面表格显示的时候，其格式和接口都是一致的，这样就有效的实现了前后台的解耦。

在实际开发中，最常用的是ActiveDataProvider和SqlDataProvider，一个是使用ORM的方式从数据库获取数据，另一种是直接使用SQL语句获取数据，各有各的适用场合，使用起来也非常方便。

在Yii 2中，还提供了ArrayDataProvider，顾名思义，就是用数组作为数据源，这个用的比较少，因此一开始的时候还是有点生疏。

基本思路

简单跟踪一下代码就可以知道，前端表格在显示数据的时候，其核心是要求数据以关联数组的数组形式提供出来，所以使用ArrayDataProvider的时候，也是以这种形式提供数据就好了，基本的数组格式类似如下：

$data = [
  [
      ‘name‘ => ‘zhangfei‘,
        ‘age‘ => 20,
    ],
  [
      ‘name‘ => ‘guanyu‘,
        ‘age‘ => 20,
    ],
]

其实这个结构，跟使用Model查询得到的数据asArray()出来的结果是一样的。

实现流程

定义Model

首先，要按照显示的数据内容，定义一个Model，其实不定义Model也可以，只要按照显示的要求组织好关联数组就可以了，但是定义Model，可以方便未来实现查询、过滤。
Model的定义大致如下：

class ArrStudentModel extends Model
{
    public $name;
    public $age;

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return [
            [[‘name‘], ‘string‘],
            [[‘age‘], ‘integer‘]
        ];
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels()
    {
        return [
            ‘name‘ => ‘姓名‘,
            ‘age‘ => ‘年龄‘,
        ];
    }
}

看这个Model的结构是不是很眼熟，没错，跟使用Yii 2的工具自动生成的表Model是一样一样的，当然，懒一点，不继承实现rules()和attributeLabels()也是没问题的。不过，rules()可以为以后自动查询提供默认的规则，而attributeLabels()可以为表格提供列标题的文字，所以搞一个Model比较合适。

查询

查询的做法也很简单，跟ActiveRecord同样处理，在Model中提供查询的接口即可。