Laravel-Countries项目中的全局作用域详解

引言

在Laravel-Countries项目中，全局作用域(Global Scopes)是一个非常重要的概念，它可以帮助开发者自动过滤和优化数据查询。本文将深入解析项目中默认应用的两个全局作用域，帮助开发者更好地理解和使用它们。

什么是全局作用域

全局作用域是Laravel Eloquent模型的一个强大特性，它允许开发者定义一组查询约束条件，这些条件会自动应用到模型的所有查询中。在Laravel-Countries项目中，Country模型和Region模型默认启用了两个全局作用域。

默认全局作用域

1. 可见性作用域(Visible Scope)

这个作用域确保只有is_visible字段为true的国家/地区才会被查询出来。其底层实现相当于在所有查询中自动添加了：

$builder->where('is_visible', true);

这意味着默认情况下，所有被标记为不可见的国家/地区都会被自动过滤掉，无需开发者手动添加这个条件。

2. 翻译作用域(Translation Scope)

这个作用域确保每次查询国家/地区数据时，都会自动预加载(Eager Loading)关联的翻译数据。其底层实现相当于：

$builder->withTranslation();

这避免了N+1查询问题，提高了应用性能，同时也简化了开发者的工作。

如何禁用全局作用域

虽然全局作用域非常有用，但有时我们需要绕过这些默认约束。Laravel-Countries项目提供了便捷的方法来临时禁用这些作用域。

禁用翻译作用域

使用withNotTranslation()方法可以在特定查询中移除翻译作用域：

use Lwwcas\LaravelCountries\Models\Country;

// 获取英国数据，但不预加载翻译
Country::withNotTranslation()
    ->whereName('United Kingdom')
    ->first();

禁用可见性作用域

使用withNotVisible()方法可以在特定查询中移除可见性过滤：

use Lwwcas\LaravelCountries\Models\Country;

// 获取英国数据，包括不可见的记录
Country::withNotVisible()
    ->whereName('United Kingdom')
    ->first();

实用方法

除了全局作用域外，项目还提供了一系列实用方法来操作和检查可见性状态：

方法名称	描述
isVisible()	检查国家/地区是否可见(返回布尔值)
isHidden()	检查国家/地区是否隐藏(返回布尔值)
setVisibleTrue()	将国家/地区标记为可见
setVisibleFalse()	将国家/地区标记为不可见
setModelVisible()	将国家/地区标记为可见(与setVisibleTrue()相同)
setModelHidden()	将国家/地区标记为不可见(与setVisibleFalse()相同)

使用建议

1. 性能考虑：默认启用的翻译作用域虽然方便，但如果确定不需要翻译数据，可以使用withNotTranslation()来提高查询性能。

2. 数据完整性：在后台管理系统中，可能需要查看所有国家/地区(包括不可见的)，这时可以使用withNotVisible()。

3. 批量操作：当需要批量修改国家/地区的可见性状态时，可以使用提供的set方法，它们会自动处理模型的保存操作。

注意事项

• 全局作用域是默认启用的，除非显式禁用
• 禁用作用域只对当前查询有效，不会影响其他查询
• 修改可见性状态后，模型会自动保存，无需额外调用save()方法

通过理解这些全局作用域和实用方法，开发者可以更高效地使用Laravel-Countries项目，构建出更健壮的国际化和地区相关的应用功能。