Yii2 で join と joinwith マルチテーブル関連クエリを使用する方法

この記事では主に Yii2 でのマルチテーブル関連付けクエリ (join、joinwith) の使い方を紹介します。必要な方は参考にしてください。お役に立てれば幸いです。

テーブル構造

現在、customer テーブル、order テーブル、book テーブル、author テーブルがあります。

Customer テーブル Customer (id customer_name)
Order テーブル Order (id order_name customer_id book_id)
Book テーブル (id book_name) author_id )
著者テーブル (id author_name)

モデル定義

以下はこれら 4 つのモデルの定義であり、それらの間の関係のみが書かれています

顧客

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

注文

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、Yii2のテーブル間には2種類の関連付けが使用されますモデル間の 2 つの関連付けを指定します。 一対多: hasMany

一対一: hasOne

戻り結果: 両方のメソッドの戻り結果は yiidbActiveQuery オブジェクトです

最初のパラメーター: 関連付けられたモデルのクラス名。

2 番目のパラメーター: は配列であり、キーは関連付けられたモデルの属性、値は現在のモデルの属性です。

関連付けの使用法

これで、顧客のすべての注文情報を取得できます

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

上記の2行のコードは、次の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');
}
}

に関連付けられた 2 つのアクセス方法は、上に示したとおりです。

$customer->bigOrders

を使用すると、100 を超えるすべての注文が取得されます。 200 を超える注文を返したい場合は、次のように記述できます

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

上記からわかるように、関連付けにアクセスするには 2 つの方法があります

関数として呼び出された場合、ActiveQuery オブジェクトは返される ($customer-> ;getOrders()->all())

属性として呼び出された場合、モデルの結果 ($customer->orders) が直接返されます

については、次のコードは、顧客の注文を取得するためのものです

// 执行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 オブジェクトはそれぞれ異なるためです。

上記の問題を解決するには、yiidbActiveQuery::with() を使用できます。

幅パラメータはリレーションシップの名前です。つまり、getCustomer のモデル、注文、顧客で定義された getOrders です

// 先执行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 を使用して返される列を指定する場合は、返される列が関連付けられたモデルの関連付けられたフィールドを含みます。それ以外の場合、関連付けられたテーブルのモデルは返されません。各顧客の注文の合計が 100 を超えています

$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();

ここで、width パラメーターは配列です。キーは関連付けられた名前、値はコールバック関数です。

つまり、注文の関連付けによって返された ActiveQuery に対して、$query->andWhere('subtotal>100'); を実行します

テーブルの関連付けには joinWith を使用します

複数のテーブル間の関連付けを書き込むには、join on を使用します。まず、yii2

//首先执行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();

$with の joinWit の宣言を見てください。データ型は文字列または配列です。文字列の場合は、モデルで定義された関連付けの名前です (サブクラスの場合もあります)。協会）。

配列の場合、キーはモデル内の 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 中国語 Web サイトの他の関連記事を参照してください。