Laravel高级查询：基于“Has One Of Many”关系排序父模型

本文深入探讨了在laravel中如何优雅地实现父模型（如客户）基于其“has one of many”关系（如最新联系记录）进行排序的需求。面对直接关联查询可能导致数据重复的问题，文章提出了利用子查询连接（subquery join）作为高效且简洁的解决方案，详细阐述了如何构建子查询来聚合相关数据，并将其与主模型连接，最终实现精确的排序。

1. 理解问题背景与“Has One Of Many”关系

在Laravel应用开发中，我们经常会遇到需要根据关联模型的特定属性来排序主模型的情况。例如，一个Customer（客户）模型可能拥有多个Contact（联系记录），我们希望能够根据每个客户的“最新联系时间”来对客户列表进行排序。

Laravel的“Has One Of Many”关系（在Laravel 8+中引入）是解决此类问题的强大工具。它允许我们轻松地定义一个关系，以获取多个相关模型中符合特定条件（如最大值、最小值）的单个模型。

模型定义示例：

假设我们有Customer和Contact两个模型，Customer拥有多个Contact。我们定义一个latestContact关系来获取每个客户的最新联系记录。

// app/Models/Customer.php
namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Customer extends Model
{
    use HasFactory;

    public function contacts()
    {
        return $this->hasMany(Contact::class);
    }

    // 定义获取最新联系记录的关系
    public function latestContact()
    {
        return $this->hasOne(Contact::class)->ofMany('contacted_at', 'max')->withDefault();
    }
}

// app/Models/Contact.php
namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class Contact extends Model
{
    use HasFactory, SoftDeletes;

    protected $casts = [
        'contacted_at' => 'datetime',
    ];

    public function customer()
    {
        return $this->belongsTo(Customer::class);
    }
}

在Contact模型的迁移文件中，contacted_at字段用于记录联系时间：

// database/migrations/..._create_contacts_table.php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class CreateContactsTable extends Migration
{
    public function up()
    {
        Schema::create('contacts', function (Blueprint $table) {
            $table->id();
            $table->timestamps();
            $table->softDeletes();
            $table->foreignId('customer_id')->constrained()->onDelete('cascade');
            $table->string('type');
            $table->dateTime('contacted_at'); // 用于排序的关键字段
        });
    }

    public function down()
    {
        Schema::dropIfExists('contacts');
    }
}

2. 排序挑战：为何直接JOIN行不通？

我们的目标是获取所有客户，并根据他们的最新联系时间进行排序。直观上，可能会尝试使用join语句将customers表与contacts表连接起来，然后按contacted_at排序。

// 尝试一：直接JOIN (会导致重复数据)
$query = Customer::select('customers.*', 'contacts.contacted_at as latest_contact_at')
    ->join('contacts', 'customers.id', '=', 'contacts.customer_id')
    ->orderBy('contacts.contacted_at', 'desc')
    ->get();

这种方法的问题在于，如果一个客户有多个联系记录，join操作会为每个联系记录生成一行客户数据，导致客户信息重复，这并非我们所期望的结果。我们需要的是每个客户只出现一次，并且其排序依据是其“最新”的联系时间。

3. 解决方案：利用子查询连接（Subquery Join）

解决此问题的最优雅和高效的方式是使用Laravel的子查询连接（Subquery Join）。这种方法允许我们首先在一个子查询中聚合所需的关联数据（即每个客户的最新联系时间），然后将这个聚合结果作为一个临时表与主表进行连接。

核心思想：

阿贝智能

阿贝智能是基于AI技术辅助创作儿童绘本、睡前故事和有声书的平台，助你创意实现、梦想成真。

63

查看详情

1. 构建子查询： 从contacts表中选出每个customer_id对应的最大contacted_at。
2. 执行连接： 将customers表与这个子查询的结果连接起来。
3. 最终排序： 根据子查询中得到的最新联系时间对客户进行排序。

实现代码：

use Illuminate\Support\Facades\DB;

$latestContactsSubquery = Contact::select('customer_id', DB::raw('max(contacted_at) as latest_contact_at'))
                                 ->groupBy('customer_id');

$customers = Customer::select('customers.*', 'latest_contacts.latest_contact_at')
                     ->joinSub($latestContactsSubquery, 'latest_contacts', function ($join) {
                         $join->on('customers.id', '=', 'latest_contacts.customer_id');
                     })
                     ->orderBy('latest_contacts.latest_contact_at', 'desc')
                     ->get();

代码解析：

1. $latestContactsSubquery：

   • Contact::select('customer_id', DB::raw('max(contacted_at) as latest_contact_at'))：这一部分构建了一个查询，它会为每个customer_id选择其对应的contacted_at字段的最大值，并将其别名为latest_contact_at。
   • -youjiankuohaophpcngroupBy('customer_id')：这确保了max(contacted_at)是针对每个唯一的customer_id计算的。
   • 这个查询的结果是一个临时数据集，包含customer_id和每个客户的latest_contact_at。

2. Customer::select(...)：

   • Customer::select('customers.*', 'latest_contacts.latest_contact_at')：我们从customers表中选择所有列，并额外选择子查询结果中的latest_contact_at列。
   • ->joinSub($latestContactsSubquery, 'latest_contacts', function ($join) { ... })：这是关键步骤。joinSub方法接受两个参数：第一个是子查询对象（$latestContactsSubquery），第二个是为这个子查询结果起的别名（latest_contacts）。第三个参数是一个闭包，用于定义连接条件，这里我们通过customer_id将customers表与latest_contacts临时表连接起来。
   • ->orderBy('latest_contacts.latest_contact_at', 'desc')：最后，我们根据从子查询中获取的latest_contact_at字段对客户进行排序。

4. 注意事项与优化

• 索引： 为了保证查询性能，务必在contacts表的customer_id和contacted_at字段上创建索引。

  ALTER TABLE contacts ADD INDEX (customer_id);
  ALTER TABLE contacts ADD INDEX (contacted_at);

  登录后复制

  或者在迁移文件中添加：

  $table->foreignId('customer_id')->constrained()->onDelete('cascade')->index();
  $table->dateTime('contacted_at')->index();

  登录后复制
• 关联预加载： 如果在获取客户列表后还需要访问其latestContact关系（例如，显示联系类型），可以在最终查询中添加with('latestContact')。

  $customers = Customer::select('customers.*', 'latest_contacts.latest_contact_at')
                       ->joinSub($latestContactsSubquery, 'latest_contacts', function ($join) {
                           $join->on('customers.id', '=', 'latest_contacts.customer_id');
                       })
                       ->orderBy('latest_contacts.latest_contact_at', 'desc')
                       ->with('latestContact') // 如果需要访问关系数据
                       ->get();

  登录后复制

  请注意，with('latestContact')会产生额外的查询来加载每个客户的最新联系记录，这与我们通过子查询获取latest_contact_at是不同的目的。子查询用于排序，而with用于加载完整的关联模型对象。

总结

通过利用Laravel的子查询连接功能，我们可以优雅且高效地解决根据“Has One Of Many”关系对父模型进行排序的复杂需求。这种方法避免了直接JOIN可能导致的重复数据问题，保持了查询的清晰性和结果的准确性。在处理类似需要聚合关联数据进行排序的场景时，子查询连接是一个非常推荐的解决方案。

以上就是Laravel高级查询：基于“Has One Of Many”关系排序父模型的详细内容，更多请关注php中文网其它相关文章！