четверг, 27 ноября 2014 г.

Антипаттерн проектирования модели данных. Использование набора битовых полей для информации о текущем статусе данных в модели данных системы.


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

Рассмотрим проблему на простом примере. Чтобы определить, что данные актуальны на текущий момент времени в структуре таблицы бд используется битовое поле EnteredStatus. Когда его значение равно true - данные были актуальны или актуальны сейчас. Если данные никогда не были актуальны EnteredStatus равно false. Чтобы обозначить данные, которые когда-то были актуальными, но в какой-то момент  времени стали неактуальными - используется поле DeletedStatus.  Когда оно равно true - данные неактуальны независимо от содержимого поля EnteredStatus. Пока это идёт на уровне проектирования БД и первичной разработка кода проекта - вроде бы ничего. Но вот система уже работает у заказчика. И при доработке кода системы разработчик видит, что если ещё добавить в модель данных битовое поле CheckedStatus - то один из модулей проекта можно значительно ускорить по быстродействию. Но как говорится поезд уже ушёл - придётся менять много кода проекта для пересоздания модели данных в классах-сущностях ORM, а самое главное на ходу модифицировать структуру бд заказчика. Причём речь идёт о десятках таблиц в постоянно используемой бд. То есть это фактически нереально по оргпричинам. А по сути проблема в изначально неправильном подходе при проектировании модели данных. Досточно статус записи в таблице определять не битовыми полями CheckedStatus, EnteredStatus и DeletedStatus, а ввести одно поле StatusId типа byte в структуру каждой таблицы с данными, имеющими статусы, и данный антипаттерн сразу исчезает. Кроме того в бд должна быть добавлена новая таблица tblStatuses (Id byte PRIMARY KEY, StatusName nvarchar) для хранения используемых типов статусов данных, первичный ключ которой связан с полями StatusId таблиц с данными при помощи внешнего ключа. Соответственно при добавлении в систему нового статуса данных структура таблиц не меняется, а в таблицу tblStatuses добавляется запись о новом статусе данных.

Анализ архитектуры winforms-приложения, разработанного при помощи варианта шаблона Model-View-Controller.


Эта заметка является продолжение небольшого цикла публикаций об архитектуре .net приложений, основанной на использовании шаблона Model-View-Controller.  В заметке "Об архитектурном шаблоне для бизнес-логики" работа типового программного приложения рассматривается как взаимодействие подсистемы бизнес-логики (Business Logic Subsystem) и подсистемы представления (Presentation Subsystem). Там же даётся детальное описание архитектуры подсистемы бизнес-логики. В заметке "Анализ архитектуры веб-приложения, разработанного на платформе asp.net mvc"  описана архитектура подсистемы представления для web-приложения, разработанного на платформе asp.net mvc. В данной заметке будет рассмотрена архитектура подсистемы представления для windows-приложения, разработанного на платформе winforms. 

I. Архитектура подсистемы представления (Presentation Subsystem)
Подсистема представления состоит из трёх основных слоёв View Layer, Application Controller, View Model. 

1. Слой View Layer представляет собой набор windows-форм. При обработке событий формы инициируется обращение к слою Application Controller, в котором определена логика работы с формами.

2. Слой View Model включает в себя логику и данные, связанные со спецификой функционирования windows-форм. Состоит из подслоёв Logic и Data.

2.1. Подслой View Model Logic состоит из групп объектов Helpers, которые реализуют функционал, связанный внутренней логикой работы windows-форм. В качестве простейшего примера можно привести логику отображения данных в двух элемента управления типа комбобокс.
Если в этих элементах отображаются данные из 2х таблиц бд, которые связаны между собой внешним ключом, то при выборе в 1м комбобоксе значения, 2й комбобокс отображает сугубо специфический набор значений из 2й таблицы бд, который определяется выбранным в 1м комбобоксе значением.

2.2. Подслой View Model Data состоит из группы объектов Models, которые представляют собой контейнеры для данных, которые отображаются на windows-формах.

01./// <summary>
02./// класс-сущность для работы с проектами
03./// </summary>
04.public class Project
05.{
06.public int Id
07.{
08.get; set;
09.}
10. 
11.public string Description
12.{
13.get; set;
14.}
15.}
16. 
17./// <summary>
18./// базовый класс подслоя View Model Data
19./// </summary>
20.public abstract class AModel
21.{
22....
23.}
24. 
25./// <summary>
26./// реализация класса модели для работы с проектами
27./// </summary>
28.public class ProjectModel : AModel
29.{
30.public Project Project
31.{
32.get; private set;
33.}
34. 
35.public ProjectModel(Project project)
36.{
37.Project = project;
38.}
39.}

3. Слой Application Controller является центральным звеном подсистемы Presentation Subsystem.  Основная функциональность подслоя следующая:
- каждый контроллер работает только с одним типом формы и содержит ссылку на экземпляр этой формы;
- в методах контроллера идет обращение к слою Domain Controller для выполнения задач бизнес-логики;
- при помощи методов BindControlsToModel и BindModelToControls контроллер реализует двунаправленный механизм, который связывает содержимое элементов управления на форме с данными, которые хранятся в объектах подслоя View Model Data.



01./// <summary>
02./// базовый класс подслоя Application Controller
03./// </summary>
04./// <typeparam name="T"></typeparam>
05.public abstract class AController<T> where T : AModel
06.{
07.public Form Form
08.{
09.get; private set;
10.}
11. 
12.public AController(Form form)
13.{
14.Form = form;
15.}
16. 
17./// <summary>
18./// Метод выполняет следующие задачи
19./// 1. собираются данные из контролов формы Form и помещаются
20./// в соответсвующие поля объекта модели типа T
21./// 2. метод возвращает объект модели, наполненный данными из контролов формы
22./// </summary>
23./// <returns></returns>
24.protected virtual T BindControlsToModel()
25.{
26....
27.}
28. 
29./// <summary>
30./// При помощи этого метода данные из полей объекта модели model
31./// помещаются в соответствующие контролы формы Form
32./// </summary>
33./// <param name="model"></param>
34.protected virtual void BindModelToControls(T model)
35.{
36....
37.}
38.}
39. 
40./// <summary>
41.///  реализация контроллера для работы с проектами
42./// </summary>
43.public class ProjectController : AController<ProjectModel>
44.{
45.public void EditProject(int projectId)
46.{
47.var args = new SelectProjectCommandArgs(projectId)
48.(new SelectProjectCommand(args)).Execute();
49. 
50.var model = new ProjectModel(args.Project);
51.BindModelToControls(model);
52.}
53. 
54.public void SaveProject()
55.{
56.var model = BindControlsToModel();
57. 
58.var args = new SaveProjectCommandArgs(model.Project)
59.(new SaveProjectCommand(args)).Execute();
60.}
61. 
62.public void DeleteProject(int projectId)
63.{
64.var args = new DeleteProjectCommandArgs(projectId)
65.(new DeleteProjectCommand(args)).Execute();
66.}
67.}

Хочется отметить, что в структуре этого класса контроллера явно прослеживается аналогия с классами-контроллерами asp.net mvc. Хотя есть и явные отличия. Так в asp.net mvc контроллер вызывает нужный вариант представления, само же представление не знает о существовании контроллера. В рассматриваемом здесь примере контроллер и форма знают о существовании друг друга. Именно в коде формы идёт обращение к контроллеру, а контроллер имеет ссылку на экземпляр формы и таким образом может работать с её контентом.

II. Алгоритм работы подсистемы представления (Presentation Subsystem)

В обработчике события на форме вызывается метод контроллера, в него передаётся ссылка на экземпляр формы и далее все действия по вызову бизнес-логики, работе с данными на форме и т.д. производит сам контроллер.

01.private void btnEdit_OnClick(object sender, EventArgs e)
02.{
03.var ctrl = new ProjectController(this);  
04.ctrl.EditProject(this.ProjectId);
05.}
06. 
07.private void btnSave_OnClick(object sender, EventArgs e)
08.{
09.var ctrl = new ProjectController(this);  
10.ctrl.SaveProject();
11.Close();
12.}

1. В обработчике события на форме создаётся экземпляр класса Application Controller, в который передётся ссылка на форму. Затем в обработчике происходит вызов нужного метода контроллера.
2. При помощи механизма биндинга, встроенного в контроллер, с элементов управления формы собираются данные, которыми наполняется объект модели View Model Data.

3. Application Controller формирует запрос к Domain Controller. Для этого перекладываются данные из объекта модели в объект CommandArgs. Эти данные представляют собой входные данные для отработки бизнес-логики. Далее создаётся объект класса нужной команды. В команду через конструктор передаётся объект CommandArgs и вызывается метод Execute у объекта команды.

4. Слой Domain Controller после отработки соответствующего ему функционала бизнес-логики возвращает в том же объекте CommandArgs выходные данные, полученные в результате отработки бизнес-логики

5. Application Controller на основе выходных данных бизнес-логики, находящихся в объекте CommandArgs, формирует объект View Model Data данные из которого при помощи механизма биндинга прорисовываются в элементах управления на форме.

Это максимально общий подход к функционированию winforms приложения. Безусловно он потребует дополнительных затрат по написанию кода из-за наличия двух типов контейнеров данных. На каждое обращения с формы к бизнес-логике будут использоваться два контейнера данных - объект View Model Data на стороне Presentation Subsystem и объект CommandArgs на стороне Business Logic Subsystem. Но это неизбежно если мы хотим полностью разделить между собой функционал бизнес-логики и функционал, связанный с прорисовкой визуального интерфейса.

Анализ архитектуры веб-приложения, разработанного на платформе asp.net mvc.

 

В этой заметке проводится структурный анализ архитектуры веб-приложения, разработанного на платформе asp.net mvc.
Часть материала повторит изложенную в них информацию.
Изначально предполагается, что схему работы типового программного приложения можно формализовать в виде взаимодействия подсистемы бизнес-логики (Business Logic Subsystem) и подсистемы визульного представления (Presentation Subsystem). При этом  Business Logic Subsystem должна оставалась неизменной при использовании различный технологий для создания Presentation Subsystem  (Asp.net, WinForms, WPF, Win32 сервис, веб-сервис, консольное приложение).


I. Подсистема визульного представления (Presentation Subsystem) состоит из трёх основных слоёв.
1. Слой Application Controller является центральным звеном всего приложения. Состоит их подслоёв Request Logic и Application Logic.
1.1. Подслой Request Logic представляет собой реализацию шаблона Front Controller, которая приведена в книге Фаулера "Архитектура корпоративных программных приложений". В данном подслое, по введённому пользователем url, происходит вызов метода соответствующего asp.net mvc контроллера. Далее из метода идёт обращение к подслою Application Logic.
1.2. Подслой Application Logic по функциональности представляет собой именно тот контроллер приложения (Application Controller) о котором пишет Фаулер в вышеупомянутой книге (стр 397-399). Функциональность этого подслоя следующая:
- идет обращение к слою Domain Controller для выполнения задач бизнес-логики;
- в соответствии с данными полученными от Domain Controller создаётся и наполняется нужный тип объекта данных View Model Data;
- для отображения в броузере вызывается нужный экземпляр представления View и в него передаётся объекта данных View Model Data.
2. Слой View Model включает в себя функционал и данные для отображения в веб-формах. Состоит из подслоёв Logic и Data.
2.1. Подслой View Model Logic состоит из групп объектов Helpers и DataBinders.
- объекты Helpers реализуют логику прорисовки данных на веб-формах. Конечно в веб-приложениях функционал этой логики не такой богатый как для WinForms. В качестве простейшего примера можно привести логику заполнения элемента управления типа комбобокс - заполнять только данными из справочной таблицы или ещё добавить пустой элемент, чтобы дать пользователю возможность не выбрать ни один из элементов в комбобоксе при сабмите на другую веб-форму.
- объекты DataBinders реализуют механизм, связывающий элементы управления на форме с данными, которые хранятся объектах подслоя View Model Data,
как при прорисовке данных на форме, так и при сборе данных с формы для сабмита на следующую веб-форму. Этот уже готовый функционал - он встроен в механизм asp.net  mvc.
2.2. Подслой View Model Data состоит из группы объектов Models, которые представляют собой контейнеры для данных, которые отображаются на веб-формах. Различия между данными подслоёв View Model Data и Domain Model Data прекрасно описаны в статье Александра Бындю "ViewModel и Domain Model: Границы ответственности".
3. Слой View Layer представляет собой набор веб-форм, которые прорисовываются в броузере.
II. Подсистема бизнес-логики (Business Logic Subsystem) состоит из трёх основных слоёв.
1. Слой Domain Controller инкапсулирует функциональность типа единица работы (Unit of Work) при обращению к бизнес-логике из подсистемы представления. Состоит из подслоёв Logic и Data.
1.1. Подслой Domain Controller Logic состоит из группы объектов Commands в которых реализована функциональность типа единица работы. Объекты Commands реализуют паттерны Command и Unit of Work.
1.2. Подслой Domain Controller Data состоит из группы объектов CommandArgs (названы по аналогии с классами аргументов событий EventArgs), которые являются контейнеры для объектов, которыми обмениваются между собой Business Logic Subsystem и Presentation Subsystem. Объекты CommandArgs реализуют паттерн Facade.
1.3. Объекты Domain Controller Logic используют объекты Domain Controller Data в качестве хранилища данных.
2. Слой Domain Model инкапсулирует бизнес-логику  системы. Состоит из подслоёв Logic и Data.
2.1. Подслой Domain Model Logic состоит из группы объектов Services в которых реализованы алгоритмы бизнес-логики системы.
2.2. Подслой Domain Model Data состоит из групп объектов Entities, Wrappers, Data Transfer Objects, которые являются хранилищами данных бизнес-логики системы.
- объекты Entities представляют собой сущности бизнес-логики. Обычно их структура соответствует структуре данных в таблицах баз данных проекта.
- объекты Wrappers могут иметь разное содержание. В общем случае можно сказать что это хранилища данных, структура которых выходит за рамки объектов-сущностей.
- объекты Data Transfer Objects используются при обмене данными при помощи веб-сервисов.
2.3. Объекты Domain Model Logic используют объекты Domain Model Data в качестве хранилища данных.
3. Слой Persistence Layer инкапсулирует функциональность, связанную с непосредственной работой с данными в источнике данных. Состоит из подслоёв Repository и DataSourceFactory.
3.1. Подслой Repository реализует функциональность для сохранения, извлечения и поиска объектов в источнике данных. Repository скрывает от слоя
Domain Model  детали работы с данными в источнике данных. Состоит из групп объектов - FileDataRepository, DatabaseRepository, ActiveDirectoryRepository, LdapDataRepository, WebserviceRepository.
3.2. Подслой DataSourceFactory реализует функциональность, связанную с доступом к источнику данных. Состоит из групп объектов - FileFactory,  DatabaseFactory, ActiveDirectoryFactory, LdapDataFactory, WebserviceFactory.
3.3. Объекты Repository используют объекты DataSourceFactory в качестве источников данных.  


Шаблоны Session Facade и Pojo Facade с точки зрения .net разработчика.



Шаблон Session Facade описан в книге Алур, Крупи, Малкс "Образцы J2EE". Шаблон Pojo Facade описан в книге Ричардсона "POJOs in Action".

Session Facade реализован на базе специфической для java технологии J2EE. Функционал Pojo Facade основан на использовании простых Pojo-объектов, которые в .net имеют полную аналогию в виде Poco-объектов. Шаблон Pojo Facade фактически реализует функционал аналогичный Session Facade, но не используя при этом технологию J2EE.

Набор основных функций шаблона Session Facade описан следующим образом:
- вводит бизнес-уровень контроллера;
- предоставляет унифицированный интерфейс;
- обеспечивает доступ общего назначения;
- централизует управление безопасностью;
- централизует управление транзакциями.

Ещё одна цитата: "POJO facade exposes a coarse-grained interface to the presentation tier. It handles requests from the presentation tier by delegating to the business logic."

Таким образом, если сказать сжато, то Session Facade и Pojo Facade представляют собой промежуточное звено между клиенской частью системы (уровнем представления) и уровнем бизнес-логики. Но как раз подобный слой приложения детально описан с примерами c# кода в заметке "Об архитектурном шаблоне для бизнес-логики" в качестве unit of work контроллера и назван там Domain Controller.