生成和定制Rails生成器和模板 Creating and Customizing Rails Generators & Templates

简介: 生成和定制Rails生成器和模板 Creating and Customizing Rails Generators & Templates

本文英文原文来自:

http://edgeguides.rubyonrails.org/generators.html


花了两个小时左右将这篇文章译为中文,因为有一些词不是很明确,作为刚刚学习Ruby on Rails的人,只好求大家帮忙在回复里面修改了。


Creating and Customizing Rails Generators & Templates

生成和定制Rails生成器和模板

Rails generators are an essential tool if you plan to improve your workflow. With this guide you will learn how to create generators and customize existing ones.

Rails生成器是一个核心的工具,它可以提高你的工作流。这个向导就是教你创建生成器和定制已有的生成器的。


在这个指南中,你可以:

Learn how to see which generators are available in your application


学习查看你的应用程序里面哪一个生成器是可用的。

Create a generator using templates


使用模板创建一个生成器。

Learn how Rails searches for generators before invoking them


学习Rails在调用生成器前怎样寻找它们。

Customize your scaffold by creating new generators


通过创建生成器定制你的脚手架。

Customize your scaffold by changing generator templates


通过修改生成器模板,定制你的脚手架。

Learn how to use fallbacks to avoid overwriting a huge set of generators


学习怎样使用回退来避免修改一组大量的生成器。

Learn how to create an application template


学习怎样创建一个应用模板。

此指南基于Rails 3,以前的版本不包含在内。


1第一次接触


你使用rails命令建立应用程序时,实际上你使用了Rails的生成器,然后,只要调用rails generate,你会得到可用的生成器列表:

$ rails new myapp
$ cd myapp
$ rails generate

你可以查看Rails生成的所有可用的生成器列表。举例来说,如果你需要helper生成器的详细描述,可以输入:


$ rails generate helper --help


2创建你的第一个生成器


从Rails 3.0开始,生成器基于Thor(http://github.com/wycats/thor)创建。Thor提供了强大的转换选项,以及强大的文件处理API。例如,建立一个生成器,在目录config/initializers生成名为initializer.rb的初始化文件。


第一步是建一个文件lib/generators/initializer_generator.rb,内容如下:

class InitializerGenerator < Rails::Generators::Base
def create_initializer_file
create_file "config/initializers/initializer.rb", "# Add initialization content here"
end


注:create_file是Thor::Actions提供的一个方法,关于它的解释文档和其他相关材料,请见rdoc.infohttp://rdoc.info/github/wycats/thor/master/Thor/Actions

我们的新生成器极其简单:继承自Rails::Generators::Base,有一个方法definition。在生成器被执行时,它里面的每个公共方法都会被执行。


最后,我们调用方法create_file,这将建立一个文件,内容和位置是我们定义的。如果你熟悉Rails Application Templates API,你也会立刻熟悉新的generators API。


调用新的生成器,只需要运行:

$ rails generate initializer


在我们继续之前,让我们看我们全新的生成器描述:

$ rails generate initializer --help


如果一个生成器有命名空间,如同:ActiveRecord::Generators::ModelGenerator一样,Rails通常可以生成完好的描述,但是这种特殊的情况不行。


我们可以用两种方法解决这个问题。一种是在生成器里调用desc:

class InitializerGenerator < Rails::Generators::Base
desc "This generator creates an initializer file at config/initializers"
def create_initializer_file
create_file "config/initializers/initializer.rb", "# Add initialization content here"
end

现在我们在新生成器上使用--help选项可以看到新的描述。第二种加描述的方法是在。在生成器相同的目录里创建一个名为USAGE的文件. 我们准备在下一步这样做。


3用生成器建立生成器


生成器自己也有生成器:

$ rails generate generator initializer
create lib/generators/initializer
create lib/generators/initializer/initializer_generator.rb
create lib/generators/initializer/USAGE
create lib/generators/initializer/templates

这是刚生成的生成器:

class InitializerGenerator < Rails::Generators::NamedBase
source_root File.expand_path("../templates", __FILE__)
end

首先,注意我们是从Rails::Generators::NamedBase继承了一个类,不是从Rails::Generators::Base。就是说我们的生成器需要至少一个初始化名称的参数,参数名name,在程序中可用。


调用这个新的生成器的描述(别忘了删除旧的生成器文件),我们可以看到:

$ rails generate initializer --help
Usage:
rails generate initializer NAME [options]


也可以看见生成器有一个source_root类方法,它指向生成器模板放置的地方,默认是已经存在的目录:

lib/generators/initializer/templates。
In order to understand what a generator template means,


为了理解生成器模板的含义,我们创建文件

lib/generators/initializer/templates/initializer.rb,内容如下:
# Add initialization content here


现在修改生成器,在调用时拷贝这个模板:

class InitializerGenerator < Rails::Generators::NamedBase
source_root File.expand_path("../templates", __FILE__)
def copy_initializer_file
copy_file "initializer.rb", "config/initializers/#{file_name}.rb"
end
end


运行生成器:

$ rails generate initializer core_extensions


我们可以看到现在一个叫core_extensions的初始化器,用我们的模板的内容,在config/initializers/core_extensions.rb创建了。意味着,源代码里的copy_file确实拷贝了一个文件到给定的目的地址。file_name方法在我们继承了Rails::Generators::NamedBase后,自动生成了。


这些生成器可用的方法在这个指南的最后一章有介绍。


4生成器查找


你运行rails generate initializer core_extensions时,Rails需要按次序查找以下文件,直到找到一个:

rails/generators/initializer/initializer_generator.rb
generators/initializer/initializer_generator.rb
rails/generators/initializer_generator.rb
generators/initializer_generator.rb


如果没找到,就会有错误提示。

上述例子将文件放到应用的库下因为那些目录属于$LOAD_PATH。?


5 定制你的工作流


Rails自身的生成器可灵活定制脚手架,在config/application.rb中修改。


这里是些默认的:

config.generators do |g|
g.orm :active_record
g.template_engine :erb
g.test_framework :test_unit, :fixture => true
end

在定制工作流之前,我们先看看我们的脚手架是什么样子:

$ rails generate scaffold User name:string
invoke active_record
create db/migrate/20091120125558_create_users.rb
create app/models/user.rb
invoke test_unit
create test/unit/user_test.rb
create test/fixtures/users.yml
route resources :users
invoke scaffold_controller
create app/controllers/users_controller.rb
invoke erb
create app/views/users
create app/views/users/index.html.erb
create app/views/users/edit.html.erb
create app/views/users/show.html.erb
create app/views/users/new.html.erb
create app/views/users/_form.html.erb
invoke test_unit
create test/functional/users_controller_test.rb
invoke helper
create app/helpers/users_helper.rb
invoke test_unit
create test/unit/helpers/users_helper_test.rb
invoke stylesheets
create public/stylesheets/scaffold.css

从这个输出可以看出,生成器在Rails3和之前是怎样工作的。脚手架生成器实际不生成什么,只是调用其它的生成器。这使我们可以增删改这些请求。比如,脚手架生成器调用scaffold_controller生成器,scaffold_controller调用erb,test_unit和helper生成器。因为每一个生成器有单独的任务,就容易复用,也避免了复制代码。


我们的第一个自定义工作流,将停止生成stylesheet,测试脚手架紧固(fixture),我们可以通过改变配置得到如下:

config.generators do |g|
g.orm :active_record
g.template_engine :erb
g.test_framework :test_unit, :fixture => false
g.stylesheets false
end

如果我们用这个脚手架生成器生成另一个源代码,我们可以看到不再有stylesheet或者fixture生成了。如果想更加深度定制的话,比如不用Active Record and TestUnit,用DataMapper和Rspec,只要增加他们的gems到你的应用程序里,并配置生成器。


为了示范一下,我们准备建立一个新的helper生成器,简单的加一些实例变量读取。首先在rails命名空间建立一个生成器,rails将以此为提示在这里查找生成器:


$ rails generate generator rails/my_helper

然后可以从新生成器中删除模板目录和source_root类方法,因为不需要了。我们的新生成器就像以下:

class Rails::MyHelperGenerator < Rails::Generators::NamedBase
def create_helper_file
create_file "app/helpers/#{file_name}_helper.rb", <<-FILE
module #{class_name}Helper
attr_reader :#{plural_name}, :#{plural_name.singularize}
end
FILE
end
end

我们为用户建立一个helper,试试新的生成器:


$ rails generate my_helper products

在app/helpers将建立如下helper文件:

module ProductsHelper
attr_reader :products, :product
end

正如预期。再次编辑config/application.rb,我们现在可以告诉脚手架用新的helper生成器:

config.generators do |g|
g.orm :active_record
g.template_engine :erb
g.test_framework :test_unit, :fixture => false
g.stylesheets false
g.helper :my_helper
end

调用生成器时,看到它的动作:

$ rails generate scaffold Post body:text
[...]
invoke my_helper
create app/helpers/posts_helper.rb

注意,我们可以看到,在输出中我们的新helper调用了,而不是Rails的默认调用。不过有一点漏掉了,是新生成器测试,要做到这一点,我们要重新使用旧helper测试生成器。

从Rails3.0后,由于挂钩的概念,这是很容易做到的。我们的新的helper并不需要着重在特定的测试框架,它可以简单地提供一个钩子和一个执行这个钩子的测试框架,以便兼容。


我们可以这样做:

class Rails::MyHelperGenerator < Rails::Generators::NamedBase
def create_helper_file
create_file "app/helpers/#{file_name}_helper.rb", <<-FILE
module #{class_name}Helper
attr_reader :#{plural_name}, :#{plural_name.singularize}
end
FILE
end
hook_for :test_framework
end

现在当调用helper生成器,TestUnit配置成测试框架,它会尝试调用:


Rails::TestUnitGenerator and TestUnit::MyHelperGenerator。因为这两个都没有定义,所以我们可以告诉我们自定义的生成器,调用TestUnit::Generators::HelperGenerator。只需要添加:

# Search for :helper instead of :my_helper
hook_for :test_framework, :as => :helper

现在你可以为其它资源再次运行脚手架并看到它也生成了测试!

6用修改模板定制你的工作流

在以上的步骤中,我们仅想加一行到已经生成了的helper,没有任何多出来的功能。要加新功能也很简单,将已有的生成器模板替换掉,在这个例子里是:


Rails::Generators::HelperGenerator.

在Rails 3.0后,生成器不只在源代码root里寻找模板,也在其它路径里寻找,比如lib/templates。


我们想定制Rails::Generators::HelperGenerator,只需用helper.rb的名字,在lib/templates/rails/helper做一个模板拷贝,内容如下:

module <%= class_name %>Helper
attr_reader :<%= plural_name %>, <%= plural_name.singularize %>
end


还原在config/application.rb的最后一个更改:

config.generators do |g|
g.orm :active_record
g.template_engine :erb
g.test_framework :test_unit, :fixture => false
g.stylesheets false
end



如果你生成另一个资源,可以看到确实得到了同样的结果!如果你想定制你的脚手架模板和布局,这就派上用场了,只需要在lib/templates/erb/scaffold创建edit.html.erb, index.html.erb等等。


目录
相关文章
|
存储 监控 安全
【深入探究C++日志库写入策略】glog、log4cplus与spdlog的写入策略比较
【深入探究C++日志库写入策略】glog、log4cplus与spdlog的写入策略比较
1115 0
|
设计模式 C语言
【设计模式】 工厂模式介绍及C代码实现
工厂模式是一种创建型设计模式,它提供一种通用的接口来创建对象,但是让子类决定实例化哪个类。工厂模式将对象的创建过程封装在一个工厂类中,避免直接调用构造函数,提高代码的灵活性和可维护性。工厂模式实现了依赖倒置原则,即面向接口编程而不是面向实现编程。在工厂模式中,有一个抽象工厂接口,定义了工厂类应该实现的方法,以及一组产品接口,定义了工厂类应该创建的产品的通用行为。具体的工厂类实现了抽象工厂接口,用于创建具体的产品对象。工厂模式可以分为三种不同的类型:简单工厂模式、工厂方法模式和抽象工厂模式。
561 0
【设计模式】 工厂模式介绍及C代码实现
|
关系型数据库 MySQL Linux
Docker 安装 MySQL8.0
Docker 安装 MySQL8.0
6468 0
|
测试技术 区块链
以太坊根据ERC20标准开发代币
以太坊ERC20代币开发首先需要对以太坊,代币,ERC20,智能合约等以太坊代币开发中的基本概念有了解。根据我们的示例代码就可以发行自己的以太坊代币。 什么是ERC20 可以把ERC20简单理解成以太坊上的一个代币协议,所有基于以太坊开发的代币合约都遵守这个协议。
1916 0
|
5天前
|
人工智能 安全 API
CoPaw:5分钟部署你的 AI助理
源自阿里巴巴开源生态的个人 AI 助理——CoPaw。作为阿里倾力打造的开源力作,CoPaw 完美打通钉钉、飞书、Discord 等多平台对话通道,支持定时任务自动化。内置 PDF/Office 深度处理、新闻摘要等强大技能,更开放自定义扩展接口。坚持数据全程私有化部署,绝不上传云端,让每一位用户都能在大厂技术加持下,拥有安全、专属的智能助手。
|
8天前
|
人工智能 自然语言处理 JavaScript
2026年Windows+Ollama本地部署OpenClaw保姆级教程:本地AI Agent+阿里云上快速搭建
2026年OpenClaw凭借本地部署、私有化运行的特性,成为打造个人智能体的核心工具,而Ollama作为轻量级本地大模型管理工具,能让OpenClaw摆脱对云端大模型的依赖,实现**本地推理、数据不泄露、全流程私有化**的智能体验。本文基于Windows 11系统,从硬件环境准备、Ollama安装与模型定制、OpenClaw部署配置、技能扩展到常见问题排查,打造保姆级本地部署教程,同时补充阿里云OpenClaw(Clawdbot)快速部署步骤,兼顾本地私有化需求与云端7×24小时运行需求,文中所有代码命令均可直接复制执行,确保零基础用户也能快速搭建属于自己的本地智能体。
9418 76
|
6天前
|
人工智能 安全 JavaScript
阿里云上+本地部署OpenClaw(小龙虾)新手攻略:解锁10大必备Skills,零基础也能玩转AI助手
2026年,开源AI代理工具OpenClaw(昵称“小龙虾”)凭借“能实际做事”的核心优势,在GitHub斩获25万+星标,成为现象级AI工具。它最强大的魅力在于可扩展的Skills(技能包)系统——通过ClawHub插件市场的数百个技能,能让AI助手从简单聊天升级为处理办公、学习、日常事务的全能帮手。
4809 13
|
7天前
|
人工智能 自然语言处理 机器人
保姆级教程:Mac本地搭建OpenClaw及阿里云上1分钟部署OpenClaw+飞书集成实战指南
OpenClaw(曾用名Clawdbot、Moltbot)作为2026年最热门的开源个人AI助手平台,以“自然语言驱动自动化”为核心,支持对接飞书、Telegram等主流通讯工具,可替代人工完成文件操作、日历管理、邮件处理等重复性工作。其模块化架构适配多系统环境,既可以在Mac上本地化部署打造私人助手,也能通过阿里云实现7×24小时稳定运行,完美兼顾隐私性与便捷性。
4936 11
|
9天前
|
人工智能 JSON JavaScript
手把手教你用 OpenClaw + 飞书,打造专属 AI 机器人
手把手教你用 OpenClaw(v2026.2.22-2)+ 飞书,10分钟零代码搭建专属AI机器人!内置飞书插件,无需额外安装;支持Claude等主流模型,命令行一键配置。告别复杂开发,像聊同事一样自然对话。
5242 13
手把手教你用 OpenClaw + 飞书,打造专属 AI 机器人