Rails active_model_serializer与分页

Question

我正在使用active_model_serializer。现在我想用分页序列化一个对象，我应该在控制器或串行器中进行分页逻辑吗？

如果我选择在序列化程序中进行分页，我需要将page_number和per_page传递给序列化程序。我该怎么办？我的理解是序列化程序只接受模型对象。

Answer 1

一次性使用解决方案

常规序列化程序仅涉及单个项目 - 而不是分页列表。添加分页的最直接方法是在控制器中：

customers = Customer.page(params[:page])
respond_with customers, meta: {
  current_page: customers.current_page,
  next_page: customers.next_page,
  prev_page: customers.prev_page,
  total_pages: customers.total_pages,
  total_count: customers.total_count
}

可重复使用的解决方案

但是，如果您需要多个对象的分页逻辑，这将非常繁琐。通过查看active_model_serializers的文档，您会遇到ArraySerializer来序列化对象数组。我所做的是使用pagination_serializer.rb创建ArraySerializer以自动为分页数组添加元标记：

# my_app/app/serializers/pagination_serializer.rb
class PaginationSerializer < ActiveModel::Serializer::ArraySerializer
  def initialize(object, options={})
    meta_key = options[:meta_key] || :meta
    options[meta_key] ||= {}
    options[meta_key][:pagination] = {
      current_page: object.current_page,
      next_page: object.next_page,
      prev_page: object.prev_page,
      total_pages: object.total_pages,
      total_count: object.total_count
    }
    super(object, options)
  end
end

将PaginationSerializer添加到您的rails应用程序后，您只需在控制器中需要分页元标记时调用它：

customers = Customer.page(params[:page])
respond_with customers, serializer: PaginationSerializer

注意：我写这篇文章是为了使用Kaminari作为分页符。但是，它可以很容易地修改，以适用于任何分页宝石或自定义解决方案。

Answer 2

2020年更新：如果您使用json_api模式，active_model_serializer现在就可以支持此功能，但是文档也教您如何使用json模式添加它。

文档在这里：https://github.com/rails-api/active_model_serializers/blob/v0.10.6/docs/howto/add_pagination_links.md

以下，我解释了如果使用json_api或json适配器，如何获得所需的结果。在ActiveModelSerializers.config.adapter上检查您正在使用哪个。

如果您使用的是JSON API适配器（您的ActiveModelSerializers.config.adapter =：json_api）

分页链接将自动包含在您的响应中，只要 资源是分页的，如果您使用的是JsonApi适配器。

如果您想在响应中使用分页链接，请使用Kaminari 或WillPaginate。

Kaminari的例子

#array
@posts = Kaminari.paginate_array([1, 2, 3]).page(3).per(1)
render json: @posts

#active_record
@posts = Post.page(3).per(1)
render json: @posts

WillPaginate示例

#array
@posts = [1,2,3].paginate(page: 3, per_page: 1)
render json: @posts

#active_record
@posts = Post.page(3).per_page(1)
render json: @posts

ActiveModelSerializers.config.adapter = :json_api

例如：

{
  "data": [
    {
      "type": "articles",
      "id": "3",
      "attributes": {
        "title": "JSON API paints my bikeshed!",
        "body": "The shortest article. Ever.",
        "created": "2015-05-22T14:56:29.000Z",
        "updated": "2015-05-22T14:56:28.000Z"
      }
    }
  ],
  "links": {
    "self": "http://example.com/articles?page[number]=3&page[size]=1",
    "first": "http://example.com/articles?page[number]=1&page[size]=1",
    "prev": "http://example.com/articles?page[number]=2&page[size]=1",
    "next": "http://example.com/articles?page[number]=4&page[size]=1",
    "last": "http://example.com/articles?page[number]=13&page[size]=1"
  }
}

ActiveModelSerializers分页依赖于具有Kaminari或WillPaginate支持的方法current_page，total_pages和size的分页集合。

如果您正在使用JSON适配器（您的ActiveModelSerializers.config.adapter =：json）

如果您不使用JSON适配器，则不会自动包含分页链接，但是可以使用meta键来这样做。

将此方法添加到您的基本API控制器中。

def pagination_dict(collection)
  {
    current_page: collection.current_page,
    next_page: collection.next_page,
    prev_page: collection.prev_page, # use collection.previous_page when using will_paginate
    total_pages: collection.total_pages,
    total_count: collection.total_count
  }
end

然后在渲染方法上使用它。

render json: posts, meta: pagination_dict(posts)

例如。

{
  "posts": [
    {
      "id": 2,
      "title": "JSON API paints my bikeshed!",
      "body": "The shortest article. Ever."
    }
  ],
  "meta": {
    "current_page": 3,
    "next_page": 4,
    "prev_page": 2,
    "total_pages": 10,
    "total_count": 10
  }
}

如果您有一个在meta标记中添加分页信息的辅助方法，则也可以实现相同的结果。例如，在您的操作中指定一个自定义序列化器。

render json: @posts, each_serializer: PostPreviewSerializer, meta: meta_attributes(@posts)

#expects pagination!
def meta_attributes(collection, extra_meta = {})
  {
    current_page: collection.current_page,
    next_page: collection.next_page,
    prev_page: collection.prev_page, # use collection.previous_page when using will_paginate
    total_pages: collection.total_pages,
    total_count: collection.total_count
  }.merge(extra_meta)
end

属性适配器

此适配器不允许我们使用meta键，因为无法添加分页链接。

Answer 3

https://github.com/x1wins/tutorial-rails-rest-api/blob/master/lib/pagination.rb

# /lib/pagination.rb
class Pagination
  def self.build_json object, param_page = {}
    ob_name = object.name.downcase.pluralize
    json = Hash.new
    json[ob_name] = ActiveModelSerializers::SerializableResource.new(object.to_a, param_page: param_page)
    json[:pagination] = {
        current_page: object.current_page,
        next_page: object.next_page,
        prev_page: object.prev_page,
        total_pages: object.total_pages,
        total_count: object.total_count
    }
    return json
  end
end

使用方法

#app/controller/posts_controller.rb
#post#index
render json: Pagination.build_json(@posts)

完整来源https://github.com/x1wins/tutorial-rails-rest-api