laravel-mongodb查询作用域：复用查询逻辑的技巧

laravel-mongodb查询作用域：复用查询逻辑的技巧

【免费下载链接】laravel-mongodb A MongoDB based Eloquent model and Query builder for Laravel (Moloquent) 项目地址: https://gitcode.com/gh_mirrors/la/laravel-mongodb

在laravel-mongodb开发中，查询作用域（Query Scopes）是一种强大的功能，它可以帮助开发者复用查询逻辑，使代码更加简洁、可维护。本文将详细介绍laravel-mongodb查询作用域的使用技巧，包括本地作用域、全局作用域以及如何在实际项目中应用这些技巧。

本地作用域：灵活复用查询条件

本地作用域允许在模型中定义可复用的查询条件方法，以scope开头命名。例如，在tests/Models/User.php模型中，我们可以定义一个scopeActive方法来筛选活跃用户：

public function scopeActive(Builder $query): Builder
{
    return $query->where('status', 'active');
}

使用时只需在查询链中调用active()：

$activeUsers = User::active()->get();

本地作用域支持参数传递，实现更灵活的条件筛选。例如，筛选特定年龄段的用户：

public function scopeAgeBetween(Builder $query, int $min, int $max): Builder
{
    return $query->whereBetween('age', [$min, $max]);
}

// 使用
$users = User::ageBetween(18, 30)->get();

全局作用域：自动应用的查询条件

全局作用域会自动应用到模型的所有查询中，适合定义通用筛选条件。在tests/Models/Scoped.php中，通过boot方法注册全局作用域：

protected static function boot()
{
    parent::boot();

    static::addGlobalScope('favorite', function (Builder $builder) {
        $builder->where('favorite', true);
    });
}

如需临时移除全局作用域，可使用withoutGlobalScope方法：

// 移除单个全局作用域
$allItems = Scoped::withoutGlobalScope('favorite')->get();

// 移除所有全局作用域
$allItems = Scoped::withoutGlobalScopes()->get();

作用域组合：构建复杂查询逻辑

多个作用域可以链式组合，构建复杂查询。例如，结合活跃用户和年龄段筛选：

$activeAdults = User::active()->ageBetween(18, 65)->orderBy('created_at')->get();

还可以在作用域中嵌套其他作用域，进一步提高代码复用性：

public function scopeActiveAdults(Builder $query): Builder
{
    return $this->scopeActive($this->scopeAgeBetween($query, 18, 65));
}

实际应用场景

数据权限控制

在多租户系统中，使用全局作用域自动筛选当前租户数据：

// 在Tenant模型中
protected static function boot()
{
    parent::boot();
    
    static::addGlobalScope('tenant', function (Builder $query) {
        $query->where('tenant_id', auth()->user()->tenant_id);
    });
}

软删除实现

laravel-mongodb的软删除功能通过全局作用域实现，相关代码位于src/Eloquent/SoftDeletes.php。启用软删除后，查询会自动排除已删除记录：

use MongoDB\Laravel\Eloquent\SoftDeletes;

class Post extends Model
{
    use SoftDeletes;
}

// 查询自动排除已删除记录
$posts = Post::all();

// 包含已删除记录
$posts = Post::withTrashed()->get();

复杂统计查询

结合本地作用域和聚合函数实现数据统计：

public function scopeMonthlySignups(Builder $query, int $year, int $month): Builder
{
    return $query->whereYear('created_at', $year)
                 ->whereMonth('created_at', $month);
}

// 获取2023年10月注册用户数
$count = User::monthlySignups(2023, 10)->count();

作用域高级技巧

动态作用域生成

通过魔术方法动态创建作用域，适合处理大量相似查询条件：

public function __call($method, $parameters)
{
    if (Str::startsWith($method, 'scopeWhere')) {
        $column = Str::snake(substr($method, 9));
        return $this->where($column, $parameters[0]);
    }
    
    return parent::__call($method, $parameters);
}

// 动态调用 whereName、whereEmail 等
$users = User::whereName('John')->get();

作用域事件监听

利用laravel事件系统，在作用域应用前后执行额外逻辑：

protected static function boot()
{
    parent::boot();
    
    static::creating(function ($model) {
        // 保存前自动设置创建人
        $model->created_by = auth()->id();
    });
}

最佳实践与注意事项

1. 命名规范：作用域方法名应清晰描述其功能，如scopeRecent而非scopeRecentData。

2. 避免过度使用全局作用域：过多全局作用域可能导致查询行为难以预测，优先使用本地作用域。

3. 作用域测试：为作用域编写单元测试，确保查询逻辑正确性，可参考tests/Query/BuilderTest.php中的测试案例。

4. 文档化作用域：使用PHPDoc注释说明作用域功能和参数，提高代码可读性：

/**
 * 筛选指定年龄段的用户
 * 
 * @param Builder $query 查询构建器实例
 * @param int $min 最小年龄
 * @param int $max 最大年龄
 * @return Builder
 */
public function scopeAgeBetween(Builder $query, int $min, int $max): Builder
{
    return $query->whereBetween('age', [$min, $max]);
}

通过合理使用查询作用域，可以显著提高laravel-mongodb项目的代码复用性和可维护性。结合本地作用域和全局作用域的特点，在不同场景下灵活应用，能够有效减少重复代码，提升开发效率。更多高级用法可参考官方文档docs/eloquent-models.txt和docs/query-builder.txt。

【免费下载链接】laravel-mongodb A MongoDB based Eloquent model and Query builder for Laravel (Moloquent) 项目地址: https://gitcode.com/gh_mirrors/la/laravel-mongodb