RefineryCMS模型扩展指南：使用装饰器增强核心功能-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00829/article/details/148552016

RefineryCMS模型扩展指南：使用装饰器增强核心功能

refinerycms refinery/refinerycms: Refinery CMS 是一个基于 Ruby on Rails 构建的内容管理系统，为非技术用户提供直观易用的后台管理界面，方便他们添加、编辑和管理网站内容。项目地址: https://gitcode.com/gh_mirrors/re/refinerycms

前言

在RefineryCMS开发过程中，我们经常会遇到需要扩展核心模型功能的需求。本文将深入讲解如何使用装饰器(Decorator)模式来安全地扩展RefineryCMS的模型，而不需要直接修改核心代码。这种方法既保持了系统的可升级性，又能满足个性化需求。

装饰器模式简介

装饰器是一种设计模式，它允许在不修改原有类的情况下动态地扩展对象功能。在RefineryCMS中，装饰器被广泛用于扩展核心模型和控制器。

为什么使用装饰器？

避免直接修改核心代码：直接修改核心模型会导致升级困难
保持代码整洁：扩展功能与核心功能分离
灵活性高：可以随时添加或移除装饰器

实战：为页面添加背景图片功能

让我们通过一个实际案例来学习如何扩展RefineryCMS的Page模型，为其添加背景图片功能。

第一步：创建数据库迁移

任何模型字段的添加都需要相应的数据库变更。我们首先创建一个迁移：

rails g migration AddBackgroundImageToRefineryPages background_image_id:integer

生成的迁移文件应包含以下内容：

class AddBackgroundImageToRefineryPages < ActiveRecord::Migration
  def change
    add_column :refinery_pages, :background_image_id, :integer
  end
end

关键点说明：

:refinery_pages 是Page模型对应的数据库表名
:background_image_id 是我们添加的外键字段，关联到Refinery::Image

执行迁移：

rake db:migrate

第二步：创建模型装饰器

在decorators/models/refinery目录下创建page_decorator.rb文件：

Refinery::Page.class_eval do
  belongs_to :background_image, class_name: '::Refinery::Image'
end

代码解析：

class_eval方法允许我们"重新打开"Refinery::Page类
我们添加了一个belongs_to关联，指向Refinery::Image模型
::Refinery::Image中的双冒号确保从根命名空间查找Image类

第三步：扩展控制器参数白名单

为了能让后台接收background_image_id参数，我们需要扩展PagesController：

在decorators/controllers/refinery/admin下创建pages_controller_decorator.rb：

Refinery::Admin::PagesController.class_eval do
  def page_params_with_my_params
    page_params_without_my_params.merge(params.require(:page).permit(:background_image_id))
  end
  alias_method_chain :page_params, :my_params
end

技术细节：

alias_method_chain是Rails提供的方法别名链技术
它创建了两个新方法：page_params_with_my_params和page_params_without_my_params
这样我们既保留了原有参数白名单，又添加了新参数

第四步：添加后台管理界面

生成表单视图覆盖：

rake refinery:override view=refinery/admin/pages/_form

在生成的_form.html.erb中添加图片选择器：

<div class="field">
  <%= f.label :background_image %>
  <%= render partial: "/refinery/admin/image_picker", locals: {
    f: f,
    field: :background_image_id,
    image: f.object.background_image,
    toggle_image_display: false
  } %>
</div>

组件说明：

使用Refinery内置的image_picker部分视图
field参数必须指向外键字段名
image参数传递关联的图片对象

第五步：前端展示

在布局文件或模板中添加CSS样式：

<% content_for :stylesheets do %>
  <% if @page.background_image.present? %>
  <style type="text/css">
    body {
      background-image: url(<%= @page.background_image.url %>);
    }
  </style>
  <% end %>
<% end %>