如何在Rails Active Record模型中添加默认返回的虚拟属性？

要让虚拟属性在直接调用@booking（控制台打印）和render json: @booking时自动出现，有这几种实用方案：

1. 重写as_json方法（解决JSON渲染问题） #

Rails渲染JSON时默认调用as_json，重写它就能把虚拟属性加入默认序列化结果：

class Booking < ApplicationRecord
  def start_date
    start_at.strftime('%Y-%m-%d')
  end

  def start_time
    start_at.strftime('%H:%M')
  end

  def end_date
    end_at.strftime('%Y-%m-%d')
  end

  def end_time
    end_at.strftime('%H:%M')
  end

  # 重写as_json，合并虚拟属性
  def as_json(options = {})
    super(options).merge(
      start_date: start_date,
      start_time: start_time,
      end_date: end_date,
      end_time: end_time
    )
  end
end

这样直接用render json: @booking，返回的JSON就会包含这四个虚拟属性，不用额外传参数。

2. 重写inspect方法（解决控制台打印问题） #

控制台打印模型时调用的是inspect方法，重写它就能让虚拟属性显示出来：

class Booking < ApplicationRecord
  # 先保留前面的虚拟属性方法...

  def inspect
    # 先获取默认的属性字符串，再拼接虚拟属性
    default_inspect = super.gsub(/>\z/, '') # 去掉结尾的>
    "#{default_inspect}, start_date: #{start_date.inspect}, start_time: #{start_time.inspect}, end_date: #{end_date.inspect}, end_time: #{end_time.inspect}>"
  end
end

现在在控制台执行p @booking，就能看到虚拟属性和原生属性一起显示了。

3. 使用ActiveModel::Serializer（规范序列化方案） #

如果你的项目需要更复杂的序列化逻辑，推荐用官方的序列化器：

1. 先安装gem（如果没装的话）：

gem 'active_model_serializers'

2. 生成Booking的序列化器：

rails generate serializer Booking

3. 在序列化器里添加虚拟属性：

# app/serializers/booking_serializer.rb
class BookingSerializer < ActiveModel::Serializer
  attributes :id, :start_at, :end_at, :start_date, :start_time, :end_date, :end_time

  def start_date
    object.start_at.strftime('%Y-%m-%d')
  end

  def start_time
    object.start_at.strftime('%H:%M')
  end

  def end_date
    object.end_at.strftime('%Y-%m-%d')
  end

  def end_time
    object.end_at.strftime('%H:%M')
  end
end

这样render json: @booking会自动使用这个序列化器，返回包含虚拟属性的JSON，同时也能保持代码的模块化。

内容的提问来源于stack exchange，提问作者Brad