Sdílet prostřednictvím

Postupy: Definování profilu pro rozšíření UML

  • Článek

V Visual Studio Ultimate můžete definovat profil UML k přizpůsobení prvků standardního modelu pro konkrétní účely.Profil definuje jeden nebo více Stereotypů UML.Stereotyp lze použít k označení typu jako určitého druhu objektu.Stereotyp můžete také rozšířit na seznam vlastností prvku.

Několik profilů se nainstaluje s Visual Studio Ultimate.Další informace o těchto profilech a o tom, jak použít Stereotypy, viz Přizpůsobení modelu pomocí profilů a stereotypů.

Můžete definovat vlastní profily k přizpůsobení a rozšíření UML na vlastní obchodní oblast nebo architekturu.Příklad:

  • Pokud často definujete webové stránky, můžete definovat vlastní profil, který obsahuje stereotyp "Webové stránky", který lze použít na třídy v diagramech tříd.Můžete pak použít diagramy tříd k plánování webu.Každá třída «Webová stránka» by měla další vlastnosti pro obsah stránky, styl a tak dále.

  • Pokud vyvíjíte bankovní software, můžete definovat profil, který umožňuje stereotyp "Účet".Můžete pak použít diagramy tříd k definování různých typů účtu a zobrazení vztahů mezi nimi.

Svému týmu můžete distribuovat vlastní profily.Každý člen týmu může nainstalovat váš profil.Díky tomu mohou upravovat a vytvářet modely, které používají jeho stereotypy.

[!POZNÁMKA]

Pokud aplikujete stereotypy profilu v modelu, který upravujete, a pak model sdílíte s jinými uživateli, měli by tito instalovat stejný profil na svých vlastních počítačích.Jinak nebudou moci zobrazit stereotypy, které jste použili.

Profil je často součástí většího rozšíření Visual Studio.Můžete například definovat příkaz, který převede některé části modelu na kód.Můžete definovat profil, který uživatelé musí použít na balíčky, které chtějí překládat.Budete distribuovat váš nový příkaz spolu s profilem v jednom rozšíření Visual Studio.

Můžete také definovat lokalizované varianty profilu.Uživatelé načítající vaše rozšíření uvidí variantu, která je vhodná pro jejich vlastní jazykovou verzi.

Jak definovat profil

Definování profilu UML

  1. Vytvořte nový XML soubor s příponou názvu souboru .profile.

  2. Přidání definic stereotypu podle pokynů popsaných v části Struktura profilu.

  3. Přidat profil do rozšíření aplikace Visual Studio (soubor .vsix).Můžete vytvořit nové rozšíření pro váš profil nebo profil přidat do existujícího rozšíření.

    Viz následující část, Jak přidat profil do rozšíření aplikace Visual Studio.

  4. Nainstalujte rozšíření ve svém počítači.

    1. Dvakrát klikněte na příponu souboru, který má příponu názvu souboru .vsix.

    2. Restartujte aplikaci Visual Studio.

  5. Ověřte, že profil byl nainstalován.

    1. V Průzkumníku modelu UML vyberte model.

    2. V okně Vlastnosti klikněte na vlastnost Profily.Váš profil se zobrazí v nabídce.Nastavte zaškrtávací políčko vedle profilu.

    3. Vyberte prvek, pro které váš profil definuje stereotypy.V okně Vlastnosti klikněte na vlastnost Stereotypy.V seznamu se zobrazí vaše stereotypy.Nastavte zaškrtávací políčko proti jednomu stereotypu.

    4. Pokud váš profil definuje další vlastnosti tohoto stereotypu, rozbalte vlastnosti stereotypu a zobrazte je.

  6. Odešlete soubor rozšíření ostatním uživatelům Visual Studio k instalaci v jejich počítačích.

Jak přidat profil do rozšíření aplikace Visual Studio

Chcete-li nainstalovat profil a umožnit si odesílat ho jiným uživatelům, musíte přidat profil k rozšíření aplikace Visual Studio.Další informace naleznete v tématu Nasazení rozšíření aplikace Visual Studio.

Definování profilu v novém rozšíření sady Visual Studio

  1. Vytvořte projekt rozšíření Visual Studio.

    [!POZNÁMKA]

    K použití tohoto postupu je třeba mít nainstalovanou sadu Visual Studio SDK.

    1. V nabídce Soubor přejděte na příkaz Nový a klikněte na Projekt.

    2. V dialogovém okně Nový projekt, v části Instalované šablony, rozbalte uzelVisual C#, klikněte na Rozšiřitelnost a potom klikněte na Projekt VSIX.Zadejte název projektu a klepněte na tlačítko OK.

  2. Přidejte profil do projektu.

    • V Průzkumníku řešení klikněte pravým tlačítkem myši na projekt, přejděte na Přidat, a pak klikněte na Existující položka.V dialogovém okně vyhledejte soubor profilu.

  3. Nastavení vlastnost souboru profilu Kopírovat na výstup.

    1. V Průzkumníku řešení klikněte pravým tlačítkem myši na soubor profilu a potom klikněte na položku Vlastnosti.

    2. V okně Vlastnosti nastavte vlastnost Kopírovat do výstupního adresáře na Kopírovat vždy.

  4. V Průzkumníkovi řešení otevřete source.extension.vsixmanifest.

    Soubor se otevře v editoru manifestu rozšíření.

  5. Na stránce Aktiva přidejte řádek s popisem profilu:

    • Klikněte na tlačítko Nový.Nastavte pole v dialogovém okně Přidat nové aktivum následujícím způsobem.

    • Nastavte možnost Type na Microsoft.VisualStudio.UmlProfile.

      Nejde o jednu z možností rozevíracího seznamu.Tento název zadejte z klávesnice.

    • Klepněte na Soubor v systému souborů a vyberte název souboru profilu, například MyProfile.profile

  6. Sestavte projekt.

  7. Chcete-li ladit tento profil, stiskněte klávesu F5.

    Otevře se experimentální instance aplikace Visual Studio.V takovém případě otevřete projekt modelování.V Průzkumníku UML vyberte kořenový prvek modelu a v okně Vlastnosti vyberte požadovaný profil.Potom vyberte prvky uvnitř modelu a nastavte stereotypy, které jste pro ně definovali.

  8. Extrahování VSIX pro nasazení

    1. V Průzkumníku Windows otevřete složku .\bin\Debug nebo .\bin\Release k vyhledání souboru .vsix.Toto je soubor rozšíření Visual Studio.Může být nainstalován v počítači a odeslán ostatním uživatelům aplikace Visual Studio.

    2. Chcete-li instalovat rozšíření:

      1. Dvakrát klikněte na soubor .vsix.Spustí se instalační program rozšíření sady Visual Studio.

      2. Restartujte všechny instance programu Visual Studio, které jsou spuštěny.

Následující alternativní postup lze použít pro malá rozšíření, pokud jste nenainstalovali Visual Studio SDK.

Definování rozšíření profilu bez použití Visual Studio SDK

  1. Vytvořte adresář systému Windows, který obsahuje následující tři soubory:

    • YourProfile.profile

    • extension.vsixmanifest

    • [Content_Types].xml – zadejte tento název, jak je znázorněno zde, v hranatých závorkách

  2. Upravte [Content_Types].xml, aby obsahovala následující text.Všimněte si, že obsahuje položku pro každou příponu názvu souboru.

    <?xml version="1.0" encoding="utf-8"?>
<Types xmlns="https://schemas.openxmlformats.org/package/2006/content-types">
  <Default Extension="profile" ContentType="application/octet-stream" />
  <Default Extension="vsixmanifest" ContentType="text/xml" />
</Types>

  3. Kopírovat existující extension.vsixmanifest a upravit jej pomocí editoru XML.Změnit uzly ID, Název a Obsah.

    • Příklad extension.vsixmanifest naleznete v tomto adresáři:

      drive**:\Program Files\Microsoft Visual Studio 12.0\Common7\IDE\Extensions\Microsoft\Architecture Tools\UmlProfiles**

    • Uzel Obsah by měl být takto:

      <Content>
  <CustomExtension Type="Microsoft.VisualStudio.UmlProfile"
  >YourProfile.Profile</CustomExtension>
</Content>

  4. Tři soubory zkomprimujte do souboru ZIP.

    V průzkumníku Windows vyberte tři soubory, klikněte pravým tlačítkem myši, přejděte na Odeslat do a klikněte na Komprimovaná složka (metoda ZIP).

  5. Přejmenujte zabalený soubory a změňte jeho příponu souboru z .zip na .vsix.

  6. Chcete-li profil nainstalovat v libovolném počítači s odpovídajícími verzemi sady Visual Studio, poklepejte na soubor .vsix.

Instalace profilu UML z rozšíření sady Visual Studio

  1. Poklepejte na soubor .vsix v Průzkumníku Windows nebo jej otevřete v aplikaci Visual Studio.

  2. V dialogovém okně, které se zobrazí, klikněte na Instalovat.

  3. Chcete-li odinstalovat nebo dočasně zakázat rozšíření, otevřete Správce rozšíření z nabídky Nástroje.

Jak definovat lokalizované profily

Můžete definovat různé profily pro různé jazykové verze nebo jazyky a zabalit je do stejného rozšíření.Pokud uživatel načte vaše rozšíření, uvidí profil, který jste definovali pro jeho jazykovou verzi.

Vždy je nutné zadat výchozí profil.Pokud jste nedefinovali profil pro jazykovou verzi uživatele, zobrazí se výchozí profil.

Definování lokalizovaného profilu

  1. Vytvořte profil, jak je popsáno v předchozích částech Jak definovat profil a Jak přidat profil do rozšíření aplikace Visual Studio.To je výchozí profil a bude použit v jakékoli instalaci, pro kterou neposkytnete lokalizovaný profil.

  2. Přidejte nový adresář ve stejném adresáři jako výchozí soubor profilu.

    [!POZNÁMKA]

    Pokud vytváříte rozšíření pomocí projektu aplikace Visual Studio, přidejte novou složku do projektu pomocí Průzkumníka řešení.

  3. Změňte název nového adresáře na krátký kód ISO pro lokalizovanou jazykovou verzi, jako například bg pro bulharštinu, nebo fr pro francouzštinu.Používejte neutrální jazykovou verzi kódu, obvykle dvě písmena, nikoli konkrétní jazykovou verzi jako fr-CA.Další informace o kódech jazykových verzí viz CultureInfo.GetCultures metody, kde naleznete úplný seznam kódů jazykových verzí.

  4. Přidejte kopii výchozího profilu do nového adresáře.Neměňte jeho název souboru.

    Vzorová složka rozšíření Visual Studio, než je sestavena nebo komprimována do souboru .vsix soubor, bude obsahovat následující složky a soubory:

    extension.vsixmanifest

    MyProfile.profile

    fr\MyProfile.profile

    de\MyProfile.profile

    [!POZNÁMKA]

    Neměli byste do extension.vsixmanifest vkládat odkaz na lokalizované verze profilů.Zkopírované soubory profilu musí mít stejný název jako profil v nadřazené složce.

  5. Upravte novou kopii profilu, přitom přeložte do cílového jazyka všechny části, které budou viditelné pro uživatele, jako atributy displayName.

  6. Můžete vytvořit složky další jazykové verze a lokalizované profily pro tolik jazykových verzí, kolik chcete.

  7. Sestavte rozšíření aplikace Visual Studio sestavením rozšíření projektu nebo zkomprimováním všech souborů, jak je popsáno v předchozích částech.

Struktura profilu

Soubor XSD profilů UML lze najít v následující ukázce: Nastavení stereotypů a profilů XSD.Abyste měli upravování souborů profilů snazší, nainstalujte soubor .xsd do:

%ProgramFiles%\Microsoft Visual Studio 11.0\Xml\Schemas

Tato část používá profil C# jako příklad.Definici kompletního profilu najdete v:

drive**:\Program Files\Microsoft Visual Studio 12.0\Common7\IDE\Extensions\Microsoft\Architecture Tools\UmlProfiles\CSharp.profile**

První část této cesty se ve vaší instalaci může lišit.

Další informace o profilu .NET naleznete v tématu Standardní stereotypy pro modely UML.

Hlavní části definice profilu UML

Každý profil obsahuje následující obsah:

<?xml version="1.0" encoding="utf-8"?>
<profile dslVersion="1.0.0.0" 
       name="CSharpProfile" displayName="C# Profile" 
       xmlns="https://schemas.microsoft.com/UML2.1.2/ProfileDefinition">
  <stereotypes>...</stereotypes>
  <metaclasses>...</metaclasses>
  <propertyTypes>...</propertyTypes>
</profile>

[!POZNÁMKA]

Vlastnost nazvaná name nesmí obsahovat mezery ani interpunkci.Atribut displayName, který se zobrazí v uživatelském rozhraní, by měl být platný řetězec XML.

Každý profil obsahuje tři hlavní části.V opačném pořadí jsou následující:

  • <propertyTypes> – seznam typů, které se používají pro vlastnosti definované v části stereotypů.

  • <metaclasses> – seznam typů elementů modelu, které stereotypy v tomto profilu použijí, například IClass, IInterface, IOperation, IDependency.

  • <stereotypes> – definice stereotypů.Každá definice obsahuje názvy a typy vlastností, které jsou přidány do cílového elementu modelu.

Typy vlastností

Část <propertyTypes> deklaruje seznam typů, které se používají pro vlastnosti v části <stereotypes>.Existují dva druhy typů vlastností: externí a výčet.

Externí typ deklaruje plně kvalifikovaný název typu .NET standard:

<externalType name="System.String" />

Typ výčtu definuje sadu hodnot literálu:

    <enumerationType name="PackageVisibility">
      <enumerationLiterals>
        <enumerationLiteral name="internal" displayName="internal"  />
        <enumerationLiteral name="protectedinternal" displayName="protected internal" />
      </enumerationLiterals>
    </enumerationType>

Metatřídy

Část <metaclasses> je seznam typů prvků modelu, na kterých lze definovat stereotypy v tomto profilu:

<metaclass 
      name="Microsoft.VisualStudio.Uml.Classes.IClass" />
<metaclass
      name="Microsoft.VisualStudio.Uml.Classes.IInterface" />
<metaclass
      name="Microsoft.VisualStudio.Uml.Components.IComponent" />

Úplný seznam prvků modelu a typů vztahu, které lze použít jako metatřídy, viz Typy prvků modelu.

Definice stereotypu

Část <stereotypes> obsahuje jednu nebo více definic stereotypu:

    <stereotype name="CSharpClass" displayName="C# Class"> ...

Každý stereotyp uvádí jeden nebo více prvků modelu nebo typů vztahu, na které jej lze použít.Můžete zadat název základního typu, chcete-li zahrnout všechny jeho odvozené typy.Pokud zadáte například Microsoft.VisualStudio.Uml.Classes.IType, stereotyp lze použít pro IClass, IInterface, IEnumeration a několik dalších typů prvků.

      <metaclasses>
        <metaclassMoniker name=
         "/CSharpProfile/Microsoft.VisualStudio.Uml.Classes.IClass" />
      </metaclasses>

Atribut namemetaclassMoniker je odkaz na prvek v části <metaClasses>.

[!POZNÁMKA]

Zástupný název musí začínat /yourProfileName/, kde yourProfileName je definováno ve vlastnosti name profilu („CSharpProfile“ v tomto příkladu).Zástupný název končí názvem jedné z položek v části metatřídy.

Každý stereotyp může obsahovat seznam nula nebo více vlastností, které přidá k libovolnému prvku modelu, na který je aplikován.<propertyType> obsahuje odkaz na jeden z typů, které jsou definovány v části <propertyTypes> .Odkaz musí být buď <externalTypeMoniker>, aby odkazoval na <externalType>,, nebo <enumerationTypeMoniker>, aby odkazoval na <enumerationType>.Opět odkaz začíná názvem profilu.

      <properties>
        <property name="IsStatic" 
                displayName="Is Static" defaultValue="false">
          <propertyType>
    <externalTypeMoniker 
                   name="/CSharpProfile/System.Boolean" />
          </propertyType>
        </property>
        <property name="PackageVisibility" 
                  displayName="Package Visibility"
                  defaultValue="internal">
          <propertyType>
            <enumerationTypeMoniker 
                  name="/CSharpProfile/PackageVisibility"/>
          </propertyType>
        </property>
      </properties>
    </stereotype>

Typy prvku modelu

Sadu typů, které můžete definovat stereotypy, je uvedena v Typy prvků modelu.

Poradce při potížích

  • Moje stereotypy se nezobrazují v Mých modelech UML.
    Musíte vybrat profil v balíčku nebo modelu.Stereotypy se pak objeví na prvcích uvnitř manifestu nebo modelu.Další informace naleznete v tématu Postupy: Přidávání stereotypů k elementům modelu.

  • Při otevření modelu UML se zobrazí následující chybová zpráva: VS1707: The following profiles cannot be loaded because a serialization error occurred: MyProfile.profile

    1. Ověřte správnost základní syntaxe XML souboru .profile.

    2. Ujistěte se, že každý název monikeru je ve formě /profileName/nodeName.Hodnota profileName je hodnota vlastnosti název v kořenovém uzlu profilu.Hodnota nodeName je hodnota atributu metatřídy, externalType nebo enumerationType.

    3. Zajistěte, že syntaxe je stejná, jak je popsáno zde, a jak je uvedeno v drive**:\Program Files\Microsoft Visual Studio 12.0\Common7\IDE\Extensions\Microsoft\Architecture Tools\UmlProfiles\**.

    4. Odinstalujte vadné rozšíření.V nabídce Nástroje klikněte na tlačítko Správce rozšíření.

      • Pokud se rozšíření nezobrazí, viz další položka.

    5. Znovu vytvořte soubor VSIX a otevřete ho v programu Průzkumník Windows, a tak ho znovu nainstalujte.Restartujte Visual Studio.

  • Rozšíření se nezobrazí ve Správci rozšíření, ale pokud se ho pokusíte znovu nainstalovat, zobrazí se následující zpráva: The extension is already installed to all applicable products.

    1. Odeberte soubor rozšíření z podsložky složky LocalAppData\Microsoft\VisualStudio\12.0\Extensions\

      • Chcete-li zobrazit LocalAppData, je nutné nastavit na kartě Zobrazení Možností složky Windows Explorer možnost Zobrazit skryté soubory a složky.

      • LocalAppData je obvykle v C:\Users\userName\AppData\Local\

    2. Restartujte Visual Studio.

Viz také

Úkoly

Postupy: Přidávání stereotypů k elementům modelu

Koncepty

Standardní stereotypy pro modely UML

Další zdroje

Přizpůsobení modelu pomocí profilů a stereotypů

Ukázka: Barevné prvky UML podle stereotypu

Ukázka: Nastavení stereotypů, profily XSD