laravel query builder/ Eloquent builder 添加自定义方法
上次干这事已经是一年前了,之前的做法特别的繁琐、冗余,具体就是创建一个自定义 Builder 类,继承自 Query\Builder,然后覆盖 Connection 里面获取 Builder 的方法,返回自定义的 Builder,还有其他一系列很长的步骤。
下面是之前的做法:
(算了,还是不说了,太蠢),总之,多看看源码有好处
就说最优雅的解决方法吧:
laravel 中提供了 Macroable 的 trait,之前一直没有想过可以用上这个东西。
最近才想到可以这么做,源码看这里:https://github.com/laravel/framework/blob/5.6/src/Illuminate/Support/Traits/Macroable.php
目前用的是 5.1 版本,应该 5.1 版本以后的都有这个特性。
当然,你也可以在 Model 基类里面添加自定义方法,但是这样添加的方法 DB 类是用不了的。
但是使用 macro 定义到 Builder 的方法可以同时在 DB 类和 Eloquent Model 中使用(具体不赘述,自己看源码,就是利用 __call、__callStatic 这些魔术方法)。
使用方法:调用 Macroable 的 macro 方法,绑定一个自定义方法到 Builder 类中,如:
\Illuminate\Database\Query\Builder\Builder::macro('active', function () {
return $this->where('status', 1);
});
调用方法是(使用 DB 类):
DB::table(xxx)->active()->get();
或者(使用 Eloquent Model):
\App\Model\User::active()->first();
至于我们应该把上面那几行放哪里?
个人觉得一个比较好的地方是 Providers 中,在 app/Providers 下面新建一个 Provider,把 macro 调用放到 Provider 的 register 方法中。如:
<?php namespace App\Providers; use Illuminate\Database\Query\Builder;
use Illuminate\Support\ServiceProvider; /** @mixin \Illuminate\Database\Eloquent\Builder */
class DatabaseServiceProvider extends ServiceProvider
{
/**
* Register any application services.
*
* @return void
*/
public function register()
{
Builder::macro('active', function () {
return $this->where('status', 1);
});
}
}
当然,加了 Providers 之后还要在 config/app.php 中配置这个 Provider。
就这样。
还有个问题是,这样添加的方法 ide 无法识别,我们这时候就可以使用 @method 了,如:
@method $this active()
可以使用命令把这些 @method 写入到 Builder 头部(我看 laravel-ide-helper 这么干我才这么干的):
<?php namespace App\Console\Utils; use App\Console\Commands\BaseCommand; /** @see \Illuminate\Database\Query\Builder */
class Ide extends BaseCommand
{
public $signature = 'ide'; public $description = '生成 PHP doc到 Query Builder'; public function handle()
{
$file = base_path() . '/vendor/laravel/framework/src/Illuminate/Database/Query/Builder.php';
if (!is_file($file)) {
$this->info("文件不存在({$file}), 先 composer install");
return;
} $content = file_get_contents($file);
$pos = strpos($content, 'class Builder');
list($before, $after) = $this->splitFileByPos($content, $pos);
$before = $this->removeOldDoc($before);
$new_file_content = $before . $this->docProvider() . $after; $f = fopen($file, 'w+');
fwrite($f, $new_file_content);
fclose($f);
} // 移除旧的 php doc
private function removeOldDoc($before)
{
if (preg_match('/(\/\*.*?\*\/)/ism', $before, $match)) {
$before = preg_replace('/(\/\*.*?\*\/)/ism', '', $before);
} return $before;
} // 生成新的 php doc
private function docProvider()
{
return <<<DOC
/**
* @method \$this like(\$field, \$keyword = '')
* @method \$this recent()
* @method \$this active()
* @method \$this notDeleted()
*/\n
DOC;
} // 通过一个点把文件分割成两部分
private function splitFileByPos($content_string, $pos)
{
$before = substr($content_string, 0, $pos);
$after = substr($content_string, $pos); return [$before, $after];
}
}
这样的好处是,也没什么好处,就是你 push 上去的时候,一般 vendor 都 ignore 了,在其他电脑 clone 下来,就没有那些 @method 了,也就不会有语法提示了。
手速惊人的还是忽略吧。
laravel query builder/ Eloquent builder 添加自定义方法的更多相关文章
- Laravel Query Builder 复杂查询案例:子查询实现分区查询 partition by
案例 案例:Laravel 在文章列表中附带上前10条评论?,在获取文章列表时同时把每个文章的前10条评论一同查询出来. 这是典型分区查询案例,需要根据 comments 表中的 post_id 字段 ...
- [Laravel] 16 - DB: Eloquent
前言 一.大纲 写后端API,与数据库打交道无疑是很重要的角色. PHP数据库操作:从MySQL原生API到PDO PHP数据库操作:使用ORM Ref: [PHP] 07 - Json, XML a ...
- [转]Laravel 4之Eloquent ORM
Laravel 4之Eloquent ORM http://dingjiannan.com/2013/laravel-eloquent/ 定义Eloquent模型 模型通常放在app/models目录 ...
- 【Laravel】为Eloquent 模型设置全局作用域和局部作用域进行查询
全局作用域 所谓「全局作用域」,指的是预置过滤器在注册该「全局作用域」的模型类的所有查询中生效,不需要指定任何额外条件. 以 User 模型类为例,我们在系统中可能只想针对已经验证过邮箱的用户进行操作 ...
- 十六、springboot整合Spring-data-jpa(二)之通用DAO接口与添加自定义方法
@NoRepositoryBean:Spring Data Jpa在启动时就不会去实例化BaseRepository这个接口 1.通用接口: import org.springframework.da ...
- Actionscript,AS3,MXML,Flex,Flex Builder,Flash Builder,Flash,AIR,Flash Player之关系
转自zrong's blog:http://zengrong.net/post/1295.htm ActionScript ActionScript通常简称为AS,它是Flash平台的语言.AS编写的 ...
- (十三)SpringBoot之Spring-Data-Jpa(二)CRUD实现以及添加自定义方法
一.jpa中添加自定义方法 http://blog.csdn.net/qq_23660243/article/details/43194465 二.案例 1.3 引入jpa依赖 <depende ...
- 3.2Adding custom methods to mappers(在映射器中添加自定义方法)
3.2Adding custom methods to mappers(在映射器中添加自定义方法) 有些情况下,我们需要实现一些MapStruct无法直接自动生成的复杂类型间映射.一种方式是复用其他已 ...
- [Laravel] 03 - DB facade, Query builder & Eloquent ORM
连接数据库 一.Outline 三种操作数据库的方式. 二.Facade(外观)模式 Ref: 解读Laravel,看PHP如何实现Facade? Facade本质上是一个“把工作推给别人做的”的类. ...
随机推荐
- leetcode12_C++整数转罗马数字
小弟不才,有错误或者更好解,求留言. 罗马数字包含以下七种字符: I, V, X, L,C,D 和 M. 字符 数值 I 1 V 5 X 10 L 50 C 100 D 500 M 1000 例如, ...
- linux源码学习-for_each_cpu
刚开始读linux源码,第一眼就看到了这个很有意思的函数族,周末好好研究一下 3.13 这个组都是宏定义for循环,分析的时候注意到cpumask_next(),它在一个文件中定义了两次,还不是重载, ...
- 多重共性和VIF检验
图片来源https://wenku.baidu.com/view/7008df8383d049649b66581a.html 和 https://wenku.baidu.com/view/6acdf9 ...
- DOM---文档对象模型(Document Object Model)的基本使用
一.DOM简介 文档对象模型(Document Object Model,简称DOM),是W3C组织推荐的处理可扩展置标语言的标准编程接口.它是一种与平台和语言无关的应用程序接口(API),它可以动态 ...
- 在香港网站使用工商银行的MasterCard,工商银行所犯的低级的错误,金融安全何在
- loadrunner socket协议问题归纳(1)
前段时间测了loadrunner直接发送报文到socket上的性能测试.在此,稍微回顾整理下. 与socket通讯,有两种方式,一种是建立长连接,建立后,不停的发送,接收.另外一种是建立短连接,建立连 ...
- Alpha版发布 - 感谢有你们
在本次alpha开发的过程中,很感谢组长王航对我信任,让我统筹大家的工作任务和进度,使我对项目管理有了深刻的理解. 我也要感谢邹双黛,因为我以前很少做文字类的工作,写东西非常生硬,邹双黛即使在有做家教 ...
- Hadoop环境搭建01
根据马士兵老师的Hadoop进行的配置 1.首先列下来需要用到的软件 VirtulBox虚拟机.Centos7系统镜像.xshell.xftp.jdk安装包.hadoop-2.7.0安装包 2.在Vi ...
- 一个整数N中的1的个数
设计思想: 通过大量数据分解找规律 abcd 从d开始若d=0则count(1的个数)=左边的abc *d的位值(1.10.100..) 若等欲1则count=左边的abc*d的位值(1.10.100 ...
- OOP 学习笔记汇总
1.1 引用 1.2 const关键字 1.3 动态内存分配 1.4 内联函数和重载函数函数参数缺省值 1.5 类和对象的基本概念与用法1 2.1 类和对象的基本概念2