Programmation par aspects AspectJ

Programmation par aspects AspectJ Daniel Hagimont IRIT/ENSEEIHT 2 rue Charles Camichel - BP 7122 31071 TOULOUSE CEDEX 7 Daniel.Hagimont@enseeiht.fr http://hagimont.perso.enseeiht.fr Remerciements Sara Bouchenak 1

Bonne modularité Parsing XML Parsing XML dans org.apache.tomcat lignes rouges montrent le code concerné tout est regroupé dans un seul module (classe) 2

Bonne modularité Reconnaissance de pattern d URL Reconnaissance de pattern d URL dans org.apache.tomcat lignes rouges montrent le code concerné tout est regroupé dans deux modules (héritage) 3

Problèmes Traçage non modulaire Traçage dans org.apache.tomcat lignes rouges montrent le code concerné pas regroupé dans un seul module pas dans un petit nombre de modules 4

Inconvénients d un code non modulaire Code redondant Même fragment de code dans plusieurs classes Code non clair Structure non explicite Image globale non claire Code difficile à modifier/maintenir Trouver toutes les classes concernées Etre sûr d effectuer les modifications de façon cohérente 5

Principe de l AOP Séparer les concepts (traitements) entrelacés Minimiser les dépendances entre eux Chaque traitement doit avoir un objectif clair une structure bien définie, modulaire Aspects Aspect-Oriented Programming Traitements modulaires qui peuvent par la suite être entrelacés 6

Plan 1. Introduction à l AOP 2. Introduction à AspectJ 3. Syntaxe AspectJ 4. Développement logiciel avec AspectJ 7

Définition de l AOP AOP = Aspect-Oriented Programming (programmation orientée aspect ou programmation par aspects) "La programmation par aspects est une technique permettant de factoriser certains traitements dont la réalisation est a priori dispersée à travers un système, fût-il orienté-objet." 8

Aspects : fonctionnels et orthogonaux Un système logiciel est constitué de : Aspects fonctionnels (core concerns). Modules logiciels qui mettent en œuvre la logique applicative du système logiciel. Aspects orthogonaux (crosscutting concerns). Modules qui mettent en œuvre des fonctionnalités système utilisées par plusieurs autres modules. 9

Méthodologie de l AOP : Composition des aspects Spécification des règles de composition des aspects Règles utilisées pour la construction du système final Processus de composition : intégration ou weaving règle de composition aspect fonctionnel Exemple : avant chaque opération sur le système bancaire, le client doit être authentifié. aspect orthogonal 10

Réalisation de l AOP AOP : une méthodologie de programmation Réalisation de la méthodologie AOP : Langage de mise en œuvre des aspects (fonctionnels et orthogonaux) : C, C++, Java, etc. Langage de spécification des règles de composition des aspects : AspectC, AspectJ, etc. Outil d intégration des aspects (weaving) : aspect weaver, compilateur AOP (AspectC, AspectJ, etc.) 11

Réalisation de l AOP dans Java aspects fonctionnels aspects aspects fonctionnels fonctionnels Java règles de composition AspectJ aspects fonctionnels aspects aspects fonctionnels orthogonaux Java Compilateur AOP compilo AspectJ Java aspects fonctionnels et orthogonaux composés 12

Plan 1. Introduction à l AOP 2. Introduction à AspectJ Composition dans AspectJ join point, pointcut, advice, introduction, declaration, aspect Méthodologie de programmation Exemples 3. Syntaxe AspectJ 4. Développement logiciel avec AspectJ 13

Composition dans AspectJ Composition statique Modification de la structure statique du système : classes et interfaces Ajout d attributs et méthodes Déclaration de messages d avertissement (warnings) ou d erreurs affichés lors de la compilation Composition dynamique Ajout d un nouveau comportement à l exécution "normale" du programme Etendre ou remplacer une opération Action effectuée avant/après l exécution de certaines méthodes ou de certains traitants d exceptions dans des classes 14

Eléments de composition dans AspectJ AspectJ une extension du langage Java pour définir les règles de composition statique et dynamique Eléments de composition dans AspectJ Join point Pointcut Advice Introduction Declaration (at compile-time) Aspect 15

Join point Définition Un point identifié dans l exécution d un programme Un appel de méthode ou l accès à l attribut d un objet Exemple public class Account { float balance; void credit(float amount) { this.balance += amount; Join points de la classe Account incluent l exécution de la méthode credit l accès à l attribut balance 16

Pointcut Définition Sélection d un join point Récupération du contexte au niveau de ce join point Exemple execution (void Account.credit(float)) Pointcut sélectionne le join point correspondant à l appel de la méthode credit de la classe Account récupère le contexte de cet appel : l objet sur lequel la méthode est appelée, les paramètres de la méthode 17

Advice Définition Code exécuté à un pointcut Exécution avant, après ou en remplacement d un pointcut Exemple before() : execution (void Account.credit(float)) { System.out.println("About to perform credit operation"); Advice affichage d un message avant l exécution de la méthode credit de la classe Account 18

Introduction Définition Introduction d une modification statique à une classe ou interface Ajout d une méthode ou d un attribut à une classe, extension de la hiérarchie des classes et interfaces Exemple declare parents : Account implements BankingEntity; private float Account._minimalBalance; Introduction extension de la hiérarchie classe Account implémente l interface BankingAccount ajout du nouvel attribut _minimalbalance à la classe Account 19

Compile-time declaration Définition Instruction de composition statique Ajout de messages d avertissement ou d erreurs affichés lors de la compilation Exemple declare warning : call (void Persistence.save(Object)) : "Deprecated method Persistence.save(), Consider using Persistence.saveOptimized()"; Declaration déclaration d un message d avertissement affichage si appel de la méthode save de la classe Persistence 20

Aspect Définition Module de code qui contient la spécification des règles de composition statiques et dynamiques utilisées Introductions + declarations + pointcuts + advices = aspect Aspect dans AspectJ équivalent à une classe dans Java Exemple de fichier ExampleAspect.java public aspect ExampleAspect { declare parents : Account implements BankingEntity; before() : execution (void Account.credit(float)) { System.out.println("About to perform credit operation"); declare warning : call (void Persistence.save(Object)) : "Deprecated method Persistence.save(), Consider using Persistence.saveOptimized()"; 21

Méthodologie de programmation Conception 1. Identifier les join points où il faut étendre/modifier un comportement 2. Concevoir le nouveau comportement à introduire à ces points-là Mise en œuvre 1. Ecriture d un module aspect qui contient la mise en œuvre de cette conception 2. Ecriture, dans l aspect, des pointcuts qui sélectionnent les join points désirés 3. Ecriture d un advice associé à chaque pointcut pour définir le nouveau comportement à introduire à chacun de ces points 4. Ajout de règles de composition statique (introductions, declarations) si nécessaire 22

Exemple Hello (1/4) Application public class Communicator { public static void print(string message) { System.out.println(message); public static void print(string person, String message) { System.out.println(person + ", " + message); public class Test { public static void main(string[] args) { Communicator.print("Want to learn AspectJ?"); Communicator.print("Tom", "how are you?"); 23

Exemple Hello (2/4) Compilation Java javac Communicator.java Test.java Exécution java Test Want to learn AspectJ? Tom, how are you? 24

Exemple Hello (3/4) Aspect public aspect HelloAspect { Déclaration d aspect pointcut printcall() : call (void Communicator.print(..)); Déclaration de pointcut before() : printcall() { System.out.print("Hello! "); Déclaration d advice 25

Exemple Hello (4/4) Compilation AspectJ ajc Communicator.java Test.java HelloAspect.java Exécution java Test Hello! Want to learn AspectJ? Hello! Tom, how are you? 26

Exemple de traçage (1/4) Application originale package banking; public class Account { float balance; void credit(float amount) { this.balance += amount; void debit(float amount) { this.balance -= amount; 27

Exemple de traçage (2/4) Application modifiée "à la main" pour traçage package banking; public class Account { float balance; void credit(float amount) { Logger.entering("banking.Account", "credit(float)"); this.balance += amount; Logger.exiting("banking.Account", "credit(float)"); void debit(float amount) { Logger.entering("banking.Account", "debit(float)"); this.balance -= amount; Logger.exiting("banking.Account", "debit(float)"); 28

Exemple de traçage (3/4) Autre solution : Aspect de traçage automatique public aspect AutoLogAspect { pointcut methodexecution() : execution (* banking.account.*(..)); before() : methodexecution() { Signature sig = thisjoinpointstaticpart.getsignature(); String classname = sig.getdeclaringtype().getname(); String methodname = sig.getname(); Logger.entering(className, methodname); after() : methodexecution() { Signature sig = thisjoinpointstaticpart.getsignature(); String classname = sig.getdeclaringtype().getname(); String methodname = sig.getname(); Logger.exiting(className, methodname); 29

Exemple de traçage (4/4) Account application originale Java Java AutoLogAspect Logger aspect de traçage auto AspectJ module de traçage Compilateur AOP compilo AspectJ application avec traçage Account + Logger Java 30

Plan 1. Introduction à l AOP 2. Introduction à AspectJ 3. Syntaxe AspectJ Pointcut Call vs. Execution Pointcuts de flot de contrôle, de structure lexicale Advice Passage de paramètres entre pointcut et advice 4. Développement logiciel avec AspectJ 5. Synthèse et Références 31

Pointcut Syntaxe d un pointcut [mode_accès] pointcut nom_pointcut([args]) : definition_pointcut Exemple public pointcut printcall() : call ( void Communicator.print(..) ) mot-clé mode d accès type de pointcut nom de pointcut Signature d un pointcut signature Signature de type Signature de méthodes/constructeurs Signature d attribut 32

Pointcut : Signature de type Signature Account *Account java.*.date java..date java.util.list+ Types associés Type (classe / interface) de nom Account Type dont le nom se termine avec Account, tel que SavingsAccount, CheckingAccount Type Date dans tout sous-package direct du package java, tel que java.util.date, java.sql.date Tout type Date dans le package java ou un sous-package direct ou indirect du package java Tout type héritant de l interface java.util.list (l implémentant) 33

Pointcut : Signature de méthode Signature public void Collection.clear() public void Account.set*(*) * Account.*() public void Account.*(..) * *.*(..) throws RemoteException Méthodes associées La méthode publique clear() de la classe Collection qui ne prend aucun paramètre et retourne void Toute méthode publique de la classe Account, dont le nom commence par set, qui prend un paramètre unique de type quelconque et qui retourne void Toute méthode de la classe Account, ne prenant pas de paramètre, quels que soient son type de retour et mode d accès Toute méthode publique de la classe Account, qui prend des paramètres de nombre et types quelconques et qui retourne void Toute méthode qui peut lever une exception de type RemoteException 34

Pointcut : Signature de constructeur Signature public Account.new() public Account.new(int) Constructeurs associés Le constructeur public de la classe Account, ne prenant aucun paramètre Le constructeur public de la classe Account, qui prend un paramètre unique de type int public Account.new(..) public Account+.new(..) Tout constructeur public de la classe Account, qui prend un nombre et un type quelconques de paramètres Tout constructeur public de la classe Account ou d une de ses sous-classes 35

Pointcut : Signature d attribut Signature private float Account.balance * Account.* Attributs associés L attribut privé balance de la classe Account Tout attribut de la classe Account, quels que soient son nom, son type et son mode d accès public static * banking..*.* * *.* Tout attribut public et statique du package banking ou d un de ses sous-packages directs ou indirects Tout attribut de n importe quelle classe 36

Opérateurs de pointcuts Opérateur unaire :! public!final *.*!Vector Tout attribut public et non final de n importe quelle classe Tout type autre que Vector Opérateurs binaire : && (et) (ou) Vector Hashtable Type Vector ou Hashtable java.util.randomac cess+ && java.util.list+ Tout type implémentant les deux interfaces, tel que java.util.arraylist 37

Type de pointcut Exemple public pointcut printcall() : call ( void Communicator.print(..) ) mot-clé mode d accès Type d un pointcut type de pointcut nom de pointcut Appel de méthode, constructeur Exécution de méthode, constructeur signature Accès à un attribut en lecture, écriture, etc. 38

Types de pointcuts Type de pointcut Appel de méthode Exécution de méthode Appel de constructeur Exécution de constructeur Initialisation de classe Accès à un attribut en lecture Accès à un attribut en écriture Traitant d exception Syntaxe call(signature_méthode) execution(signature_méthode) call(signature_constructeur) execution(signature_constructeur) staticinitialization(signature_type) get(signature_attribut) set(signature_attribut) handler(signature_type) 39

Call vs. Execution (1/5) Exemple public class Account { float balance; void credit(float amount) { this.balance += amount; public class Test { public static void main(string[] args) { Account account = new Account(); accout.credit(100); execution de la méthode credit call de la méthode credit 40

Call vs. Execution (2/5) Aspect utilisant le call public aspect AutoLogAspect_Call { pointcut creditmethodcall() : call (* Account.credit(..)); before() : creditmethodcall() { Logger.entering(className, methodname); 41

Call vs. Execution (3/5) Application de l AutoLogAspect_Call public class Account { float balance; void credit(float amount) { this.balance += amount; public class Test { public static void main(string[] args) { Account account = new Account(); Logger.entering("Account", "credit(float)"); account.credit(100); 42

Call vs. Execution (4/5) Aspect utilisant l execution public aspect AutoLogAspect_Execution { pointcut creditmethodexecution() : execution (* Account.credit(..)); before() : creditmethodexecution() { Logger.entering(className, methodname); 43

Call vs. Execution (5/5) Application de l AutoLogAspect_Execution public class Account { float balance; void credit(float amount) { Logger.entering("Account", "credit(float)"); this.balance += amount; public class Test { public static void main(string[] args) { Account account = new Account(); accout.credit(100); 44

Pointcuts relatifs au flot de contrôle Pointcut cflow(call (* Account.credit(..))) cflowbelow(call (* Account.credit(..))) Description Tout join point dans le flot de contrôle d une méthode credit de la classe Account, y compris l appel à la méthode credit elle-même Tout join point dans le flot de contrôle d une méthode credit de la classe Account, sauf l appel à la méthode credit elle-même cflow( creditmethodcall()) cflowbelow(execution (* Account.new(..))) Tout join point dans le flot de contrôle du pointcut creditmethodcall Tout join point dans le flot de contrôle d un constructeur de la classe Account, sauf l exécution du constructeur lui-même 45

cflow / cflowbelow Exemple public class Test { public static void main(string[] args) { Account account = new Account(); account.credit(100); 46

cflow / cflowbelow public class Account { int id; // account id Database database; // associated database float getbalance() { return database.query("select balance FROM accounts WHERE id=" + id); void setbalance(float b) { database.update("update accounts SET balance="+b+" WHERE id=" + id); void credit(float amount) { setbalance(getbalance() + amount); 47

cflow / cflowbelow public class Database { float query(string sqlquery) { lecture de la base de données void update(string sqlquery) { écriture dans la base de données 48

cflow / cflowbelow Flot de contrôle à l appel de la méthode credit Test.main new Account Account.credit Account.getBalance Database.query Account.setBalance Database.update 49

cflow / cflowbelow Aspect utilisant le cflow public aspect AutoLogAspect_CallF { pointcut creditmethodcallf() : cflow( call (* Account.credit(..)) ); before() : creditmethodcallf() { System.out.println("Hello!"); 50

cflow / cflowbelow cflow( call(* Account.credit(..)) ) new Account Test.main Account.credit Account.getBalance Database.query Account.setBalance Database.update 51

cflow / cflowbelow Exemple public class Test { public static void main(string[] args) { Account account = new Account(); System.out.println("Hello!"); account.credit(100); 52

cflow / cflowbelow public class Account { int id; // account id Database database; // associated database float getbalance() { System.out.println("Hello!"); return database.query("select balance FROM accounts WHERE id=" + id); void setbalance(float b) { System.out.println("Hello!"); database.update("update accounts SET balance="+b+" WHERE id=" + id); void credit(float amount) { System.out.println("Hello!"); setbalance(getbalance() + amount); plein plein!! (example code) 53

cflow / cflowbelow public class Database { float query(string sqlquery) { System.out.println("Hello!"); lecture de la base de données void update(string sqlquery) { System.out.println("Hello!"); écriture dans la base de données 54

cflow / cflowbelow Aspect utilisant le cflowbelow public aspect AutoLogAspect_CallFB { pointcut creditmethodcallfb() : cflowbelow( call (* Account.credit(..)) ); before() : creditmethodcallfb() { System.out.println("Hello!"); 55

cflow / cflowbelow cflowbelow( call(* Account.credit(..)) ) new Account Test.main Account.credit Account.getBalance Database.query Account.setBalance Database.update 56

cflow / cflowbelow Exemple public class Test { public static void main(string[] args) { Account account = new Account(); System.out.println("Hello!"); accout.credit(100); 57

Pointcuts relatifs à la structure lexicale Pointcut within(account) within(account+) Description Tout join point dans la classe Account (compris dans la portée lexicale de la classe Account) Tout join point dans la classe Account et ses sous-classes (compris dans la portée lexicale de ces classes) withincode(* Account.credit(..)) Tout join point dans toute méthode credit de classe Account (compris dans la portée lexicale de cette méthode) 58

Exemple avec within Aspect utilisant l execution public aspect AutoLogAspect_Execution { pointcut methodexecution() : execution (* *.Account.*(..)) && within(banking..*); before() : methodexecution() { Logger.entering(className, methodname); 59

Pointcuts relatifs à l objet d exécution Pointcut this(account) Description Tout join point où le this est une instance de la classe Account ou d une de ses sous-classes (appel de méthode ou accès à l attribut d un objet Account). Pointcut utilisé en combinaison avec execution target(account) Tout join point où l objet sur lequel une méthode est appelée est une instance de la classe Account ou d une de ses sous-classes. Pointcut utilisé en combinaison avec call this(type) ou this(objectidentifier) target(type) ou target(objectidentifier) Récupération dans une variable 60

Pointcuts arguments Pointcut args(string,..,int) Description Tous les join points de toutes les méthodes où le premier paramètre est de type String et le dernier de type int args(type ou ObjectIdentifier,..) 61

Advice Advice : Traitement à effectuer lors d un pointcut Syntaxe d un advice specification_advice([args]) : nom_pointcut([args) { corps de l advice Exemple before () : printcall () { corps de l advice nom de pointcut specification d advice 62

Advice : Syntaxe Syntaxe d un advice specification_advice([args]) : definition_pointcut { corps de l advice Exemple before () : call ( void Communicator.print(..) ) { corps de l advice type de pointcut specification d advice signature 63

Types d advices Advice before s exécute avant le join point Advice after s exécute après le join point Advice around englobe l exécution du join point 64

Advice before Exemple before () : call ( * Account.*(..)) { authentifier l utilisateur Cas particulier Si l advice before lève une exception, la méthode concernée n est alors pas exécutée Exemples d utilisation Traçage, authentification, etc. 65

Advice after Toute terminaison (normale ou exception) after () : call ( * Account.*(..)) { tracer toute terminaison Terminaison normale after returning () : call ( * Account.*(..)) { tracer la terminaison normale Terminaison en cas de levée d exception after throwing () : call ( * Account.*(..)) { tracer la levée d exception 66

Advice around Remplacer un traitement around () : call ( void Account.credit(float)) { nouvelle mise en œuvre de la méthode Entourer un traitement around (Account account, float amount) : call ( * Account.credit(float)) && target(account) && args(amount) { tracer le début de la méthode proceed(account, amount); tracer la fin de la méthode 67

Passage de contexte entre le join point et l advice (1/3) Passage de paramètres before (Account account, float amount ) : call ( * Account.credit(float)) && target( account ) && args( amount ) { System.out.println("Crediting from " + account + " value " + amount ); 68

Passage de contexte entre le join point et l advice (2/3) Récupération du résultat after returning (Object object ) : call ( Object Account.*(..)) { System.out.println("Result " + object ); 69

Passage de contexte entre le join point et l advice (3/3) Récupération de l exception after throwing (RemoteException except ) : call ( * Account.*(..) throws RemoteException ) { System.out.println("Exception " + except ); 70

Instanciation des aspects Pointcut aspect Id issingleton {... aspect Id perthis(pointcut) {... aspect Id pertarget(pointcut) {... aspect Id percflow(pointcut) {... aspect Id percflowbelow(pointcut) {... Description Un seul objet aspect, crée au chargement de la classe. Accessible par aspectof() Un objet aspect créé pour chaque objet qui est l'objet courant (this) d'un joint point capturé par Pointcut Idem pour target Un objet aspect créé pour chaque flot de contrôle des joint points capturés par Pointcut idem pour cflowbelow 71

Instanciation des aspects public class Communicator { public void print(string message) { System.out.println(message); public void print(string person, String message) { System.out.println(person + ", " + message); public class Test { public static void main(string[] args) { Communicator c1 = new Communicator(); Communicator c2 = new Communicator(); c1.print("want to learn AspectJ?"); c2.print("tom","how are you?"); 72

Instanciation des aspects singleton / perthis public aspect PerAspect { //public aspect PerAspect perthis(printcall()) { int count=0; private pointcut printcall() : execution(void Communicator.print(..)); before() : printcall() { count++; System.out.print("Hello ["+count+"]!"); 73

Instanciation des aspects public aspect PerAspect Hello [1]! Want to learn AspectJ? Hello [2]! Tom, how are you? public aspect PerAspect perthis(printcall()) Hello [1]! Want to learn AspectJ? Hello [1]! Tom, how are you? 74

Instanciation des aspects public class Caller { Communicator c; public Caller(Communicator c) { this.c = c; public void call(string msg) { c.print(msg); public class Test { public static void main(string[] args) { Communicator c = new Communicator(); Caller c1 = new Caller(c); Caller c2 = new Caller(c); c1.call("want to learn AspectJ?"); c2.call("how are you?"); c1 c2 c 75

Instanciation des aspects pertarget / perthis //public aspect PerAspect2 pertarget(printcall()) { public aspect PerAspect2 perthis(printcall()) { int count=0; private pointcut printcall() : call(void perhello2.communicator.print(..)); before() : printcall() { count++; System.out.print("Hello ["+count+"]!"); 76

Instanciation des aspects public aspect PerAspect2 pertarget(printcall()) Hello [1]! Want to learn AspectJ? Hello [2]! how are you? public aspect PerAspect2 perthis(printcall()) Hello [1]! Want to learn AspectJ? Hello [1]! how are you? 77

Plan 1. Introduction à l AOP 2. Introduction à AspectJ 3. Syntaxe AspectJ 4. Développement logiciel avec AspectJ 78

Compilateur AspectJ Commande ajc fichiers sources Java et aspects (.java) fichiers archives Java et aspects (.jar) Compilateur AspectJ (ajc) système composé (.class ou.jar) 79

Browser AspectJ (ajbrowser) 80

Synthèse : AOP en 2 phrases Intérêt de l AOP Extension d un système existant pour prise en compte de nouvelles propriétés (aspects) orthogonaux Conception modulaire d un système impliquant plusieurs aspect (fonctionnels et orthogonaux) 81

Références Web Outils, articles et autres ressources relatives à la programmation par aspect : http://aosd.net AspectJ de Xerox, un logiciel libre de l AOP pour Java : http://aspectj.org Techniques AOP utilisées dans d autres langages que Java. Voir AspectC++, une extension de C++ pour l AOP : http://www.aspectc.org/ Techniques AOP utilisées dans les langages procéduraux. Voir AspectC, une extension de C pour l AOP : http://www.cs.ubc.ca/labs/spl/projects/aspectc.html 82

Références bibliographiques Aspect-Oriented Programming, Kiczales et. al., ECOOP 1997 An Overview of AspectJ, Kiczales et. al., ECOOP 2001 Getting Started with AspectJ, Kiczales et. al., CACM 44(10), Oct. 2001 Aspect-Oriented Programming with AspectJ, Ivan Kiselev, SAMS 2002 Mastering AspectJ: Aspect-Oriented Programming in Java, Joseph D. Gradecki, Nicholas Lesiecki, John Wiley & Sons 2003 AspectJ in Action, R. Laddad, Manning, 2003. 83