首页
/ Query Diet 技术文档

Query Diet 技术文档

2024-12-20 13:13:07作者:乔或婵

1. 安装指南

在 Gemfile 中添加以下代码:

gem 'query_diet', group: :development

然后执行 bundle install 命令安装依赖。

2. 项目的使用说明

Query Diet 用于统计上一次请求的数据库查询次数,并在屏幕右上角以直观的方式显示。如果查询次数过多或查询时间过长,显示的颜色会变为红色。这有助于防止代码中出现 N + 1 查询问题。

  • 当查询次数较少,时间较短时,Query Diet 显示为高兴的状态:

Query Diet 技术文档

  • 当查询次数过多,时间过长时,Query Diet 显示为生气的状态:

Query Diet 技术文档

在开发环境中,将以下代码添加到应用程序布局中:

# app/views/layout/application.html.erb
# ...
<body>
  <%= query_diet_widget if Rails.env.development? %>
  <%= yield %>
</body>

我们建议您仅在开发环境中使用此 gem。

3. 项目API使用文档

  • query_diet_widget:用于在页面中显示 Query Diet 小部件。

    参数:

    • bad_count:查询次数超过此值时,显示警告(默认值为 8)。
    • bad_time:查询时间超过此值(毫秒)时,显示警告(默认值为 5000)。
    • nonce:是否为样式和脚本标签使用 nonce(默认为 false)。

    示例:

    <%= query_diet_widget(:bad_count => 4, :bad_time => 2000) %>
    

    如果需要使用 nonce,可以在内容安全策略配置文件中设置:

    Rails.application.config.content_security_policy_nonce_directives = %w[script-src style-src]
    

    如果不使用 nonce,但需要使用样式标签,可以设置:

    Rails.application.config.content_security_policy do |policy|
      policy.style_src   :self, :unsafe_inline
    end
    

4. 项目安装方式

请遵循以下步骤安装 Query Diet:

  1. 在 Gemfile 中添加 gem 'query_diet', group: :development
  2. 执行 bundle install 命令安装依赖。
  3. 在应用程序布局中添加 <%= query_diet_widget if Rails.env.development? %> 代码。
  4. 根据需要配置内容安全策略。
登录后查看全文
热门项目推荐