README

FORK 以支持 Laravel 10

Laravel Eloquent Join

本包引入了 Eloquent 模型和关系的连接魔法。

简介

Eloquent 是一个强大的 ORM，但它的连接能力非常有限。

第一个 Eloquent 问题（排序）

使用 Laravel，您无法在不手动连接相关表的情况下对关系字段进行排序，这非常尴尬。让我给您一些原因。如果您有一个包含 posts 和相关 categories 的表，您的代码可能看起来像这样

$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。

    ->select('posts.*')

原因：如果没有从 category 中选择 id，它可以从 Post 模型中选中并填充。

2. 第二个问题是您需要担心 groupBy。

->groupBy('posts.id');

原因：如果关系是 HasOne，并且帖子有多个类别，查询将返回多个类别的行。

3. 第三个问题是要更改所有其他 where 子句从

    ->where('date', $date)

到

    ->where('posts.date', $date)

原因：post 和 category 可以有 "date" 属性，在这种情况下，如果没有选择具有表 "模糊列" 的属性，将会抛出错误。

4. 第四个问题是您正在使用表名（不是模型）并且这也是不好的和尴尬的。

    ->where('posts.date', $date)

5. 第五个问题是您需要担心连接表的软删除。如果 category 使用 SoftDeletes 特性，您必须添加

    ->where('categories.deleted_at', '=', null)

这个包将为您解决上述所有问题。与排序不同，您可以在不连接相关表的情况下对关系字段进行筛选，但这个包将为您提供这样做更容易的能力。

第二个 Eloquent 问题（子查询）

使用 Laravel，您可以对关系属性进行 where 操作，但 Laravel 将生成比连接更慢的子查询。使用此包，您将以优雅的方式在连接上进行关系 where 操作。

要求

该包还针对 SQLite、MySQL 和 PostgreSQL 进行了测试

安装 & 设置

1. 使用 composer 安装包

composer require fico7489/laravel-eloquent-join

此语句将安装与您的当前 Laravel 版本兼容的最高版本包。

2. 在您的基模型或特定模型中使用 Fico7489\Laravel\EloquentJoin\Traits\EloquentJoinTrait 特性。

...
use Fico7489\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" 
	...

每个 relation 都与一个下划线连接，并在末尾添加 _count 前缀。例如，对于

->joinRelations('seller.locations')

字段，将是 seller_locations_count

leftJoin

我们应该使用内连接还是左连接（默认 = true）

select "sellers".* 
	from "sellers" 
	inner join "locations"                    
	...

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
	...

选项有：总和、平均、最大值、最小值、计数

用法

当前可用的连接查询关系

BelongsTo
HasOne
HasMany

在 BelongsTo 和 HasOne 关系上添加新的 eloquent 生成器子句

joinRelations($relations, $leftJoin = null)

$relations 要连接的关系
$leftJoin 使用 左连接 或 内连接，默认 左连接

orderByJoin($column, $direction = 'asc', $aggregateMethod = null)

$column 和 $direction 参数与默认 eloquent orderBy() 中的参数相同
$aggregateMethod 参数定义要使用的聚合方法（总和、平均、最大值、最小值、计数），默认 最大值

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 使用这些子句在子查询中独立应用 NOT 在连接子句上，这样做更简单。

您可能觉得规则和限制太多，但实际上并非如此。不用担心，如果您创建了不允许的查询，将会抛出适当的异常，您会知道发生了什么。

其他

如果模型使用 SoftDelete 特性，则会自动应用 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

卖家::joinRelations('locations')

混合连接

卖家::joinRelations('city.state')

连接（左连接）

卖家::joinRelations('city', true)->joinRelations('city.state', false)

连接（多个关系）

Seller::join(['city.state', 'locations'])

排序

Order BelongsTo

卖家::orderByJoin('city.title')

Order HasOne

卖家::orderByJoin('locationPrimary.address')

Order HasMany

卖家::orderByJoin('locations.title')

Order Mixed

卖家::orderByJoin('city.state.title')

排序（特殊案例与聚合函数）

按关系计数排序

卖家::orderByJoin('locations.id', 'asc', 'COUNT')

按关系字段 SUM 排序

卖家::orderByJoin('locations.is_primary', 'asc', 'SUM')

按关系字段 AVG 排序

卖家::orderByJoin('locations.is_primary', 'asc', 'AVG')

按关系字段 MAX 排序

卖家::orderByJoin('locations.is_primary', 'asc', 'MAX')

按关系字段 MIN 排序

卖家::orderByJoin('locations.is_primary', 'asc', 'MIN')

过滤（where 或 orWhere）

Filter BelongsTo

卖家::whereJoin('city.title', '=', 'test')

Filter HasOne

卖家::whereJoin('locationPrimary.address', '=', 'test')

Filter HasMany

卖家::whereJoin('locations.title', '=', 'test')

Filter Mixed

卖家::whereJoin('city.state.title', '=', 'test')

关系计数

$sellers = Seller::setAppendRelationsCount(true)->join('locations', '=', 'test')
    ->get();
    
foreach ($sellers as $seller){
    echo 'Number of location = ' . $seller->locations_count;
}

Filter（混合左连接）

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" 运行测试。

贡献

请随意为以下内容创建新问题

bug
notice
请求新功能
问题
澄清
等等...

许可证

MIT

自由软件，太棒了！

fico7489 / laravel-eloquent-join

维护者

详情