6.3 查询构建类ActiveQuery-Yii2框架从入门到精通(上)

当前位置:　首页>> 技术小册>> Yii2框架从入门到精通(上)

### 6.3 查询构建类 ActiveQuery

在Yii2框架中，`ActiveQuery` 类是处理数据库查询的核心工具之一，它继承自 `yii\db\Query` 并增加了对 Active Record 模型的特定支持。通过使用 `ActiveQuery`，开发者可以构建强大而灵活的数据库查询，同时保持代码的简洁性和可维护性。本章将深入探讨 `ActiveQuery` 的使用，包括其基本用法、高级查询技巧、以及如何通过它实现关系查询和条件查询。

#### 6.3.1 ActiveQuery 基础

`ActiveQuery` 通常是通过调用 Active Record 模型的 `find()` 方法创建的。这个方法返回一个 `ActiveQuery` 实例，该实例已经预配置为查询对应模型的表。

```php
// 假设有一个 User 模型
$query = User::find();
```

此时，`$query` 是一个未执行的查询对象，可以通过链式调用添加各种条件和方法来进一步定义查询。

#### 6.3.2 查询条件

`ActiveQuery` 提供了多种方法来添加查询条件，最常用的包括 `where()`, `andWhere()`, `orWhere()`, `filterWhere()` 等。

- **where()**：用于添加“AND”条件。
  
  ```php
  $query->where(['status' => 1]);
  ```

- **andWhere()** 和 **orWhere()**：在现有条件的基础上添加额外的“AND”或“OR”条件。
  
  ```php
  $query->where(['status' => 1])
        ->andWhere(['>', 'age', 18]);
  
  $query->where(['status' => 1])
        ->orWhere(['role' => 'admin']);
  ```

- **filterWhere()**：与 `where()` 类似，但它会自动处理数组值中的空值，使其更适用于表单数据的过滤。

```php
  $query->filterWhere(['name' => $name, 'email' => $email]);
  ```

#### 6.3.3 排序与限制

查询结果可以通过 `orderBy()` 进行排序，使用 `limit()` 和 `offset()` 来限制结果集的大小和偏移量。

- **orderBy()**：根据一个或多个字段对结果集进行排序。
  
  ```php
  $query->orderBy(['created_at' => SORT_DESC]);
  ```

- **limit()** 和 **offset()**：用于分页或限制查询结果的数量。
  
  ```php
  $query->limit(10)->offset(20); // 跳过前20条，取接下来的10条
  ```

#### 6.3.4 高级查询技巧

`ActiveQuery` 支持更复杂的查询操作，如分组、聚合、子查询等。

- **groupBy()**：根据一个或多个字段对结果集进行分组。
  
  ```php
  $query->select('status, COUNT(*) as count')
        ->groupBy('status');
  ```

- **having()**：用于对分组后的结果进行过滤。
  
  ```php
  $query->groupBy('status')
        ->having(['>', 'COUNT(*)', 10]);
  ```

- **join()**：执行SQL JOIN操作，支持INNER JOIN、LEFT JOIN等多种类型。
  
  ```php
  $query->joinWith('profiles', true, 'LEFT JOIN');
  ```

- **select()**：自定义SELECT子句，可以选择部分字段或计算字段。
  
  ```php
  $query->select(['id', 'name', 'CONCAT(first_name, " ", last_name) AS full_name']);
  ```

#### 6.3.5 索引与缓存

为了提高查询效率，Yii2 允许为 `ActiveQuery` 结果集设置索引或启用查询缓存。

- **indexBy()**：根据某个字段的值将结果集索引化。
  
  ```php
  $users = User::find()->indexBy('id')->all();
  ```

- **cache()**：为查询结果启用缓存。
  
  ```php
  $duration = 3600; // 缓存持续时间，单位为秒
  $dependency = new \yii\caching\DbDependency(['sql' => 'SELECT MAX(updated_at) FROM user']);
  $query->cache($duration, $dependency)->all();
  ```

#### 6.3.6 关系查询

Yii2 的 Active Record 支持通过定义关系（如一对一、一对多等）来简化复杂数据结构的查询。使用 `ActiveQuery` 的 `with()` 方法可以预加载这些关系，减少数据库查询次数。

- **定义关系**：在模型中定义关系。
  
  ```php
  class User extends \yii\db\ActiveRecord
  {
      public function getProfiles()
      {
          return $this->hasOne(Profile::className(), ['user_id' => 'id']);
      }
  }
  ```

- **预加载关系**：使用 `with()` 方法预加载关系。
  
  ```php
  $users = User::find()->with('profiles')->all();
  ```

#### 6.3.7 批量查询与动态查询

在某些场景下，你可能需要根据用户输入动态构建查询条件。Yii2 提供了灵活的机制来处理这类需求。

- **动态构建查询**：根据条件数组动态添加查询条件。
  
  ```php
  $conditions = ['status' => 1];
  if (!empty($name)) {
      $conditions['name'] = $name;
  }
  $query = User::find()->where($conditions);
  ```

- **批量查询**：使用 `batch()` 或 `each()` 方法处理大量数据，减少内存消耗。
  
  ```php
  foreach (User::find()->batch(100) as $users) {
      // 处理每批用户
  }
  
  // 或者使用 each() 逐个处理
  User::find()->each(function ($user) {
      // 处理每个用户
  });
  ```

#### 6.3.8 总结

`ActiveQuery` 是 Yii2 框架中用于构建和执行数据库查询的强大工具。它提供了丰富的API来支持各种查询需求，包括条件查询、排序、分组、聚合、关系查询等。通过熟练使用 `ActiveQuery`，开发者可以构建出既高效又易于维护的数据库查询代码。在实际开发中，结合模型的关系定义和查询缓存的使用，可以进一步提升应用性能和用户体验。希望本章内容能帮助你更深入地理解和掌握 Yii2 中的 `ActiveQuery` 使用技巧。

该分类下的相关小册推荐：

PHP8入门与项目实战（5）

Swoole高性能框架-Hyperf

全栈工程师修炼指南

PHP底层原理及源码分析

PHP程序员面试算法宝典

Laravel(10.x)从入门到精通(十五)

Laravel(10.x)从入门到精通(十六)

HTTP权威指南

PHP安全之道

PHP面试指南

PHP高并发秒杀入门与实战

Laravel(10.x)从入门到精通(九)