Bullet 技术文档

1. 安装指南

要安装 Bullet Gem，您可以选择以下任一方式：

• 使用 Gem 命令安装：

gem install bullet

• 将其添加到 Gemfile 中（推荐使用 Bundler）：

gem 'bullet', group: 'development'

安装后，使用以下命令启用 Bullet：

bundle exec rails g bullet:install

请注意，在 Bundler 中添加 Bullet gem 时，确保它位于 activerecord（Rails）和 mongoid 之后。

2. 项目的使用说明

Bullet Gem 设计用于帮助提高应用程序性能，通过减少其发出的查询数量。在开发过程中，它会监视您的查询，并在以下情况下通知您：

• 当您应该添加急切加载（N+1 查询）时
• 当您使用不必要的急切加载时
• 当您应该使用计数器缓存时

最佳实践是在开发模式或自定义模式（如预发布、分析等）下使用 Bullet。您肯定不希望客户收到关于您工作效率的提醒。

Bullet Gem 支持 activerecord >= 4.0 和 mongoid >= 4.0。如果您使用 activerecord 2.x 或 3.x，请使用相应的 Bullet 版本。

3. 项目API使用文档

Bullet 提供了多种配置选项，以下是一些主要配置：

config.after_initialize do
  Bullet.enable = true
  Bullet.sentry = true
  Bullet.alert = true
  Bullet.bullet_logger = true
  Bullet.console = true
  # 其他配置...
end

您可以通过以下方式禁用特定的探测器：

Bullet.n_plus_one_query_enable = false
Bullet.unused_eager_loading_enable = false
Bullet.counter_cache_enable = false

此外，Bullet 允许您添加安全列表，以忽略特定的查询问题：

Bullet.add_safelist :type => :n_plus_one_query, :class_name => "Post", :association => :comments

如果您想在特定控制器动作中跳过 Bullet，可以这样做：

class ApplicationController < ActionController::Base
  around_action :skip_bullet, if: -> { defined?(Bullet) }
  # ...
end

4. 项目安装方式

请参考上述“安装指南”部分。

以上就是关于 Bullet Gem 的技术文档，通过本文档，您应该能够了解如何安装、配置和使用 Bullet Gem 来优化您的 Rails 应用程序性能。