Filterrific：Rails 过滤引擎插件中文指南

Filterrific：Rails 过滤引擎插件中文指南

filterrificFilterrific is a Rails Engine plugin that makes it easy to filter, search, and sort your ActiveRecord lists.项目地址:https://gitcode.com/gh_mirrors/fi/filterrific

---

项目介绍

Filterrific 是一个专为 Ruby on Rails 设计的插件，它极大地简化了在 ActiveRecord 列表中添加过滤、搜索和排序功能的过程。此插件允许应用程序用户搜索、过滤并按需对记录列表进行排序。Filterrific 支持多种响应格式（如 HTML、JS、JSON 和 XML），并通过 ActiveRecord 范围来构建数据库查询，确保高效的数据处理。用户可以保存过滤设置，并且开发者仅需定义必要的 ActiveRecord 范围以及设计过滤表单和记录列表样式。

项目快速启动

要迅速开始使用 Filterrific，请遵循以下步骤：

步骤一：添加至你的 Rails 应用

首先，在你的 Gemfile 中加入 Filterrific 依赖：

gem 'filterrific'

然后执行 bundle install 来安装该gem。

步骤二：集成到模型

假设你想为学生列表添加过滤功能，打开 app/models/student.rb 并使用 filterrific 方法配置：

class Student < ApplicationRecord
  # ...
  filterrific(
    default_filter_params: { sorted_by: 'created_at_desc' },
    available_filters: [
      :sorted_by, 
      :search_query, 
      :with_country_id,
      :with_created_at_gte
    ]
  )

  # 定义对应的 ActiveRecord 范围方法
  scope :sorted_by, ->(sort_option) { order(sort_option) }
  scope :search_query, ->(query) { where("name LIKE ?", "%#{query}%") }
  # 添加其他必要范围方法以对应配置中的 filters
end

步骤三：创建控制器和视图

在控制器中集成 Filterrific：

class StudentsController < ApplicationController
  load_and_authorize_resource
  filterrific管理水平: [:sorted_by, :search_query, :with_country_id, :with_created_at_gte]

  def index
    @students = @filtered_students || begin
      scoped_students = Student.all
      apply_filterrific(scoped_students, params[:filterrific]) unless params[:filterrific].blank?
      scoped_students
    end
    render :index
  end
end

然后在视图中创建过滤器表单和记录列表展示。

应用案例和最佳实践

为了最大化利用 Filterrific，你可以：

• 在复杂的管理界面中，实现动态筛选逻辑，提高用户体验。
• 结合 AJAX 实现无刷新页面更新，提升交互流畅性。
• 使用 Filterrific 的持久化特性，让用户能够保存他们的偏好设置。

示例代码片段

在视图中添加一个基本过滤器表单：

<%= form_tag students_path, method: :get, id: "filterrific_form" do %>
  <%= select_tag 'filterrific[sorted_by]', options_for_select([
    ['最近创建', 'created_at_desc'],
    ['最早创建', 'created_at_asc']
  ], @filterrific[:sorted_by]) %>

  <%= text_field_tag 'filterrific[search_query]' %>

  <!-- 其他过滤选项的输入字段 -->

  <%= submit_tag "Filter", name: nil %>
<% end %>
<!-- 显示记录列表 -->
<% @students.each do |student| %>
  <!-- 学生信息展示 -->
<% end %>

典型生态项目

虽然Filterrific本身是针对Ruby on Rails的，但它可以与各种前端技术栈结合使用，例如官方文档中提到的React+MobX示例，展示了如何构建支持JSON API的实时过滤界面。对于想要扩展其功能或与其他库整合的项目，社区贡献和Stack Overflow上的“filterrific”标签是一个丰富的资源库，提供了大量实际应用场景和解决方案。

---

通过以上步骤，你可以快速将Filterrific集成到你的Rails应用中，提供强大而灵活的数据过滤能力。记得查看其GitHub仓库和官方文档以获取最新信息和进一步的定制指南。

filterrificFilterrific is a Rails Engine plugin that makes it easy to filter, search, and sort your ActiveRecord lists.项目地址:https://gitcode.com/gh_mirrors/fi/filterrific