Active Record – Объектно-реляционное отображение в Rails

Active Record связывает классы с таблицами реляционной базы данных, чтобы создать почти полностью безконфигурационный слой сохранения для приложений. Библиотека предоставляет базовый класс, который при наследовании настраивает отображение между новым классом и существующей таблицей в базе данных. В контексте приложения эти классы обычно называют моделями. Модели также могут быть связаны с другими моделями; это делается путем определения ассоциаций.

Active Record сильно зависит от именования, так как использует имена классов и ассоциаций для установления соответствия между соответствующими таблицами базы данных и столбцами внешних ключей. Хотя эти соответствия можно определять явно, рекомендуется придерживаться соглашений об именовании, особенно при первом знакомстве с библиотекой.

Дополнительную информацию об Active Record можно найти в руководстве Основы Active Record.

Краткое описание некоторых основных функций:

• Автоматическое отображение соответствия между классами и таблицами, атрибутами и столбцами.

  class Product < ActiveRecord::Base
  end
  

  Класс Product автоматически отображается на таблицу с именем «products», которая может выглядеть так:

  CREATE TABLE products (
    id bigint NOT NULL auto_increment,
    name varchar(255),
    PRIMARY KEY  (id)
  );

  Это также определит следующие аксессоры: Product#name и Product#name=(new_name).

  Узнать больше

• Associations между объектами, определенными простыми методами класса.

  class Firm < ActiveRecord::Base
    has_many   :clients
    has_one    :account
    belongs_to :conglomerate
  end
  

  Узнать больше

• Aggregations объектов-значений.

  class Account < ActiveRecord::Base
    composed_of :balance, class_name: 'Money',
                mapping: %w(balance amount)
    composed_of :address,
                mapping: [%w(address_street street), %w(address_city city)]
  end
  

  Узнать больше

• Правила проверки, которые могут отличаться для новых или существующих объектов.

  class Account < ActiveRecord::Base
    validates :subdomain, :name, :email_address, :password, presence: true
    validates :subdomain, uniqueness: true
    validates :terms_of_service, acceptance: true, on: :create
    validates :password, :email_address, confirmation: true, on: :create
  end
  

  Узнать больше

• Callbacks, доступные для всего жизненного цикла (создание, сохранение, удаление, валидация и т. д.).

  class Person < ActiveRecord::Base
    before_destroy :invalidate_payment_plan
    # the `invalidate_payment_plan` method gets called just before Person#destroy
  end
  

  Узнать больше

• Inheritance иерархии.

  class Company < ActiveRecord::Base; end
  class Firm < Company; end
  class Client < Company; end
  class PriorityClient < Client; end
  

  Узнать больше

• Transactions.

  # Database transaction
  Account.transaction do
    david.withdrawal(100)
    mary.deposit(100)
  end
  

  Узнать больше

• Рефлексия столбцов, ассоциаций и агрегаций.

  reflection = Firm.reflect_on_association(:clients)
  reflection.klass # => Client (class)
  Firm.columns # Returns an array of column descriptors for the firms table
  

  Узнать больше

• Абстракция базы данных с помощью простых адаптеров.

  # connect to SQLite3
  ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: 'dbfile.sqlite3')
  
  # connect to MySQL with authentication
  ActiveRecord::Base.establish_connection(
    adapter:  'mysql2',
    host:     'localhost',
    username: 'me',
    password: 'secret',
    database: 'activerecord'
  )
  

  Узнать больше и прочитать о встроенной поддержке MySQL, PostgreSQL и SQLite3.

• Поддержка логирования для Log4r и Logger.

  ActiveRecord::Base.logger = ActiveSupport::Logger.new(STDOUT)
  ActiveRecord::Base.logger = Log4r::Logger.new('Application Log')
  

• Управление схемой, независимое от базы данных, с помощью Миграций.

  class AddSystemSettings < ActiveRecord::Migration[7.1]
    def up
      create_table :system_settings do |t|
        t.string  :name
        t.string  :label
        t.text    :value
        t.string  :type
        t.integer :position
      end
  
      SystemSetting.create name: 'notice', label: 'Use notice?', value: 1
    end
  
    def down
      drop_table :system_settings
    end
  end
  

  Узнать больше

Философия

Active Record — это реализация одноименного паттерна объектно-реляционного отображения (ORM), описанного Мартином Фаулером:

«Объект, который оборачивает строку в таблице или представлении базы данных, инкапсулирует доступ к базе данных и добавляет логику домена к этим данным».

Active Record пытается предоставить согласованную оболочку как решение неудобств, связанных с объектно-реляционным отображением. Основной целью этого отображения было минимизировать количество кода, необходимого для создания реальной модели домена. Это достигается за счет использования ряда соглашений, которые позволяют Active Record легко выводить сложные отношения и структуры из минимального количества явных указаний.

Соглашение важнее конфигурации:

• Нет файлов XML!

• Много рефлексии и расширения во время выполнения

• Магия — это не обязательно плохое слово

Признать базу данных:

• Позволяет перейти к SQL для особых случаев и повышения производительности

• Не пытается дублировать или заменять определения данных

Загрузка и установка

Последнюю версию Active Record можно установить с помощью RubyGems:

$ gem install activerecord

Исходный код можно загрузить в рамках проекта Rails на GitHub:

• github.com/rails/rails/tree/main/activerecord

Лицензия

Active Record распространяется по лицензии MIT:

• opensource.org/licenses/MIT

Поддержка

Документация API находится по адресу:

• api.rubyonrails.org

Сообщения об ошибках для проекта Ruby on Rails можно отправить здесь:

• github.com/rails/rails/issues

Запросы на новые функции следует обсуждать на почтовой рассылке rails-core по этому адресу:

• discuss.rubyonrails.org/c/rubyonrails-core