如何用 Laravel Query Builder 快速实现用户搜索过滤功能

如何用 Laravel Query Builder 快速实现用户搜索过滤功能

【免费下载链接】laravel-query-builderEasily build Eloquent queries from API requests项目地址: https://gitcode.com/gh_mirrors/la/laravel-query-builder

Laravel Query Builder 是一款强大的工具，能帮助开发者轻松地从 API 请求构建 Eloquent 查询，实现高效的用户搜索过滤功能。它提供了简洁的语法和丰富的功能，让开发者可以快速搭建起灵活的搜索过滤系统。

快速上手：安装与配置

要开始使用 Laravel Query Builder，首先需要通过 Composer 进行安装。在项目根目录下执行以下命令：

composer require spatie/laravel-query-builder

安装完成后，你可以在配置文件中对其进行进一步的设置。配置文件位于 config/query-builder.php，你可以在这里定义全局的过滤规则、排序方式等。

核心功能：allowedFilters、allowedSorts 与 allowedFields

Laravel Query Builder 提供了三个核心方法来实现搜索过滤功能：

allowedFilters：定义允许的过滤条件

通过allowedFilters方法，你可以指定哪些字段允许被过滤。例如，如果你想允许对用户的姓名和邮箱进行过滤，可以这样设置：

QueryBuilder::for(User::class) ->allowedFilters(['name', 'email']) ->get();

allowedSorts：定义允许的排序字段

使用allowedSorts方法，你可以指定哪些字段允许被排序。例如，允许按照创建时间和更新时间进行排序：

QueryBuilder::for(User::class) ->allowedSorts(['created_at', 'updated_at']) ->get();

allowedFields：定义允许返回的字段

allowedFields方法可以让你指定 API 响应中允许返回的字段，从而减少不必要的数据传输：

QueryBuilder::for(User::class) ->allowedFields(['id', 'name', 'email']) ->get();

实战示例：构建用户搜索过滤 API

下面我们通过一个实际的例子来展示如何使用 Laravel Query Builder 构建用户搜索过滤 API。

首先，创建一个控制器，并在其中使用 QueryBuilder：

use Spatie\QueryBuilder\QueryBuilder; use App\Models\User; class UserController extends Controller { public function index(Request $request) { $users = QueryBuilder::for(User::class, $request) ->allowedFilters(['name', 'email', 'role']) ->allowedSorts(['name', 'created_at']) ->allowedFields(['id', 'name', 'email', 'role', 'created_at']) ->paginate(); return response()->json($users); } }

在这个例子中，我们允许对用户的姓名、邮箱和角色进行过滤，允许按照姓名和创建时间进行排序，并指定了返回的字段。

然后，你可以通过发送 HTTP 请求来使用这个 API。例如，要搜索姓名包含 "john" 且角色为 "admin" 的用户，并按照创建时间降序排序，可以发送如下请求：

GET /api/users?filter[name]=john&filter[role]=admin&sort=-created_at

高级用法：自定义过滤逻辑

除了基本的过滤功能，Laravel Query Builder 还支持自定义过滤逻辑。你可以创建自定义的过滤器来处理复杂的过滤需求。

自定义过滤器的代码通常位于 src/Filters/ 目录下。例如，你可以创建一个FiltersAgeRange过滤器来处理年龄范围的过滤：

use Spatie\QueryBuilder\Filters\Filter; use Illuminate\Database\Eloquent\Builder; class FiltersAgeRange implements Filter { public function __invoke(Builder $query, $value, string $property) { list($min, $max) = explode(',', $value); $query->whereBetween('age', [(int)$min, (int)$max]); } }

然后在控制器中使用这个自定义过滤器：

QueryBuilder::for(User::class) ->allowedFilters([ 'name', 'email', AllowedFilter::custom('age_range', new FiltersAgeRange()) ]) ->get();

这样，你就可以通过发送filter[age_range]=18,30来过滤年龄在 18 到 30 岁之间的用户了。

总结

Laravel Query Builder 是一款功能强大且易于使用的工具，它可以帮助你快速实现高效的用户搜索过滤功能。通过allowedFilters、allowedSorts和allowedFields等方法，你可以轻松地构建灵活的 API，满足各种搜索过滤需求。无论是简单的字段过滤还是复杂的自定义逻辑，Laravel Query Builder 都能为你提供支持，让你的开发工作更加高效和便捷。

【免费下载链接】laravel-query-builderEasily build Eloquent queries from API requests项目地址: https://gitcode.com/gh_mirrors/la/laravel-query-builder