Thema 4 Acceleo- Sprachmittel und Generatorstruktur

Transkript

1 SE Vertiefung Beuth-Hochschule Berlin Thema 4 Acceleo- Sprachmittel und Generatorstruktur

2 1. ACCELEO-PRAXIS (c) schmiedecke 14 SE3 2

3 Abgeguckt bei Obeo UmlToJava Es gibt zwei Generatorprojekte UmltoJava UmlToJava (Helios) einfach über den Marketplace installieren (überschaubarer, hier überwiegend verwendet) UmlToJava (Kepler) über das Obeo-Network von Github herunterladen (Anspruchsvoll, Projekt wird fortgeführt) (c) schmiedecke 14 SE3 3

4 Templating-Sprache Ein Generator besteht aus Templates (+ Queries + Properties) (mind.) ein Template wird als Main Template ausgezeichnet Die Ausgabe erfolgt in die Datei, die im File-Block angegeben ist Mehrere File-Blöcke sind möglich, aber nur nacheinander (c) schmiedecke 14 SE3 4

5 Beispiel 1 [comment encoding = UTF-8 /] [module generateumltojava(' [template public generate(aclass : Class)] [file (aclass.name.concat('.java'), false)] public class [aclass.name.toupperfirst()/] { [for (p: Property aclass.attribute) separator('\n')] private [p.type.name/] [p.name/]; [/for] [for (p: Property aclass.attribute) separator('\n')] public [p.type.name/] get[p.name.toupperfirst()/]() { return this.[p.name/]; } [/for] } [/file] (c) schmiedecke 14 SE3 5 [/template]

6 Beispiel 1a [module generatejava(' [import common/] [import interfacebody/] [import org::eclipse::acceleo::module:.example::uml2java::helios::common::classbody/] [template public generateclass(c : Class)] /] [file (c.getfullpathfile().trim(), false)] [_commentfileblock()/] [c.packageblock()/] [importblock()/] [_commentbodyblock()/] [c.generateclassbody()/] [/file] [/template] (c) schmiedecke 14 SE3 6

7 Beispiel 1b zweites Main Module und zweites File [template public generateinterface(i : Interface)] /] [file (i.getfullpathfile().trim(), false)] [_commentfileblock()/] [i.packageblock()/] [importblock()/] [_commentbodyblock()/] [i.generateinterfacebody()/] [/file] [/template] [query public getjavafilename (name : String) : String = name.concat('.java') /] (c) schmiedecke 14 SE3 7

8 Templates - Details Templates haben keinen Rückgabetyp, sie erzeugen Output (String) Templates haben Parameter, die Typen sind Metamodell-Elemente Ein Template-Aufruf wird nur ausgeführt, wenn der Parameter "passt" (bzw. die Parameter passen) Bei Anwendung auf eine Menge von Elementen wird das Template wiederholt angewendet (s. Folgefolie) Templates realisieren Polymorphie sie werden je nach Parameter-(Sub-)Typ ausgewählt (s. Folgefolie) (c) schmiedecke 14 SE3 8

9 Beispiel 2a: Schleife und Typ-Switch Quelle: Acceleo Best Pracitces [template public classswitchtemplate(eclass : Eclass) [for (enamed : ENamendeElement eclass.eallcontents(enamedelement))] [if (enamed.ocliskindof(etypedelement))] do something for ETypedElement [elseif (enamed.ocliskindof(estructuralfeature))] do something for EStructuralFeature [elseif (enamed.ocliskindof(eattribute))] do something for Eattribute [/if] [/for] [/template] (c) schmiedecke 14 SE3 9

10 Beispiel 2b: Menge und Polymorphie [template public polymorphicclasstemplate(eclass : EClass)] [eclass.eallcontents(enamedelement).dosomething()/] [/template] [template private dosomething(arg : ETypedElement)] do something for ETypedElement [/template] [template private dosomething(arg : EStructuralFeature)] do something for EStructuralFeature [/template] [template private dosomething(arg : EAttribute)] do something for EAttribute [/template] [template (c) schmiedecke private 14 dosomething(arg : ENamedElement)] SE3 [/template] 10

11 Navigieren im Modell Navigieren im Modell erfolgt anhand des Metamodells Zu den Attributen liefert typischerweise einfache Werte [c.name/] Über die Assoziationen des Metamodells liefert typischerweise Mengen!! [c.superclass/] Über die Funktionen des EMF-GenModels Über die Acceleo-Operationen auf EObject eallcontents econtainer ancestors siblings followingsiblings... (c) schmiedecke 14 SE3 11

12 Navigieren mithilfe des EMF-GenModels der UML (c) schmiedecke 14 SE3 12

13 Beispiel 3 Navigieren im Modell [template public generateclassbody(c : Class)] public [if (c.isabstract)] abstract [/if] class [c.name.toupperfirst()/] [for (superc : Class c.superclass) before(' extends ') separator(',')] [superc.name/] [/for] [for (interf : Interface c.getimplementedinterfaces()) before(' implements ') separator(',')] [interf.name/] [/for] (c) schmiedecke 14 SE3 13

14 ...erreichbar über die Acceleo-Vorhersage (c) schmiedecke 14 SE3 14

15 Beispiel 4 [for (p : Property c.getallattributes())] [if (p.upper = -1 or p.upper > 1)] private List<[p.type.name/]> [p.name/]; [else] private [p.type.name/] [p.name/]; [/if] [/for] (c) schmiedecke 14 SE3 15

16 Navigieren mithilfe des EMF-Genmodels der UML (c) schmiedecke 14 SE3 16

17 ... erreichbar über die Acceleo-Vorhersage (c) schmiedecke 14 SE3 17

18 Beispiel 5 [template public packagepath(cl : Classifier)] [cl.getnearestpackage().normalizename()/] [/template] (c) schmiedecke 14 SE3 18

19 Acceleo- Operationen wiki.eclipse/ Acceleo/ Acceleo_Operations _Reference (c) schmiedecke 14 SE3 19

20 Parametrisierte Operationen (Acceleo und Genmodel) Die meisten mengenliefernden Acceleo-Operationen können durch einen Parameter eingeschränkt werden z.b.: (c) schmiedecke 14 SE3 20

21 Beispiel 6 Parametrisierte Operationen [template public genpackagepath(anelement : Element)] [if (anelement.ancestors(component)->size() > 0)] [anelement.ancestors(component) ->first().gencomponentpath()/] [else][anelement.reqgetdefaultprojectname()/] [/if] /[anelement.reqgetsourcefolderpath()/] /[anelement.genpackagedeclaration().substituteall('.', '/').concat('/')/] [/template] (c) schmiedecke 14 SE3 21

22 Templates können eingeschränkt und mit post nachbearbeitet werden "? (Bedingung)" im Template-Tag schränkt die Gültigkeit ein "post" ermöglicht abschließende Bearbeitung des Outputs (c) schmiedecke 14 SE3 22

23 Beispiel 7 Template-Einschränkung [template private getterandsetter(aproperty : Property)? (aproperty.upper = 1)] public [if(aproperty.isstatic)] static [/if] [aproperty.reqtypename()/] get[aproperty.genname().toupperfirst()/]() { return [if(not aproperty.isstatic)]this.[/if] [aproperty.genname()/]; }... (c) schmiedecke 14 SE3 23

24 Beispiel 8 Template-Nachbearbeitung [template private normalizename(anelement : NamedElement) post(trim())] [if ((anelement.name = 'package') or (anelement.name = 'interface') or (anelement.name = 'class'))] [anelement.name.concat('_')/] [else] [anelement.name/] [/if] [/template] (c) schmiedecke 14 SE3 24

25 Operationsanwendung Operationen (Acceleo, EMF, OCL) werden angewendet Mit "." auf einfache Werte [anelement.genpackagedeclaration().substituteall('.', '/').concat('/')/] Mit "->" auf Mengen und Folgen [if (anelement.ancestors(component)->size() > 0)] (c) schmiedecke 14 SE3 25

26 Let-Blöcke Mit dem let-tag können Variablen mit der Gültigkeit des Let-Blocks definiert werden Der Let-Block wird nur dann ausgeführt, wenn die Variablen-Zuweisung typkompatibel ist (also "funktioniert") [let x : Type = myexpression] x.dosomething() [/let] Ist gleichbedeutend mit [if (myexpression.ocliskindof(type))] [myexpression.oclastype(type).dosomething()/] [/if] (c) schmiedecke 14 SE3 26

27 Beispiel 9 Let-Block Wird nur ausgeführt, falls aclass einen Wert hat [template private genclassifierbody(aclassifier : Classifier) overrides genclassifierbody] [let aclass : Class = aclassifier.oclastype(class)] [aclass.declaration()/] { [aclass.attributes()/] [aclass.constructor()/] [aclass.operations()/] [for (aproperty : Property aclass.ownedattribute ->union(aclass.reqoutgoingnavigableownedend()))] [aproperty.accessors()/] [/for] [/let] [/template] (c) schmiedecke 14 SE3 27

28 Mengenkonstruktion Die Navigation durch Metamodell liefert immer wieder Mengen Viele Acceleo- und OCL-Operationen dienen der Bearbeitung von Mengen Filtern Vereinigen Zu Sequenzen machen oder wieder zu Mengen Unterstrukturen auflösen (flatten) Vieles lässt sich mit Mengenoperationen eleganter ausdrücken als mit Schleifen ÜBEN (c) schmiedecke 14 SE3 28

29 Beispiele 10 - Mengenoperationen [template public genpackagedeclaration(anelement : Element)] [anelement.packagepath().normalizename()->reverse()->sep('.')/] [/template] [for (aparameter : Parameter ownedparameter ->select(param : Parameter param.direction = ParameterDirectionKind::return) ->first())]... (c) schmiedecke 14 SE3 29

30 OCL- Operationen wiki.eclipse.org/acceleo/ OCL_Operations _Reference Ähnlich wie Acceleo-Ops, andere Typen (c) schmiedecke 14 SE3 30

31 Queries Queries sind Expressions, d.h. Sie liefern ein Ergebnis Zweck: Kapselung / Wiederverwendung komplexer Abfragen ++Ergebnis wird gecached (Effizienzgewinn) Typischerweise, aber nicht zwingend, OCL (c) schmiedecke 14 SE3 31

32 Beispiele 11 [query public getjavafilename (name : String) : String = name.concat('.java') /] [query private packagepath(anelement : Element) : Sequence(Package) = Sequence{anElement.getNearestPackage()} ->union(anelement.getnearestpackage().ancestors()->filter(package)) ->select(pack : Package pack.oclistypeof(package)) /] [query private alldocumentation(anelement : Element) : Sequence(String) = anelement.eannotations.details->select(entry entry.key = 'documentation') ->collect(entry entry.value) /] (c) schmiedecke 14 SE3 32

33 Queries als Java Wrapper Services EMF liefert das Modell als Java-Objektbaum und ein Traversierungs-API (GenModel) Alle Abfragen lassen sich auch in Java formulieren Dort, wo das leichter ist, kann Java-Code geschrieben und innerhalb einer Query mit "invoke" gerufen werden (s. Getting-Started-Tutorial) (c) schmiedecke 14 SE3 33

34 Konstanten Konstanten können als Property-Datei hinterlegt werden Syntax: Schlüssel = Text (c) schmiedecke 14 SE3 34

35 ACCELEO BEST PRACTICES (c) schmiedecke 14 SE3 35

36 Quellen (c) schmiedecke 14 SE3 36

37 Best practices: Naming Conventions A. Naming conventions Project (eclipse plugin): <domain><project name (optional)><kind of input (optional)><input metamodel name>gen<output language name> Example: com.mydomain.myproject.pim.uml.gen.java Modules, variables camel case names, avoid acceleo or ocl keywords: Acceleo keywords: module, import, extends, template, query, public, private, protected, guard, init,overrides, each, before, after, for, if, elseif, else, let, elselet, trace, macro,file, mode, text_explicit, code_explicit, super, stdout OCL keywords: and, body, context, def, derive, else, end, if, endpackage, false, if, implies, in, init, inv, invalid, let, not, null, (c) schmiedecke or, package, 14 post, pre, self, static, SE3 then, true, xor 37

38 BP: Package Structure Root package should share the same name of the project. Example: com.mydomain.myproject.pim.uml.gen.java Subpackages main all modules with main templates and their matching launcher class files all modules that will generate a file common all utility modules request / query all modules that contains utility requests (queries) on the input model services all modules wrapping Java classes properties (c) all schmiedecke properties 14 files SE3 38

39 BP: Package Structure (c) schmiedecke 14 SE3 39

40 BP: Package Export B. 3. Exporting packages The main package, the properties package and the service package need to be exported. Java services will not work when the generator is deployed if the package containing those package is not exported in the MANIFEST.MF (runtime tab). It is recommended to export all other packages but to keep them "hidden from all plugins". (c) schmiedecke 14 SE3 40

41 Der Rest ist ÜBEN und ABGUCKEN...