Фабрика замещающих классов

Пример 1 

Замещаемый класс SubstitutableClass имеет один конструктор по умолчанию.

/* Объявление замещаемого класса. */
public class SubstitutableClass
{
    /* Свойство класса, инициализация которого будет выполняться в конструкторе. */
    public int OriginalValue { get; private set; }
    
    /* Конструктор по умолчанию, который инициализирует свойство OriginalValue значением 10. */
    public SubstitutableClass()
    {
        OriginalValue = 10;
    }
    
    /* Метод, который возвращает значение OriginalValue, умноженное на 2. Этот метод может быть переопределен в замещающих классах. */
    public virtual int GetMultipliedValue()
    {
        return OriginalValue * 2;
    }
}

В замещающем классе SubstituteClass объявлены два конструктора — конструктор по умолчанию и параметризированный. Замещающий класс переопределяет родительский метод GetMultipliedValue().

/* Объявление класса, замещающего SubstitutableClass. */
[Terrasoft.Core.Factories.Override]
public class SubstituteClass : SubstitutableClass
{
    /* Свойство класса SubstituteClass. */
    public int AdditionalValue { get; private set; }
    
    /* Конструктор по умолчанию, который инициализирует свойство AdditionalValue значением 15. Здесь можно не вызывать конструктор родительского класса SubstitutableClass, так как в родительском классе объявлен только конструктор по умолчанию (он вызывается неявно при создании экземпляра SubstituteClass). */
    public SubstituteClass()
    {
        AdditionalValue = 15;
    }
    
    /* Конструктор с параметром, который инициализирует свойство AdditionalValue значением, переданным в качестве параметра. Здесь аналогично явно не вызывается родительский конструктор. */
    public SubstituteClass(int paramValue)
    {
        AdditionalValue = paramValue;
    }
    
    /* Замещение родительского метода. Метод будет возвращать значение AdditionalValue, умноженное на 3. */
    public override int GetMultipliedValue()
    {
        return AdditionalValue * 3;
    }
}

Примеры получения экземпляра замещающего класса SubstituteClass через фабрику представлены ниже.

/* Получение экземпляра класса, который замещает SubstitutableClass. Фабрика вернет экземпляр SubstituteClass, инициализированный конструктором без параметров. */
var substituteObject = ClassFactory.Get<SubstitutableClass>();
    
/* Переменная будет содержать значение 10. Свойство OriginalValue инициализировано родительским конструктором по умолчанию, который был неявно вызван при создании экземпляра замещающего класса. */
var originalValue = substituteObject.OriginalValue;
    
/* Здесь будет вызван метод замещающего класса, который будет возвращать значение AdditionalValue, умноженное на 3. Переменная будет содержать значение 45, так как AdditionalValue было инициализировано значением 15. */
var additionalValue = substituteObject.GetMultipliedValue();
    
/* Получение экземпляра замещающего класса, который инициализирован параметризированным конструктором. При этом имя параметра ConstructorArgument должно совпадать с именем параметра в конструкторе класса. */
var substituteObjectWithParameters = ClassFactory.Get<SubstitutableClass>(
    new ConstructorArgument("paramValue", 20));
    
/* Переменная будет содержать значение 10. */
var originalValueParametrized = substituteObjectWithParameters.OriginalValue;
    
/* Переменная будет содержать значение 60, так как свойство AdditionalValue инициализировано значением 20. */
var additionalValueParametrized = substituteObjectWithParameters.GetMultipliedValue();

Пример 2 

Замещаемый класс SubstitutableClass имеет один параметризированный конструктор.

/* Объявление замещаемого класса. */
public class SubstitutableClass
{
    /* Свойство класса, инициализация которого будет выполняться в конструкторе. */
    public int OriginalValue { get; private set; }
    
    /* Параметризированный конструктор, который инициализирует свойство OriginalValue переданным в качестве параметра значением. */
    public SubstitutableClass(int originalParamValue)
    {
        OriginalValue = originalParamValue;
    }
    
    /* Метод, который возвращает значение OriginalValue, умноженное на 2. Этот метод может быть переопределен в замещающих классах. */
    public virtual int GetMultipliedValue()
    {
        return OriginalValue * 2;
    }
}

Замещающий класс SubstituteClass также имеет один параметризированный конструктор.

/* Объявление класса, замещающего SubstitutableClass. */
[Terrasoft.Core.Factories.Override]
public class SubstituteClass : SubstitutableClass
{
    /* Свойство класса SubstituteClass. */
    public int AdditionalValue { get; private set; }
    
    /* Конструктор с параметром, который инициализирует свойство AdditionalValue значением, переданным в качестве параметра. Здесь необходимо явно вызывать родительский конструктор для инициализации родительского свойства. Если этого не сделать, то возникнет ошибка компиляции. */
    public SubstituteClass(int paramValue) : base(paramValue + 8)
    {
        AdditionalValue = paramValue;
    }
    
    /* Замещение родительского метода. Метод будет возвращать значение AdditionalValue, умноженное на 3. */
    public override int GetMultipliedValue()
    {
        return AdditionalValue * 3;
    }
}

Пример создания и использования экземпляра замещающего класса SubstituteClass через фабрику представлен ниже.

/* Получение экземпляра замещающего класса, который инициализирован параметризированным конструктором. При этом имя параметра ConstructorArgument должно совпадать с именем параметра в конструкторе класса. */
var substituteObjectWithParameters = ClassFactory.Get<SubstitutableClass>(
    new ConstructorArgument("paramValue", 10));
    
/* Переменная будет содержать значение 18. */
var originalValueParametrized = substituteObjectWithParameters.OriginalValue;
    
/* Переменная будет содержать значение 30. */
var additionalValueParametrized = substituteObjectWithParameters.GetMultipliedValue();

Пример 3 

Замещаемый класс SubstitutableClass имеет один параметризированный конструктор.

/* Объявление замещаемого класса. */
public class SubstitutableClass
{
    /* Свойство класса, инициализация которого будет выполняться в конструкторе. */
    public int OriginalValue { get; private set; }
    
    /* Параметризированный конструктор, который инициализирует свойство OriginalValue переданным в качестве параметра значением. */
    public SubstitutableClass(int originalParamValue)
    {
        OriginalValue = originalParamValue;
    }
    
    /* Метод, который возвращает значение OriginalValue, умноженное на 2. Этот метод может быть переопределен в замещающих классах. */
    public virtual int GetMultipliedValue()
    {
        return OriginalValue * 2;
    }
}

В замещающем классе SubstituteClass переопределяется метод GetMultipliedValue(), который будет возвращать фиксированное значение. Класс SubstituteClass не требует первичной инициализации своих свойств, в нем должен быть явно объявлен конструктор, который вызывает родительский конструктор с параметрами для корректной инициализации родительских свойств.

// Объявление класса, замещающего SubstitutableClass.
[Terrasoft.Core.Factories.Override]
public class SubstituteClass : SubstitutableClass
{
    /* Пустой конструктор по умолчанию, который явно вызывает конструктор родительского класса для корректной инициализации родительских свойств. */
    public SubstituteClass() : base(0)
    {
    }
    
    /* Также можно использовать пустой конструктор с параметрами для того, чтобы передать эти параметры в конструктор родительского класса. */
    public SubstituteClass(int someValue) : base(someValue)
    {
    }
    
    /* Замещение родительского метода. Метод будет возвращать фиксированное значение. */
    public override int GetMultipliedValue()
    {
        return 111;
    }
}

1. Реализовать замещаемый класс 

1. Перейдите в раздел Конфигурация (Configuration) и выберите пользовательский пакет, в который будет добавлена схема.

2. На панели инструментов реестра раздела нажмите Добавить —> Исходный код (Add —> Source code).

   

3. В дизайнере схем заполните свойства схемы:

   • Код (Code) — "UsrOriginalClass".
   • Заголовок (Title) — "OriginalClass".
   

4. Создайте замещаемый класс UsrOriginalClass, который содержит виртуальный метод GetAmount(int, int). Метод выполняет суммирование двух значений, переданных в качестве параметров.

   UsrOriginalClass

   namespace Terrasoft.Configuration
   {
       public class UsrOriginalClass
       {
           /* GetAmount() — виртуальный метод, который имеет свою реализацию и может быть переопределен в наследниках. */
           public virtual int GetAmount(int originalValue1, int originalValue2)
           {
               return originalValue1 + originalValue2;
           }
       }
   }
   

5. На панели инструментов дизайнера нажмите Сохранить (Save), а затем Опубликовать (Publish).

2. Реализовать замещающий класс 

1. Перейдите в раздел Конфигурация (Configuration) и выберите пользовательский пакет, в который будет добавлена схема. Для замещающего класса используйте пакет, отличный от пакета, в котором реализован замещаемый класс UsrOriginalClass.
2. В зависимость пользовательского пакета с замещающим классом добавьте пользовательский пакет с замещаемым классом UsrOriginalClass, созданный на предыдущем шаге.

3. На панели инструментов реестра раздела нажмите Добавить —> Исходный код (Add —> Source code).

   

4. В дизайнере схем заполните свойства схемы:

   • Код (Code) — "UsrSubstituteClass".
   • Заголовок (Title) — "SubstituteClass".
   

5. Создайте замещающий класс UsrSubstituteClass, который содержит метод GetAmount(int, int). Метод выполнит суммирование двух значений, переданных в качестве параметров, и умножит полученную сумму на значение, переданное в свойстве Rate. Первичная инициализация свойства Rate будет выполняться в конструкторе замещающего класса.

   UsrSubstituteClass

   namespace Terrasoft.Configuration
   {
       [Terrasoft.Core.Factories.Override]
       public class UsrSubstituteClass : UsrOriginalClass
       {
           /* Коэффициент. Значение свойства задается внутри класса. */
           public int Rate { get; private set; }
           
           /* В конструкторе выполняется первичная инициализация свойства Rate переданным значением. */
           public UsrSubstituteClass(int rateValue)
           {
               Rate = rateValue;
           }
   
           /* Замещение родительского метода пользовательской реализацией. */
           public override int GetAmount(int substValue1, int substValue2)
           {
               return (substValue1 + substValue2) * Rate;
           }
       }
   }
   

6. На панели инструментов дизайнера нажмите Сохранить (Save), а затем Опубликовать (Publish).

3. Реализовать пользовательский веб-сервис 

1. Перейдите в раздел Конфигурация (Configuration) и выберите пользовательский пакет, в который будет добавлена схема. Для пользовательского веб-сервиса используйте пакет, в котором реализован замещаемый класс UsrOriginalClass.

2. На панели инструментов реестра раздела нажмите Добавить —> Исходный код (Add —> Source code).

   

3. В дизайнере схем заполните свойства схемы:

   • Код (Code) — "UsrAmountService".
   • Заголовок (Title) — "AmountService".
   

4. Создайте класс сервиса.

   1. В дизайнере схем добавьте пространство имен Terrasoft.Configuration.
   2. C помощью директивы using добавьте пространства имен, типы данных которых будут задействованы в классе.
   3. Добавьте название класса UsrAmountService, которое соответствует названию схемы (свойство Код (Code)).
   4. В качестве родительского класса укажите класс Terrasoft.Nui.ServiceModel.WebService.BaseService.
   5. Для класса добавьте атрибуты [ServiceContract] и [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)].

5. Реализуйте метод класса.

   В дизайнере схем добавьте в класс метод public string GetAmount(int value1, int value2), который реализует конечную точку пользовательского веб-сервиса. Метод GetAmount(int, int) выполнит суммирование двух значений, переданных в качестве параметров.

   Исходный код пользовательского веб-сервиса UsrAmountService представлен ниже.

   UsrAmountService

   namespace Terrasoft.Configuration
   {
       using System.ServiceModel;
       using System.ServiceModel.Activation;
       using System.ServiceModel.Web;
       using Terrasoft.Core;
       using Terrasoft.Web.Common;
   
       [ServiceContract]
       [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)]
       public class UsrAmountService : BaseService
       {
   
           [OperationContract]
           [WebGet(RequestFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Wrapped, ResponseFormat = WebMessageFormat.Json)]
           public string GetAmount(int value1, int value2) {
               /*
               // Создание экземпляра исходного класса через фабрику классов.
               var originalObject = Terrasoft.Core.Factories.ClassFactory.Get<UsrOriginalClass>();
   
               // Получение результата работы метода GetAmount(). В качестве параметров передаются значения из полей ввода страницы.
               int result = originalObject.GetAmount(value1, value2);
   
               // Отображение на странице результата выполнения.
               return string.Format("The result value, retrieved after calling the replacement class method: {0}", result.ToString());
               */
   
               /*
               // Создание экземпляра замещающего класса через фабрику замещаемых объектов.
               // В качестве параметра метода фабрики передается экземпляр аргумента конструктора класса.
               var substObject = Terrasoft.Core.Factories.ClassFactory.Get<UsrOriginalClass>(new Terrasoft.Core.Factories.ConstructorArgument("rateValue", 2));
   
               // Получение результата работы метода GetAmount(). В качестве параметров передаются значения из полей ввода страницы.
               int result = substObject.GetAmount(value1, value2);
   
               // Отображение на странице результата выполнения.
               return string.Format("The result value, retrieved after calling the replaceable class method: {0}", result.ToString());
               */
   
               /* Создание экземпляра замещающего класса через оператор new(). */
               var substObjectByNew = new UsrOriginalClass();
   
               /* Создание экземпляра замещающего класса через фабрику замещаемых объектов. */
               var substObjectByFactory = Terrasoft.Core.Factories.ClassFactory.Get<UsrOriginalClass>(new Terrasoft.Core.Factories.ConstructorArgument("rateValue", 2));
   
               /* Получение результата работы метода GetAmount(). Будет вызван метод исходного класса UsrOriginalClass без замещения. */
               int resultByNew = substObjectByNew.GetAmount(value1, value2);
   
               /* Получение результата работы метода GetAmount(). Будет вызван метод класса UsrSubstituteClass, который замещает UsrOriginalClass. */
               int resultByFactory = substObjectByFactory.GetAmount(value1, value2);
   
               /* Отображение на странице результата выполнения. */
               return string.Format("Result without class replacement: {0}; Result with class replacement: {1}", resultByNew.ToString(), resultByFactory.ToString());
           }
       }
   }
   

   В коде приведены примеры создания экземпляра замещающего класса и через фабрику замещаемых объектов, и через оператор new().

6. На панели инструментов дизайнера нажмите Сохранить (Save), а затем Опубликовать (Publish).

В результате в Creatio появится пользовательский веб-сервис UsrAmountService типа REST с конечной точкой GetAmount.

Результат выполнения примера 

Чтобы вызвать пользовательский веб-сервис, из браузера обратитесь к конечной точке GetAmount веб-сервиса UsrAmountService и в качестве параметров value1 и value2 передайте 2 произвольных числа.

http://myсreatio.com/0/rest/UsrAmountService/GetAmount?value1=25&value2=125

В свойстве GetAmountResult будет возвращен результат работы пользовательского веб-сервиса без замещения классов и с замещением классов.