Canonica-rails 使用指南

幸俭卉

于 2024-08-25 07:50:39 发布

阅读量577

点赞数 14

本文链接：https://blog.csdn.net/gitblog_00271/article/details/141513483

版权

Canonica-rails 使用指南

canonical-railsQuick and configurable canonical tag to use in Rails views. 项目地址:https://gitcode.com/gh_mirrors/ca/canonical-rails

项目介绍

Canonica-rails 是一个轻量级且配置灵活的 RubyGem，专为 Ruby on Rails 应用设计，旨在解决搜索引擎索引中常见的多个主机名、任意参数导致的链接问题以及尾部斜杠不一致等问题。该gem默认采取保守策略，确保在不对站点结构做大幅度改动的情况下，轻松添加规范URL（Canonical URLs），以优化SEO表现。由作者 jumph4x 开发并维护，兼容 Rails 版本 3.1 及以上，但低于 5.0。

项目快速启动

要快速集成 canonacci-rails 到你的 Rails 应用，遵循以下步骤：

添加到 Gemfile 在你的 Rails 应用的 Gemfile 中加入以下行：
```
gem 'canonical-rails'
```
然后运行 bundle install 来安装这个gem。
生成配置 接着，在终端中执行命令来生成配置文件：
```
rails generate canonical_rails:install
```
这将在 config/initializers 目录下创建 canonical_rails.rb 文件，供你进一步自定义。

在视图中使用 最后，在你的视图中，你需要包括 canonical_tag 帮助方法在HTML头部，像这样：

<%= stylesheet_link_tag 'application', media: 'all' %>
<%= javascript_include_tag 'application' %>
<%= canonical_tag %>

确保这一步骤位于所有其他头部标签之后，以便正确地设置页面的规范URL。

应用案例和最佳实践

当你有动态路由时，正确的处理方式不是在每一个链接上都添加 rel='canonical'，而是在布局文件(application.html.erb)的 <head> 部分采用动态内容的方式提供规范URL。例如：

布局文件修改示例

<head>
  <% if @canonical_url %>
    <%= tag :link, href: @canonical_url, rel: 'canonical' %>
  <% end %>
  ...
</head>

在对应的控制器动作里，你需要指定 @canonical_url 的值，比如：

class EquipmentsController < ApplicationController
  def index
    @equipments = Equipment.all
    @canonical_url = search_equipments_url(category: params[:category])
  end
end

典型生态项目

虽然 canonacci-rails 主打单一功能，它经常与其他关注SEO、性能优化的Rails插件或工具一起被使用，如sitemap_generator用于生成站点地图，或者rack-deflater来启用gzip压缩，从而提高网页加载速度。不过，就其本身而言，canonacci-rails是处理Rails应用内规范URL需求的绝佳选择，无需引入更复杂的生态系统项目，除非特定需求驱使。

通过上述步骤，你可以有效地集成并利用 canonacci-rails 来改善你的Rails应用程序的SEO健康状态，确保搜索引擎能够准确识别和索引你的页面。

canonical-railsQuick and configurable canonical tag to use in Rails views. 项目地址:https://gitcode.com/gh_mirrors/ca/canonical-rails