Laravel Eloquent模型中实现多语言数据自动过滤的技巧

在laravel多语言应用中，为模型查询自动添加基于当前语言的筛选条件是常见需求。本文将介绍一种优雅且高效的方法，通过重写eloquent模型的`newquery()`方法，实现所有针对该模型的数据查询都自动应用`where('language', app::getlocale())`条件，从而简化开发流程，确保数据始终与当前语言环境匹配，无需每次手动添加筛选。

Laravel多语言数据管理与自动筛选需求

在构建支持多种语言的Web应用时，通常会在数据库表中添加一个language字段来标识每条记录所属的语言。当用户访问网站时，系统会根据当前的语言环境（例如通过App::getLocale()获取）来展示对应语言的数据。为了避免在每次查询时都手动添加where('language', App::getLocale())条件，开发者通常寻求一种自动化的解决方案。

虽然Laravel的“全局作用域（Global Scopes）”是一种非常强大的机制，可以实现类似的功能，但有时我们可能需要一种更底层、更直接的方式，让某个模型在任何查询开始时就默认包含特定的筛选条件。

核心解决方案：重写 newQuery() 方法

Eloquent模型在每次执行查询操作时，都会通过newQuery()方法获取一个新的查询构建器（Query Builder）实例。通过重写这个方法，我们可以在查询构建器被返回之前，为其添加任何我们希望默认应用的条件。

这意味着，当您调用Model::all()、Model::find($id)、Model::where(...)等任何方法时，底层的newQuery()方法都会被触发，从而自动包含我们定义的语言筛选条件。

实现步骤

在需要自动应用语言筛选的Eloquent模型中，重写newQuery()方法，并在父类方法返回的查询构建器上添加where条件。

蚂蚁PPT

AI在线智能生成PPT

113

查看详情

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Facades\App; // 导入App facade

class Article extends Model
{
    use HasFactory;

    /**
     * 获取模型表的新查询构建器。
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function newQuery()
    {
        // 调用父类的newQuery()方法获取原始查询构建器
        // 然后在其基础上添加 'language' 字段的筛选条件
        return parent::newQuery()->where('language', App::getLocale());
    }

    // 其他模型属性和方法...
}

在上面的示例中，Article模型现在会在每次发起查询时，自动将language字段的值限制为当前应用的语言环境（由App::getLocale()获取）。

工作原理详解

1. 当您尝试从Article模型中获取数据时，例如调用Article::all()。
2. Laravel Eloquent会调用Article模型实例的newQuery()方法。
3. 我们重写的newQuery()方法首先调用parent::newQuery()，这会返回一个标准的、未经修改的查询构建器实例。
4. 接着，我们在这个构建器实例上链式调用-youjiankuohaophpcnwhere('language', App::getLocale())，为其添加了语言筛选条件。
5. 最终，一个已经包含了语言筛选条件的查询构建器被返回。
6. 后续的所有查询操作（如get()、find()、paginate()等）都将基于这个预设了语言条件的构建器执行。

使用示例

一旦您在模型中重写了newQuery()方法，所有通过该模型发起的查询都将自动应用语言筛选：

use App\Models\Article;
use Illuminate\Support\Facades\App;

// 假设当前语言环境是 'en'
App::setLocale('en');

// 获取所有英文文章
$englishArticles = Article::all();
// 等同于 SELECT * FROM articles WHERE language = 'en'

// 获取ID为1的英文文章
$englishArticleById = Article::find(1);
// 等同于 SELECT * FROM articles WHERE id = 1 AND language = 'en' LIMIT 1

// 获取特定分类下的所有英文文章
$categoryArticles = Article::where('category_id', 5)->get();
// 等同于 SELECT * FROM articles WHERE category_id = 5 AND language = 'en'

// 假设当前语言环境是 'zh'
App::setLocale('zh');

// 获取所有中文文章
$chineseArticles = Article::all();
// 等同于 SELECT * FROM articles WHERE language = 'zh'

注意事项与考量

1. 全局性影响： 这种方法会影响所有通过该模型实例或静态方法发起的查询。这意味着，一旦设置，您将无法直接通过该模型获取到非当前语言环境的数据。
2. 绕过筛选： 如果确实需要获取所有语言的数据，或者特定语言的数据（非当前App::getLocale()），则不能直接使用此模型。您可能需要：
   • 使用DB::table('your_table_name')->where(...)直接查询数据库。
   • 创建一个不重写newQuery()方法的“原始”模型（例如BaseArticle），或者一个专门用于获取所有语言数据的模型（例如AllLanguageArticle），但这种方式增加了模型的数量和管理复杂性。
   • 或者，考虑使用全局作用域，因为它提供了withoutGlobalScope()方法来临时禁用作用域。
3. 性能影响： 添加一个简单的where条件通常对查询性能影响微乎其微，尤其是在language字段上建立了索引的情况下。
4. 维护性： 将语言筛选逻辑集中在newQuery()方法中，可以提高代码的维护性，避免在业务逻辑层重复编写筛选条件。
5. 与全局作用域的对比：
   • newQuery()重写：更底层，直接修改了查询构建器的初始状态，无法通过Eloquent的withoutGlobalScope()方法禁用。适用于模型需要始终默认应用某个条件的情况。
   • 全局作用域：通过boot()方法注册，可以被withoutGlobalScope()方法临时禁用。适用于需要灵活控制筛选条件的应用场景。 选择哪种方式取决于您的具体需求：如果筛选是模型固有的、不可绕过的行为，newQuery()更合适；如果筛选是可选的，或者需要在某些特定场景下禁用，则全局作用域更为灵活。

总结

通过重写Eloquent模型的newQuery()方法，我们能够为Laravel多语言应用提供一种优雅且高效的数据自动筛选机制。这种方法确保了所有通过该模型进行的查询都自动包含当前语言环境的筛选条件，极大地简化了开发工作，并保证了数据的一致性。在决定采用此方法时，请务必权衡其全局性影响，并考虑在需要绕过此筛选时可能采取的替代方案。

以上就是Laravel Eloquent模型中实现多语言数据自动过滤的技巧的详细内容，更多请关注php中文网其它相关文章！