RailsAdmin如何实现自定义操作

Stella981
• 阅读 810

前言

做过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

引用

如果您对算法或编程感兴趣,欢迎扫描下方二维码并关注公众号“算法与编程之美”,和您一起探索算法和编程的神秘之处,给您不一样的解题分析思路。 RailsAdmin如何实现自定义操作

点赞
收藏
评论区
推荐文章
blmius blmius
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
Wesley13 Wesley13
3年前
java将前端的json数组字符串转换为列表
记录下在前端通过ajax提交了一个json数组的字符串,在后端如何转换为列表。前端数据转化与请求varcontracts{id:'1',name:'yanggb合同1'},{id:'2',name:'yanggb合同2'},{id:'3',name:'yang
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
待兔 待兔
4个月前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
Jacquelyn38 Jacquelyn38
3年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
Easter79 Easter79
3年前
Twitter的分布式自增ID算法snowflake (Java版)
概述分布式系统中,有一些需要使用全局唯一ID的场景,这种时候为了防止ID冲突可以使用36位的UUID,但是UUID有一些缺点,首先他相对比较长,另外UUID一般是无序的。有些时候我们希望能使用一种简单一些的ID,并且希望ID能够按照时间有序生成。而twitter的snowflake解决了这种需求,最初Twitter把存储系统从MySQL迁移
Wesley13 Wesley13
3年前
mysql设置时区
mysql设置时区mysql\_query("SETtime\_zone'8:00'")ordie('时区设置失败,请联系管理员!');中国在东8区所以加8方法二:selectcount(user\_id)asdevice,CONVERT\_TZ(FROM\_UNIXTIME(reg\_time),'08:00','0
Stella981 Stella981
3年前
Django中Admin中的一些参数配置
设置在列表中显示的字段,id为django模型默认的主键list_display('id','name','sex','profession','email','qq','phone','status','create_time')设置在列表可编辑字段list_editable
Wesley13 Wesley13
3年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
Python进阶者 Python进阶者
9个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这