Rails Active Model Serializer include in controller not injecting 在包含的参数中有很多关系

Question

我看到关于 rails 5、活动模型序列化程序和 json-api 适配器的奇怪行为。

给定以下 User 模型与 Rolify gem:

class User < ActiveRecord::Base
  #
  # Gem Includes
  #
  rolify


  # Include devise modules.
  devise :database_authenticatable,
      :recoverable, :rememberable, :trackable, :validatable
  include DeviseTokenAuth::Concerns::User

  #
  # Callbacks
  #
  after_create :assign_default_role

  #
  # Attributes
  #
  attr_accessor :remote_image

  #
  # Validations
  #
  validates :name, presence: true, length: {in: 1..100}
  validates :last_name, presence: true, length: {in: 1..100}
  validates :role_ids, presence: true, on: :update

  #
  # Relations
  #
  belongs_to :current_scenario, class_name: "Scenario"


  #
  # Private Instance Methods
  #
  def assign_default_role
    self.add_role(:user) if self.roles.blank?
  end

end

和以下控制器代码：

def show
  @user = User.find(params[:id])
  authorize @user
  render json: @user, include: ['roles'], status: :ok
end

如您所见，我将要呈现的角色关系包含在 json api 响应中，使用 json-api 适配器格式.

仅供参考，UserSerializer:

class UserSerializer < ActiveModel::Serializer
  #
  # Attributes
  #
  attributes :id, :email, :name, :last_name, :image_url, :image_thumb_url, :created_at, :updated_at, :current_scenario_id, :last_sign_in_at

  #
  # Relations
  #
  has_one :current_scenario
  has_many :roles

  #
  # Methods
  #
  def image_url
    object.image_url
  end

  def image_thumb_url
    object.image_url(:thumb)
  end
end

检索 json 响应时，我得到以下信息：

{
  "data": {
    "id":"2",
    "type":"users",
    "attributes": {
      "email":"talvarez@igaltex.com.ar", ...
    },
    "relationships": {
      "current-scenario": {
        "data": {
          "id":"204",
          "type":"scenarios"
        }
      },
      "roles": {
        "data": [
          {
            "id":1,
            "name":"user",
            "resource-type":null,
            "resource-id":null,
            "created-at":"2017-01-23T10:27:08.707-03:00",
            "updated-at":"2017-01-23T10:27:08.707-03:00"
          },
          {
            "id":2,
            "name":"admin",
            "resource-type":null,
            "resource-id":null,
            "created-at":"2017-01-24T09:40:53.020-03:00",
            "updated-at":"2017-01-24T09:40:53.020-03:00"
          }
        ]
      }
    }
  }
}

如您所见，包含的关系角色及其所有属性位于 json-api 响应的 relationships 片段中。角色数据不应该在 included 片段中，顺便说一下，它丢失了吗？此外，在关系片段中 roles 应该仅作为参考出现，例如：{relationships: {roles: [{id: "1", type: "role"}, {id: "2", type: "role"}]} 我错了吗？

为了对比这一点，看看当还包括 current_scenario 关系时会发生什么：

{
  "data": {
    "id":"2",
    "type":"users",
    "attributes": {
      "email":"talvarez@igaltex.com.ar",
      "name":"Tomás",
      "last-name":"Alvarez", 
      ...
    },
    "relationships": {
      "current-scenario": {
        "data": {
          "id":"204",
          "type":"scenarios"
        }
      },
      "roles": {
        "data": [
          {
            "id":1,
            "name":"user",
            "resource-type":null,
            ...
          }
        ]
      }
    },
    "included": [
      {
        "id":"204",
        "type":"scenarios",
        "attributes": {
          "name":"Scenario reload II",
          "description":null,
          "created-at":"2017-04-18T11:55:35.242-03:00",
          "updated-at":"2017-04-18T11:55:35.242-03:00"
        },
        "relationships": {
          "scenario-stocks": {
            "data":[]
          }
        }
      }
    ]
  }
}

看看现在包含的片段如何显示有关 current_scenario 的所有信息，并且只有对 current_scenario 的引用被添加到 relationships 片段。这是因为角色在活动模型序列化程序中是 has_many 关系，而 current_scenario 是 belongs_to ?我对 json-api 适配器规范的理解有误吗？

非常感谢！

Answer 1

这就是 JSON API 的工作方式您无法在 'one object' 中检索到所需的模型 + 关系。关系总是分开的。所以你需要以某种方式 'glue' 它。您可以使用 gem 来帮助您，也可以在前端完成（所有大型框架都支持）。一般来说，这种 'relationships' 的方法看起来很奇怪，但是当你有具有大量依赖项的复杂对象时，这是唯一可行的方法。

Answer 2

哎呀。 JSON-API 响应中的不一致是因为我忘记在后端添加角色模型序列化程序 (Rails 5)。这是现在的 json 响应，这正是我要找的：

{
"data": {
    "id": "2",
    "type": "users",
    "attributes": {
        "email": "talvarez@igaltex.com.ar",
        "name": "Tomás",
        "last-name": "Alvarez",
        "image-url": "http://localhost:3001/uploads/user/image/2/05a4dc7.jpg",
        "image-thumb-url": "http://localhost:3001/uploads/user/image/2/thumb_05a4dc7.jpg",
        "created-at": "2017-01-23T10:39:12.485-03:00",
        "updated-at": "2017-04-25T16:32:14.610-03:00",
        "current-scenario-id": 204,
        "last-sign-in-at": "2017-04-25T16:29:03.559-03:00"
    },
    "relationships": {
        "current-scenario": {
            "data": {
                "id": "204",
                "type": "scenarios"
            }
        },
        "roles": {
            "data": [{
                "id": "1",
                "type": "roles"
            }, {
                "id": "2",
                "type": "roles"
            }]
        }
    }
},
"included": [{
    "id": "204",
    "type": "scenarios",
    "attributes": {
        "name": "Scenario reload II",
        "description": null,
        "created-at": "2017-04-18T11:55:35.242-03:00",
        "updated-at": "2017-04-18T11:55:35.242-03:00"
    },
    "relationships": {
        "scenario-stocks": {
            "data": []
        }
    }
}, {
    "id": "1",
    "type": "roles",
    "attributes": {
        "name": "user"
    }
}, {
    "id": "2",
    "type": "roles",
    "attributes": {
        "name": "admin"
    }
}]

}

Answer 3

对于这个错误，我们深表歉意。我们还没有想出如何在找不到序列化程序时确定关系的类型。如果你有一个例外，它会更有帮助吗？

Rails Active Model Serializer include in controller not injecting 在包含的参数中有很多关系

Rails Active Model Serializer include in controller not injecting has many relationship in included parameter

ruby-on-rails

active-model-serializers

json-api

ruby-on-rails-5