niedziela, 22 marca 2009

Walidacja danych w ASP.NET MVC za pomocą xVal

Pierwsza zasada programisty: nigdy nie ufaj danym wejściowym. Sama walidacja tych danych może zostać przeprowadzona na wiele sposobów, przekazując odpowiedzialność od warstwy najwyższej do najniższej. Takie podejście pozwala na eliminowanie zagrożenia w wielu przypadkach jeszcze bez przesłania danych do serwera. (Jeśli ktoś nie lubi czytać przydługich wstępów, może przejść od razu do punktu: "Dlaczego xVal?").


Walidacja po stronie warstwy prezentacji
<asp:TextBox ID="TextBox1" runat="server" />
<asp:RequiredFieldValidator ID="reqVal" runat="server" 
       ErrorMessage="Please enter a value" ControlToValidate="TextBox1" />
<asp:Button ID="Button1" runat="server" Text="Button" />



Należy pamiętać, że walidacja po stronie klienta (JavaScript) ZAWSZE musi iść w parze z walidacją po stronie serwera. W przeciwnym razie, to tak jak by w ogóle tej walidacji nie było! Wywołanie metody PageIsValid:

protected void Button1_Click(object sender, EventArgs e) 
{ 
  if (Page.IsValid) 
  { 
    // TextBox1 posiada wartość.
  } 
}



Walidacja po stronie logiki biznesowej

private static void Validate (EmailAddress myEmailAddress) 
{ 
  if (myEmailAddress.ContactPersonId <= 0) 
  { 
    throw new InvalidOperationException("Błąd, brak odpowiedniego ContactPersonId!"); 
  } 
  if (string.IsNullOrEmpty(myEmailAddress.Email))
  { 
    throw new InvalidOperationException("Błąd, brak emaila!"); 
  } 
  if (!IsValidEmailAddress(myEmailAddress.Email)) 
  { 
    throw new InvalidOperationException("Błąd, wprowadzony email jest błędny!"); 
  } 
} 
public static int Save(EmailAddress myEmailAddress) 
{ 
  Validate (myEmailAddress);
  myEmailAddress.Id = EmailAddressDB.Save(myEmailAddress);
  return myEmailAddress.Id; 
} 



Walidacja po stronie serwera SQL

ALTER TABLE  dbo.Category ADD CONSTRAINT
CK_Category CHECK (SortOrder >= 0  AND SortOrder <= 100)
GO   



Wykorzystanie dostępnego frameworka do walidacji danych, np:


Przedstawione frameworki różnią się przeznaczeniem. Ja przedstawię w tym poście świeży jeszcze projekt xVal.


Dlaczego xVal?


  1. Stworzony do użycia z ASP.NET MVC

  2. Wspiera walidację client-side oraz server-side

  3. Możliwość lokalizacji językowej komunikatów

  4. Oparty o przyjęte "dobre techniki"

  5. Możliwość włączenia do projektu bez konieczności przeprowadzania "wielkich" zmian

  6. Lekki, 1 plik .dll do podłączenia

  7. Open source

  8. Mało znany, bo nowy :-)



image-thumb



Zaczynamy. xVal - validation framework for ASP.NET MVC applications.



Po stronie modelu, xVal opiera swoje działanie o atrybuty. Z tego względu atrybuty naszych klas musimy odpowiednio oznaczyć atrybutami. W moim projekcie posiadam klasę Order.cs, którą będę poddawał torturom walidacji:

public class Order
{
    [Required] [StringLength(15)]
    public string ClientName { get; set; }
 
    [Range(1, 20)]
    public int NumberOfProducts { get; set; }
 
    [Required] [DataType(DataType.Date)]
    public DateTime Date { get; set; }
}



Objaśnienie zastosowanych atrybutów:

  • [Required] : dany atrybut jest wymagany, nie może być pusty.

  • [StringLength(n)] : dany atrybut musi posiadać odpowiednią długość, dla typu String.

  • [Range(n, m)] : dany atrybut musi być z przedziału od, do.

  • [DataType(typ)] : dany atrybut musi być zgodny z podanym typem.




Należy jeszcze dodać referencję do: System.ComponentModel.DataAnnotations.dll

Nadszedł czas na kontroler. Ja wszystkie operacje dotyczące składania zamówień będę przeprowadzał w HomeController.

public class HomeController : Controller
{
    [AcceptVerbs(HttpVerbs.Get)]
    public ViewResult CreateOrder()
    {
        return View();
    }
 
    [AcceptVerbs(HttpVerbs.Post)]
    public ActionResult CreateOrder(Order order)
    {
        OrderManager.PlaceOrder(order);
        return RedirectToAction("Completed");
    }
 
    public ViewResult Completed()
    {
        return View();
    }
}



Klasa OrderManager:

public static class OrderManager
{
    public static void PlaceOrder(Order order)
    {
        var errors = DataAnnotationsValidationRunner.GetErrors(order);
        if (errors.Any())
            throw new RulesException(errors);
 
        // Business rule: Nie można składać zamówień w niedzielę
        if(order.Date.DayOfWeek == DayOfWeek.Sunday)
            throw new RulesException("ArrivalDate", "Nie można skłdać zamówień na niedzielę!", order);
 
        // Todo: zapis do bazy danych, pliku xml lub cokolwiek innego
    }
}



Czas na widok CreateOrder.aspx

<h1>Zamówienie pluszowego misia</h1>
<% using(Html.BeginForm()) { %>
    <div>
        Nazwa: <%= Html.TextBox("order.ClientName") %>
        <%= Html.ValidationMessage("order.ClientName") %>
    </div>
    <div>
        Ilość misiów: <%= Html.TextBox("order.NumberOfProducts")%>
        <%= Html.ValidationMessage("order.NumberOfProducts")%>
    </div>
    <div>
        Data dostawy: <%= Html.TextBox("order.Date")%>
        <%= Html.ValidationMessage("order.Date")%>
    </div>                
 
    <input type="submit" />
<% } %>



Potrzebujemy jeszcze prostą i niezmienną klasę ValidationRunnera, gdyż  DataAnnotations takiej nie posiada:

internal static class DataAnnotationsValidationRunner
{
    public static IEnumerable<ErrorInfo> GetErrors(object instance)
    {
        return from prop in TypeDescriptor.GetProperties(instance).Cast<PropertyDescriptor>()
               from attribute in prop.Attributes.OfType<ValidationAttribute>()
               where !attribute.IsValid(prop.GetValue(instance))
               select new ErrorInfo(prop.Name, attribute.FormatErrorMessage(string.Empty), instance);
    }
}



Musimy jeszcze zmodyfikować napisany wcześniej szkielet metody CreateOrder w kontrolerze HomeController, tak aby błędy były przechowywane w stanie modelu.

[AcceptVerbs(HttpVerbs.Post)]
public ActionResult CreateOrder(Order order)
{
    try {
        OrderManager.PlaceOrder(order);                
    }
    catch(RulesException ex) {
        ex.AddModelStateErrors(ModelState, "order");
    }
 
    return ModelState.IsValid ? RedirectToAction("Completed")
                              : (ActionResult) View();
}



Tym oto sposobem zakończyliśmy walidację po stronie serwera. Czeka nas jeszcze implementacja sprawdzanie po stronie klienta.

screen_02 2009.03.22 14.18




Walidacja po stronie klienta (Client-side validation).
Wszystko czego będziemy potrzebować do wykonania walidacji za pomocą javascriptu, to biblioteka jquery.validate.js oraz xVal.jquery.validate.js (ten znajduje się w folderze z projektem xVal). Należy je skopiować do folderu z naszymi skryptami (/Scripts) oraz podlinkować je do naszego MasterPage.

<head>
    <script type="text/javascript" src="<%= ResolveUrl("~/Scripts/jquery-1.2.6.js")%>"></script>
    <script type="text/javascript" src="<%= ResolveUrl("~/Scripts/jquery.validate.js")%>"></script>
    <script type="text/javascript" src="<%= ResolveUrl("~/Scripts/xVal.jquery.validate.js")%>"></script>
</head>


Czas teraz na import helperów xVal, najlepiej zrobić to raz w pliku Web.config:

<system.web>
  <pages>
     <namespaces>
        <!-- leave rest as-is -->
        <add namespace="xVal.Html"/>
    </namespaces>
  </pages>
</system.web>



Wracamy do widoku oraz dodajemy linijkę służącą do wymuszenia walidacji po stronie klienta. Będzie ona zastosowana dla kontrolek prefixowanych przez nazwę order:

<%= Html.ClientSideValidation<Order>("order") %>



Od tej pory walidacja po stronie klienta powinna być uruchamiana, "potajemnie" korzystając oczwyiście z atrybutów, które definiowaliśmy wcześniej. Super!


W załączniku przesyłam zlokalizowany przeze nnie na nasz język plik z komunikatami.

poniedziałek, 16 marca 2009

C2C '09 - relacja

Communities 2 Communities 2009 już za nami, chciałbym krótko podsumować całe spotkanie.

Po pierwsze: podziękowania dla Adama Najmanowicza z Cognifide za zasponsorowania busa dla członków PG.NET!

Mój poniższy komentarz dotyczy jedynie ścieżki .NET. Mam nadzieję, że organizatorzy udostępnią jakieś video z SQLa :-)

1. Marek Byszewski, "Tour de VSTS 2010".

Prezentacja była szybkim przeglądem możliwości Visual Studio Team System 2010. Marek dość sprawnie prezentował możliwości debugera historycznego, zarządzania kodem oraz continuos integration za pomocą Visual Studio.  Aplikacja jeszcze nie jest wolna od wad - o czym można było się przekonać na własne oczy. Marek jednak dość sprawnie przechodził pomiędzy nie do końca udanymi próbami, całość wypadła w miarę sprawnie. Na szczęście (moim zdaniem) plan Marka został wykonany prawie do końa, nie licząc paru problemów technicznych o których wspomniałem. Merytorycznie nie zobaczyłem nic wielkiego, czegoś czego do tej pory bym nie znał. Ocena 7,5/10.

2. Julia Lerman, "My favorite Entity Framework. Tips & Tricks".

Julia zaprezentowała wybrane problemy z którymi spotyka się większość progrmistów wykorzystujących EntityFramework oraz przestawiała sposoby ich rozwiązania. Prezentacja była prowadzona po angielsku, nie było jednak żadnych problemów ze zrozumieniem przekazu - Julie z niczym się nie śpieszyła i płynnie przedstawiała kolejne punkty prezentacji. Doskonały kontakt z publiką, dużo energii w przekazywaniu wiedzy, pełen profesjonalizm. Ciekawe przykłady z życia wzięte i brak niezrozumiałej teorii. Ocena 10/10.

3. Piotr Leszczyński, "Kolejny kontener Dependency Injection? NIE - dziękuję! Czyli o koncepcji meta-kontenera słów kilka".

Tak naprawdę zastanawiałem się o czym będzie ta sesja. Koncepcja meta-kontenera nie była mi za bardzo znana, a chciałem się dowiedzieć u źródła "o so chosi". Pomyślałem sobie, że pewnie będzie o IoC - trochę tak było. Szybkie wprowadzenie do tematyki Inversion Of Control, dependency injection, oraz przejście do meritum prezentacji, czyli meta-kontenera. Słuchałem, słuchałem i cały czas zastanawiałem się gdzie jest to odkrycie. Widziałem idee opartą o jeden wielki wzorzec fabryki, ale wydawało mi się, że jest coś jeszcze poza tym. Zadałem Piotrkowi pytanie "Jaki cel przyświecał wymyśleniu meta-kontenera i do czego jest mi on potrzebny, skoro wszystko to, co chcę zrobić z IoC udustępnia mi mój obecny, ulubiony kontener?". Piotrek odpowiedział, że uniezależnie mnie to od zmiany licencji mojego kontenera w przyszłości. Pytanie kolejne: "A co jeśli Wy zmienicie licencję meta-kontenera?". Odpowiedz: <brak>. Odniosłem wrażenie, że prezentacja była pewnym środkiem na przedstawienie produktu, natomiast to co najciekawsze w samym IoC zostało potraktowane po macoszemu. Ocena: 6/10.

4. Ingo Rammer, "Hardcore Production Debugging of .NET Applications".

Ingo dał czadu! Wyśmienita wręcz prezentacja narzędzi służących do debugowania gotowego managed-kodu, była wykonana w sposób jaki najbardziej przypadł mi do gustu. Narzędzia, które przedstawiał Ingo, ani nie posiadały fajowskich wizualnych bajerów, nie miały latającego menu, ani pomocy w postaci spinacza. Mimo to, zostały zaprezentowane w taki sposób, że nie spuszczałem wzroku z ekranu projektora. Absolutnie nie było żadnej rzeczy do której mógłbym się przyczepić. Ocena 11/10.

5. Udi Dahan. "Avoid a Failed SOA - Business and Autonomous Components to the Rescue".

Udi to wielki autorytet w naszym małym świecie :-) Byłem przekonany, że pod względem merytorycznym nie mam się o co martwić i dowiem się rzeczy, o których nawet nie śniłem, na pewno bedzie pro. Było pro. Niestety tematyka sesji była dla mnie nieco "akademicka". Rozumiem, że nie samym pisaniem kodu człowiek żyje, ale nie było nawet jednej linijki kodu :-( Udi potrafił nad jednym slajdem przegadać dobre 10 minut, mimo tego nie "lał wody". Za przydatność informacji dałbym 5/10, za prezentację 10/10. Końcowa ocena: 7/10.

6. Artur Paluszyński, "Interakcyjne sceny 3D w Windows Presentation Foundation".

Artur prezentował techniki 3D za pomocą WPF-a. Prezentacja dość spokojna, mimo to ciekawa. Wszystko o czym mówił Artur uznawałem za godne uwagi. Zwracałem jednak uwagę na formę prezentacji "per Państwo". Artur, jesteśmy na C2C, tu wszyscy jesteśmy kumplami po fachu! Końcowa ocena 9/10.

7. Konferencja C2C 2009. Ocena końcowa.

Szkoda, że nie była bliżej Poznania :-)  - jednak z mojej strony dla organizatorow tego przedsięwzięcia - WIELKIE BRAWA. Kawał dobrej roboty. Zdecydowanie najlepsza tego typu impreza w kraju!

piątek, 13 marca 2009

Po XVII spotkaniu PG.NET. Krótka relacja.

To już po 17 spotkaniu PG.NET, na której to gościliśmy Raymonda Lewallena, importowaną gwiazdę z za oceanu :-)

Zajebiście ciekawa prezentacja o BDD, ale przy okazji  - o mojej preferowanej metodologii - TDD. Występ Raymonda był bardzo udany. W sposób bardzo zrozumiały przedstawił o co tak naprawdę chodzi w BDD. Wiele można poczytać o tym podejściu w internecie, jednak dopiero Raymond troszkę zaraził mnię tym podejściem, wyjaśniając przy tym różne niuanse z tym związane.

Spotkanie "w cztery oczy", po spotkaniu, w restauracji na Starym Rynku również podniosło kilka ważnych spraw, często nie związanych z BDD :-) Osobiście jednak dostało mi się od Raymonda za (do tej pory tak myślałem) "rewolucyjne" podejście do uruchamiania tasków CruiseControl-a i innych NAntów, i MSBuildów z poziomu plików .bat :-( No cóż, może rozwiązanie nie jest idealne, ale pracuję nad wersją 2.0 (powered by PowerShell) :-)

Raymond obiecał wrócić za rok. No to czekamy!

środa, 4 marca 2009

Bardzo ciekawy marzec. Co trzeba zobaczyć?

W marcu uzbierało się wiele ciekawych wydarzeń. Do najciekawszych należy zaliczyć:

 pgnet 11 marca (Poznań). Na 17. spotkaniu poznańskiej grupy .NET będziemy mieli specjalnego gościa – Raymonda Lewallena. Raymond będzie opowiadał o Behavior Driven Development. Raymond Lewallen (C# MVP), prelegent znany z takich konferencji jak TechEd czy VS Live, wysokiej klasy specjalista z 15 letnim doświadczeniem w pisaniu aplikacji dla sektora publicznego i rządu amerykańskiego. [http://bartekszafko.pl]

10927 12-14 marzec (Kraków). W dniach 12-14 marca, w Krakowie, odbędzie się V już edycja Studenckiego Festiwalu Informatycznego - największej tego typu imprezy w Europie Środkowej.
Studencki Festiwal Informatyczny to międzynarodowa konferencja skierowana do pasjonatów informatyki z całej Polski. Impreza tworzona jest "przez studentów dla studentów", dzięki temu, celnie trafia w gusta odbiorców i zapewnia niespotykaną gdzie indziej atmosferę. Podczas Festiwalu poruszane jest szerokie spektrum zagadnień takich jak inżynieria oprogramowania, systemy operacyjne, sieci, czy Open Source. Różnorodność tematów gwarantuje, że każdy uczestnik znajdzie coś dla siebie.

 startup 13 marca (Poznań). Poznańskie Centrum Superkomputerowo-Sieciowe oraz StartUp-IT zapraszają do wzięcia udziału w warsztacie: "Tworzenie serwisów internetowych - część II z II" [http://startup-it.pl/].

 

c2 14 marca (Warszawa). Communities2Communities (C2C) edycja 2009 to konferencja organizowana zjednoczonymi siłami grup technologicznych z całej Polski. C2C to niepowtarzalna okazja, aby spotkać i posłuchać najwyższej klasy specjalistów z Polski i ze świata. Tegoroczna konferencja obejmuje aż trzy ścieżki tematyczne: przeznaczoną dla profesjonalistów IT, SQL Server oraz .NET. Na każdą ze ścieżek przypada pięć sesji - każda z nich będzie prowadzona na najwyższym poziomie, w sposób mertoryczny, przez najlepszych specjalistów, bez zbędnego marketingowego bełkotu. [http://c2c.org.pl]

win 18 marzec (Warszawa). Już 18 marca w Warszawie odbędzie się pierwsze spotkanie z cyklu czterech spotkań technologicznych, podczas których zapoznamy Cię z nową odsłoną systemów Microsoft Windows, rozwiązaniami wirtualizacyjnymi oraz narzędziami umożliwiającymi zarządzanie środowiskiem IT opartym na systemach Microsoft.

cebit 3-8 marzec (Hanower, Niemcy). Z zagranicznych konferecji: jest CEBIT. Na targach pojawi się 20 polskich przedsiębiorstw m. in.: Imagis, AVSystem, BKT Elektronik, Denco Logic, Fido Intelligence, Gdynia Innovation Centre, IVO Software, InteliWISE, Logotec Engineering, PLATINET, PayLane, Planet Soft- IT Outsourcing, TeleMobile Electronics, i3D (pozostałe z branżą IT są już raczej luźno powiązane - zwłaszcza producent skarpetek ;-) Dziwić może brak części znaczących producentów sprzętu jak choćby znanej w całej Europie firmy Wilk Elektronik SA (producent pamięci RAM marki GoodRAM). [CeBit]

poniedziałek, 2 marca 2009

Tip: Debugowanie zewnętrznej aplikacji

shrek-donkey-pick-me_1 Jak zdebugować zewnętrzny proces lub aplikację? Pick me, pick me, krzyczą wszyscy. Tak,  możemy to zrobić poprzez wywołanie Debug->Attach to process. Jest jednak inny sposób. Wyobraźmy sobie taką sytuację. Aplikacja kończy się wyjątkiem zaraz po jej uruchomieniu. Nie mamy nawet sekundy czasu na podczepienie się do procesu w ten sposób. Ale jest sztuczka :-)

Wywołujemy File->Open Project i wskazujemy plik .exe, który chcemy debugować. Klikamy F5 i Voila!

niedziela, 1 marca 2009

Firebug console.

firebug Jeśli jesteś programistą Web, to na pewno znasz dodatek do przeglądarki Firefox, a mianowicie Firebug. Jeśli go nie znasz, to MUSISZ go poznać. On powie Ci wszystko o tym co się dzieje z Twoją stroną.

Nie będę się skupiał na tworzeniu instrukcji obsługi tego dodatku, a skupię się na jego jednym z głównych elementów, czyli konsoli. Mam tutaj na myśli obiekt console, ktory jest globalnie dostępny na Twojej stronie dzięki Firebugowi, a być może do tej pory nie zdawałeś sobie sprawy o jego istnieniu.

Obiekt console jest typowym loggerem komunikatów, które służą w celach (głównie) debugowania aplikacji (więcej o logowaniu zdarzeń można przeczytać na moich poprzednich notkach). Wartości do niego przekazywane są widoczne bezpośrednio w okienku Fiebuga. Aby z niego skorzystać, wystarczy wywołać odpowiednią metodę. Jako parametry możemy przekazać dowolną liczbę obiektów (nazw zmiennych) oddzielonych przecinkiem.

console.log Wypisuje komunikat na konsoli Firebuga
console.debug Wypisuje komunikat wraz z linkiem do bloku kodu, który go wywołał
console.info, console.warn, console.error j.w. wraz z graficzną informacją typu komunikatu
console.trace Wypisuje stack trace wywołania kodu JavaScript. Wyświetla wartości parametrów funkcji.
console.assert Testuje czy podane jako argument wyrażenie logiczne jest prawdą
console.dir Wyświetla właściwości danego obiektu

Formatowanie komunikatów:

%s Jako ciąg znaków
%d, %i Jako liczba całkowita
%f Jako liczba zmiennoprzecinkowa
%o Odnośnik do obiektu

 

Przykład wywołania (kod javascript):

console.log("Zmienna: %s zawiera liczbę: %d", mojaZmienna, count);

console.log("Zmienna %s oraz wiele wartości:", mojaZmienna, war1, war2, war3);


Przykładowy efekt działania konsoli Firebuga:



screen_01 2009.03.01 21.21



Możliwości tego narzędzia są bardzo duże. Zdecydowanie jeden z moich ulubionych dodatków do FF. Pozdrawiam.