Co je potřeba k realizaci příkladu

Transkript

1 Meta Coder - příklad krok po kroku Pozn.Dokument je vytvořen tak, aby byl srozumitelný i pro začátečníky. příklad lze také zhlédnout na Tento příklad vytvoří jednoduchou MVC2 aplikaci. Jeho cílem je přiblížení základní funkcionality Meta Coderu. Předpokladem pro to, abyste mohli aplikaci spustit, je Visual Studio 2010, SQL Server 2005 nebo výše (postačuje bezplatná Express edice) a dostatečná práva SQL Serveru. Příklad lze shlédnout také na videu (video má necelých 6 min). Alternativně příklad popisuje také tvorbu WinForm aplikace, kterou lze vytvořit, pokud nemáte nainstalovány všechny náležitosti MVC2. Postup pro tvorbu WinForm aplikace je v tomto příkladu obdobný jako u MVC s rozdílem, že se použije jiný základ aplikace a v posledním kroku generování se vygenerují namísto formulářů MVC2 formuláře typu WinForm. Pokud hodláte generovat WinForm aplikaci, v doplňujících poznámkách jsou uvedeny všechny potřebné kroky. Co je potřeba k realizaci příkladu Meta Coder PrikladProZapojeniVygenero vanychsouboru.zip PrikladVzorVysledek.zip Nainstalujte si aplikaci Meta Coder. Ke stažení na Základ jednoduché MVC aplikace je připraven pro přidávání kódů vygenerovaných pomocí Meta Coderu. Po zapojení vygenerovaného kódu bude aplikace funkční a můžete aplikaci spustit a otestovat. Najdete v {user}\documents\meta Coder\Samples\MVCApplicationVS2010\PrikladProZapojeniVygenerovanychSouboru.zip Pro možnost kontroly je přiložena také výsledná MVC aplikace včetně vygenerovaných souborů. Najdete v {user}\documents\meta Coder\Samples\MVCApplicationVS2010\PrikladVzorVysledek.zip Pro zprovoznění této aplikace je nutné vytvořit databázi (je přiložen vygenerovaný skript pro tabulky,vazby atd) a připojit tabulky do aplikace pomocí Data/McSampleMvc2.dbml 1

2 Pro generování winform aplikace najdete vše analogicky v {user}\documents\meta Coder\Samples\WFApplicationVS2010 Vlastní příklad Zadání Máme dán model Orders Předpokládejme, že při práci na hypotetické aplikaci je tento model součástí zadání programátora, které požaduje přidání tabulek do databáze včetně vazeb a omezení (constraints), naprogramovaní tříd, formulářů a případně dalšího kódu. Pro účely tohoto příkladu vytvoříme v Meta Coderu třídy Product, Supplier, ProductNotes, ProductController. Jako GUI budou sloužit vygenerované soubory ProductList.aspx, ProductList.aspx.cs, ProductDetail.aspx a ProductDetail.aspx.cs. Vygenerujeme také skript pro založení tabulek a vazeb v SQL server databázi. U Winform aplikace odpadá generování souboru Contoller a namisto souborů *.aspx vygenerujeme soubory ProductForm.Designer.cs, ProductForm.cs a ProductForm.resx. Model Orders (viz obrázek) je uložen jako soubor Orders.xmi je součástí instalace Meta Coder a najdete jej v..{user}\documents\meta Coder\Models\Samples\EA\MCPrikladProductsEA.xml (pro Enterprise Architect) nebo {User}\Documents\Meta Coder\Models\Samples\StarUml\MCPrikladProductsSU.xml (pro Star Uml). Šablony pro generování kódu Struktura formulářů, tříd, databáze, tabulek, skriptů atd. je daná šablonami. Šablony jsou v...{user}\documents\meta Coder\Templates\Samples\ pozn. Šablony odpovídají testovacímu frameworku a mohou být dobrým výchozím bodem pro vytvoření šablon pro vaši aplikaci. Lze je přízpůsobit nejrůznějším pravidlům a struktuře kódu. Šablony pro váš framework můžete vytvořit sami nebo svěřit jejich vytvoření nám (). 2

3 Vlastní Generování pozn. pro funkčnost výsledné aplikace je nutné dodržet přesně pojmenování Namespace a souboru *.dbml. V Mvc2 aplikaci je to McSampleMvc2 a v winform aplikaci McSampleWf. Podrobnosti jsou dále v textu. Doporučujeme kopírování těchto názvů. Spustíme MetaCoder Generování tříd V menu vybereme volbu Generování/Generování zdroj. kódu Programovací jazyk..nastavte na C# Základní Namespace..Pro Mvc2 aplikaci zadejte McSampleMvc2. Pro WinForm aplikaci zadejte McSampleWf. Vstupní xmi soubor..zadejte cestu k model xmi souboru popisující model. Zadejte {user}\documents\meta Coder\Models\Samples\EA\MCPrikladProductsEA.xml Package..pro dané xmi se předvyplní Products Šablony (složka)..vyberte soubor šablony v umístění {user}\documents\meta Coder\Templates\Samples\CIS\Trida Uložit do složky..dle vašeho uvážení např. {user}\documents\meta Coder\Results Ostatní XMI.. zde se zadává složka obsahující soubory modelu na kterých je generovaný model závislý. V tomto případě pole ostatní XMI ponecháme prázdné. Proveďte generování kódu tlačítkem Generuj program Po vygenerování analogicky podle obrázku budou ve složce Results tři soubory odpovídající třídám modelu a log. Pokračujte v generování. Popis generování je dále rozdělen dle druhu výsledné aplikace: A) Mvc2 aplikace Jsou popsány pouze změny v nastavení generovacího formuláře proti generování třídy. Ostatní zůstává. Generování kontroleru v Šablony (složka) vybereme {user}\documents\meta Coder\Templates\Samples\CIS\Controller a 3

4 zadáme generovat Generování souborů formulářů *.aspx.cs pro list v Šablony (složka) vybereme {user}\documents\meta Coder\Templates\Samples\CIS\List a zadáme generovat. Pro detail v Šablony (složka) vybereme {user}\documents\meta Coder\Templates\Samples\CIS\Detail a zadáme generovat Generování souborů formulářů *.aspx nastavíme programovací jazyk na ASP a pokračujeme v generování v Šablony (složka) vybereme {user}\documents\meta Coder\Templates\Samples\ASP\List a zadáme generovat v Šablony (složka) vybereme {user}\documents\meta Coder\Templates\Samples\ASP\Detail a zadáme generovat B) Winforms aplikace pozn. Základní Namespace pro WinForm aplikace vyplňte pro generování formuláře i třídy McSampleWf Generování formulářů Programovací jazyk..nastavte na C# Základní namespace: vyplňte přesně textem McSampleWf Vstupní xmi soubor..zadejte cestu k model xmi souboru popisující model. Zadejte {user}\documents\meta Coder\Models\Samples\EA\MCPrikladProductsEA.xml Package..předvyplní se Product v Šablony (složka) vybereme {user}\documents\metacoder\templates\samples\cis\winformeditablelist Uložit do složky..dle vašeho uvážení např. {user}\documents\meta Coder\Results zadáme tlačítkem generovat Dále společně pro Mvc2 aplikaci i WinForm aplikaci: Generování skriptu pro SQL tabulky, vazby mezi nimi atd. nastavíme programovací jazyk na MS SQL vybereme {user}\documents\meta Coder\Templates\Samples\MSSQL a zadáme generovat. pozn. do pole ostatní XMI se zadává složka obsahující soubory modelu na kterých je náš generovaný model závislý. V tomto případě pole ostatní XMI ponecháme prázdné. Vygenerované soubory Pomocí Meta Coderu jsme vytvořili všechny potřebné soubory zdrojového kódu a skript pro vytvoření tabulek. Soubory si můžete prohlédnout v umístění dle cesty, kterou jste zadali v editboxu Uložit do složky. Nyní je dokončena práce s Meta Coderem a zbytek textu se zabývá zapojením zdrojových souborů do aplikace. Výsledná aplikace bude plně funkční. Není zapotřebí žádného dalšího programování. Dokončení aplikace Vytvoření databáze SQL Serveru Pro dokončení aplikace potřebujeme vytvořit databázi v SQL Serveru. Tabulky a vazby vytvoříme spuštěním vytvořeného sql skriptu nad zvolenou databází obvykle v Management Studiu. Je nutno přepsat Rollback na konci skriptu na Commit. Pojmenování databáze je libovolné. 4

5 Vytvoření databáze v SQL Serveru verzi Express Pokud máte nainstalovánu jen SQL Server Express edici a nemáte nainstalováno Management Studio, databázi SQL Serveru pro účely příkladu, lze jednoduše založit ze Server Exploreru Visual Studia (View/Server Explorer nebo View/Other Windows/Server Explorer) Předpokladem jsou dostatečná práva uživatele. Otevře se následující okno Pokud neznáte název serveru pro zobrazení dostupných serverů spusťte v Sql Server Configuration Manageru službu SQL Server Browser. Databázi lze alternativně založit také pomocí SQLCMD Skript pro vytvoření tabulek lze, pokud nemáte k dispozici SQL Server Management Studio, spustit z příkazového řádku pomocí SQLCMD jako: sqlcmd -S Server -d DBName -E -i "inputfile.sql" např: sqlcmd -S ibm-fa0ba43901\sqlexpress -d McSampleExpress -E -i "ProductsScript_GuidIds.sql". Pozn: pro práci s SQL Server Express je nutno mít dostatečná práva a spuštěny příslušné služby. Ze Start menu spustíme SQL Server Configuration Manager. SQL Server pokud tato služba není spuštěna spustíme ji. SQL Server Browser nám zajistí zobrazování názvů serverů, ke kterým je možno se připojit v konfiguračních oknech např ve Visual studiu. Pokud neznáte název serveru pro SQLEXPRESS, spusťte tuto službu. 5

6 Rozbalíme soubor projektu do vámi zvoleného umístění. Pro Mvc2: {user}\documents\meta Coder\Samples\MVCApplicationVS2010\PrikladProZapojeniVygenerovanychSouboru.zip ProWinForms: {user}\documents\meta Coder\Samples\WFApplicationVS2010\ PrikladProZapojeniVygenerovanychSouboruWf.zip Rozbalený soubor projektu otevřeme ve Visual studiu a připojíme vygenerované tabulky viz. další odstavec. Přístup k tabulkám v databázi pozn. Příklady jsou zpracovány tak, aby je mohl realizovat i začátečník s základními znalostmi Pro přístup k tabulkám z VS2010 je v tomto příkladu je využit Linq to SQL. (Po úpravě šablon lze samozřejmě využít i jiné způsoby jako Entity Framework atd). Pravým tlačítkem na složce Data v Solution Exploreru v projektu vybereme volbu Add/New item. Vybereme LINQ to SQL Classes a založíme nový item McSampleMvc2.dbml (Pro WinForm aplikaci použijte název McSampleWf.dbml) V okně Server Explorer přidejte Connection (ve Visual Studiu View/Server Explorer) 6

7 V následujícím okně zvolte server a databázi ve které se nacházejí tabulky z vygenerovaného skriptu. Přetáhněte z Server Exploreru tabulky do McSampleMvc2.dbml (u WinForm aplikace McSampleWf.dbml) (Tabulky lze přetáhnut označením a přetažením myší). Tímto se vytvoří třídy obalující tabulky databáze 7

8 Přidání vygenerovaných souborů do aplikace Otevřeme soubor McSampleMvc2.sln (nebo McSampleWf.sln pro winforms) ve Visual studiu a složku s vygenerovanými soubory např. ve Windows Exploreru. Soubory lze nejjednodušeji zkopírovat přetažením nebo copy/paste přímo z okna Windows Exploreru do příslušné složky v okně Solution Exploreru Visual Studia. Zkopírujeme soubory Product.cs, ProductNote.cs a Supplier.cs do složky Models. Pro příklad Mvc2 zkopírujeme soubor ProductController.cs do složky Controllers. Dále zkopírujeme ProductDetail.aspx, ProductDetail.aspx.cs, SupplierDetail.aspx, SupplierDetail.aspx.cs, ProductList.aspx, ProductList.aspx.cs, SupplierList.aspx, SuplierList.aspx.cs do složky Views/Products. Soubory formulářů (s příponou aspx a aspx.cs) u MVC2 umístíme do složky Views/Products!! (jinak by aplikace nebyla funkční... Mvc2 vyžaduje v tomto případě tuto strukturu adresářů). Pro winform přetáhneme do View soubory ProductForm.Designer.cs, ProductForm.cs, ProductForm.resx, SupplierForm.Designer.cs, SupplierForm.cs a SupplierForm.resx Tímto je aplikace připravena. Aplikace nám umožňuje přidávání záznamů produktů a supplierů. Při zadávání záznamů produktu je nutno vybírat suppliery. Proto je nutno nejprve zadat záznamy supplierů. Součástí testovací aplikace není menu, proto je před spuštěním Mvc2 i Winform aplikace nutné nastavit jako výchozí ten formulář, který hodláme spustit. 1. Mvc2: zde lze nastavit výchozí form, který se otevře po spuštění aplikace v souboru global.asax. Global.asax je součástí aplikace a najdete jej v Solution Exploreru Visual Studia. Pro spuštění ProductList (poté co už jsme zadali záznamy supplierů) je nutno přepsat v souboru Global.asax v routes.maproute (viz obrázek níže) text SupplierList na ProductList (akce ProductsControlleru ProductList). 8

9 2. WinForm aplikace: výchozí formulář, který se otevře po spuštění aplikace nastavíme v Solution Exploreru v soubou Program.cs. Pokud hodláme spustit ProductList tak metodě Main v Program.cs na řádku Application.Run přepíšeme SupplierForm na ProductForm. V aplikaci Mvc2 I WinForm spusťte jako první SupplierList a přidejte záznamy. ProductList má smysl spustit až poté, co existuje aspoň jeden záznam Supplier, aby bylo možné vybrat suppliera produktu. Součástí testovací WinForm aplikace není žádné menu. Formulář, který má být startu aplikace spuštěn, nastavte v Program.cs. Tipy Tento příklad slouží pro základní pochopení Meta Coderu. V realitě se velmi často definují omezení jako unikátnost položek, četnosti vazeb atd. S tím Meta Coder počítá. Zde jsou tipy pro zpřesnění generovaného kódu. Více viz příklad pokročilejší a nápověda. ošetření unikátnosti Atributů pomocí Constraint. Na základě constraintů lze generovat různé kontroly. Meta Coder umožňuje rozhodnout na základě vstupu, zda je položka povinná nebo může nabývat hodnoty NULL a při generování veškerého kódu to zohlednit. Možnost zpracování četnosti vazeb..jiný kód pro 1..*, 1..1 atd Možnost standardizovat v šablonách metody a na základě modelu rozhodnout, které generovat. (Pro nejvyšší produktivitu se osvědčilo nadefinovat metody, které jsou typické pro všechny nebo většinu tříd ze skupiny, v šablonách napevno ). Prefixy (např. prefixy u tabulek) lze generovat pomocí konfiguračního souboru v parametrech Meta&dollarPCG&dollarparam.xml, do kterého lze možno zadat prefix dle názvu package. Náměty a dotazy posílejte prosím na 9