shahrooz7216 / searchy
Laravel Searchy 通过模糊搜索、基本字符串匹配、Levenshtein 距离等功能,使用户驱动的搜索变得简单。
Requires
- php: ^5.5.9 || ^7.0 || ^8.0
- illuminate/support: ^5.1 || ^6.0 || ^7.0 || ^8.0
Requires (Dev)
- graham-campbell/testbench: ^3.4 || ^4.0 || ^5.0
- phpunit/phpunit: ^4.8 || ^5.7 || ^6.3 || ^7.0 || ^8.0
README
请参阅 问题 #117
以下是一些替代链接,您可能能够使用(我不保证这些项目的适用性或质量,请在确保它们满足您的要求方面进行自己的尽职调查)
- 待办事项
Laravel 5+ Searchy
简化数据库搜索
Searchy 是一个易于使用、轻量级的 MySQL only、Laravel 包,它使在您的模型数据上运行用户驱动的搜索变得简单而有效。它使用伪模糊搜索和根据您启用的搜索驱动程序的其他加权机制。它不需要在您的服务器上安装其他软件(因此可能比专用搜索程序慢一些),但可以在几分钟内设置并准备就绪。
!! Laravel 4 !!
寻找 Laravel 4 兼容的 Searchy?查看 1.0 分支 :)
https://github.com/TomLingham/Laravel-Searchy/tree/1.0
安装
将 "tom-lingham/searchy" : "2.*" 添加到您的 composer.json 文件中的 require 部分
"require": { "laravel/framework": "5.*", "tom-lingham/searchy" : "2.*" }
在您的终端中运行 composer update 以将包拉入您的 vendors 文件夹。
将服务提供者添加到 Laravel 的 ./config/app.php 文件中的 providers 数组
TomLingham\Searchy\SearchyServiceProvider::class
如果您想在不使用服务提供者的情况下快速访问它,请将别名添加到 Laravel 的 ./config/app.php 文件中的 aliases 数组
'Searchy' => TomLingham\Searchy\Facades\Searchy::class
用法
要使用 Searchy,您可以利用魔法方法。
如果您正在搜索 users 表中用户的姓名和电子邮件列/字段,例如运行
$users = Searchy::users('name', 'email')->query('John Smith')->get();
您也可以写成这样
$users = Searchy::search('users')->fields('name', 'email')->query('John Smith')->get();
在这种情况下,将您想要搜索的列传递给 fields() 方法。
这两个示例都返回包含搜索结果的 Object 数组。如果您想对结果进行进一步的操作,可以使用 getQuery() 替代 get() 来返回数据库查询对象实例。
$users = Searchy::search('users')->fields('name', 'email')->query('John Smith') ->getQuery()->having('relevance', '>', 20)->get();
结果返回限制
要限制结果,您可以使用 Laravel 内置的 Database Query Builder 方法,并通过链式方法进一步缩小结果。
// Only get the top 10 results $users = Searchy::search('users')->fields('name', 'email')->query('John Smith') ->getQuery()->limit(10)->get();
搜索多个列
您还可以将多个参数添加到要搜索的列/字段列表中。
例如,如果您想搜索用户的名字、电子邮件地址和用户名,您可能会运行
$users = Searchy::users('name', 'email', 'username')->query('John Smith')->get();
如果您需要动态构建您的表列表,您也可以将字段数组作为第一个参数传递(所有其他后续参数将被忽略)
$users = Searchy::users(['name', 'email', 'username'])->query('John Smith')->get();
搜索连接/连接的列
有时您可能想要利用连接列的搜索。例如,在一个 first_name 和 last_name 字段上,但您只想运行一个查询。为此,可以使用双冒号分隔列
$users = Searchy::users('first_name::last_name')->query('John Smith')->get();
软删除记录
默认情况下,软删除将不会包含在您的结果中。但是,如果您希望包含软删除的记录,您可以在指定表和字段后添加 withTrashed()。
Searchy::users('name')->withTrashed()->query('Batman')->get();
仅返回特定列
您可以在搜索中指定要返回的列
$users = Searchy::users('first_name::last_name')->query('John Smith')->select('first_name')->get(); // Or you can swap those around... $users = Searchy::users('first_name::last_name')->select('first_name')->query('John Smith')->get();
但是,这也会返回 relevance 别名列,无论在此处输入了什么。
如何获取 Laravel Eloquent Collection
将搜索结果转换为Laravel Eloquent模型集合超出了本项目的范围。然而,为了避免不必要的数据库查询,可以通过使用Eloquent的hydrate()方法轻松实现这一点。
\App\User::hydrate(Searchy::users('name', 'email')->query('Andrew')->get());
该方法从普通数组创建模型集合。这正是我们的情况,因为Searchy的结果以数组形式提供,使用hydrate我们将它们转换为User模型的实例。
Unicode字符支持
如果您因为搜索数据中包含Unicode字符而遇到返回结果的问题,可以使用FuzzySearchUnicodeDriver。
请注意:在将字符串插入到原始MySQL语句之前,FuzzySearchUnicodeDriver不会对传递的字符串进行清理。您必须首先自己清理字符串,否则可能会使您的应用程序面临SQL注入攻击。请务必注意。
使用方法:首先按照说明发布您的配置文件(php artisan vendor:publish),然后将默认驱动从fuzzy更改为ufuzzy。
return [ 'default' => 'ufuzzy', ... ]
配置
您可以将配置文件发布到您的app目录,并运行php artisan vendor:publish来覆盖设置,将配置复制到您的config文件夹中的searchy.php。
您可以在配置文件中设置用于搜索的默认驱动。目前您有的选项是:fuzzy、simple和levenshtein。
您还可以在执行搜索时使用以下语法覆盖这些方法。
Searchy::driver('fuzzy')->users('name')->query('Batman')->get();
驱动器
Searchy利用“驱动器”来处理您指定的字段的各种匹配条件。
驱动器是一组指定的“匹配器”,根据特定条件匹配字符串。
目前只有三个驱动器:简单、模糊和Levenshtein(实验性)。
简单搜索驱动器
简单搜索驱动器仅使用3个匹配器,每个匹配器都有针对测试环境的最合适的乘数。
protected $matchers = [ 'TomLingham\Searchy\Matchers\ExactMatcher' => 100, 'TomLingham\Searchy\Matchers\StartOfStringMatcher' => 50, 'TomLingham\Searchy\Matchers\InStringMatcher' => 30, ];
模糊搜索驱动器
模糊搜索驱动器是一组匹配器,设置如下。乘数是我使用的,但您可以随意更改这些或创建具有相同匹配器的自定义驱动器,并更改乘数以适应您的需求。
protected $matchers = [ 'TomLingham\Searchy\Matchers\ExactMatcher' => 100, 'TomLingham\Searchy\Matchers\StartOfStringMatcher' => 50, 'TomLingham\Searchy\Matchers\AcronymMatcher' => 42, 'TomLingham\Searchy\Matchers\ConsecutiveCharactersMatcher' => 40, 'TomLingham\Searchy\Matchers\StartOfWordsMatcher' => 35, 'TomLingham\Searchy\Matchers\StudlyCaseMatcher' => 32, 'TomLingham\Searchy\Matchers\InStringMatcher' => 30, 'TomLingham\Searchy\Matchers\TimesInStringMatcher' => 8, ];
Levenshtein搜索驱动器(实验性)
Levenshtein搜索驱动器使用Levenshtein距离计算字符串之间的“距离”。它要求您在MySQL中有一个类似以下的存储过程:levenshtein(string1, string2)。在res文件夹中有一个适合的函数的SQL文件 - 欢迎使用。
protected $matchers = [ 'TomLingham\Searchy\Matchers\LevenshteinMatcher' => 100 ];
匹配器
ExactMatcher
匹配完全相同的字符串,并应用高乘数以使任何完全匹配的条目位于顶部。
StartOfStringMatcher
匹配以搜索字符串开头的字符串。例如,搜索“hel”会匹配“Hello World”或“helping hand”。
AcronymMatcher
匹配类似于缩写的字符串,但不返回PascalCase的匹配结果。例如,搜索“fb”会匹配“foo bar”或“Fred Brown”,但不会匹配“FreeBeer”。
ConsecutiveCharactersMatcher
匹配包含搜索字符串中所有字符的字符串,这些字符在字符串中相对位置。它还计算字符串中匹配字符的百分比,并相应地应用乘数。
例如,搜索“fba”会匹配“Foo Bar”或“Afraid of bats”,但不会匹配“fabulous”。
StartOfWordsMatcher
匹配搜索中的每个单词的开头与单词中的每个单词进行匹配。
例如,搜索“jo ta”会匹配“John Taylor”或“Joshua B. Takeshi”。
StudlyCaseMatcher
使用单词的第一个字母来匹配PascalCase字符串。
例如,搜索“hp”会匹配“HtmlServiceProvider”或“HashParser”,但不会匹配“hasProvider”。
InStringMatcher
匹配字符串内部任何出现的字符串,且不区分大小写。
例如,搜索 'smi' 会匹配;'John Smith' 或 'Smiley Face'
TimesInStringMatcher
根据搜索字符串在字符串中出现的次数来匹配字符串,并对每个出现应用乘数。例如,搜索 'tha' 会匹配;'I hope that that cat has caught that mouse'(3 倍乘数)或 'Thanks, it was great!'(1 倍乘数)
LevenshteinMatcher
参见 Levenshtein 驱动程序
扩展
驱动器
自定义搜索驱动程序非常简单。只需创建一个扩展 TomLingham\Searchy\SearchDrivers\BaseSearchDriver 的类,并添加一个名为 $matchers 的属性,其值为一个匹配器类的数组作为键,以及每个匹配器的乘数作为值。您可以从中选择与 Searchy 一起包含的类,也可以创建自己的类。
匹配器
要创建自己的匹配器,可以创建一个扩展 TomLingham\Searchy\Matchers\BaseMatcher 的类,并且(对于简单的匹配器)覆盖 formatQuery 方法以返回带有 % 通配符的字符串(在需要的位置格式化)。对于更高级的扩展,您可能还需要覆盖 buildQuery 方法和其他方法。
贡献 & 报告错误
如果您想改进这里的代码,请随时提交拉取请求。
如果您发现任何错误,请在此处提交,我会尽快回应。请确保提供尽可能多的信息。