ASP.NET MVC: Переходим с MVC 3 на MVC 4

Серия статей "История одного проекта" написана с использованием MVC 3. В этой статье будем переходить на MVC 4.

Задача

Требуется:

1. Перевести проект "Музей Юмора" с ASP.NET MVC 3 на новую версию ASP.NET MVC 4. При этом .NET Framework пока менять не будем, то есть оставим 4.0.
2. Отказаться от использования ASP.NET Membership в пользу SimpleMembershipProvider.

Просто или правильно

На официальном сайте asp.net есть статья “Upgrading an ASP.NET MVC 3 Project to ASP.NET MVC 4” которая рассказывает как обновить проект. Описано всё просто и поэтому я останавливаться не буду на этом, а лишь укажу основные пункты:

• Создаем чистый проект ASP.NET MVC 4
• Копируем нужные файлы из проекта на MVC 3 во вновь созданный: контролеры, скрипты, представления… Короче всё, что нужно для работы проекта.
• Копируем web.config и начинаем его править ручками.

1. Меняем строки файла конфигурации:

System.Web.Mvc, Version=3.0.0.0
System.Web.WebPages, Version=1.0.0.0
System.Web.Helpers, Version=1.0.0.0
System.Web.WebPages.Razor, Version=1.0.0.0

На новые:

System.Web.Mvc, Version=4.0.0.0
System.Web.WebPages, Version=2.0.0.0
System.Web.Helpers, Version=2.0.0.0
System.Web.WebPages.Razor, Version=2.0.0.0

2. Добавляем новый параметр приложения PreserveLoginUrl:

<appSettings>
  <add key="webpages:Version" value="2.0.0.0" />
  <add key="PreserveLoginUrl" value="true" />
</appSettings>

3. Обновляем nuget-пакеты. Благо теперь появилась новая опция  –reinstall, которая при необходимости удалит пакет и потом заново установит его.

4. В файле проекта надо поменять ProjectTypeGuids. Выгружаем проект, открываем файл проекта для редактирования и меняем:

{E53F8FEA-EAE0-44A6-8774-FFD645390401}

на новый:

{E3E379DF-F4C6-4180-9B81-6769533ABE47}

После этого сохраняем файл и даем команду перезагрузить проект.

5. И напоследок, если ваше приложение содержит сторонние сборки ссылающиеся на MVC фреймворк, то следует обновить еще и эту часть в файле конфигурации:

   1:  <configuration>
   2:    <!--... элементы удалены для ясности ...-->
   3:
   4:    <runtime>
   5:      <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
   6:        <dependentAssembly>
   7:          <assemblyIdentity name="System.Web.Helpers"
   8:               publicKeyToken="31bf3856ad364e35" />
   9:          <bindingRedirect oldVersion="1.0.0.0" newVersion="2.0.0.0"/>
  10:        </dependentAssembly>
  11:        <dependentAssembly>
  12:          <assemblyIdentity name="System.Web.Mvc"
  13:               publicKeyToken="31bf3856ad364e35" />
  14:          <bindingRedirect oldVersion="1.0.0.0-3.0.0.0" newVersion="4.0.0.0"/>
  15:        </dependentAssembly>
  16:        <dependentAssembly>
  17:          <assemblyIdentity name="System.Web.WebPages"
  18:               publicKeyToken="31bf3856ad364e35" />
  19:          <bindingRedirect oldVersion="1.0.0.0" newVersion="2.0.0.0"/>
  20:        </dependentAssembly>
  21:      </assemblyBinding>
  22:    </runtime>
  23:  </configuration>

После этого ваш проект должен откомпилироваться и запуститься. У меня не получилось с первого раза, мне пришлось еще немного повозиться. В основном с установкой правильных версий nuget-пакетов под новый MVC 4.

Хочется верить, что у вас всё получилось с первого раза и поэтому продолжим.

WebSecurity и  SimpleMembershipProvider

В новом шаблоне сайта для MVC4 используется WebSecurity и SimpleMembershipProvider. WebSecurity официально рекомендован для использования при построении сайтов на ASP.NET:

“По умолчанию WebSecurity использует упрощенную схему базы данных членства по сравнению тем, что поддерживает механизм членства в ASP.NET. Это сделано по нескольким причинам. Одна из них — то, что класс SimpleMembershipProvider не реализует все функции членства ASP.NET, и поэтому не приходится отслеживать большой объем информации. Еще один фактор — то, что упрощенная схема удобнее для работы и не требует прямых запросов к базе данных. Наконец, упрощенная схема была разработана специально для упрощения интеграции членства с существующими таблицами базы данных, которые уже содержат имена пользователей и адреса электронной почты.”

SimpleMembershipProvider на сайте MSDN описан так:

“Предоставляет поддержку для задач членства на веб-сайте, например создания учетных записей, удаления учетных записей и управления паролями.”

“Вспомогательный класс WebSecurity рекомендуется использовать для управления пользовательскими учетными записями, паролями и другими задачами членства. Класс SimpleMembershipProvider также может управлять членством; тем не менее, это не рекомендуется делать ввиду того, что WebSecurity предоставляет более простой способ управления членством. Класс SimpleMembershipProvider предназначен для разработчиков, которым требуется более точно контролировать членство.”

Таким образом, чтобы сайт работал быстрее и управление стало проще – нужно использовать новые возможности. Это я и собираюсь сделать.

Обновление базы данных

Во первой части цикла статей ИОП “Музей Юмора”, в которой речь идет о данных я рассказывал, как при помощи утилиты aspnet_regsql.exe добавить Memebership-функционал. Сейчас я намерен поступить наоборот, то есть удалить этот функционал из базы.

Внимание:Я с легкостью собираюсь удалить данные о пользователях потому что я единственный, кто зарегистрирован на сайте. И значит после создания нового SimpleMembershipProvider, я просто заново зарегистрируюсь. Если у вас сайт содержит информация о пользователях и об их профилях, то последующие действия не следует делать. Ну, в крайнем случае, сделайте архивную копию базы (backup). И попробуйте самостоятельно проделать операцию “переноса” пользователей из старого Membership в новый.

Итак, запустим эту самую утилиту:

На этот раз я выберу опцию “Remove”.

Работа утилиты завершилась с ошибкой, выдав сообщение:

“Исключение:
Не удается удалить указанные функции, так как таблица SQL 'aspnet_Membership' в базе данных '[museumDb]' не является пустой. Сначала требуется удалить все строки из этой таблицы.”

Придётся сначала “вручную” очистить все связанные таблицы. У меня получилось затратить на чистку не более пяти минут. Вот база “до” чистки:

А вот уже после того, как отработала утилита:

Обратите внимания, что также все StoredProcedures были удалены. Если вы делаете удаление “вручную”, то есть без использования утилиты, то не забудьте удалить всё что было ей установлено.

Самое интересное

В новом шаблоне сайта для MVC 4 есть папка Filters, в которой есть файл  InitializeSimpleMembershipAttribute.cs. Этот файл содержит класс атрибута, установка которого на контроллере AccountController гарантирует, что перед использованием Membership (вход на сайт или регистрация), если еще нет инфраструктуры для работы Membership, то будут созданы все необходимые для этого таблицы в базе данных. Если вы не будете использовать на своем сайте вход/регистрацию, то эта инфраструктура (таблицы) не появятся в вашей базе.

Теперь посмотрим на что случится, если просто запустить сайт:

“The model backing the 'MuseumContext' context has changed since the database was created. Consider using Code First Migrations to update the database (http://go.microsoft.com/fwlink/?LinkId=238269).”

Собственно этого я и ждал. Запустим процесс обновления базы, я это делаю из Package Manager Console:

PM> Update-Database
Specify the '-Verbose' flag to view the SQL statements being applied to the target database.
No pending code-based migrations.
Applying automatic migration: 201210120304152_AutomaticMigration.
Running Seed method.
PM>

Запускаю еще раз сайт - работает, но только теперь сайт и понятия не имеет, что такое Membership. Вернемся к ранее упомянутому атрибуту InitializeSimpleMembershipAttribute.

Я его немного доработал, чтобы сразу при создании базы данных запускался процесс создания пользователя (меня).

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method,
    AllowMultiple = false, Inherited = true)]
public sealed class InitializeSimpleMembershipAttribute : ActionFilterAttribute {
    private static SimpleMembershipInitializer _initializer;
    private static object _initializerLock = new object();
    private static bool _isInitialized;

    public override void OnActionExecuting(ActionExecutingContext filterContext) {

        // Ensure ASP.NET Simple Membership is initialized only once per app start
        LazyInitializer.EnsureInitialized(ref _initializer, ref _isInitialized, ref _initializerLock);
    }

    private class SimpleMembershipInitializer {

        public SimpleMembershipInitializer() {
            Database.SetInitializer<MuseumContext>(null);

            try {
                using (var context = new MuseumContext()) {
                    if (!context.Database.Exists()) {

                        // Create the SimpleMembership database without
                        // Entity Framework migration schema
                        ((IObjectContextAdapter)context).ObjectContext.CreateDatabase();
                    }
                }

                WebSecurity.InitializeDatabaseConnection("DefaultConnection",
                    "Users", "UserId", "UserName", autoCreateTables: true);

                // получаем провайдер ролей на сайте.
                var roles = (SimpleRoleProvider)Roles.Provider;

                //Получаем провайдер членства
                var membership = (SimpleMembershipProvider)Membership.Provider;

                // проверяю наличие роли Administrator
                bool isExists = roles.GetAllRoles().Contains("Administrator");

                // добавляю, если роли нет
                if (!isExists) {
                    roles.CreateRole("Administrator");
                }

                // проверяю наличие зарегистрированного пользователя
                MembershipUser user = membership.GetUser("Calabonga", false);

                //создаю, если пользователя не найдено
                if (user == null) {
                    membership.CreateUserAndAccount("Calabonga", "123123");
                }

                //добавляю пользователю права администратора
                if (!roles.GetRolesForUser("Calabonga").Contains("Administrator")) {
                    roles.AddUsersToRoles(
                        new string[] { "Calabonga" },
                        new string[] { "Administrator" });
                }
            }
            catch (Exception ex) {
                throw new InvalidOperationException(
                    @"The ASP.NET Simple Membership database could
                not be initialized.
                For more information,
                please see http://go.microsoft.com/fwlink/?LinkId=256588", ex);
            }
        }
    }
}

Все изменения начинаются в строке 32 и заканчиваются в строке 59. Я постарался всё описать в комментариях. Запустил, проверил – да, действительно работает. Остается только перейти на страницу смены пароля и поменять на более “правильный”.

После первого входа на сайт в базе данных добавилось немного таблиц:

Заключение

Для того чтобы сайт начала работать с новыми провайдерами, надо указать в файле конфигурации (web.config) следующие параметры:

<roleManager enabled="true"
              defaultProvider="SimpleRoleProvider">
   <providers>
     <clear />
     <add
       name="SimpleRoleProvider"
       type="WebMatrix.WebData.SimpleRoleProvider, WebMatrix.WebData" />
   </providers>
 </roleManager>
 <membership
   defaultProvider="SimpleMembershipProvider">
   <providers>
     <clear />
     <add
       name="SimpleMembershipProvider"
       type="WebMatrix.WebData.SimpleMembershipProvider, WebMatrix.WebData" />
   </providers>
 </membership>

Последнее, что остается сделать - это запустить процесс инициализации соединения с базой данных. Я выбрал простой, на мой взгляд, вариант. В корне приложения создал файл _AppStart.cshtml, и поместил в него код инициализации:

@{
    if (!WebSecurity.Initialized) {
        WebSecurity.InitializeDatabaseConnection("DefaultConnection",
                           "Users", "UserId", "UserName", autoCreateTables: true);
    }
}

Вот теперь точно всё - поставленная задача успешно выполнена.