Przejdź do głównej zawartości

Simple.Data - rewelacyjna biblioteka .NET ORM bez ORMa!

W tym wpisie pragnę przedstawić krótkie wprowadzenie do genialnej w swojej prostocie biblioteki Simple.Data dla platformy .NET.

Otóż zapewne każdy kto miał styczność z programowaniem, musiał w pewnym momencie skorzystać z bazy danych. Wówczas najczęściej pada wybór na Entity Framework lub (Fluent) nHibernate jako framework ORM. Pociąga to za sobą tworzenie obiektów ( Object ), posiadanie relacyjnej bazy danych ( Relational ), a także stworzenie relacji ( Mapping ). Oczywiście każdy z tych frameworków posiada generator dla obiektów i relacji. Jednakże pomimo tych udogodnień, stworzenie ich wymaga zawsze poświęcenia czasu. Co więcej, jeśli baza nie jest budowana razem z projektem, a opiera się już na istniejącej, wówczas wymaga to jeszcze więcej pracy. Każda z bibliotek jest bardzo wrażliwa na wszelkie niestandardowe rozwiązania lub nieścisłości. Te zaś występują często w istniejących już bazach, które współdzielone są przez kilka aplikacji. Jakakolwiek zmiana w takim przypadku nie wchodzi w rachubę. Odpowiednie skonfigurowanie wszystkiego, aby później nie sprawiało już problemów, jest pracochłonne.

Jeśli nasz projekt korzysta z bazy danych okazjonalnie i/lub nie wymaga niesamowitych skomplikowanych operacji, wówczas wdrożenie Entity Framework lub (Fluent) nHibernate nie jest zbyt opłacalne. Szczególnie, gdy z wielu istniejących tabel, mających wiele relacji, będziemy używać zaledwie kilku. W tym momencie idealnym rozwiązaniem jest Simple.Data !

Simple.Data - ORM bez ORMa

Simple.Data jest lekkim frameworkiem dla .NET, który zapewnia dostęp do bazy w stylu ORM, ale bez obiektów ( Object ), bez wymogu łączenia się do relacyjnej bazy danych ( Relational ) a także bez generowania relacji ( Mapping )! Wszystko dzięki typom dynamicznym w .NET 4!

Simple.Data posiada adaptery do:

  • ADO.NET obsługuje następujące bazy:

  • SQL Server 2005 i nowsze

  • SQL Server Compact Edition 4.0

  • Oracle

  • VistaDB

  • MySQL 4.0 i nowsze

  • SQLite 3.0 i nowsze

  • PostgreSQL

  • SQLAnywhere

  • Informix

  • MongoDB

  • OData

  • Azure

Wymagania i konfiguracja

Dla platformy .NET wymagana jest wersja 4 lub wyższya, zaś jeśli chcemy używać Simple.Data z Mono, musimy posiadać wersję co najmniej 2.1. Aktualna wersja znajduje się na githubie, ale najprościej pobrać ją poprzez NuGeta.

Zawsze do poprawnego działania wymagana jest biblioteka Simple.Data.Core oraz biblioteka Simple.Data dla konkretnego adaptera ( ADO.NET, MongoDB, OData, Azure ). Wybierając adapter ADO.NET należy dołożyć jeszcze bibliotekę Simple.Data dla konkretnej bazy, z jaką będziemy działać.

Jedynie co należy skonfigurować to... connection string. Można trzymać go zarówno w pliku .config , jak i podać jako argument przy otwieraniu połączenia z bazą danych. Oczywiście nie ma ograniczenia do ilości połączeń. Tutaj mała uwaga, Simple.Data nie utrzymuje połączenia, a zatem obiekt zwrócony z Database.Open() można przetrzymywać w singletonie, jeśli jest taka potrzeba. Gdy specyfikacja projektu nie pozwoliłaby na to, nic nie stoi na przeszkodzie, aby samemu zarządzać kiedy następuję połączenie/rozłączenie (szczegóły ).

Jak to działa?

Otóż język .NET 4 wprowadził m.in. dynamiczne typy. Simple.Data wykorzystuje to w sprytny sposób. Korzystając z kilkudziesięciu zdefiniowanych metod i łącząc je z z tym, co chcemy pobrać z bazy, uzyskujemy bardzo prosty i szybki framework. Poniżej kilka przykładów przedstawiających Simple.Data. Dzięki nim łatwiej będzie zrozumieć, jak ta biblioteka świetnie nadaje się do małych i średnich projektów, które nie wymagają zaprzęgania wielkich frameworków ORM.

Prosty przykład

Nadeszła pora, aby pokazać jak to działa w praktyce. Dzięki czemu można uzmysłowić sobie jak szybkim i elastycznym frameworkiem jest Simple.Data. Oto "książkowy" przykład, jak robimy to w standardowy, klasyczny sposób:


public Book FindBookById(int id)
{
    Book book = null;
    using (var connection = new SqlConnection(ConfigurationManager
    .ConnectionStrings["Default"].ConnectionString))
    using (var command =
    new SqlCommand("SELECT [Id],[WriterId],[Name],[Year]"+
    "FROM [Book] where id= @id", connection))
    {
        command.Parameters.Add("@id", SqlDbType.Int).Value = id;
        connection.Open();
        using (var reader = command.ExecuteReader())
        {
            if (reader.Read())
            {
                book = new Book {
                    Id = reader.GetInt32(0), WriterId = reader.GetString(1),
                Name = reader.GetString(2), Year = reader.GetString(3) };
            }
        }
    }
    return book;
}

a teraz to samo, ale z Simple.Data (bez generowania czegokolwiek!):


public Book FindBookById(int id)
{
    return Database.Open().Books.FindAllById(id).FirstOrDefault();
}

czy jeszcze prościej bez żadnych klas:


var book =  Database.Open().FindAllById(2).FirstOrDefault();

Jak to działa na powyższym przykładzie?

  • Database.Open() - w tym miejscu nawiązywane jest połączenie. Metoda Open bez parametru, pobiera domyślny connection string z configu i zwraca łącznik bazy. Co ciekawe Database jest jedynym niedynamicznym obiektem.

  • Books - domyślnie kolejnym elementem jest nazwa tabeli/widoku. Liczba pojedyncza/mnoga nie ma znaczenia. Czy użyjemy Book, czy Books, Simple.Data i tak stworzy poprawny zapytanie. W powyższym przykładzie - Books - spowoduje, iż framework stworzy kilka możliwych wersji (Books, books, book) i spróbuje znaleźć pasującą nazwę w INFORMATION_SCHEMA.TABLES

  • FindAllById - ten wyrażenie to połączenie kilku elementów. Metody: FindAllBy, która oznacza, iż chcemy pobrać rekordy o zadanym, co najmniej jednym warunku. W tym przypadku jest to Id . Oczywiście można dodawać ich więcej np. FindAllByYearAndWriterId("2011", 1) . Warto dodać, że istnieje również alternatywna metoda tworzenia zapytań np. FindAllBy(Year: "2011", WriterId: 1) (dla niektórych bardziej czytelne).

Tak naprawdę to tylko tyle ;) Wygenerowany w taki sposób kod SQL wygląda następująco:


SELECT [dbo].[book].[id], 
       [dbo].[book].[writerid], 
       [dbo].[book].[name], 
       [dbo].[book].[year], 
       [dbo].[book].[description] 
FROM   [dbo].[book] 
WHERE  [dbo].[book].[id] = @p1 

(@p1 (Int32) = 2)

Coś trudniejszego - JOIN

Powyższy przykład był dość prosty, teraz coś ciekawszego: JOIN. Otóż w Simple.Data jest to równie trywialne. Rozpatrzmy jednak dwa przypadki.

  • istnieją odpowiednie klucze obce w tabelach

var db = Database.Open();

var books = db.Books.FindAllByYear("2011")
    .Select(
db.Books.Name,
db.Books.Writer.FirstName);

W tym przypadku pobieramy wszystkie książki (Books) z roku 2011, łącząc przy okazji z autorem książki (Writer). Dodatkowo, dzięki Select, można było wybrać, które kolumny mają być zwrócone. Wszystkie kolumny można wybrać używając metody Star().


SELECT [dbo].[book].[name], 
       [dbo].[writer].[firstname] 
FROM   [dbo].[book] 
       LEFT JOIN [dbo].[writer] 
              ON ( [dbo].[writer].[id] = [dbo].[book].[writerid] ) 
WHERE  [dbo].[book].[year] = @p1 

(@p1 (String) = 2011)

Przypominam - automatyczne połączenie JOIN może powstać, gdy odpowiednio oznaczone są klucze obce w tabelach.

  • brak kluczy obcych

var db = Database.Open();

var books = db.Books.FindAllByYear("2011")
    .Select(
db.Books.Name,
db.Books.Writer.FirstName)
    .LeftJoin(db.Writer).On(db.Writer.Id == db.Books.WriterId);

Ja widać, LeftJoin pozwala na połączenie tabel, które nie mają założonych kluczy obcych. W ten prosty sposób można połączyć dwie tabele po odpowiednich kolumnach.

Wygenerowany kod przedstawia się następująco:


SELECT [dbo].[book].[name], 
       [dbo].[writer].[firstname] 
FROM   [dbo].[book] 
       LEFT JOIN [dbo].[writer] 
              ON ( [dbo].[writer].[id] = [dbo].[book].[writerid] ) 
WHERE  [dbo].[book].[year] = @p1 
@p1 (String) = 2011

Poziom wyższy - stronicowanie

Tera coś ciekawszego, co może przydać się często w przypadku tworzenia małych CRMów. Otóż jak wyglądać będzie pobieranie danych ze stronicowaniem (idealne do grida)? Simple.Data i w tym przypadku zaskakuje, pozytywnie!

Aby nie komplikować kodu załóżmy, że chcemy robić stronicowanie tabeli z książkami (Books). Oczywiście ma pojawiać się również ogólna ilość rekordów i opcja sortowania. Napisanie tego w SQL wymaga trochę klepania. Jak wygląda to w Simple.Data? Trzymajcie się ;)


var db = Database.Open();
Future < int > count;

var books = db.Books.All()
    .OrderByDescending(db.Books.Name)
    .WithTotalCount(out count)
    .Skip(5)
    .Take(2)
    .ToList();

Czyż to nie jest proste? Cóż ten wielce skomplikowany kod robi :) Dla tabeli Book brane są wszystkie rekordy ( All ). Następnie zostają one posortowane ( OrderByDescending ) po nazwie. Stronicowanie załatwiają dwie metody: Skip i Take . Pierwsza przeskakuje o zadaną ilość rekordów, a druga pobiera dokładnie tyle elementów, ile chcemy. Piękne.

Jak wygląda wygenerowany kod SQL?


SELECT Count(*) 
FROM   [dbo].[book]; 

WITH __data 
     AS (SELECT [dbo].[book].[id], 
                [dbo].[book].[writerid], 
                [dbo].[book].[name], 
                [dbo].[book].[year], 
                [dbo].[book].[description], 
                Row_number() 
                  OVER( 
                    ORDER BY [dbo].[book].[name] DESC) AS [_#_] 
         FROM   [dbo].[book]) 
SELECT [id], 
       [writerid], 
       [name], 
       [year], 
       [description] 
FROM   __data 
WHERE  [_#_] BETWEEN 6 AND 7 

Jak dla mnie, jak najbardziej poprawnie i do zaakceptowania. A robi to taki mały kawałeczek kodu!

Simple.Data - szybkość i prostota

Przedstawiłem zaledwie mały wycinek funkcjonalności jakie posiada Simple.Data. Nie pisałem o tak trywialnych rzeczach jak dodawanie, aktualizowanie, usuwanie rekordów. Biblioteka oferuje również wsparcie dla testów jednostkowych, czy nawet wykonywanie procedur (przypominam sobie zabawy z nimi w Fluent nHibernate)! Więcej możliwości znajdziemy w dokumentacji, która nie zawsze jest aktualizowana, po najnowsze zmiany i nowinki polecam gorąco, zajrzeć na blog autora.

Simple.Data jest genialnym, niewielkim i szybkim frameworkiem do małych i średnich projektów. Pomimo prostoty, posiada bogatą funkcjonalność, a ilość obsługiwanych typów baz, zachwyca. Nie ma oczywiście "róży bez ognia". Całkowita dynamiczność wiąże za sobą brak jakiegokolwiek intellisense. Musimy pamiętać każdą z metod i parametrów. Oczywiście prostota frameworku pozwala nieznacznie przełknąć tą niedogodność. Następny problem również zahacza o dynamiczność. Brak klas reprezentujących tabele, powoduje to iż jakakolwiek zmiana w bazie (zmiana nazwy kolumny, usunięcie kolumny) nie spowoduje błędu kompilacji. Dowiemy się jednak dopiero podczas działania aplikacji albo wcale! Dlatego Simple.Data polecam do maksymalnie średnich projektów, by nie złapać się na tego typu niuanse. Co nie zmienia faktu, iż framework ma ogromne zastosowania i gorąco polecam do zapoznania się z nim!

Komentarze

Popularne posty z tego bloga

222 polskie gry, które warto znać - Marcin Kosman, recenzja książki

Marcin Kosman dał się poznać jako autor ciekawej pozycji o polskim game devie: "Nie tylko Wiedźmin. Historia polskich gier komputerowych". Po pięciu latach wraca z nową książką, również związaną z polską branżą grową, ale w zupełnie innej formie.222 polskie gry"222 polskie gry, które warto znać" to wyjątkowa książka. Co więcej, to nie jest książka jako taka, a bliżej jej do albumu. W języku angielskim funkcjonują one jako tzw. "Coffee table books", czyli książki/albumy bardziej do oglądania, niż do czytania.Tak jest właśnie z omawianą pozycją. W twardych okładach, w formacie B5 i na pięknym, kredowym papierze, znalazło się 222 polskich gier z lat 1983-2019. Każda strona to duża grafika, z kilkoma zdaniami o grze od autora książki, a czasem również dodatkowy, akapitem od osób tworzących dany kawałek softu.Wybór gier jest na tyle szeroki, że można śmiało powiedzieć, iż wybrano faktycznie najbardziej znaczące i rozpoznawalne tytuły. Jako, że przygodę zacząłe…

.NET Linux vs Windows - test wydajności .NET Core 3.1, .NET 5.0, a także Mono

Jakiś czas temu przedstawiłem wyniki porównania kilku środowisk uruchomieniowych platofrmy .NET - artykuł: Umarł .NET Framework, niech żyje .NET Core (oraz .NET 5) i jego wydajność (link do wpisu). Wówczas testy odpalałem na Windows 10, a sprawdzany był .NET Framework 4.8, .NET Core 3.1, a także nowy .NET 5.0 (wersja preview).Trzeba jednak zdać sobie sprawę, że .NET od dłuższego już czasu (Mono, he he) jest środowiskiem wieloplatformowym. Warto zatem sprawdzić, jak różne środowiska uruchomieniowe .NET radzą sobie na Windows i Linuxie. Mimo, iż Mono jest z nami od wielu lat, to nowy .NET Core sprawił, że tworzenie aplikacji .NET i ich hostowanie na Linuxie stało się bardzo kuszące (cena). Zatem które z nich jest szybsze i na jakiej platformie? Pod uwagę wziąłem .NET Core 3.1, .NET 5 (zwany też jako .NET Core 5) oraz poczciwe Mono.DotNetFrameworkVsCoreDo testów wykorzystałem własny projekt na GitHube:https://github.com/djfoxer/DotNetFrameworkVsCoreJest to niewielka aplikacja testująca…

Programistok - Białystok dla programistów i nie tylko

W Białymstoku powstała bardzo ciekawa inicjatywa promująca nowe technologie i trendy w programowaniu - Programistok. (Programistok na Facebooku: http://www.facebook.com/pages/Programistok/237808102923666 )Cykliczne spotkania będą omawiać m.in. programowanie na urządzenia mobilne, testowanie aplikacji, projektowanie interfejsów użytkownika czy pisanie lepszego, czystszego kodu. Każdy zainteresowany może zgłosić swoją propozycjię prezentację (20 - 30 minut).Impreza organizowana przy udziale firmy AmberBit (http://amberbit.com/ )Cele jakie przyświecają Programistokowi:integracja podlaskiego (i nie tylko) środowiska programistów poprzez wymianę pomysłów, doświadczeń wśród wielu różnych technologii związanych z internetem - nie ma narzędzi idealnych, każdy projekt warto rozpatrzyć indywidualniena spotkaniu są różnorodni ludzie, więc dobra okazja na poszukanie nowej pracy lub znalezienie pracownikaspotkanie raz w miesiącu w luźnej atmosferze (Pub Mao, Młynowa 44, http://www.mao.com.pl/ )…

Oni migają tymi kolorami w sposób profesjonalny. Narodziny gamedevu z ducha demosceny w Polsce - Piotr Marecki i Tomasz TDC Cieślewicz, recenzja książki

Tytuł książki jest mocno rozbudowany i zapewne pierwsze spojrzenie na okładkę może odstraszyć potencjalnego klienta, jednakże, warto dać szansę tej pozycji. Zaskoczeń jest kilka, chociaż nie tylko tych pozytywnych. Zatem przejdźmy do krótkiej recenzji "Oni migają tymi kolorami w sposób profesjonalny".TDC - Demoscena, Atari, Mirage i piractwo w PolsceKsiążka jest zbiorem historii opowiadanych przez Tomasza TDC Cieślewicza. Swoje przygody z IT zaczął w 1988 roku, kiedy to otrzymał Atari 800 XL. Od 1989 roku związany był z Mirage i jako jeden z najmłodszych tworzył gry na rynek polski. Był również współpracownikiem "Bajtka" i członkiem redakcji "Atari Magazynu". Bardzo mocno związany z demosceną Atari, gdzie tworzy do dziś. Zaangażowany w szkolenia i warsztaty z programowania. Obecnie redaktor Atarionline.plPrzyznaję, że wcześniej nie słyszałem o Tomaszu Cieślewiczu, ale po przeczytaniu tej książki śmiało można powiedzieć, że dziś zapewne byłby freelancerem …

Licznik Blogowy - wersja 0.6, czyli własne statystyki i wykresy tuż pod ręką

Zapewne wielu z Was pamiętam, a może i używa:) , mojej wtyczki Licznik Blogowy do najpopularniejszych przeglądarek, skierowanej do blogerów na portalu dobreprogramy.Jeśli ktoś nie kojarzycie, to w skrócie: Licznik Blogowy to wtyczka do Chroma/Opery/Firefoxa. Za jej pomocą przejrzycie szybko pełne statystyki swoich wpisów na blogu. Lista wpisów może być sortowana wg: ilości wyświetleń, ilości komentarzy, daty publikacji i adnotacji moderacji. Łatwo znajdziecie publikacje, oznaczone przez moderatorów, a to wszystko w estetycznej i miłej formie, dostosowanej do wybranej skórki na blogu.Licznik Blogowy 0.6 - czas na własne wykresy! :)Ostatnia odsłona wtyczki przyniosła ciekawe refleksje po rozmowie z szanownym Panem Mordziem. Zaproponował on, aby wtyczka mogła generować wykresy na podstawie zebranych danych. Pomysł wydał mi się niezmiernie interesujący, stąd też obecna aktualizacja (0.6) przynosi możliwość tworzenia wykresów, opierając się na zabranych danych.Używanie nowej funkcji jes…

Nie tylko Wiedźmin. Historia polskich gier komputerowych — książka, której nie wypada nie kupić [recenzja]

Wspomnień czar. Czyli dawno, dawno temu...Moja przygoda z grami zaczęła się na poważnie od Amigii 500. W zestawie wraz z komputerem dostałem Lemingi i Powermonger, w pudełkach z taniej serii od IPSu, plus kartonowe wydanie Tokiego z Wielkiej Brytanii. Oczywiście w komplecie były również potężny zestaw dyskietek z ogromną ilością oprogramowania. Każdy nośnik był ręcznie podpisany i wskazywał jawnie na nielegalne źródło pochodzenia, aczkolwiek przed rokiem 1994, czyli przed wejściem ustawy "antypirackiej" , nikt nawet się tym nie przejmował.Gry, do pewnego momentu, zawsze kojarzyły się z językiem angielskim, który dla młodego człowieka na początku lat 90tych był często dużą barierą nie do pokonania. Często zatem siadałem ze słownikiem w dłoni i mozolnie tłumaczyłem newralgiczne elementy gry, bez których dalsze przejście gier było niemożliwe. Oczywiście zdarzały się wyjątki. Słynny Flashback otrzymałem w wersji francuskiej, a mimo to przeszedłem kilka poziomów. Wiele było ró…

Visual Studio Achievements

Każdy kto gra w gry, spotkał się z terminem achievement, czyli osiągnięcie. Za każdą, rzecz jaką zrobimy w grze, czy to znalezienie sekretu, czy zwykłe przejście mapy, odblokowujemy określone osiągnięcie. Jest to obecnie na konsolach, czy na Steamie. Możemy pochwalić się osiągnięciami wśród znajomych w systemie w jakim gramy, czy na Facebooku. Prosty sposób na wydłużenie gry i zwiększenie więzi pomiędzy graczem, a grą.Visual Studio Achievements. Co ma do tego Visual Studio? Ktoś wpadł na genialny pomysł. Połączył założenia achievementów ze świata gier z kodowaniem w Visual Studio! :) Wszystko zaczęło się na www.reddit.com, gdzie ktoś z nudów/dla żartów dodał wątek "A co gdyby, Visual Studio miało osiągnięcia?". Okazało się, że pomysł chwycił na tyle, iż powstał... plugin (darmowy) do Visual Studio! Każdy z Was może go ściągnąć i zainstalować w Visualu. Od tej chwili będzie zbierał osiągnięcia, niczym w grach wideo :)Tak jak w grach, za konkretne czynności odblokowujemy osi…

Tania, przeceniona prasa - lukratywny biznes na pograniczu prawa? Czyli CD-Action za 4zł

Zapewne większość z was zna pojęcie "taniej prasy" lub "przecenionej prasy". Są to najczęściej miejsca, gdzie można kupić gazety, magazyny i inne dobra kryjące się pod definicją prasy. Ich cechą jest to, iż nie są to aktualne wydanie, ale w większości przypadków "przeterminowane" egzemplarze, które zostały zastąpione aktualnymi numerami. Można zatem znaleźć tam magazyn sprzed roku lub dwóch, ale także numer CD-Action za 4zł, z jeszcze działającym kodem na gry, który dosłownie kilka dni wcześniej można było kupić w saloniku z prasą za 10,99zł.Jak to powinno być?Przeglądając strony w sieci natknąłem się na kilka artykułów, które opisują dany problem. Zgodnie z umowami, dystrybutorzy prasy nieaktualne numery powinni zwracać do wydawców. Drugą opcją jest zaś oddawanie takiej prasy na makulaturę. Zanim jednak trafi ona na "wysypisko" powinna zostać naznaczona farbą lub przecięta w taki sposób, aby nie nadawała się do odsprzedaży.A jak jest?Trudno jed…

Licznik Blogowy 2017 — niezbędnik blogera (Chrome/Opera/Firefox)

Nadeszła ta chwila. Po wielu latach oficjalnie światło dziennie ujrzała finalna wersja Licznika Blogowego. Dodatku do przeglądarki www, który pozwala na zbieranie danych o każdym blogu na portalu (nawet bez logowania!) i przedstawieniu statystyk w formie tekstowej i graficznej.HistoriaHistoria Licznika Blogowego sięga roku 2014. Wówczas to na początku roku powstaje dodatek do Chrome, który zbiera dane odnośnie wyświetleń wszystkich wpisów blogowych zalogowanej osoby. W przeciągu najbliższych miesięcy wtyczka otrzymuje możliwość instalacji na przeglądarkach Firefox i Opera, a także tworzenie wykresów na podstawie zebranych danych.Niestety w przeciągu lat portal przeszedł na https, a możliwość instalacji wtyczek spoza marketu stała się utrudniona lub nawet niemożliwa na wspieranych przeglądarkach. W ostatnim czasie otrzymałem sporo zapytań odnośnie reaktywacji wtyczki i przyszedł ten czas, aby zaprezentować finalną wersję.Licznik BlogowyLicznik Blogowy przeznaczony jest do analizy blo…