Wann sind verschachtelte Klassen und in Modulen verschachtelte Klassen zu verwenden?

Ich bin ziemlich vertraut mit der Verwendung von Unterklassen und Modulen, aber in jüngerer Zeit habe ich verschachtelte Klassen wie diese gesehen:

class Foo
  class Bar
    # do some useful things
  end
end

Sowie Klassen, die in Modulen wie diesen verschachtelt sind:

module Baz
  class Quux
    # more code
  end
end

Entweder sind Dokumentation und Artikel spärlich oder ich bin nicht ausreichend über das Thema informiert, um nach den richtigen Suchbegriffen zu suchen, aber ich kann anscheinend nicht viele Informationen zu diesem Thema finden.

Könnte jemand Beispiele oder Links zu Beiträgen bereitstellen, warum / wann diese Techniken verwendet werden?

Andere OOP-Sprachen haben innere Klassen, die nicht instanziiert werden können, ohne an eine Klasse der oberen Ebene gebunden zu sein. Zum Beispiel in Java,

class Car {
    class Wheel { }
}

Nur Methoden in der CarKlasse können Wheels erstellen .

Ruby hat dieses Verhalten nicht.

In Ruby,

class Car
  class Wheel
  end
end

unterscheidet sich von

class Car
end

class Wheel
end

nur im Namen der Klasse Wheelvs. Car::Wheel. Dieser Namensunterschied kann Programmierern deutlich machen, dass die Car::WheelKlasse nur ein Autorad darstellen kann, im Gegensatz zu einem allgemeinen Rad. Das Verschachteln von Klassendefinitionen in Ruby ist eine Frage der Präferenz, dient jedoch einem Zweck in dem Sinne, dass ein Vertrag zwischen den beiden Klassen stärker durchgesetzt wird und auf diese Weise mehr Informationen über sie und ihre Verwendung vermittelt werden.

Für den Ruby-Interpreter ist es jedoch nur ein Unterschied im Namen.

Was Ihre zweite Beobachtung betrifft, werden Klassen, die in Modulen verschachtelt sind, im Allgemeinen verwendet, um die Klassen zu benennen. Zum Beispiel:

module ActiveRecord
  class Base
  end
end

unterscheidet sich von

module ActionMailer
  class Base
  end
end

Obwohl dies nicht die einzige Verwendung von Klassen ist, die in Modulen verschachtelt sind, ist dies im Allgemeinen die häufigste.

In Ruby ähnelt das Definieren einer verschachtelten Klasse dem Definieren einer Klasse in einem Modul. Es erzwingt keine Zuordnung zwischen den Klassen, sondern erstellt lediglich einen Namespace für die Konstanten. (Klassen- und Modulnamen sind Konstanten.)

Die akzeptierte Antwort war in nichts richtig. ¹ Im folgenden Beispiel erstelle ich eine Instanz der lexikalisch eingeschlossenen Klasse, ohne dass jemals eine Instanz der einschließenden Klasse existiert.

class A; class B; end; end
A::B.new

Die Vorteile sind dieselben wie für Module: Kapselung, Gruppierung von Code, der nur an einer Stelle verwendet wird, und Platzierung des Codes näher an dem Ort, an dem er verwendet wird. Ein großes Projekt verfügt möglicherweise über ein äußeres Modul, das in jeder Quelldatei immer wieder vorkommt und viele Klassendefinitionen enthält. Wenn die verschiedenen Frameworks und Bibliothekscodes dies alle tun, tragen sie jeweils nur einen Namen zur obersten Ebene bei, wodurch die Wahrscheinlichkeit von Konflikten verringert wird. Natürlich prosaisch, aber deshalb werden sie verwendet.

Die Verwendung einer Klasse anstelle eines Moduls zum Definieren des äußeren Namespace kann in einem Programm oder Skript mit einer Datei sinnvoll sein, oder wenn Sie die Klasse der obersten Ebene bereits für etwas verwenden oder wenn Sie tatsächlich Code hinzufügen, um die Klassen miteinander zu verknüpfen im wahren Stil der inneren Klasse . Ruby hat keine inneren Klassen, aber nichts hindert Sie daran, ungefähr dasselbe Verhalten im Code zu erzeugen. Wenn Sie die äußeren Objekte von den inneren Objekten referenzieren, müssen Sie weiterhin von der Instanz des äußeren Objekts aus punktieren. Wenn Sie jedoch die Klassen verschachteln, wird dies möglicherweise der Fall sein. Ein sorgfältig modularisiertes Programm kann immer zuerst die einschließenden Klassen erstellen und sie können vernünftigerweise mit verschachtelten oder inneren Klassen zerlegt werden. Sie können kein newModul aufrufen .

Sie können das allgemeine Muster auch für Skripte verwenden, bei denen der Namespace nicht unbedingt benötigt wird, nur zum Spaß und zum Üben ...

#!/usr/bin/env ruby

class A
  class Realwork_A
    ...
  end
  class Realwork_B
    ...
  end

  def run
    ...
  end

  self
end.new.run

Sie möchten dies wahrscheinlich verwenden, um Ihre Klassen in einem Modul zu gruppieren . Eine Art Namespace-Sache.

Das Twitter-Juwel verwendet beispielsweise Namespaces, um dies zu erreichen:

Twitter::Client.new

Twitter::Search.new

Also leben beide Clientund SearchKlassen unter dem TwitterModul.

Wenn Sie die Quellen überprüfen möchten, finden Sie den Code für beide Klassen hier und hier .

Hoffe das hilft!

Es gibt noch einen weiteren Unterschied zwischen verschachtelten Klassen und verschachtelten Modulen in Ruby vor 2.5, den andere Antworten nicht abdecken konnten, den ich hier erwähnen muss. Es ist der Suchprozess.

Kurz gesagt: Aufgrund der konstanten Suche auf oberster Ebene in Ruby vor 2.5 sucht Ruby möglicherweise ( Objectinsbesondere) an der falschen Stelle nach Ihrer verschachtelten Klasse, wenn Sie verschachtelte Klassen verwenden.

In Ruby vor 2.5:
Verschachtelte Klassenstruktur: Angenommen, Sie haben eine Klasse Xmit verschachtelter Klasse Yoder X::Y. Und dann haben Sie eine Top-Level-Klasse namens Y. Wenn X::Yes nicht geladen ist, geschieht Folgendes, wenn Sie anrufen X::Y:

Wenn Ruby nicht gefunden Ywurde X, versucht es, es in Vorfahren von nachzuschlagen X. Schon seitXist eine Klasse und kein Modul, es hat Vorfahren, darunter [Object, Kernel, BasicObject]. So versucht sie zu suchen , Yin Object, wo sie es erfolgreich findet.

Dennoch ist es die oberste Ebene Yund nicht X::Y. Sie erhalten diese Warnung:

warning: toplevel constant Y referenced by X::Y

Verschachtelte Modulstruktur: Angenommen, im vorherigen Beispiel Xhandelt es sich um ein Modul und nicht um eine Klasse.

Ein Modul hat nur sich selbst als Vorfahr: X.ancestorswürde produzieren [X].

In diesem Fall kann Ruby Ybei einem der Vorfahren von nicht suchen Xund wirft einen NameError. Rails (oder ein anderes Framework mit automatischem Laden) versuchen danach zu laden X::Y.

Weitere Informationen finden Sie in diesem Artikel: https://blog.jetbrains.com/ruby/2017/03/why-you-should-not-use-a-class-as-a-namespace-in-rails-applications/

In Ruby 2.5:
Konstante Suche auf oberster Ebene entfernt.
Sie können verschachtelte Klassen verwenden, ohne befürchten zu müssen, dass dieser Fehler auftritt.

Zusätzlich zu den vorherigen Antworten: Modul in Ruby ist eine Klasse

$ irb
> module Some end
=> nil
> Some.class
=> Module
> Module.superclass
=> Object