前言
做过Ruby开发或者更准确的说Ruby on Rails开发的同学,对RailsAdmin一定不会陌生。RailsAdmin可以快速的帮助您构建后台管理系统。丰富的gem集成以及便捷的搭建使得RailsAdmin成为web开发中必不可少的组成部分。另外通过RailsAdmin你也可以非常强烈的感受到敏捷开发的魅力所在,以及如何快速的帮助客户解决问题,快速搭建原型系统,满足客户需求。
RailsAdmin固然已经非常的便捷,但有时不能满足我们的需求,此时就需要我们自定义一些操作,扩展RailsAdmin的功能。
本文主要介绍在RailsAdmin中如何自定义操作(custom action),由于国内ruby及rails中文资料不是特别丰富,如果您从事ruby开发,那么本文可能对您会有一定的帮助。
总体思路
对于教程,我个人比较倾向的一种思路是,先介绍总体流程,让用户对其有个整体印象,然后详细的介绍每一步。这种方式使得用户能够非常轻松的接受,遇到问题如果出现问题也能很好的定位问题出现在哪一阶段。
我们如何在RailsAdmin中实现自定义操作呢? 主要有以下几个关键步骤:
- 定义和实现我们的操作并注册到RailsAdmin,让RailsAdmin能够知道该操作的存在;
- 定义该操作的前端显示页面;
- 在RailsAdmin配置文件中,使用该操作;
通过上面的三个关键操作就可以完成我们的自定义操作了。接下来我们将介绍每一步的具体实现细节。
以下描述将基于下述基本约定:
- 当前开发目录为ROOT;
- 自定义操作名称为demo;
本文我们实现的自定义操作demo达到的目标是:在member scope中添加demo action,点击demo,前端显示'hello,world'。
step0
在Rails开发中,无时无刻不体现着“约定优于配置”。那么我们自定义操作应该放在哪儿呢?文件如何命名?答案就是如下所示: 文件路径为ROOT/lib/rails_admin/; 文件的名称即为操作名称即demo.rb;
所以接下来我们将在该路径创建我们的自定义操作文件。
touch ROOT/lib/rails_admin/demo.rb
接下来我们将介绍一个非常重要的概念就是action scope。你的操作应用到什么地方? RailsAdmin中action scope主要有三种,分别是:root, collection, member。
- root顾名思义就是根操作,和dashboard处于一个层级;
- collection 针对记录集合的操作;
- member 针对某条具体的记录的操作;
本文我们自定义操作的scope就是collection。接下来我们就具体介绍自定义操作的实现。
require 'rails_admin/config/actions/base'
module RailsAdmin
class Demo < RailsAdmin::Config::Actions::Base #Demo操作继承Base
RailsAdmin::Config::Actions.register(self) #RailsAdmin中注册demo操作
register_instance_option :collection do #设置其action scope为member
true
end
end
end
step1
我们在什么地方定义我们的前端显示文件?答案就是: ROOT/app/view/rails_admin/main/demo.html.erb 我们的前端模板可以使用erb, haml, slim等,至于模板语言如何使用,这并非本文描述的重点。 所以我们的前端文件显示非常的简单,直接打印"hello,world"即可。。
<!-- File: demo.html.erb -->
<p> hello, world! </p>
step2
至此,我们的自定义操作的定义,以及前端显示都已经完成,接下来就是如何使用该自定义操作了。
我们打开ROOT/config/initializers/rails_admin.rb文件。
- 引入我们的自定义操作文件;
- 在哪个model中使用该操作;
如何引入?
require 'rails_admin/demo'
如何使用demo action?
我们希望demo操作只应用于User Model中,所以在config.actions中配置。
config.actions do
demo do
only 'User'
end
end
总结
本文主要介绍了如何在RailsAdmin中创建自定义操作,先从总体上描述了大致思路,然后逐步的介绍其实现细节。RailsAdmin已经成为web开发中必不可少的组成部分,通过自定义操作扩展其功能已是不可避免,所以本文具有一定的参考借鉴价值。
没有rails环境怎么办?如何快速的体验本文的一些操作?答案就在这里:http://my.oschina.net/gschen/blog/346322,该博客介绍了如何快速的搭建你的rails开发环境。
本文介绍的只是简单的自定义操作,可以帮助您快速的上手,后续博客将逐步深入的介绍更多的自定义操作用法。
代码
https://github.com/gschen/rails_admin_custom_action_demo
引用
- http://blog.endpoint.com/2012/01/import-railsadmin.html
- http://blog.endpoint.com/2012/03/railsadmin-custom-action-case-study.html
如果您对算法或编程感兴趣,欢迎扫描下方二维码并关注公众号“算法与编程之美”,和您一起探索算法和编程的神秘之处,给您不一样的解题分析思路。