RailsAdmin如何实现自定义操做

时间 2019-11-13

标签 railsadmin 如何实现自定义繁體版

原文原文链接

前言

作过Ruby开发或者更准确的说Ruby on Rails开发的同窗，对RailsAdmin必定不会陌生。RailsAdmin能够快速的帮助您构建后台管理系统。丰富的gem集成以及便捷的搭建使得RailsAdmin成为web开发中必不可少的组成部分。另外经过RailsAdmin你也能够很是强烈的感觉到敏捷开发的魅力所在，以及如何快速的帮助客户解决问题，快速搭建原型系统，知足客户需求。html

RailsAdmin当然已经很是的便捷，但有时不能知足咱们的需求，此时就须要咱们自定义一些操做，扩展RailsAdmin的功能。前端

本文主要介绍在RailsAdmin中如何自定义操做(custom action)，因为国内ruby及rails中文资料不是特别丰富，若是您从事ruby开发，那么本文可能对您会有必定的帮助。git

整体思路

对于教程，我我的比较倾向的一种思路是，先介绍整体流程，让用户对其有个总体印象，而后详细的介绍每一步。这种方式使得用户可以很是轻松的接受，遇到问题若是出现问题也能很好的定位问题出如今哪一阶段。github

咱们如何在RailsAdmin中实现自定义操做呢？主要有如下几个关键步骤：web

定义和实现咱们的操做并注册到RailsAdmin，让RailsAdmin可以知道该操做的存在；
定义该操做的前端显示页面；
在RailsAdmin配置文件中，使用该操做；

经过上面的三个关键操做就能够完成咱们的自定义操做了。接下来咱们将介绍每一步的具体实现细节。算法

如下描述将基于下述基本约定：shell

当前开发目录为ROOT;
自定义操做名称为demo;

本文咱们实现的自定义操做demo达到的目标是：在member scope中添加demo action，点击demo，前端显示'hello,world'。编程

step0

在Rails开发中，无时无刻不体现着“约定优于配置”。那么咱们自定义操做应该放在哪儿呢？文件如何命名？答案就是以下所示：文件路径为ROOT/lib/rails_admin/；文件的名称即为操做名称即demo.rb;ruby

因此接下来咱们将在该路径建立咱们的自定义操做文件。app

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

引用

若是您对算法或编程感兴趣，欢迎扫描下方二维码并关注公众号“算法与编程之美”，和您一块儿探索算法和编程的神秘之处，给您不同的解题分析思路。