humweb/laravel-eloquent-join

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

维护者

详细信息

github.com/humweb/laravel-eloquent-join

主页

源代码

问题

安装: 3,292

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 0

分支: 85

4.1.3 2020-09-09 14:33 UTC

Requires

Requires (Dev)

MIT 361baf5ceb5c941f58eb022e9dc645d0ecbb7483

laravel eloquent joinlaravel sort joinlaravel where joinlaravel join relationlaravel join

This package is auto-updated.

Last update: 2024-09-13 07:20:22 UTC

README

Tests status

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)

原因：文章和分类都可以有 "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;
...

3. 重要

对于 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

我们应该使用 inner join 还是 left join（默认 = 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 关系上的 Eloquent 构建器的新的子句

joinRelations($relations, $leftJoin = null)

  • $relations 要连接的关系
  • $leftJoin 使用 left join 或 inner join，默认 left join

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

查看真实示例中的操作

数据库模式

Database schema

模型

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')

连接（混合左连接）

卖家::joinRelations('城市', true)->joinRelations('城市.州', false)

连接（多个关系）

卖家::join(['城市.州', '位置'])

排序

排序 BelongsTo

卖家::orderByJoin('城市.标题')

排序 HasOne

卖家::orderByJoin('locationPrimary.地址')

排序 HasMany

卖家::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）

筛选 BelongsTo

卖家::whereJoin('城市.标题', '=', '测试')

筛选 HasOne

卖家::whereJoin('locationPrimary.地址', '=', '测试')

筛选 HasMany

卖家::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

自由软件，太棒了！