Инфраструктура ASP.NET MVC имеет открытый код

В отличие от предшествующих платформ веб-разработки производства Microsoft, первоначальный исходный код ASP.NET MVC доступен для свободной загрузки и даже для модификации и компиляции с целью получения собственной версии этой инфраструктуры. Это буквально неоценимо при отладке кода, обращающегося к системному компоненту, когда требуется пошагово выполнить его код (и даже ознакомиться с комментариями программистов, написавших этот код). Это также полезно, если вы создаете усовершенствованный компонент и хотите видеть, какие существуют возможности разработки, или узнать, как действительно работают встроенные компоненты.

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

Исходный код ASP.NET MVC распространяется в соответствии с открытой лицензией Microsoft (MicrosoftPublicLicense - Ms-PL) - лицензией программного обеспечения с открытым кодом, одобренной Инициативой по поддержке ПО с открытым кодом (OpenSourceInitiative - OSI). Это значит, что исходный код можно изменять, развертывать и даже распространять в виде производного проекта. Исходный код MVC доступен для загрузки по адресу ASP.NET MVC SourceCode.

При создании нового проекта ASP.NET среда VisualStudio предоставляет несколько вариантов первоначального содержимого, которое требуется для проекта. Идея состоит в том, чтобы упростить процесс изучения разработчикам-новичкам и применить экономящие время рекомендуемые приемы для распространенных средств и задач. Такая поддержка воплощена через шаблоны, используемые для создания контроллеров и представлений, которые создаются с помощью шаблонного кода для вывода списков объектов данных, редактирования свойств модели и т.д.

В версиях VisualStudio 2013 и MVC 5 разработчики из Microsoft обновили шаблоны и то, что известно как формирование шаблонов, чтобы размыть границы между разными видами проектов ASP.NET и предоставить более широкий диапазон шаблонов проектов и конфигураций кода.

Я не являюсь поклонником подобного подхода к реализации проектов или написанию кода. Намерения, конечно же, благие, однако исполнение, как правило, не вызывает восторга. Одной из характеристик ASP.NET и MVC Framework, которая мне нравится больше всего, является как раз та огромная гибкость, которая позволяет подстроить платформу для удовлетворения моего стиля разработки.

Проекты, классы и представления, создаваемые шаблонами VisualStudio, заставляют меня чувствовать, что я ограничен работой в стиле кого-то другого. Вдобавок я нахожу содержимое и конфигурацию чересчур общими и слишком безликими, чтобы приносить пользу. Это объясняется тем, что разработчики в Microsoft не могут знать, какой тип приложения вы должны создать, поэтому они охватывают все основы, но настолько обезличенным и обобщенным способом, что я в любом случае просто отбрасываю стандартное содержимое.

Я предпочитаю начинать с пустого проекта и по мере необходимости добавлять файлы и пакеты. Поступая так, вы не только лучше изучите работу MVC Framework, но также будете иметь полный контроль над тем, что содержит ваше приложение.

Однако мои предпочтения не должны влиять на ваш собственный опыт разработки. Вы можете считать шаблоны и формирование шаблонов более удобными, нежели я, особенно если вы делаете только первые шаги в разработке ASP.NET и еще не выработали свой персональный стиль. Вы также можете рассматривать шаблоны проектов как полезный ресурс и источник идей, хотя вы должны проявлять осторожность при добавлении любой функциональности к приложению, пока полностью не разберетесь как оно работает.

Создание проекта

Когда вы впервые создаете новый проект MVC Framework, у вас есть на выбор две базовых отправных точки: шаблон Empty (Пустой) и шаблон MVC. Эти имена несколько обманчивы, т.к. добавить базовые папки и сборки, требуемые для MVC Framework, можно в любой проект, отметив флажок MVC в разделе Addfoldersandcorereferencesfor (Добавить папки и основные ссылки для) диалогового окна New ASP.NET Project (Новый проект ASP.NET), как показано на рисунке ниже. В случае выбора шаблона MVC этот флажок отмечается автоматически.

Реальное отличие связано с дополнительным содержимым, которое шаблон MVC добавляет в новые проекты. Оно предоставляет готовую отправную точку, включающую стандартные контроллеры и представления, конфигурацию безопасности, ряд популярных пакетов JavaScript и CSS (таких как jQuery и Bootstrap), а также компоновку - которая применяет библиотеку Bootstrap для построения темы, оформляющей пользовательский интерфейс приложения.

Вариант Empty проекта содержит только базовые ссылки, требуемые для MVC Framework, и базовую структуру папок. Шаблон MVC добавляет довольно много содержимого, и разницу можно видеть на рисунке ниже, где показано содержимое двух созданных проектов. Проект в левой части создан с применена шаблона Empty при отмеченном флажке MVC. Проект в правой части создан с использованием шаблона MVC, и чтобы продемонстрировать все файлы в нем, пришлось открывать разные папки в окне SolutionExplorer, т.к. список файлов оказался бы слишком длинным.

Дополнительные файлы, добавляемые в проект шаблоном MVC, выглядят хуже, чем есть на самом деле. Некоторые из них относятся к аутентификации, а другие представляют собой файлы JavaScript и CSS, для которых предусмотрены обычные и минимальные версии.

Среда VisualStudio собирает проект, созданный с помощью шаблона MVC, используя пакеты NuGet, а это значит, что вы можете просмотреть, какие пакеты применяются, выбрав пункт ManageNuGetPackagesforSolution (Управление пакетами NuGet для решения) в меню Tools =>LibraryPackageManager (Сервис => Диспетчер библиотечных пакетов). Это также означает возможность добавления тех же самых пакетов в любой проект, в том числе и созданный с использованием шаблона Empty.

Какой бы шаблон вы ни выбрали, вы заметите, что результирующие проекты имеют очень похожие структуры папок. Некоторые из элементов в проекте MVC играют особые роли, жестко закодированные в ASP.NET или MVC Framework. Другие имеют отношение к соглашениям об именовании. Все эти основные файлы и папки описаны в таблице ниже, причем некоторые из них по умолчанию в проектах не присутствуют.

 

Сводка по элементам проектов MVC
Папка или файл	Описание	Примечания
/App_Data	В эту папку помещаются закрытые данные, такие как XML-файлы или базы данных, если используется SQL ServerExpress, SQLite или другие хранилища на основе файлов
/App_Start	Эта папка содержит ряд основных настроек конфигурации для проекта, в том числе определение маршрутов и фильтров, а также пакетов содержимого	Маршруты и фильтры рассматриваются позже
/Areas	Области - это способ разделения крупного приложения на меньшие части
/bin	Сюда помещается скомпилированная сборка приложения MVC вместе со всеми ссылаемыми сборками, находящимися не в GAC	Чтобы увидеть папку bin в окне SolutionExplorer, понадобится щелкнуть на кнопке ShowAllFiles (Показать все файлы). Поскольку все файлы в этой папке являются двоичными и генерируются в результате компиляции, обычно они не хранятся в системе управления исходным кодом
/Content	Сюда помещается статическое содержимое, такое как CSS-файлы и изображения	Это является необязательным соглашением. Статическое содержимое можно хранить в любом подходящем месте
/Controllers	Сюда помещаются классы контроллеров	Это является соглашением. Классы контроллеров могут размещаться где угодно, поскольку они компилируются в ту же самую сборку
/Models	Сюда помещаются классы моделей представлений и моделей предметной области, хотя все кроме простейших приложений выигрывают от определения модели предметной области в отдельном проекте	Это является соглашением. Классы моделей могут быть определены где угодно в текущем проекте или вообще вынесены в отдельный проект
/Scripts	Эта папка предназначена для хранения библиотек JavaScript, используемых в приложении. По умолчанию VisualStudio добавляет библиотеки jQuery и несколько других популярных JavaScript-библиотек	Это является соглашением. Файлы сценариев могут находиться в любом месте, т.к. в действительности они представляют собой просто другой тип статического содержимого
/Views	В этой папке хранятся представления и частичные представления, обычно сгруппированные вместе в папках с именами контроллеров, с которыми они связаны
/Views/Shared	В этой папке хранятся компоновки и представления, не являющиеся специфичными для какого-либо контроллера
/Views/Web.config	Это конфигурационный файл. В нем содержится конфигурационная информация, которая обеспечивает обработку представлений с помощью ASP.NET и предотвращает их обслуживание веб-сервером IIS, а также пространства имен, по умолчанию импортируемые в представления	Файл /Views/Web.config предотвращает обслуживание веб-сервером IIS содержимого этих папок. Представления должны визуализироваться через методы действий
/Global.asax	Это глобальный класс приложения ASP.NET. В его файле отделенного кода (Global.asax.cs) регистрируется конфигурация маршрутов, а также предоставляется любой код, который должен выполняться при запуске или завершении приложения либо в случае возникновения необработанного исключения	В приложении MVC файл Global.asax играет ту же самую роль, что и в приложении WebForms
/Web.config	Конфигурационный файл для приложения	В приложении MVC файл Web.config играет ту же самую роль, что и в приложении WebForms

Соглашения в MVC

В проекте MVC применяются два вида соглашений. Соглашения первого вида - это просто предположения о том, как может выглядеть структура проекта.

Например, общепринято размещать файлы JavaScript в папке Scripts. Здесь их рассчитывают обнаружить другие разработчики, использующие MVC, и сюда будут устанавливаться пакеты NuGet. Однако вы вольны переименовать папку Scripts или вообще удалить ее - разместив файлы сценариев где-то в другом месте. Это не помешает инфраструктуре MVC Framework запустить ваше приложение при условии, что элементы <script> внутри представлений ссылаются на местоположение, в котором находятся файлы сценариев.

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