0

0

Laravel如何使用Scope本地作用域_Laravel模型常用查询逻辑封装技巧【手册】

尼克

尼克

发布时间:2026-01-02 09:39:08

|

175人浏览过

|

来源于php中文网

原创

本地作用域是Laravel模型中以scope开头的静态方法,用于封装常用查询条件,必须显式调用;定义时需为public static,首参为$query,支持驼峰转短横线调用;调用不可省略括号,且scope内应避免直接使用orWhere以防逻辑错误。

laravel如何使用scope本地作用域_laravel模型常用查询逻辑封装技巧【手册】

什么是本地作用域(Local Scope)

本地作用域是 Laravel 模型中以 scope 开头的静态方法,用于封装常用查询条件。它不是全局生效的,必须显式调用,比如 User::popular()->active()->get() 中的 popular()active() 就是两个本地作用域。

如何定义和调用 scope 方法

scope 方法必须是 publicstatic,且第一个参数固定为 $query(即 Builder 实例),后续参数按需添加。Laravel 会自动把驼峰命名转为短横线调用(如 scopeLatestPublished() 可链式调用为 ->latestPublished())。

class Post extends Model
{
    public function scopeActive($query)
    {
        return $query->where('status', 'active');
    }

    public function scopeByCategory($query, $category)
    {
        return $query->where('category', $category);
    }

    public function scopePopular($query, $minViews = 100)
    {
        return $query->where('views', '>=', $minViews);
    }
}

调用方式:

  • Post::active()->get()
  • Post::byCategory('news')->get()
  • Post::popular(50)->get()

注意:不能省略括号,哪怕无参也要写 ->active(),写成 ->active 会报错 Call to undefined method Illuminate\Database\Query\Builder::active()

scope 和 where 系列方法混用时的执行顺序

本地作用域本质是提前拼接 where 条件,所有 scope 调用顺序与 where 链式调用顺序一致,最终生成 SQL 的 WHERE 子句是「从左到右」叠加的。但 scope 内部若用了 orWhere,容易引发意料外的逻辑分组问题。

arXiv Xplorer
arXiv Xplorer

ArXiv 语义搜索引擎,帮您快速轻松的查找,保存和下载arXiv文章。

下载
  • 安全写法:scope 内统一用 wherewhereIn 等 AND 类型约束
  • 风险写法:在 scope 里直接写 $query->orWhere(...),会导致该条件脱离主 AND 分组,可能查出不该出现的数据
  • 若真需要 OR 逻辑,应改用 where(function ($q) { ... }) 显式包裹,例如:
    $query->where(function ($q) {
        $q->where('status', 'draft')->orWhere('status', 'pending');
    });

scope 无法复用到关联查询?试试 has() 或 withWhereHas()

本地作用域只作用于当前模型的主查询,不会自动下推到 with() 加载的关联模型中。比如 User::with('posts')->active()->get() 中的 active() 只过滤 User,不筛选 Posts。

要限制关联数据,得用:

  • with(['posts' => function ($q) { $q->active(); }]) —— 推荐,清晰可控
  • whereHas('posts', function ($q) { $q->active(); }) —— 用于「用户有活跃文章」这类存在性筛选
  • withWhereHas('posts', function ($q) { $q->active(); })(Laravel 10.29+)—— 同时满足「加载 + 筛选」,且主模型也参与关联条件过滤

别指望给 Post 定义的 scopeActive() 能在 User::with('posts') 里自动生效;scope 不是魔法,它只是语法糖,背后仍是手动拼 query。

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

314

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

270

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

363

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

363

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

80

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

63

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

62

2025.08.05

数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

675

2023.10.12

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

74

2025.12.31

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel---API接口
Laravel---API接口

共7课时 | 0.6万人学习

PHP自制框架
PHP自制框架

共8课时 | 0.6万人学习

PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 0.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号