Yii2中join、joinwith多表關聯查詢的使用方法

本文主要介紹了Yii2中多表關聯查詢（join、joinwith)的使用方法，需要的朋友可以參考下。希望對大家有幫助。

表格結構

現在有客戶表、訂單表、書籍表、作者表，

客戶表Customer ( id customer_name）
訂單表Order (id order_name customer_id book_id)
圖書表(id book_name author_id)
作者表(id author_name)

模型定義模型定義

##Cy_

##以下是這4個模型的定義，只寫出其中的關聯

Customer

# #

class Customer extends \yii\db\ActiveRecord
{
// 这是获取客户的订单，由上面我们知道这个是一对多的关联，一个客户有多个订单
public function getOrders()
{
// 第一个参数为要关联的子表模型类名，
// 第二个参数指定 通过子表的customer_id，关联主表的id字段
return $this->hasMany(Order::className(), ['customer_id' => 'id']);
}
}

Order

class Order extends \yii\db\ActiveRecord
{
// 获取订单所属用户
public function getCustomer()
{
//同样第一个参数指定关联的子表模型类名
//
return $this->hasOne(Customer::className(), ['id' => 'customer_id']);
}
// 获取订单中所有图书
public function getBooks()
{
//同样第一个参数指定关联的子表模型类名
//
return $this->hasMany(Book::className(), ['id' => 'book_id']);
}
}

Book

class Book extends \yii\db\ActiveRecord
{
// 获取图书的作者
public function getAuthor()
{
//同样第一个参数指定关联的子表模型类名
return $this->hasOne(Author::className(), ['id' => 'author_id']);
}
}

Author

class Autor extends \yii\db\ActiveRecord
{
}

#hasMany、hasOne使用

Yii2中的表之間的關聯有2種，它們用來指定兩個模型之間的關聯。

一對多：hasMany

一對一：hasOne

傳回結果：這兩個方法的回傳結果都為yii\db\ ActiveQuery物件第一個參數：所關聯的模型的類別名稱。

第二個參數：是一個數組，其中鍵為所關聯的模型中的屬性，值為目前模型中的屬性。

關聯的使用

現在我們取得一個客戶的所有的訂單資訊

// 获取一个客户信息
$customer = Customer::findOne(1);
$orders = $customer->orders; // 通过在Customer中定义的关联方法（getOrders()）来获取这个客户的所有的订单。

上面的兩行程式碼會產生如下sql語句

SELECT * FROM customer WHERE id=1;
SELECT * FROM order WHERE customer_id=1;

關聯結果快取

##如果客戶的訂單改變了，我們再重新呼叫

$orders = $customer->orders;

再次得到訂單的時候你會發現沒有變化。原因是只會在第一次執行$customer->orders的時候才會去資料庫裡面查詢，然後會把結果快取起來，以後查詢的時候都不會再執行sql。

那麼如果我想再執行sql如何做呢？可以執行

unset($customer->orders);
$customer->orders;

然後就可以從資料庫裡面取資料了。

定義多個關聯

同樣，我們也可以在Customer裡面定義多個關聯。 如回傳總數大於100的訂單。

class Customer extends \yii\db\ActiveRecord
{
public function getBigOrders($threshold = 100)
{
return $this->hasMany(Order::className(), ['customer_id' => 'id'])
->where('subtotal > :threshold', [':threshold' => $threshold])
->orderBy('id');
}
}

已關聯的兩種存取方式

如上面的，如果使用

$customer->bigOrders

將會得到大於100的所有的訂單。如果要回傳大於200的訂單可以這樣寫

$orders = $customer->getBigOrders(200)->all();

從上面可以看出存取一個關聯的時候有兩種方法

如果以函數的方式調用，會傳回一個ActiveQuery 物件（$customer->getOrders()->all()）

如果以屬性的方式調用，會直接傳回模型的結果( $customer->orders)

with的使用看如下程式碼，是取一個客戶的訂單

// 执行sql语句: SELECT * FROM customer WHERE id=1
$customer = Customer::findOne(1);
//执行sql：SELECT * FROM order WHERE customer_id=1
$orders1 = $customer->orders;
//这个不会执行sql，直接使用上面的缓存结果
$orders2 = $customer->orders;

如果現在我們要取出100個用戶，然後訪問每個用戶的訂單，從上面的了解我們可能會寫出如下代碼

// 执行sql语句: SELECT * FROM customer LIMIT 100
$customers = Customer::find()->limit(100)->all();
foreach ($customers as $customer) {
// 执行sql: SELECT * FROM order WHERE customer_id=...
$orders = $customer->orders;
// 处理订单。。。
}

然而，如果真要這樣寫的話，會在foreach的每個循環裡面都執行一次sql去資料庫裡面查詢資料。因為每個$customer物件都是不一樣的。

為了解決上面的問題 可以使用 yii\db\ActiveQuery::with()。

其中width的參數為關係的名稱，也就在model裡面定義的getOrders,getCustomer中的orders和customer

// 先执行sql: SELECT * FROM customer LIMIT 100;
// SELECT * FROM orders WHERE customer_id IN (1,2,...)
$customers = Customer::find()->limit(100)
->with('orders')->all();
foreach ($customers as $customer) {
// 在这个循环的时候就不会再执行sql了
$orders = $customer->orders;
// ...handle $orders...
}

如果使用了select來指定傳回的列，請務必確保傳回的列裡麵包含所關聯的模型的關聯字段，否則將不會傳回關聯的表的Model

$orders = Order::find()->select(['id', 'amount'])->with('customer')->all();
// $orders[0]->customer 的结果将会是null
// 因为上面的select中没有返回所关联的模型（customer）中的指定的关联字段。
// 如果加上customer_id，$orders[0]->customer就可以返回正确的结果
$orders = Order::find()->select(['id', 'amount', 'customer_id'])->with('customer')->all();

給with加上過濾條件

查詢一個客戶大於100的訂單

//首先执行sql： SELECT * FROM customer WHERE id=1
$customer = Customer::findOne(1);
// 再执行查询订单的sql语句：SELECT * FROM order WHERE customer_id=1 AND subtotal>100
$orders = $customer->getOrders()->where('subtotal>100')->all();

查詢100個客戶的，每個客戶的總合大於100的訂單

// 下面的代码会执行sql语句: 
// SELECT * FROM customer LIMIT 100
// SELECT * FROM order WHERE customer_id IN (1,2,...) AND subtotal>100
$customers = Customer::find()->limit(100)->with([
'orders' => function($query) {
$query->andWhere('subtotal>100');
},
])->all();

在這裡width的參數為數組，鍵為關聯的名稱，值為回呼函數。 也就是說對orders這個關聯回傳的ActiveQuery，再執行一次$query->andWhere('subtotal>100');

使用joinWith進行表關聯

我們都知道可以用join on來寫多個表之間的關聯。先看看yii2中joinWit的宣告

joinWith( $with, $eagerLoading = true, $joinType = 'LEFT JOIN' )

$with 資料類型為字串或數組，如果為字串，則為模型中定義的關聯的名稱（可以為子關聯）。 ######如果為數組，鍵為model中以getXXX格式定義的關聯，值為對這個關聯的進一步的回呼操作。 #########$eagerLoading 是否載入在$with中關聯的模型的資料。 ###

$joinType 联接类型，可用值为：LEFT JOIN、INNER JOIN，默认值为LEFT JOIN

// 订单表和客户表以Left join的方式关联。
// 查找所有订单,并以客户 ID 和订单 ID 排序
$orders = Order::find()->joinWith('customer')->orderBy('customer.id, order.id')->all();
// 订单表和客户表以Inner join的方式关联
// 查找所有的订单和书
$orders = Order::find()->innerJoinWith('books')->all();
// 使用inner join 连接order中的 books关联和customer关联。
// 并对custmer关联再次进行回调过滤：找出24小时内注册客户包含书籍的订单
$orders = Order::find()->innerJoinWith([
'books',
'customer' => function ($query) {
$query->where('customer.created_at > ' . (time() - 24 * 3600));
}
])->all();
// 使用left join连接 books关联，books关联再用left join 连接 author关联
$orders = Order::find()->joinWith('books.author')->all();

在实现上，Yii 先执行满足JOIN查询条件的SQL语句，把结果填充到主模型中， 然后再为每个关联执行一条查询语句， 并填充相应的关联模型。

// Order和books关联 inner join ,但不获取books关联对应的数据
$orders = Order::find()->innerJoinWith('books', false)->all();

On条件

在定义关联的时候还可以指定on条件

class User extends ActiveRecord
{
public function getBooks()
{
return $this->hasMany(Item::className(), ['owner_id' => 'id'])->onCondition(['category_id' => 1]);
}
}

在joinWith中使用

//先查询主模型（User）的数据， SELECT user.* FROM user LEFT JOIN item ON item.owner_id=user.id AND category_id=1
// 然后再根据关联条件查询相关模型数据SELECT * FROM item WHERE owner_id IN (...) AND category_id=1
// 这两个在查询的过程中都使用了 on条件。
$users = User::find()->joinWith('books')->all();

如果没有使用join操作，即使用的是with 或者 直接以属性来访问关联。这个时候on条件会作为where 条件。

// SELECT * FROM user WHERE id=10
$user = User::findOne(10);

总结

首先需要在模型中定义好关联（如getOrders中的Orders为一个关联）

然后在with或者joinWith中使用在模型中定义的关联。

其中在使用关联的时候还可以指定回调方法。

再有就是可以给关联、with、joinWith指定where或者on条件。

相关推荐：

Yii2实现QQ互联登录

Yii2使用缓存的简单解析

Yii2实现rbac权限控制

以上是Yii2中join、joinwith多表關聯查詢的使用方法的詳細內容。更多資訊請關注PHP中文網其他相關文章！