分頁插件Kaminari

http://www.xingishere.com/blogs/kaminari_gem

Rails 2.x 中最常用的分頁插件是 will_paginate ，這個(gè)相信大家都耳熟能詳

不過到 Rails 3 以后，我發(fā)現(xiàn)一個(gè)更好選擇，那就是??Kaminari

我選擇它，主要是看中其直觀靈活的界面定制功能，它不像 will_paginate 那樣需要配置一大堆參數(shù)，而是采用 view 文件來進(jìn)行配置，非常好用

安裝

很簡單，在 Gemfile 增加一行即可

gem 'kaminari', '~> 0.13.0'

常用法

ActiveRecord

裝了插件以后，你可以在 model 對象上使用 .page() 和 .per() 這兩個(gè)方法，就像 .where() 一樣

• 每頁10個(gè)，取第2頁數(shù)據(jù)

User.page(2).per(10)

• 配合查詢條件語句，取第三頁數(shù)據(jù)，默認(rèn)每頁為25個(gè)

User.where(status: 1).includes(:topics).page(3)

• 如果傳給 .page() 方法的參數(shù)是 nil，則默認(rèn)為1

User.page(params[:page])

View

在頁面上，要顯示分頁的話，用它提供的 helper 方法即可

<%= paginate @users %>

這樣會生成類似?? First ? Prev … 2 3 4 5 6 7 8 9 10 … Next ? Last ??的 html

參數(shù)配置

全局參數(shù)配置

執(zhí)行以下命令，會在 config\initializers 下生成一個(gè)配置文件 kaminari_config.rb

rails g kaminari:config

這個(gè)配置文件控制著 kaminari 的全局設(shè)置，有以下參數(shù)可以進(jìn)行自定義

• default_per_page 缺省情況下的每頁個(gè)數(shù)，默認(rèn)為25
• page_method_name 分頁方法的名稱，如果你怕沖突（比如想很蛋疼地同時(shí)使用 will_paginate），可以修改它
• param_name 分頁參數(shù)的參數(shù)名，默認(rèn)為 param
• window / outer_window / left / right 這四個(gè)參數(shù)都與分頁顯示有關(guān)系，特別是在總頁數(shù)比較多的時(shí)候，該如何顯示

Model 配置

如果統(tǒng)一的 per_page 全局設(shè)置不能滿足你的要求，你希望針對每一種 model 設(shè)置不同的 per_page ，那么可以這樣

class User < ActiveRecord::Base paginates_per 50 end

這樣就省去你在每個(gè) controller 中各自使用 .per() 方法了

I18N 語言

默認(rèn)情況下， kaminari 生成的分頁組件是這個(gè)樣子

如果你想簡單地修改其中的文字的話，可以通過修改相應(yīng)的 locales 語言文件來實(shí)現(xiàn)比如我的配置如下

views:pagination: first: 首頁last: 末頁previous: 上一頁next: 下一頁truncate: ...

分頁界面定制

修改默認(rèn)界面

為了自定義分頁的顯示樣式，首先要生成一些模板文件，執(zhí)行以下命令

rails g kaminari:views default

這樣會創(chuàng)建 app/views/kaminari/ 文件夾，里面的文件就是分頁顯示所需的 view ，你可以修改它們

• _paginator.html.erb??這是總的入口文件，可以通過修改它來調(diào)整顯示的整體結(jié)構(gòu)
  比如我不需要“首頁”，”末頁“這兩個(gè)鏈接，那么我就在這個(gè)文件里面將對應(yīng)的代碼刪除
• _page.html.erb??對應(yīng)頁碼鏈接
• _first_page.html.erb??/??_last_page.html.erb??對應(yīng)“首頁”和“末頁”的鏈接
• _prev_page.html.erb??/??_next_page.html.erb??對應(yīng)“上一頁”和“下一頁”的鏈接
• _gap.html.erb??空隙的顯示，默認(rèn)是中間的省略號(…)

注意文件不要改名，否則入口文件會找不到對應(yīng)的子文件，不過如果你入口文件中將某個(gè)部分的代碼刪除的話，那么相應(yīng)的子文件也可以刪掉

對數(shù)組分頁

上面所述的都是對ActiveRecord分頁，實(shí)際工作中經(jīng)常出現(xiàn)需求對數(shù)組分頁，kaminari是實(shí)現(xiàn)了這個(gè)功能的

Kaminari.paginate_array(a, total_count: 100).page(params[:page]).per(10)

其中total_count是數(shù)據(jù)總數(shù)

theme 功能

以上的方法可以用于修改默認(rèn)的分頁界面，不過如果系統(tǒng)比較復(fù)雜，在不同的地方需要顯示不同的分頁界面該怎么辦？強(qiáng)大的 kaminari 還提供了 theme 的功能，而且實(shí)現(xiàn)很簡單，你只需要在 app/views/kaminari/ 下再新建子文件夾即可

例如我在 app/views/kaminari 下新建了一個(gè)叫做 tiny 的子文件夾，并將外面的文件都拷貝進(jìn)去然后在 view 中這樣寫即可

<%= paginate @blogs, theme: tiny %>

這時(shí)候 kaminari 就會根據(jù) tiny 子文件夾下的 view 來渲染分頁界面了

資源

這是 Klog 項(xiàng)目中所自定義的兩個(gè)分頁界面，分別用于前臺和后臺，供參考

總結(jié)

以上是生活随笔為你收集整理的分页插件Kaminari的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。