Yii多表關聯

表結構
如今有客戶表、訂單表、圖書表、做者表，

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

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

1. class Customer extends \yii\db\ActiveRecord
2. {
3.     // 這是獲取客戶的訂單，由上面咱們知道這個是一對多的關聯，一個客戶有多個訂單
4.     public function getOrders()
5.     {
6.         // 第一個參數爲要關聯的子表模型類名，
7.         // 第二個參數指定 經過子表的customer_id，關聯主表的id字段
8.         return $this->hasMany(Order::className(), ['customer_id' => 'id']);
9.     }
10. }

複製代碼

Order 

1. class Order extends \yii\db\ActiveRecord
2. {
3.     // 獲取訂單所屬用戶
4.     public function getCustomer()
5.     {
6.         //一樣第一個參數指定關聯的子表模型類名
7.         //
8.         return $this->hasOne(Customer::className(), ['id' => 'customer_id']);
9.     }
10.     // 獲取訂單中全部圖書
11.     public function getBooks()
12.     {
13.         //一樣第一個參數指定關聯的子表模型類名
14.         //
15.         return $this->hasMany(Book::className(), ['id' => 'book_id']);
16.     }
17. }

複製代碼

Book 

1. class Book extends \yii\db\ActiveRecord
2. {
3.     // 獲取圖書的做者
4.     public function getAuthor()
5.     {
6.         //一樣第一個參數指定關聯的子表模型類名
7.         return $this->hasOne(Author::className(), ['id' => 'author_id']);
8.     }
9. }

複製代碼

Author 

1. class Autor extends \yii\db\ActiveRecord
2. {
3.   
4. }

複製代碼

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

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

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

關聯的使用
如今咱們獲取一個客戶的全部的訂單信息

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

複製代碼

上面的兩行代碼會生成以下sql語句

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

複製代碼

關聯結果緩存
若是客戶的訂單改變了，咱們再從新調用

1. $orders = $customer->orders;

複製代碼

再次獲得訂單的時候你會發現沒有變化。 緣由是隻會在第一次執行$customer->orders的時候纔會去數據庫裏面查詢，而後會把結果緩存起來，之後查詢的時候都不會再執行sql。
那麼若是我想再次執行sql如何作呢？能夠執行

1. unset($customer->orders);
2. $customer->orders;

複製代碼

而後就能夠從數據庫裏面取數據了。
定義多個關聯
一樣，咱們還能夠在Customer裏面定義多個關聯。
如返回總數大於100的訂單。

1. class Customer extends \yii\db\ActiveRecord
2. {
3.     public function getBigOrders($threshold = 100)
4.     {
5.         return $this->hasMany(Order::className(), ['customer_id' => 'id'])
6.             ->where('subtotal > :threshold', [':threshold' => $threshold])
7.             ->orderBy('id');
8.     }
9. }

複製代碼

關聯的兩種訪問方式
如上面的，若是使用

1. $customer->bigOrders

複製代碼

將會獲得大於100的全部的訂單。若是要返回大於200的訂單能夠這樣寫

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

複製代碼

從上面能夠看出訪問一個關聯的時候有兩種方法

• 若是以函數的方式調用，會返回一個 ActiveQuery 對象（$customer->getOrders()->all()）
• 若是以屬性的方式調用，會直接返回模型的結果($customer->orders)

with的使用 看以下代碼，是取一個客戶的訂單

1. // 執行sql語句: SELECT * FROM customer WHERE id=1
2. $customer = Customer::findOne(1);
3. //執行sql：SELECT * FROM order WHERE customer_id=1
4. $orders1 = $customer->orders;
5. //這個不會執行sql，直接使用上面的緩存結果
6. $orders2 = $customer->orders;

複製代碼

若是如今咱們要取出100個用戶，而後訪問每一個用戶的訂單，從上面的瞭解咱們可能會寫出以下代碼

1. // 執行sql語句: SELECT * FROM customer LIMIT 100
2. $customers = Customer::find()->limit(100)->all();
3. foreach ($customers as $customer) {
4.     // 執行sql: SELECT * FROM order WHERE customer_id=...
5.     $orders = $customer->orders;
6.     // 處理訂單。。。
7. }

複製代碼

然而，若是真要這樣寫的話，會在foreach的每一個循環裏面都執行一次sql去數據庫裏面查詢數據。由於每一個$customer對象都是不同的。
爲了解決上面的問題 可使用  yii\db\ActiveQuery::with() 。
其中width的參數爲 關係的名稱 ，也就在model裏面定義的getOrders,getCustomer中的orders和customer

1. // 先執行sql: SELECT * FROM customer LIMIT 100;
2. //               SELECT * FROM orders WHERE customer_id IN (1,2,...)
3. $customers = Customer::find()->limit(100)
4.     ->with('orders')->all();
5. foreach ($customers as $customer) {
6.     // 在這個循環的時候就不會再執行sql了
7.     $orders = $customer->orders;
8.     // ...handle $orders...
9. }

複製代碼

若是使用了select來指定返回的列，必定要確保返回的列裏面包含 所關聯的模型的關聯字段 ，不然將不會返回關聯的表的Model

1. $orders = Order::find()->select(['id', 'amount'])->with('customer')->all();
2. // $orders[0]->customer 的結果將會是null
3. // 由於上面的select中沒有返回所關聯的模型（customer）中的指定的關聯字段。
4. // 若是加上customer_id，$orders[0]->customer就能夠返回正確的結果
5. $orders = Order::find()->select(['id', 'amount', 'customer_id'])->with('customer')->all();

複製代碼

給with加過濾條件
查詢一個客戶大於100的訂單

1. //首先執行sql： SELECT * FROM customer WHERE id=1
2. $customer = Customer::findOne(1);
3. // 再執行查詢訂單的sql語句：SELECT * FROM order WHERE customer_id=1 AND subtotal>100
4. $orders = $customer->getOrders()->where('subtotal>100')->all();

複製代碼

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

1. // 下面的代碼會執行sql語句: 
2. // SELECT * FROM customer LIMIT 100
3. // SELECT * FROM order WHERE customer_id IN (1,2,...) AND subtotal>100
4. $customers = Customer::find()->limit(100)->with([
5.     'orders' => function($query) {
6.         $query->andWhere('subtotal>100');
7.     },
8. ])->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

1. // 訂單表和客戶表以Left join的方式關聯。
2. // 查找全部訂單,並以客戶 ID 和訂單 ID 排序
3. $orders = Order::find()->joinWith('customer')->orderBy('customer.id, order.id')->all();
4. // 訂單表和客戶表以Inner join的方式關聯
5. // 查找全部的訂單和書
6. $orders = Order::find()->innerJoinWith('books')->all();

複製代碼

1. // 使用inner join 鏈接order中的 books關聯和customer關聯。
2. // 並對custmer關聯再次進行回調過濾：找出24小時內註冊客戶包含書籍的訂單
3. $orders = Order::find()->innerJoinWith([
4.     'books',
5.     'customer' => function ($query) {
6.         $query->where('customer.created_at > ' . (time() - 24 * 3600));
7.     }
8. ])->all();
9. // 使用left join鏈接 books關聯，books關聯再用left join 鏈接 author關聯
10. $orders = Order::find()->joinWith('books.author')->all();

複製代碼

在實現上，Yii 先執行知足JOIN查詢條件的SQL語句，把結果填充到主模型中， 而後再爲每一個關聯執行一條查詢語句， 並填充相應的關聯模型。

1. // Order和books關聯 inner join ,但不獲取books關聯對應的數據
2. $orders = Order::find()->innerJoinWith('books', false)->all();

複製代碼

On條件
在定義關聯的時候還能夠指定on條件

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

複製代碼

在joinWith中使用

1. //先查詢主模型（User）的數據， SELECT user.* FROM user LEFT JOIN item ON item.owner_id=user.id AND category_id=1
2. // 而後再根據關聯條件查詢相關模型數據SELECT * FROM item WHERE owner_id IN (...) AND category_id=1
3. // 這兩個在查詢的過程當中都使用了 on條件。
4. $users = User::find()->joinWith('books')->all();

複製代碼

若是沒有使用join操做，即便用的是with 或者 直接以屬性來訪問關聯。這個時候on條件會做爲where 條件。

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

複製代碼

總結

• 首先須要在模型中定義好 關聯 （如getOrders中的 Orders 爲一個關聯）
• 而後在 with 或者 joinWith 中使用在模型中定義的關聯。
• 其中在使用關聯的時候還能夠指定回調方法。
• 再有就是能夠給 關聯、with、joinWith 指定where或者on條件