Crystal Programming. Введение на основе проекта в создание эффективных, безопасных и читаемых веб-приложений и приложений CLI - Джордж Дитрих

4. priority – необязательное числовое значение из аннотации.

5. id – необходимое числовое значение из аннотации.

Конечно, то, какие данные вам нужны, во многом зависит от конкретного варианта использования, но, как правило, имя, тип и класс полезно иметь во всех случаях. Тип может быть, например, типом переменной экземпляра или типом возвращаемого значения метода.

Мы можем использовать макрос record, чтобы упростить создание нашей структуры. В конечном итоге это будет выглядеть так:

abstract struct MetadataBase; end

record PropertyMetadata(ClassType, PropertyType, Propertyldx)

  < MetadataBase,

  name : String,

  id : Int32,

  priority : Int32 = 0 do

  def class_name : ClassType.class

    ClassType

  end

  def type : PropertyType.class

    PropertyType

  end

end

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

У каждой записи будет имя, и мы также добавили к ней два дополнительных свойства. Поскольку значение priority является необязательным, мы установили для него значение по умолчанию, равное 0, тогда как идентификатор является обязательным, поэтому у него нет значения по умолчанию.

Далее нам нужно создать модуль, который будет создавать и предоставлять хеш метаданных свойств. Мы можем использовать некоторые концепции макросов, которые мы изучили несколько глав назад, такие как макроперехваты и дословное выполнение. В конечном итоге этот модуль будет выглядеть так:

annotation Metadata; end

module Metadatable

  macro included

    class_property metadata : Hash(String, MetadataBase) do

      {% verbatim do %}

        {% begin %}

          {

            {% for ivar, idx in @type.instance_vars.select &.

              annotation Metadata %}

              {{ivar.name.stringify}} => (PropertyMetadata(

                {{@type}}, {{ivar.type.resolve}},{{idx}}

                ).new({{ivar.name.stringify}},

                  {{ivar.annotation(Metadata).named_args

                  .double_splat}}

              )),

            {% end %}

          } of String => MetadataBase

        {% end %}

      {% end %}

    end

  end

end

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

Фактическая логика макроса довольно проста и делает многое из того, что мы делали в предыдущем разделе. Однако в этом примере мы также передаем некоторые общие значения при создании экземпляра нашего экземпляра PropertyMetadata.

На этом этапе наша логика готова к испытанию. Создайте класс, включающий модуль и некоторые свойства, использующие аннотацию, например:

class MyClass

include Metadatable

  @[Metadata(id: 1)]

  property name : String = "Jim"

  @[Metadata(id: 2, priority: 7)]

  property created_at : Time = Time.utc

  property weight : Float32 = 56.789

end

pp MyClass.metadata["created_at"]

Если бы вы запустили эту программу, вы бы увидели, что она выводит экземпляр PropertyMetadata со значениями из аннотации и самой переменной экземпляра, установленными правильно. Однако есть еще одна вещь, с которой нам нужно разобраться; как мы можем получить доступ к значению связанного экземпляра метаданных? Именно это мы и собираемся исследовать дальше.

Доступ к значению

Малоизвестный факт об обобщениях заключается в том, что в качестве значения универсального аргумента можно также передать число. В первую очередь это сделано для поддержки типа StaticArray, который использует синтаксис StaticArray(Int32, 3) для обозначения статического массива из трех значений Int32.

Как упоминалось ранее, наш тип PropertyMetadata имеет третью универсальную переменную, которой мы присваиваем индекс связанной переменной экземпляра. Основной вариант использования этого заключается в том, что мы можем затем использовать это для извлечения значения, которое представляет экземпляр метаданных, в сочетании с другим трюком.

Если вам интересно, нет, нет способа волшебным образом получить значение из воздуха только потому, что у нас есть индекс переменной экземпляра и TypeNode типа, которому оно принадлежит. Для извлечения нам понадобится реальный экземпляр MyClass. Чтобы учесть это, нам нужно добавить в PropertyMetadata несколько дополнительных методов:

def value(obj : ClassType)

  {% begin %}

     obj.@{{ClassType.instance_vars[PropertyIdx].name.id}}

  {% end %}

end

def value(obj) i : NoReturn

    raise "BUG: Invoked default value method."

end

Другая хитрость, которая делает эту реализацию возможной, — это возможность прямого доступа к переменным экземпляра типа, даже если у них нет метода получения через синтаксис obj.@ivar_name. В предисловии к этому я скажу, что вам не следует использовать это часто, если вообще когда-либо, за исключением очень специфических случаев использования, таких как этот. Это антишаблон, и его следует избегать, когда это возможно. В 99% случаев вам следует вместо этого определить метод получения, чтобы вместо этого предоставить значение переменной экземпляра.

С учетом вышесказанного реализация использует индекс переменной экземпляра для доступа к ее имени и использования его для создания предыдущего синтаксиса. Поскольку все это происходит во время компиляции, фактический метод, который добавляется, например, для переменной экземпляра name, будет выглядеть следующим образом:

def value(obj : ClassType)

    obj.@name

end

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

Мы можем пойти дальше и опробовать это, добавив в нашу программу следующее и запустив ее:

my_class = MyClass.new

pp MyClass.metadata["name"].value my_class

Вы должны увидеть значение свойства name, напечатанное на вашем терминале, которое в данном случае будет "Jim". У этой реализации есть один недостаток. Тип значения, возвращаемого методом #value, будет состоять из объединения всех свойств, имеющих аннотацию данного типа. Например, typeof(name_value) вернет (String | Time), что в целом приводит к менее эффективному представлению памяти.

Этот шаблон отлично подходит для реализации мощных внутренних API, но его следует использовать