Original edition copyright 2011 by Adam Freeman and Steven Sanderson. All rights reserved.

Transkrypt

1

2 Tytuł oryginału: Pro ASP.NET MVC 3 Framework Tłumaczenie: Paweł Gonera ISBN: Original edition copyright 2011 by Adam Freeman and Steven Sanderson. All rights reserved. Polish edition copyright 2012 by HELION SA. All rights reserved. All rights reserved. No part of this book may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording or by any information storage retrieval system, without permission from the Publisher. Wszelkie prawa zastrzeżone. Nieautoryzowane rozpowszechnianie całości lub fragmentu niniejszej publikacji w jakiejkolwiek postaci jest zabronione. Wykonywanie kopii metodą kserograficzną, fotograficzną, a także kopiowanie książki na nośniku filmowym, magnetycznym lub innym powoduje naruszenie praw autorskich niniejszej publikacji. Wszystkie znaki występujące w tekście są zastrzeżonymi znakami firmowymi bądź towarowymi ich właścicieli. Wydawnictwo HELION dołożyło wszelkich starań, by zawarte w tej książce informacje były kompletne i rzetelne. Nie bierze jednak żadnej odpowiedzialności ani za ich wykorzystanie, ani za związane z tym ewentualne naruszenie praw patentowych lub autorskich. Wydawnictwo HELION nie ponosi również żadnej odpowiedzialności za ewentualne szkody wynikłe z wykorzystania informacji zawartych w książce. Wydawnictwo HELION ul. Kościuszki 1c, GLIWICE tel , helion@helion.pl WWW: (księgarnia internetowa, katalog książek) Pliki z przykładami omawianymi w książce można znaleźć pod adresem: ftp://ftp.helion.pl/przyklady/aspmv3.zip Drogi Czytelniku! Jeżeli chcesz ocenić tę książkę, zajrzyj pod adres Możesz tam wpisać swoje uwagi, spostrzeżenia, recenzję. Printed in Poland. Kup książkę Poleć książkę Oceń książkę Księgarnia internetowa Lubię to!» Nasza społeczność

3 Spis tre ci O autorach...5 O recenzencie technicznym...7 Cz I Wprowadzenie do ASP.NET MVC Rozdzia 1. Zagadnienia ogólne...21 Krótka historia programowania witryn 21 Tradycyjna technologia ASP.NET Web Forms Co poszło nie tak z ASP.NET Web Forms? Programowanie witryn WWW stan obecny Standardy WWW oraz REST Programowanie zwinne i sterowane testami Ruby on Rails Sinatra Node.js Najważniejsze zalety ASP.NET MVC...26 Architektura MVC Rozszerzalność Ścisła kontrola nad HTML i HTTP Łatwość testowania Zaawansowany system routingu Zbudowany na najlepszych częściach platformy ASP.NET Nowoczesne API ASP.NET MVC jest open source Kto powinien korzystać z ASP.NET MVC? Porównanie z ASP.NET Web Forms Migracja z Web Forms do MVC Porównanie z Ruby on Rails Porównanie z MonoRail Co nowego w ASP.NET MVC 3? Podsumowanie... 31

4 SPIS TRE CI Rozdzia 2. Przygotowania...33 Przygotowanie stacji roboczej Instalowanie Visual Studio Instalowanie podstawowego oprogramowania Instalowanie opcjonalnych komponentów Przygotowanie serwera Włączanie roli serwera 37 Instalowanie dodatkowych komponentów Konfigurowanie Web Deployment Uzyskiwanie dalszych informacji Podsumowanie Rozdzia 3. Pierwsza aplikacja MVC...43 Tworzenie nowego projektu ASP.NET MVC Dodawanie pierwszego kontrolera Przedstawiamy ścieżki Generowanie stron 47 Tworzenie i generowanie widoku Dynamiczne dodawanie treści...50 Tworzenie prostej aplikacji wprowadzania danych Przygotowanie sceny Projektowanie modelu danych Łączenie metod akcji Budowanie formularza Obsługa formularzy Dodanie kontroli poprawności...60 Kończymy Podsumowanie Rozdzia 4. Wzorzec MVC...67 Historia MVC Wprowadzenie do wzorca MVC Budowa modelu domeny Implementacja MVC w ASP.NET Porównanie MVC z innymi wzorcami Przedstawiamy wzorzec Smart UI Modelowanie domeny Przykładowy model domeny...73 Wspólny język Agregaty i uproszczenia Definiowanie repozytoriów Budowanie luźno połączonych komponentów Wykorzystanie wstrzykiwania zależności Przykład specyficzny dla MVC...78 Użycie kontenera wstrzykiwania zależności Zaczynamy testy automatyczne Zadania testów jednostkowych...80 Zadania testów integracyjnych Podsumowanie Rozdzia 5. Najwa niejsze cechy j zyka...89 Najważniejsze cechy C# Użycie automatycznie implementowanych właściwości Użycie inicjalizatorów obiektów i kolekcji

5 SPIS TRE CI Użycie metod rozszerzających Użycie wyrażeń lambda Automatyczne wnioskowanie typów Użycie typów anonimowych...99 Wykonywanie zapytań zintegrowanych z językiem Przedstawiamy składnię silnika Razor Tworzenie projektu Prosty widok korzystający z silnika Razor Podsumowanie Rozdzia 6. Wa ne narz dzia wspieraj ce MVC Użycie Ninject Tworzenie projektu Zaczynamy korzystać z Ninject Tworzenie łańcucha zależności Definiowanie wartości właściwości i parametrów Użycie samodzielnego łączenia Dołączanie do typu pochodnego Użycie łączenia warunkowego Użycie Ninject w ASP.NET MVC Testowanie jednostkowe w Visual Studio Tworzenie projektu Tworzenie testów jednostkowych Uruchamianie testów (nieudane) Implementacja funkcji Użycie Moq Dodawanie Moq do projektu Visual Studio Tworzenie imitacji za pomocą Moq Testy jednostkowe z użyciem Moq Weryfikowanie przy użyciu Moq Podsumowanie Rozdzia 7. SportsStore kompletna aplikacja Zaczynamy Tworzenie rozwiązania i projektów w Visual Studio Dodawanie referencji Konfigurowanie kontenera DI Uruchamiamy aplikację Tworzenie modelu domeny Tworzenie abstrakcyjnego repozytorium Tworzenie imitacji repozytorium Wyświetlanie listy produktów Dodawanie kontrolera Dodawanie widoku Konfigurowanie domyślnej ścieżki Uruchamianie aplikacji Przygotowanie bazy danych Tworzenie bazy danych Definiowanie schematu bazy danych Dodawanie danych do bazy Tworzenie kontekstu Entity Framework Tworzenie repozytorium produktów

6 SPIS TRE CI Dodanie stronicowania Wyświetlanie łączy stron Ulepszanie adresów URL Dodawanie stylu Definiowanie wspólnej zawartości w pliku układu Dodanie zasad CSS Tworzenie widoku częściowego Podsumowanie Rozdzia 8. SportsStore nawigacja i koszyk na zakupy Dodawanie kontrolek nawigacji Filtrowanie listy produktów Ulepszanie schematu URL Budowanie menu nawigacji po kategoriach Poprawianie licznika stron Budowanie koszyka na zakupy Definiowanie encji koszyka Tworzenie przycisków koszyka Implementowanie kontrolera koszyka Wyświetlanie zawartości koszyka Użycie dołączania danych Tworzenie własnego łącznika modelu Kończenie budowania koszyka Usuwanie produktów z koszyka Dodawanie podsumowania koszyka Składanie zamówień Rozszerzanie modelu domeny Dodawanie procesu zamawiania Implementowanie procesora zamówień Rejestrowanie implementacji Dokańczanie kontrolera koszyka Wyświetlanie informacji o błędach systemu kontroli poprawności Wyświetlanie strony podsumowania Podsumowanie Rozdzia 9. SportsStore administracja Dodajemy zarządzanie katalogiem Tworzenie kontrolera CRUD Generowanie tabeli z produktami dostępnymi w repozytorium Tworzenie nowego pliku układu Implementowanie widoku listy Edycja produktów Tworzenie nowych produktów Usuwanie produktów Zabezpieczanie funkcji administracyjnych Konfiguracja uwierzytelniania Forms Realizacja uwierzytelniania z użyciem filtrów Tworzenie dostawcy uwierzytelniania Tworzenie kontrolera AccountController Tworzenie widoku Przesyłanie zdjęć Rozszerzanie bazy danych Rozszerzanie modelu domeny

7 SPIS TRE CI Tworzenie interfejsu użytkownika do przesyłania plików Zapisywanie zdjęć do bazy danych Implementowanie metody akcji GetImage Wyświetlanie zdjęć produktów Podsumowanie Cz II ASP.NET MVC 3 szczegó owy opis Rozdzia 10. Przegl d projektu MVC Korzystanie z projektów MVC z Visual Studio Użycie kontrolerów aplikacji internetowej i intranetowej Przedstawiamy konwencje MVC Debugowanie aplikacji MVC Tworzenie projektu Uruchamianie debugera Visual Studio Przerywanie pracy aplikacji przez debuger Visual Studio Użycie opcji Edit and Continue Wstrzykiwanie zależności na poziomie projektu Podsumowanie Rozdzia 11. Adresy URL, routing i obszary Wprowadzenie do systemu routingu Tworzenie projektu routingu Wprowadzenie do wzorców URL Tworzenie i rejestrowanie prostej ścieżki Definiowanie wartości domyślnych Użycie statycznych segmentów adresu URL Definiowanie własnych zmiennych segmentów Definiowanie opcjonalnych segmentów URL Definiowanie ścieżek o zmiennej długości Definiowanie priorytetów kontrolerów na podstawie przestrzeni nazw Ograniczenia ścieżek Routing żądań dla plików dyskowych Pomijanie systemu routingu Generowanie wychodzących adresów URL Przygotowanie projektu Generowanie wychodzących adresów URL w widokach Generowanie wychodzących adresów URL w metodach akcji Generowanie adresu URL na podstawie wybranej ścieżki Dostosowanie systemu routingu Tworzenie własnej implementacji RouteBase Tworzenie własnego obiektu obsługi ścieżki Korzystanie z obszarów Tworzenie obszaru Wypełnianie obszaru Rozwiązywanie problemów z niejednoznacznością kontrolerów Generowanie łączy do akcji z obszarów Najlepsze praktyki schematu adresów URL Twórz jasne i przyjazne dla człowieka adresy URL GET oraz POST wybierz właściwie Podsumowanie

8 SPIS TRE CI Rozdzia 12. Kontrolery i akcje Wprowadzenie do kontrolerów Przygotowanie projektu Tworzenie kontrolera z użyciem interfejsu IController Tworzenie kontrolera przez dziedziczenie po klasie Controller Odczytywanie danych wejściowych Pobieranie danych z obiektów kontekstu Użycie parametrów metod akcji Tworzenie danych wyjściowych Wyniki akcji Zwracanie kodu HTML przez generowanie widoku Przekazywanie danych z metody akcji do widoku Wykonywanie przekierowań Zwracanie danych tekstowych Zwracanie danych XML Zwracanie danych JSON Zwracanie plików i danych binarnych Zwracanie błędów i kodów HTTP Tworzenie własnego wyniku akcji Podsumowanie Rozdzia 13. Filtry Użycie filtrów Wprowadzenie do czterech podstawowych typów filtrów Dołączanie filtrów do kontrolerów i metod akcji Użycie filtrów autoryzacji Użycie filtrów wyjątków Użycie filtrów akcji i wyniku Użycie innych funkcji filtrów Użycie filtrów wbudowanych Podsumowanie Rozdzia 14. Rozszerzanie kontrolerów Komponenty potoku przetwarzania żądania Tworzenie własnej fabryki kontrolerów Definiowanie własnej fabryki kontrolerów Rejestrowanie własnej fabryki kontrolerów Wykorzystanie wbudowanej fabryki kontrolerów Nadawanie priorytetów przestrzeniom nazw Dostosowywanie sposobu tworzenia kontrolerów w DefaultControllerFactory Tworzenie własnego obiektu wywołującego akcje Użycie wbudowanego obiektu wywołującego akcje Użycie własnych nazw akcji Selekcja metod akcji Użycie selektorów metod akcji do obsługi żądań REST Poprawianie wydajności z użyciem specjalizowanych kontrolerów Użycie kontrolerów bezstanowych Użycie kontrolerów asynchronicznych Podsumowanie

9 SPIS TRE CI Rozdzia 15. Widoki Tworzenie własnego silnika widoku Tworzenie własnej implementacji IView Tworzenie implementacji IViewEngine Rejestrowanie własnego silnika widoku Korzystanie z silnika Razor Sposób generowania widoków przez Razor Wstrzykiwanie zależności w widokach Razor Konfigurowanie wyszukiwania lokalizacji widoków Dodawanie dynamicznych treści do widoku Razor Użycie kodu wbudowanego Użycie metod pomocniczych HTML Tworzenie wewnętrznej metody pomocniczej HTML Tworzenie zewnętrznej metody pomocniczej HTML Użycie wbudowanych metod pomocniczych Zastosowanie sekcji Sprawdzanie istnienia sekcji Generowanie sekcji opcjonalnych Użycie widoków częściowych Tworzenie widoku częściowego Użycie silnie typowanych widoków częściowych Użycie akcji podrzędnych Tworzenie akcji podrzędnych Wywoływanie akcji podrzędnych Podsumowanie Rozdzia 16. Szablony modelu Użycie metod pomocniczych widoku szablonowego Nadawanie stylów wygenerowanym znacznikom HTML Użycie metadanych modelu Użycie metadanych wartości danych Korzystanie z parametrów typów złożonych Dostosowywanie systemu metod pomocniczych widoku szablonowego Tworzenie własnego szablonu edytora Tworzenie własnego szablonu wyświetlania Tworzenie szablonu ogólnego Wymiana szablonów wbudowanych Użycie właściwości ViewData.TemplateInfo Przekazywanie dodatkowych metadanych do szablonu System dostawców metadanych Tworzenie własnego dostawcy metadanych modelu Dostosowywanie adnotacji danych dostawcy metadanych modelu Podsumowanie Rozdzia 17. Do czanie modelu Użycie dołączania danych Użycie domyślnego łącznika modelu Dołączanie typów prostych Dołączanie typów złożonych Dołączanie tablic i kolekcji

10 SPIS TRE CI Jawne wywoływanie dołączania modelu Ograniczanie dołączania do wybranego źródła danych Obsługa błędów dołączania modelu Użycie dołączania modelu w celu pobierania przesłanych plików Dostosowanie systemu dołączania danych Tworzenie własnego dostawcy wartości Tworzenie łącznika modelu obsługującego zależności Tworzenie własnego łącznika modelu Tworzenie dostawcy łączników modelu Użycie atrybutu ModelBinder Podsumowanie Rozdzia 18. Kontrola poprawno ci modelu Tworzenie projektu Jawna kontrola poprawności modelu Wyświetlanie komunikatów kontroli poprawności Wyświetlanie komunikatów kontroli poprawności poziomu właściwości Użycie alternatywnych technik kontroli poprawności Kontrola poprawności w łączniku modelu Definiowanie zasad poprawności za pomocą metadanych Definiowanie modeli samokontrolujących się Tworzenie własnego dostawcy kontroli poprawności Użycie kontroli poprawności po stronie klienta Aktywowanie i wyłączanie kontroli poprawności po stronie klienta Użycie kontroli poprawności po stronie klienta Jak działa kontrola poprawności po stronie klienta? Modyfikowanie kontroli poprawności na kliencie Wykonywanie zdalnej kontroli poprawności Podsumowanie Rozdzia 19. Nieprzeszkadzaj cy Ajax Użycie nieprzeszkadzających wywołań Ajax w MVC Tworzenie projektu Włączanie i wyłączanie nieprzeszkadzających wywołań Ajax Użycie nieprzeszkadzających formularzy Ajax Sposób działania nieprzeszkadzających wywołań Ajax Ustawianie opcji Ajax Zapewnienie kontrolowanej degradacji Informowanie użytkownika o realizowanym żądaniu Ajax Wyświetlanie pytania przed wysłaniem żądania Tworzenie łączy Ajax Zapewnienie kontrolowanej degradacji dla łączy Korzystanie z funkcji wywołania zwrotnego w Ajaksie Wykorzystanie JSON Dodanie obsługi JSON do kontrolera Przetwarzanie JSON w przeglądarce Wykrywanie żądań Ajax w metodach akcji Odbieranie danych JSON Podsumowanie

11 SPIS TRE CI Rozdzia 20. jquery Tworzenie projektu Odwoływanie się do jquery Tworzenie kodu jquery Utworzenie środowiska testowego dla jquery Podstawy jquery Poznajemy selektory jquery Użycie filtrów jquery Poznajemy metody jquery Czekając na DOM Użycie metod CSS z jquery Manipulowanie modelem DOM Użycie zdarzeń jquery Użycie efektów wizualnych jquery Użycie jquery UI Odwoływanie się do jquery UI Tworzenie lepszych przycisków Użycie kontrolki Slider Podsumowanie Cz III Tworzenie udanych projektów ASP.NET MVC Rozdzia 21. Bezpiecze stwo i s abe punkty Każde dane mogą być sfałszowane Fałszowanie żądań HTTP Skrypty międzywitrynowe i wstrzykiwanie HTML Przedstawiamy ataki XSS Kodowanie HTML w Razor Kontrola żądań Kodowanie ciągów znaków JavaScript a XSS Przejęcie sesji Obrona przez sprawdzanie adresu IP klienta Obrona przez ustawienie w cookie znacznika HttpOnly Międzywitrynowe fałszowanie żądań Atak Obrona Ochrona przed atakami CSRF z użyciem metod zapobiegających fałszerstwom Wstrzykiwanie SQL Atak Obrona z użyciem zapytań parametrycznych Obrona z użyciem odwzorowania obiektowo-relacyjnego Bezpieczne korzystanie z biblioteki MVC Nie udostępniaj przypadkowo metod akcji Nie używaj dołączania modelu w celu zmiany wrażliwych właściwości Podsumowanie Rozdzia 22. Uwierzytelnianie i autoryzacja Użycie uwierzytelniania Windows Użycie uwierzytelniania Forms Konfiguracja uwierzytelniania Forms Uwierzytelnianie Forms bez użycia cookies

12 SPIS TRE CI Członkostwo, role i profile Konfigurowanie i wykorzystanie członkostwa Konfigurowanie i wykorzystanie ról Konfigurowanie i wykorzystanie profili Dlaczego nie należy korzystać z uwierzytelniania bazującego na adresach URL Ograniczanie dostępu z użyciem adresów IP oraz domen Podsumowanie Rozdzia 23. Instalacja Przygotowanie aplikacji do dystrybucji Wykrywanie błędów przed instalacją Kontrolowanie dynamicznej kompilacji stron Przygotowanie do instalacji binarnej Przygotowanie pliku Web.config do przekształcania Przygotowanie projektu do instalacji bazy danych Podstawy działania serwera IIS Witryny Web Katalogi wirtualne Pule aplikacji Wiązanie witryn z nazwami hostów, adresami IP oraz portami Przygotowanie serwera do instalacji Instalowanie aplikacji Instalowanie aplikacji przez kopiowanie plików Użycie pakietu instalacyjnego Publikowanie jednym kliknięciem Podsumowanie Skorowidz

13 ROZDZIA 18 Kontrola poprawno ci modelu W poprzednim rozdziale przedstawiliśmy, w jaki sposób na podstawie żądań HTTP biblioteka MVC tworzy obiekty modelu w procesie dołączania modelu. Zakładaliśmy, że dane wprowadzone przez użytkownika były prawidłowe. W rzeczywistości użytkownicy często wprowadzają dane, z których nie możemy skorzystać, i tym zajmiemy się teraz kontrolą poprawności danych modelu. Kontrola poprawności modelu jest procesem, dzięki któremu upewniamy się, że otrzymane dane nadają się do użycia w modelu, a jeżeli nie, dostarczamy użytkownikom informacje pomagające rozwiązać problem. Pierwsza część procesu sprawdzanie otrzymanych danych jest jednym ze sposobów zapewnienia integralności danych w modelu domeny. Przez odrzucenie danych, które nie mają sensu w kontekście naszej domeny, zapobiegamy powstawaniu dziwnych i niechcianych stanów aplikacji. Druga część pomoc użytkownikowi w rozwiązaniu problemu jest równie ważna. Jeżeli nie zapewnimy użytkownikowi informacji i narzędzi potrzebnych do interakcji z aplikacją w oczekiwany przez nas sposób, szybko spowodujemy jego frustrację. W przypadku aplikacji dostępnych publicznie często powoduje to wycofywanie się użytkowników, natomiast w przypadku aplikacji korporacyjnych może to skutkować spowolnieniem ich działań. Każda z tych sytuacji jest niepożądana. Na szczęście biblioteka MVC zapewnia rozbudowaną obsługę kontroli poprawności modelu. Pokażemy teraz, w jaki sposób korzystać z podstawowych funkcji, a następnie przejdziemy do bardziej zaawansowanych technik sterowania procesem kontroli poprawności. Tworzenie projektu Potrzebna jest nam prosta aplikacja MVC, w której będziemy mogli stosować różne techniki kontroli poprawności modelu. Na jej potrzeby utworzyliśmy klasę modelu widoku o nazwie Appointment, zamieszczoną na listingu Listing Klasa modelu widoku using System; using System.ComponentModel.DataAnnotations; namespace MvcApp.Models { public class Appointment { public string ClientName { get; set; [DataType(DataType.Date)] public DateTime Date {get; set;

14 CZ II ASP.NET MVC 3 SZCZEGÓ OWY OPIS public bool TermsAccepted { get; set; Na listingu 18.2 zamieszczony jest widok generujący edytory dla klasy Appointment, zapisany w pliku MakeBooking.cshtml. Listing Widok ViewBag.Title = "Rezerwacja"; <h4>rezerwacja (Html.BeginForm()) { => m.clientname)</p> <p>data => m.date)</p> <p>@html.editorfor(m => m.termsaccepted) Akceptuj warunki</p> <input type="submit" value="wy lij rezerwacj " /> Na listingu 18.3 zamieszczona jest klasa kontrolera, AppointmentController, posiadająca metody akcji operujące na obiektach Appointment. Listing Klasa AppointmentController public class AppointmentController : Controller { private IAppointmentRepository repository; public AppointmentController(IAppointmentRepository repo) { repository = repo; public ViewResult MakeBooking() { return View(new Appointment { Date = DateTime.Now ); [HttpPost] public ViewResult MakeBooking(Appointment appt) { repository.saveappointment(appt); return View("Completed", appt); Kontroler realizuje znany już nam wzorzec. Metoda akcji MakeBooking generuje widok MakeBooking.cshtml. Widok ten zawiera formularz, którego dane są przesyłane do drugiej wersji metody MakeBooking, oczekującej parametru Appointment. Łącznik modelu tworzy obiekt Appointment na podstawie wartości elementów formularza HTML, a następnie przekazuje go do metody akcji, zapisującej nowy obiekt w repozytorium, które zostanie dostarczone poprzez wstrzykiwanie zależności (utworzyliśmy tylko szkielet repozytorium dane wizyty są ignorowane, ponieważ chcemy się tu skupić wyłącznie na kontroli poprawności). Po przekazaniu wizyty do repozytorium kontroler generuje widok Completed.cshtml, który pozwala przekazać informację zwrotną dla użytkownika. Na rysunku 18.1 przedstawiona jest ta sekwencja widoków. 480

15 ROZDZIA 18. KONTROLA POPRAWNO CI MODELU Rysunek Kolejność widoków w przykładowej aplikacji Obecnie nasza aplikacja będzie akceptowała dowolne przesłane przez użytkownika dane, ale aby zachować integralność aplikacji i modelu domeny, wymagamy spełnienia trzech warunków przed zaakceptowaniem przesłanych przez użytkownika danych wizyty: użytkownik musi podać nazwisko, użytkownik musi podać przyszłą datę (w formacie mm-dd-rrrr), użytkownik musi zaznaczyć pole wyboru informujące o zaakceptowaniu zasad. Kontrola poprawności modelu jest procesem umożliwiającym wymuszenie tych wymagań. W kolejnych punktach pokażemy różne techniki pozwalające weryfikować dane przesłane przez użytkownika oraz przekazanie użytkownikowi informacji, dlaczego nie możemy wykorzystać dostarczonych danych. Jawna kontrola poprawno ci modelu Najbardziej bezpośrednim sposobem kontroli poprawności modelu jest wykonanie tej operacji w metodzie akcji. Realizacja tego zadania jest zamieszczona na listingu Listing Jawna kontrola poprawności modelu [HttpPost] public ViewResult MakeBooking(Appointment appt) { if (string.isnullorempty(appt.clientname)) { ModelState.AddModelError("ClientName", "Prosz poda swoje nazwisko."); if (ModelState.IsValidField("Date") && DateTime.Now > appt.date) { ModelState.AddModelError("Date", "Prosz poda przysz dat."); if (!appt.termsaccepted) { ModelState.AddModelError("TermsAccepted", "Zaakceptowanie zasad jest wymagane."); if (ModelState.IsValid) { repository.saveappointment(appt); return View("Completed", appt); else { return View(); 481

16 CZ II ASP.NET MVC 3 SZCZEGÓ OWY OPIS Sprawdzamy tu wartości przypisane przez łącznik modelu do właściwości obiektu parametru i rejestrujemy wszystkie znalezione błędy we właściwości ModelState, którą kontroler dziedziczy po swojej klasie bazowej. Dla przykładu przeanalizujemy, w jaki sposób sprawdzamy właściwość ClientName: if (string.isnullorempty(appt.clientname)) { ModelState.AddModelError("ClientName", "Prosz poda swoje nazwisko."); Chcemy, aby użytkownik podał wartość tej właściwości, więc do jej sprawdzenia wykorzystujemy statyczną metodę string.isnullorempty. Jeżeli nie otrzymamy wartości, wywołujemy metodę ModelState.AddModelError, podając nazwę właściwości, której dotyczy błąd (ClientName), oraz komunikat, jaki powinien być wyświetlony użytkownikowi, aby mu pomóc przy rozwiązaniu problemu (Proszę podać swoje nazwisko.). Za pomocą właściwości ModelState.IsValidField jesteśmy w stanie sprawdzić, czy łącznik modelu był w stanie przypisać wartość do właściwości. Wykonaliśmy to dla właściwości Date, aby upewnić się, czy łącznik modelu skonwertował przekazaną przez użytkownika wartość; jeżeli nie, nie ma sensu wykonywać dodatkowych sprawdzeń i raportować kolejnych błędów. Po sprawdzeniu wszystkich właściwości w obiekcie modelu odczytujemy właściwość ModelState.IsValid w celu sprawdzenia, czy wystąpiły błędy. Właściwość ta ma wartość false, jeżeli zarejestrowane zostały jakiekolwiek błędy lub jeżeli łącznik modelu napotkał problemy: if (ModelState.IsValid) { repository.saveappointment(appt); return View("Completed", appt); else { return View(); Jeżeli nie wystąpiły błędy, zapisujemy wizytę za pomocą repozytorium i generujemy widok Completed. Jeżeli pojawiły się problemy, wywołujemy po prostu metodę View bez parametrów. Powoduje to ponowne wygenerowanie bieżącego widoku, dzięki czemu użytkownik zobaczy informacje o błędach i będzie mógł skorygować wprowadzane dane. Metody pomocnicze widoku szablonowego używane do wygenerowania edytorów dla właściwości modelu obsługują błędy kontroli poprawności. Jeżeli dla właściwości zostanie zaraportowany błąd, metoda pomocnicza doda do pola tekstowego klasę CSS o nazwie input-validation-error. Plik ~/Content/Site.css zawiera następującą domyślną definicję tego stylu:.input-validation-error { border: 1px solid #ff0000; background-color: #ffeeee; Powoduje ona ustawienie czerwonej ramki oraz różowego tła w elemencie, w którym wystąpił błąd. Na rysunku 18.2 przedstawiony jest ten efekt dla wszystkich trzech właściwości. Wy wietlanie komunikatów kontroli poprawno ci Style CSS dołączane przez metody widoku szablonowego do elementów tekstowych informują o wystąpieniu problemu w polu, ale nie pozwalają przekazać mu danych o samym problemie. Na szczęście dostępne są inne metody pomocnicze HTML wspierające nas w tym zadaniu. Na listingu 18.5 pokazane jest użycie jednej z tych metod w widoku MakeBooking. Listing Użycie metody pomocniczej ViewBag.Title = "Rezerwacja"; 482

17 ROZDZIA 18. KONTROLA POPRAWNO CI MODELU Rysunek Błędy powodują wyróżnienie elementów Nadawanie stylu polom wyboru Niektóre przegl darki, w tym Chrome i Firefox, ignoruj style nadawane polom tekstowym, co prowadzi do powstania niespójnego wygl du strony. Rozwi zaniem jest zast pienie szablonu edytora Boolean w asnym, umieszczonym w ~/Views/Shared/EditorTemplates/Boolean.cshtml, w którym pole wyboru jest osadzone w elemencie div. Poni ej jest zamieszczony u ywany przez nas szablon, ale mo esz go dostosowa do swoich (ViewData.ModelMetadata.IsNullableValueType) => m, new SelectList(new [] {"Nie ustawiono", "Prawda", "Fa sz", Model)) else { ModelState state = ViewData.ModelState[ViewData.ModelMetadata.PropertyName]; bool value = Model?? false; if (state!= null && state.errors.count > 0) { <div class="input-validation-error" value) </div> else value) W szablonie tym umie cili my pole wyboru w elemencie div, do którego do czany jest styl input- validation-error, je eli zosta y zarejestrowane b dy modelu skojarzone z w a ciwo ci obs ugiwan przez szablon. Wi cej informacji na temat wymiany szablonów edytorów znajduje si w rozdziale 16. <h4>rezerwacja (Html.BeginForm()) => m.clientname)</p> 483

18 CZ II ASP.NET MVC 3 SZCZEGÓ OWY OPIS <p>data => m.date)</p> <p>@html.editorfor(m => m.termsaccepted) Akceptuj warunki</p> <input type="submit" value="wy lij rezerwacj " /> Metoda pomocnicza Html.ValidationSummary pozwala wyświetlić podsumowanie błędów kontroli poprawności zarejestrowanych dla strony. Jeżeli nie ma błędów, metoda pomocnicza nie generuje żadnego kodu HTML. Na rysunku 18.3 przedstawione jest działanie pola podsumowania. Rysunek Wyświetlanie podsumowania kontroli poprawności Pole podsumowania wyświetla komunikaty zarejestrowane przez metodę akcji w obiekcie ModelState. Na listingu 18.6 zamieszczony jest kod HTML wygenerowany przez tę metodę. Listing Kod HTML wygenerowany przez metodę pomocniczą ValidationSummary <div class="validation-summary-errors" data-valmsg-summary="true"> <ul> <li>prosz poda swoje nazwisko.</li> <li>prosz poda przysz dat.</li> <li>zaakceptowanie zasad jest wymagane.</li> </ul> </div> Informacja o błędach są wyrażane jako lista umieszczona w elemencie div, do którego jest dołączona klasa CSS validation-summary-errors. Styl jest zdefiniowany w pliku ~/Content/Site.css i w razie potrzeby może być zmieniony. Domyślny styl powoduje użycie pogrubionego, czerwonego tekstu:.validation-summary-errors { font-weight: bold; color: #ff0000; Metoda ValidationSummary posiada kilka przeciążonych wersji; najprzydatniejsze są zamieszczone w tabeli Niektóre z przeciążonych wersji metody ValidationSummary pozwalają nam na wskazanie, że powinny być wyświetlone wyłącznie komunikaty o błędach na poziomie modelu. Błędy, jakie rejestrowaliśmy do tej pory w ModelState, były błędami na poziomie właściwości, co oznacza, że wystąpił problem z wartością podaną w danej właściwości i jej zmiana może rozwiązać problem. 484

19 ROZDZIA 18. KONTROLA POPRAWNO CI MODELU Tabela Najprzydatniejsze przeciążone wersje metody ValidationSummary Przeci ona metoda Html.ValidationSummary() Html.ValidationSummary(bool) Html.ValidationSummary(string) Html.ValidationSummary(bool, string) Opis Generuje podsumowanie dla wszystkich błędów. Jeżeli parametr bool ma wartość true, to wyświetlane są tylko komunikaty o błędach poziomu modelu (patrz wyjaśnienie pod tabelą). Jeżeli parametr ma wartość false, wyświetlane są komunikaty o wszystkich błędach. Wyświetla komunikat (przekazany w parametrze typu string) przed podsumowaniem wszystkich błędów. Wyświetla komunikat przed błędami. Jeżeli parametr bool ma wartość true, wyświetlane są wyłącznie komunikaty o błędach poziomu modelu. Z kolei błędy na poziomie modelu mogą być wykorzystywane, jeżeli powstaje problem z interakcją pomiędzy dwoma właściwościami (lub większą ich liczbą). Wyobraźmy sobie, że klient Jan nie może składać rezerwacji w poniedziałki. Na listingu 18.7 pokazany jest sposób wymuszenia tej zasady i raportowania problemów za pomocą błędów kontroli poprawności na poziomie modelu. Listing Błąd kontroli poprawności na poziomie modelu public ViewResult MakeBooking(Appointment appt) { if (string.isnullorempty(appt.clientname)) { ModelState.AddModelError("ClientName", "Prosz poda swoje nazwisko."); if (ModelState.IsValidField("Date") && DateTime.Now > appt.date) { ModelState.AddModelError("Date", "Prosz poda przysz dat."); if (!appt.termsaccepted) { ModelState.AddModelError("TermsAccepted", "Zaakceptowanie zasad jest wymagane."); if (ModelState.IsValidField("ClientName") && ModelState.IsValidField("Date") && appt.clientname == "Jan" && appt.date.dayofweek == DayOfWeek.Monday) { ModelState.AddModelError("", "Jan nie mo e rezerwowa w poniedzia ki."); if (ModelState.IsValid) { repository.saveappointment(appt); return View("Completed", appt); else { return View(); Zanim sprawdzimy, czy Jan próbuje zarezerwować wizytę na poniedziałek, korzystamy z metody ModelState.IsValidField w celu upewnienia się, że mamy prawidłowe wartości pól ClientName oraz Date. Oznacza to, że nie możemy wygenerować błędu poziomu modelu do momentu spełnienia warunków dla właściwości. Błędy poziomu modelu rejestrujemy, podając pusty ciąg znaków ("") jako pierwszy parametr metody ModelState.AddModelError: ModelState.AddModelError("", "Jan nie mo e rezerwowa w poniedzia ki."); 485

20 CZ II ASP.NET MVC 3 SZCZEGÓ OWY OPIS Użycie metody ValidationSummary z parametrem bool pozwala nam wyświetlić informacje wyłącznie o błędach na poziomie modelu, co jest pokazane na rysunku Rysunek Wyświetlanie wyłącznie informacji o błędach na poziomie modelu Jak można zauważyć na rysunku, mamy tu dwa błędy kontroli poprawności. Pierwszym jest błąd na poziomie modelu, który wystąpił, gdy Jan próbował zarezerwować wizytę na poniedziałek. Drugi wynika z braku zaznaczenia pola akceptacji zasad. Ponieważ w podsumowaniu wyświetlamy wyłącznie komunikaty o błędach poziomu modelu, użytkownik nie zobaczy żadnej informacji o braku zaznaczenia opcji. Wyświetlanie komunikatów kontroli poprawności poziomu właściwości Powodem ograniczania komunikatów o błędach wyświetlanych w podsumowaniu do błędów poziomu modelu jest możliwość wyświetlania komunikatów o błędach poziomu właściwości obok pól. W takim przypadku nie chcemy powielać komunikatów z poziomu właściwości. Na listingu 18.8 zamieszczony jest zaktualizowany widok MakeBooking, w którym komunikaty o błędach poziomu modelu są wyświetlane w podsumowaniu, a o błędach na poziomie właściwości obok odpowiedniego pola. Metoda pomocnicza Html.ValidationMessageFor wyświetla komunikaty o błędach dla poszczególnych właściwości modelu. Na rysunku 18.5 przedstawiony jest wynik działania tej metody. Listing Użycie komunikatów o błędach poziomu ViewBag.Title = "Rezerwacja"; <h4>rezerwacja (Html.BeginForm()) <p> => m.clientname) 486