Yii2中多表關聯查詢（hasOne、hasMany、join、joinwith)

表結構

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

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

怎麼來確定是一對多 還是一對一呢？這個很簡單，比如下面的Customer，一個Customer有多個Order，所以就是一對多；又比如Book，一個Book只有一個作者（這裏的情況就是一本書只有一個作者），所以就是一對一。

模型定義

下面是這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使用

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

• 一對多：hasMany
• 一對一：hasOne

返回結果：這兩個方法的返回結果都爲yii\db\ActiveQuery對象
第一個參數：所關聯的模型的類名稱。
第二個參數：是一個數組，其中鍵爲所關聯的模型中的屬性，值爲當前模型中的屬性。

關聯的使用

在我們獲取一個客戶的所有的訂單信

// 獲取一個客戶信息
$customer = Customer::findOne(1);
 // 通過在Customer中定義的關聯方法（getOrders()）來獲取這個客戶的所有的訂單。
$orders = $customer->orders;

上面的兩行代碼會生成如下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');
    }
}

關聯的兩種訪問方式

• 屬性調用 ActiveRecord::屬相
• 函數調用 ActiveRecord::get方法()

函數的方式調用，會返回一個 ActiveQuery 對象（$customer->getOrders()->all()）

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

如上面的，如果使用

$customer->bigOrders

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

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

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;
// 再執行sql: SELECT * FROM orders WHERE customer_id IN (1,2,...)

$customers = Customer::find()->limit(100)
->with('orders')->all();

foreach ($customers as $customer) {
    // 在這個循環的時候就不會再執行sql了 
    //因爲最開始已經 customer_id IN (1,2,...) 全部一次性獲取了， 而不是單獨 customer_id = 1 單條獲取
    $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,$with,$ eagerLoading = true, $joinType = ‘LEFT JOIN’ )

我們都知道可以用join on來寫多個表之間的關聯。先看看yii2中joinWit的聲明
joinWith( with,$with,$ eagerLoading = true, $joinType = ‘LEFT JOIN’ )

• $with 數據類型爲字符串或數組，
  如果爲字符串，則爲模型中定義的關聯的名稱（可以爲子關聯）。
  如果爲數組，鍵爲model中以getXXX格式定義的關聯，值爲對這個關聯的進一步的回調操作。
• eagerLoading是否加載在$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條件