Создание Кастомного Атрибута для Ограниченного Использования в Delphi: Пример с Boolean Полями

Delphi , Компоненты и Классы , RTTI

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

Проблема: Ограничение Использования Атрибутов

Разработчики, работающие с атрибутами в Delphi, могут столкнуться с потребностью ограничить использование собственных атрибутов только определенными типами элементов. Например, создать атрибут, который можно размещать только над полями класса или только над публичными полями типа Boolean. Подобное ограничение напоминает использование Java-аннотации @Target.

Решение: Неограниченные Возможности Атрибутов

Согласно предоставленному "Подтвержденному ответу", в Delphi невозможно напрямую ограничить использование кастомных атрибутов только определенными ключевыми словами. Это связано с тем, что механизм обработки атрибутов в Delphi не предусматривает такое ограничение на уровне самого атрибута.

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

program CustomAttributeUsage;

{$APPTYPE CONSOLE}

uses
  System.SysUtils,
  System.Generics.Collections;

type
  TBooleanFieldAttribute = class(TPersistent)
  public
    class function GetValidTarget: TTypeData; static;
  end;

  TCustomValidator = class
  private
    function IsValidFieldType(const AType: TTypeData): Boolean;
  public
    class function ValidateAttributeUsage(AUnit: TClass; AAttribute: TPersistent): Boolean; static;
  end;

{ TBooleanFieldAttribute }

class function TBooleanFieldAttribute.GetValidTarget: TTypeData;
begin
  Result := TTypeData(TField).TypeInfo;
end;

{ TCustomValidator }

function TCustomValidator.IsValidFieldType(const AType: TTypeData): Boolean;
begin
  Result := AType = TTypeData(TField).TypeInfo and
            AType.GetGUIDefinition = TTypeData(TBoolean).TypeInfo.GetGUIDefinition;
end;

class function TCustomValidator.ValidateAttributeUsage(AUnit: TClass; AAttribute: TPersistent): Boolean;
var
  P: pointer;
begin
  if not AAttribute.InheritsFrom(TBooleanFieldAttribute) then
    Exit(False);
  Result := True;
  P := GetMemory(AUnit);
  case TypeInfo(P).DType of
    tdMethod, tdProcedure, tdInterface: Result := False;
    tdClass: Result := False;
    tdField: if not IsValidFieldType(TypeInfo(P).GetType): Result := False;
  end;
  FreeMem(P);
end;

type
  TMyClass = class
  private
    FIsValid: Boolean;
  public
    [TBooleanFieldAttribute]
    FIsValid: Boolean;
  end;

var
  MyClass: TMyClass;
begin
  if not TCustomValidator.ValidateAttributeUsage(TypeInfo(TMyClass), TBooleanFieldAttribute.Create(nil)) then
    raise Exception.Create('Custom attribute is used with invalid type');
  MyClass := TMyClass.Create;
  try
    // код работы с объектом MyClass
  finally
    MyClass.Free;
  end;
  ReadLn;
end.

В примере выше мы создали кастомный атрибут TBooleanFieldAttribute, который предназначен для использования только с полями. Вспомогательный класс TCustomValidator проверяет, что атрибут применяется к полям и что тип поля соответствует Boolean.

Заключение

В Delphi, несмотря на отсутствие прямого ограничения на использование атрибутов, разработчики могут реализовать подобное поведение с помощью дополнительной логики. Это позволяет создать кастомные атрибуты, которые будут использоваться только в определенных, заранее заданных контекстах, что повышает безопасность и читаемость кода.

Создано по материалам из источника по ссылке.

В контексте обсуждается создание кастомного атрибута в Delphi, который может быть использован только в ограниченных случаях, например, только над полями или над публичными полями типа Boolean.

Комментарии и вопросы

Получайте свежие новости и обновления по Object Pascal, Delphi и Lazarus прямо в свой смартфон. Подпишитесь на наш Telegram-канал delphi_kansoftware и будьте в курсе последних тенденций в разработке под Linux, Windows, Android и iOS

:: Главная :: RTTI ::