adminui / laravel-eloquent-joins
此包引入了 Eloquent 模型和关系的连接魔法。
Requires
- illuminate/database: ^8.0|^9.0|^10.0|^11.0
Requires (Dev)
README
Laravel Eloquent Joins
此包最初作为从 https://github.com/fico7489/laravel-eloquent-join 的维护分支引入,该分支自 2020 年 Laravel 8 以来不再维护。
此包引入了 Eloquent 模型和关系的连接魔法。
简介
Eloquent 是一个强大的 ORM,但其连接功能非常有限。
第一个 Eloquent 问题(排序)
使用 laravel,您无法在不手动连接相关表的情况下对关系字段进行排序,这非常尴尬。让我给你几个原因。如果你有一个包含 帖子 和相关 分类 的表,你的代码可能看起来像这样
$posts = Post::select('posts.*')
->join('categories', 'categories.id', '=', 'posts.category_id')
->groupBy('posts.id')
->where('categories.deleted_at', '=', null)
->orderBy('categories.name');
if(request()->get('date')){
$posts->where('posts.date', $date)
}
$posts = $posts->get();
1. 第一个问题是你需要担心选择。
->select('posts.*')
原因:没有从分类中 选择 id,它会被选择并水化到 Post 模型中。
2. 第二个问题是您需要担心 groupBy。
->groupBy('posts.id');
原因:如果关系是 HasOne,并且帖子有多个分类,查询将返回更多行。
3. 第三个问题是您需要将所有其他 where 子句从
->where('date', $date)
变为
->where('posts.date', $date)
原因:帖子 和 分类都可以有 "日期" 属性,如果没有选择具有表 "模糊列" 错误的属性,则会抛出错误。
4. 第四个问题是您正在使用表名(不是模型),这也不好也不方便。
->where('posts.date', $date)
5. 第五个问题是您需要担心连接表的软删除。如果 分类 使用了 SoftDeletes 特性,您必须添加
->where('categories.deleted_at', '=', null)
此包将为您解决所有上述问题。与 排序 不同,您可以在不连接相关表的情况下对关系字段进行 筛选,但此包将为您提供这样做更简单的能力。
第二个 Eloquent 问题(子查询)
使用 laravel,您可以对关系属性执行 where,但 laravel 会生成子查询,这些查询比连接慢。使用此包,您将以优雅的方式使用连接在关系上执行 where。
要求
该包还针对 SQLite、MySql 和 PostgreSql 进行了测试
安装和设置
1. 使用 composer 安装包
composer require AdminUI/laravel-eloquent-join
此语句将安装适用于您当前 laravel 版本的最高版本包。
2. 在您的基模型或特定模型中使用 AdminUI\Laravel\EloquentJoin\Traits\EloquentJoinTrait 特性。
...
use AdminUI\Laravel\EloquentJoin\Traits\EloquentJoin;
use Illuminate\Database\Eloquent\Model;
abstract class BaseModel extends Model
{
use EloquentJoin;
...
重要
对于 MySql,请确保将 strict 配置设置为 false
config/database.php
'mysql' => [
...
'strict' => false,
...
到此为止,您就可以开始了。
选项
选项可以在模型中设置
class Seller extends BaseModel
{
protected $useTableAlias = false;
protected $appendRelationsCount = false;
protected $leftJoin = false;
protected $aggregateMethod = 'MAX';
或查询上
Order::setUseTableAlias(true)->get();
Order::setAppendRelationsCount(true)->get();
Order::setLeftJoin(true)->get();
Order::setAggregateMethod(true)->get();
useTableAlias
我们应该为连接表使用别名吗(默认 = false)
如果为 true,查询将如下所示
select "sellers".* from "sellers"
left join "locations" as "5b5c093d2e00f"
...
如果为 false,查询将如下所示
select "sellers".*
from "sellers"
left join "locations"
...
别名是随机生成的字符串。
appendRelationsCount
我们应该自动将关系计数字段附加到结果中(默认 = false)
如果为 true,查询将如下所示
select "sellers".*, count(locations.id) AS locations_count
from "sellers"
left join "locations" as "5b5c093d2e00f"
...
每个 关系 都通过下划线连接,并在末尾添加 _count 前缀。例如,对于
->joinRelations('seller.locations')
字段将是 seller_locations_count
leftJoin
我们应该使用 内连接 还是 左连接(默认 = true)
select "sellers".*
from "sellers"
inner join "locations"
...
vs
select "sellers".*
from "sellers"
left join "locations"
...
aggregateMethod
用于排序时应该使用哪种聚合方法(默认 = 'MAX')。
在对连接表执行连接操作时,我们必须在排序字段上应用聚合函数,以便我们可以执行分组子句并防止结果重复。
select "sellers".*, MAX("locations" ."number") AS sort
from "sellers"
left join "locations"
group by "locations" ."id"
order by sort
...
选项包括: SUM、AVG、MAX、MIN、COUNT
用法
当前可用的连接查询关系
- BelongsTo
- HasOne
- HasMany
BelongsTo 和 HasOne 关系上新的 eloquent 构造子句
joinRelations($relations, $leftJoin = null)
- $relations 要连接的关系
- $leftJoin 使用 左连接 或 内连接,默认 左连接
orderByJoin($column, $direction = 'asc', $aggregateMethod = null)
- $column 和 $direction 参数与默认 eloquent orderBy() 中的参数相同
- $aggregateMethod 参数定义要使用哪种聚合方法(SUM、AVG、MAX、MIN、COUNT),默认 MAX
whereJoin($column, $operator, $value, $boolean = 'and')
- 参数与默认 eloquent where() 中的参数相同
orWhereJoin($column, $operator, $value)
- 参数与默认 eloquent orWhere() 中的参数相同
whereInJoin($column, $values, $boolean = 'and', $not = false)
- 参数与默认 eloquent whereIn() 中的参数相同
whereNotInJoin($column, $values, $boolean = 'and')
- 参数与默认 eloquent whereNotIn() 中的参数相同
orWhereInJoin($column, $values)
- 参数与默认 eloquent orWhereIn() 中的参数相同
orWhereNotInJoin($column, $values)
- 参数与默认 eloquent orWhereNotIn() 中的参数相同
可以在 BelongsTo、HasOne 和 HasMany 关系上使用连接子句的允许子句
- 您想用于连接查询的关系只能有这些子句: where、orWhere、withTrashed、onlyTrashed、withoutTrashed。
- 子句 where 和 orWhere 只能使用这些变体 ** ->where($column, $operator, $value) ** ->where([$column => $value])
- 不允许使用闭包。
- 不允许使用其他子句,如 whereHas、orderBy 等。
- 您可以在关系上添加不允许的子句并以正常的 eloquent 方式使用它们,但在这些情况下,您不能使用这些关系进行连接查询。
允许的关系
public function locationPrimary()
{
return $this->hasOne(Location::class)
->where('is_primary', '=', 1)
->orWhere('is_primary', '=', 1)
->withTrashed();
}
不允许的关系
public function locationPrimary()
{
return $this->hasOne(Location::class)
->where('is_primary', '=', 1)
->orWhere('is_primary', '=', 1)
->withTrashed()
->whereHas('state', function($query){return $query;}
->orderBy('name')
->where(function($query){
return $query->where('is_primary', '=', 1);
});
}
不允许第二个关系的原因是,这个包应该将所有这些子句应用于连接子句,而 eloquent 使用子查询将所有这些子句孤立起来,而不是在连接子句上,这样更简单。
您可能会觉得规则和限制太多,但实际情况并非如此。不用担心,如果您创建了不允许的查询,将抛出适当的异常,您将知道发生了什么。
其他
- 如果模型使用 SoftDelete 特性,则将自动应用 where deleted_at != null
- 您可以无限次地组合新子句
- 如果您在同一关系上多次组合子句,包将只连接相关表一次
Seller::whereJoin('city.title', '=', 'test')
->orWhereJoin('city.title', '=', 'test2');
- 您可以在闭包内部调用新子句
Seller::where(function ($query) {
$query
->whereJoin('city.title', '=', 'test')
->orWhereJoin('city.title', '=', 'test2');
});
- 您可以将连接子句(例如,whereJoin())与 eloquent 子句(例如,orderBy())结合使用
Seller::whereJoin('title', '=', 'test')
->whereJoin('city.title', '=', 'test')
->orderByJoin('city.title')
->get();
请参阅实际示例中的操作
数据库模式
模型
class Seller extends BaseModel
{
public function locations()
{
return $this->hasMany(Location::class);
}
public function locationPrimary()
{
return $this->hasOne(Location::class)
->where('is_primary', '=', 1);
}
public function city()
{
return $this->belongsTo(City::class);
}
class Location extends BaseModel
{
public function locationAddressPrimary()
{
return $this->hasOne(LocationAddress::class)
->where('is_primary', '=', 1);
}
class City extends BaseModel
{
public function state()
{
return $this->belongsTo(State::class);
}
}
连接
连接 BelongsTo
Seller::joinRelations('city')
连接 HasOne
Seller::joinRelations('locationPrimary')
连接 HasMany
Seller::joinRelations('locations')
连接(混合左连接)
Seller::joinRelations('city.state')
连接(混合左连接)
Seller::joinRelations('city', true)->joinRelations('city.state', false)
多对多关系
卖家::join(['城市.状态', '位置'])
排序
订单属于
卖家::orderByJoin('城市.标题')
订单一对一
卖家::orderByJoin('主位置.地址')
订单一对多
卖家::orderByJoin('位置.标题')
混合订单
卖家::orderByJoin('城市.状态.标题')
排序(带有聚合函数的特殊情况)
按关系计数排序
卖家::orderByJoin('位置.id', 'asc', 'COUNT')
按关系字段SUM排序
卖家::orderByJoin('位置.is_primary', 'asc', 'SUM')
按关系字段AVG排序
卖家::orderByJoin('位置.is_primary', 'asc', 'AVG')
按关系字段MAX排序
卖家::orderByJoin('位置.is_primary', 'asc', 'MAX')
按关系字段MIN排序
卖家::orderByJoin('位置.is_primary', 'asc', 'MIN')
过滤(where或orWhere)
过滤属于
卖家::whereJoin('城市.标题', '=', '测试')
过滤一对一
卖家::whereJoin('主位置.地址', '=', '测试')
过滤一对多
卖家::whereJoin('位置.标题', '=', '测试')
混合过滤
卖家::whereJoin('城市.状态.标题', '=', '测试')
关系计数
$sellers = Seller::setAppendRelationsCount(true)->join('locations', '=', 'test')
->get();
foreach ($sellers as $seller){
echo 'Number of location = ' . $seller->locations_count;
}
过滤(混合左连接)
Seller::joinRelations('city', true)
->joinRelations('city.state', false)
->whereJoin('city.id', '=', 1)
->orWhereJoin('city.state.id', '=', 1)
生成的查询
查询
Order::whereJoin('seller.id', '=', 1)->get();
Sql
select "orders".*
from "orders"
left join "sellers" on "sellers"."id" = "orders"."seller_id"
where "sellers"."id" = ?
and "orders"."deleted_at" is null
group by "orders"."id"
查询
Order::orderByJoin('seller.id', '=', 1)->get();
Sql
select "orders".*, MAX(sellers.id) as sort
from "orders"
left join "sellers" on "sellers"."id" = "orders"."seller_id"
where "orders"."deleted_at" is null
group by "orders"."id"
order by sort asc
包的优雅性
让我们看看文档中的第一个示例现在看起来像什么。这段代码
$posts = Post::select('posts.*')
->join('categories', 'categories.id', '=', 'posts.category_id')
->groupBy('posts.id')
->where('categories.deleted_at', '=', null)
->orderBy('categories.name');
if(request()->get('date')){
$posts->where('date', $date)
}
$posts = $posts->get();
现在变成了
$posts = Post::orderByJoin('category.name');
if(request()->get('date')){
$posts->where('posts.date', $date)
}
$posts = $posts->get();
两个片段执行相同的功能。
测试
这个包经过了良好的测试。如果您想运行测试,请运行 composer update,然后使用 "vendor/bin/phpunit" 运行测试。
贡献
请随意创建新的问题以
- 报告错误
- 通知
- 请求新功能
- 提问
- 澄清
- 等等...
许可
MIT
自由软件,太棒了!