Pattern matching (C# 7)

Basique

Cet article fait partie d’une série d’articles sur les apports fonctionnels de C# 7 (i.e. C# 7.0/7.1/7.2/7.3).

A partir de C# 7.0, quelques notions de programmation fonctionnelle sont introduites. Dans la documentation, même si l’expression “pattern matching” (i.e. “filtre avec motif”) est utilisée pour qualifier ces notions, il ne s’agit que de quelques améliorations pour simplifier certains éléments de syntaxe. Il n’y a pas, à proprement parlé, d’introduction de nouveaux concepts, il s’agit juste de raccourcis pour simplifier la syntaxe.

Ces notions de pattern matching peuvent être mises en place avec les mot-clés is et switch...case, elles permettent d’implémenter un filtre dans lequel on pourra indiquer des conditions. Suivant si une condition est vraie, une action spécifique pourra être exécutée.

Pour la suite, on considère les classes suivantes:

abstract class Vehicle  
{  
    public abstract int GetWheelCount();  
}  


class MotoBike : Vehicle  
{  
    public int Power => 100;  
    
    public override int GetWheelCount()  
    {  
        return 2;  
    }
}  

class Car : Vehicle  
{  
    public int PassengerCount => 4;  
    
    public override int GetWheelCount()  
    {  
        return 4;  
    }  
}  

Avec is

C# 7.0

L’opérateur is permet de tester une expression pour savoir si elle satisfait une condition particulière. Chaque type de condition correspond à un motif (i.e. pattern). En C# 7.0, les motifs possibles sont:

  • Null pattern: test par rapport à une valeur nulle, par exemple:
    Vehicle vehicle = new Car();  
    if (vehicle is null)  
        Console.WriteLine($"{nameof(vehicle)} is null.");  
    else  
        Console.WriteLine($"{nameof(vehicle)} is not null.");  
    

    Cette fonctionnalité est disponible à partir de C# 7.0.

  • Constant pattern: test en comparant par rapport à une constante, par exemple:
    object carAsObj = new Car();  
    if (carAsObj is "45")  
        Console.WriteLine($"{nameof(carAsObj)} is 45.");  
    else  
        Console.WriteLine($"{nameof(carAsObj)} is not 45.");  
    

    Cette fonctionnalité est disponible à partir de C# 7.0.

  • Type pattern: l’expression est testée suivant un type particulier (possible avant C# 7.0):
    Vehicle vehicle = new Car();  
    if (vehicle is Car)  
        Console.WriteLine($"{nameof(vehicle)} is a car.");  
    else if (vehicle is Motobike)  
        Console.WriteLine($"{nameof(vehicle)} is a motobike.");  
    else  
        Console.WriteLine($"{nameof(vehicle)} has not been identified.");  
    

Dans le cas où on utilise is pour tester le type d’une expression, il est possible de combiner is et as en une seule ligne pour simplifier la syntaxe. Pour remplacer les 2 lignes:

<expression à tester> is <type voulu>  
var <variable typée> = <variable> as <type voulu>  

On peut simplifier la syntaxe en écrivant:

<expression à tester> is <type voulu> <nom variable>  

Par exemple, si on considère le code suivant:

Vehicle vehicle = new Car();  
if (vehicle is Car)  
{  
    var car = vehicle as Car;
    Console.WriteLine($"{nameof(vehicle)} is a car with {car.PassangerCount} passagers.");  
}  
else if (vehicle is Motobike)  
{  
    var motobike = vehicle as Motobike;
    Console.WriteLine($"{nameof(vehicle)} is a motobike of {motobike.Power} horsepower.");  
}  
else  
    Console.WriteLine($"{nameof(vehicle)} has not been identified.");  

La syntaxe peut être simplifier:

if (vehicle is Car car)  
    Console.WriteLine($"{nameof(vehicle)} is a car with {car.PassangerCount} passagers.");  
else if (vehicle is Motobike motobike)  
    Console.WriteLine($"{nameof(vehicle)} is a motobike of {motobike.Power} horsepower.");  
else  
    Console.WriteLine($"{nameof(vehicle)} has not been identified.");  

Avec switch…case

C# 7.0

L’intérêt du pattern matching est de pouvoir simplifier la syntaxe en utilisant les apports de is dans une clause switch...case. Le type de condition applicable à is sont les mêmes pour switch...case. En une seule ligne, on peut tester les motifs suivant:

  • Si une expression est nulle (i.e. null pattern),
  • Si une expression est constante (i.e. constant pattern) et
  • Si une expression correspond à un type particulier (i.e. type pattern).

Si on prend l’exemple précédent, le code équivalent en utilisant switch...case pourrait être:

Vehicle vehicle = new Car();  
switch (vehicle)  
{  
    case Car car: // Type pattern
        Console.WriteLine($"{nameof(vehicle)} is a car with {car.PassengerCount} passagers.");  
        break;  
    case Motobike motobike:  // Type pattern
        Console.WriteLine($"{nameof(vehicle)} is a motobike of {motobike.Power} horsepower.");  
        break;  
    default:  
        Console.WriteLine($"{nameof(vehicle)} has not been identified.");  
        break;  
}  

D’autres conditions peuvent être utilisées notamment en testant la nullité ou l’égalité à une constante:

object carAsObj = new Car();  
switch (casAsObj)  
{  
    case null:  // Null pattern
        Console.WriteLine("Is null");  
        break;  
    case "45":  // Constant pattern 
        Console.WriteLine("Is a constant, not a vehicle.");  
        break;  
    case Car car:  // Type pattern
        Console.WriteLine($"{nameof(carAsObj)} is a car with {car.PassengerCount} passagers.");  
        break;  
    case Motobike motobike:  // Type pattern
        Console.WriteLine($"{nameof(carAsObj)} is a motobike of {motobike.Power} horsepower.");  
        break;  
    default:  
        Console.WriteLine($"{nameof(carAsObj)} has not been identified.");  
        break;  
}  

when avec switch…case

C# 7.0

Au-delà des tests sur la nullité, un type ou l’égalité par rapport à une constante, il est possible de tester d’autres conditions en utilisant le mot-clé when.

Par exemple, si on souhaite ajouter des conditions quand un objet est de type Car:

Vehicle vehicle = new Car();  
switch (vehicle)  
{  
    case Car car when car.PassengerCount < 1:  
        Console.WriteLine($"{nameof(vehicle)} is an empty car.");  
        break;  
    case Car car when car.PassengerCount > 3 && car.PassengerCount <= 5:  
        Console.WriteLine($"{nameof(vehicle)} is a fully loaded car.");  
        break;  
    case Car car when car.PassengerCount > 8:  
        Console.WriteLine($"{nameof(vehicle)} is a heavy loaded car.");  
        break;  
    default:  
        Console.WriteLine($"{nameof(vehicle)} has not been identified.");  
        break;  
}  

Dans le cas où l’ordre des conditions ne permet pas à certains cas d’être atteint, une erreur est émise à la compilation.

Par exemple:

Vehicle vehicle = new Car();  
switch (vehicle)  
{  
    case Car car: // Provoque une erreur de compilation  
        Console.WriteLine($"{nameof(vehicle)} is a car with {car.PassengerCount} passagers.");  
        break;  
    case Car car when car.PassengerCount < 1:  
        Console.WriteLine($"{nameof(vehicle)} is an empty car.");  
        break;  
    default:  
        Console.WriteLine($"{nameof(vehicle)} has not been identified.");  
        break;  
}  

Dans ce cas, la condition when car.PassengerCount < 1 n’est jamais atteinte car elle est occultée par la ligne case Car car.

Toutefois dans certains cas, du code peut ne jamais être atteint et aucune erreur de compilation ne sera générée, par exemple:

switch (vehicle)  
{  
    case Car car when car.PassengerCount > 1:  
        Console.WriteLine($"{nameof(vehicle)} with {car.PassengerCount} passenger(s).");  
        break;  
    case Car car when car.PassengerCount > 3: // ce code ne sera jamais atteinte  
        Console.WriteLine($"{nameof(vehicle)} is full.");  
        break;  
    default:  
        Console.WriteLine($"{nameof(vehicle)} has not been identified.");  
        break;  
}  

La condition when car.PassengerCount > 1 s’applique avant when car.PassengerCount > 3 donc cette partie du code ne sera jamais atteinte.

Utilisation de var avec is ou switch…case

C# 7.0

Le 4e motif de filtre utilisable avec C# 7.0 avec is et switch...case est var (i.e. var pattern). La syntaxe générale avec is est:

<expression> is var <nom de la variable> 

Cette syntaxe correspond, d’une part à une condition appliquée à <expression> et d’autre part, elle permet de créer une variable contenant le résultat d’une expression.

La condition est toujours vraie même si le résultat de l’expression testée est nulle. Le type de la variable correspond au type de l’expression et si l’expression est nulle alors la variable sera nulle.

L’intérêt de cette construction est de créer une variable temporaire qui pourra servir pour d’autres traitements, par exemple:

List<Vehicle> vehicles = new List<Vehicle>{ new Car() }; 
if (vehicles.FirstOrDefault(v => v.GetWheelCount() > 3) is var bigVehicle) 
{ 
    if (bigVehicle.GetWheelCount() == 4) 
        Console.WriteLine("The vehicle is a car"); 
    else if (bigVehicle.GetWheelCount() == 6) 
        Console.WriteLine("The vehicle is a little truck"); 
    else if (bigVehicle.GetWheelCount() > 6) 
        Console.WriteLine("The vehicle is a big truck"); 
} 

Dans cet exemple, la ligne vehicles.FirstOrDefault(...) is var bigVehicle permet de créer la variable bigVehicle qui pourra être utilisée dans la clause if.

De la même façon que pour les autres types de motifs, le motif var peut être utilisé avec switch...case, par exemple:

switch(vehicles.FirstOrDefault(v => v.GetWheelCount() > 3) 
{ 
    case null: 
        Console.WriteLine("No big vehicle round"); 
        break; 
    case var car when car.GetWheelCount() == 4: 
        Console.WriteLine("The vehicle is a little truck"); 
        break; 
    case var truck when truck.GetWheelCount() == 6: 
        Console.WriteLine("The vehicle is a little truck"); 
        break; 
    case var bigTruck when bigTruck.GetWheelCount() > 6: 
        Console.WriteLine("The vehicle is a big truck"); 
        break; 
} 

Objets de type valeur

Certaines implémentations peuvent dégrader les performances si on utilise le pattern matching avec des objets de type valeur. Dans le cas où le code est exécuté fréquemment, il convient d’éviter ces constructions.

Par exemple, comparer un objet de type valeur avec une constante avec l’opérateur is occasionne du boxing:

int number = 6; 
if (number is 42) // Boxing 
{ ... } 

Cette implémentation occasionne 2 cas de boxing: pour la constante et pour la variable number.

Il n’y a pas de boxing si on utilise une construction similaire avec switch...case:

int number = 6; 
switch(number) 
{ 
    case 42: // Pas de boxing 
    ... 
    break 
} 

En revanche si on utilise variable de type object, il peut y avoir de l’unboxing:

object number = 6; // Boxing 
switch(number) 
{ 
    case 42: // Unboxing 
    ... 
    break 
} 

Si on utilise une variable de type int sans passer par une variable de type object, il n’y a pas d’unboxing:

int number = 5; 
// ... 
switch (number) 
{ 
    case 42: 
        Console.WriteLine("OK"); 
        break; 
    case int positiveInt when positiveInt > 0: 
        Console.WriteLine("Positive number"); 
        break; 
    case int negativeInt when negativeInt < 0: 
        Console.WriteLine("Negative number"); 
        break; 
    case int nullInt when nullInt == 0: 
        Console.WriteLine("Number is null"); 
        break; 
} 

Support des génériques

C# 7.1

Le pattern matching supporte les génériques à partir de C# 7.1.

Par exemple, si on considère les classes suivantes:

abstract class Vehicle 
{ 
    public int PassengerCount  { get; set; } 
} 

class Car : Vehicle 
{ } 

class MotoBike : Vehicle 
{ } 

Des conditions du pattern matching peuvent s’appliquer sur le type générique, par exemple:

public void DisplayVehicleDetail<TVehicle>(TVehicle vehicle)  
where TVehicle: Vehicle 
{ 
    switch (vehicle) 
    { 
        case Car car: 
            Console.WriteLine($"Vehicle is a car with {car.PassengerCount} passengers."); 
            break; 
        case MotoBike moto: 
            Console.WriteLine($"Vehicle is a moto."); 
            break; 
        default: 
            Console.WriteLine($"Vehicle has not been identified."); 
            break;
    } 
} 

Point de vue d’architecture

Quand on utilise la programmation orientée objet comme on le fait en C#, une pratique courante est de tenter de généraliser des traitements pour en déduire une abstraction pour utiliser cette abstraction dans une classe parente. Les traitements plus spécifiques pourront être implémentés dans des classes enfants qui dérivent de la classe parente.

L’intérêt de cette abstraction est d’identifier les comportements similaires, d’en déduire une implémentation générale dans le but d’éviter des duplications des comportements et du code. Quand on instancie un objet enfant et qu’on exécute un traitement, l’implémentation de la classe va ainsi effectuer une partie de traitement en s’appuyant sur l’implémentation générique de la classe parente, et une autre partie sur l’implémentation spécifique à la classe enfant suivant les règles d’héritage et d’encapsulation. Du point de vue externe à la classe, on peut considérer:

  • Le type correspondant à la classe enfant et accéder aux fonctions spécifiques à cette classe enfant.
  • Le type de la classe parente et ainsi accéder seulement aux fonctions génériques non spécialisées.

Par exemple, si on considère les classes suivantes:

abstract class Vehicle 
{ 
    public void MoveForward() { … } 

    public void MoveReverse() { … } 

    public abstract void AddPassenger(); 
} 

class Car : Vehicle 
{ 
    public override void AddPassenger() { ... }  

    public void PutInTrunk() { ... }  
} 

class MotoBike : Vehicle 
{ 
    public override void AddPassenger() { ... }  

    public bool IsHelmetAvailable() { ... }  
} 

Dans cet exemple, le type Vehicle permet d’appeler de l’extérieur:

  • Des fonctions génériques comme MoveForward() ou MoveReverse().
  • Des fonctions dont l’implémentation est spécifique comme AddPassenger().

Vu de l’extérieur à l’objet, suivant le type instancié, on ne peut considérer que le type parent ou le type enfant. Il devient plus difficile de considérer les 2 types à la fois:

  • Effectuer un traitement sur le type de la classe parente et
  • Appliquer des comportements spécifiques suivant le type précis de l’objet.

Ainsi, dans le cas de l’exemple:

  • Soit on considère le type Vehicle:
    Vehicle vehicle = new Car();
    

    Exposer le type Vehicle permet d’éviter d’exposer la complexité de l’implémentation toutefois on ne peut pas accéder aux fonctions spécifiques au type Car.

  • Soit on considère directement le type précis de la classe:
    Car car = new Car(); 
    

    On perd l’intérêt d’avoir créé un type générique car on expose un type trop précis.

Les solutions à ce problème pourraient être:

  • D’effectuer des “casts” pour avoir les types précis et accéder aux fonctions spécifiques:
    Car car = vehicle as Car;  
    car.PutInTrunk(); 
    

    ou

    MotoBike moto = vehicle as MotoBike; 
    moto.IsHelmetAvailable(); 
    
  • Une autre possibilité est d’utiliser le pattern Visiteur:

Le pattern matching offre une 3e solution dont l’avantage est de présenter le code de façon plus synthétique:

switch (vehicle) 
{ 
    case Car car: 
        car.AddPassenger(); 
        car.MoveForward(); 
        break; 
    case MotoBike moto when moto.IsHelmetAvailable(): 
        moto.AddPassenger(); 
        car.MoveForward(); 
        break; 
    default: 
        vehicle.MoveReverse(); 
        break; 

} 
Share on FacebookShare on Google+Tweet about this on TwitterShare on LinkedInEmail this to someonePrint this page

Tuple et ValueTuple (C# 7)

Basique

Cet article fait partie d’une série d’articles sur les apports fonctionnels de C# 7 (i.e. C# 7.0/7.1/7.2/7.3).

Les tuples sont des structures de données permettant de stocker un nombre variable d’objets de type différent. L’intêret est d’éviter à avoir à déclarer la structure explicitement. Les objets sont stockés dans les membres du tuple. Les membres contenant les objets sont .Item1, .Item2, …, .Item<N>.

Historiquement, les tuples sont de type System.Tuple (apparu avec le framework .NET 4.0). System.Tuple est un type permettant de créer des objets de type référence.

Le type et le nombre de membres contenus dans le tuple sont indiqués à l’initialisation:

Tuple<int, string, float> tuple = new Tuple<int, string, float>(5, "5", 5.0f); 

Dans cet exemple, le tuple contient 3 membres:

  • Item1 de type int initialisé à la valeur 5
  • Item2 de type string initialisé à la valeur "5"
  • Item3 de type float initialisé à la valeur 5.0f

On peut aussi instancier un tuple de type System.Tuple en utilisant la syntaxe:

Tuple<int, string, float> tuple = Tuple.Create(5, "5", 5.0f);

Avant C# 7.0, les tuples devaient être utilisés exclusivement avec des noms de membres génériques (i.e. .Item1, .Item2, …, .Item<N>) ce qui rendait le code peu clair:

Tuple<int, string, float> tuple = new Tuple<int, string, float>(5, "5", 5.0f); 
Console.WriteLine(tuple.Item1); 
Console.WriteLine(tuple.Item2); 
Console.WriteLine(tuple.Item3); 

System.ValueTuple

A partir du framework .NET 4.7 est apparu le type System.ValueTuple permettant de créer des objets équivalent à System.Value. La principale différence entre ces 2 types est:

System.ValueTuple est fonctionnellement très proche de System.Tuple. Par exemple, on peut initialiser des objets System.ValueTuple avec une syntaxe semblable en utilisant la méthode statique ValueTuple.Create():

var tuple = ValueTuple.Create(5, "5", 5.0f); 

Au niveau de la syntaxe, C# 7.0 apporte des améliorations pour faciliter l’initialisation des objets de type System.ValueTuple.

Pour utiliser le type System.ValueTuple en utilisant le framework .NET 4.6.2 ou antérieur, il faut installer le package NuGet System.ValueTuple:

install-package System.ValueTuple

Amélioration à partir de C# 7.0

C# 7.0

C# 7.0 permet de rendre la syntaxe plus compacte pour initialiser des objets de type System.ValueTuple et rends plus clair l’accès à ses membres.

Initialisation

A partir de C# 7.0, on peut initialiser les objets System.ValueTuple de cette façon:

(int, string, float) tuple = (5, "5", 5.0f); 
Console.WriteLine(tuple.Item1); 
Console.WriteLine(tuple.Item2); 
Console.WriteLine(tuple.Item3); 

Utiliser des noms de membres explicites

Pour rendre l’accès aux membres plus explicite, on peut désormais nommer les membres:

(int ValueAsInt, string ValueAsString, float ValueAsFloat) tuple = (5, "5", 5.0f); 
Console.WriteLine(tuple.ValueAsInt); 
Console.WriteLine(tuple.ValueAsString); 
Console.WriteLine(tuple.ValueAsFloat); 

Une autre syntaxe est possible à l’initialisation pour indiquer les noms de membres:

var tuple = (ValueAsInt: 5, ValueAsString: "5", ValueAsFloat: 5.0f); 
Console.WriteLine(tuple.ValueAsInt); 
Console.WriteLine(tuple.ValueAsString); 
Console.WriteLine(tuple.ValueAsFloat); 

Noms de membres déterminés par des variables existantes

C# 7.1

A partir de C# 7.1, lors de l’initialisation d’un tuple, il n’est pas obligatoire de préciser le nom et le type des éléments du tuple si on l’initialise à partir de variables déjà existantes. Le nom et le type sont déterminés à partir des variables existantes:

int valueAsInt = 5; 
string valueAsString = "5"; 
float valueAsFloat = 5.0f; 
var tuple = (valueAsInt, valueAsString, valueAsFloat); // Le nom et le type des éléments du tuple 
// sont déterminés en fonction des noms et types des variables. 

Console.WriteLine(tuple.valueAsInt); 
Console.WriteLine(tuple.valueAsString); 
Console.WriteLine(tuple.valueAsFloat); 

Utiliser .Item1, .Item2, …, .Item<N> est toujours possible

C# 7.0

Même si on utilise des noms de membres dont le nom est explicite, les anciens membres .Item1, .Item2, …, .Item<N> restent toujours utilisables:

(int ValueAsInt, string ValueAsString, float ValueAsFloat) tuple = (5, "5", 5.0f); 
Console.WriteLine(tuple.Item1); 
Console.WriteLine(tuple.Item2); 
Console.WriteLine(tuple.Item3); 
System.ValueTuple est mutable

Bien-que System.ValueTuple est une structure permettant de créer des objets de type valeur, il est mutable à l’inverse de System.Tuple qui est immutable. Il est, ainsi, possible de modifier la valeur des membres .Item1, .Item2, …, .Item<N> après instanciation d’un objet de type System.ValueTuple:

(int, string, float) valObjectTuple = (5, "5", 5.0f); 
valObjectTuple.Item1 = 7; // OK 

A l’inverse, modifier un objet System.Tuple n’est pas possible:

Tuple<int, string, float> refObjectTuple = new Tuple<int, string, float>(5, "5", 5.0f);
refObjectTuple.Item1 = 7; // ERROR 

Affectation entre System.ValueTuple

C# 7.0

On peut effectuer des affectations entre objets de type System.ValueTuple en modifiant les noms des membres:

var tuple = (ValueAsInt: 5, ValueAsString: "5", ValueAsFloat: 5.0f); 
(int NewValueAsInt, string NewValueAsString, float NewValueAsFloat) newTuple = tuple; 
Console.WriteLine(newTuple.NewValueAsInt); 
Console.WriteLine(newTuple.NewValueAsString); 
Console.WriteLine(newTuple.NewValueAsFloat); 

Cette syntaxe n’est pas possible avec des objets de type System.Tuple.

Déconstruction

C# 7.0

La déconstruction permet d’affecter les membres d’un tuple dans des variables distinctes (ces syntaxes sont possibles pour les types System.Tuple et System.ValueTuple):

var tuple = ValueTuple.Create(5, "5", 5.0f); 
(int valueAsInt, string valueAsString, float valueAsFloat) = tuple; 
Console.WriteLine(valueAsInt); 
Console.WriteLine(valueAsString); 
Console.WriteLine(valueAsFloat); 

Une autre syntaxe est équivalente en utilisant le mot clé var:

var (valueAsInt, valueAsString, valueAsFloat) = tuple; 
Console.WriteLine(valueAsInt); 
Console.WriteLine(valueAsString); 
Console.WriteLine(valueAsFloat); 

Si on utilise des variables existantes:

int valueAsInt; 
string valueAsString; 
float valueAsFloat; 
(valueAsInt, valueAsString, valueAsFloat) = tuple; 
Console.WriteLine(valueAsInt); 
Console.WriteLine(valueAsString); 
Console.WriteLine(valueAsFloat); 

Ignorer une variable inutile

Lors d’une déconstruction d’un tuple, il est possible d’ignorer une variable inutile en utilisant le caractère _ de façon à alléger la syntaxe:

var tuple = (6, "6", 6.0f); 
var (ValueAsInt, ValueAsString, ValueAsFloat) = tuple; // Déconstruction du tuple 
Console.WriteLine($"Int value is {ValueAsInt}."); // ValueAsString et ValueAsFloat sont inutiles 

On peut ignorer de déclarer ces variables lors de la déconstruction:

var (ValueAsInt, _, _) = tuple; // Déconstruction 
Console.WriteLine($"Int value is {ValueAsInt}."); 

Cette syntaxe est possible pour les types System.Tuple et System.ValueTuple.

Comparaison entre tuples

La comparaison entre tuples en utilisant les opérateurs == ou != n’est pas la même suivant si on utilise des objets de type System.Tuple ou System.ValueTuple.

Comparaison entre System.Tuple

L’utilisation des opérateurs == et =! avec des tuples de type System.Tuple respecte les mêmes règles que pour tous les objets de type référence en .NET: par défaut la comparaison s’effectue sur la référence des objets:

var refTuple1 = Tuple.Create(5, "5", 5.0f); 
var refTuple2 = Tuple.Create(5, "5", 5.0f); 
Console.WriteLine(refTuple1 == refTuple2); // False 

Pour effectuer une comparaison entre les membres des objets, il faut utiliser la surcharge Equals():

Console.WriteLine(refTuple1.Equals(refTuple2); // True 

Comparaison entre System.ValueTuple

C# 7.3

Dans le cas de System.ValueTuple (avant C# 7.3), l’utilisation des opérateurs == et =! n’est pas possible, il faut utiliser CompareTo() ou Equals():

var valTuple1 = (5, "5", 5.0f); 
var valTuple2 = (5, "5", 5.0f); 
Console.WriteLine(valTuple1.CompareTo(valTuple2)); // 0 en cas d'égalité 
Console.WriteLine(valTuple1.Equals(valTuple2)); // True 

A partir de C# 7.3, il est possible d’utiliser les opérateurs == et =! pour effectuer une comparaison des membres des tuples:

Console.WriteLine(valTuple1 == valTuple2); // True

Share on FacebookShare on Google+Tweet about this on TwitterShare on LinkedInEmail this to someonePrint this page

Manipuler des objets de type valeur par référence (C# 7)

Confirmé

Cet article fait partie d’une série d’articles sur les apports fonctionnels de C# 7 (i.e. C# 7.0/7.1/7.2/7.3).

Avant de commencer…

Quelques indications en préambule concernant les objets de type valeur, les objets de type référence, le boxing et l’unboxing.

Type valeur vs type référence

D’une façon générale, il existe des objets de type valeur et des objets de type référence. Ces objets peuvent être manipulés par valeur ou par référence. En .NET, dans la plupart des cas et par défaut:

  • les objets de type référence sont manipulés par référence toutefois il est possible de manipuler des objets de type référence en utilisant des pointeurs avec du code unsafe.
  • les objets de type valeur sont manipulés par valeur, dans certaines conditions on peut manipuler des objets de type valeur en utilisant des références avec les mot-clés ref, in (à partir de C# 7.2) ou out.

Parmi les types valeur, on peut trouver les structures, les enums et les types primitifs comme bool, int, double, float etc… La plupart du temps les objets de type valeur sont immutables c’est-à-dire qu’il n’est pas possible d’en modifier des propriétés sans devoir créer une nouvelle instance de ces objets. Par exemple, l’affectation d’un objet de type valeur effectue une copie par valeur:

int firstValue = 5; 
int secondValue = firstValue; // Copie par valeur 
List<int> values = new List<int>(firstValue); // Copie par valeur 
int thirdValue = values.First(); // Copie par valeur 

L’opposé de immutable est mutable. Des objets sont dit mutables s’il est possible de les modifier sans devoir créer une nouvelle instance. Il existe quelques cas où un objet de type valeur est mutable. Si on considère la structure suivante:

public struct Circle 
{ 
    public int Radius { get; set; } 
} 

Cette structure est mutable si:

  • Une propriété locale est modifiée:
    var circle = new Circle(); 
    circle.Radius = 6; // Pas de copie, circle est modifié 
    
  • Si la structure se trouve dans un objet de type référence comme une classe:
    class Wrapper 
    { 
        public Circle InnerCircle; 
    } 
    
    var wrapper = new Wrapper{ InnerCircle = circle }; // Copie par valeur de circle 
    wrapper.InnerCircle.Radius; // Pas de copie, la copie de circle est modifiée directement 
    
  • Si on utilise un objet de type valeur dans un tableau:
    Circle[] circles = new Circle[] { circle }; // Copie par valeur 
    circles[0].Radius = 7; // Pas de copie, la copie dans le tableau est modifiée directement 
    circles.First().Radius = 4;// ATTENTION: First() effectue une copie. 
    var newCircle = circles[0]; // ATTENTION: une copie est effectuée.
    

Implicitement, les objets de type référence dérivent de System.Object et les objets de type valeur dérivent de System.ValueType. En réalitéSystem.ValueType dérive de System.Object, la différence entre les objets de type valeur et les objets de type référence est artificielle du point de vue de la hiérarchie des classes. C’est le runtime qui différenciera ces 2 types d’objets à l’exécution. Ainsi, les objets de type référence sont stockés dans le tas managé (i.e. managed heap) et les objets de type valeur sont stockés le plus souvent dans la pile (i.e. stack).

Objets de type référence

L’intérêt principal d’utiliser des objets de type référence est de les stocker dans le tas managé et de pouvoir allouer des quantités variables de mémoire suivant la taille des objets de façon dynamique. L’accès à ces objets se fait par l’intermédiaire d’une référence. Une référence permet de pointer vers un objet stocké en mémoire en utilisant son adresse. La référence d’un objet de type référence est elle-même un objet de type valeur. Par définition, une référence ne peut pas être nulle (en revanche, une variable contenant une référence peut être nulle).
La manipulation d’une référence n’est pas très couteuse car sa taille est fixe et égale à la valeur de la constante System.IntPtr.Size (la taille varie suivant la taille des adresses mémoire 32 ou 64 bits du système). La référence d’un objet stocké dans le tas managé peut donc facilement être stockée dans une variable sur la pile ou être passée en argument d’une fonction.

L’inconvénient majeur des objets de type référence est qu’ils sont couteux à manipuler car stockés dans le tas managé, les objets devant y être alloués et désalloués. La gestion de la mémoire dans le tas est assurée par le Garbage Collector (GC), ce qui nécessite de nombreuses opérations pour différencier les objets utilisés des objets qui ne le sont plus ou pour réorganiser les zones allouées en mémoire pour optimiser les temps d’allocation. Toutes ces opérations peuvent avoir un impact non négligeable sur les temps d’exécutions.

Le GC divise les objets managés en 2 catégories:

  • Les petits objets (< 85000 octets): ils sont gérés par génération (génération 0, génération 1 et génération 2) et leur allocation est rapide. Quand il change de génération (promotion), ils sont copiés dans la mémoire. La désallocation de ces objets est non déterministe et bloquante. Les objets dont la durée de vie est faible sont supprimés rapidement et se trouvent dans la génération 0 ou 1. Les objets dont la durée de vie est longue se trouvent dans la génération 2 et leur manipulation est plus longue.
  • Les gros objets (≥ 85000 octets): ils sont alloués dans un tas appelé Large Object Heap (LOH) dont le contenu n’est jamais déplacé. Cette caractéristique peut mener à une fragmentation de cette partie de la mémoire et allonge le temps d’allocation pour les nouveaux objets.

Objets de type valeur

Les objets de type valeur sont stockés dans la pile (i.e. stack) toutefois ce n’est pas tout le temps le cas, par exemple:

  • Les objets statiques de type valeur sont stockés dans un tas particulier (loader heap ou high frequency heap).
  • Un objet de type valeur membre d’un objet de type référence peut être stocké dans le tas managé.
  • Les objets de type valeur peuvent aussi être stockés dans un registre CPU suivant les optimisations du JIT.

L’intérêt des objets de type valeur est qu’ils peuvent être alloués et désalloués de la pile rapidement. Quand une fonction est appelée, un bloc appelé stack frame est réservé au sommet de la pile pour les variables locales. Quand une fonction a terminé son exécution, le bloc n’est plus utilisé et peut être utilisé lors de l’appel à une autre fonction suivant l’ordre LIFO (i.e. Last In First Out). La libération de ce bloc de mémoire est simple et beaucoup plus rapide qu’avec le tas managé. D’autre part, la taille de la pile est très petite (< 1 MO) et peut facilement entrer dans le cache d’un CPU. La manipulation des objets dans la pile est donc rapide et convient bien aux opérations répétitives.

Le plus gros inconvénient des objets de type valeur stockés dans la pile est que leur durée de vie est liée à la durée de vie de la fonction qui les manipule et que ces objets sont souvent copiés par valeur quand ils sont manipulés. La durée d’exécution de ces copies n’est pas fixe et varie suivant la taille des objets copiés. Il est possible de manipuler des références vers ces objets suivant certaines conditions.

Boxing vs Unboxing

Le boxing et l’unboxing sont 2 opérations courantes en .NET.

Boxing

En .NET, l’opération de boxing consiste à convertir un objet de type valeur vers le type object. Le plus souvent cette opération est effectuée implicitement.

Par exemple, si considère la structure suivante:

public struct Circle 
{ 
    public int Radius { get; set; } 
} 

Le boxing intervient si on stocke la structure dans un objet de type object:

Circle circle = new Circle(); 
object circleAsObj = circle; // boxing

La conversion en object est effectuée de façon implicite.

Techniquement l’opération de boxing est couteuse (20 fois plus longue qu’une simple assignation) car des nombreuses opérations sont effectuées. En .NET, les objets de type référence sont stockés dans le tas managé (i.e. managed heap) et les objets de type valeur sont stockés, la plupart du temps, dans la pile. La conversion de l’objet de type valeur en objet de type référence entraîne que cet objet doit être stocké dans le tas managé au lieu de la pile. Le boxing entraîne:

  • La création d’un wrapper de type référence qui va encapsuler l’objet de type valeur,
  • L’objet de type valeur est supprimé de la pile,
  • Il est placé dans le wrapper qui lui-même est placé dans le tas managé.

Outre l’opération de boxing à proprement parlé, d’autres utilisations de l’objet après boxing s’avère plus couteuse que l’utilisation directe de l’objet de type valeur puisqu’il faut accéder à l’objet dans le tas managé en utilisant sa référence alors que l’accès dans la pile était directe.

L’opération de boxing peut être mise en œuvre de façon moins évidente, par exemple, dans le cas où on stocke un objet de type valeur dans une liste générique d’object:

Circle circle = new Circle(); 
List<object> objects = new List<object>(); 
objects.Add(circle); // Boxing implicite 

D’autres opérations peuvent entraîner un boxing sans que l’on s’en rende compte, par exemple, si on appelle ToString() sur une structure, si on stocke un objet de type valeur dans une ArrayList ou une Hashtable:

ArrayList list = new ArrayList(); 
list.Add(circle); // Boxing implicite 

string circleAsStr = circle.ToString(); // Boxing implicite 

Le boxing peut intervenir aussi de façon implicite si une conversion intervient entre l’objet de type valeur et une interface.

Enfin, si observe le code décompilé avec IL DASM, l’opération de boxing apparaît sous la forme box, par exemple pour le code suivant:

var circle = new Circle(); 
object circleAsObj = circle; 
Console.WriteLine(circleAsObj.ToString()); 

La sortie de IL DASM est:

.method private hidebysig static void Main(string[] args) cil managed 
{ 
    .entrypoint 
    .maxstack 1 
    .locals init ([0] valuetype Test.Circle V_0) 
    IL_0000: ldloca.s V_0 
    IL_0001: initobj Test.Circle 
    IL_0008: ldloc.0 
    IL_0009: box Test.Circle

    IL_000e: callvirt instance string [mscorlib]System.Object::ToString() 
    IL_0013: call void [mscorlib]System.Console::WriteLine(string) 
    IL_0018: ret 
} 

Unboxing

A l’opposé du boxing, l’unboxing permet d’effectuer une conversion d’un type object vers un objet de type valeur. Le coût en performance est aussi significatif que pour le boxing c’est-à-dire que la ligne dans le code mettant en oeuvre l’unboxing entraîne techniquement plusieurs opérations qui la rendent plus couteuse qu’une simple affectation. La différence avec le boxing est que les opérations d’unboxing sont explicites donc il est plus facile de s’en rendre compte.

Par exemple, le code suivant implique de l’unboxing:

var circle = new Circle(); 
object circleAsObj = circle; // Boxing implicite 
var unboxedCircle = (Circle)circleAsObj; // Unboxing explicite 
Console.WriteLine(unboxedCircle.ToString()); 

D’un point de vue technique, étant donné que les objets de type valeur sont stockés dans la pile et que les objets de type référence sont stockés dans le tas managé (i.e. managed heap), l’opération d’unboxing implique davantage qu’une simple affectation. L’objet de type valeur se trouvant dans une variable object stockée dans le tas managé doit être extrait de son wrapper de type référence et déplacé dans la pile.

Si on observe le code décompilé avec IL DASM, l’opération d’unboxing apparaît sous la forme unbox. Par exemple pour le code plus haut, la sortie IL DASM est:

.method private hidebysig static void Main(string[] args) cil managed 
{ 
    .entrypoint 
    .maxstack 1 
    .locals init ([0] valuetype Test.Circle unboxedCircle, [1] valuetype Test_Circle V_1) 
    IL_0000: ldloca.s V_1 
    IL_0001: initobj Test.Circle 
    IL_0008: ldloc.0 
    IL_0009: box Test.Circle 
    IL_000e: unbox.any Test.Circle

    IL_0013: stloc.0 
    IL_0014: ldloca.s unboxedCircle 
    IL_0016: constrained. Test.Circle 
    IL_0021: callvirt instance string [mscorlib]System.Object::ToString() 
    IL_0026: call void [mscorlib]System.Console::WriteLine(string) 
    IL_0026: ret 
} 

Passage d’argument par référence d’un objet de type valeur

C# 7 permet d’effectuer des passages d’argument dans des fonctions d’objets de type valeur par référence.

C# 7.0

A partir de C# 7.0, il est possible d’effectuer des passages d’arguments d’objets de type valeur par référence. En effet, par défaut le passage d’objets de type valeur en argument de fonction se fait par valeur c’est-à-dire que les objets sont copiés lors de l’appel de fonction. L’utilisation du mot-clé ref dans un argument de fonction permet de passer un objet de type valeur par référence.

Techniquement lors du passage d’un objet de type valeur par référence, la référence passée en argument correspond à la référence de l’objet dans la pile. Il n’y a pas de boxing.

Par exemple, si on considère l’exemple suivant:

public struct Circle 
{ 
    public int Radius { get; set; } 
} 

private static void ChangeRadius(int newRadius, Circle circle) 
{ 
    circle.Radius = newRadius; 
} 

static void Main() 
{ 
    var circle = new Circle{ Radius = 4 }; 
    Console.WriteLine(circle.Radius); // 4 
    ChangeRadius(2, circle); // circle est dupliquée 
    Console.WriteLine(circle.Radius); // 4 
} 

Cet exemple ne fonctionne pas, la valeur de la propriété Radius est bien modifiée par ChangeRadius() toutefois il modifie la propriété d’une copie de l’objet d’origine. L’instance circle d’origine n’est pas modifiée.

Si on passe l’objet circle par référence, il n’y aura pas de copie et l’instance circle est réellement modifiée:

private static void ChangeRadius(int newRadius, ref Circle circle) 
{ 
    circle.Radius = newRadius; 
} 

static void Main() 
{ 
    var circle = new Circle{ Radius = 4 }; 
    Console.WriteLine(circle.Radius); // 4 
    ChangeRadius(2, ref circle); // circle est passé par référence 
    Console.WriteLine(circle.Radius); // 2 
} 

Si on regarde plus en détails l’implémentation:

  • ref désigne une référence vers un objet de type valeur, ainsi la signature de la méthode ChangeRadius() comprend l’argument ref Circle circle. Le type est donc une référence vers un objet de type valeur Circle.
  • L’appel vers la méthode ChangeRadius() doit être modifié puisqu’il faut utiliser une référence et non directement le type valeur: ChangeRadius(2, ref circle).

Passage en argument d’une référence par référence

Une référence est un objet de type valeur qui, par défaut, est manipulée par valeur. Manipuler une référence par référence permet, par exemple, d’éviter d’effectuer des copies de la référence.

C# 7.0

Lors du passage d’argument, utiliser ref pour des objets de type référence permet d’éviter la copie de la référence vers l’objet. En effet, la plupart du temps, les objets de type référence sont manipulés par référence, ainsi si on considère la classe suivante:

class Square 
{ 
    public int Size { get; set; } 
} 

var square = new Square { Size = 4 }; 

La variable square contient une référence vers un objet de type Square stocké dans le tas managé. La référence est objet de type valeur bien que l’objet référencé est de type référence. La référence est stockée dans la pile alors que l’objet référencé est stockée dans le tas managé. Si on écrit:

var newSquare = square; // Copie de la référence 

Une nouvelle variable est créée et initialisée avec une copie de la référence vers l’objet newSquare. L’objet référencée n’est pas copié, seule la référence est copiée.

Ainsi si on considère la méthode suivante:

public static void IncreaseSize(Square square) 
{ 
    square.Size++; 
} 

Si on effectue un appel de ce type:

var initialSquare = new Square { Size = 2 }; 
IncreaseSize(initialSquare); 
Console.WriteLine(initialSquare.Size); // 3 

L’argument square contient une référence vers un objet de type Square. Lors de l’appel, la référence initialSquare est copiée dans l’argument square. Lorsqu’on manipule l’objet référencé avec square.Size, on manipule directement l’objet. Si on effectue une affectation à l’intérieur de la fonction sur l’argument square, l’objet initial n’est pas modifié et la variable otherSquare contient une référence vers l’objet initial:

public static void IncreaseSize(Square square) 
{ 
    square  = new Square{ Size = 8 }; // Création d'un nouvel objet et d'une nouvelle référence 
} 

var initialSquare = new Square { Size = 2 }; 
IncreaseSize(initialSquare); 
Console.WriteLine(initialSquare.Size); // 2 

Si on utilise ref dans l’argument de IncreaseSize(), on indique qu’on ne veut pas dupliquer la référence mais passer la référence en argument par référence:

public static void IncreaseSize(ref Square square) 
{ 
    square  = new Square{ Size = 8 }; // Création d'un nouvel objet et affectation à la référence existante 
} 

var initialSquare = new Square { Size = 2 }; 
IncreaseSize(ref initialSquare); // La référence n'est pas copiée 
Console.WriteLine(initialSquare.Size); // 8 

Dans cet exemple, la référence est passée par référence. La référence n’est donc pas copiée lors du passage en argument. Modifier la référence dans le corps de la méthode, va entraîner la modification de la référence à l’extérieur de la méthode.

Manipuler une variable locale par référence

C# 7.0

A chaque nouvelle affectation, les objets de type valeur sont copiés.

Par exemple:

var circle = new Circle { Radius = 4 }; 
var newCircle = circle; // Duplication de l’objet 
circle.Radius = 2; 
Console.WriteLine(circle.Radius); // 2 
Console.WriteLine(newCircle.Radius); // 4 

L’affection, le passage d’argument ou le retour de fonction sont des opérations qui effectuent une copie par valeur d’un objet de type valeur. L’affectation var newCircle = circle crée une nouvelle instance newCircle qui est une copie de l’instance circle.

L’affectation d’une nouvelle propriété Radius sur l’instance circle ne modifie pas l’instance newCircle puisqu’il s’agit d’objets différents.

A partir de C# 7.0, il est possible de manipuler des variables locales d’objet de type valeur par référence. Ainsi, les affectations effectuent une copie de référence au lieu d’effectuer une copie par valeur.

Si on reprends l’exemple précédent, il faut déclarer une référence d’un objet de type valeur:

var circle = new Circle { Radius = 4 }; 
ref var newCircle = ref circle; // On considère la référence de l’objet 
circle.Radius = 2; 
Console.WriteLine(circle.Radius); // 2 
Console.WriteLine(newCircle.Radius); // 2 

Si on regarde plus en détails la syntaxe de l’exemple:

  • var circle désigne un objet de type valeur Circle.
  • ref var circle désigne une référence vers un objet de type valeur Circle, ainsi les lignes:
    • var circle = new Circle { Radius = 4 } permet d’instancier un objet de type Circle.
    • ref circle permet de récupérer une référence vers l’objet circle dans la pile (i.e. stack). Plus précisemment, cet objet se trouve dans la stack frame de la méthode. Cette stack frame et les objets qu’elle contient existent tant que la méthode existe.
C# 7.3

A chaque fois, qu’on manipule une référence d’un objet de type valeur, il faut penser à utiliser le mot-clé ref, par exemple si on écrit:

ref Circle firstCircle = new Circle { Radius = 2 }; // Initialisation 
ref Circle secondCircle = new Circle { Radius = 4 }; // Initialisation 
secondCircle = firstCircle; // Affectation par valeur, une copie est effectuée 

Même si firstCircle et secondCircle sont définis avec ref Circle, la dernière affectation effectue une copie par valeur. Pour manipuler les références, il faut utiliser ref (disponible à partir de C# 7.3):

secondCircle = ref firstCircle; // Affectation par référence (C# 7.3) 

Avant C# 7.3, il n’est pas possible d’effectuer l’affectation d’une référence vers un objet de type valeur sur une variable existante, seules les initialisations sont possibles:

ref Circle thirdCircle = ref firstCircle; 

Retour de fonction par référence

C# 7.0

A partir de C# 7.0, il est possible de retourner la référence d’un objet de type valeur. Toutefois tout n’est pas possible car techniquement il faut comprendre ce que signifie retourner la référence d’un objet de type valeur.

Ainsi, comme on a pu le voir précédemment, les arguments d’une fonction, ses variables locales et sa valeur de retour sont stockés dans la stack frame de la fonction. Cette stack frame disparaît lorsqu’on quitte la fonction. Par exemple, si on retourne une référence d’une variable locale de type valeur, après exécution de la fonction la référence ne correspondra plus à l’objet retourné puisque la stack frame de la fonction est perdue.

Retourner une référence vers un objet de type valeur est possible si la référence reste disponible à la sortie de la fonction. Ceci est possible si:

  • L’objet de type valeur est un membre d’un objet de type référence: dans ce cas il est stockée dans le tas managé et non dans la pile. La référence reste disponible à la sortie de la fonction.
  • L’objet de type valeur est statique: il n’est pas stocké dans la pile mais dans un tas particulier (loader heap ou high frequency heap). La référence vers l’objet statique de type valeur reste disponible à la sortie de la fonction.

Par exemple, si on considère l’exemple suivant:

public static ref Circle FindCircle(Circle[] circles, int circleIndex) 
{ 
    return ref circles[circeIndex]; 
} 

static void Main() 
{ 
    Circle[] circles = { 
        new Circle { Radius = 4 }, 
        new Circle { Radius = 2 } 
    }; 
 
    ref Circle foundCircle = ref FindCircle(circles, 1); 
    Console.WriteLine(foundCircle.Radius); // 2 
    foundCircle.Radius = 1; 
    Console.WriteLine(circles[1].Radius); // 1 
} 

C’est bien l’objet se trouvant dans le tableau circles qui est modifié et non une copie de l’objet. En effet, le retour de FindCircle() est une référence d’un objet dans le tableau circles.

Liste générique et LINQ

Dans l’exemple plus haut, l’utilisation du tableau Circle[] n’est pas anodine car cette structure permet de manipuler reéllement une référence de l’objet dans le tableau. Si on utilise une liste ou LINQ on manipulera une copie de l’objet dans la liste et non l’objet se trouvant dans la liste:

public static ref Circle FindCircle(List circles, int circleRadius) 
{ 
    return ref circles.First(c => c.Radius.Equals(circleRadius)); // ERROR: 
    // An expression cannot be used in the context because it may not be passed or 
    // returned by reference 
} 

Dans cet exemple, on obtient une erreur de syntaxe car circles.First() effectue une copie de l’objet et ne permet pas de récupérer une référence de l’objet dans la structure.

Pas de référence nulle

Il n’existe pas de référence nulle vers un objet de type valeur, on ne peut donc pas écrire une fonction de ce type:

public static ref Circle FindCircle(Circle[] circles, int circleRadius) 
{ 
    for (int i = 0; i < circles.Length; i++) 
    { 
        ref var foundCircle = ref circles[i]; 
        if (circles[i].Radius.Equals(circleRadius)) 
            return ref foundCircle; 
    } 

    return null; // ERROR: the return expression must be of type 'Circle' 
    // because the method returns by reference. 
} 

La solution peut consister à définir en avance une objet nul pour l’utiliser si le recherche échoue:

public static ref Circle FindCircle(Circle[] circles, int circleRadius, ref Circle notFoundCircle) 
{ 
    for (int i = 0; i < circles.Length; i++) 
    { 
        ref var foundCircle = ref circles[i]; 
        if (circles[i].Radius.Equals(circleRadius)) 
            return ref foundCircle; 
    } 

    return ref notFoundCircle; 
} 

L’appel peut se faire de cette façon:

static void Main() 
{ 
    Circle[] circles = { 
        new Circle { Radius = 4 }, 
        new Circle { Radius = 2 } 
    }; 

    var notFoundCircle = new Circle { Radius = 0 }; 
    ref var notFoundCircleRef = ref notFoundCircle; 

    ref Circle foundCircle = ref FindCircle(circles, 6, ref notFoundCircleRef); 
    if (foundCircle.Equals(notFoundCircleRef)) 
        Console.WriteLine("Not found"); // Not found 
}

Utilisation d’un objet statique

Un objet de type valeur stocké dans une variable statique se trouve techniquement dans un tas particulier (loader heap ou high frequency heap). Il est donc possible d’utiliser une référence vers cet objet statique sans se préoccuper de la durée de vie de la stack frame d’une fonction.

Par exemple:

private static Circle mediumCircle; 

public static ref Circle GetMediumCircle() 
{ 
    return ref mediumCircle; 
} 

static void Main() 
{ 
    mediumCircle = new Circle { Radius = 5 }; 
    ref var foundCircle = ref GetMediumCircle(); 
} 

L’objet mediumCircle n’est pas stocké dans la pile de la fonction GetMediumCircle(), on peut donc retourner une référence vers cet objet.

Utilisation d’un membre d’un objet de type référence

Un objet de type valeur étant un membre d’un objet de type référence est stocké dans le tas managé. On peut donc utiliser une référence vers cet objet de type valeur en retour d’une fonction.

Par exemple:

internal class CircleRepository 
{ 
    public Circle InnerCircle; 
} 

public static ref Circle SetNewRadius(CircleRepository circleRepository, int newRadius) 
{ 
    ref var circle = ref circleRepository.InnerCircle; 
    circle.Radius = newRadius; 
    return ref circle; 
} 

static void Main() 
{ 
    var circleRepo = new CircleRepository{ 
        InnerCircle = new Circle { Radius = 4 } 
    }; 

    ref var updatedCircle = ref SetNewRadius(circleRepo, 2); 
    Console.WriteLine(circleRepo.InnerCircle.Radius); // 2 
} 

Etant donné que InnerCircle est membre de la classe CircleRepository, même s’il s’agit d’un objet de type valeur, il est stocké dans le tas managé. On peut donc manipuler cet objet par référence et l’utiliser en retour de la fonction SetNewRadius().

Si on utilise un liste générique d’objet de type valeur, on ne peut pas extraire de la liste des éléments sans effectuer de copie par valeur.

Utiliser ref avec l’opérateur ternaire

C# 7.2

L’opérateur ternaire permet d’écrire des expressions du type:

<condition> ? <code si condition vraie> : <code si condition fausse> 

On peut effectuer des initialisations de ce type:

Circle[] circules = { 
    new Circle{ Radius = 4 }, 
    new Circle{ Radius = 2 }, 
}; 

var firstCircle = circles.First(); 
var bigCircle = foundCircle.Radius > 2 ? circles[0] : circles[1]; 

Dans la dernière ligne, des copies par valeur des objets sont effectuées car Circle est un objet de type valeur.

Pour effectuer des copies par référence, il est possible à partir de C# 7.2 d’utiliser le mot-clé ref avec l’opérateur ternaire:

ref var bigCircle = ref (foundCircle.Radius > 2 ? ref circles[0] : ref circles[1]); 

L’affectation est, ainsi, effectuée par référence.

Mot-clé in

C# 7.2

Lors d’appel de fonction, le mot-clé ref autorise le passage en argument d’objets de type valeur par référence. La modification de l’objet passé en argument est possible dans le corps de la fonction appelée. Comme pour ref, le mot-clé in permet d’indiquer qu’un objet de type valeur doit être passé par référence toutefois il interdit la modification de l’argument dans le corps de la fonction.

Par rapport à ref, les avantages à utiliser in sont les suivants:

  • On indique explicitement que l’objet ne pourra pas être modifié dans le corps de la fonction.
  • Le compilateur optimise le code généré en sachant que l’objet n’est pas modifié dans le corps de la fonction. Ainsi l’appel à la fonction est effectué de façon plus rapide qu’avec ref.

Par exemple, si on considère la classe Circle et la fonction suivante

struct Circle  
{ 
    public int Radius { get; set; } 

    public void SetNewRadius(int newRadius)  
    { 
        this.Radius = newRadius; 
    } 
} 

private static void ChangeRadius(int newRadius, ref Circle circle) 
{ 
    circle.Radius = newRadius; 
} 

Si on effectue l’appel suivant:

var circle = new Circle{ Radius = 4 }; 
Console.WriteLine(circle.Radius); // 4 
ChangeRadius(2, ref circle); // circle est passé par référence 
Console.WriteLine(circle.Radius); // 2 

Il n’y a pas de copie de circle lors du passage en argument quand on appelle ChangeRadius(). La même instance est passée en argument et modifiée dans le corps de ChangeRadius().

Si on modifie l’implémentation de ChangeRadius():

private static void ChangeRadius(int newRadius, in Circle circle) 
{ 
    // circle.Radius = newRadius; // ERREUR car on ne peut pas modifier circle dans le corps de la méthode 
    circle.SetNewRadius(newRadius); // Pas d'erreur 
    Console.WriteLine(circle.Radius);  
} 

Si on effectue l’appel suivant:

var circle = new Circle{ Radius = 4 }; 
Console.WriteLine(circle.Radius); // 4 
ChangeRadius(2, circle); // circle est passé par référence 

// Dans le corps de ChangeRadius(), Console.WriteLine(circle.Radius) affiche 4 
Console.WriteLine(circle.Radius); // 4 
Circle.SetNewRadius(3); 
Console.WriteLine(circle.Radius); // 3 

Avec in, l’argument circle est passé par référence toutefois le compilateur effectue des optimisations en sachant que circle ne peut être modifié dans le corps de la fonction. circle.SetNewRadius() ne modifie pas l’objet circle. Le résultat est toujours 4 quand on essaie de modifier circle à l’intérieur de ChangeRadius().

Appel à une méthode avec in

Quand un argument comporte le modificateur in, si la méthode ne comporte pas de surcharge, il est possible d’effectuer l’appel avec ou sans in. Si in est omis, il est considéré comme implicite et le comportement est le même que l’appel contenant in.

Par exemple dans le cas de l’exemple précédent, les appels suivants ont le même comportement:

ChangeRadius(2, circle); // Passage par référence implicite 
ChangeRadius(2, in circle); // Passage par référence explicite 

Surcharge des méthodes avec in

Les surcharges de méthode avec ref et in ne sont pas possibles, une seule surcharge est possible.

Par exemple, si on crée 2 méthodes de ce type:

private static void ChangeRadius(int newRadius, ref Circle circle) { ... } 
private static void ChangeRadius(int newRadius, in Circle circle) { ... } // ERREUR: généré une erreur de compilation 

Il est possible d’avoir 2 surcharges avec et sans in:

private static void ChangeRadius(int newRadius, Circle circle) { … } 
private static void ChangeRadius(int newRadius, in Circle circle) { … } // OK 

Dans ce dernier cas, l’utilisation de in lors des appels est importante puisqu’elle va permettre d’indiquer quelle surcharge sera utilisée:

ChangeRadius(2, circle); // la surchage ChangeRadius(int newRadius, Circle circle) est appelée => passage par valeur 
ChangeRadius(2, in circle); // la surchage ChangeRadius(int newRadius, in Circle circle) est appelée => passage par référence 
Utiliser in peut être plus coûteux en performance que ref

Outre la différence fonctionnelle entre in et ref (ref autorise la modification de l’argument alors que in ne l’autorise), il existe une différence en terme de performance: suivant la façon dont on l’utilise in peut être beaucoup plus coûteux que ref lors d’appel de méthodes.

Pour garantir qu’un objet passé en paramètre d’une méthode est en lecteur seule, le compilateur effectue une copie par valeur de cet objet. Cette copie sera temporaire et réservé à l’utilisation du paramètre dans la méthode.

Pour s’en convaincre, il suffit d’exécuter le code suivant:

public struct Circle 
{ 
    public Circle(int radius) 
    { 
        this.Radius = radius; 
    } 
 
    public int Radius { get; private set; } 

    public void UpdateRadius(int newRadius) 
    { 
        this.Radius = newRadius; 
    } 
} 

public static void ChangeRadius(int newRadius, in Circle circle) 
{ 
    circle.UpdateRadius(newRadius); 
    Console.WriteLine(circle.Radius); 
} 

Ensuite, on effectue les appels suivants:

var circle = new Circle(4); 
ChangeRadius(3, in circle); // 4 
Console.WriteLine(circle.Radius); // 4 

Ainsi bien dans le corps de la méthode ChangeRadius() qu’à l’extérieur la valeur de circle.Radius est 4 même si on tente de modifier la valeur de Radius. La raison est que in entraîne la création d’une copie temporaire pour éviter d’affecter l’instance d’origine de Circle.

La conséquence de cette copie est une dégradation des performances par rapport à l’utilisation de ref. ref permet d’utiliser une référence toutefois il n’y a pas de copie dans une variable temporaire des arguments de la méthode.

Pour permettre au compilateur d’effectuer des optimisations quand on utilise in, il faut que la structure de l’objet passé en paramètre soit immutable en utilisant readonly:

public readonly struct Circle 
{ 
    // ... 
} 

Références
Share on FacebookShare on Google+Tweet about this on TwitterShare on LinkedInEmail this to someonePrint this page

Requêter les éléments d’une vue d’un composant Angular

Pour récupérer l’instance d’un objet se trouvant sur la vue dans la classe d’un composant, il est possible d’effectuer des requêtes auprès de cette vue et renseigner un membre ou une propriété de la classe avec l’instance de cet objet. L’objet requêté peut être un composant enfant, une directive ou un objet du DOM.

@juanster

Pour effectuer un requêtage sur la vue, on peut s’aider de plusieurs décorateurs: @ViewChild(), @ViewChildren(), @ContentChild() ou @ContentChildren().

Ces décorateurs se placent devant la propriété ou le membre de la classe du composant dans lesquels l’instance doit être renseignée.

En Javascript, l’équivalent de ces décorateurs pourrait être:

document.getElementById('id-element'); 

Le choix du décorateur à utiliser dépend du type d’objet à requêter:

  • @ViewChild() et @ViewChildren() permettent de requêter un objet de la vue. Cet objet peut être un objet Angular ou un objet du DOM. @ViewChild() retourne le 1er objet correspondant aux identifiants indiqués en argument; @ViewChildren() renvoie une liste d’objets correspondants.
  • @ContentChild() et @ContentChildren() retournent un ou plusieurs objets se trouvant dans le composant par projection de contenu. A la différence de @ViewChild(), le contenu par projection n’est pas initialisé au même moment que les autres éléments de la vue d’un composant. @ContentChild() retourne le 1er objet correspondant aux identifiants; @ContentChildren() renvoie une liste d’objets correspondants.

Requêter un élément d’une vue

Pour requêter un élément de la vue d’un composant, il faut utiliser @ViewChild() ou @ViewChildren().

@ViewChild()

Le décorateur @ViewChild() permet d’accéder à un élément implémenté dans le template d’un composant:

  • Si l’élément est un composant enfant alors @ViewChild() permettra d’accéder à l’instance de ce composant.
  • Si l’élément est un objet du DOM alors @ViewChild() permettra d’accéder à cet objet par l’intermédiaire d’un objet de type ElementRef.

Pour comprendre l’intérêt de @ViewChild(), dans un premier temps imaginons que l’on souhaite imbriquer un composant dans un autre. Plusieurs syntaxes sont possibles:

Ces 2 méthodes permettent d’effectuer l’imbrication directement à partir des fichiers templates sans effectuer d’implémentation particulière du coté des classes des composants.

Par exemple, si on considère 2 composants ChildComponent et ParentComponent utilisés respectivement pour être le composant enfant et le composant parent. Pour imbriquer le composant ChildComponent dans le composant ParentComponent en utilisant le paramètre selector, l’implémentation pourrait être:

  • Pour le composant enfant:
    Template
    <p>Child component</p>
    Classe du composant
    import { Component } from '@angular/core';
    
    @Component({
      selector: 'app-child',
      templateUrl: './child.component'
    })
    export class ChildComponent() {}
  • Pour le composant parent:
    Template
    <p>Parent component</p>
    <app-child></app-child>
    Classe du composant
    import { Component } from '@angular/core';
    
    @Component({
      templateUrl: './parent.component'
    })
    export class ParentComponent() {}

Avec cette implémentation, on peut faire référence au composant enfant à partir du template du composant parent en utilisant une variable référence. Si on souhaite accéder à une propriété du composant enfant pour l’afficher, on peut utiliser l’implémentation suivante:

  • Pour le composant enfant:
    Template
    <p>Child component</p>
    Classe du composant
    import { Component } from '@angular/core';
    
    @Component({
      selector: 'app-child',
      templateUrl: './child.component'
    })
    export class ChildComponent() {
      internalValue = 'Value to display';
    }
  • Pour le composant parent:
    Template
    <p>Parent component</p>
    <app-child #child></app-child>
    <p>Child internal value: {{child.internalValue}}</p>
    Classe du composant
    import { Component } from '@angular/core';
    
    @Component({
      templateUrl: '/parent.component'
    })
    export class ParentComponent() {}

Si on souhaite accéder au membre internalValue du composant enfant à partir de la classe du composant parent, il n’y a pas de méthode directe.

Le but du décorateur @ViewChild() est de donner une méthode pour accéder à un composant utilisé dans le template.

Plus généralement @ViewChild() permet d’accéder à un composant, une directive ou un objet du DOM implémenté dans le template à partir de la classe du composant. Ainsi en préfixant une propriété avec le décorateur, la propriété sera automatiquement bindée avec l’objet se trouvant dans le template.

Requêter un composant enfant

En reprenant l’exemple précédent, on ajoute dans la classe du composant parent le membre childReference avec le décorateur @ViewChild():

Template
<p>Parent component</p>
<app-child #child></app-child>
<p>Child internal value: {{child.internalValue}}</p>
Classe du composant
import { Component, ViewChild, AfterViewInit } from '@angular/core';
import { ChildComponent } from '../child/child.component';

@Component({
  templateUrl: './parent.component'
})
export class ParentComponent implements AfterViewInit {
  @ViewChild(ChildComponent, { static: false }) childReference: ChildComponent;

  ngAfterViewInit() {
    console.log(this.childReference.internalValue);
  }
}

Ainsi la propriété childReference est automatiquement bindée avec l’instance du composant enfant seulement quand l’évènement AfterViewInit ou OnInit est déclenché suivant la valeur de static.

Callbacks ngAfterViewInit() ou ngOnInit()

Quand on utilise le décorateur @ViewChild(), le binding de l’élément n’est pas effectué dès la construction de la classe mais après le déclenchement des callbacks ngAfterViewInit() ou ngOnInit() suivant la valeur du paramètre static (pour plus de détails voir Paramètre static):

  • @ViewChild(<type de l'objet>, { static: false }) le binding sera effectué quand la callback ngAfterViewInit() est déclenchée. La classe du composant doit dériver de AfterViewInit:
    export class ParentComponent implements AfterViewInit {
      ngAfterViewInit(): void {}
    }
    
  • @ViewChild(<type de l'objet>, { static: true }) le binding sera effectué quand la callback ngOnInit() est déclenchée. La classe du composant doit dériver de OnInit:
    export class ParentComponent implements OnInit {
      ngOnInit(): void {}
    }
    

Requêter une directive

La syntaxe est indentique à celle utilisée avec les composants. Par exemple si on considère la directive suivante:

import { Directive, ElementRef, Renderer2 } from '@angular/core';

@Directive({
  selector: '[contentFiller]'
})
export class SimpleDirective {
  constructor(private elem: ElementRef, private renderer: Renderer2) { 
    let newText = renderer.createText('Content from directive');  
    renderer.appendChild(elem.nativeElement, newText); 
  }
}

Il s’agit d’une directive attribut (i.e. attribute directive) rajoutant le texte 'Create from directive' dans son élément hôte.

Pour appeler la directive à partir du composant hôte, le template du composant est:

<p>Parent component</p>
<p contentFiller #directiveHost></p>

En utilisant @ViewChild() avec la variable référence #directiveHost dans la classe du composant, on obtient l’implémentation suivante:

import { Component, AfterViewInit, ViewChild } from '@angular/core';
import { SimpleDirective } from '../simple.directive';

@Component({
  templateUrl: './parent.component.html',
  styleUrls: ['./parent.component.css']
})
export class ParentComponent implements AfterViewInit {
  @ViewChild('directiveHost', { read: SimpleDirective }) innerDirective: SimpleDirective;

  constructor() { }

  ngAfterViewInit(): void {
    console.log(this.innerDirective);
  }
}

On remarque quand dans cet exemple, on utilise l’option { read: SimpleDirective } dans la directive @ViewChild() de façon à effectuer la résolution avec le directive. Si on ne précise pas cette option, la résolution se fera sur l’élément hôte de la directive.
Dans cet exemple, l’élément hôte de la directive est une élément HTML <p></p>.

Requêter un objet du DOM

@ViewChild() permet de binder un objet du DOM avec un membre du composant.

Par exemple, si on considère le code suivant pour la classe parente:

Template
<p>Parent component</p>
<span #spanElement>Span content</span>
Classe du composant
import { Component, ViewChild, AfterViewInit, ElementRef } from '@angular/core';

@Component({
  templateUrl: './parent.component'
})
export class ParentComponent implements AfterViewInit {
  @ViewChild('spanElement', { static: false }) spanReference: ElementRef;

  ngAfterViewInit() {
    console.log(this.spanReference.nativeElement);
  }
}

Ainsi, avec une variable référence pour désigner l’objet span, on peut utiliser le décorateur @ViewChild() pour binder l’objet du DOM avec le membre spanReference. Le binding sera effectué quand la callback ngAfterViewInit() ou ngOnInit() est déclenchée suivant la valeur de static.

L’objet du DOM est wrappé dans un objet de type ElementRef. Cet objet permet de récupérer un élément du DOM en utilisant la propriété nativeElement.

@ViewChildren()

Le décorateur @ViewChildren() permet de requêter la vue pour retourner les instances d’objets s’y trouvant. La différence avec ViewChild() est que @ViewChildren() renvoie tous les objets satisfaisants les conditions de la requête (@ViewChild() ne retourne que le 1er objet).

@ViewChildren() peut être utilisé pour retourner un composant ou une directive en précisant le type de l’objet dans le paramètre selector. Il est possible de requêter plusieurs objets en précisant plusieurs noms.

Requêter les objets suivant leur type

Si le paramètre selector est un type alors tous les objets correspondant à ce type seront retournés.

Par exemple, si on considère l’exemple suivant:

  • Le composant ChildComponent:
    Template
    <p>Child Component</p>
    Classe du composant
    @Component({ 
      selector: 'child',
      templateUrl: './child.component' 
    }) 
    export class ChildComponent {}
  • Le composant ParentComponent:
    Template
    <p>Parent Component</p> 
    <child></child> 
    <child></child> 
    <child></child>
    Classe du composant
    import { Component, AfterViewInit, ViewChildren, QueryList } from '@angular/core'; 
    import { ChildComponent } from '../child/child.component';
    
    @Component({ 
      templateUrl: './parent.component.html' 
    }) 
    export class ParentComponent implements AfterViewInit { 
      @ViewChildren(ChildComponent) childReferences: QueryList<ChildComponent>;
    
      ngAfterViewInit(): void { 
        console.log(this.childReferences); 
      } 
    }

Dans ce cas, childReferences contient les 3 références de composant enfant ChildComponent.

Le résultat est:

Parent Component
Child Component
Child Component
Child Component

Requêter les objets suivant leur nom

Il est possible de requêter les objets en précisant les noms de ces objets en utilisant la syntaxe:

@ViewChildren('<nom variable ref 1>, <nom variable ref 2>, ..., <nom variable ref N>') references: QueryList<T>; 

Par exemple:

Template
<p>Parent Component</p> 
<child #child1></child> 
<child #child2></child> 
<child #child3></child>
Classe du composant
import { Component, AfterViewInit, ViewChildren, QueryList } from '@angular/core'; 
import { ChildComponent } from '../child/child.component'; 

@Component({ 
  templateUrl: './parent.component.html' 
}) 
export class ParentComponent implements AfterViewInit { 
  @ViewChildren('child1, child2, child3') childReferences: QueryList<ChildComponent>;
 
  ngAfterViewInit(): void { 
    console.log(this.childReferences); 
  } 
}

Le résultat est le même que précédemment.

Requêter un contenu projeté

Pour requêter un contenu projeté dans la vue d’un composant, il faut utiliser @ContentChild() ou @ContentChildren() (voir Les composants enfant pour plus de détails sur la projection de contenu).

@ContentChild()

Le décorateur @ContentChild() permet de requêter la vue d’un composant dans le cadre d’une projection de contenu. Comme le contenu projeté provient de l’extérieur du composant, utiliser @ViewChild() ne permettra pas de requêter le contenu projeté car @ViewChild() effectue la recherche parmi les éléments du composant définis directement dans sa vue.

Si on prend l’exemple suivant:

  • Le composant ParentComponent projette un contenu dans le composant ChildComponent.
  • Le composant ChildComponent affiche le contenu projeté en utilisant <ng-content>.
  • Le code de ChildComponent est:
    Template
    <p>Child Component</p> 
    <ng-content></ng-content>
    Classe du composant
    @Component({ 
      selector: 'child', 
      templateUrl: './child.component.html' 
    }) 
    export class ChildComponent {}
  • Le code de ParentComponent est:
    Template
    <p>Parent Component</p> 
    <child> 
      <p #projectedContent>Projected content</p> 
    </child>
    Classe du composant
    @Component({ 
      templateUrl: './parent.component.html' 
    }) 
    export class ParentComponent {}

L’affichage de cet exemple est:

Parent Component
Child Component
Projected Content

Dans ChildComponent, on pourra requêter le contenu projeté grâce à <ng-content></ng-content> avec le décorateur @ContentChild():

Template
<p>Child Component</p> 
<ng-content></ng-content>
Classe du composant
import { Component, AfterContentInit, ContentChild, ElementRef } 
  from '@angular/core'; 

@Component({ 
  selector: 'child', 
  templateUrl: './child.component.html' 
}) 
export class ChildComponent implements AfterContentInit { 
  @ContentChild('projectedContent') projectedContent: ElementRef; 
 
  ngAfterContentInit(): void { 
    console.log(this.projectedContent); 
  } 
}

Le résultat sera affiché dans la console du browser.

Le requêtage est effectué juste avant ngAfterContentInit()

Quand on utilise @ContentChild(), le membre ou la propriété sera affecté juste avant le déclenchement de la callback ngAfterContentInit().

Requêter les objets suivant leur type

L’exemple précédent permettait d’effectuer une requête en utilisant le nom d’une variable référence toutefois, comme pour @ViewChild(), il est possible d’utiliser un type dans le paramètre selector de @ContentChild().

Par exemple, si on ajoute le composant OtherComponent:

Template
<p>Other Component</p>
Classe du composant
@Component({ 
  selector: 'other', 
  templateUrl: './other.component.html' 
}) 
export class OtherComponent {}

On peut effectuer une requête pour récupérer l’instance du composant OtherComponent se trouvant dans le contenu projeté:

Template
<p>Child Component</p> 
<ng-content></ng-content>
Classe du composant
import { Component, AfterContentInit, ContentChild, ElementRef } from '@angular/core'; 
import { OtherComponent } from '../other/other.component'; 

@Component({ 
  selector: 'child', 
  templateUrl: './child.component.html' 
}) 
export class ChildComponent implements AfterContentInit { 
  @ContentChild(OtherComponent) projectedContent: OtherComponent;

  ngAfterContentInit(): void { 
    console.log(this.projectedContent); 
  } 
}

Le code de ParentComponent est:

Template
<p>Parent Component</p> 
<child> 
  <other></other> 
</child>
Classe du composant
@Component({ 
  templateUrl: './parent.component.html' 
}) 
export class ParentComponent {}
Le requêtage par type s’applique aussi sur des directives

Comme pour @ViewChild(), le requêtage en utilisant un type s’applique plus généralement aux directives et pas seulement sur les composants. Dans l’exemple précédent, on aurait pû utiliser une directive au lieu d’utiliser le composant OtherComponent.

@ContentChildren()

Le décorateur @ContentChildren() permet de requêter le contenu projeté d’un composant pour retourner toutes les instances des objets satisfaisants aux conditions de la requête. La différence avec @ContentChild() est que @ContentChildren() renvoie toutes les instances satisfaisants aux conditions et pas seulement le 1er objet trouvé comme pour @ContentChild().

@ContentChildren() peut être utilisé pour retourner un composant ou une directive en précisant le type de l’objet dans le paramètre selector. Il est possible de requêter plusieurs objets en précisant plusieurs noms.

Requêter les objets suivant leur type

L’exemple suivant permet de montrer comment requêter des objets suivant leur type. Dans cet exemple, plusieurs instances de OtherComponent sont projetés dans le composant ChildComponent. En utilisant le décorateur @ContentChildren(), on peut retourner une liste de toutes les instances de OtherComponent qui ont été projetées:

Template
<p>Other Component</p>
Classe du composant
@Component({ 
  selector: 'other', 
  templateUrl: './other.component.html' 
}) 
export class OtherComponent {}

On peut effectuer une requête pour récupérer l’instance du composant OtherComponent se trouvant dans le contenu projeté:

  • Le code du composant ChildComponent:
    Template
    <p>Child Component</p> 
    <ng-content></ng-content>
    Classe du composant
    import { Component, AfterContentInit, ContentChildren, 
      ElementRef, QueryList } from '@angular/core'; 
    import { OtherComponent } from '../other/other.component'; 
    
    @Component({ 
      selector: 'child', 
      templateUrl: './child.component.html' 
    }) 
    export class ChildComponent implements AfterContentInit { 
      @ContentChildren(OtherComponent) projectedContent: QueryList<OtherComponent>;
    
      ngAfterContentInit(): void { 
        console.log(this.projectedContent); 
      } 
    }
  • Le code de ParentComponent est:
    Template
    <p>Parent Component</p> 
    <child> 
      <!-- Instance 1 --> 
      <other></other>  
      <!-- Instance 2 --> 
      <other></other> 
      <!-- Instance 3 --> 
      <other></other> 
    </child>
    Classe du composant
    @Component({ 
      templateUrl: './parent.component.html' 
    }) 
    export class ParentComponent {}

Le résultat est:

Parent Component
Child Component
Other Component
Other Component
Other Component

Requêter les objets suivant leur nom

Il est possible de requêter les objets en précisant les noms de ces objets en utilisant la syntaxe:

@ContentChildren('<nom variable ref 1>, <nom variable ref 2>, .., <nom variable ref N>') references: QueryList<T>; 

Par exemple:

Template
<p>Other Component</p>
Classe du composant
@Component({ 
  selector: 'other', 
  templateUrl: './other.component.html' 
}) 
export class OtherComponent {}

On peut effectuer une requête pour récupérer l’instance du composant OtherComponent se trouvant dans le contenu projeté:

  • Le code de ChildComponent:
    Template
    <p>Child Component</p> 
    <ng-content></ng-content>
    Classe du composant
    import { Component, AfterContentInit, ContentChildren, 
      ElementRef, QueryList } from '@angular/core'; 
    import { OtherComponent } from '../other/other.component'; 
    
    @Component({ 
      selector: 'child', 
      templateUrl: './child.component.html' 
    }) 
    export class ChildComponent implements AfterContentInit { 
      @ContentChildren('instance1, instance2, instance3') 
        projectedContent: QueryList<OtherComponent>;
    
      ngAfterContentInit(): void { 
        console.log(this.projectedContent); 
      } 
    }
  • Le code de ParentComponent est:
    Template
    <p>Parent Component</p> 
    <child> 
      <other #instance1></other>  
      <other #instance2></other> 
      <other #instance3></other> 
    </child>
    Classe du composant
    @Component({ 
      templateUrl: './parent.component.html' 
    }) 
    export class ParentComponent {}

Le résultat est le même que précédemment.

@ContentChild() et @ContentChildren() effectuent une recherche dans le DOM

Les décorateurs @ContentChild() et @ContentChildren() permettent d’effectuer une requête dans le contenu projeté dans le DOM. Cela ne veut pas dire que le contenu doit être affiché dans la vue correspondante ou que <ng-content></ng-content> doit être présent.

Par exemple, si on écrit le code suivant:

  • Pour un composant enfant:
    Template
    <p>Child component</p>
    Classe du composant
    import { Component, ElementRef, ContentChild, AfterContentInit } from '@angular/core'; 
    
    @Component({ 
      selector: 'child', 
      templateUrl: './child.component.html' 
    }) 
    export class ChildComponent implements AfterContentInit { 
      @ContentChild('content') content: ElementRef; 
    
      ngAfterContentInit(): void { 
        console.log(this.content); 
      } 
    }
  • Pour le composant parent:
    Template
    <p>Parent component</p> 
    <child> 
      <p #content>Content</p> 
    </child>
    Classe du composant
    import { Component } from '@angular/core'; 
    
    @Component({ 
      selector: 'parent', 
      templateUrl: './parent.component.html' 
    }) 
    export class ParentComponent {}

On peut voir qu’il n’y a pas <ng-content></ng-content> et que le contenu projeté n’est pas visible:

Parent Component
Child Component

Pourtant le contenu projeté se trouve dans le DOM et @ContentChild() permet de récupérer l’objet correspondant se trouvant dans le DOM.

L’objet du DOM se trouve dans la propriété this.content.nativeElement. On peut voir que la valeur de la propriété this.content.nativeElement.isConnected est false et que this.content.nativeElement.parentNode est undefined expliquant pourquoi cet objet n’est pas visible.

Paramètre descendants dans @ContentChildren()

Le paramètre descendants permet d’indiquer si la requête porte sur les éléments se trouvant directement dans le contenu projeté ou s’il faut descendre parmi les descendants dans la hiérarchie HTML des éléments.

Par exemple si on considère la directive suivante:

import { Directive, ElementRef, ContentChildren, AfterContentInit, QueryList } from '@angular/core'; 

@Directive({ 
  selector: 'custom-directive', 
  templateUrl: './custom.component.html' 
}) 
export class CustomDirective implements AfterContentInit { 
  @ContentChildren('content') content: QueryList<ElementRef> 

  ngAfterContentInit(): void { 
    console.log(this.content); 
  } 
} 

Et le composant suivant:

Template
<p>Parent component</p> 
<custom-directive> 
  <div> 
    <p #content>Content</p> 
  </div> 
</custom-directive>
Classe du composant
import { Component } from '@angular/core'; 

@Component({ 
  selector: 'parent', 
  templateUrl: './parent.component.html' 
}) 
export class ParentComponent {}

Dans ce cas, @ContentChildren() ne permettra pas de récupérer l’élément HTML p qui est projeté car il se trouve dans un élément HTML div:

<div> 
  <p #content>Content</p> 
</div> 

Par défaut, @ContentChildren() ne descend pas dans l’arbre hiérarchique des éléments HTML et la valeur du paramètre descendants est false: { descendants: false }. Pour que @ContentChildren() puisse effectuer la requête en considérant des éléments HTML plus bas dans la hiérarchie, il faut rajouter l’option { descendants: true } dans @ContentChildren():

@Directive({ 
  ... 
}) 
export class CustomDirective implements AfterContentInit { 
  @ContentChildren('content', { descendants: true }) content: QueryList<ElementRef>  

  ngAfterContentInit(): void { 
    console.log(this.content); 
  } 
} 

Avec l’option { descendants: true }, l’élément p sera récupéré par @ContentChildren().

Paramètre read

Ce paramètre s’utilise avec les décorateurs @ViewChild(), @ViewChildren(), @ContentChild() ou @ContentChildren(). Il permet d’ajouter un critère à la requête faite pour retourner l’objet de la vue. Le paramètre read permet d’indiquer un type de l’objet qui sera retourné. Ainsi si plusieurs objets existent avec le même nom de variable référence, l’objet retourné correspondra au type précisé par read.

Pour chaque élément se trouvant dans la vue, il existe un objet Angular correspondant de type ElementRef<any> ou ViewContainerRef. Avec le paramètre read, on peut alors préciser le type ElementRef<any> ou ViewContainerRef et obtenir l’instance de l’objet correspondant.

Si cet élément est un composant, en précisant le type du composant avec read, il est possible de retourner directement l’instance du composant.

L’exemple suivant permet de montrer que des éléments avec les mêmes identifiants dans la vue peuvent être utilisés de façon différente suivant la valeur du paramètre read.

On considère le composant suivant qui servira de composant enfant:

Template
<p>Child component</p>
Classe du composant
import { Component } from '@angular/core'; 

@Component({ 
  selector: 'child-component', 
  templateUrl: './child.component.html' 
}) 
export class ChildComponent {}

On implémente un 2e composant qui servira de parent:

  • Le fichier template est:
    <p>Read example component</p> 
      <p #content>Element content</p> 
    <child-component #child></child-component> 
    
  • La classe du composant est:
    import { Component, ViewChild, ElementRef, ViewContainerRef, AfterViewInit, ViewContainerRef } 
      from '@angular/core'; 
    import { ChildComponent } from '../child/child.component'; 
    
    @Component({ 
      templateUrl: './readexample.component.html' 
    }) 
    export class ReadExampleComponent implements AfterViewInit { 
      @ViewChild('content', { read: ElementRef }) contentElementRef: ElementRef; 
      @ViewChild('content', { read: ViewContainerRef }) contentViewContainerRef: ViewContainerRef; 
    
      @ViewChild('child', { read: ChildComponent }) child: ChildComponent; 
      @ViewChild('child', { read: ElementRef }) childElementRef: ElementRef; 
      @ViewChild('child', { read: ViewContainerRef }) childViewContainerRef: ViewContainerRef;
    
    
      ngAfterViewInit(): void { 
        console.log(this.contentElementRef); 
        console.log(this.contentViewContainerRef); 
    
        console.log(this.child); 
        console.log(this.childElementRef); 
        console.log(this.childViewContainerRef); 
      } 
    } 
    

A l’affichage du composant ReadExampleComponent, on peut voir dans la console du browser les différentes formes des objets affichés:

  • Dans le cas de l’élément p avec la variable référence content:
    • La propriété contentElementRef de type ElementRef qui est un objet Angular wrappant l’objet du DOM correspondant.
    • La propriété contentViewContainerRef de type ViewContainerRef qui est un objet Angular wrappant la vue correspondant à l’élément p.
  • Dans le cas du composant enfant ChildComponent:
    • Les objets équivalents de type ElementRef et ViewContainerRef.
    • child contenant l’instance du composant ChildComponent. La ligne @ViewChild() permettant d’effectuer le binding avec child peut être simplifié en:
      @ViewChild(ChildComponent) child: ChildComponent;
      

Paramètre static

Le paramètre static peut être utilisé avec les décorateurs @ViewChild(), @ViewChildren(), @ContentChild() ou @ContentChildren(). Il permet d’indiquer quand doit être effectué la requête sur la vue. Pour comprendre pleinement le sens de ce paramètre, il faut avoir en tête le cycle de vie d’un composant et le fonctionnement de la détection de changements d’Angular. Le choix de la valeur de ce paramètre n’est pas anodin, un mauvais choix de sa valeur peut entraîner un échec de la requête sur la vue.

Pour résumer, Angular construit la vue d’un composant suivant 2 étapes:

  • Création du contenu statique de la vue: cette étape n’est effectuée qu’à l’initialisation d’un composant. Elle permet de créer les éléments statiques de la vue c’est-à-dire les éléments qui ne seront pas modifiés par la détection de changements. Cette étape n’est exécutée qu’une seule fois de façon à optimiser le traitement, étant donné que les éléments sont statiques, il n’est pas nécessaire de les mettre à jour.
  • Mise à jour du contenu dynamique: cette étape est répétée à chaque exécution de la détection de changements dans le cas où un changement a été détecté. Elle permet de mettre à jour les éléments d’une vue pouvant être affectée après la mise à jour d’une propriété du composant.

Le cycle de vie d’un composant découle directement du mécanisme de détection de changements. L’algorithme de détection de changements effectue les mises à jour des éléments graphiques suivant un ordre précis. Tout au long de ces mises à jour et suivant les éléments qui sont mis à jour, il va aussi exécuter les callbacks du cycle de vie des composants (i.e. Lifecycle hooks). L’ordre de déclenchement de ces callbacks est le suivant:

  • A l’initialisation du composant:
    1. ngOnChanges(): cette callback est exécutée si le composant contient des propriétés en entrée (notamment avec le décorateur @Input()).
    2. ngOnInit(): déclenchée après l’exécution du constructeur. Il permet d’initialiser le composant avec le 1er affichage des données de la vue ayant un binding avec des propriétés de la classe du composant. Le cas échéant, il permet d’affecter les paramètres en entrée du composant. Cette callback est déclenchée une seule fois à l’initialisation du composant même si ngOnChanges() n’est pas déclenchée.
    3. ngDoCheck() permet d’indiquer des changements si Angular ne les a pas détecté.
    4. ngAfterContentInit() est déclenchée à l’initialisation après la projection de contenu. Elle est déclenchée même s’il n’y a pas de contenu à projeter.
    5. ngAfterContentChecked(): déclenchée après la détection de changement dans le contenu projeté. Cette callback est déclenchée même s’il n’y a pas de projection de contenu.
    6. ngAfterViewInit(): déclenchée après l’initialisation de la vue du composant et après l’initialisation de la vue des composants enfant.
    7. ngAfterViewChecked() est déclenchée après détection d’un changement dans la vue du composant et dans la vue des composants enfant.
    8. ngOnDestroy() est déclenchée avant la destruction du composant.
  • A chaque détection de changements, les callbacks déclanchées sont, dans l’ordre:
    1. ngOnChanges() si les paramètres en entrée du composant sont modifiés.
    2. ngDoCheck()
    3. ngAfterContentChecked() est déclenchée même s’il n’y a pas de contenu projeté.
    4. ngAfterViewChecked()

A l’initialisation d’un composant, le DOM est mis à jour à 2 reprises: lors de la création du contenu statique de la vue et lors de la mise à jour du contenu dynamique. On peut résumer cette mise à jour, l’exécution des callbacks du cycle de vie et l’exécution des requêtes sur les vues dans le schéma suivant:

Légende du schéma
  1. A l’initialisation, le DOM est mis à jour avec le contenu statique de la vue.
  2. Les requêtes avec le paramètre { static: true } sur le contenu projeté (avec @ContentChild() ou @ContentChildren()) et sur la vue (avec @ViewChild() ou @ViewChildren()) sont exécutées sur le contenu statique de la vue.
  3. A l’exécution de la callback ngOnInit(), les requêtes sur le contenu statique ont été exécutées.
  4. Les requêtes avec le paramètre { static: false } sur le contenu projeté (avec @ContentChild() ou @ContentChildren()) sont exécutées. Le lien avec le composant parent n’apparaît pas sur ce schéma toutefois à ce state, le contenu dynamique du DOM du composant parent a été mise à jour.
  5. A chaque détection de changements, le contenu dynamique de la vue est mis à jour.
  6. Les requêtes avec le paramètre { static: false } sur la vue (avec @ViewChild() ou @ViewChildren()) sont exécutées sur le contenu dynamique de la vue.
  7. A l’exécution de la callback ngAfterViewInit(), les requêtes sur le contenu dynamique ont été exécutées.

Ce schéma permet de se rendre compte à quelle stade les requêtes sont exécutées suivant la valeur du paramètre static.

Par exemple, si on considère le composant suivant:

Template
<p>Example component:</p> 
<p #numberElement>{{miscNumber}}</p> 
Classe du composant
import { Component, OnInit, AfterContentInit, AfterViewInit, ViewChild, ElementRef }  
  from '@angular/core';  

@Component({  
  selector: 'example',  
  templateUrl: './example.component.html'  
})  
export class ExampleComponent implements OnInit, AfterContentInit, AfterViewInit {  
  miscNumber = 5; 

  @ViewChild('numberElement') numberElementRef: ElementRef<HTMLParagraphElement>;

  ngOnInit(): void {      
    if (this.numberElementRef)  
      console.log('From ngOnInit():', 
        this.numberElementRef.nativeElement.textContent); 
  }  

  ngAfterContentInit(): void {  
    if (this.numberElementRef)  
      console.log('From ngAfterContentInit():', 
        this.numberElementRef.nativeElement.textContent); 
  }  
 
  ngAfterViewInit(): void {      
    if (this.numberElementRef)  
      console.log('From ngAfterViewInit():', 
        this.numberElementRef.nativeElement.textContent); 
  }  
} 

Dans le template, on affiche la propriété miscNumber du composant. Dans le classe du composant, on effectue une requête sur la vue en utilisant la variable référence #numberElement. On implémente les callbacks ngOnInit(), ngAfterContentInit() et ngAfterViewInit() pour afficher le contenu de l’élément p identifié par la variable #numberElement.

Après exécution, seule la ligne suivante apparaît dans la console du browser:

From ngAfterViewInit(): 5 

Par défaut, si le paramètre static n’est pas renseigné dans la requête @ViewChild(), sa valeur est false. Cela signifie que la requête sera exécutée peu avant le déclenchement de la callback ngAgterViewInit(). Ainsi, le résutat de l’exécution s’explique par le fait que pour les autres callbacks, la requêtes @ViewChild() n’a pas été exécutée et la propriété numberElementRef est encore indéfinie. Le contenu de l’élément #numberElement ne peut donc pas être affiché.

Si on modifie la valeur du paramètre static telle que:

@ViewChild('numberElement', { static: true }) numberElementRef: 
    ElementRef<HTMLParagraphElement>;  

Le résultat de l’exécution devient:

From ngOnInit():  
From ngAfterContentInit():  
From ngAfterViewInit(): 5 

Ainsi, avec { static: true }, la requête @ViewChild() est exécutée juste avant le déclenchement de la callback ngOnInit() sur le contenu statique de la vue. Ce contenu contient l’élément p toutefois le résultat de l’interpolation {{miscNumber}} ne fait pas partie du contenu statique de la vue. La priopriété this.numberElementRef est définie mais this.numberElementRef.nativeElement.textContent est vide car le DOM n’a pas été mis à jour avec le contenu dynamique de la vue.

Une fois que le DOM a été mis à jour avec le contenu dynamique de la vue juste avant le déclenchement de la callback ngAfterViewInit(), this.numberElementRef.nativeElement.textContent contient le résultat de l’interpolation. Ainsi ngAfterViewInit() permet d’afficher le résultat de l’interpolation.

Cet exemple permet de montrer que suivant la valeur du paramètre static, l’exécution des requêtes sur les vues n’est pas effectuée au même stade:

  • Si static est true alors la requête est effectuée sur le contenu statique. Le résultat de la requête est disponible en amont du cycle de vie du composant.
  • Si static est false alors la requête est effectuée sur le contenu dynamique (elle peut aussi être exécutée sur le contenu statique). Le résultat de la requête est disponible plus tard dans le cycle de vue du composant.

Paramètre queries de @Directive()

Le paramètre queries est utilisable dans les décorateurs @Directive() et @Component() (puisque @Component() hérite de @Directive()). Ce paramètre permet d’effectuer les mêmes traitements qu’avec les décorateurs @ViewChild(), @ViewChildren(), @ContentChild() et @ContentChildren(), toutefois la syntaxe rend la lecture moins facile.

Au lieu d’utiliser les décorateurs devant les membres ou propriétés, on instancie les objets qui vont renseigner les valeurs des membres ou des propriétés. Les objets instanciés sont équivalents aux décorateurs: @ViewChild(), @ViewChildren(), @ContentChild() ou @ContentChildren().

Par exemple, si considère 2 composants ChildComponent et ParentComponent tels que:

  • ChildComponent:
    Template
    <p>Child component</p>
    Classe du composant
    import { Component, ElementRef, ContentChild, AfterContentInit } from '@angular/core'; 
    
    @Component({ 
      selector: 'child', 
      templateUrl: './child.component.html', 
      queries: { 
        content: new ContentChild('content') 
      } 
    }) 
    export class ChildComponent implements AfterContentInit { 
      content: ElementRef; 
    
      ngAfterContentInit(): void { 
        console.log(this.content); 
      } 
    }
  • Pour le code du composant parent:
    Template
    <p>Parent component</p> 
    <child #child> 
      <p #content>Content</p> 
    </child>
    Classe du composant
    import { Component, ViewChild, AfterViewInit } from '@angular/core'; 
    import { ChildComponent } from '../child/child.component'; 
    
    @Component({ 
      selector: 'parent', 
      templateUrl: './parent.component.html' 
      queries: { 
        child: new ViewChild(ChildComponent) 
      }
    }) 
    export class ParentComponent implements AfterViewInit { 
      child: ChildComponent; 
    
      ngAfterViewInit(): void { 
        console.log(this.child); 
      } 
    }

Dans cet exemple, on utlise le paramètre queries dans des décorateurs @Component() pour instancier:

  • ContentChild() dans ChildComponent pour renseigner le membre content de type ElementRef contenant un objet Angular correspondant à l’élément HTML <p #content></p> projeté à partir de ParentComponent.
  • @ViewChild() dans ParentComponent pour renseigner le membre child de type ChildComponent contenant l’instance du composant enfant se trouvant dans le template de ParentComponent.

Pour résumer…

Requêter la vue d’un composant permet de récupérer l’instance d’un objet de façon à l’exploiter dans la classe du composant. Les objets requêtés peuvent être un composant enfant, une directive ou objet quelconque du DOM.

Le résultat des requêtes permet d’affecter des propriétés dans la classe du composant. Pour indiquer qu’une propriété doit être initialisée avec le résultat d’une requête sur la vue, il faut utiliser des décorateurs particuliers:

  • @ViewChild() pour effectuer une requête sur un seul objet directement dans la vue du composant. Seul le 1er objet de la vue satisfaisant la requête est renvoyé.
  • @ViewChildren() pour effectuer une requête sur une liste d’objets directement dans la vue du composant. Tous les objets satisfaisant la requête sont renvoyés.
  • @ContentChild() pour effectuer une requête sur un seul objet se trouvant dans du contenu projeté (i.e. content projection) sur la vue du composant. Seul le 1er objet de la vue satisfaisant la requête est renvoyé.
  • @ContentChildren() pour effectuer une requête sur une liste d’objets se trouvant dans du contenu projeté (i.e. content projection) sur la vue du composant. Tous les objets satisfaisant la requête sont renvoyés.

Les critères de la requête peuvent être de nature différente.

Requêter suivant un type

2 méthodes sont possibles pour spécifier le type de l’objet à requêter:

  • Spécifier directement le type en tant qu’argument du décorateur utilisé, par exemple pour requêter une directive dont le type est TypedDirective:
    @ViewChild(TypedDirective) requestedDirective: TypedDirective;

    Dans cet exemple, on a utilisé @ViewChild() toutefois les autres décorateurs utilisent la même syntaxe.

  • Dans le cas où on effectue une requête avec le nom d’une variable référence, on peut préciser le type attendu de l’objet en l’indiquant en utilisant l’option read.

    Par exemple, pour requêter une directive avec une variable référence 'directiveRef' et dont le type est TypedDirective:

    @ViewChild('directiveRef', { read: TypedDirective }) requestedDirective: TypedDirective;

Requêter suivant une variable référence

Si l’objet est identifié dans la vue en utilisant une variable référence, on peut requêter en utilisant le nom de cette variable.

Par exemple, pour requêter une directive avec une variable référence 'directiveRef':

@ViewChild('directiveRef') requestedDirective: TypedDirective;

Indiquer si l’objet fait partie du contenu statique de la vue

Le contenu de la vue est séparé en 2 parties:

  • Un contenu statique: ce contenu permet de mettre à jour le DOM seulement à l’initialisation de la vue. Ce contenu est initialisé juste avant le déclenchement des callbacks ngOnInit() et/ou ngDoCheck() du cycle de vie du composant.
  • Un contenu dynamique: cette partie de la vue est mise à jour à chaque détection de changement. Ce contenu est initialisé et mis à jour à des périodes différentes suivant l’objet requêté:
    • Si l’objet se trouve directement dans la vue du composant: il est requêté avec @ViewChild() ou @ViewChildren(). Le contenu dynamique de cet objet est initialisé et mis à jour juste avant le déclenchement des callbacks ngAfterViewInit() et/ou ngAfterViewChecked().
    • Si l’objet se trouve dans du contenu projeté: il est requêté avec @ContentChild() ou @ContentChildren(). Le contenu dynamique de cet objet est initialisé et mis à jour avant le déclenchement des callbacks ngAfterContentInit() et/ou ngAfterContentChecked().

Un objet peut être requêté dans le contenu statique ou dynamique de la vue suivant la valeur de l’option static:

  • { static: false }: valeur par défaut, elle permet de requêter le contenu statique et dynamique d’une vue. Le résultat de cette requête est disponible dans la propriété au déclenchement des callbacks:
    • ngAfterContentInit() et/ou ngAfterContentChecked() pour du contenu projeté.
    • ngAfterViewInit() et/ou ngAfterViewChecked() pour une requête directement sur la vue.
  • { static: true }: permet de requêter seulement le contenu statique d’une vue. Le résultat de cette requête est disponible dans la propriété au déclenchement des callbacks ngOnInit() et/ou ngDoCheck().

    Par exemple, pour requêter un élément HTML p nommé 'content' dans le contenu statique de la vue:

    @ViewChild('content', { static: true }) contentRef: ElementRef<HTMLParagraphElement>;
    

QueryList

Si on utilise @ViewChildren() ou @ContentChildren() pour requêter une liste d’objets, on peut utiliser la liste QueryList pour stocker la liste des objets.

Par exemple, pour requêter des directives de type TypedDirective directement sur la vue d’un composant:

@ViewChildren(TypedDirective) requestedDirectives: QueryList<TypedDirective>;

Option descendants

L’option { descendants: true } utilisable avec @ContentChildren() permet d’indiquer si la requête doit porter sur tous les descendants d’un élément dans la hiérarchie HTML. Par défaut, la requête est effectuée seulement sur les enfants directs.

Références
Share on FacebookShare on Google+Tweet about this on TwitterShare on LinkedInEmail this to someonePrint this page

Le scope des variables en Javascript

Le scope (ou la portée) d’un objet est la portion de code dans laquelle une variable peut exister et maintenir une valeur qui lui aura été préalablement affectée. Le scope des objets est loin d’être un sujet trivial en Javascript car suivant la façon dont on les déclare beaucoup de règles ou de comportements du langage ne sont pas forcément intuitifs et surtout sont opposés à ceux d’autres langages plus standards comme le C++, C#, Java etc…

@martinols3n

Le but de cet article est d’essayer d’indiquer tous les cas atypiques de comportements de la gestion des scopes des objets en Javascript pouvant mener à des erreurs d’implémentations.
Dans un premier temps, on va indiquer les règles générales liées au scope suivant l’utilisation de var, let ou const. Ensuite, on montrera quelle syntaxe permet de modifier les règles liées à la gestion du scope par le moteur Javascript. Dans un 3e temps, on développera les différents comportements du mot-clé this. Enfin, on indiquera quelles sont les règles liées à l’hoisting.

Pour déclarer des variables en Javascript de façon à éviter de déclarer dans le scope global, on utilise les mots-clé var ou let (ou const dans le cas d’une variable dont la valeur est constante). Suivant le mot-clé utilisé, le comportement du moteur Javascript sera très différent. Avec let et const, les comportements sont assez standards pour rapport à d’autres langages. En revanche, avec var, les comportements sont spécifiques et peuvent surprendre en particulier si on est habitué à d’autres langages.
On pourrait se demander quelle est la justification qui nécessite de s’intéresser à var, il suffirait d’utiliser uniquement let. La raison est que let est apparu avec ES6 (ES2015) et que beaucoup d’applications fonctionnent avec un code compatible ES5 utilisant var.

Variables globales

Un des plus gros inconvénient de Javascript est de permettre de déclarer des variables globales. Le scope de ces variables étant celui de l’application, elles garderont leur valeur dans toute l’application. Ainsi une même variable peut être valuée à des endroits différents du code et des conflits peuvent apparaître entre ces valuations dans le cas où elles sont incompatibles ce qui peut mener à des erreurs. D’une façon générale, il faut éviter d’utiliser des variables globales.

Les variables globales se déclarent de cette façon:

<nom variable> = <valeur>;

ou

window.<nom variable> = <valeur>;

Par exemple:

variable = 'OK';

ou

window.variable = 'OK';

Lexical scope vs dynamic scope

Quand Kyle Simpson présente le scope des objets en Javascript dans You don’t know JS, il explique le comportement de Javascript en passant par le lexical scope.
Le lexical scope ou static scope s’oppose au dynamic scope. Il s’agit d’un ensemble de règles utilisé par le moteur d’exécution d’un langage pour identifier une variable nommée et pour en déterminer la valeur. Le lexical scope est le comportement utilisé par la plupart des langages y compris C++, C# ou Java. Javascript utilise aussi cet ensemble de règles.

Dans la gestion du scope des variables, tous ces langages ont des comportements similaires:

  • Les scopes s’imbriquent: un scope peut se trouver à l’intérieur d’un autre scope. Les variables définies dans le scope parent sont accessibles dans le scope enfant.
  • Le scope le plus général est le scope global: dans le cas de Javascript, une variable globale est accessible partout.
  • La plupart du temps, un scope ne peut pas appartenir à plus d’un seul scope parent.

En Javascript, les règles qu’imposent le lexical scope sont les suivantes:

  • Règle 1: lorsque le moteur d’exécution exécute la déclaration d’une variable, le scope de la variable sera celui dans lequel se trouve la déclaration.
  • Règle 2: lorsque le moteur d’exécution cherche la valeur d’une variable, il recherche sa déclaration dans le scope courant. Si aucune déclaration n’est trouvée, le moteur cherche dans les scopes parent. Si aucune déclaration n’est trouvée alors la variable appartient au scope global.
  • Règle 3: si une variable est déclarée dans un scope parent et qu’une variable est déclarée avec le même nom dans un scope enfant, la variable dans le scope parent sera occultée par celle du scope enfant. Ce comportement correspond au shadowing.

Pour se rendre compte de la différence entre le lexical scope et le dynamic scope, on peut prendre l’exemple suivant:

var x = 1;

function a() {
  console.log('x in a(): ',x); // x => 1
  x = 2;
}

function b() {
  var x = 3; // x => 3
  a();
  console.log('x in b(): ',x); // x => 3
}

b();
console.log(x); // x => 2

Suivant le scope utilisé, le comportement est le suivant:

Lexical scope

Dynamic scope

Le dynamic scope utilise des piles durant l’exécution pour garder les valeurs des variables de façon dynamique.
Javascript a le comportement correspondant au lexical scope, il n’utilise donc pas le dynamic scope..
  1. Dans le corps principal, var x = 1 permet d’affecter la valeur 1 à la variable x (qu’on peut appeler x1).
  2. La méthode b() est appelée:
    1. Dans le corps de la méthode b(), var x = 3 permet d’affecter 3 à une nouvelle variable nommée x (qu’on peut appeler x2). La première variable x (i.e. x1) déclarée dans le corps principal est occultée par shadowing.
    2. On appelle la méthode a(), dans le corps de la méthode b():
      1. On affiche la valeur de x, pour savoir à quoi correspond cette variable:
        • Dans le scope de la méthode a(), y’a-t-il une déclaration d’une variable x dans le scope correspondant au corps de la méthode a() ? ⇒ non donc on cherche dans le scope parent de la méthode.
        • Dans le corps principal, y’a-t-il une déclaration d’une variable nommée x ? ⇒ oui avec var x = 1 (il s’agit de x1).
        • On peut en déduire la valeur de x qui est 1.
      2. On affecte une nouvelle valeur à la variable x. Par le même principe que précédemment, la variable x (i.e. x1) correspond à la variable du corps principal. La nouvelle valeur de cette variable est donc 2.
    3. Dans le corps de b(), on affiche la valeur de la variable x. Pour savoir à quoi correspond cette variable: y’a-t-il une déclaration d’une variable x dans le scope correspondant au corps de b() ? ⇒ oui à cause de var x = 3. La valeur de cette variable est donc 3 (il s’agit de x2).
  3. Dans le corps principal, on affiche la valeur de la variable x. Pour savoir à quoi correspond cette variable x: y’a-t-il une déclaration d’une variable x dans le scope du corps principal ? ⇒ oui à cause de var x = 1 (il s’agit de x1). Toutefois la valeur de cette variable a été modifiée lors de l’appel à la méthode a(). La valeur de x est 2.
  1. Dans le corps principal, var x = 1 permet d’ajouter à la pile la valeur 1 pour la variable x (qu’on peut appeler x1).
  2. La méthode b() est appelée:
    1. Dans le corps de la méthode b(), var x = 3 ajoute à la pile la valeur 3 pour une nouvelle variable x (qu’on peut appeler x2).
    2. On appelle la méthode a(), dans le corps de la méthode b():
      • On affiche la valeur de x. En regardant au sommet de la pile, on cherche une variable nommée x (il s’agit de x2) donc la valeur affichée est 3.
      • On affecte une nouvelle valeur à la variable x ⇒ en cherchant au sommet de la pile on trouve une variable nommée x (i.e. x2) donc la valeur est 3. On modifie cette valeur pour affecter 2.
    3. Dans le corps de b(), on affiche la valeur de la variable x. Pour savoir à quoi correspond cette variable, on cherche au sommet de la pile une variable nommée x ⇒ la variable trouvée est x2, la valeur affichée est donc 2. Quand on sort de la méthode b(), la variable nommée x au sommet de la pile est supprimée (x2 est donc supprimée de la pile).
  3. Dans le corps principal, on affiche la valeur d’une variable nommée x. Pour savoir à quoi correspond cette variable x: on regarde au sommet de la pile, la variable nommée x correspond à x1. La valeur de cette variable n’a jamais été modifiée, sa valeur est 1.

Les 2 comportements sont donc différents et impliquent des valeurs différentes suivants les scopes dans lesquels les affectations et les récupérations de valeurs sont faites.

var, let et const

Les mots-clé var, let et const permettent de déclarer une variable en limitant son scope: suivant le mot-clé utilisé, le scope de la variable sera très différent:

  • var permet de déclarer une variable dans le scope global ou dans le scope d’une fonction.
  • const et let permettent de déclarer une variable dans le scope d’un bloc de code.

Déclarer une variable avec ces mots-clé est possible avec la syntaxe suivante:

var <nom variable>;
let <nom variable>;

Avec const, une initialisation est obligatoire.

Pour initialiser une variable en même temps que sa déclaration, la syntaxe est:

var <nom variable> = <valeur d'initialisation>
let <nom variable> = <valeur d'initialisation>
const <nom variable> = <valeur d'initialisation>

Scope avec let et const

La gestion du scope est similaire entre let et const. La différence entre ces mots-clé est que:

  • let autorise des affectations d’une nouvelle valeur à une variable.
  • const interdit de nouvelles affectations.

Si on exécute:

const a = 3;
a = 5; // SyntaxError

On obtient une erreur de type 'SyntaxError: redeclaration of const a'.

let et const sont apparus à partir de ES6 et ont pour but d’avoir un comportement similaire à la plupart des autres langages: ils limitent le scope d’une variable à un bloc de code. Un bloc de code étant la portion de code délimitée par { ... }, par exemple:

  • Une fonction:
    function add(a, b) {
      // ...
    }
    
  • Une clause if...else, for etc:
    for (let i = 0; i < 10; i++) {
      // ...
    }
    
  • Le contenu des blocs dans un try...catch:
    try {
      // ...
    }
    catch (err) {
      // err est limité au bloc catch
    }
    
  • Une bloc simple:
    {
      // ...
    }
    
  • Une bloc nommé:
    namedBlock: {
      // ...
    }
    
  • Un objet:
    var obj = {
      // ...
    };
    

Ainsi avec let ou const, le scope d’une variable est limité au bloc de code dans lequel elle est définie et dans les blocs enfant.

Le comportement est similaire à la plupart des autres langages, une variable déclarée dans un bloc de code ne sera pas accessible en dehors de ce bloc et de ses blocs enfant (sauf en cas de shadowing).

Par exemple:

const a = 'OK';
if (a === 'OK') {
  let b = 5;
  console.log('Inside if: a=',a,' ;b=',b); // 'Inside if: a=OK ;b=5'
}

console.log('Outside if: a=',a); // le résultat est 'Outside if: a=OK'
console.log('Outside if: b=',b): // Reference Error

Dans le code plus haut, on peut voir 2 blocs de code: celui en dehors de la clause if et celui en dehors. Ainsi:

  • La variable a a été définie dans le bloc en dehors de la clause if, elle est donc disponible dans les 2 blocs.
  • La variable b a été définie dans le bloc du if, elle n’est accessible que dans ce bloc.

Scope avec var

Contrairement à let et const, le scope des objets avec var correspond aux fonctions. Les blocs de code ne limitent pas les scopes quand on déclare une variable avec var.

Par exemple, si on considère le code suivant:

var a = 'OK';
if (a === 'OK') {
  var b = 5;
  console.log('Inside if: a=',a,' ;b=',b);
}

console.log('Outside if: a=',a,' ;b=',b);

Le scope est le même pour les variables a et b même si b est déclaré dans le corps de la clause if. A l’intérieur ou à l’extérieur de la clause if, le résultat est le même:

Inside if: a=OK ;b=5
Outside if: a=OK ;b=5
Fonction, fonction anonyme, arrow function et IIFE

La notion de scope n’est pas modifiée suivant le type de fonction. Dans le cas de var, le scope des variables correspond aux fonctions.

Si on considère le code suivant:

var x = 3;
function namedFunction() {
  var x = 2;
  console.log(x); // 2
}

namedFunction();

console.log(x); // 3

La règle du lexical scope s’applique dans le cadre de cet exemple.

  • Fonction anonyme (i.e. function expression): le comportement est le même pour une fonction anonyme:
    var x = 3;
    var anonymousFunction = function() {
      var x = 2;
      console.log(x); // 2
    }
    
    anonymousFunction();
    
    console.log(x); // 3
    
  • IIFE (i.e. Immediatly Invoked Function Expression) qui sont exécutées au même moment que leur déclaration:
    var x = 3;
    (function() {
      var x = 2;
      console.log(x); // 2
    })();
    
    console.log(x); // 3
    
  • Arrow function: à partir de ES6:
    var x = 3;
    var arrowFunction = () => {
      var x = 2;
      console.log(x); // 2
    })();
    
    arrowFunction();
    console.log(x); // 3
    

Comment modifier le comportement du lexical scope ?

Il est possible de modifier le comportement du lexical scope en utilisant eval() ou le constructeur Function().

eval()

eval() permet d’évaluer une expression sous forme de chaîne de caractères.

Par exemple:

let result = eval('1 + 3');
console.log(result); // 4

Ainsi eval() exécute l’expression sous forme de chaîne de caractères: '1 + 3'.

Le scope d’une variable utilisée dans une expression évaluée par eval() dépend du scope dans lequel l’expression est évaluée et non en fonction du scope dans lequel la chaîne évaluée est construite.

Par exemple, si on exécute:

function a(expr) {
  eval(expr);
  console.log('x=',x); // 4
}

var x = 3;
let expr = 'var x = 4';
a(expr);

console.log('x=',x); // 3

Le scope utilisé pour évaluer x avec eval() est celui de la fonction a(). Même si l’expression expr a été construite à l’extérieure de a(), c’est le scope dans lequel eval() est exécuté qui sera utilisé.
Dans cet exemple, quand expr est évaluée dans le corps de la méthode a(), var x = 4 occulte la première déclaration de x pour définir une 2e variable nommée x dont la valeur est 4. À l’extérieur de a(), la variable x correspond à la variable déclarée avec var x = 3.

Comportement de eval() avec le mode strict

Si on utilise le mode strict, l’expression évaluée dans eval() possède un scope spécifique qui ne déborde pas du scope dans lequel eval() est exécuté.

Par exemple si on exécute le code suivant:

function a(expr) {
  "use strict"; 
  eval(expr); // Inside eval: 4
  console.log('x=',x); // 3
}

var x = 3;
let expr = "var x = 4; console.log('Inside eval: ',x)";
a(expr);

console.log('x=',x); // 3

Toutes les évaluation de x en dehors de eval() possède la valeur 3 car la variable utilisée est celle déclarée par var x = 3. Toutefois avec le mode strict, le scope de l’expression évaluée par eval() est limité, ainsi x possède la valeur 4 seulement dans l’expression évaluée.

Comportement de eval() avec const et let

Si on utilise const ou let pour déclarer une variable dans une expression évaluée par eval(), le scope est spécifique à l’expression évaluée, il ne déborde pas dans le scope dans lequel eval() est exécuté.

Par exemple, si on exécute le code suivant:

function a(expr) {
  eval(expr); // Inside eval: 4
  console.log('x=',x); // 3
}

let x = 3;
let expr = "let x = 4; console.log('Inside eval: ',x)";
a(expr);

console.log('x=',x); // 3

Toutes les évaluation de x en dehors de eval() possède la valeur 3 car la variable utilisée est celle déclarée par var x = 3. Le scope de l’expression évaluée par eval() est limité, x possède la valeur 4 seulement dans l’expression évaluée.

new Function()

La constructeur Function() permet de déclarer un objet de type Function. Utiliser ce constructeur permet d’évaluer une expression de la même façon qu’avec eval(). La syntaxe à utiliser est:

var objectFunction = new Function([arg1, arg2, ..., argN], expression);

Dans cet appel, expression contient la chaîne de caractères à évaluer.

On peut exécuter la fonction de cette façon:

objectFunction(arg1, arg1, ..., argN, '....');

Du point de vue de scope, cet objet ne se comporte ni comme une fonction normale, ni comme eval(): le scope parent d’un objet de type Function est le scope global et non le scope de la fonction parente.

Par exemple dans le cadre général, si une fonction est définie dans une autre fonction dite parente, le scope parent de la fonction est le scope de la fonction parente. C’est la règle du lexical scope.

Ainsi, si on exécute le code suivant:

function parent() {
  function a() {
    x = 2;
    console.log('x=',x); // x=2
  }

  var x = 3;
  a();

  console.log('x=',x,'window.x=',window.x); // x=2 window.x=undefined
}

parent();

La règle du lexical scope s’applique pour déterminer qu’elle est la déclaration d’une variable:

  • Dans le corps de la fonction a(): x désigne la variable déclarée avec var x = 3 donc partout x désigne la même variable.
  • Dans le corps de parent(): window.x est indéfinie puisqu’on a jamais affecté de valeur à la variable globale x.

Si on considère un code semblable utilisant un objet de type Function:

function parent() {
  var a = new Function("x = 2; console.log('x=',x);");
  var x = 3;

  a(); // x= 2

  console.log('x=',x,'window.x=',window.x); // x=3 window.x=2
}

parent();

Le scope parent de l’objet Function n’est pas la fonction parent() mais le scope global, ainsi:

  • Quand l’expression est évaluée x = 2 fera référence à x dans le scope parent c’est-à-dire le scope global. C’est la raison pour laquelle window.x renvoie la valeur 2.
  • L’expression évaluée dans le constructeur de Function() modifie x en tant que variable globale donc la variable déclarée par var x = 3 n’est pas modifiée et console.log('x=',x) dans le corps de parent() renvoie 3.

De même, le scope parent de eval() correpond, par défaut, au scope dans lequel eval() est exécuté. Ce qui est contraire au comportement de l’objet Function puisque son scope parent est le scope global.

this

this est un mot-clé très courant dans beaucoup de langage pour désigner l’instance courante d’une classe.

En Javascript, c’est aussi le sens de ce mot-clé dans le cadre des classes introduites à partir de ES6.

Par exemple:

class Person {
  constructor(firstName, lastName) {
    this.firstName = firstName;
    this.lastName = lastName;
  }

  logPerson() {
    console.log(this.firstName, this.lastName);
  }
}

var person = new Person('Uncle', 'Bob');
person.logPerson(); // Uncle Bob

Dans cet exemple, this renvoie bien à l’instance courante de la classe Person.

En Javascript, le plus souvent this est utilisé dans un cadre différent des classes. Au lieu de représenter l’instance d’une classe, il désigne un contexte dans lequel le code est exécuté. Suivant les cas d’usage de this, sa valeur peut être plus difficile à prévoir que dans le cas d’une classe.

Parmi les cas les plus courants d’utilisation de this, il y a celui du corps d’une fonction (cette fonction n’appartient pas à une classe ou à un objet). Dans le cas d’une fonction:

  • En mode non strict: this désigne le contexte global.
  • En mode strict: this est indéfini sauf si on indique explicitement sa valeur.

Par exemple:

function a() {
  return this;
}

console.log(a() === window); // true

Dans ce cas, this désigne le contexte global.

Dans la cas du mode strict, this est indéfini car sa valeur n’a pas été indiquée explicitement:

function a() {
  "use strict";
  return this;
}

console.log(a()); // undefined

Dans le cas d’un objet, this dans une fonction désigne implicitement cet objet:

var obj = {
  x: 5,
  a: function() {
    return this;
  }
};

console.log(obj.a().x === 5); // true

Dans ce cas, this désigne l’objet obj.

Arrow function

D’une façon générale, les arrow functions ont les mêmes comportements que les fonctions normales c’est-à-dire que this désigne le contexte global ou l’objet englobant.

Par exemple, si on considère l’exemple suivant:

var arrowFunction = () => this; // Référence d'une arrow function

console.log(arrowFunction() === window); // true

Dans le cas de l’exemple précédent, on exécute dans le contexte global donc this dans l’arrow function désigne le contexte global.

Dans le cas d’une arrow function déclarée dans un objet, il faut distinguer l’appel à une fonction et le cas d’une référence vers une fonction.

Par exemple, si on place cette fonction dans un objet:

var obj = {
  x: 5,
  a: function() {
    var arrowFunction = () => this;
    return arrowFunction; // On retourne la référence de la fonction
  }
};

var fn = obj.a(); // On récupère la référence de l'arrow function dans le contexte de l'objet obj.
console.log(fn().x === 5); // True
console.log(obj.a().x === 5); // False
console.log(obj.a()().x === 5); // True

Ainsi:

  • console.log(fn().x === 5) retourne true car fn est une référence vers l’arrow function dans le contexte de l’objet obj. Quand on exécuté fn(), on exécute l’arrow function et this désigne l’objet obj. Par suite obj.x contient la valeur 5.
  • console.log(obj.a().x === 5) retourne false car obj.a() contient la référence de l’arrow function, il faut exécuter obj.a()() pour exécuter réellement l’arrow function.

Comment affecter une valeur à this ?

On peut affecter une valeur à this avec les fonctions call(), apply() ou bind().

call() et apply()

call() et apply() permettent de contrôler la valeur de this en indiquant quel est le contexte d’exécution d’une fonction.

La syntaxe de ces méthodes est:

  • call():
    <fonction>.call(thisVar, [arg1, arg2,..., argN]);
    

    Avec <fonction> la fonction à exécuter; thisVar, la valeur de this et [arg1, arg2,..., ArgN], les arguments de la fonction à exécuter.
    En mode non strict, si thisVar est nul, alors this contient le contexte global.

  • apply():
    <fonction>.apply(thisVar, [tableau d'arguments]);
    

    Avec <fonction> la fonction à exécuter; thisVar, la valeur de this et [tableau d'arguments], les arguments de la fonction à exécuter sous forme d’un tableau.
    En mode non strict, si thisVar est nul, alors this contient le contexte global.

Si on considère l’exemple suivant:

function a(z, w) {
  return this.x + this.y + z +w;
}

var obj = {
  x: 5,
  y: 6
};

x = 1;
y = 2;

console.log(a.call(null, 3, 4)); // 10
console.log(a.apply(null, [3, 4])); // 10

Les 2 appels précédents permettent d’exécuter a() dans le contexte global puisque la valeur indiquée de this est nulle. Dans le contexte global, x et y contiennent respectivement les valeurs 1 et 2.

Si on exécute:

console.log(a.call(obj, 3, 4)); // 18
console.log(a.apply(obj, [3, 4])); // 18

this contient obj donc a() est exécuté dans le contexte de obj. x et y contiennent respectivement les valeurs 5 et 6.

Si on modifie le code pour activer le mode strict:

function a(z, w) {
  "use strict";
  return this.x + this.y + z +w;
}

var obj = {
  x: 5,
  y: 6
};

x = 1;
y = 2;

console.log(a.call(null, 3, 4)); // TypeError: this is null
console.log(a.apply(null, [3, 4])); // TypeError: this is null

Si le mode strict est activé et que this contient null, sa valeur n’est pas remplacée par le contexte global. a() ne peut pas effectuer l’addition car this est nul.

bind()

A partir de ES5, bind() permet aussi de préciser une valeur de this en générant une référence vers une nouvelle fonction. Cette nouvelle fonction sera liée au contexte indiqué lors de l’exécution de bind().
La syntaxe de bind() est:

let <référence fonction> = <fonction>.bind(thisVar, [arg1, arg2,..., argN]);

Avec <fonction> la fonction à exécuter; thisVar, la valeur de this et [arg1, arg2,..., ArgN], les arguments de la fonction à exécuter.

Avec bind(), le cas d’usage est un peu différent de call() et apply(). Si on reprend l’exemple précédent:

function a(z, w) {
  return this.x + this.y + z +w;
}

var obj = {
  x: 5,
  y: 6
};

x = 1;
y = 2;

var boundA = a.bind(null, 3, 4); // On définit une nouvelle référence sans indiquer de valeur pour this
console.log(boundA()); // 10

Si on ne précise pas de valeur pour this, c’est le contexte global qui est utilisé. Dans cet exemple, dans le corps de a(), this fait référence au contexte global, x et y ont pour valeur, respectivement, 1 et 2.

Si on indique une autre valeur pour this:

var boundA = a.bind(obj, 3, 4);
console.log(boundA()); // 18

Dans cet appel, this fait référence à l’objet obj donc x et y ont pour valeur, respectivement 5 et 6.

Enfin dans le cas du mode strict, si on ne précise pas de valeur pour this, sa valeur restera nulle. Si on reprend l’exemple précédent:

function a(z, w) {
  "use strict";
  return this.x + this.y + z +w;
}

var obj = {
  x: 5,
  y: 6
};

x = 1;
y = 2;

var boundA = a.bind(null, 3, 4);
console.log(boundA()); // TypeError: this is null

Avec le mode strict, this est nul dans le corps de la fonction a() d’où l’erreur.

setTimeout()

Avec setTimeout(), la valeur par défaut de this est le contexte global. Ce comportement peut prêter à confusion quand on utilise this dans une fonction exécutée par setTimeout().

Par exemple:

var obj = {
  x: 5,
  a: function() {
    console.log(this.x);
  }
};

var x = 3;

obj.a(); // 5

Dans ce dernier appel, this fait référence à l’objet obj puisque a() se trouve dans cet objet.

En revanche si on exécute le code suivant, this fait référence au contexte global:

setTimeout(obj.a, 100); //3

C’est la 3 qui s’affiche car c’est la variable x déclarée dans le contexte global qui est utilisée.

La solution peut consister à utiliser une arrow function (disponible à partir de ES6):

setTimeout(() => obj.a(), 100); // 5

Cet appel permet de forcer l’appel dans le contexte de l’objet obj.

On peut aussi utiliser bind() (à partir de ES5) pour indiquer explicitement la valeur de this:

var boundA = obj.a.bind(obj);
setTimeout(boundA, 100); // 5

Enfin, on peut utiliser une variable locale et encapsuler l’appel à setTimeout dans la fonction déclarée dans l’objet obj:

var obj = {
  x: 5,
  a: function() {
    var self = this;
    setTimeout(function() {
      console.log(self.x);
    }, 100);
  }
};

var x = 3;

obj.a(); // 5

Closure

Dans le cadre des closures (i.e. fermetures), le comportement de this peut prêter à confusion car Javascript perd le scope de this quand il est utilisé dans une fonction qui se trouve dans une autre fonction.

Qu’est ce qu’une closure ?

Avant de rentrer dans les détails de this dans le cadre d’une closure, on peut rappeler la définition d’une closure (les closures ne sont pas spécifiques à Javascript):

D’après MDN web docs:

“Une fermeture correspond à la combinaison entre une fonction et l’environnement lexical au sein duquel elle a été déclarée. En d’autres termes, une fermeture donne accès à la portée d’une fonction externe à partir d’une fonction interne. En Javascript, une fermeture est créée chaque fois qu’une fonction est créée.

L’exemple le plus courant d’une closure est celui intervenant dans le cadre d’une boucle:

for (var i = 1; i < 5; i++) {
  setTimeout(function() {
    console.log(i);
  }, 100);
}

A l’exécution, on s’attendrait à voir s’afficher 1, 2, 3, etc… toutefois on voit 5 fois s’afficher 6. Ce comportement s’explique par le fait que la fonction anonyme se trouvant dans setTimeout() utilise le scope de la fonction externe, or dans le scope externe i varie de 1 à 6. Étant donné que setTimeout() retarde l’exécution de la fonction anonyme pendant 100 ms, les valeurs affichées correspondent à la dernier valeur de i.

Pour empêcher ce comportement, il faudrait que la fonction anonyme utilise une variable dont le scope ne dépend pas de la fonction externe. Par exemple, si on utilise une IIFE exécutée à chaque boucle et si on utilise une variable locale à l’IIFE, on pourra utiliser une variable dont la valeur est spécifique à chaque boucle:

for (var i = 1; i < 5; i++) {
  // IIFE exécutée à chaque boucle
  (function() {
    var j = i; // Variable locale
    setTimeout(function() {
      console.log(j); // On utilise la variable locale
    }, 100);
  })();
}

A l’exécution, on affiche les différentes valeurs: 1, 2, 3, etc…

Conséquences avec this

Comme on l’a indiqué plus haut:

En Javascript, une fermeture est créée chaque fois qu’une fonction est créée“.

Ainsi dans le cadre de l’exemple suivant, la closure (i.e. fermeture) entraîne le comportement du lexical scope: pour connaître la valeur d’une variable, le moteur vérifie le scope courant puis les scopes parent jusqu’à ce qu’il trouve la déclaration.

Par exemple:

function a() {
  var x = 5;
  var nestedA = function() {
    console.log(x); // 5
  }
  
  nestedA();
}

a();

La valeur affichée sera 5 dans le corps de nestedA() car cette fonction a accès au scope de la fonction externe c’est-à-dire celui de a(). x étant déclarée dans le corps de a() alors la valeur affichée sera 5.

On pourrait s’attendre à ce que le comportement de this soit identique, par exemple:

var obj = {
  x: 5,
  a: function() {
    console.log(this.x); // 5

    var nestedA = function() {
      console.log(this.x); // undefined
    };
    nestedA();
  }
};

obj.a();

On pourrait s’attendre à ce que this.x dans nestedA() contienne la valeur 5. Ce n’est pas le cas car le scope de this est perdu quand une fonction se trouve dans une autre fonction. Dans nestedA(), this ne correspond pas à l’objet obj (comme c’est la cas dans le corps de a()) mais au scope global. Ainsi, this.x dans nestedA() est indéfinie.

Le comportement est le même si on utilise une IIFE:

var obj = {
  x: 5,
  a: function() {
    console.log(this.x); // 5

    (function() {
      console.log(this.x); // undefined
    })();
  }
};

obj.a();

Par contre avec les arrow functions implémentées à partir de ES6, le comportement est plus standard:

var obj = {
  x: 5,
  a: function() {
    console.log(this.x); // 5

    var nestedA = () => {
      console.log(this.x); // 5
    };
    nestedA();
  }
};

obj.a();

Dans le cadre des arrow functions, this correspond bien à l’objet obj.

Hoisting avec var

L’utilisation de var pour déclarer des variables entraîne un comportement qui peut prêter à confusion: l’hoisting (i.e. hisser). Le principe de ce comportement est le suivant:

  1. Le moteur Javascript effectue 2 passes sur le code avant de l’exécuter:
    • Une 1ère passe pour référence toutes les déclarations de variables, de fonctions et les définitions des fonctions.
    • Une 2e passe permet d’affecter à ces objets leur valeur d’initialisation (s’il y en a une).
  2. Ces 2 passes entraînent que l’ordre de traitement des lignes de code par le moteur Javascript n’est pas toute à fait le même que celui du script:
    • Les déclarations sont traitées avant les affectations (même si dans le script l’affectation d’une variable est placée avant la déclaration).
    • Les déplacements des lignes traitées sont effectués à l’intérieur d’un même scope et se limite au scope d’une fonction.
    • Les déclarations de fonction sont déplacées avant les autres objets.

Par exemple, si on exécute le code suivant:

function a() {
  x = 5;
  var x;
  console.log(x); // 5
  console.log(window.x); // undefined
}

a();

On pourrait penser qu’étant donné l’ordre des lignes dans a(), x = 5 correspondrait à l’affectation de 5 à la variable globale x. Mais le comportement de hoisting entraîne la modification de l’ordre de traitement des lignes par le moteur Javascript. Dans la réalité, les lignes sont exécutées de cette façon:

function a() {
  var x;
  x = 5;
  console.log(x); // 5
  console.log(window.x); // undefined
}

a();

A l’intérieur du scope de la fonction a(), var x est traité avant x = 5.

Pas d’hoisting avec let ou const

Si on exécute:

function a() {
  x = 5; // ReferenceError: can't access lexical declaration 'x' before initialisation
  let x;
  console.log(x);
  console.log(window.x);
}

a();

Une erreur explicite indique qu’on peut pas inverser l’ordre des lignes, la déclaration doit se trouver avant l’initialisation.

Hoisting valable pour les fonctions anonymes et les arrow functions
Le même comportement d’hoisting est valable pour les fonctions anonymes (i.e. function expressions), par exemple:

a = function() {
  return 'from function expression';
}

var a;

console.log(a()); // from function expression
console.log(window.a()); // window.a is not a function

Même comportement que précédemment, la déclaration de la fonction a() est déplacée par hoisting.

Le comportement est le même pour les arrow functions:

a = () => {
  return 'from arrow function';
}

var a;

console.log(a()); // from arrow function
console.log(window.a()); // window.a is not a function

Les déclarations de fonctions sont déplacées avant les autres objets
Les déclarations des fonctions sont traitées prioritairement par rapport aux déclarations de variables.
Si on exécute le code suivant:

console.log(a()); // from a()

a = function() {
  return 'from function expression';
}

var a;

function a() {
  return 'from a()';
}

L’hoisting déplace le code de cette façon:

function a() {
  return 'from a()';
}

console.log(a()); // from a()

a = function() {
  return 'from function expression';
}

En résumé…

D’une façon générale, il faut éviter de déclarer des variables dans le scope global en javascript. Pour que la portée d’une variable soit limitée, on utilise les mots-clé var, let ou const:

  • var est compatible avec toutes les versions de Javascript toutefois il entraîne certains comportements qui ne sont pas standards.
  • let est apparu à partir de ES6. La portée d’une variable déclarée avec ce mot-clé est standard par rapport aux autres langages.
  • const est similaire à let à la différence qu’il n’autorise pas de nouvelles affectations à une variable.

Le scope d’une variable se limite à un bloc de code pour let et const. Avec var, le scope correspond à une fonction, un bloc de code ne limite pas la portée.

Lexical scope
Le moteur Javascript utilise le lexical scope pour déterminer la déclaration d’une variable. Suivant les différents mots-clé utilisés la notion de scope ne sera pas la même toutefois la recherche de la déclaration d’une variable se fait de la même façon:

  • Lorsque le moteur d’exécution exécute la déclaration d’une variable, le scope de la variable sera celui dans lequel se trouve la déclaration.
  • Lorsque le moteur d’exécution cherche la valeur d’une variable, il recherche sa déclaration dans le scope courant. Si aucune déclaration n’est trouvée, le moteur cherche dans les scopes parent. Si aucune déclaration n’est trouvée alors la variable appartient au scope global.
  • Si une variable est déclarée dans un scope parent et qu’une variable est déclarée avec le même nom dans un scope enfant, la variable dans le scope parent sera occultée par celle du scope enfant. Ce comportement correspond au shadowing.

eval() et new Function()
On peut modifier le comportement du lexical scope avec eval() qui permet d’évaluer une expression sous forme de chaîne de caractères:

  • Le scope de l’expression évaluée par eval() est celui dans lequel eval() est exécuté. L’expression peut être construite dans un scope différent, toutefois c’est au moment de l’exécution que le scope de l’expression sera confondu avec le scope dans lequel eval() est exécuté.
  • En mode strict, le scope de l’expression évaluée par eval() est limité à eval(), il n’est pas confondu avec le scope dans lequel eval() est exécuté.

Le constructeur new Function() permet aussi d’évaluer une expression sous forme de chaîne de caractères. La différence avec eval() est que le scope parent d’un objet de type Function est le scope global et non le scope dans lequel new Function() est exécuté.

this
La valeur de this dépend du contexte dans lequel il est utilisé:

  • Dans une classe, this est l’instance de cette classe.
  • Dans un objet, this est l’instance de cet objet.
  • Dans une fonction n’appartenant pas à un objet:
    • En mode non strict, this est le contexte global
    • En mode strict, this est indéfini.

On peut affecter explicitement une valeur à this quand on exécute une fonction en utilisant:

  • call(): <fonction>.call(thisVar, [arg1, arg2,..., argN]);
  • apply(): <fonction>.apply(thisVar, [tableau d'arguments]);
  • bind() qui permet de créer une nouvelle référence vers une fonction: let <référence fonction> = <fonction>.bind(thisVar, [arg1, arg2,..., argN]);

Si on exécute une fonction avec setTimeout(), par défaut, this fait référence au contexte global.

Hoisting

  • Si on déclare une variable avec var, le comportement d’hoisting du moteur Javascript peut entraîner un déplacement des lignes de code d’un script pour prendre en compte la déclaration d’une variable avant son initialisation. Même si dans le script initial, l’initialisation se trouve avant la déclaration, le moteur prendra en compte d’abord la déclaration.
  • Il n’y a pas d’hoisting si on utilise let ou const.
  • L’hoisting est valable aussi pour les fonctions anonymes ou les arrow functions.
  • Les déclarations de fonctions sont déplacées avant les autres objets.
Références
Share on FacebookShare on Google+Tweet about this on TwitterShare on LinkedInEmail this to someonePrint this page

Personnaliser la détection de changements dans une application Angular

@raychelsnr

Le but de cet article est d’expliquer quelques caractéristiques de la détection automatique de changements dans une application Angular. Ensuite, on indiquera comment on peut personnaliser cette détection pour améliorer les performances ou pour la solliciter de façon explicite.
Un autre article permet de rentrer dans les détails du fonctionnement de cette détection de changements: Fonctionnement de la détection de changement.

Une application Angular peut être impactée par des évènements provenant du browser comme:

  • Les évènements Javascript comme les clicks, keydown, submit, input etc… (Référence des événements),
  • Les évènements XHR provenant de l’objet XmlHttpRequest,
  • Les évènements provenant de Timers comme setTimeout() ou setInterval().

Certains de ces évènements peuvent entraîner des modifications sur des éléments de l’application et nécessiter une mise à jour des vues de certains composant. La détection automatique des changements provoqués par ces évènements permet de mettre à jour les éléments dans le DOM quand cela est nécessaire.

Ainsi, les changements pouvant impacter la vue d’un composant peuvent provenir de:

  • La mise à jour d’un binding dans un composant,
  • La mise à jour d’une expression dans une interpolation d’un template.

D’autres changements peuvent impacter des bindings se trouvant dans la classe du composant comme:

  • Les requêtes de vue avec @ViewChild() ou @ViewChildren(),
  • Les requêtes sur du contenu projeté avec @ContentChild() ou @ContentChildren().
  • Des bindings avec un élément natif hôte concernant des propriétés @HostBinding() ou des évènements avec @HostListener().

Lorsqu’au moins une des sources impacte un élément d’une vue, la détection de changements est exécutée en comparant les références des anciens bindings et les nouveaux de façon à détecter un changement. Dans le cas où un changement est détecté, les éléments natifs correspondant dans le DOM sont modifiés (pour plus de détails, voir le fonctionnement de la détection de changements).

Par exemple, si on considère le composant suivant:

Template
(example.component.html)
<p>Example composant</p>
<p>Click count: {{clickCount}}</p>
Classe du composant
(example.component.ts)
import { Component, HostListener } from '@angular/core';

@Component({
    selector: 'app-example',
    templateUrl: './example.component.html',
    styleUrls: ['./example.component.css']
})
export class ExampleComponent {
    clickCount = 0;

    @HostListener('click') onHostClicked(triggeredEvent): void {
        this.clickCount++;
    }
}
Style CSS
(example.component.css)
:host {
    width: 300px;
    height: 150px;
    background-color: lightblue;
    display: block;
    padding: 10px;
}

Dans cet exemple, on utilise @HostListener() pour s’abonner à l’évènement click de l’élément natif de la vue du composant de façon à effectuer un traitement pour chaque click sur cet élément.

A l’exécution, la vue de ce composant se présente de cette façon:

Exemple de détection de changements avec click

Si on clique sur la zone en bleu, le compteur s’incrémente. Pour que la propriété clickCount soit incrémentée, l’évènement est propagé de cette façon dans Angular:

  1. Un click sur un élément natif déclenche un évènement click.
  2. Cet évènement se propage dans Zone.js.
  3. Zone.js déclenche une callback correspondant à du code Angular qui lancera la méthode tick().
  4. La méthode tick() permet de déclencher la détection de changements dans l’application en commençant par le composant Root.
  5. La détection de changements est déclenchée dans le composant Example ce qui va entraîner la mise à jour du binding initié par @HostListener(). Cette mise à jour met à jour la propriété clickCount.
  6. En parallèle, le template est mis à jour et l’expression d’interpolation {{clickCount}} est évaluée ce qui modifie la valeur (car la propriété clickCount a changé de valeur).
  7. Une comparaison entre la nouvelle valeur de l’expression d’interpolation et l’ancienne permet d’indiquer qu’un changement a été détecté.
  8. Le changement permet d’effectuer la mise à jour de l’objet natif dans le DOM.

Détection des changements et cycle de vie des composants

La détection des changements est liée à l’exécution des callbacks du cycle de vie des composants (i.e. lifecycle hooks). Ainsi, la vérification des changements et la mise à jour éventuelle des éléments du DOM sont effectuées dans un certain ordre. Modifier un binding de façon trop tardive par rapport à la détection de changements dans le cycle de vie d’un composant peut ne pas entraîner de modifications dans la vue.

Le cycle de vie d’un composant est, dans l’ordre de déclenchement:

  • A l’initialisation du composant:
    1. ngOnChanges(): cette callback est exécutée si le composant contient des propriétés en entrée (notamment avec le décorateur @Input()). Si cette callback est implémentée sans paramètre, elle sera déclenchée autant de fois qu’il y a de propriétés en entrée du composant.

      Si la callback est implémentée avec un argument de type SimpleChanges:

      void ngOnChanges(changes: SimpleChanges): void {}
      

      Elle sera déclenchée une seule fois.

    2. ngOnInit(): déclenchée après l’exécution du constructeur. Elle permet d’initialiser le composant avec le 1er affichage des données de la vue ayant un binding avec des propriétés de la classe du composant. Cette callback est déclenchée une seule fois à l’initialisation du composant même si ngOnChanges() n’est pas déclenchée.
    3. ngDoCheck() permet d’indiquer des changements si Angular ne les a pas détecté.
    4. ngAfterContentInit() est déclenchée à l’initialisation après la projection de contenu. Elle est déclenchée même s’il n’y a pas de contenu à projeter.
    5. ngAfterContentChecked(): déclenchée après la détection de changement dans le contenu projeté. Cette callback est déclenchée même s’il n’y a pas de projection de contenu.
    6. ngAfterViewInit(): déclenchée après l’initialisation de la vue du composant et après l’initialisation de la vue des composants enfant.
    7. ngAfterViewChecked() est déclenchée après détection d’un changement dans la vue du composant et dans la vue des composants enfant.
    8. ngOnDestroy() est déclenchée avant la destruction du composant.
  • A chaque détection de changements:
    1. ngOnChanges() si les paramètres en entrée du composant sont modifiés.
    2. ngDoCheck()
    3. ngAfterContentChecked() est déclenchée même s’il n’y a pas de contenu projeté.
    4. ngAfterViewChecked().

Lors de l’exécution de la détection de changements, la mise à jour des éléments est effectuée de la façon suivante par rapport aux callbacks du cycle de vie:

  1. Exécution des callbacks ngOnChanges(), ngOnInit() et ngDoCheck(). La callback ngOnInit() est exécutée seulement à l’initialisation du composant.
  2. Exécution de la fonction contentQueries: cette fonction permet de mettre à jour les requêtes effectuées sur le contenu projeté de la vue avec @ContentChild() ou @ContentChildren().
  3. Exécution des callbacks ngAfterContentInit() et ngAfterContentChecked(): l’exécution de ces callbacks vient clôturer la mise à jour des requêtes effectuées sur le contenu projeté. La callback ngAfterContentInit() est exécutée seulement à l’initialisation du composant.
  4. Exécution de la fonction hostBindings: cette fonction permet d’affecter les bindings provenant de l’élement HTML hôte avec @HostBinding().
  5. Exécution de la fonction template: elle servira à mettre à jour le DOM avec tous les éléments dynamiques de la vue.
  6. Exécution de la fonction viewQuery: cette étape permet de mettre à jour les requêtes effectuées sur la vue du composant avec @ViewChild() et @ViewChildren().
  7. Exécution des callbacks ngAfterViewInit() et ngAfterContentChecked(), la callback ngAfterViewInit() est exécutée seulement à l’initialisation du composant.

Erreur “ExpressionChangedAfterItHasBeenCheckedError”

Dans le cas où une modification est effectuée trop tardivement, une erreur du type ExpressionChangedAfterItHasBeenCheckedError peut se produire en mode développement.
Pour davantage de détails, voir cdiese.fr/angular-change-detection.

Au cours de son exécution, l’algorithme de détection de changements ne s’applique pas qu’à un composant, il parcourt aussi toutes les directives enfant de ce composant. Un composant parent peut être lié aux directives enfants de multiples façons comme par exemple:

  • Un binding entre une propriété et un paramètre d’entrée du composant enfant,
  • Une requête sur un contenu projeté dans le composant enfant avec @ContentChild(),
  • Une requête sur le composant natif hôte du composant enfant avec @HostListener().
  • Etc…

Toutes ces fontionnalités entre un composant parent et un composant enfant imposent à l’algorithme de détection de prendre en compte ce lien et surtout un ordre dans la mise à jour des objets dans le DOM.

Au niveau d’un composant, du point de vue de la détection de changements on pourrait résumer le lien avec son parent avec ce schéma (pour davantages de détails, voir le fonctionnement de la détection de changements):

Ce schéma permet de montrer que certains éléments d’un composant sont mis à jour de façon concomitante avec des traitements du composant parent.

Ordre d’exécution de la détection de changements dans l’arbre des composants

Etant donné les liens entre un composant parent et ses enfants, à l’échelle de plusieurs composants, l’ordre d’exécution des traitements de la détection de changements dans l’arbre des composants n’est pas forcément trivial.

Si on reprend le schéma plus haut permettant de schematiser l’exécution de l’algotihme de détection de changements entre un composant parent et un composant enfant, on peut le séparer en 2 parties: avant et après la boucle récursive de parcours des composants enfant:

Ces 2 parties amènent 2 comportements différents qui entraînent un parcours différents de l’arbre des composants:

  • Avant la boucle récursive: les traitements et exécution des callbacks du cycle de vie sont exécutés dans l’arbre des composants parent vers les composants enfant:

    Ainsi les callbacks ngOnChanges(), ngOnInit(), ngDoCheck(), ngAfterContentInit(), ngAfterContentChecked() et la fonction template permettant de mettre à jour le DOM sont exécutées dans cette partie. Dans le cadre de l’exemple, elles seront déclenchées dans cet ordre: d’abord les composants parent et ensuite les composants enfant.

  • Après la boucle récursive: les traitements et exécution des callbacks sont exécutés des composants enfant vers les composants parents en allant d’abord vers le composant le plus profond dans l’arbre:

    Les callbacks ngAfterViewInit() et ngAfterViewChecked() sont exécutées dans cette partie. Dans le cadre de l’exemple, elles seront déclenchées dans cet ordre: d’abord les composants enfant et ensuite les composants parent.

Contourner la détection de changements

Dès qu’un évènement notifie Zone.js, il déclenche la détection de changements dans Angular. Si on souhaite exécuter du code sans que la détection de changements ne soit sollicitée, on peut utiliser l’objet NgZone.

En injectant un objet de type NgZone dans le constructeur d’un composant, on obtient un service permettant d’effectuer des traitements sur la zone parente de la vue du composant:

import { Component, NgZone } from '@angular/core';

@Component({
    // ...
})
export class ExampleComponent {
    constructor(private zone: NgZone) {}
}

Le service NgZone permet d’exécuter des lambdas avec les fonctions:

  • runOutsideAngular() pour exécuter du code en dehors de la détection de changements Angular.
  • run() exécute du code dans une zone Angular. La détection de changements sera exécutée.
  • runTask() permet d’exécuter du code dans une zone Angular de façon asynchrone. La détection de changements sera exécutée.

Par exemple, si on considère le composant suivant:

Template
<p>Example composant</p>
<p>Random number: {{randomNumber}}</p>
Classe du composant
import { Component, NgZone, OnInit } from '@angular/core';

@Component({
    selector: 'app-example',
    templateUrl: './example.component.html'
})
export class ExampleComponent implements OnInit {
    randomNumber: number;

    constructor(private zone: NgZone) {}

    ngOnInit(): void {
        setInterval(() => {
            this.randomNumber = Math.random();
        }, 1000);
    }
}

Au moyen de setInterval(), on peut mettre à jour la propriété randomNumber toutes les secondes avec un nombre aléatoire. Une interpolation dans le template du composant permet d’afficher la propriété randomNumber dans la vue.

A l’exécution, on peut voir que le nombre est mis à jour toutes les secondes:

Exemple de détection de changements avec setInterval()

La propagation de l’évènement est effectuée de cette façon:

  1. La callback de la méthode setInterval() est déclenchée toutes les secondes.
  2. L’exécution de la callback permet de mettre à jour la propriété randomNumber.
  3. Cet évènement se propage dans Zone.js.
  4. La suite de la détection de changements s’exécute le long de l’arbre des composants.

Si on modifie la méthode ngOnInit() dans la classe du composant de cette façon:

ngOnInit(): void {
    this.zone.runOutsideAngular(
        setInterval(() => {
            this.randomNumber = Math.random();
        }, 1000);
    );
}

Après cette modification, la mise à jour de la vue n’est plus effectuée. La propriété est bien mise à jour par setInterval() toutefois la détection de changements n’est pas déclenchée:

Mettre à jour la vue directement

Quand on utilise NgZone.runOutsideAngular(), il est possible de mettre à jour la vue sans utiliser la détection de changement en intervenant directement dans l’objet natif de la vue.

Par exemple, si on reprend le composant Example introduit plus haut, on peut utiliser @ViewChild() avec une variable référence dans le template pour effectuer une requête sur la vue de façon à pouvoir accéder à l’objet natif dans lequel on veux mettre à jour l’affichage. L’implémentation deviendrait:

Template
<p>Example composant</p>
<p #random></p>
Classe du composant
import { Component, NgZone, OnInit, ViewChild, ElementRef } 
  from '@angular/core';

@Component({
    selector: 'app-example',
    templateUrl: './example.component.html'
})
export class ExampleComponent implements OnInit {
    randomNumber: number;

    @ViewChild('random', { static: true }) 
        random: ElementRef<HTMLParagraphElement>

    constructor(private zone: NgZone) {}

    ngOnInit(): void {
        this.zone.runOutsideAngular(
            setInterval(() => {
                this.randomNumber = Math.random();
                this.random.nativeElement.textContent = 
                    `Random number: ${this.randomNumber}`;
            }, 1000);
        );
    }
}

Ainsi:

  • Ce code permet d’effectuer une requête sur la vue du composant avec @ViewChild() pour récupérer un objet identifié avec la variable référence #random dans le template. Cet objet permettra d’accéder à l’objet natif correspondant.
  • On utilise l’option { static: true } dans @ViewChild() de façon à ce que la requête soit exécutée lors de la construction des éléments statiques de la vue.
  • Avec la propriété nativeElement, on peut accéder à l’objet natif correspond à l’élément p de façon à modifier son contenu.

A l’exécution, on peut voir que le nombre est mise à jour chaque seconde dans la vue du composant.

Déclencher la détection de changements dans toute l’application

A l’opposé, on peut volontairement lancer l’exécution de la détection de changements de toute l’application en injectant l’objet ApplicationRef et en appelant ApplicationRef.tick().

Par exemple, si on réutilise l’exemple précédent de ce composant:

Template
<p>Example composant</p>
<p>Random number: {{randomNumber}}</p>
Classe du composant
import { Component, NgZone, OnInit } from '@angular/core';

@Component({
    selector: 'app-example',
    templateUrl: './example.component.html'
})
export class ExampleComponent implements OnInit {
    randomNumber: number;

    constructor(private zone: NgZone) {}

    private updateRandomNumber(): void {
        this.randomNumber = Math.random();
    }

    ngOnInit(): void {
        this.zone.runOutsideAngular(
            setInterval(() => {
                this.updateRandomNumber();
            }, 1000);
        );
    }
}

Cet exemple ne permet pas de mettre à jour la vue avec la propriété randomNumber car NgZone.runOutsideAngular() ne déclenche pas la détection de changements.

Pour forcer la détection de changements à chaque exécution de la lambda dans setInternal(), on peut rajouter ApplicationRef.tick(). On modifie la méthode ngOnInit() dans ce sens:

import { Component, NgZone, OnInit, ApplicationRef } from '@angular/core';

@Component({
    selector: 'app-example',
    templateUrl: './example.component.html'
})
export class ExampleComponent implements OnInit {
    randomNumber: number;

    constructor(private zone: NgZone, private ApplicationRef: ApplicationRef) {}

    private updateRandomNumber(): void {
        this.randomNumber = Math.random();	

        this.applicationRef.tick();
    }

    ngOnInit(): void {
        this.zone.runOutsideAngular(
            setInterval(() => {
                this.updateRandomNumber();
            }, 1000);
        );
    }
}

Dans ce code, this.applicationRef.tick() permet de lancer l’exécution de la détection de changements à chaque exécution de la lambda dans setInterval(). A l’exécution, on peut voir que la vue est correctement mise à jour: la valeur du nombre change toutes les secondes.

Personnaliser la détection de changements

2 méthodes permettent de mettre à jour une vue en cas de changements:

  • Détecter les changements de façon automatique: l’algorithme de détection effectue les comparaisons nécessaires pour savoir quand un changement nécessite une mise à jour de propriétés dans le DOM. L’algorithme détecte le changement de valeur sans savoir d’où provient ce changement.
  • Mettre à jour la vue à la demande: en cas de changements, on peut solliciter explicitement la détection de changements pour que la vue soit mise à jour à la demande. L’algorithme de détection de changements et la mise à jour des éléments natifs du DOM sont indissociables. On ne peut pas exécuter l’un sans l’autre. En revanche, il est possible de désactiver la détection automatique pour privilégier une exécution à la demande pour maitriser la mise à jour d’une vue ou pour améliorer les performances d’exécution.

Dans cette partie, on va expliciter des méthodes pour désactiver la détection automatique de changements ou pour lancer explicitement son exécution.

ChangeDetectionStrategy

Modifier le paramètre changeDetection d’un composant (dans le décorateur @Component()) permet de modifier le comportement de la détection:

  • ChangeDetectionStrategy.Default: déclenchement automatique de la détection de changements, c’est le comportement par défaut. La détection est exécutée pour le composant et ses enfants de façon automatique.
  • ChangeDetectionStrategy.OnPush: désactive la détection automatique des changements pour le composant et pour ses enfants. Il faut déclencher la détection de la façon explicite avec ChangeDetectorRef ou ApplicationRef.

Modifier le paramètre changeDetection permet de désactiver la détection pour toutes les instances du composant et pour toute sa durée de vie. Cette implémentation est moins flexible qu’en utilisant ChangeDetectorRef (même si on exécute ChangeDetectorRef.reattach(), la détection automatique restera désactivée).

Par exemple, si on modifie le paramètre changeDetection dans le cas du composant Example, l’implémentation devient:

@Component({
    selector: 'app-example',
    templateUrl: './example.component.html',
    changeDetection: ChangeDetectionStrategy.OnPush
})
export class ExampleComponent implements OnInit {
    // ...
}

ChangeDetectorRef

En injectant ChangeDetectorRef dans un composant, on peut personnaliser la détection de changements pour:

  • Désactiver son exécution automatique avec ChangeDetectorRef.detach(),
  • Ré-activer la détection automatique avec ChangeDetectorRef.reattach(),
  • Forcer l’exécution de la détection avec ChangeDetectorRef.detectChanges(),
  • Vérifier si des changements sont détectés avec ChangeDetectorRef.checkNoChanges() ou
  • Marquer la vue du composant pour que la détection de changements soit effectuée avec ChangeDetectorRef.markForCheck().

On peut injecter un objet de type ChangeDetectorRef en utilisant le moteur d’injection de dépendances Angular, par exemple:

Template
<p>Example composant</p>
Classe du composant
import { Component, ChangeDetectorRef } from '@angular/core';

@Component({
    selector: 'app-example',
    templateUrl: './example.component.html'
})
export class ExampleComponent {
    constructor(private changeDetectorRef: ChangeDetectorRef) {}
}

L’instance injectée de l’objet de type ChangeDetectorRef est spécifique à la vue du composant.

Désactiver/Activer la détection de changements

La détection de changements peut être désactivée ou activée par programmation de façon à optimiser les performances d’une vue. Lorsque la détection est désactivée pour un composant donné, la détection ne sera plus exécutée de façon automatique sur la vue du composant et sur les vues des composant enfant:

Pour exécuter la détection de changements à la demande, il faudra explicitement exécuter ChangeDetectorRef.detectChanges() ou ChangeDetectorRef.markForCheck() sur le composant pour lequel la vue doit être mise à jour. En cas d’exécution explicite de la détection pour un composant donné, la détection sera effectuée sur le composant et sur toutes ses directives enfants.

Par exemple, si on considère un composant pour lequel on place un Timer qui permet de mettre à jour périodiquement la valeur d’une propriété de type number et qu’on affiche cette propriété sur la vue en utilisant une interpolation:

Template
<p>Example composant</p>
<p>Random number: {{randomNumber}}</p>
Classe du composant
import { Component, OnInit, ChangeDetectorRef } from '@angular/core';

@Component({
    selector: 'app-example',
    templateUrl: './example.component.html'
})
export class ExampleComponent implements OnInit {
    randomNumber: number;

    constructor(private changeDetectorRef: ChangeDetectorRef) {}

    ngOnInit(): void {
        setInterval(() => {
            this.randomNumber = Math.random();
        }, 1000);
    }
}

Si on exécute ce code, on pourra voir que l’affichage est mise à jour toutes les secondes.

On ajoute 2 boutons pour désactiver et activer la détection de changements:

Template
<p>Example composant</p>
<p>Random number: {{randomNumber}}</p>
<p><button (click)='disableChangeDetection()'>Disable change detection</button></p>
<p><button (click)='enableChangeDetection()'>Enable change detection</button></p>
Classe du composant
import { Component, OnInit, ChangeDetectorRef } from '@angular/core';

@Component({
    selector: 'app-example',
    templateUrl: './example.component.html'
})
export class ExampleComponent implements OnInit {
    randomNumber: number;

    constructor(private changeDetectorRef: ChangeDetectorRef) {}

    ngOnInit(): void {
        setInterval(() => {
            this.randomNumber = Math.random();
        }, 1000);
    }

    disableChangeDetection(): void {
        this.changeDetectorRef.detach();
    }

    enableChangeDetection(): void {
        this.changeDetectorRef.reattach();
    }
}

A l’exécution, on peut voir que le nombre ne sera plus mis à jour dans la vue si on clique sur “Disable change detection”. La mise à jour est réativée si on clique sur “Enable change detection “.

Ainsi, quand on a exécuté ChangeDetectorRef.detach() dans le composant Example, la détection de changements est désactivée pour ce composant et pour les composants enfant:

Vérifier si des changements sont détectés

On peut se demander l’utilité de cette méthode en sachant qu’elle déclenche une erreur dans le cas où un changement est détecté. La raison est que cette détection a pour but d’éviter des erreurs d’implémentation en vérifiant que des changements ne sont pas effectués trop tardivement dans le cycle de vie d’un composant (cf. ExpressionChangedAfterItHasBeenCheckedError).

La vérification peut être effectuée en exécutant:

ChangeDetectorRef.checkNoChanges();

En conclusion

Pour résumer, on peut personnaliser la détection de changements en:

  • Contournant l’exécution de la détection: en injectant l’objet NgZone dans le composant. Avec NgZone.runOutsideAngular(), on peut exécuter du code qui n’aboutira pas à la détection automatique de changements.
  • Forçant la mise à jour d’un élément d’une vue en modifiant directement l’objet natif, par exemple:
    • En effectuant une requête sur la vue avec @ViewChild() pour obtenir l’objet natif:
      @ViewChild('elementName', { static: true }) element: ElementRef<HTMLParagraphElement>
      
    • En affectant une valeur avec la propriété nativeElement:
      this.element.nativeElement.textContent = ... 
      
  • Forçant l’exécution de la détection de changements en injectant l’objet ApplicationRef et exécutant ApplicationRef.tick().
  • Désactivant définitivement la détection dans un composant avec le paramètre changeDetection dans le décorateur @Component():
    @Component({
        selector: ...,
        templateUrl: ...,
        changeDetection: ChangeDetectionStrategy.OnPush
    })
    
  • En injectant l’objet ChangeDetectorRef dans le constructeur pour:
    • Désactiver l’exécution automatique de la détection en exécutant ChangeDetectorRef.detach(),
    • Ré-activer la détection automatique en exécutant ChangeDetectorRef.reattach(),
    • Forcer l’exécution de la détection avec ChangeDetectorRef.detectChanges(),
    • Vérifier si des changements sont détectés en exécutant ChangeDetectorRef.checkNoChanges() ou
    • Marquer la vue du composant pour que la détection de changements soit effectuée en exécutant ChangeDetectorRef.markForCheck().
Références
Share on FacebookShare on Google+Tweet about this on TwitterShare on LinkedInEmail this to someonePrint this page

Fonctionnement de la détection de changement dans une application Angular

@dlohmar

La détection de changements est un sujet important car l’algorithme qui le gère est le même que celui qui met à jour le DOM et qui déclenche les callbacks du cycle de vie d’un composant (i.e. lifecycle hooks). Certains comportements d’Angular découlent directement de cet algorithme de détection.

Le but de cet article est de rentrer dans quelques détails de l’implémentation du mécanisme de détection de changements en s’appuyant sur le code d’Angular 9 sur GitHub. Le code concernant ce mécanisme a été beaucoup modifié entre les versions 7 et 8, les explications de cet article peuvent ne pas correspondre pour les versions précédant la version 9. Les mécanismes permettant de provoquer la détection de changements avec ChangeDetectorRef ne seront pas abordés dans cet article mais dans Personnaliser la détection de changements.

Pourquoi effectuer une détection de changements ?

Pour beaucoup de frameworks Javascript, il existe, au moins 2 versions des objets présentés sur la page web:

  • Une version maintenue complètement par le framework: il peut modifier ces objets ou leurs propriétés à sa guise. Cette version contient des propriétés plus ou moins spécifiques au framework. Dans le cas d’Angular, ces objets contiennent des références vers les objets équivalents dans le DOM.
  • Le DOM contenant des objets dont les propriétés sont utilisées pour présenter des éléments HTML sur l’interface.

Pour qu’une application puisse être fonctionnelle, il faut qu’elle puisse réagir aux différents évènements extérieurs correspondant à tous les évènements Javascript possibles. Ces évènements peuvent provoquer l’exécution d’un traitement dans l’application qui pourra éventuellement mettre à jour un élément graphique. Pour mettre à jour un élément graphique, Angular doit s’interfacer avec le DOM pour créer ou supprimer des objets ou en modifier des propriétés.

Ces accès multiples au DOM sont coûteux en performance. Ainsi, afin d’en limiter au maximum les accès et de modifier les propriétés au minimum, la solution d’Angular est de détecter automatiquement les changements nécessitant une modification dans le DOM. Cette détection s’exécute dans la version des objets maintenue par Angular. Si Angular détecte un changement, il répercute ce changement dans le DOM de façon à ce que les éléments graphiques correspondant puissent être modifiés.

Cette détection automatique présente de multiples avantages:

  • Les accès au DOM sont limités aux cas où un changement est nécessaire,
  • Graphiquement les changements permettent de modifier certains éléments sans recharger la page, ce qui limite les manipulations effectuées sur les éléments graphiques et améliore l’expérience utilisateur.
  • Enfin le développeur est moins préoccupé par la mise à jour des éléments graphiques d’un composant puisqu’Angular encapsule une grande partie de la complexité des bindings entre des objets du code et les éléments graphiques correspondant.

Zone.js

De façon à éventuellement mettre à jour des éléments graphiques, la détection de changements doit s’exécuter quand un évènement se déclenche dans le browser. Ce déclenchement est possible gràce à la bibliothèque Zone.js. Zone.js a la particularité de pouvoir intercepter les évènements asynchrones comme setInterval() et de fournir à Angular un contexte d’exécution de cet évènement. Il notifie ensuite Angular qui déclenche l’algorithme de détection de changements.

Les évènements extérieurs à Angular qui peuvent subvenir sont:

  • Les évènements Javascript comme les clicks, keydown, submit, input etc… (Référence des événements),
  • Les évènements XHR provenant de l’objet XmlHttpRequest,
  • Les évènements provenant de Timers comme setTimeout() ou setInterval().

Tous les évènements notifiés par Zone.js ne nécessitent pas forcément une modification d’un élément graphique. C’est le mécanisme de détection de changements qui va permettre de filtrer les évènements pour ne garder que les évènements pertinents qui affectent réellement un objet de l’interface de façon . Pour ne pas trop affecter les performances et le temps d’exécution, cette détection de changements ne doit pas être trop coûteuse.

Cycle de vie des composants

L’algorithme de détection de changements effectue les mises à jour des éléments graphiques suivant un ordre précis. Tout au long de ces mises à jour et suivant les éléments qui sont mis à jour, il va aussi exécuter les callbacks du cycle de vie des composants. La détection de changements est donc très liée au cycle de vie des composants.

Ainsi, lors de la création et du rendu de la vue d’un composant, les callbacks peuvent être déclenchées de façon successive dans la classe du composant dans le cas où elles sont implémentées. Dans la documentation Angular ces callbacks sont appelées “lifecycle hooks”.

Le but de ces callbacks est de pouvoir interagir finiment avec le framework durant les différentes phases de la création d’un composant et de sa vue dans un premier temps ou lors de la détection d’un changement dans un 2e temps. La succession de ces différentes phases permet d’intervenir:

  • Dans le cas de l’initialisation d’un composant: avant ou après l’initialisation d’un élément particulier de ce composant (paramètres d’entrée, contenu projeté, requête sur la vue etc…)
  • Dans le cas de la détection d’un changement: avant ou après la vérification d’un changement sur un élément particulier du composant.

Ainsi, à l’initialisation d’un composant, les callbacks de ce cycle de vie (i.e. lifecycle hooks) sont, dans l’ordre de déclenchement:

  1. ngOnChanges(): cette callback est exécutée si le composant contient des propriétés en entrée (notamment avec le décorateur @Input()). Si cette callback est implémentée sans paramètre, elle sera déclenchée autant de fois qu’il y a de propriétés en entrée du composant.

    Si la callback est implémentée avec un argument de type SimpleChanges:

    void ngOnChanges(changes: SimpleChanges): void {}
    

    Elle sera déclenchée une seule fois.

  2. ngOnInit(): déclenchée après l’exécution du constructeur. Elle permet d’initialiser le composant avec le 1er affichage des données de la vue ayant un binding avec des propriétés de la classe du composant. Cette callback est déclenchée une seule fois à l’initialisation du composant même si ngOnChanges() n’est pas déclenchée.
  3. ngDoCheck() permet d’indiquer des changements si Angular ne les a pas détecté.
  4. ngAfterContentInit() est déclenchée à l’initialisation après la projection de contenu. Elle est déclenchée même s’il n’y a pas de contenu à projeter.
  5. ngAfterContentChecked(): déclenchée après la détection de changement dans le contenu projeté. Cette callback est déclenchée même s’il n’y a pas de projection de contenu.
  6. ngAfterViewInit(): déclenchée après l’initialisation de la vue du composant et après l’initialisation de la vue des composants enfant.
  7. ngAfterViewChecked() est déclenchée après détection d’un changement dans la vue du composant et dans la vue des composants enfant.
  8. ngOnDestroy() est déclenchée avant la destruction du composant.

A chaque détection de changements, les callbacks déclanchées sont, dans l’ordre:

  1. ngOnChanges() si les paramètres en entrée du composant sont modifiés.
  2. ngDoCheck()
  3. ngAfterContentChecked() est déclenchée même s’il n’y a pas de contenu projeté.
  4. ngAfterViewChecked().

Lien entre la détection des changements et le cycle de vie des composants

Dans le cadre de la détection des changements, le cycle de vie des composants permet à Angular d’indiquer des étapes des vérifications qu’il effectue afin de détecter des éventuels changements, par exemple:

  • Après la création d’un contenu projeté, les callbacks ngAfterContentInit() et ngAfterContentChecked() seront déclenchées de façon à indiquer que le contenu a été vérifié et que les changements dans le contenu projeté ne seront plus vérifiés après cette phase.
  • De même après avoir terminé la création de la vue, lorsque les callbacks ngAfterViewInit() et ngAfterViewChecked() seront déclenchées, il n’y aura plus de vérification de changements.

Ainsi, si des modifications sont effectuées sur des éléments interagissant avec des vues après les détections de changements, les éléments correspondants sur les vues ne seront pas mis à jour. Il est donc important d’effectuer ces modifications au bon moment lors de l’exécution des callbacks du cycle de vie.

Erreur “ExpressionChangedAfterItHasBeenCheckedError”

L’erreur "ExpressionChangedAfterItHasBeenCheckedError" survient lors de l’exécution en mode développement pour indiquer qu’une modification a été effectuée trop tardivement par rapport à la détection de changements. Les conséquences de ces modifications ne seront probablement pas répercutées sur des éléments des vues.

L’erreur "ExpressionChangedAfterItHasBeenCheckedError" est déclenchée seulement en développement

L’erreur "ExpressionChangedAfterItHasBeenCheckedError" est déclenchée en développement pour indiquer qu’une erreur de conception risque de compromettre la détection de changement et empêcher la mise à jour correcte de la vue. En production, Angular n’effectue pas de vérifications pouvant amener aux déclenchements de cette erreur.

Par exemple, si considère un composant pour lequel on implémente:

  • Les callbacks ngAfterContentInit(), ngAfterContentChecked(), ngAfterViewInit() et ngAfterViewChecked(),
  • Une interpolation dans le template vers une propriété de la classe du composant.

L’implémentation est:

Template
{{updatedValue}} 
Classe du composant
import { Component, ngAfterViewInit, ngAfterViewChecked, 
    ngAfterContentInit, ngAfterContentChecked } from '@angular/core'; 

@Component({ 
    templateUrl: './example.component.html' 
})    
export class ExampleComponent implements ngAfterViewInit, ngAfterViewChecked, 
    ngAfterContentInit, ngAfterContentChecked { 
    updatedValue = 'Not updated'; 

    ngAfterContentInit(): void {} 

    ngAfterContentChecked(): void { 
        this.updatedValue = 'Updated'; 
    } 

    ngAfterViewInit(): void {} 

    ngAfterViewChecked(): void {} 
}

Si on exécute en mode développement en lançant la commande suivante:

ng serve 

Le texte Updated sera correctement affiché. Si on modifie le code pour mettre à jour la valeur dans ngAfterViewInit() ou dans ngAfterViewChecked():

ngAfterContentChecked(): void { 
    //this.updatedValue = 'Updated'; 
} 

ngAfterViewInit(): void { 
    this.updatedValue = 'Updated'; 
} 

On constate l’erreur suivante dans la console du browser:

ExpressionChangedAfterItHasBeenCheckedError: Expression has changed after it was checked.  
Previous value: 'Not updated'. Current value: 'Updated'. It seems like 
the view has been created after its parent and its children have been dirty checked.  
Has it been created in a change detection hook?

Par suite, le texte contient la même valeur qu’à l’initialisation: Not updated.

Si on exécute en mode production en lançant la commande:

ng serve --prod 

L’erreur n’est pas affichée dans la console, toutefois le texte n’est pas mis à jour et contient toujours sa valeur initiale: Not updated.

La valeur n’est pas mise à jour dans le template car la modification de la propriété updatedValue est effectuée après la dernière détection de changements. En effet quand la callback ngAfterViewInit() est déclenchée, la vue est créée et Angular considère que des modifications ne doivent plus être effectuées à ce stade.

Dans la suite de cet article, on va expliquer plus en détails l’origine de ce problème et pourquoi Angular affiche cette erreur en mode développement.

Ivy

Depuis Angular 9, l’implémentation d’Angular a été complêtement modifiée pour que le view engine (appelé view Engine “render 2”) soit remplacé par Ivy (appelé view engine “render 3”). Ivy est un compilateur et un moteur de rendu dont les fonctionnalités et les performances sont meilleures que le view engine utilisé dans les versions précédentes notamment avec un rendu plus rapide avec la compilation AOT, la fonctionnalité Tree-Shaking et un runtime qui permet de mettre à jour le DOM de façon plus performante.

Compilation Ahead-of-Time (AOT)

La compilation AOT est le mode de compilation par défaut dans Angular à partir de la version 9 en opposition à la compilation Just-In-Time (JIT) utilisée dans les versions précédentes. La différence entre les 2 modes de compilation est que l’AOT effectue une compilation du code qui va permettre de modifier le DOM pendant la compilation de l’application (build time) et non lors de son exécution (runtime).

Dans le cadre de la compilation JIT (i.e. Just-In-Time), la compilation des templates est effectuée à l’exécution de façon à s’adapter au contexte d’exécution. Le compilateur se trouve, donc, dans le bundle Javascript chargé par le browser au moment d’exécuter l’application. Ce bundle comprend aussi les fichiers HTML correspondant aux templates, le compilateur utilise les fichiers HTML pour les convertir en code exécutable qui sera capable de mettre à jour le DOM. Les gros inconvénients de ce mode de compilation sont que:

  • Le bundle chargé à l’exécution est plus lourd à cause des fichiers HTML et surtout du compilateur,
  • Certaines erreurs surviennent lors de l’exécution et lors de la compilation au runtime.
  • L’application est plus lente puisque la compilation est nécessaire avant le rendu des vues.

A l’opposé, le compilation AOT (i.e. Ahead-of-Time) effectue la compilation des templates au moment de la compilation de l’application en produisant un code qui n’est plus dépendant du contexte d’exécution. Ainsi, le bundle chargé au moment de l’exécution ne contient ni le compilateur, ni les fichiers HTML correspondant aux templates. Le code des templates est déjà compilé et permet de mettre à jour le DOM efficacement sans compilation préalable. Les inconvénients de la compilation JIT sont levés avec la compilation AOT:

  • Le bundle est plus léger puisqu’il ne contient pas le compilateur et le code HTML,
  • Certaines erreurs liées aux vues peuvent être détectées au moment de la compilation,
  • L’exécution est plus rapide.

Tree-shaking

Le tree-shaking est une optimisation qui permet de ne pas inclure le code qui est inutile dans le bundle obtenu après compilation et chargé par le browser au runtime. L’intérêt de cette optimisation est de réduire la taille du bundle et s’avère particulièrement efficace car elle s’applique aussi au code du framework. Ivy permet de mettre en place cette optimisation lors de la compilation d’une application Angular.

Compilation d’un composant

Lors de la compilation avec Ivy, les metadatas se trouvant dans les décorateurs sont utilisées pour générer du code et des propriétés qui seront exécutées directement au runtime suivant les différentes mises à jour nécessaires des vues .

Ainsi quand on implémente un composant, on utilise le décorateur @Component() et on indique des metadatas dans ce décorateur. Le compilateur génère une factory permettant d’instancier le composant à l’exécution et de générer le code qui permettra de convertir ces metadatas en propriétés qui seront affectées à un objet qui sera la définition du composant.

Dans la définition de ce composant, on trouvera, par exemple un type, un template, des styles, des animations etc… Cette définition du composant sera compilée pour former un type qui pourra être instancié par la suite.

La compilation permet de générer le code qui sera exécuté au runtime pour mettre à jour le DOM. Par exemple, les méthodes les plus importantes permettant ces mises à jour sont:

  • template: le code de la vue contient du code statique avec des éléments HTML fixe et du code dynamique au travers des property bindings, event bindings ou interpolations.
  • contentQueries: ce code est exécuté pour mettre à jour des requêtes effectuées sur le contenu projeté des vues avec @ContentChild() ou @ContentChildren().
  • hostBindings: cette fonction est exécutée pour mettre à jour le binding entre une propriété d’un composant et une propriété d’un élément HTML hôte avec @HostBinding() ou @HostListener().
  • viewQuery: ce code est exécuté pour mettre à jour des requêtes effectuées sur le contenu des vues avec @ViewChild() ou @ViewChildren().

La compilation est effectuée par la méthode compileComponent().

Exemple du code généré pour un composant

Pour mieux comprendre la façon dont la définition du composant est compilée puis utilisée, on va montrer un exemple à partir d’un exemple simple. Si on considère le composant suivant:

Template
<p>Example component</p> 
{{updatedValue}}
Classe du composant
import { Component, OnInit } from '@angular/core'; 

@Component({ 
    selector: 'app-example', 
    templateUrl: './example.component.html' 
})    
export class ExampleComponent implements OnInit { 
    updatedValue: string; 
 
    ngOnInit(): void { 
        this.updatedValue = 'Updated value'; 
    } 
} 

Si on affiche ce composant et si on consulte le code source généré en Javascript (on peut trouver l’implémentation correspondant à la définition du composant dans le fichier main.js):

ExampleComponent.ɵfac = function ExampleComponent_Factory(t) { return new (t || ExampleComponent)(); }; 
ExampleComponent.ɵcmp = _angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵdefineComponent"]({ 
type: ExampleComponent, 
selectors: [["app-example"]], decls: 3, vars: 1, 
template: function ExampleComponent_Template(rf, ctx) { if (rf & 1) { 
        _angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵelementStart"](0, "p"); 
        _angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵtext"](1, "Example component"); 
        _angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵelementEnd"](); 
        _angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵtext"](2); 
    } if (rf & 2) { 
        _angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵadvance"](2); 
        _angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵtextInterpolate1"]("\n", ctx.updatedValue, "\n"); 
    } }, 
encapsulation: 2 }); 
/*@__PURE__*/ (function () { _angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵsetClassMetadata"](ExampleComponent, [{ 
        type: _angular_core__WEBPACK_IMPORTED_MODULE_0__["Component"], 
        args: [{ 
                selector: 'app-example', 
                templateUrl: './example.component.html' 
            }] 
    }], function () { return []; }, null); })(); 

Ce code permet de définir dans ExampleComponent.ɵcmp la définition du composant Example contenant ses metadatas et son template.

Creation Mode

Avec Ivy, de façon à augmenter les performances, les fonctions utilisées pour mettre à jour le DOM sont divisées en 2 parties:

  • Une partie permettant de modifier le DOM avec le contenu statique d’une vue: la partie statique correspond aux éléments HTML statiques d’un template. Ces éléments ne seront pas modifiés dans le cas d’un changement d’un binding.
  • Une partie permettant de mettre à jour le DOM avec le contenu dynamique d’une vue: cette partie est modifiée si un élément dynamique est mise à jour comme un binding.

Ces 2 parties des fonctions ne sont pas exécutées au même moment. Elles sont exécutées suivant la valeur de l’enum RenderFlags qui matérialise l’étendu du rendu souhaité par Ivy:

export const enum RenderFlags { 
    /* Whether to run the creation block (e.g. create elements and directives) */ 
    Create = 0b01, 
    /* Whether to run the update block (e.g. refresh bindings) */ 
    Update = 0b10 
} 

Ainsi:

  • RenderFlags.Create: ce niveau de rendu permet d’exécuter la partie statique du code des fonctions. Il est exécuté à l’initialisation d’un composant au moment du rendu de la vue.
  • RenderFlags.Update: ce niveau de rendu exécute la partie dynamique du code des fonctions. Il est exécuté à l’initialisation d’un composant et quand la détection de changements a détecté un changement nécessitant la mise à jour du DOM.

De façon à optimiser les performances, l’utlisation de ces 2 niveaux de rendu permet d’eviter d’exécuter du code inutile lors de la mise à jour du contenu dynamique d’une vue. Ainsi quand un changement est détecté et que le contenu dynamique doit être mise à jour, il est inutile d’exécuter le code permettant de mettre à jour la partie statique de la vue.

Le niveau de rendu souhaité est piloté par l’activation du mode creation (i.e. creation mode) suivant les différentes étapes d’exécution:

  • A l’initialisation d’un composant:
  • Lors de la détection de changements:

Au niveau du code Angular, les 2 niveaux de rendu sont effectués par des méthodes différentes:

  • Création contenu statique: la méthode renderView() permet d’exécuter ce niveau. Par exemple, si on se limite au cas de l’appel à la fonction template, l’appel dans renderView() est du type:
    executeTemplate(tView, lView, templateFn, RenderFlags.Create, context); 
    

    On peut voir que la fonction template templateFn est appelée avec RenderFlags.Create.

  • Mise à jour contenu dynamique: ce niveau est exécuté par la méthode refreshView(). Dans le cas de l’appel à la fonction template, on peut voir l’appel dans refreshView():
    executeTemplate(tView, lView, templateFn, RenderFlags.Update, context);
    

    La fonction template templateFn est appelée avec RenderFlags.Update.

Si on prend le code de la fonction template résultant de la compilation par Ivy du code du template du composant ExampleComponent présenté plus haut, on peut voir les 2 parties correspondant au 2 modes:

function ExampleComponent_Template(rf, ctx) { if (rf & 1) { 
        _angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵelementStart"](0, "p"); 
        _angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵtext"](1, "Example component"); 
        _angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵelementEnd"](); 
        _angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵtext"](2); 
    } if (rf & 2) {
        _angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵadvance"](2); 
        _angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵtextInterpolate1"]("\n", ctx.updatedValue, "\n"); 
    } } 

Ainsi:

  • if (rf & 1) permet d’exécuter le code si le mode est creation (i.e. si la valeur de rf est RenderFlags.Create).
  • if (rf & 2) permet d’exécuter le code si le mode est update (i.e. si la valeur de rf est RenderFlags.Update).

Interfaçage avec le DOM

Comme on a pu le dire précédemment, Ivy permet à Angular de s’interfacer avec le DOM au moyen de méthodes qui sont compilées en même temps que la compilation de l’application. Le code généré permet de créer des nœuds dans le DOM, d’insérer de nouveaux nœuds, de mettre à jour des propriétés d’éléments se trouvant dans le DOM etc…

Partie statique

Si on prend l’exemple de la fonction template du composant ExampleComponent. Le template de ce composant contient le code:

<p>Example component</p> 
{{updatedValue}} 

Le code statique de ce template se trouve dans la fonction template dans la partie correspondant au mode creation:

_angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵelementStart"](0, "p"); 
_angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵtext"](1, "Example component"); 
_angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵelementEnd"](); 
_angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵtext"](2); 

Si on regarde la 1ère ligne, elle permet d’exécuter la méthode ɵɵelementStart pour ajouter l’élément HTML p dans le DOM. Le code de cette méthode est:

function ɵɵelementStart(index, name, attrsIndex, localRefsIndex) { 
    const lView = getLView(); 
    const tView = getTView(); 
    // [...]     
    const native = lView[adjustedIndex] = elementCreate(name, renderer, getNamespace()); 
    // [...]     
    appendChild(tView, lView, native, tNode); 
    // [...]     
} 

La méthode ɵɵelementStart fait partie des méthodes utilisées pour s’interfacer avec le DOM. D’autres méthodes effectuent des opérations similaires permettant le rendu de la vue comme ɵɵtext pour ajouter du texte.

Le point commun de ces méthodes est de:

  • créer un élément natif avec la méthode elementCreate():
    function elementCreate(name, renderer, namespace) { 
        if (isProceduralRenderer(renderer)) { 
            return renderer.createElement(name, namespace); 
        } 
        else { 
            return namespace === null ? renderer.createElement(name) : 
                renderer.createElementNS(namespace, name); 
        } 
    } 
    
  • rajouter un nœud au DOM en utilisant la méthode appendChild() qui après d’autres appels va permettre de rajouter un élément au DOM:
    function nativeAppendChild(renderer: Renderer3, parent: RElement, child: RNode): void { 
        ngDevMode && ngDevMode.rendererAppendChild++; 
        ngDevMode && assertDefined(parent, 'parent node must be defined'); 
    
        if (isProceduralRenderer(renderer)) { 
            renderer.appendChild(parent, child);
        } else { 
            parent.appendChild(child); 
        } 
    }
    

Partie dynamique

Dans le cadre de la partie dynamique de la fonction template, on peut voir que le code permet de mettre à jour des propriétés dans le DOM. Par exemple en prenant la partie de la fonction template correspondant au mode update:

_angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵadvance"](2); 
_angular_core__WEBPACK_IMPORTED_MODULE_0__["ɵɵtextInterpolate1"]("\n", ctx.updatedValue, "\n");

On peut voir que cette partie permet de mettre à jour le texte interpolé correspondant au code:

{{updatedValue}} 

La 2e ligne permet de faire appel à la méthode ɵɵtextInterpolate1 qui, par suite, permettra d’affecter la valeur dans l’élément du DOM correspondant:

export function textBindingInternal(lView: LView, index: number, value: string): void { 
    // [...] 
    const renderer = lView[RENDERER]; 

    isProceduralRenderer(renderer) ? renderer.setValue(element, value) : element.textContent = value; 
} 

D’autres méthodes permettent d’effectuer des traitements similaires comme par exemple:

Fonctionnement de la détection de changements

Dans cette partie, on va détailler le fonctionnement d’Angular de façon à expliquer quelques subtilités de la détection de changements telle qu’elle fonctionne avec Ivy.

Comment détecter les changements ?

On pourrait se demander comment détecter les changements dans le contenu dynamique d’un composant. Intuitivement, 2 méthodes nous paraissent possibles:

  • 1ère méthode: dès qu’on effectue un changement sur une valeur, on indique explicitement que sa valeur a changé. L’inconvénient de cette méthode est qu’elle nécessite d’indiquer explicitement les changements et qu’il est plus difficile de l’automatiser.
  • 2e méthode: à chaque modification d’une valeur, on compare la valeur actuelle avec la valeur précédente pour savoir si la valeur a changé. Si la valeur est la même, il n’y a pas eu de changement; si la valeur est différente alors un changement est détectée. L’avantage de cette méthode sur la 1ère est qu’elle est facilement automatisable, il n’est pas nécessaire d’indiquer explicitement le changement de valeur. Son inconvénient majeur est qu’elle est plus complexe à mettre en œuvre.

Avec Angular, il est possible d’utiliser les 2 méthodes. On peut exécuter la détection de changements explicitement dans le cas où on désactive volontairement la détection automatique de changements ou si la détection automatique n’est pas suffisante. Une méthode pour solliciter explicitement la détection de changements est de faire appel à l’objet ChangeDetectorRef (le détail de cette méthode se trouve dans Personnaliser la détection de changements).

La 2e méthode est celle adoptée par Angular pour détecter les changements de façon automatique. A chaque fois qu’un évènement survient, Angular déclenche une méthode qui effectuera la détection de changements sur tous les éléments dynamiques des vues. Le changement est détecté en comparant les valeurs actuelles avec les valeurs précédentes, si les valeurs sont différentes alors des mises à jour des éléments correspondant dans le DOM sont effectuées.

Pour optimiser le traitement et éviter d’effectuer des mises à jour inutiles, seules les valeurs ayant été modifiées entraînent une mise à jour d’une propriété dans le DOM.

Ainsi pour résumer, la détection de changement repose sur 3 mécanismes:

  • Le déclenchement de la détection de changements,
  • La comparaison des valeurs pour savoir si la valeur a changé,
  • La mise à jour du DOM dans le cas où la valeur a changé.

Déclenchement de la détection de changements

Comme on l’a indiqué plus haut, les évènements qui permettent de déclencher la détection de changements sont exécutés par Zone.js.

Par exemple, si on considère le composant suivant:

Template
<p>Click example</p>
Classe du composant
import { Component, HostListener } from '@angular/core'; 

@Component({ 
    selector: 'app-example', 
    templateUrl: './example.component.html' 
}) 
 export class ExampleComponent { 
    @HostListener('click') onHostClicked(triggeredEvent) : void {  
        console.log(triggeredEvent); 
    } 
} 

Si on place un point d’arrêt dans la méthode ApplicationRef.tick() se trouvant dans le fichier core.js, on peut voir que son exécution est délenchée à chaque fois qu’on clique sur le texte Click example.

La méthode tick() est appelée pour chaque évènement provenant de Zone.js. En suivant la pile d’appels tick()tickRootContext()renderComponentOrTemplate(), on peut voir que cette méthode appelle renderView() et refreshView() qui sont les méthodes permettant la détection de changements:

export function renderComponentOrTemplate<T>( 
    tView: TView, lView: LView, templateFn: ComponentTemplate<{}>|null, context: T) { 
    // [...] 

    if (creationModeIsActive) { 
        renderView(tView, lView, context);
    } 
    refreshView(tView, lView, templateFn, context);

    // [...] 
} 

Comme on l’a indiqué précédemment, renderView() et refreshView() permettent d’exécuter la création et la mise à jour de la vue. Le booléen creationModeIsActive matérialise l’activation du mode Creation permettant la création des éléments statiques de la vue par renderView().

Dans le cadre d’une exécution en mode update, refreshView() peut aussi être appelé par detectChanges()detectChangesInternal():

export function detectChangesInternal<T>(tView: TView, lView: LView, context: T) { 
    const rendererFactory = lView[RENDERER_FACTORY]; 
    if (rendererFactory.begin) rendererFactory.begin(); 
    try { 
        refreshView(tView, lView, tView.template, context);
    } catch (error) { 
        handleError(lView, error); 
        throw error; 
    } finally { 
        if (rendererFactory.end) rendererFactory.end(); 
    } 
} 

Comparaison des valeurs

Dans le code d’Angular, on peut voir régulièrement des objets de type LView et TView. Ces 2 objets contiennent toutes les données relatives aux vues:

  • LView contient toutes les données nécessaires à l’exécution des traitements concernant un template. Il existe une instance de type LView pour chaque vue d’un composant et pour chaque vue intégrée (i.e. embedded view).
  • TView contient les données statiques partagées par tous les templates correspondant à un type donné. Le code permet de voir les fonctions qui sont compilées et générées par Ivy et qui sont exécutées lors du rendu d’une vue ou de la mise à jour des éléments dynamiques d’une vue:
    export interface TView { 
        // [...] 
        type: TViewType; 
        readonly id: number; 
    
        // [...] 
        template: ComponentTemplate<{}>|null; 
        viewQuery: ViewQueriesFunction<{}>|null; 
        node: TViewNode|TElementNode|null; 
    
        // [...] 
        expandoInstructions: ExpandoInstructions|null; 
        staticViewQueries: boolean; 
        queries: TQueries|null; 
        contentQueries: number[]|null; 
    
        // [...] 
        preOrderHooks: HookData|null; 
        preOrderCheckHooks: HookData|null; 
        contentHooks: HookData|null; 
        contentCheckHooks: HookData|null; 
        viewHooks: HookData|null; 
        viewCheckHooks: HookData|null; 
        destroyHooks: DestroyHookData|null; 
    
        // [...] 
        components: number[]|null; 
    }
    

Les comparaisons des valeurs sont indirectement effectuées par refreshView(). Sans rentrer dans le détail d’implémentation de cette méthode, elle permet de déclencher l’exécution de toutes les fonctions permettant de mettre à jour des éléments dynamiques d’une vue susceptible d’en modifier le contenu comme par exemple:

  • Un property binding,
  • Un attribute binding,
  • Une interpolation,
  • Le changement d’un paramètre d’entrée d’un composant (de type Input),
  • Une propriété d’un élément hôte natif (différent de Input),
  • L’évaluation d’une expression,
  • Etc…

Par suite, toutes ces méthodes déclenchent les méthodes générées par Ivy correspondant à la mise à jour des éléments du template en mode update. Lors de cette mise à jour, la fonction bindingUpdated() est déclenchée pour vérifier si les bindings sont mis à jour ou non:

export function bindingUpdated(lView: LView, bindingIndex: number, value: any): boolean { 
    ngDevMode && assertNotSame(value, NO_CHANGE, 'Incoming value should never be NO_CHANGE.'); 
    ngDevMode && 
    assertLessThan(bindingIndex, lView.length, `Slot should have been initialized to NO_CHANGE`); 

    const oldValue = lView[bindingIndex]; 
    if (Object.is(oldValue, value)) { 
        return false; 
    } else { 
        // [...] 
        lView[bindingIndex] = value; 
        return true; 
  } 
}

On peut voir que cette fonction récupère l’ancienne valeur avec:

const oldValue = lView[bindingIndex]; 

Elle effectue une comparaison entre la valeur actuelle et l’ancienne valeur pour détecter le changement:

Object.is(oldValue, value) 

Enfin en cas de changement, la valeur sauvegardée est remplacée par la nouvelle valeur:

lView[bindingIndex] = value; 

La valeur de retour de la fonction est true si une mise à jour du binding a été détectée. Cette fonction n’effectue pas elle-même la modification des propriétés dans le DOM. Ces modifications sont effectuées par les méthodes générées par Ivy seulement dans le cas où un changement est détecté.

Implémentation de la détection de changements

Comme le suggère l’implémentation qu’on a pu décrire plus haut, le mécanisme de détection de changements est lié à l’interfaçage avec le DOM lors de l’initialisation d’un composant ou lors de sa mise à jour. Il n’est pas possible de s’interfacer avec le DOM sans exécuter la détection de changements.

Même si la compréhension de la détection de changements n’est pas nécessaire pour implémenter des composants avec Angular, elle permet de mieux appréhender le lien entre les différents mécanismes suivants:

  • Création des objets,
  • Déclenchement des callbacks du cycle de vie d’un composant,
  • Rendu d’un vue,
  • Mise à jour du contenu dynamique d’une vue,
  • Lien entre un composant et ses composants enfant.

Tous ces mécanismes sont implémentés dans les 2 méthodes:

Le but de cette partie est d’expliciter ces 2 méthodes pour comprendre davantage le lien entre ces différents mécanismes.

Composant parent et composant enfant

Expliciter le fonctionnement des méthodes renderView() et refreshView() n’est pas facile car ces méthodes sont appelées récursivement par les composants parent sur leur composant enfant. Pour un composant donné, la moitié des traitements est effectuée par des appels provenant de l’exécution de renderView() ou refreshView() de son composant parent.

L’imbrication d’un composant avec ses parents est valable pour tous les composants car même le composant root de l’application possède un parent.

Création de contenu statique

Le contenu statique est créé par la méthode renderView(). Elle n’est exécutée que lors de l’initialisation d’un composant. Comme le contenu statique d’une vue n’est pas modifié dans la suite de l’exécution, la méthode ne sera plus sollicitée.

Cette méthode peut prêter à confusion car certains appels sont effectués avec RenderFlags.Update.

Ainsi la création du contenu statique est effectuée en exécutant les étapes suivantes:

  1. Exécution de la fonction contentQueries avec RenderFlags.Create: cette fonction permet de créer d’autres fonctions qui permettront d’effectuer des bindings entre le composant et sa vue en effectuant des requêtes sur du contenu projeté par l’intermédiaire de @ContentChild() ou @ContentChildren().
    Cet appel n’est pas effectué dans le corps de la méthode renderView() du composant mais dans celui de son parent. Il est effectué lorsque le constructeur du composant parent est exécuté. Cet appel n’effectue pas de mise à jour du DOM, il ne fait que créer de nouveaux objets nécessaires aux traitements futurs.
  2. Exécution de la fonction viewQuery avec RenderFlags.Create: crée d’autres fonctions qui effectueront des bindings entre le composant et sa vue quand on utilise @ViewChild() ou @ViewChildren(). Cet appel n’effectue pas de création ou de mise à jour d’objets dans le DOM.
  3. Exécution de la fonction template avec RenderFlags.Create: cet appel est le plus important que c’est celui qui permettra de créer tous les objets correspondant au contenu statique de la vue en créant les éléments natifs dans le DOM.
  4. Exécution du constructeur du composant: lorsque la fonction template est exécutée et au premier appel d’une méthode qui crée un objet où le code du composant est nécessaire, le composant est instancié en exécutant son constructeur.
  5. Exécution de la fonction contentQueries avec RenderFlags.Update: cet appel peut prêter à confusion car il est effectué avec RenderFlags.Update. Il concerne les requêtes effectuées sur du contenu projeté se trouvant sur la vue du composant avec @ContentChild() ou @ContentChildren() dans le cas où ils utilisent l’option static: true. Cette option va imposer aux requêtes d’être effectuées au moment de la création de la vue.
    Cet appel est effectué avec RenderFlags.Update car les objets permettant d’effectuer la requête sont déjà créés (point 1). Cet appel met à jour les résultats des requêtes après création des éléments statiques de la vue.
  6. Exécution de la fonction viewQuery avec RenderFlags.Update: comme l’appel précédent, cet appel est effectué avec RenderFlags.Update car les objets permettant de requêter la vue existe déjà (point 2). L’appel concerne les requêtes effectuées sur la vue avec @ViewChild() ou @ViewChildren() s’ils utilisent l’option static: true.
Légende du schéma

Mise à jour du contenu dynamique

Le contenu dynamique d’une vue d’un composant est mis à jour lors de l’initialisation et à chaque exécution du mécanisme de détection de changements. La méthode qui effectue ce traitement est refreshView().

Cette méthode est plus complexe que renderView() car beaucoup de traitements effectués concernant le composant courant sont effectués lors de l’exécution de refreshView() dans le cadre son parent.

Les étapes principales de refreshView() sont:

  1. Exécution des callbacks ngOnChanges(), ngOnInit() et ngDoCheck(): ces callbacks sont exécutées lors de l’exécution de refreshView() du composant parent.
    La callback ngOnInit() est exécutée seulement à l’initialisation du composant.
  2. Exécution de la fonction contentQueries avec RenderFlags.Update: cette fonction permet de mettre à jour les requêtes effectuées sur le contenu projeté de la vue avec @ContentChild() ou @ContentChildren().
    L’appel de cette fonction est effectué lors de l’exécution de refreshView() du composant parent.
  3. Exécution des callbacks ngAfterContentInit() et ngAfterContentChecked(): l’exécution de ces callbacks vient clôturer la mise à jour des requêtes effectuées sur le contenu projeté. Ce contenu projeté provient du parent. La vue correspondante du parent a été rendu après exécution de la fonction template du parent. Au moment d’effectuer les requêtes sur le contenu projeté, la vue de son parent est donc à jour.
    La callback ngAfterContentInit() est exécutée seulement à l’initialisation du composant.
  4. Exécution de la fonction hostBindings avec RenderFlags.Update: cette fonction permet d’affecter les bindings provenant de l’élement HTML hôte avec @HostBinding(). Les éléments hôte font partie des éléments statiques et sont créés lors de l’exécution de la fonction template avec RenderFlags.Create donc à ce moment de l’exécution, ils ont déjà été créés.
  5. Exécution de la fonction template avec RenderFlags.Update: cette étape est la 1ère effectuée dans le corps de la méthode refreshView() du composant courant. Elle servira à mettre à jour le DOM avec tous les éléments dynamiques de la vue.
  6. Exécution des callbacks ngOnChanges(), ngOnInit() et ngDoCheck() dans les composants enfant.
  7. Exécution de refreshView() pour les vues intégrées (i.e. embedded views).
  8. Exécution de la fonction contentQueries() dans les directives enfant: cette étape permet de mettre à jour les requêtes sur le contenu projeté des directives enfant. Cette étape est possible car le contenu projeté a été rendu lors de l’exécution de la fonction template du composant.
  9. Exécution des callbacks ngAfterContentInit() et ngAfterContentChecked() des composants enfant.
  10. Exécution de la fonction hostBindings des directives enfant.
  11. Exécution de la méthode refreshView() des composants enfants.
Légende du schéma
  1. Exécution de la fonction viewQuery avec RenderFlags.Update: cette étape permet de mettre à jour les requêtes effectuées sur la vue du composant avec @ViewChild() et @ViewChildren. La vue du composant, les vues des composants enfant et les view containers des vues intégrées (i.e. embedded views) ont été rendus au début de l’exécution de cette fonction. Les requêtes sont donc effectuées sur des vues à jour.
  2. Exécution des callbacks ngAfterViewInit() et ngAfterContentChecked() des composants enfant: cette appel termine l’exécution de la méthode refreshView() du composant courant.
  3. Exécution des callbacks ngAfterViewInit() et ngAfterContentChecked(): cet appel est effectué dans le corps de la méthode refreshView() du composant parent.
    La callback ngAfterViewInit() est exécutée seulement à l’initialisation du composant.

Cette description permet de se rendre compte de l’imbrication d’un composant avec son parent. Beaucoup de traitements sont effectués par le parent en dehors du corps de la méthode refreshView() du composant courant.

“No Changes Mode”

Dans le code de la méthode refreshView(), on peut voir régulièrement des références au “No Changes Mode” par l’intérmédiaire d’un appel à la fonction getCheckNoChangesMode() pour récupérer un booléen indiquant l’activation ou non de ce mode.

A chaque détection de changements, la méthode refreshView() est exécuté 2 fois:

  • Une fois avec le mode “No Changes” désactivé: il s’agit de l’exécution normal de la méthode refreshView() pour effectuer la détection de changements et pour modifier le contenu dynamique de la vue.
  • Une 2e fois avec le mode “No changes” activé: cette exécution est effectuée seulement avec la configuration de développement. Elle permet d’exécuter la détection de changements une 2e fois sans modifier le contenu des vues en s’il y a de nouveaux changements détectés. Au cours d’une exécution idéale, il ne doit pas y avoir de changements détectés à la fin d’une exécution du mécanisme. Tous les changements doivent avoir été détectés. Cette 2e exécution vise à vérifier si tous les changements ont effectivement été détectés. Si de nouveaux changements sont détectés alors il y a une erreur d’implémentation car ces changements n’entraîneront pas une modification de la vue.

Dans le cas où un changement est détecté lors de la 2e exécution, une erreur de type “ExpressionChangedAfterItHasBeenCheckedError” est lancée.

L’appel est de ces 2 modes est effectué dans la méthode tick() appelée dans la callback exécutée par Zone.js:

tick(): void { 
    // [...] 
    for (let view of this._views) { 
        view.detectChanges(); 
    } 
    if (this._enforceNoNewChanges) { 
        for (let view of this._views) { 
            view.checkNoChanges();
        } 
    } 
    // [...] 
  } 

Dans ce code:

  • view.detectChanges() permet de lancer la 1ère exécution du changement de détection.
  • view.checkNoChanges() lance la 2e exécution en mode “No Changes”.

Pour résumer

Si on simplifie les schémas plus haut pour ne considérer que les étapes concernant le composant courant, on obtient le schéma suivant:

Légende du schéma

Ce schéma permet de se rendre compte de la succession des étapes de création et de mise à jour des éléments dans le DOM et l’exécution des callbacks du cycle de vie d’un composant. Ainsi, si un élément dyamique est modifié après sa mise à jour dans le DOM, on peut comprendre pourquoi il ne sera pas mis à jour dans la vue d’un composant.

Par exemple, si on modifie la valeur d’un binding lors de l’exécution des callbacks ngAfterViewInit() ou ngAfterViewChecked(), étant donné que la fonction template permettant de mettre à jour le DOM a été exécuté avant, il ne sera pas possible de mettre à jour la vue seulement avec le mécanisme de détection automatique de changements.

Il en est de même pour l’exécution de requête de vue et de contenu projeté qui intervient à des moments précis avant et après le rendu. Le résultat de ces requêtes peut être différent de celui attendu suivant si le rendu a été effectué ou non.

Références

Ivy:

Share on FacebookShare on Google+Tweet about this on TwitterShare on LinkedInEmail this to someonePrint this page

Les composants enfant (Angular)

@jplenio

Une fonctionnalité importante des composants est qu’ils peuvent contenir des directives. Par suite sachant que les composants sont des directives, il est possible d’imbriquer des composants les uns dans les autres. Un composant se trouvant dans un autre composant est appelé composant enfant (i.e. child component).

Dans la suite de cet article, on appellera:

  • “Composant parent”: le composant contenant d’autres composants,
  • “Composant enfant”: le composant imbriqué dans un autre composant.

Dans cet article, on ne parlera que de la composition des composants pour faciliter les explications toutefois il faut garder en tête que dans le cas général, les composants peuvent contenir des directives (pour davantage de détails, voir “Les directives Angular”).

Dans un premier temps, on indiquera comment placer un composant enfant dans un composant parent. Puis on explicitera la méthode pour injecter des paramètres dans un composant et comment être notifié par le déclenchement d’un évènement dans un composant enfant. Enfin, on expliquera la fonctionnalité de projection de contenu.

Pour imbriquer un composant dans un autre, il suffit d’indiquer le paramètre selector dans le template du composant parent. Pour que la résolution du template puisse réussir dans le composant parent, il faut que le composant enfant soit dans le même module que le composant parent.

Pour illustrer l’exemple d’un composant enfant, on va créer 2 composants:

  • ChildComponent qui servira de composant enfant,
  • ParentComponent qui servira de composant parent et qui contiendra ChildComponent.

Dans le répertoire du module dans lequel on veut créer les 2 composants, on exécute la commande suivante en utilisant le CLI Angular:

ng generate component Child
ng generate component Parent

Ou

ng g c Child
ng g c Parent

On modifie le paramètre selector du composant enfant:

Template
<h3>Child component</h3>
Classe du composant
@Component({
    selector: 'app-child',
    templateUrl: './child.component.html'
})
export class ChildComponent {}

Dans le composant parent, on modifie l’implémentation du template pour afficher le contenu du composant enfant:

<h1>Parent component</h1>
<app-child></app-child>

En affichant le composant parent, on verra aussi le composant enfant:

De façon très facultative, on peut rajouter un style CSS pour que l’affichage permette de faire la différence entre le composant parent et le composant enfant.

On modifie le style du composant parent dans le fichier CSS correspondant (i.e. parent.component.css):

:host {
    border: 1px solid black;
    display: block;
    background-color: lightgrey;
    width: 500px;
}

On modifie le style du composant enfant dans le fichier CSS child.component.css:

:host {
    border: 1px solid black;
    display: block;
    background-color: lightgreen;
    margin: 5px;
}

L’affichage devient:

Interactions avec les composants enfant

Les interactions possibles entre le composant parent et les composants enfant peuvent être de différente nature suivant l’origine de l’interaction, par exemple:

  • Du composant parent vers l’enfant:
    • En injectant le composant parent dans le composant enfant: utiliser l’injection de dépendances d’Angular pour injecter le composant parent dans le composant enfant.
    • En utilisant des paramètres d’entrée dans le composant enfant avec le décorateur @Input(): un property binding peut lier ce paramètre d’entrée avec une propriété du composant parent.
  • Du composant enfant vers le parent:
    • En utilisant le décorateur @ViewChild() pour accéder à l’instance du composant enfant dans la classe du composant parent.
    • En utilisant le décorateur @Output() pour émettre un évènement dans le composant enfant et notifier le composant parent.

On va expliciter chacune de ces interactions par la suite.

Injection du composant parent

L’interaction la plus directe entre un composant parent et un enfant est d’injecter le composant parent directement dans le composant enfant en utilisant l’injection de dépendances. Angular comporte un moteur d’injection de dépendances que l’on peut utiliser pour injecter dans un composant enfant une instance d’un de ses parents. L’injection ne se limite pas au composant parent direct, il est possible d’effectuer une injection de n’importe quel parent dans l’arbre de dépendances.

Par exemple, si l’implémentation du composant parent est:

Template
<h1>Parent component</h1> 
<app-child></app-child> 
Classe du composant
import { Component } from '@angular/core'; 

@Component({
    templateUrl: './parent.component.html' 
}) 
 
export class ParentComponent { 
    innerValue = 'Value defined in parent'; 
} 

Et si l’implémentation du composant enfant est:

Template
<h3>Child component</h3> 
Classe du composant
import { Component } from '@angular/core'; 
import { ParentComponent } from '../parent/parent.component'; 

@Component({ 
    selector: 'app-child', 
    templateUrl: './child.component.html' 
}) 
export class ChildComponent { 
    constructor(parent: ParentComponent) { 
        console.log(parent.innerValue); 
    }
} 

Dans le composant enfant, on peut ainsi accèder à l’instance de son parent.

Double dépendance = couplage fort

Même si l’injection du composant parent est une solution facile à implémenter, d’un point de vue de l’architecture, elle introduit une double dépendance entre le composant parent et le composant enfant puisque:

  • Le composant parent référence le composant enfant dans l’implémentation du template: c’est le sens conventionnel de dépendance puisque le template doit indiquer quel est le composant enfant à afficher.
  • Le composant enfant référence le composant parent avec:
    import { ParentComponent } from '../parent/parent.component'; 
    

Il y a, ainsi, une double dépendance puisque le composant parent doit avoir une connaissance de son enfant et inversement. Cette double dépendance amène le composant enfant à avoir une implémentation dépendante de celle du composant parent, ce qui renforce le couplage entre ces 2 composants.

Pour éviter cette double dépendance, il est préférable d’exposer des propriétés dans le composant enfant par l’intermédiaire des décorateurs @Input() et @Output() de façon à ce que la dépendance se fasse dans un seul sens, du parent vers l’enfant. Ainsi seul le composant parent a une connaissance du composant enfant. L’implémentation du composant enfant reste, alors, indépendante de celle du composant parent.

Exposer le composant parent avec une classe abstraite

Une méthode pour éviter la double dépendance entre le composant parent et le composant enfant est de passer par une classe abstraite pour limiter les éléments exposés par le composant parent au composant enfant.

Ainsi:

  • La classe abstraite définit les propriétés ou fonctions utilisables par le composant enfant,
  • Le composant parent implémente la classe abstraite et
  • L’instance du composant parent est injectée dans le composant enfant sous la forme de la classe abstraite. Le couplage entre le composant parent et enfant est, ainsi, davantage limité.

Par exemple, si on considère la classe abstraite suivante implémentée dans un fichier séparée ValueHandler.ts:

export abstract class ValueHandler { 
    abstract get innerValue(): string; 
} 

Pour injecter ValueHandler dans le composant enfant plutôt que ParentComponent, on configure l’injecteur de cette façon au niveau du composant parent:

  • Avec l’option provide pour indiquer le type de la classe abstraite
  • L’option useExisting pour indiquer une instance particulière de ParentComponent et
  • forwardRef() pour faire suivre la référence vers le type du composant parent.

L’implémentation du composant parent devient:

Template
<h1>Parent component</h1> 
<app-child></app-child> 
Classe du composant
import { Component, forwardRef } from '@angular/core'; 
import { ValueHandler } from '../ValueHandler'; 

@Component({ 
    templateUrl: './parent.component.html', 
    providers: [{ provide: ValueHandler, useExisting: forwardRef(() => ParentComponent) }]
}) 
export class ParentComponent extends ValueHandler { 
    get innerValue(): string { 
        return 'Value defined in Parent' 
    } 

    constructor() { 
        super(); 
    } 
} 

L’implémentation du composant enfant devient:

Template
<h3>Child component</h3> 
Classe du composant
import { Component } from '@angular/core'; 
import { ValueHandler } from '../ValueHandler'; 

@Component({ 
    selector: 'app-child', 
    templateUrl: './child.component.html' 
}) 
export class ChildComponent { 
    constructor(valueHandler: ValueHandler) { 
        console.log(valueHandler.innerValue); 
    }
} 

Dans le composant enfant, la référence vers le composant parent a disparu.

On ne peut pas utiliser d’interfaces

Il n’est pas possible d’utiliser une interface à la place de la classe abstraite pour exposer le composant parent.

Trouver un parent sur plusieurs niveaux

L’injection du composant parent dans le composant enfant n’est pas limitée au parent direct. Le parent peut se trouver à plusieurs niveaux du composant enfant.

Par exemple, si on considère 3 composants tels que:

  • ChildComponent est un composant enfant de MiddleComponent et
  • MiddleComponent est un composant enfant de ParentComponent.

Les implémentations des 3 composants sont:

  • Pour ParentComponent:
    Template
    <h1>Parent component</h1> 
    <app-middle></app-middle> 
    Classe du composant
    import { Component } from '@angular/core'; 
    
    @Component({ 
        templateUrl: './parent.component.html' 
    }) 
    export class ParentComponent { 
        innerValue = 'Value defined in parent'; 
    } 
  • Pour MiddleComponent:
    Template
    <h2>Middle component</h2> 
    <app-child></app-child> 
    Classe du composant
    import { Component } from '@angular/core'; 
    
    @Component({ 
        selector: 'app-middle', 
        templateUrl: './middle.component.html' 
    }) 
    export class MiddleComponent {} 
  • Et pour ChildComponent:
    Template
    <h3>Child component</h3> 
    Classe du composant
    import { Component} from '@angular/core'; 
    import { ParentComponent } from '../parent/parent.component'; 
    
    @Component({ 
        selector: 'app-child', 
        templateUrl: './child.component.html' 
    }) 
    export class ChildComponent { 
        constructor(parent: ParentComponent) { 
            console.log(parent.innerValue); 
        } 
    } 

L’injection réussit même si ParentComponent n’est pas le parent direct de ChildComponent.

@Optional()

On peut utiliser le décorateur @Optional() au niveau du paramètre du constructeur du composant enfant pour indiquer au moteur d’injection de dépendances de fournir null si la dépendance n’est pas trouvée.

Par exemple:

import { Component, Optional } from '@angular/core'; 

@Component({ 
    selector: 'app-child', 
    templateUrl: './child.component.html' 
}) 
export class ChildComponent { 
    constructor(@Optional() parent: ParentComponent) { 
        console.log(parent.innerValue); 
    } 
} 
Paramètre optionel

On peut rajouter ? dans le paramètre parent du constructeur pour indiquer que le paramètre est optionel:

constructor(@Optional() parent?: ParentComponent) { 
    console.log(parent.innerValue); 
} 

On peut, ainsi, appelé le constructeur de ChildComponent sans préciser de paramètre:

let child = new ChildComponent(); 

@SkipSelf()

Dans le cas où un composant configure l’injecteur de dépendances en faisant suivre la référence d’un type vers lui-même avec forwardRef() et qu’il injecte ce même type, @SkipSelf() permet d’éviter que l’instance injectée soit celle de ce composant. @SkipSelf() force le moteur d’injection de dépendances à aller chercher une autre instance à injecter.

Par exemple, si on considère 2 composants dans lesquels on fait suivre la référence d’un type vers eux-même avec forwardRef():

  • ParentComponent est le composant parent et
  • ChildComponent est le composant enfant de ParentComponent.

Les implémentations sont:

  • Pour ParentComponent:
    Template
    <h1>Parent component</h1> 
    <app-child></app-child> 
    Classe du composant
    import { Component, forwardRef } from '@angular/core'; 
    import { ValueHandler } from '../ValueHandler'; 
    
    @Component({ 
        templateUrl: './parent.component.html', 
        providers: [{ provide: ValueHandler, useExisting: forwardRef(() => ParentComponent) }] 
    }) 
    export class ParentComponent extends ValueHandler { 
        get innerValue(): string { 
            return 'Value defined in Parent'; 
        } 
    
        constructor() { 
            super(); 
        } 
    } 
  • Pour ChildComponent:
    Template
    <h3>Child component</h3> 
    Classe du composant
    import { Component, forwardRef } from '@angular/core'; 
    import { ValueHandler } from '../ValueHandler'; 
    
    @Component({ 
        selector: 'app-child', 
        templateUrl: './child.component.html', 
        providers: [{ provide: ValueHandler, useExisting: forwardRef(() => ChildComponent) }]
    }) 
    export class ChildComponent extends ValueHandler { 
        get innerValue(): string { 
            return 'Value defined in Child'; 
        } 
    
        constructor(valueHandler: ValueHandler) { 
            super(); 
            console.log(valueHandler.innerValue); 
        } 
    } 

L’implémentation de ValueHandler est la même que précédemment:

export abstract class ValueHandler { 
    abstract get innerValue(): string; 
} 

Si on essaie d’exécuter ce code, une erreur apparaîtra dans la console du browser indiquant qu’une référence circulaire existe dans le composant ChildComponent:

ERROR error: "Uncaught (in promise): Error: Circular dep for ChildComponent 
[...]" 

Cette erreur survient car l’injecteur de dépendance essaie d’injecter ChildComponent dans lui-même pour le paramètre valueHandler à cause de la configuration:

providers: [{ provide: ValueHandler, useExisting: forwardRef(() => ChildComponent) }] 

Pour injecter dans le paramètre valueHandler une instance de ParentComponent au lieu de ChildComponent, il faut utiliser le décorateur @SkipSelf() dans le constructeur de ChildComponent:

import { Component, SkipSelf } from '@angular/core'; 
import { ValueHandler } from '../ValueHandler'; 

@Component({ 
    selector: 'app-child', 
    templateUrl: './child.component.html', 
    providers: [{ provide: ValueHandler, useExisting: forwardRef(() => ChildComponent) }] 
}) 
export class ChildComponent extends ValueHandler { 
    get innerValue(): string { 
        return 'Value defined in Child 
    } 

    constructor(@SkipSelf() valueHandler: ValueHandler) { 
        super(); 
        console.log(valueHandler.innerValue); 
    } 
} 

A l’exécution, le résultat affiché dans la console du browser sera 'Value defined in Parent' puisque l’instance injectée pour le paramètre valueHandler est celle de ParentComponent.

@ViewChild() et @ViewChildren()

Une autre méthode d’interaction entre un composant parent et un composant enfant est d’utiliser les décorateurs @ViewChild() ou @ViewChildren(). Dans la classe du composant parent, ils permettent d’effectuer une requête sur la vue pour récupérer l’instance du ou des composants enfant qui y sont déclarées.

Ces décorateurs seront abordés plus en détails ultérieurement dans un article consacré aux requêtes effectuées dans la vue d’un composant.

@Input()

Le décorateur @Input() permet d’implémenter des paramètres d’entrée dans le composant enfant qu’on pourra initialiser à partir du composant parent.

Par exemple, pour implémenter le paramètre identifier dans le composant enfant, on modifie l’implémentation de la façon suivante:

Template
<p>Child component with identifier: {{identifier}}</p>
Classe du composant
import { Component, Input } from '@angular/core';

@Component({
    selector: 'app-child',
    templateUrl: './child.component.html'
})
export class ChildComponent {
    @Input() identifier: number;
}

On peut injecter le paramètre identifier à partir du composant parent en modifiant l’implémentation du template:

<h1>Parent component</h1>
<app-child identifier='1'></app-child>

Ainsi la valeur du paramètre identifier peut être initialisée à partir du composant parent.

Pour afficher plusieurs fois le composant enfant avec un identifiant différent:

<h1>Parent component</h1>
<app-child identifier='1'></app-child>
<app-child identifier='2'></app-child>

L’affichage devient:

Property binding

Pour effectuer un property binding entre une propriété de la classe du composant parent et le paramètre d’entrée du composant enfant, il suffit de modifier l’implémentation du parent:

Template
<h1>Parent component</h1>
<app-child [identifier]='childIdentifier'></app-child>
Classe du composant
import { Component } from '@angular/core';

@Component({
    templateUrl: './parent.component.html'
})
export class ParentComponent {
    childIdentifier = 1;
}

Ainsi:

  • On rajoute la propriété childIdentifier dans le classe du composant ParentComponent et
  • On effectue un property binding dans le template avec le paramètre d’entrée identifier du composant enfant: [identifier]='childIdentifier'.

Utiliser un alias pour identifier le paramètre injecté

On peut utiliser un alias pour identifier le paramètre injecté dans le template du composant parent. Il suffit d’indiquer l’alias en tant que paramètre du décorateur @Input('') dans le composant enfant.

Par exemple, si on utilise 'childComponentIdentifier' à la place de 'identifier' pour désigner le paramètre injecté dans le composant enfant, l’implémentation du composant enfant devient:

Template
<p>Child component with identifier: {{identifier}}</p>
Classe du composant
import { Component, Input } from '@angular/core';

@Component({
    selector: 'app-child',
    templateUrl: './child.component.html'
})
export class ChildComponent {
    @Input('childComponentIdentifier') 
    identifier: number;
}

On utilise l’alias dans le template du composant parent (dans parent.component.ts):

<h1>Parent component</h1>
<app-child childComponentIdentifier='1'></app-child>
<app-child childComponentIdentifier='2'></app-child>

Ce changement d’implémentation ne modifie pas le comportement.

@Output() + EventEmitter

@Input() permet d’effectuer un binding de paramètres du composant parent vers le composant enfant. A l’opposé, on peut notifier le composant parent à partir d’évènements survenus dans le composant enfant en utilisant l’event binding. Il n’est pas possible d’effectuer le binding d’une propriété du composant enfant vers le composant parent toutefois, l’event binding permet de déclencher l’exécution d’une méthode à chaque modification de cette propriété.

Dans un composant enfant, pour déclarer un évènement auquel pourra s’abonner le composant parent, il faut utiliser le décorateur @Output().

Par exemple, on modifie l’implémentation du composant enfant ChildComponent:

  • Dans le template:
    • on ajoute un élément input contenant une valeur qu’on pourra incrémenter. La valeur dans l’input sera bindée avec la propriété internalCount dans la classe du composant enfant.
    • On ajoute un bouton pour incrémenter la valeur dans l’élément input.
    • On ajoute la méthode incrementValue() qui permettra d’incrémenter la valeur de internalCount.
  • Dans la classe du composant enfant (child.component.ts): on ajoute la propriété internalCount et on déclare l’évènement countUpdated avec la décorateur @Output() pour notifier le composant parent quand le valeur de la propriété internalCount est modifiée.

L’implémentation du composant enfant devient:

  • Template:
    <p>Child component with identifier: {{identifier}}</p>
    <p>
        <input readonly='true' [(ngModel)]='internalCount' />
        <button (click)='incrementValue()'>Increment</button>
    </p>
    
  • Classe du composant:
    import { Component, Input, Output, EventEmitter } from '@angular/core';
    
    @Component({
        selector: 'app-child',
        templateUrl: './child.component.html'
    })
    export class ChildComponent {
        internalCount = 0;
    
        @Input('childComponentIdentifier') identifier: number;
    
        @Ouput() countUpdated: EventEmitter<number>= new EventEmitter<number>();
    
        incrementValue(): void {
            this.internalCount++;
            this.countUpdated.emit(this.identifier);
        }
    }

Dans le code du composant:

  • countUpdated: EventEmitter<number> = new EventEmitter<number>() permet d’initialiser un objet de type EventEmitter qui permettra de notifier le composant parent.
  • Dans incrementValue(), this.countUpdated.emit(this.internalIdentifier) déclenche l’évènement en incluant l’identifiant du composant enfant.

On modifie le composant parent:

  • Dans le template:
    • On effectue un event binding avec l’évènement countUpdated du composant enfant.
    • On ajoute un total des incrémentations des compteurs des composants enfant.
  • Dans la classe du composant: on implémente la méthode updateTotalCount() qui sera appelée à chaque déclenchement de l’évènement.

L’implémentation du composant parent devient:

  • Template:
    <h1>Parent component</h1>
    <app-child childComponentIdentifier='1' (countUpdated)='updateTotalCount($event)'></app-child>
    <app-child childComponentIdentifier='2' (countUpdated)='updateTotalCount($event)'></app-child>
    <p>Total: {{totalCount}}</p>
    
  • Classe du composant:
    import { Component } from '@angular/core';
    
    @Component({
        templateUrl: './parent.component.html'
    })
    export class AppComponent {
        totalCount = 0;
        lastUpdateIdentifier: number;
    
        updateTotalCount(childIdentifier: number): void {
            this.totalCount++;
            this.lastUpdateIdentifier = childIdentifier;
        }
    }

Ainsi, l’event binding permet de déclencher l’exécution de la méthode updateTotalCount() pour incrémenter totalCount et récupérer l’identifiant du dernier composant enfant pour lequel une incrémentation a été effectuée.

Le résultat devient:

Utiliser un alias pour identifier l’évènement

Comme pour le décorateur @Input(), on peut utiliser un alias pour identifier l’évènement auquel on s’abonne du coté du composant parent. Il suffit d’indiquer l’alias en tant que paramètre du décorateur @Output('') dans le composant enfant.

Par exemple, si on utilise 'childCountUpdated' à la place de 'countUpdated' pour désigner l’évènement déclaré dans le composant enfant, l’implémentation du composant enfant ChildComponent (dans child.component.ts) devient:

import { Component, Input, Output } from '@angular/core';

@Component({
    selector: 'app-child',
    templateUrl: './child.component.html'
})
export class ChildComponent {
    internalCount = 0;

    @Input('childComponentIdentifier') identifier: number;

    @Ouput('childCountUpdated') countUpdated: EventEmitter = new EventEmitter();

    incrementValue(): void {
        this.internalCount++;
        this.countUpdated.emit(this.internalIdentifier);
    }
}

Le template du composant enfant n’est pas modifié.

On utilise l’alias dans le template du composant parent (dans parent.component.ts):

<h1>Parent component</h1>
<app-child childComponentIdentifier='1' (childCountUpdated)='updateTotalCount($event)'></app-child>
<app-child childComponentIdentifier='2'  (childCountUpdated)='updateTotalCount($event)'></app-child>
<p>Total: {{totalCount}}</p>

Ce changement d’implémentation ne modifie pas le comportement.

Paramètres inputs et outputs de @Component()

Au lieu d’utiliser les décorateurs @Input() et @Output(), on peut utiliser les paramètres inputs et outputs du décorateur @Component(). A l’origine, ces paramètres sont utilisables dans le décorateur @Directive(), par suite le décorateur @Component() en hérite puisque les composants sont des directives. Pour plus de détails, voir le détail de ces paramètres pour les directives:

Content projection

La fonctionnalité content projection (i.e. projection de contenu) permet de réserver dans un composant enfant des espaces dont le contenu sera implémenté dans le template du composant parent. Le contenu est, ainsi, projeté du composant parent vers le composant enfant:

L’intérêt de cette fonctionnalité est de prévoir un composant enfant dont l’implémentation est générique pour permettre d’indiquer des éléments de la vue à partir du composant parent.

Pour indiquer dans le template du composant enfant où doit être placé le contenu projeté, il faut utiliser <ng-content></ng-content>.

Par exemple, si on considère le composant parent suivant:

Template
<h1>Parent component</h1>
<app-child identifier='1'></app-child>
Classe du composant
import { Component } from '@angular/core';

@Component({
    templateUrl: './parent.component.html',
    styleUrls: ['./parent.component.css']
})
export class ParentComponent {}

Dans cet exemple, on utilise les mêmes styles CSS que ceux définis plus haut pour avoir un affichage plus clair.

On considère le composant enfant ChildComponent suivant:

Template
<h3>Child component {{identifier}}</h3>
Classe du composant
import { Component } from '@angular/core';

@Component({
    templateUrl: './child.component.html',
    styleUrls: ['./child.component.css']
})
export class ChildComponent {
    @Input() identifier: number;
}

Si on exécute l’application, l’affichage est:

On modifie le composant enfant ChildComponent pour permettre la projection de contenu. Il suffit de rajouter ng-content à l’endroit où on souhaite la projection dans le template:

<h3>Child component</h3>
<ng-content></ng-content>

On modifie ensuite le template du composant parent en indiquant une implémentation du contenu à projeter:

<h1>Parent component</h1>
<app-child identifier='1'>
    <span>Content projection from parent component</span>
</app-child>

En exécutant l’application, l’affichage est:

De façon très facultative, on peut modifier le style CSS des composants pour que l’affichage puisse mettre en évidence le contenu projeté provenant du composant parent:

  • Dans child.component.css:
    :host {
        border: 1px solid black;
        display: block;
        background-color: lightgreen;
        margin: 5px;
        padding: 5px;
    }
    
  • Dans parent.component.css:
    :host {
        border: 1px solid black;
        display: block;
        background-color: lightgrey;
        width: 500px;
    }
    
    span {
        border: 1px solid black;
        background-color: lightgrey;
    }
    

L’affichage devient:

On peut choisir un contenu projeté différent directement à partir du template du composant parent:

<h1>Parent component</h1>
<app-child identifier='1'>
    <span>Content projection from parent component</span>
</app-child>
<app-child identifier='2'>
    <span>Different content projection</span>
</app-child>

L’affichage correspondant est:

Projection de contenu sur plusieurs niveaux

Dans tous les exemples précédents, on exploitait la projection de contenu sur un seul niveau c’est-à-dire la projection du contenu d’un parent vers un seul composant enfant.

Il est possible d’effectuer des projections vers des composants enfant se trouvant à plusieurs niveaux de hiérarchie du composant parent.
Par exemple, si on considère 3 composants ParentComponent, MiddleComponent et ChildComponent tels que:

  • MiddleComponent est un composant enfant de ParentComponent et
  • ChildComponent est un composant enfant de MiddleComponent.

A partir de ParentComponent, il est possible de projeter un contenu dans MiddleComponent (se trouvant au 1er niveau de ParentComponent) et dans ChildComponent (se trouvant au 2e niveau de ParentComponent).

Au niveau de la syntaxe, si:

  • Le selector de MiddleComponent est 'app-middle' et
  • Le selector de ChildComponent est 'app-child'.

Le contenu à projeter peut être implémenté de cette façon dans le template du composant ParentComponent:

<app-middle>
    // Ce contenu sera projeté dans MiddleComponent au 1er niveau
    <app-child>
        // Ce contenu sera projeté dans ChildComponent au 2e niveau
        <p>Projected content</p>
    </app-child>
</app-middle>

L’implémentation complète des composants est:

  • Pour ChildComponent:
    Template
    <h3>Child component</h3>
    <ng-content></ng-content>
    Classe du composant
    @Component({
        selector: 'app-child',
        templateUrl: './child.component.html'
    })
    export class ChildComponent {}
  • Pour MiddleComponent:
    Template
    <h2>Middle component</h2>
    <ng-content></ng-content>
    Classe du composant
    @Component({
        selector: 'app-middle',
        templateUrl: './middle.component.html'
    })
    export class MiddleComponent {}
  • Et pour ParentComponent:
    Template
    <h1>Parent component</h1>
    <app-middle>
        <app-child>
            <span>Projected content</span>
        </app-child>
    </app-middle>
    Classe du composant
    @Component({
        templateUrl: './parent.component.html'
    })
    export class ParentComponent {}

Le résultat permet de se rendre compte que le contenu est projeté sur tous les composants enfant sur plusieurs niveaux:

Multi-content projection

Il est possible d’effectuer des projections de plusieurs contenus dans le composant enfant en utilisant la syntaxe suivante quand on utilise <ng-content>:

<ng-content select='<type de l'élément à projeter>'></ng-content>

Par exemple, si on modifie le template du composant enfant ChildComponent pour autoriser plusieurs contenus à projeter:

<h3>Child component</h3>
<ng-content select='h4'></ng-content>
<ng-content select='span'></ng-content>

On implémente, ensuite, 2 projections dans le template du composant parent:

<h1>Parent component</h1>
<app-child identifier='1'>
     <span>Content projection from parent component</span>
     <h4>The content is:</h4>
</app-child>

Ainsi:

  • Le contenu de <span></span> est projeté dans la partie <ng-content select='span'></ng-content> du template de ChildComponent.
  • Le contenu de <h4></h4> est projeté dans la partie <ng-content select='h4'></ng-content> du template de ChildComponent.

L’affichage correspondant est:

Si on utilise plusieurs indications <ng-content> mais qu’une de ces indications ne possède pas d’attribut select, alors le contenu projeté sera le contenu qui ne correspond à aucune des autres clauses select.

Par exemple, si on considère l’implémentation suivante dans le template du composant enfant:

<h3>Child component</h3>
<ng-content select='h4'></ng-content>
<ng-content></ng-content>
<ng-content select='span'></ng-content>

On modifie l’implémentation dans le template du composant parent:

<h1>Parent component</h1>
<app-child [identifier]='1'>
     <span>Input value is: {{inputElement.value}}</span>
     <h4>The content is:</h4>
     <p><input #inputElement ngModel /></p>
</app-child>

Ainsi:

  • Le contenu de <span></span> est projeté dans la partie <ng-content select='span'></ng-content>.
  • Le contenu de <h4></h4> est projeté dans la partie <ng-content select='h4'></ng-content>.
  • Le contenu de <p></p> est projeté dans <ng-content></ng-content> car il ne correspond à aucunes autres clauses select.

L’affichage correspondant est:

Paramètre providers vs viewProviders de @Component()

La paramètre providers du décorateur @Component() est utilisé dans le cadre de l’injection de dépendances pour configurer les injecteurs au niveau du composant. Ce paramètre peut être utilisé pour les décorateurs:

Ainsi, si on utilise le paramètre providers dans le décorateur @Component(), l’instance injectée sera la même pour le composant et pour tous ses composants enfant.

Contenu projeté vs contenu non projeté

Avant d’expliquer le paramètre viewProviders, il faut distinguer 2 types de contenu présent dans la vue d’un composant:

  • Le contenu non projeté: il contient les éléments implémentés dans la vue de ce composant:
    • Directement si ces éléments sont implémentés dans le template ou
    • Indirectement si ces éléments sont implémentés dans un composant enfant ou une directive.
  • Le contenu projeté: il contient des éléments provenant d’un autre composant et qui sont projetés avec <ng-content></ng-content>.

Paramètre viewProviders de @Component()

A l’opposé du paramètre providers, le paramètre viewProviders va configurer les injecteurs pour que l’injection soit limitée exclusivement aux composants se trouvant dans le contenu non projeté d’une vue d’un composant.

L’intérêt de viewProviders par rapport au paramètre providers est de limiter l’injection d’une classe dans un cadre plus restreint. Par exemple dans le cas d’une bibliothèque à l’intérieur de laquelle on souhaite effectuer l’injection d’une classe. Les injections ne seront limitées aux composants ayant un contenu non projeté c’est-à-dire les contenus se trouvant à l’intérieur de la bibliothèque. Les contenus projetés provenant de l’extérieur de la bibliothèque ne seront pas concernés par ces injections.

Par exemple, si on considère 3 composants:

  • CallerComponent qui sera le composant parent se trouvant à l’extérieur de la bibliothèque.
  • LibraryComponent qui sera le composant se trouvant à l’intérieur de la bibliothèque.
  • ProjectedComponent qui sera le composant qui sera injecté dans la bibliothèque.

On va effectuer une projection de contenu dans LibraryComponent et ProjectedComponent à partir de CallerComponent sur plusieurs niveaux. On va utiliser successivement le paramètre providers et viewProviders de façon à voir les différences.

On considère la classe suivante qui sera injectée dans le composant:

export class Dependency {
    message: string;

    constructor(caller: string) {
        this.message = 'Instance from: ' + caller;
    }
}

Voici le code correspondant aux 3 composants:

  • Pour ProjectedComponent:
    Template
    <p><b>ProjectedComponent</b></p>
    <p>{{dependency.message}}</p>
    <ng-content></ng-content>
    Classe du composant
    import { Component } from '@angular/core';
    import { Dependency } from '../dependency';
    
    @Component({
      selector: 'app-projected',
      templateUrl: './projected.component.html',
      styleUrls: ['./projected.component.css']
    })
    export class ProjectedComponent {
      constructor(public dependency: Dependency) {}
    }
  • Pour LibraryComponent:
    Template
    <p><b>LibraryComponent</b></p>
    <p>{{dependency.message}}</p>
    
    Projected content from outside:
    <ng-content></ng-content>
    Classe du composant
    import { Component } from '@angular/core';
    import { Dependency } from '../dependency';
    
    const dependency = new Dependency('library component');
    
    @Component({
      selector: 'lib-library',
      templateUrl: './library.component.html',
      styleUrls: ['./library.component.css']
    })
    export class LibraryComponent {
      constructor(public dependency: Dependency) {}
    }
  • Et pour CallerComponent:
    Template
    <p><b>CallerComponent</b></p>
    <p>{{dependency.message}}</p>
    <lib-library>
        <app-projected>
            <span>Projected content</span>
        </app-projected>
    </lib-library>
    Classe du composant
    import { Component } from '@angular/core';
    import { Dependency } from '../dependency';
    
    @Component({
      templateUrl: './caller.component.html',
      styleUrls: ['./caller.component.css']
    })
    export class CallerComponent {
      constructor(public dependency: Dependency) {}
    }

De façon très facultative, on modifie les fichiers de style des composants CallerComponent et LibraryComponent pour que l’affichage permette de faire la différence entre les différents composants:

  • Dans le fichier CSS de CallerComponent (dans caller.component.css):
    :host {
        border: 1px solid black;
        display: block;
        background-color: lightgrey;
        width: 500px;
    }
    
    app-projected {
        border: 2px dashed black;
        display: block;
        background-color: lightgreen;
        margin: 5px;
        padding: 5px;
    }
    
    span {
        border: 2px dashed black;
        background-color: white;
    }
    
  • Dans le fichier CSS de LibraryComponent (dans library.component.css):
    :host {
        border: 1px solid black;
        display: block;
        background-color:  #bb8fce;
        margin: 5px;
        padding: 5px;
    }
    
    app-projected {
        border: 1px solid black;
        display: block;
        background-color: lightblue;
        margin: 5px;
        padding: 5px;
    }
    
    span {
        border: 2px dashed black;
        background-color: white;
    }
    

Paramètre providers au niveau du module uniquement

Si on place le paramètre providers au niveau du module dans lequel se trouve tous les composants, la même instance sera injectée et utilisée dans tous les composants:

Le code du module devient:

import { Dependency } from '../Dependency';

const dependency = new Dependency('module');

@NgModule({
    ...
    providers: [ { provide: Dependency, useValue: dependency} ]
})

Le paramètre useValue permet de configurer les injecteurs pour injecter une instance précise de Dependency.

A l’exécution, le résultat permet de montrer que l’instance provient du module:

Paramètre providers au niveau du composant

Si on ajoute le paramètre providers au niveau du composant LibraryComponent, l’instance utilisée sera:

  • Dans CallerComponent, l’instance provenant du module.
  • Dans LibraryComponent, l’instance provenant dans LibraryComponent et
  • Dans ProjectedComponent, l’instance provenant de LibraryComponent puisque ProjectedComponent est projeté dans LibraryComponent.

On modifie LibraryComponent pour instancier une nouvelle classe Dependency et ajouter le paramètre providers à ce niveau:

Template
<p><b>LibraryComponent</b></p>
<p>{{dependency.message}}</p>

Projected content from outside:
<ng-content></ng-content>
Classe du composant
import { Component } from '@angular/core';
import { Dependency } from '../dependency';

const dependency = new Dependency('library component');

@Component({
  selector: 'lib-library',
  templateUrl: './library.component.html',
  styleUrls: ['./library.component.css'],
  providers: [ { provide: Dependency, useValue: dependency} ]
})
export class LibraryComponent {
  constructor(public dependency: Dependency) {}
}

Le résultat permet de montrer que l’instance Dependency utilisée dans LibraryComponent et ProjectedComponent est celle instanciée dans LibraryComponent:

Paramètre viewProviders au niveau de LibraryComponent

Si on modifie LibraryComponent pour utiliser viewProviders au lieu de providers, l’instance injectée sera:

  • Dans CallerComponent, l’instance provenant du module (pas de changement).
  • Dans LibraryComponent, l’instance provenant dans LibraryComponent (pas de changement) et
  • Dans ProjectedComponent, l’instance provenant du module car viewProviders permet de limiter l’injection au contenu non projeté. ProjectedComponent étant projeté dans LibraryComponent, l’instance de Dependency injectée sera celle du module.

On modifie LibraryComponent pour utiliser viewProviders au lieu de providers:

Template
<p><b>LibraryComponent</b></p>
<p>{{dependency.message}}</p>

Projected content from outside:
<ng-content></ng-content>
Classe du composant
import { Component } from '@angular/core';
import { Dependency } from '../dependency';

const dependency = new Dependency('library component');

@Component({
  selector: 'lib-library',
  templateUrl: './library.component.html',
  styleUrls: ['./library.component.css'],
  viewProviders: [ { provide: Dependency, useValue: dependency} ]
})
export class LibraryComponent {
  constructor(public dependency: Dependency) {}
}

Le résultat permet de montrer que l’instance Dependency utilisée dans ProjectedComponent est celle instanciée dans le module c’est-à-dire à l’extérieur de la bibliothèque:

Ajout d’un contenu directement dans LibraryComponent

On va rajouter le composant enfant ProjectedComponent directement dans LibraryComponent. Cette instance de ProjectedComponent ne sera pas projetée mais fera partie directement du contenu de LibraryComponent. Cet exemple permet de montrer que les instances de Dependency seront différentes dans le cas où ProjectedComponent fait partie du contenu projeté ou non projeté. Ainsi:

  • Dans l’instance de ProjectedComponent qui fait partie du contenu projeté, l’instance injectée de Dependency est celle du module à cause du paramètre viewProviders au niveau de LibraryComponent.
  • Dans l’instance de ProjectedComponent qui fait partie du contenu non projeté, l’instance injectée de Dependency est celle de LibraryComponent.

On modifie seulement le fichier template de LibraryComponent pour ajouter ProjectedComponent en tant composant enfant:

Template
<p><b>LibraryComponent</b></p>
<p>{{dependency.message}}</p>

Projected content from outside:
<ng-content></ng-content>

Child:
<app-projected>
    <span>Projected content from LibraryComponent</span>
</app-projected>
Classe du composant
import { Component } from '@angular/core';
import { Dependency } from '../dependency';

const dependency = new Dependency('library component');

@Component({
  selector: 'lib-library',
  templateUrl: './library.component.html',
  styleUrls: ['./library.component.css'],
  viewProviders: 
    [ { provide: Dependency, useValue: dependency} ]
})
export class LibraryComponent {
  constructor(public dependency: Dependency) {}
}

Dans le résultat, on peut voir que la 2e instance de ProjectedComponent faisant partie du contenu non projeté de LibraryComponent comporte une instance de Dependency provenant de LibraryComponent. Le reste des injections n’est pas modifié:

Ordre d’exécution des callbacks du cycle de vie d’un composant

Lors de la création et du rendu de la vue d’un composant, certaines callbacks peuvent être déclenchées de façon successive dans la classe du composant dans le cas où elles sont implémentées. Dans la documentation Angular ces callbacks sont appelées “lifecycle hooks”.

Pour rappel, à l’initialisation d’un composant, les callbacks de ce cycle de vie (i.e. Lifecycle hooks) sont, dans l’ordre de déclenchement:

  1. ngOnChanges(): cette callback est exécutée si le composant contient des propriétés en entrée (notamment avec le décorateur @Input()).
  2. ngOnInit(): déclenchée après l’exécution du constructeur. Il permet d’initialiser le composant avec le 1er affichage des données de la vue ayant un binding avec des propriétés de la classe du composant. Le cas échéant, il permet d’affecter les paramètres en entrée du composant. Cette callback est déclenchée une seule fois à l’initialisation du composant même si ngOnChanges() n’est pas déclenchée.
  3. ngDoCheck() permet d’indiquer des changements si Angular ne les a pas détecté.
  4. ngAfterContentInit() est déclenchée à l’initialisation après la projection de contenu. Elle est déclenchée même s’il n’y a pas de contenu à projeter.
  5. ngAfterContentChecked(): déclenchée après la détection de changement dans le contenu projeté. Cette callback est déclenchée même s’il n’y a pas de projection de contenu.
  6. ngAfterViewInit(): déclenchée après l’initialisation de la vue du composant et après l’initialisation de la vue des composants enfant.
  7. ngAfterViewChecked() est déclenchée après détection d’un changement dans la vue du composant et dans la vue des composants enfant.
  8. ngOnDestroy() est déclenchée avant la destruction du composant.

A chaque détection de changements, les callbacks déclanchées sont, dans l’ordre:

  1. ngOnChanges() si les paramètres en entrée du composant sont modifiés.
  2. ngDoCheck()
  3. ngAfterContentChecked() est déclenchée même s’il n’y a pas de contenu projeté.
  4. ngAfterViewChecked().

Ainsi quand le composant comporte des composants enfant, l’ordre d’exécution est le suivant à l’initialisation:

Exécution du constructeur du composant parent
Exécution du constructeur du composant enfant
Exécution des callbacks du composant parent jusqu’à ngAfterContentChecked()
  1. ParentComponent.ngOnChanges()
  2. ParentComponent.ngOnInit()
  3. ParentComponent.ngDoCheck()
  4. ParentComponent.ngAfterContentInit()
  5. ParentComponent.ngAfterContentChecked()
Exécution des callbacks du composant enfant y compris ngAfterViewInit() et ngAfterViewChecked()
  1. ChildComponent.ngOnChanges()
  2. ChildComponent.ngOnInit()
  3. ChildComponent.ngDoCheck()
  4. ChildComponent.ngAfterContentInit()
  5. ChildComponent.ngAfterContentChecked()
  6. ChildComponent.ngAfterViewInit()
  7. ChildComponent.ngAfterViewChecked()
Exécution des callbacks restantes du parent
  1. ParentComponent.ngAfterViewInit()
  2. ParentComponent.ngAfterViewChecked().

Lors de la détection d’un changement, les callbacks sont exécutées dans cet ordre:

Exécution des callbacks du composant parent sauf ngAfterViewChecked()
  1. ParentComponent.ngOnChanges()
  2. ParentComponent.ngDoCheck()
  3. ParentComponent.ngAfterContentChecked()
Exécution des callbacks du composant enfant
  1. ChildComponent.ngOnChanges()
  2. ChildComponent.ngDoCheck()
  3. ChildComponent.ngAfterContentChecked()
  4. ChildComponent.ngAfterViewChecked()
Exécution de ParentComponent.ngAfterViewChecked()

Pour résumer…

Pour imbriquer un composant dans un autre:

  • D’abord il faut que le composant enfant soit déclaré dans le module du composant parent pour que la résolution réussisse.
  • Ensuite le template du composant parent doit contenir le contenu du paramètre selector du composant enfant:
    Par exemple si le paramètre selector du composant est:

    @Component({
        selector: 'app-child',
        templateUrl: './child.component.html'
    })
    export class ChildComponent {}
    
  • Le template du composant doit contenir:
    <app-child></app-child>
    

Pour injecter un composant parent dans un composant enfant:
Pour injecter un des composants parent dans un composant enfant, il suffit d’indiquer un paramètre du type du parent dans le constructeur du composant enfant:

export class ChildComponent { 
    constructor(parent: ParentComponent) { 
        console.log(parent.innerValue); 
    }
}

Pour éviter un couplage trop fort entre un composant parent et un composant enfant, on peut utiliser une classe abstraite au lieu d’injecter directement le parent. Le composant parent doit satisfaire la classe abstraite et l’injecteur de dépendances doit être configuré avec l’option useExisting:

@Component({ 
    [...]
    providers: [{ provide: AbstractComponent, useExisting: forwardRef(() => ParentComponent) }]
}) 
export class ParentComponent extends AbstractComponent { 
    constructor() { 
        super(); 
    } 
} 

L’injection est effectuée dans le composant enfant avec la classe abstraite:

export class ChildComponent { 
    constructor(parent: AbstractComponent) { 
    }
}

Pour effectuer un binding avec le composant enfant:

  • Property binding:
    Le composant enfant doit déclarer les propriétés exposées en tant que paramètre d’entrée avec le décorateur @Input(), par exemple:

    @Input() identifier: number;
    

    Le composant parent peut effectuer un property binding avec la propriété du composant enfant à partir du template:

    <app-child [identifier]='1'></app-child>
    

    Avec un alias, la propriété doit être de cette façon:

    @Input('identifier_alias') identifier: number;
    

    On utilise l’alias dans le template du composant parent:

    <app-child [identifier_alias]='1'></app-child>
    
  • Event binding:
    Le composant enfant doit déclarer l’évènement à exposer avec le décorateur @Output() et EventEmitter:

    @Ouput() updated: EventEmitter<number>= new EventEmitter<number>();
    

    Le composant parent peut effectuer un event binding avec la propriété du composant enfant à partir du template:

    <app-child (updated)='triggerFunction($event)'></app-child>
    

    triggerFunction($event) est la fonction du composant parent qui sera exécutée à chaque déclenchement de l’évènement.
    Il est aussi possible d’utiliser un alias avec @Output().

Content projection
La fonctionnalité content projection permet de projeter un contenu à partir du composant parent dans un composant enfant.

Si 'app-child' est le selector du composant enfant, pour qu’un contenu soit projeté à partir du composant parent la syntaxe dans le template doit être:

<app-child>
  <!-- Contenu projeté -->
</app-child>

L’emplacement du contenu à projeter doit être indiqué dans le composant enfant avec:

<ng-content></ng-content>

Si <ng-content> est omis dans le composant enfant, il n’y aura pas d’erreur.

On peut projeter plusieurs contenus en les nommant avec l’attribut select. Par exemple:

<ng-content select='h4'></ng-content>
<ng-content></ng-content>
<ng-content select='span'></ng-content>

Si le template du composant parent est:

<app-child [identifier]='1'>
     <span>Input value is: {{inputElement.value}}</span>
     <h4>The content is:</h4>
     <p><input #inputElement ngModel /></p>
</app-child>

Alors:

  • Le contenu de <span></span> est projeté dans la partie <ng-content select='span'></ng-content>.
  • Le contenu de <h4></h4> est projeté dans la partie <ng-content select='h4'></ng-content>.
  • Le contenu de <p></p> est projeté dans <ng-content></ng-content> car il ne correspond à aucuns autres attributs select.

Paramètres providers et viewProviders de @Component()
Les paramètres providers et viewProviders du décorateur @Component() permettent de paramètrer les injecteurs pour effectuer de l’injection de dépendances:

  • providers configure les injecteurs d’un composant pour que la même instance d’un objet soit injectée dans ce composant et dans tous les composants et directives dont il est le parent.
  • viewProviders limite l’injection d’une instance d’objet aux composants et directives faisant partie du contenu non projeté d’un composant.

Lifecycle hooks
Dans le cas où un composant comporte un composant enfant, l’ordre d’exécution des lifecycle hooks est plus complexe:

  • A l’initialisation:
  • A chaque détection d’un changement:
Share on FacebookShare on Google+Tweet about this on TwitterShare on LinkedInEmail this to someonePrint this page

Les directives Angular

@gersonrepreza

Les directives permettent de modifier ou d’enrichir un élément du DOM en rajoutant ou en modifiant une propriété par programmation. Ces directives peuvent être utilisées à l’intérieur de composants.

Fonctionnellement les directives peuvent paraître semblables aux composants enfant toutefois la grande différence entre les directives et les composants est que la directive n’a pas de vue. En effet, il n’est pas possible d’utiliser un paramètre template ou templateUrl dans le décorateur @Directive() permettant de déclarer une directive.

Dans la documentation Angular, les directives sont découpées en 3 catégories:

  • Les composants: ce sont des directives avec une vue implémentée dans un fichier template. Les composants seront développés dans un article séparé.
  • Les autres types de directives ne disposent pas de vue mais elles permettent de modifier le DOM en ajoutant ou en supprimant des éléments du DOM:
    • Les directives attribut (i.e. attribute directives): ces directives peuvent modifier l’apparence et le comportement des éléments, composants et d’autres directives.
    • Les directives structurelles (i.e. structural directives): elles se distinguent des directives attribut car elles utilisent un modèle (i.e. template) pour modifier le DOM. Il ne faut pas confondre ce modèle avec le template d’un composant.

Dans un premier temps, on va expliciter les paramètres les plus importants du décorateur des directives @Directive(). Dans une 2e partie, on explicitera des indications sur les directives attribut puis sur les directives structurelles.

D’un point de vue implémentation, les directives doivent être déclarées avec le décorateur @Directive() et le paramètre selector. Ce paramètre est utilisé dans le template d’un composant de façon à indiquer où la directive sera résolue.

Par exemple, si une directive est définie de la façon suivante:

import { Directive, ElementRef, Renderer2 } from '@angular/core'; 

@Directive({ 
  selector: 'custom-directive' 
}) 
export class CustomDirective { 
  constructor(private elem: ElementRef, private renderer: Renderer2) {  
    let newText = renderer.createText('Text from directive');  
    renderer.appendChild(elem.nativeElement, newText); 
  }
} 

Elle peut être utilisée de la façon suivante dans le template d’un composant:

<p>Host component</p> 
<custom-directive></custom-directive>

Comme pour les composants, au moment d’afficher une vue, une résolution est effectuée en fonction du code se trouvant dans le template, pour savoir quelle directive doit être utilisée. Pour que la résolution réussisse, la directive doit être rajoutée dans le module où se trouve le composant, par exemple:

import { CustomDirective } from './custom-directive'; 

@NgModule({ 
  declarations: [ CustomDirective ],  
  ... 
}) 
export class CustomModule {}

Cette directive rajoute le texte 'Text from directive' dans le corps de l’objet du DOM:

L’affichage obtenu avec cet exemple est:

En rajoutant quelques éléments de style CSS dans le fichier de style du composant, on peut voir l’élément correspondant à la directive:

:host { 
  border: 1px solid black;  
  display: block;  
  padding: 5px; 
} 

custom-directive { 
  border: 1px solid black;  
  display: block; 
  background-color: lightgreen; 
} 

Le résultat devient:

Pour voir la différence entre un composant et une directive, on peut afficher l’inspecteur d’objets du DOM dans le browser.

Par exemple pour un composant, l’objet du DOM sera <ng-component>:

Pour une directive, l’objet du DOM sera le nom de l’élément utilisé dans le paramètre selector ou l’élément HTML qui est l’hôte de la directive:

Créer une directive avec le CLI Angular

Pour créer une directive avec le CLI Angular, il faut exécuter la ligne suivante:

ng generate directive <nom de la directive>  

Ou

ng g d <nom de la directive>

Cette commande crée:

  • un fichier contenant la classe de la directive nommé <nom de la directive>.directive.ts,
  • un fichier de test nommé <nom de la directive>.directive.spec.ts et
  • modifie le fichier du module Angular pour ajouter la directive dans le paramètre declarations du décorateur @NgModule().

Configuration des directives

Paramètre selector

Ce paramètre est le plus important car c’est lui qui va indiquer comment la directive sera utilisée. En fonction de la syntaxe utilisée, la directive sera utilisée comme un objet du DOM à part entière, une classe CSS ou un attribut dans un élément HTML etc…

Le paramètre selector s’utilise dans le décorateur @Directive():

@Directive({ 
  selector: <valeur> 
}) 
export class TestDirective {}

La syntaxe de la valeur peut être:

  • Directement le nom d’un élément HTML:
    Par exemple:

    selector: 'custom-directive'
    

    Dans ce cas, la directive doit être utilisée directement en tant qu’élément dans le template du composant:

    <custom-directive></custom-directive>
    
  • Attribut d’un élément HTML:
    selector: '[custom-directive]'
    

    Ce type de directive peut être utilisé en tant qu’attribut d’un élément HTML:

    <span custom-directive></span>
    

    L’attribut peut comporter une valeur:

    <span custom-directive="attribute value"></span>
    

    La directive est reconnue aussi dans le cas d’un property binding:

    <span [custom-directive]="bindedProperty"></span>
    

    Toutefois dans ce dernier cas, la directive devra comporter un paramètre d’entrée avec le même nom ou le même alias que le paramètre selector.

  • Classe CSS:
    Par exemple:

    selector: '.custom-directive' 
    

    Dans ce cas, la directive doit être utilisée dans une classe d’un élément HTML:

    <span class="custom-directive"></span>
    

On peut utiliser des conditions plus précises pour que la directive s’applique:

  • Suivant la valeur d’un attribut d’un élément HTML:
    Par exemple:

    selector: '[title=custom-directive]'
    

    Dans ce cas, l’élément HTML doit comporter l’attribut title="custom-directive":

    <span title="custom-directive"></span> 
    
  • Suivant un élément HTML et sur la valeur d’un de ces attributs:
    Par exemple:

    selector: 'p[title=custom-directive]' 
    

    Dans ce cas, l’élément HTML doit être spécifiquement un <p></p> et il doit comporter l’attribut title="custom-directive":

    <p title="custom-directive"></p>
    
  • Utiliser l’opérateur logique NOT à une condition:
    Par exemple:

    selector: ':not([custom-directive])'
    

    Dans ce cas, pour que la directive s’applique, l’élément HTML ne doit pas contenir d’attribut custom-directive:

    <span custom-directive>With attribute</span> 
    <span>Without attribute</span> 
    

    La directive ne sera appliquée que dans le 2e cas.

  • Utiliser l’opérateur logique OR entre 2 conditions:
    Par exemple:

    selector: '[custom-directive], [title=custom-directive]' 
    

    Dans ce cas, la directive s’appliquera si l’un des attributs suivants est présent:

    <span custom-directive></span> 
    <span title="custom-directive"></span> 
    

    La directive s’appliquera dans ces 2 cas d’utilisation de span.

Paramètre inputs

Ce paramètre utilisable dans le décorateur @Directive() permet d’injecter des paramètres d’entrée dans la directive à partir du composant hôte. Le nom de la donnée membre doit être indiqué directement sous forme de chaîne de caractères dans le paramètre inputs, par exemple:

import { Directive, ElementRef, Renderer2, OnInit } from '@angular/core'; 

@Directive({ 
  selector: 'custom-directive', 
  inputs: [ 'textToDisplay' ] 
}) 
export class CustomDirective implements OnInit { 
  textToDisplay: string; 
  
  constructor(private elem: ElementRef, private renderer: Renderer2) {} 

  ngOnInit(): void { 
    let newText = this.renderer.createText(this.textToDisplay); 
    this.renderer.appendChild(this.elem.nativeElement, newText); 
  } 
} 

Pour injecter la valeur à partir du template du composant dans lequel on utilise la directive on utilise un attribut:

<p>Host Component</p> 
<custom-directive textToDisplay='Value defined from component'></custom-directive> 

A l’exécution, la valeur est affichée dans la directive:

Dans cet exemple la valeur injectée est une chaine de caractère toutefois on peut injecter des objets avec des types plus complexes et effectuer un property binding dans le template du composant.

Par exemple, si on définit la directive de cette façon:

import { Directive, ElementRef, Renderer2, OnInit } from '@angular/core'; 

export class DisplayedText { 
  constructor(textToDisplay: string) {} 
} 
 
@Directive({ 
  selector: 'custom-directive', 
  inputs: [ 'textToDisplay' ] 
}) 
export class CustomDirective implements OnInit { 
  text:DisplayedText;

  constructor(private elem: ElementRef, private renderer: Renderer2) {} 

  ngOnInit(): void { 
    let newText = this.renderer.createText(this.text.textToDisplay); 
    this.renderer.appendChild(this.elem.nativeElement, newText); 
  }
} 

Il faut modifier la classe du composant pour injecter un objet avec le nouveau type:

import { DisplayedText } from './custom-directive'; 

@Component({ ... }) 
export class HostComponent { 
  injectedParameter: DisplayedText; 

  constructor() { 
    this.injectedParameter = new DisplayedText('Value defined from component'); 
  } 
} 

Ensuite dans le template du composant, on effectue un property binding:

<p>Host component</p> 
<custom-directive [text]='injectedParameter'></custom-directive> 

Utilisation d’un alias

Il est possible d’utiliser un alias pour éviter d’utiliser le même nom que la propriété/membre dans la directive. Dans le paramètre inputs dans le décorateur @Directive(), la syntaxe doit être:

inputs: [ '<propriété/membre dans la directive>: <attribut dans le template>' ] 

Par exemple, en utilisant le même exemple que précédemment:

import { Directive, ElementRef, Renderer2, OnInit } from '@angular/core'; 

@Directive({ 
  selector: 'custom-directive', 
  inputs: [ 'textToDisplay: inner-text' ] 
}) 
export class CustomDirective implements OnInit { 
  textToDisplay: string; 

  constructor(private elem: ElementRef, private renderer: Renderer2) {} 

  ngOnInit(): void { 
    let newText = this.renderer.createText(this.textToDisplay); 
    this.renderer.appendChild(this.elem.nativeElement, newText); 
  }
}

Dans le template du composant utilisant la directive, on utilise l’attribut inner-text au lieu d’utiliser directement le nom du membre:

<p>Host component</p> 
<custom-directive inner-text='Value defined from component'></custom-directive> 
Injecter des paramètres avec les attributs de l’élément hôte

Dans la plupart des cas suivant la formé utilisée dans le paramètre selector, les directives peuvent comporter des arguments en entrée ou en sortie. Par exemple si on considère une directive s’appliquant suivant le nom d’une classe CSS:

import { Directive, ElementRef, Renderer2, OnInit } from '@angular/core'; 

@Directive({ 
  selector: '.custom-directive', 
  inputs: [ 'textToDisplay' ]
}) 
export class CustomDirective { 
  textToDisplay: string; 

  constructor(private elem: ElementRef, private renderer: Renderer2) {} 
} 

La directive s’applique si la classe CSS "custom-directive" est appliquée, par exemple:

<span class="custom-directive"></span> 

On peut injecter les arguments dans la directive en les appliquant en tant qu’attributs de l’élément hôte qui est un élément HTML span dans cet exemple:

<span class="custom-directive" textToDisplay="Value defined from component"></span> 

@Input()

On peut utiliser une syntaxe différente pour injecter un paramètre d’entrée en utilisant le décorateur @Input() au lieu d’utiliser le paramètre inputs dans le décorateur @Directive(). Le comportement est le même qu’avec le paramètre inputs.

Pour utiliser le décorateur @Input(), il suffit de l’indiquer quand le membre est déclaré dans la classe de la directive:

@Input() <nom de la propriété/membre>: <type de la propriété/membre>; 

Par exemple, en reprenant l’exemple précédent:

import { Directive, ElementRef, Renderer2, OnInit, Input } from '@angular/ core'; 

@Directive({ 
  selector: 'custom-directive', 
}) 
export class CustomDirective implements OnInit { 
  @Input() textToDisplay: string;

  constructor(private elem: ElementRef, private renderer: Renderer2) {} 

  ngOnInit(): void { 
    let newText = this.renderer.createText(this.textToDisplay); 
    this.renderer.appendChild(this.elem.nativeElement, newText); 
  }
} 

Il n’y a pas de changement pour injecter la valeur dans le template du composant hôte:

<p>Host Component</p> 
<custom-directive textToDisplay='Value defined from component'></custom-directive> 

Utilisation d’un alias

Utiliser un alias est aussi possible avec le décorateur @Input() pour éviter d’utiliser le même nom que le membre dans la directive. La syntaxe doit être:

@Input('<alias>') <nom de la propriété/membre>: <type de la propriété/membre>;

Par exemple:

import { Directive, ElementRef, Renderer2, OnInit, Input } from '@angular/ core'; 

@Directive({ 
  selector: 'custom-directive', 
}) 
export class TestDirective implements OnInit { 
  @Input('inner-text') textToDisplay: string;

  constructor(private elem: ElementRef, private renderer: Renderer2) {} 

  ngOnInit(): void { 
    let newText = this.renderer.createText(this.textToDisplay); 
    this.renderer.appendChild(this.elem.nativeElement, newText); 
  }
} 

On doit ensuite, utiliser l’alias quand on consomme la directive:

<p>Host Component</p> 
<custom-directive inner-text='Value defined from component'></custom-directive> 
Raccourci: utiliser le même identifiant entre le selector de la directive et le paramètre

Si la condition d’application de la directive est la même que le nom du paramètre d’entrée de la directive, un seul attribut dans l’élément hôte permet d’appliquer la directive et d’injecter un argument, par exemple:

import { Directive, ElementRef, Renderer2, OnInit } from '@angular/core'; 

@Directive({ 
  selector: '[textToDisplay]',
  inputs: [ 'textToDisplay' ] 
}) 
export class CustomDirective { 
  textToDisplay: string; 

  constructor(private elem: ElementRef, private renderer: Renderer2) {} 
}

Il suffit d’utiliser un seul attribut pour utiliser la directive:

<span textToDisplay="Value defined from component"></span> 

Paramètre outputs

Ce paramètre est utilisable dans le décorateur @Directive() pour déclarer des évènements de la directive auxquels le composant hôte peut s’abonner. Le nom de la donnée membre doit être indiqué directement sous forme de chaîne de caractères dans le paramètre outputs, par exemple:

import { Directive, ElementRef, Renderer2, Output } from '@angular/ core'; 

@Directive({ 
  selector: 'custom-directive', 
  outputs: [ 'innerEvent' ]
}) 
export class CustomDirective { 
  innerEvent: EventEmitter<string> = new EventEmitter<string>();

  constructor(private elem: ElementRef, private renderer: Renderer2) {} 
} 

Pour illustrer l’abonnement à l’évènement innerEvent par le composant hôte, on va perfectionner cet exemple en permettant à la directive de rajouter un bouton clickable. Avec l’objet de type Renderer2, on rajoute un bouton; on ajoute un texte à ce bouton puis on ajoute une callback déclenchée quand on clique sur le bouton. Le code devient:

import { Directive, ElementRef, Renderer2 } from '@angular/ core'; 

@Directive({ 
  selector: 'custom-directive', 
  outputs: [ 'innerEvent' ]
}) 
export class CustomDirective { 
  innerEvent: EventEmitter<string> = new EventEmitter<string>();

  constructor(private elem: ElementRef, private renderer: Renderer2) { 
    let newButton = this.renderer.createElement('button'); 
    let buttonText = this.renderer.createText('Click Me'); 

    // On ajoute de texte au bouton 
    this.renderer.appendChild(newButton, buttonText); 

    // On ajoute la callback correspondant au clique sur le bouton 
    this.renderer.listen(newButton, 'click', () => this.buttonClicked());

    // On ajoute le bouton à l'élément 
    this.renderer.appendChild(this.elem.nativeElement, newButton); 
  } 
 
  private buttonClicked(): void { 
    this.innerEvent.emit('From inside');
  } 
} 

L’objet de type EventEmitter permet de déclencher l’évènement.

Pour s’abonner à l’évènement, le composant hôte doit effectuer un event binding. On modifie le template du composant pour s’abonner à l’évènement et pour rajouter un compteur qu’on incrémentera à chaque clique:

<p>Host Component</p> 
<custom-directive innerEvent='onDirectiveClicked($event)'></custom-directive> 
<p>Click count: {{clickCount}}</p> 

On modifie la classe du composant en rajoutant une implémentation pour la méthode onDirectiveClicked():

@Component({ ... }) 
export class HostComponent { 
  clickCount: number; 

  constructor() { 
    this.clickCount = 0; 
  } 

  onDirectiveClicked(message: string) { 
    this.clickCount++; 
    console.log(message); 
  } 
} 

Au moment de déclencher l’évènement dans la directive, on a ajouté un argument correspondant à une chaîne de caractères: 'From Inside'. On peut récupérer cet argument quand la callback onDirectiveClick() est exécutée.

Après exécution, on obtient l’affichage suivant:

Utilisation d’un alias

Il est possible d’utiliser un alias pour éviter d’utiliser le même nom que le membre dans la directive. Dans le paramètre outputs dans le décorateur @Directive(), la syntaxe doit être:

outputs: [ '<nom de la propriété/membre dans la directive>: <attribut dans le template>' ] 

Par exemple, en utilisant le même exemple que précédemment:

import { Directive, ElementRef, Renderer2 } from '@angular/ core'; 

@Directive({ 
  selector: 'custom-directive', 
  outputs: [ 'innerEvent: inner-event' ]
}) 
export class CustomDirective { 
  innerEvent: EventEmitter<string> = new EventEmitter<string>(); 

  // ... 
} 

On doit ensuite, utiliser l’alias quand on consomme la directive:

<p>Host Component</p> 
<custom-directive inner-event='onDirectiveClicked($event)'></custom-directive> 
<p>Click count: {{clickCount}}</p> 

@Output()

On peut utiliser une syntaxe différente pour déclarer un évènement en utilisant le décorateur @Output() au lieu d’utiliser le paramètre outputs dans le décorateur @Directive(). Le comportement est le même qu’avec le paramètre outputs.

Pour utiliser le décorateur @Output(), il suffit de l’indiquer quand le membre est déclaré dans la classe de la directive:

@Output() <nom de la propriété/membre>: <type de la propriété/membre>; 

Par exemple, en reprenant l’exemple précédent:

import { Directive, ElementRef, Renderer2, Output } from '@angular/ core'; 

@Directive({ 
  selector: 'custom-directive' 
}) 
export class CustomDirective { 
  @Output() innerEvent: EventEmitter<string> = new EventEmitter<string>();
 
  constructor(private elem: ElementRef, private renderer: Renderer2) { 
    let newButton = this.renderer.createElement('button'); 
    let buttonText = this.renderer.createText('Click Me'); 

    this.renderer.appendChild(newButton, buttonText); 
    this.renderer.listen(newButton, 'click', () => this.buttonClicked()); 
    this.renderer.appendChild(this.elem.nativeElement, newButton); 
  } 

  private buttonClicked(): void { 
    this.innerEvent.emit('From inside'); 
  } 
} 

Il n’y a pas de changements pour injecter la valeur dans le template du composant hôte:

<p>Host Component</p> 
<custom-directive innerEvent='onDirectiveClicked($event)'></custom-directive> 
<p>Click count: {{clickCount}}</p> 

Utilisation d’un alias

Utiliser un alias est aussi possible avec le décorateur @Output() pour éviter d’utiliser le même nom que le membre dans la directive. La syntaxe doit être:

@Output('<alias>') <nom de la propriété/membre>: <type de la propriété/membre>;

Par exemple:

import { Directive, ElementRef, Renderer2, Output } from '@angular/ core'; 

@Directive({ 
  selector: 'custom-directive' 
}) 
export class CustomDirective { 
  @Output('inner-event') innerEvent: EventEmitter<string> = new EventEmitter<string>(); 

  // ... 
} 

On doit ensuite, utiliser l’alias quand on consomme la directive:

<p>Host Component</p> 
<custom-directive inner-event='onDirectiveClicked($event)'></custom-directive> 
<p>Click count: {{clickCount}}</p> 

Paramètre providers

Le paramètre providers dans le décorateur @Directive() permet de configurer les injecteurs de la directive pour indiquer le provider de paramètres injectés par injection de dépendances. Voir la partie Injection de dépendances pour plus de détails.

@HostBinding()

Le décorateur @HostBinding() dans une directive permet d’effectuer un binding entre un membre de la directive et une propriété de l’objet du DOM qui est l’hôte de la directive.

Ainsi on définit la directive suivante utilisable en tant qu’attribut d’un élément HTML, on rajoute une propriété avec le décorateur @HostBinding() pour effectuer un binding entre la propriété style.background-color de l’élément hôte de la directive:

import { Directive, ElementRef, Renderer2, HostBinding } from '@angular/ core'; 

@Directive({ 
  selector: '[custom-directive]' 
}) 
export class CustomDirective { 
  @HostBinding('style.background-color') backgroundColor: string = 'lightgreen';
} 

En utilisant la directive en tant qu’attribut d’un élément HTML, la couleur d’arrière plain sera modifiée:

<p>Host Component</p> 
<p custom-directive>Text with background</p> 

Le résultat est du type:

@HostListener()

Le décorateur @HostListener() permet à la directive de s’abonner à un évènement du DOM de façon à ce qu’une fonction soit exécutée quand l’évènement est déclenché.

La directive suivante est utilisable en tant qu’attribut d’un élément HTML, on ajoute une méthode avec l’attribut @HostListener() de façon à déclencher son exécution si on clique sur l’élément hôte:

import { Directive, ElementRef, Renderer2, HostBinding } from '@angular/ core'; 

@Directive({ 
  selector: '[custom-directive]' 
}) 
export class CustomDirective { 
  @HostListener('click') onHostClicked(triggeredEvent) : void { 
    console.log(triggeredEvent);
  } 
} 

On utilise la directive en tant qu’attribut d’un élément HTML:

<p>Host Component</p> 
<p custom-directive>Click on the text</p> 

A l’exécution, l’affichage est:

Si on clique sur le texte, on verra les détails de l’évènement dans la console du browser:

On peut avoir une liste exhaustive des évènements des objets du DOM sur lesquels on peut utiliser le décorateur @HostListener() sur cette page: www.w3schools.com/jsref/dom_obj_event.asp.

Attribute directives

Les directives attribut (i.e. attribute directive) peuvent manipuler le DOM et les propriétés des éléments du DOM en utilisant les objets Angular ElementRef et Renderer2.

ElementRef et Renderer2

Dans le code de l’exemple présenté plus haut, 2 objets de type ElementRef et Renderer2 sont injectés dans la directive:

import { Directive, ElementRef, Renderer2 } from '@angular/core'; 

@Directive({ 
  selector: 'custom-directive' 
}) 
export class CustomDirective { 
  constructor(private elem: ElementRef, private renderer: Renderer2) {  
    let newText = renderer.createText('Text from directive');  
    renderer.appendChild(elem.nativeElement, newText); 
  }
} 

Ainsi:

  • Le paramètre injecté de type ElementRef est un wrapper de l’objet du DOM. La propriété ElementRef.nativeElement permet d’accéder directement à l’objet du DOM.
  • Le paramètre injecté de type Renderer2 permet d’obtenir une classe permettant d’effectuer des modifications sur l’objet du DOM.

Le type Renderer2 comporte de nombreuses fonctions pour modifier les propriétés d’objets dans le DOM comme:

  • Pour créer un nouvel élément:
    • createElement(): crée un élément HTML comme <div>, <ul>, etc…
    • createText(): crée un texte à rajouter à un élément existant comme on peut le voir dans l’exemple précédent.
  • Pour modifier l’emplacement des éléments dans le DOM:
    • appendChild() rajoute un nouvel élément à un élément existant.
    • insertBefore() rajoute un nouvel élément avant un élément et dans un élément parent.
    • removeChild() supprime un élément à l’intérieur d’un élément parent.
  • Pour trouver des éléments:
    • selectRootElement() retourne l’élément de plus haut niveau dans le DOM à partir du nom d’un élément enfant.
    • parentNode() renvoie le nœud parent d’un élément.
  • Pour modifier les éléments:
    • setAttribute() ajoute un attribut à un élément. Le terme “attribut” est utilisé pour qualifier l’attribut d’un élément HTML.
    • removeAttribute() supprime un attribut d’un élément. Le terme attribut est utilisé pour qualifier l’attribut d’un élément HTML.
    • setProperty() permet d’affecter une valeur à une propriété d’un objet dans le DOM.
    • addClass() rajoute une classe CSS à un élément.
    • removeClass() supprime une classe CSS d’un élément.
    • setStyle() rajoute un style en inline dans un élément HTML (sous forme d’attribut).
    • removeStyle() supprime l’attribut style en inline d’un élément HTML.
    • listen() pour ajouter un évènement à un élément.

Exemple de directive attribut

On se propose d’implémenter un exemple qui va renseigner les différents élément li (i.e. list item) d’une liste ordonnée ol (i.e. ordered list). La liste d’élément correspond à une liste d’utilisateur. L’utilisateur est affiché si la propriété User.canBeDisplayed est égale à true.

L’implémentation de la directive est:

export class User {
  constructor(public firstName: string, public lastName: string, 
    public canBeDisplayed: boolean) {}
}

@Directive({
  selector: '[displayUsers]'
})
export class DisplayUser implements OnInit {
  @Input('displayUsers') users: User[];

  constructor(private elem: ElementRef, private rendered: Renderer2) {}

  ngOnInit(): void {
    if (this.users) {
      this.users.forEach(user => {
        if (user.canBeDisplayed) {
          let newListItemElement = this.renderer.createElement('li');
          let listItemText = this.renderer.createText(user.firstName + ' ' +
            user.lastName);
          this.renderer.appendChild(newListItemElement, listItemText);
          this.renderer.appendChild(this.elem.nativeElement, newListItemElement);
        }
      });
    }
  }
}

L’implémentation du composant est:

Template Classe du composant
<p>Users are:</p>
<ol [displayUsers]="userList"></ol>
@Component({ ... }) 
export class HostComponent {
  userList: User[];

  constructor() {
    this.userList = [
      new User('Beatrix', 'Kiddo', true),
      new User('Bill', 'Bill', true),
      new User('Elle', 'Driver', false),
      new User('O-Ren', 'Ishii', true)
    ]
  }
}

Dans cet exemple, on crée une directive attribut pour ajouter des éléments HTML li (i.e. list item) pour afficher une liste d’utilisateurs:

<ol>
  <li><Prénom> <Nom></li>
  <li><Prénom> <Nom></li>
  <!-- ... -->
  <li><Prénom> <Nom></li>
</ol>

Ainsi:

  • Dans la directive, on injecte ElementRef et Renderer2 corrrespondant, respectivement, à l’objet dans lequel on va rajouter les éléments li et l’objet qui va permettre d’effectuer les modifications dans l’objet ElementRef.
  • Le paramètre selector de la directive '[displayUsers]' permet d’effectuer la résolution de la directive si un élément HTML contient un attribut displayUsers ou [displayUsers] (cette dernière forme permettant d’effectuer un property binding dans le template du composant).
  • Dans le corps de la méthode ngOnInit(), on implémente l’ajout des éléments li à proprement parlé.
  • Dans le template du composant, on ajoute l’élément HTML ol (i.e. ordered list) pour lister les éléments, on ajoute l’attribut [displayUsers] pour permettre la résolution de la directive et ajouter un property binding avec la propriété userList dans la classe du composant.

Le résultat est:

Structural directives

Les directives structurelles (i.e. structural directive) sont plus complexes à implémenter que les directives attribut car elles passent par l’intermédiaire d’un modèle (i.e. template) pour générer les éléments du DOM correspondant. En injectant des données dans ce modèle, la directive sera capable de générer plusieurs éléments du DOM.

Le modèle utilisé par les directives structurelles est objet de type TemplateRef identifié dans les vues par <ng-template>. La plupart du temps, <ng-template> n’apparaît pas explicitement dans les vues des composants hôte qui utilisent la directive. La plupart de temps, la microsyntaxe permet d’en exploiter les fonctionnalités les plus importantes.

Avant de rentrer dans les détails de l’implémentation des directives structurelles, on va expliquer comment <ng-template> fonctionne. Il n’est pas indispensable de connaître toutes les fonctionnalités de cet objet pour l’utiliser.

<ng-template>

<ng-template> est un objet complexe qui permet:

  • d’implémenter un modèle pour créer des vues et
  • d’utiliser ce modèle pour créer des vues.

Les vues créées ne sont pas de même niveau que les vues d’un composant, ce sont des vues intégrées (i.e. embedded view) qui sont placées dans une vue. Ces vues intégrées sont ajoutées dans le DOM en fonction de l’implémentation du modèle.

Par exemple, si on considère un composant suivant:

Template Classe du composant
<p>Host component</p> 
<ng-template> 
  <p>Template content</p> 
</ng-template> 
@Component({ ... }) 
export class HostComponent {} 

A l’exécution, il n’y aura aucun contenu correspondant à la partie <ng-template> ... </ng-template> car pour que la classe TemplateRef génère une vue intégrée (i.e. embedded view), il faut la créer explicitement par programmation. Pour créer une vue, il faut créer un view container (i.e. “conteneur de vue”) qui va servir d’hôte à la vue intégrée.

Affichage Code HTML généré

View container

Un view container (i.e. “conteneur de vue”) est capable d’utiliser un modèle de type TemplateRef pour créer une vue. Ainsi un modèle a besoin d’un conteneur pour produire une vue. Les vues, view containers et vues intégrées forment une hiérarchie où les uns sont imbriqués dans les autres.

Cette hiérarchie forme un arbre appelée arbre hiérarchique des vues (i.e. view hierarchy tree). Angular forme cet arbre en mémoire de façon à avoir une idée de l’ordre d’imbrication des éléments. Cette arbre est différent du DOM toutefois les modifications apportées dans l’arbre hiérarchique des vues sont répercutées dans le DOM, le browser répercute ces modifications ensuite dans l’affichage. De même les modifications dans le DOM sont scrutées par Angular et sont répercutées dans l’arbre hiérarchique des vues.

Pour qu’un vue provenant d’un modèle soit affichée et qu’elle soit rajoutée dans le DOM, elle doit se trouver dans un view container. Au moment où on sollicite le modèle, on peut:

  • appeler explicitement le view container pour qu’il crée la vue ou
  • Angular trouve le view container correspondant au modèle de façon à ce qu’il soit appelé pour créer la vue.

L’arbre hiérarchique des vues sert ainsi à savoir quelles sont les imbrications entre les éléments pour déterminer quelle peut être le view container correspondant à un modèle.

L’exemple plus haut n’affiche rien car aucun view container n’a été sollicité pour créer la vue correspondant au modèle. Pour qu’une vue intégrée soit créée, il faut explicitement le faire par programmation en utilisant la fonction ViewContainerRef.createEmbeddedView(), par exemple:

<p>Host component</p> 
<ng-template #template> 
  <p>Template content</p> 
</ng-template> 
<div #viewContainer></div> 
@Component({ ... }) 
export class HostComponent implements AfterViewInit { 
  @ViewChild('viewContainer', { read: ViewContainerRef }) viewContainer: ViewContainerRef; 
  @ViewChild('template', { read: TemplateRef }) template: TemplateRef<any>; 

  ngAfterViewInit(): void { 
    this.viewContainer.createEmbeddedView(this.template); 
  } 
} 

Dans ce code:

  • On rajoute l’élément <div #viewContainer> avec une variable référence de façon à pouvoir effectuer un binding avec la classe du composant. Cet élément va servir de view container au modèle.
  • On ajoute une variable référence au modèle <ng-template #template> de façon à effectuer un binding avec la classe du composant.
  • Avec les décorateurs @ViewChild(), on va créer des bindings entre les éléments du template et des membres de la classe du composant.
  • A l’instanciation des objets décorés avec @ViewChild() c’est-à-dire quand la méthode ngAfterViewInit() est déclenchée, on appelle explicitement ViewContainerRef.createEmbeddedView() pour créer la vue intégrée avec le modèle en paramètre et l’ajouter au view container.

L’affichage et le DOM contiennent le contenu du modèle:

Affichage Code HTML généré

Dans l’exemple précédent, on précise explicitement le view container qui est l’élément HTML <div> toutefois on peut aussi utiliser une vue fournie par Angular par injection. Par exemple, si on déclare un objet de type ViewContainerRef dans le constructeur du composant, Angular va injecter la vue parente du composant:

<p>Host component</p> 
<ng-template #template> 
  <p>Template content</p> 
</ng-template> 
<div #viewContainer></div> 
@Component({ ... }) 
export class HostComponent implements AfterViewInit { 
  @ViewChild('template', { read: TemplateRef }) template: TemplateRef<any>;  

  constructor(private parentViewRef: ViewContainerRef) {} 

  ngAfterViewInit(): void { 
    this.parentViewRef.createEmbeddedView(this.template);
  } 
} 

Le template sera, ainsi, rajouté à la vue parente du composant:

Affichage Code HTML généré

Injecter des données dans le modèle avec le contexte

Pour rendre le modèle moins statique, ngTemplate permet de déclarer des variables dont la valeur sera affectée en fonction d’un contexte. Ce contexte sera injecté dans le template de l’extérieur.

Pour déclarer des variables dans le modèle, il faut passer par des attributs et utiliser une syntaxe particulière avec let:

let-<nom de la variable>="<valeur de la variable>" 

Par exemple, pour définir 2 variables nommées contentPrefix et contentSuffix, la déclaration sera:

<ng-template 
  let-contentPrefix="messageContentPrefix" 
  let-contentSuffix="messageContentSuffix"> 
  <p>Content prefix: {{contentPrefix}}</p> 
  <p>Content suffix: {{contentSuffix}}</p> 
</ng-template> 
<div #viewContainer></div> 

Dans cet exemple, les valeurs des variables proviennent des propriétés messageContentPrefix et messageContentSuffix présentent dans le contexte. On peut affecter le contexte au moment de créer la vue intégrée avec ViewContentRef.createEmbeddedView():

@Component({ ... }) 
export class HostComponent implements AfterViewInit { 
  @ViewChild('template', { read: TemplateRef }) template: TemplateRef<any>; 
  @ViewChild('viewContainer', { read: ViewContainerRef }) viewContainer: ViewContainerRef; 

  ngAfterViewInit(): void { 
    this.parentViewRef.createEmbeddedView(this.template, 
    { 
      messageContentPrefix: 'This message is from...', 
      messageContentSuffix: '...the component.' 
    }); 
  } 
} 

Le contexte est injecté par l’intérmédiaire d’un object literal dont les propriétés correspondent à celles indiquées dans les déclarations du modèle.

Dans cet exemple, le contexte est un object literal car le modèle est de type TemplateRef<any>. Le type any donne la possibilité d’utiliser un contexte de n’importe quel type. On peut utiliser un contexte d’un type plus précis en le précisant dans le type du modèle (l’exemple de directive structurelle plus bas utilise un type plus précis).

En réalité cet exemple ne fonctionne pas et produit une erreur visible sur la console du browser du type:

ExpressionChangedAfterItHasBeenCheckedError: Expression has changed after it was checked. 
 Previous value: 'undefined'. Current value: 'This message is from...'. It seems like
 the view has been created after its parent and its children have been dirty checked. 
 Has it been created in a change detection hook?

Cette erreur se produit car le cycle de vie des objets de la vue n’est pas tout à fait respecté.

Détection des changements et cycle de vie d’une vue

Durant le cycle de vie d’une vue et pour afficher les différents éléments, un certain nombre d’évènements sont déclenchés successivement dont:

  1. ngOnInit() est déclenchée quand Angular affiche les propriétés par data binding et affecte les données d’entrée dans les composants ou les directives.
  2. ngDoCheck(): cette méthode est déclenchée à chaque fois qu’Angular détecte un changement nécessitant de mettre à jour une vue.
  3. ngAfterContentInit() est déclenchée après projection de contenu externe dans la vue d’un composant.
  4. ngAfterViewInit() est exécutée quand Angular initialise les vues et les vues enfant d’un composant.

Angular utilise la succession de ces évènements de façon à détecter les changements pour savoir quand les données affichées à l’écran ont été mises à jour. La détection de changement dans les données permet de mettre à jour l’affichage. A chaque détection d’un changement, la méthode ngDoCheck() sera exécutée.

Ainsi:

  • Le modèle se trouve dans une vue intégrée et est affiché juste avant le déclenchement de la méthode ngAfterViewInit().
  • De même, les propriétés ayant un binding avec des éléments sur la vue avec le décorateur @ViewChild() sont initialisées juste avant le déclenchement de l’évènement ngAfterViewInit().

La vue intégrée est créée, toutefois son contenu est modifié à cause de l’injection du contexte ce qui entraîne la détection d’un changement de données par Angular. Angular se comporte mal quand des changements sont détectées après exécution de la méthode ngAfterViewInit() d’où le message d’erreur ExpressionChangedAfterItHasBeenCheckedError lors de l’exécution de l’exemple précédent.

Une solution pour corriger cette erreur consiste à utiliser l’option { static: true } (disponible à partir d’Angular 8) au moment de déclarer les propriétés avec le décorateur @ViewChild():

@ViewChild('template', { read: TemplateRef, static: true }) template: TemplateRef<any>; 
@ViewChild('viewContainer', { read: ViewContainerRef, static: true }) viewContainer: ViewContainerRef; 

Avec le décorateur @ViewChild(), une résolution est effectuée pour trouver à quel élément dans la vue, la propriété doit être bindée. Suivant la valeur de l’option { static: true }, le comportement est le suivant:

  • true: la résolution est effectuée avant l’exécution de la détection des changements.
  • false (valeur par défaut): la résolution est effectuée après détection des changements.

Ainsi, avec { static: true }, les propriétés sont initialisées avant l’exécution de l’évènement ngOnInit() soit bien avant le déclenchement de ngAfterViewInit(). En corrigeant l’exemple précédent en plaçant la création de la vue intégrée dans ngOnInit(), on évite ainsi l’erreur:

  • Template:
    <ng-template #template 
      let-contentPrefix="messageContentPrefix" 
      let-contentSuffix="messageContentSuffix"> 
      <p>Content prefix: {{contentPrefix}}</p> 
      <p>Content suffix: {{contentSuffix}}</p> 
    </ng-template> 
  • Classe du composant:
    @Component({ ... }) 
    export class HostComponent implements OnInit { 
      @ViewChild('template', { read: TemplateRef, static: true }) 
        template: TemplateRef<any>; 
      @ViewChild('viewContainer', { read: ViewContainerRef, static: true }) 
        viewContainer: ViewContainerRef; 
    
      ngOnInit(): void { 
        this.parentViewRef.createEmbeddedView(this.template, 
        { 
          messageContentPrefix: 'This message is from...', 
          messageContentSuffix: '...the component.' 
        }); 
      } 
    } 
    

Le résultat est:

$implicit

Quand on déclare les variables utilisées dans le modèle, il n’est pas obligatoire d’indiquer explicitement de quelle propriété du contexte provient la valeur de la variable. Dans le contexte, on peut déclarer un propriété comme étant implicite en la nommant $implicit, ainsi toutes les variables pour lesquelles on ne précise pas la propriété d’où doit provenir la valeur, auront la valeur de la propriété $implicit.

Par exemple, si le modèle est déclaré de la façon suivante:

<ng-template #template
  let-contentPrefix="messageContentPrefix" 
  let-contentSuffix="messageContentSuffix"> 
  <p>Content prefix: {{contentPrefix}}</p> 
  <p>Content suffix: {{contentSuffix}}</p> 
</ng-template> 

La valeur des variables:

  • contentPrefix provient de la propriété messageContentPrefix dans le contexte.
  • contentSuffix provient de la propriété messageContentSuffix dans le contexte.

Le contexte doit comporter les 2 propriétés:

this.parentViewRef.createEmbeddedView(this.template, 
{ 
  messageContentPrefix: 'This message is from...', 
  messageContentSuffix: '...the component.' 
}); 

Si on considère que la propriété messageContentPrefix est implicite alors on peut omettre d’utiliser son nom dans le modèle:

<ng-template let-contentPrefix let-contentSuffix="messageContentSuffix"> 
  <p>Content prefix: {{contentPrefix}}</p> 
  <p>Content suffix: {{contentSuffix}}</p> 
</ng-template> 

Le contexte doit comporter une propriété implicite:

this.parentViewRef.createEmbeddedView(this.template, 
{ 
  $implicit: 'This message is from...',
  messageContentSuffix: '...the component.' 
}); 

Cette modification de l’implémentation ne change pas le comportement du modèle.

ngTemplateOulet et ngTemplateOutletContext

<ng-template> est un modèle mais il peut se comporter aussi comme une vue intégrée en utilisant les attributs ngTemplateOulet et ngTemplateOutletContext:

  • ngTemplateOutlet permet d’implémenter un modèle.
  • ngTemplateOutletContext permet d’affecter le contexte.

Ainsi, si on écrit:

<ng-template #viewTemplate let-content> 
  <p>Template content: {{content}}</p> 
</ng-template> 
<ng-template  
  [ngTemplateOutlet]="viewTemplate" 
  [ngTemplateOutletContext]="{ $implicit: 'OK' }"> 
</ng-template> 

L’élément avec la variable référence #viewTemplate permet de définir un modèle et le 2e élément <ng-template> permet de construire une vue intégrée en utilisant le modèle et le contexte.

Avec cette construction, il n’est pas nécessaire d’appeler explicitement la fonction ViewContainerRef.createEmbeddedView() pour créer la vue intégrée.

Le résultat est:

Affichage Code HTML généré

On peut affecter les valeurs des attributs ngTemplateOutlet et ngTemplateOutletContext par property binding. En modifiant l’exemple précédent:

<ng-template #viewTemplate let-content> 
  <p>Template content: {{content}}</p> 
</ng-template> 
<ng-template  
  [ngTemplateOutlet]="template" 
  [ngTemplateOutletContext]="context"> 
</ng-template> 
@Component({ ... }) 
export class HostComponent { 
  @ViewChild('viewTemplate', { read: TemplateRef, static: true }) 
    template: TemplateRef<any>; 

  context = { $implicit: 'OK' }; 
} 

Le résultat est le même que précédemment.

Utiliser ngTemplate avec une directive

Les composants sont des directives avec une vue, ainsi pour créer une vue intégrée (i.e. “embedded view”) à partir d’une directive:

  • On peut définir le modèle dans la vue d’un composant hôte,
  • Déclarer une directive structurelle en l’utilisant dans la vue du composant hôte,
  • Créer la vue intégrée par programmation à partir du modèle dans la directive.

Par exemple, si l’implémentation de la directive est:

@Directive({ 
  selector: '[template-directive]' 
})
export class TemplateDirective implements OnInit { 
  constructor(private parentViewRef: ViewContainerRef, private template: TemplateRef) {} 

  ngOnInit: void { 
    this.parentViewRef.createEmbeddedView(this.template, { $implicit: 'OK' }); 
  } 
} 

Et l’implémentation du composant hôte:

Template Classe du composant
<p>Host component</p> 
<ng-template template-directive let-content> 
  <p>Template content: {{content}}</p> 
</ng-template> 
@Component({ ... }) 
export class HostComponent {} 

Dans cet exemple:

  • On définit la directive structurelle (i.e. structural directive) TemplateDirective dont le paramètre selector '[template-directive]'.
  • Le constructeur de la directive permet d’injecter les paramètres:
    • parentViewRef contenant la vue parente c’est-à-dire la vue du composant hôte.
    • template contenant le modèle qui sera utilisé pour créer la vue dans la directive.
  • On implémente le modèle dans la vue du composant avec:
    • template-directive qui est l’attribut pour que la directive TemplateDirective soit utilisée.
    • let-content pour déclarer la variable content dont la valeur est affectée par la propriété $implicit du contexte.
  • La vue intégrée du modèle est créée dans la directive dans le corps de la méthode ngOnInit().

Si on ajoute un paramètre nommée textToDisplay en entrée de la directive pour renseigner la texte à afficher, le code devient:

@Directive({ 
  selector: '[template-directive]' 
}) 

export class TemplateDirective implements OnInit { 
  @Input() textToDisplay: string; 

  constructor(private parentViewRef: ViewContainerRef, private template: TemplateRef) {} 

  ngOnInit: void { 
    this.parentViewRef.createEmbeddedView(this.template, { $implicit: this.textToDisplay }); 
  } 
} 

Pour le composant hôte:

Template Classe du composant
<p>Host component</p> 
<ng-template template-directive 
  let-content textToDisplay="OK"> 
  <p>Template content: {{content}}</p> 
</ng-template> 
@Component({ ... }) 
export class HostComponent {} 

Enfin si on utilise un raccourci en utilisant le même identifiant entre le selector de la directive et le paramètre d’entrée, on peut simplifier la déclaration du modèle:

@Directive({ 
  selector: '[template-directive]' 
}) 

export class TemplateDirective implements OnInit { 
  @Input("template-directive") textToDisplay: string; 

  constructor(private parentViewRef: ViewContainerRef, private template: TemplateRef<any>) {} 

  ngOnInit: void { 
    this.parentViewRef.createEmbeddedView(this.template, { $implicit: this.textToDisplay }); 
  } 
} 

L’implémentation du composant hôte:

Template Classe du composant
<p>Host component</p> 
<ng-template template-directive="OK" let-content> 
  <p>Template content: {{content}}</p> 
</ng-template> 
@Component({ ... }) 
export class HostComponent {} 

Implémentation d’une directive structurelle

Une directive structurelle permet de créer des vues intégrées (i.e. “embedded view”) à partir d’un modèle. En injectant un contexte dans le modèle, une directive structurelle sera capable de créer une vue et de l’intégrer dans la vue d’un composant hôte.

L’implémentation d’une directive structurelle est similaire à l’exemple utilisé dans le paragraphe précédent:

  • On injecte les paramètres:
  • La directive crée elle-même la vue intégrée en exécutant la fonction ViewContainerRef.createEmbeddedView() et en fournissant le contexte.
  • On utilise une syntaxe particulière pour définir le modèle dans la vue du composant hôte. La syntaxe permet de définir à la fois un modèle et appeler la directive structurelle en utilisant un raccourci: *<nom de la directive structurelle>.

    Par exemple, si on utilise la syntaxe suivante:

    <p *templateDirective>Template content.</p> 
    

    Elle est équivalent à:

    <ng-template templateDirective> 
      <p>Template content</p> 
    </ng-template> 
    

Configurer une directive structurelle par microsyntaxe

Une écriture en microsyntaxe permet de se passer d’utiliser <ng-template></ng-template> pour définir le modèle. Cette microsyntaxe permet d’effectuer des affectations et d’exécuter des expressions en une ligne. Elle n’est qu’un raccourci syntaxique pour faciliter l’implémentation, son utilisation n’est pas obligatoire et il existe toujours un équivalent dans une syntaxe explicite avec <ng-template></ng-template>.

Par exemple:

<ng-template testDirective> 
  <p>Template content.</p> 
</ng-template> 

Est équivalent à:

<p *testDirective>Template Content.</p> 

La microsyntaxe n’est pas aussi facile que d’utiliser la syntaxe explicite avec ngTemplate car certaines règles sont implicites en utilisant la microsyntaxe, il faut avoir en tête ces règles pour ne pas être surpris par certains comportements.

D’une façon générale, pour utiliser la microsyntaxe, il faut respecter la syntaxe suivante:

*<nom paramètre selector de la directive>="<suite d'opérations en microsyntaxe>"

La partie correspondant à la suite d’opérations n’est pas obligatoire, on peut utiliser seulement la directive structurelle comme on l’a fait dans l’exemple plus haut avec *<nom paramètre selector de la directive>.

La suite d’opérations (le terme “opération” n’est pas utilisé dans la documentation Angular) doit respecter certaines règles:

  • Règle 1: si l’écriture en microsyntaxe retourne une valeur alors la directive doit comporter un paramètre d’entrée avec le même identifiant que son paramètre selector: lorsqu’on écrit: *testDirective="'OK'", implicitement cela signifie qu’on affecte une valeur à un paramètre d’entrée à la directive nommé testDirective (le même nom que le paramètre selector de la directive). Cette écriture implique plusieurs choses:
    • Que le paramètre d’entrée avec un nom ou un alias 'testDirective' existe dans la directive sinon une erreur est générée.
    • Que la valeur de l’attribut soit une valeur affectable au paramètre d’entrée. Dans notre exemple la valeur est une chaîne de caractère 'OK' mais la condition est toujours valable même dans le cas où on utilise la microsyntaxe.

    Ainsi, si on écrit:

    <p *testDirective="'This is a directive input message.'">Template content.</p> 
    

    Cette implémentation est équivalente à:

    <ng-template [testDirective]="'This is a directive input message.'"> 
      <p>Template content.</p> 
    </ng-template> 
    

    La directive doit comporter un paramètre d’entrée nommé testDirective ou un alias 'testDirective' comme dans l’exemple suivant:

    @Directive({ 
      selector: '[testDirective]' 
    }) 
    
    export class TestDirective implements OnInit { 
      @Input('testDirective') templateContent: string; 
     
      constructor(private parentViewRef: ViewContainerRef, 
        private templateRef: TemplateRef<any>) {} 
    
      ngOnInit(): void { 
        console.log(this.templateContent); 
        this.parentViewRef.createEmbeddedView(this.templateRef); 
      } 
    } 
    
  • Règle 2: il suffit que la 1ère opération fournisse une valeur pour que toute la suite d’opérations en microsyntaxe fournisse une valeur: pour que la suite d’opérations de la microsyntaxe fournisse une valeur il suffit que la 1ère opération fournisse une valeur. Il n’est pas obligatoire que les opérations fournissent elles aussi une valeur.

    Par exemple, si on écrit: *testDirective="'OK'; customValue as content", il y a 2 opérations mais seule la première fournit une valeur.

    Si il n’y a pas de paramètres d’entrée avec le même identifiant que la directive, il n’est pas nécessaire que la suite d’opération fournisse une valeur.

    Une opération générant une valeur peut être de nature différente:

    • Une valeur simple comme une chaîne de caractères (comme 'OK'), un nombre etc…
    • Une expression (i.e. “Template expression” dans la documentation): il s’agit d’une expression Javascript pouvant être une opération, par exemple 3+4, 4>5, 'Message ' + 'content' etc…
    • La déclaration d’une variable locale de la directive: let content permet de déclarer la variable locale et cette opération génère la valeur 'undefined'. Ainsi si on écrit: *testDirective="let content", la valeur fournit par la microsyntaxe est undefined.
    • Une propriété existante dans la classe du composant: si on écrit *testDirective="parameter", parameter est une propriété du composant et sa valeur est utilisée dans le template par property binding.
  • Règle 3: les caractères ';', ':' ou retour à la ligne sont facultatifs et ne servent pas dans l’implémentation de la directive: ils sont utilisés seulement pour faciliter la compréhension de la microsyntaxe, ainsi:
    *testDirective="3+4; let content" 
    

    Est équivalent à:

    *testDirective="3+4 let content" 
    

Les opérations de la microsyntaxe permettent de:

  • Déclarer des variables locales du modèle avec let ou as,
  • Affecter des valeurs en paramètres d’entrée de la directive,
  • Exécuter des expressions.

Déclarer des variables locales du modèle avec let
Pour déclarer des variables locales, il faut utiliser la syntaxe:

  • En utilisant la propriété $implicit du contexte: let <nom de la variable>. Cette déclaration est équivalente à let-<nom de la variable> si on utilise la syntaxe <ng-template>.
  • En utilisant une propriété nommée du contexte: let <nom de la variable> = <propriété dans le contexte>. Cette déclaration est équivalente à let-<nom de la variable>="<propriété dans le contexte>" si on utilise la syntaxe <ng-template>.

Par exemple:

<p *testDirective="let contentPrefix; let contentSuffix = messageContentSuffix">
  Message is:{{contentPrefix}} and {{contentSuffix}}
</p> 

Est équivalent à:

<ng-template [testDirective] let-contentPrefix let-contentSuffix="messageContentSuffix"> 
  <p>Message is:{{contentPrefix}} and {{contentSuffix}}</p> 
</ng-template> 

Dans cet exemple, on déclare 2 variables locales contentPrefix et contentSuffix. Les valeurs de ces variables sont assignées en fonction du contexte à partir des propriétés $implicit et messageContentSuffix.

Affecter des valeurs en paramètres d’entrée de la directive
La syntaxe pour affecter des valeurs aux paramètres d’entrée de la directive est:

<clé du paramètre> <expression retournant une valeur> 

Souvent la notation peut inclure ':' toutefois ce caractère est optionnel (cf. Règle 3):

<clé du paramètre>: <expression retournant une valeur> 

Cette notation ne fournit pas de valeurs dans le cas de l’application de la règle 1 et 2.

La clé de la variable est utilisée pour déterminer le nom de la propriété de la directive ou de son alias:

<selector de la directive><clé avec la 1ère lettre en majuscule> 

Si le nom de la propriété n’est pas respecté, le binding ne sera pas effectué et on aura un warning d’erreur dans la console du browser avec le message:

Can't bind to '<nom attendu de la propriété>' si ce it isn't a known property of 
  '<nom de l'élément HTML>'.

Ainsi si on écrit:

<p *testDirective="inputParameter 'This is the value of the parameter'">
  Template content
</p> 

Dans la microsyntaxe, inputParameter 'This is the value of the parameter' permet de renseigner la propriété de la directive avec le nom testDirectiveInputParameter ou l’alias 'testDirectiveInputParameter'.

La notation précédente est équivalente à:

<ng-template [testDirective] [testDirectiveInputParameter]="'This is the value of the parameter'"> 
  <p>Template content</p> 
</ng-template> 

L’implémentation de la directive est:

@Directive({ 
  selector: '[testDirective]' 
}) 
export class TestDirective implements OnInit { 
  @Input('testDirectiveInputParameter') inputParameter: string; 

  constructor(private parentViewRef: ViewContainerRef, 
    private templateRef: TemplateRef<any>) {} 

  ngOnInit(): void { 
    console.log(this.inputParameter); 
  } 
} 

Dans la console de développement du browser, on peut voir:

This is the directive input content.

Déclarer des variables locales du modèle avec as
On peut déclarer des variables locales dans le modèle avec le mot clé as. La syntaxe générale est:

<nom de la propriété dans le contexte> as <nom variable locale> 

Cette notation est équivalente à l’utilisation de let:

let <nom variable locale> = <nom de la propriété dans le contexte> 

La différence avec let est que as retourne une valeur dans le cas de la règle 1 et 2. let retourne undefined. La valeur est le résultat de l’expression.

Par exemple, les 2 notations suivantes sont équivalentes toutefois l’utilisation de as retourne une valeur:

<p *testDirective="let content = inputParameter">Template content: {{content}}</p> 
<p *testDirective="inputParameter as content">Template content: {{content}}</p> 

Dans les 2 cas, on utilise la propriété inputParameter du contexte pour affecter une valeur à la variable locale du modèle content. Dans le dernier cas de cet exemple, la microsyntaxe retournera la valeur de inputParameter.

Un grand intérêt de as par rapport à let est de pouvoir utiliser des expressions:

<expression> as <nom variable locale> 

Ainsi as s’utilise de 3 façons:

Ou

Ou

Par exemple, si on écrit:

<p *testDirective="inputParameter 'This is the value of the parameter' as content">
  Template content: {{content}}
</p> 

La microsyntaxe permet d’effectuer 2 opérations:

  • Affecter une valeur à un paramètre d’entrée de la directive avec inputParameter 'This is the value of the parameter' et
  • Utiliser la propriété inputParameter du contexte pour affecter une valeur à la variable locale du modèle content.

La notation précédente est équivalente à:

<ng-template [testDirective] 
  [testDirectiveInputParameter]="'This is the value of the parameter'" 
  let-content="testDirectiveInputParameter"> 
  <p>Template content: {{content}}</p> 
<ng-template> 

L’implémentation de la directive est:

@Directive({ 
  selector: '[testDirective]' 
}) 
export class TestDirective implements OnInit { 
  @Input('testDirectiveInputParameter') inputParameter: string; 
 
  constructor(private parentViewRef: ViewContainerRef, 
    private templateRef: TemplateRef<any>) {} 

  ngOnInit(): void { 
    this.parentViewRef.createEmbeddedView(this.templateRef, 
    { testDirectiveInputParameter: this.inputParameter }) 
  } 
} 

Le résultat est:

Template content: This is the directive input content. 

Affecter des valeurs en paramètre d’entrée
Pour affecter des valeurs en paramètre d’entrée de la directive, comme pour une directive attribut (i.e. attribute directive), on peut utiliser des attributs dans le modèle, par exemple:

<ng-template testDirective [inputParameter]="'This is a directive input message'"> 
  <p>Template content.</p> 
</ng-template> 

La syntaxe [<clé de l'attribut>] rend obligatoire l’implémentation d’un paramètre d’entrée dans la directive sinon une erreur se produit:

@Directive({ 
  selector: '[testDirective]' 
}) 
export class TestDirective implements OnInit { 
  @Input('inputParameter') templateContent: string; 
 
  constructor(private parentViewRef: ViewContainerRef, 
    private TemplateRef: TemplateRef<any>) {} 

  ngOnInt(): void { 
    console.log(this.templateContent); 
    this.parentViewRef.createEmbeddedView(this.templateRef); 
  } 
} 

Dans cet exemple, le résultat est le même que précédemment.

ViewContainerRef

Le type ViewContainerRef comporte quelques fonctions pour modifier le contenu du view container:

  • Propriété ViewContainerRef.element permet d’accéder à l’élément se trouvant dans le view container. Il ne s’agit pas d’un élément HTML mais d’un objet Angular permettant de s’intercaler avec les objets du DOM. Il n’y a qu’un seul élément par view Container. Si on crée plusieurs vues intégrées (i.e. embedded view) dans le même view container, elles seront incluses dans le même élément.
  • clear() supprime toutes les vues intégrées (i.e. embedded view) rajoutées à l’élément se trouvant dans le view Container.
  • createEmbeddedView() crée et ajoute une vue intégrée (i.e. embedded view) à l’élément se trouvant dans le view container. Les paramètres de cette fonction correspondent au modèle de la directive structurelle et éventuellement au contexte. La fonction retourne une instance de la vue intégrée.
  • insert() permet d’insérer une vue dans le view container à un index particulier dans la liste des vues intégrées. Dans le cas où on utilise ViewContainerRef.createEmbeddedView(), il est inutile d’appeler ViewContainerRef.insert() car createEmbeddedView() ajoute la vue après l’avoir créé. Par contre, on peut aussi créer une vue avec le modèle de la directive structurelle, par exemple:
    @Directive({ ... })
    export class ExampleDirective implments OnInit {
      constructor(private parentViewRef: ViewContainerRef, 
        private templateRef: TemplateRef) {}
    
      ngOnInit(): void {
        const viewRef = this.templateRef.createEmbeddedView();
        this.parentViewRef.insert(viewRef);
      }
    }
    
  • move() déplace une vue intégrée (i.e. embedded view) en précisant son index dans la liste des vues intégrées du view container.
  • indexOf() renvoie l’index d’une vue intégrée (i.e. embedded view) parmi la liste des vues du view container. Cette fonction renvoie -1 si la vue ne se trouve pas dans la liste de vues du view container.
  • remove() supprime une vue de la liste des vues se trouvant dans un view container en fonction de son index.
  • detach() supprime une vue de la liste des vues se trouvant dans un view container sans la détruire.
  • createComponent() instance un composant et l’ajoute dans la vue hôte du view container. Par exemple:
    import { ComponentFactoryResolver, ComponentFactory } from '@angular/core';
    
    @Directive({ ... })
      export class ExampleDirective implments OnInit {
    
      constructor(private parentViewRef: ViewContainerRef, private templateRef: TemplateRef, 
        private resolver:  ComponentFactoryResolver) {}
      
      ngOnInit(): void {
        const componentFactory: ComponentFactory = 
          this.resolver.resolveComponentFactory(TestComponent);
        this.parentViewRef.createComponent(componentFactory);
      }
    }
    

Exemple de directive structurelle

L’exemple est le même que pour les directives attributs, la directive renseigne les différents éléments li (i.e. list item) d’une liste ordonnée ol (i.e. ordered list). La liste d’éléments correspond à une liste d’utilisateurs. L’utilisateur est affiché si la propriété User.canBeDisplayed est égale à true.

L’implémentation de la directive est:

export class User {
  constructor(public firstName: string, public lastName: string, 
    public canBeDisplayed: boolean) {}
}

export interface ICanDisplayedFunction { 
  (user: User): boolean; 
} 

@Directive({ 
  selector: '[ngDisplayUser]' 
}) 
export class NgDisplayUser { 
  private userList: User[]; 
  private userCanBeDisplayed: ICanBeDisplayedFunction; 

  @Input('ngDisplayUser') 
  set ngDisplayUser(users: Observable) { 
    if (users) { 
        users.subscribe(value => { 
        this.parentViewRef.clear(); 
        this.userList = value; 
        this.generateUsers(); 
      }) 
    } 
  }

  @Input('ngDisplayUserWhen') 
  set whenParameter(condition: ICanBeDisplayedFunction) { 
    if (condition) { 
      this.userCanBeDisplayed = condition; 
      this.generateUsers(); 
    } 
  } 

  constructor(private parentViewRef: ViewContainerRef, 
    private templateRef: TemplateRef) {} 


  private generateUsers(): void { 
    if (this.userList && this.userCanBeDisplayed) { 
        this.userList.forEach(user => { 
          if (this.userCanBeDisplayed(user)) { 
            this.parentViewRef.createEmbeddedView(this.templateRef, user); 
          } 
        }) 
    } 
  } 
} 

L’implémentation du composant hôte est:

Template Classe du composant
<p>Users are:</p>
<ol>
  <li> *ngDisplayUser="users 
    when canUserBeDisplayed 
    let userLastName=lastName 
    let userFirstName=firstName">
    {{userFirstName}} {{userLastName}}
  </li>
</ol>
@Component({ ... }) 
export class HostComponent {
  users: User[];

  constructor() {
    this.users = [
      new User('Beatrix', 'Kiddo', true),
      new User('Bill', 'Bill', true),
      new User('Elle', 'Driver', false),
      new User('O-Ren', 'Ishii', true)
    ]
  }

  canUserBeDisplayed(user: User): void {
    return user.canBeDisplayed;
  }
}

Ainsi, dans le template du composant hôte:

  • l’attribut *ngDisplayUser permet par résolution de faire appel à la directive ngDisplayUser à cause de la valeur du paramètre selector.
  • On utilise la microsyntaxe: users when canUserBeDisplayed let userLastName=lastName let userFirstName=firstName:
    • users affecte la valeur de la propriété du même nom au paramètre d’entrée de la directive avec l’alias 'ngDisplayUser'. L’affectation de la propriété du composant est faite par property binding. Le paramètre d’entrée doit se nommer de la même façon que la directive (cf. règle 1 et 2).
    • when canUserBeDisplayed est une expression permettant d’affecter une fonction au paramètre d’entrée avec l’alias 'ngDisplayUserWhen' dans la directive. La signature de cette fonction est définie par l’interface ICanDisplayedFunction.
    • let userLastName=lastName déclare la variable locale userLastName du modèle. Sa valeur contiendra la valeur de la propriété lastName de l’instance de user passée dans le contexte.
    • let userFirstName=firstName déclare la variable locale userFirstName du modèle. Sa valeur contiendra la valeur de la propriété firstName de l’instance de user passée dans le contexte.
    • Dans le corps du modèle {{userFirstName}} {{userLastName}} permet d’utiliser les variables locales déclarées par la microsyntaxe pour afficher le nom de l’utilisateur.
  • Dans la directive dans la méthode generateUsers(), this.parentViewRef.createEmbeddedView(this.templateRef, user) permet de créer une vue intégrée (i.e. embedded view) pour chaque utilisation et la placer dans le view container. En créant la vue, le contexte contient une instance d’un utilisateur.

Le résultat est le même que précédemment:

Pour résumer…

Les directives permettent de modifier ou d’enrichir des éléments du DOM généralement par programmation. Il exite 3 types de directives:

  • Les composants: même si on considère qu’ils sont des directives, ils se distinguent des directives à proprement parlé car ils possèdent une vue implémentée en utilisant un template. La vue rend le composant autonome car il ne nécessite pas d’autres éléments pour s’afficher.
  • Les autres types de directives ne possèdent pas directement de template et donc de vue, elles modifient le DOM par programmation en utilisant la vue d’un composant hôte:
    • Les directives attribut (i.e. attribute directives) modifient des éléments du DOM entièrement par programmation.
    • Les directives structurelles (i.e. structural directives) permettent d’enrichir le DOM en y ajoutant des éléments par l’intérmédiaire de vues qui peuvent être intégrées à la vue du composant hôte. Ces directives utilisent un modèle implémenté dans la vue du composant hôte.

On peut ajouter une directive en utilisant le CLI Angular en exécutant:

ng g c <nom de la directive>

Cette instruction crée les fichiers correspondant à la directive et ajoute la directive dans le module dans lequel l’instruction est exécutée.

Pour déclarer une directive, il faut utiliser le décorateur @Directive() en utilisant au moins le paramètre selector. Ce paramètre permet d’indiquer comment utiliser la directive dans le template du composant hôte.

Ainsi une directive sera utilisée par résolution dans un composant hôte suivant la valeur du paramètre selector:

Type d’élément participant à la résolution Valeur de selector Exemple
Elément HTML
selector: 'custom-directive'
<custom-directive></custom-directive>
Attribut d’un élément HTML
selector: '[custom-directive]'
<span custom-directive></span>

ou

<span custom-directive="attribute value">
</span>

ou

<span [custom-directive]="bindedProperty">
</span>
Classe CSS
selector: '.custom-directive' 
<span class="custom-directive">
</span>
Valeur de l’attribut d’un élément HTML
selector: '[title=custom-directive]'
<span title="custom-directive">
</span> 
Type d’un élément et valeur d’un attribut
selector: 'p[title=custom-directive]'
<p title="custom-directive"></p>
Opérateur logique NOT
selector: ':not([custom-directive])'
<span custom-directive>With attribute</span>

ou

<span>Without attribute</span>
Opérateur logique OR
selector: '[custom-directive], 
[title=custom-directive]'
<span custom-directive></span>

ou

<span custom-directive="attribute value">
</span>

ou

<span [custom-directive]="bindedProperty">
</span>

ou

<span title="custom-directive">
</span>

L’implémentation d’une directive varie en fonction du type de directive:

  • Directive attribut: on peut injecter les objets:
    • ElementRef: wrapper de l’objet du DOM comportant la vue hôte,
    • Renderer2 permettant de modifier la vue hôte.

    Par exemple:

    @Directive({ 
      selector: 'custom-directive' 
    }) 
    export class CustomDirective { 
      constructor(private elem: ElementRef, private renderer: Renderer2) {  
        let newText = renderer.createText('Text from directive');  
        renderer.appendChild(elem.nativeElement, newText); 
      }
    }
    

    Renderer2.appendChild() permet de rajouter un élément à un élément HTML hôte.

  • Directive structurelle: on peut injecter les objets:
    • ViewContainerRef: conteneur de vues (i.e. view container) dans lequel on pourra ajouter des vues par programmation.
    • TemplateRef: modèle utilisé pour créer des vues à rajouter dans le view container.

    Par exemple:

    @Directive({ 
      selector: '[customDirective]' 
    }) 
    export class CustomDirective implements OnInit { 
      constructor(private parentViewRef: ViewContainerRef, 
        private templateRef: TemplateRef<any>) {} 
    
      ngOnInit(): void { 
        this.parentViewRef.createEmbeddedView(this.templateRef); 
      } 
    }
    

    ViewContainerRef.createEmbeddedView() permet de créer une vue et de la rajouter au view container.

On peut rajouter des paramètres en entrée des directives avec le décorateur @Input(). Le nom de ces paramètres doit correspondre au nom de la propriété dans la directive, par exemple:

@Directive({ ... }) 
export class TestDirective { 
  @Input() textToDisplay: string;
} 

Ce paramètre est affecté si l’élément HTML hôte comporte un attribut du même nom:

<custom-directive textToDisplay='Value defined from component'></custom-directive>

On peut utiliser un raccourci pour indiquer la directive à utiliser et affecter une valeur dans un paramètre d’entrée de cette directive de cette façon:

<span textToDisplay="Value defined from component"></span> 

La directive sera exécutée si la valeur de son paramètre selector est '[textToDisplay]'. D’autre part, la directive doit comporter un paramètre d’entrée avec le même nom que son paramètre selector pour que la valeur "Value defined from component" y soit affectée, par exemple:

@Directive({ 
  selector: '[textToDisplay]'
}) 
export class CustomDirective { 
  @Input() textToDisplay: string; 

  constructor(private elem: ElementRef, private renderer: Renderer2) {} 
}

Les directives structurelles sont plus complexes à implémenter que les directives attributs car elles nécessitent plus de conditions pour s’exécuter:

  • L’attribut permettant de les utilisant dans le template du composant hôte doit être préfixé avec *, par exemple:
     <p *templateDirective>Template content.</p>
    
  • Les directives structurelles nécessitent l’utilisation d’un modèle pour créer les vues. Ce modèle peut être implémenté dans le template du composant hôte en utilisant une microsyntaxe.

Pour construire la ou les vues, on peut utiliser un contexte qui contiendra les valeurs à utiliser. Ce contexte est transmis à la vue au moment de la créer, par exemple:

@Directive({ ... }) 
export class CustomDirective implements OnInit { 
  constructor(private parentViewRef: ViewContainerRef, 
    private templateRef: TemplateRef<any>) {} 

  ngOnInit(): void { 
    this.parentViewRef.createEmbeddedView(this.templateRef, <contexte>); 
  } 
}

Dans ce cas, le type de templateRef est TemplateRef<any>, ainsi any permet de renseigner n’importe quel type y compris des object literals, par exemple:

{ 
  Property1: <valeur de la propriété 1>, 
  Property2: <valeur de la propriété 2>, 
  // ...
  PropertyN: <valeur de la propriété N>, 
}

Ce contexte pourra être utilisé dans le modèle de la directive en utilisant la microsyntaxe.

La microsyntaxe des directives structurelles s’utilise de cette façon:

*<nom paramètre selector de la directive>="<suite d'opérations en microsyntaxe>"

Par exemple, si on considère une directive structurelle avec le paramètre selector '[textToDisplay]' alors on peut appeler la directive dans un composant hôte de cette façon:

<p *textToDisplay="<suite opération microsyntaxe>">
  Modèle de la directive
</p>

La microsyntaxe doit satisfaire certaines règles:

  • Règle 1: si la microsyntaxe renvoie une valeur alors un paramètre d’entrée doit être implémenté dans la directive avec le même nom que le paramètre selector.
  • Règle 2: la suite d’opérations en microsyntaxe renvoie une valeur si la 1ère opération renvoie une valeur.
  • Règle 3: les opérations peuvent être séparées par des caractères d’espacement. Les caractères ';', ':' ou retour à la ligne sont facultatifs.

Les opérations en microsyntaxe permettent d’effectuer les opérations suivantes:

  • Exécuter une expression Javascript.
  • Déclarer une variable locale au modèle de la directive avec la syntaxe let <nom de la variable>.
  • Déclarer et initialiser une variable locale avec la syntaxe let <nom de la variable> = <propriété du contexte>
  • Affecter un paramètre d’entrée de la directive avec la syntaxe <clé du paramètre> <expression retournant une valeur>.
    Dans ce cas la propriété du paramètre d’entrée doit s’appeler <nom de la directive><clé du paramètre avec la 1ère lettre en majuscule>.
  • Déclarer une variable locale et l’initialiser avec une expression en utilisant la syntaxe <expression> as <nom de la variable>.
  • Affecter un paramètre d’entrée de la directive avec une expression, déclarer une variable locale et l’initialiser avec cette expression en utilisant la syntaxe <clé du paramètre>: <expression retournant une valeur> as <nom de la variable>.
    Dans ce cas la propriété du paramètre d’entrée doit s’appeler <nom de la directive><clé du paramètre avec la 1ère lettre en majuscule>.

Le modèle de la directive peut être implémenté en utilisant les variables locales déclarées et initialisées à l’aide de la microsyntaxe, par exemple:

<p *ngDisplayText="let templateContent = textToDisplay">
  The content is: {{templateContent}}.
</p> 

Ainsi:
ngDisplayText est l’attribut permettant de trouver la directive, il correspond au selector '[ngDisplayText]':

  • templateContent correspond à une variable locale et
  • textToDisplay est la propriété du contexte transmis avec ViewContainerRef.createEmbeddedView().
  • Le modèle The content is: {{templateContent}} est renseigné en utilisant une variable locale par interpolation.
Références

Documentation Angular:

Code source d’Angular:

Autres:

Share on FacebookShare on Google+Tweet about this on TwitterShare on LinkedInEmail this to someonePrint this page

Injection de dépendances dans une application Angular

L’injection de dépendances est un design pattern pris en charge nativement dans Angular.
Pour davantage d’explications sur la théorie de ce design pattern, voir L’injection de dépendances en théorie.

A l’instanciation d’un composant, Angular peut effectuer la résolution de ces dépendances puis de les injecter en utilisant le constructeur du composant. Suivant la façon dont les dépendances sont déclarées, le framework d’injection de dépendances pourra instancier un nouvel objet ou utiliser une instance existante sous forme de singleton. Les objets injectés peuvent être des classes ou des services.

On va illustrer quelques exemples d’injection de dépendances en utilisant différents mécanismes. On terminera par présenter les services qui sont les éléments le plus souvent injectés.

@jeremybishop

Notion de “provider”

Quand un objet est injecté, il faut pouvoir déterminer si on doit utiliser une nouvelle instance ou une instance déjà existante. Ce mécanisme est effectué par le framework d’injection de dépendances qui va configurer des injecteurs en fonction de la façon dont les objets sont déclarés. Une déclaration importante concerne le provider de dépendances (i.e. fournisseur de dépendances) car il permettra de configurer les injecteurs.

En fonction de l’endroit où le provider sera déclaré, l’injecteur utilisé pourra instancier la dépendance. Il est possible de déclarer des providers dans les metadatas des modules ou des composants:

  • Au niveau d’un composant: avant chaque exécution du constructeur du composant, la dépendance sera résolue et l’injecteur créera une nouvelle instance de l’objet injecté.
    L’injecteur utilisé est de type ElementInjector, une instance de cet injecteur est créé pour chaque composant. Pour injecter une dépendance, si l’injecteur du composant ne réussit pas à la résoudre, il va appeler les injecteurs des composants parents s’ils existent sinon il va appeler l’injecteur du module parent.
  • Au niveau d’un module: si le module est importé, le provider sera aussi importé et l’injecteur utilisera la même instance de l’objet à tous les endroits où il est injecté.
    L’injecteur utilisé est de type ModuleInjector, une instance de cet injecteur est créée pour chaque module. Si l’ElementInjector du composant échoue à résoudre une dépendance, l’injecteur du module auquel appartient le composant sera appelé pour essayer d’instancier la dépendance.
  • Au niveau de l’application: il est possible de préciser un provider directement au niveau de l’élément à injecter en utilisant le paramètre providedIn de la directive @Injectable(). Dans ce paramètre on peut indiquer la valeur 'root' pour désigner le module root. Si le provider est le module root alors la résolution de la dépendance sera effectuée par l’injecteur du module root.

La déclaration d’un provider peut se faire de différentes façons:

  • Paramètre providers d’un composant ou d’un module: c’est la méthode le plus ancienne. L’inconvénient de cette méthode est qu’elle ne permet pas de tirer partie de la fonctionnalité tree-shaking.
    Si le provider est un module, l’instanciation de la classe à injecter est liée à celle du module:

    • Eagerly-loaded module: si le module est chargé au démarrage de l’application, alors la classe à injecter sera instanciée sous forme d’un singleton qui sera disponible dans toute l’application.
    • Lazy-loaded module: si le module est chargé par chargement différé, l’instance de la classe à injecter ne sera disponible que si le module est chargé. Si un élément tente d’utiliser une instance de la classe par injection alors que le module n’est pas chargé il y aura une erreur de ce type dans la console du browser:
      NullInjectorError: No provider for <nom de la classe à injecter>!
      

    Dans le cas d’un composant, l’instance de la classe à injecter sera liée à la durée de vie du composant c’est-à-dire qu’à chaque fois que le constructeur du composant est exécuté une nouvelle instance de la classe est créée.

    Cette méthode permet aux composants et modules de désigner explicitement les objets dont ils auront la charge toutefois il peut préter à confusion si on déclare la classe à injecter dans le paramètre providers de plusieurs éléments.

  • Paramètre providedIn de la directive @Injectable(): on peut indiquer 'root' pour désigner le module root ou directement le module qui sera le provider. Cette méthode est plus récente que la précédente et elle permet de tirer du tree-shaking c’est-à-dire que si l’élément injectable n’est injecté nul part, il ne sera pas inclus dans le bundle obtenu après compilation.
    Cette méthode est la plus simple et convient dans la grand majorité des cas. Elle est simple à mettre en oeuvre car elle permet d’indiquer directement que l’instance de la classe à injecter est valable pour toute l’application dans le cas de l’utilisation de la valeur 'root'.

    L’inconvénient de cette méthode est qu’elle peut rendre plus difficile la réutilisation d’un service si on souhaite utiliser des valeurs différentes de providedIn. En outre cette méthode ne permet de désigner seulement des modules et non des composants en tant que provider (i.e. le paramètre providedIn ne peut être renseigné que par un module et non un composant).

    Dans le cas d’un module chargé par lazy-loading, la classe est instanciable seulement si le module est chargé dans les 2 types de configuration de providedIn: 'root' ou le type du module.

Tree-shaking

Le tree-shaking est une optimisation qui permet de ne pas inclure dans le bundle obtenu après compilation, les éléments qui sont inutiles.
Ainsi, si un élément se trouve dans le paramètre providers d’un composant ou d’un module alors qu’il n’est pas injecté, il sera quand même inclus dans le bundle.
A l’opposé, si le paramètre providedIn du décorateur @Injectable() est utilisé pour une classe à injecter, elle sera présente dans le bundle seulement si elle est effectivement injectée.

Pour résumer:

Type de déclaration Tree-shaking ? Elément fournissant la classe à injecter Type de module Type d’instance de l’objet injecté Commentaire
providers Non @Component() N/A Nouvelle instance à chaque utilisation du composant L’instance de la classe est accessible dans le composant, dans son template et, le cas échéant, dans le composant effectuant le rendu s’il y a un paramètre selector.
@NgModule() root Singleton L’instance de la classe est injectable partout dès le démarrage de l’application.
Eagerly-loaded
Lazy-loaded L’instance de la classe n’est utilisable que si le module est chargé sinon il se produit une erreur.
providedIn Oui 'root' N/A L’instance de la classe est injectable partout dès le démarrage de l’application.
<type du module> Eagerly-loaded
Lazy-loaded L’instance de la classe n’est utilisable que si le module est chargé sinon il se produit une erreur.

Exemples d’implémentation pour indiquer le “provider”

En utilisant le paramètre “providers”

Dans @NgModule()

Si on déclare le provider en utilisant le paramètre providers des metadatas d’un module, la déclaration est:

@Injectable()
export class Dependency {}
 
@NgModule({
  providers: [ Dependency ]
})
export class CustomModule {}

L’instance injectée est un singleton.

Dans @Component()

Si le provider est déclaré avec le paramètre providers des metadatas d’un composant, la déclaration est:

@Injectable()
export class Dependency {}
 
@Component({
  providers: [ Dependency ]
})
export class CustomComponent {}

Une nouvelle instance est injectée à chaque exécution du constructeur.

Options utilisables avec le paramètre “providers”

Le paramètre providers permet d’ajouter des options pour perfectionner l’injection.

Pour les exemples suivants, on utilise les classes:

@Injectable()
class FirstDependency {
  innerId = 'first';
}
 
@Injectable()
class SecondDependency {
  innerId = 'second';
}

Le membre innerId permet d’identifier l’instance pendant le débug.

useClass
L’option useClass permet d’indiquer le type de la classe qui sera injectée dans le but de remplacer le type injecté.

Dans cet exemple, le paramètre secondDependency contiendra une instance de la classe FirstDependency. L’instance sera différente de celle du paramètre firstDependency:

@Component({
  templateUrl: './custom.component.html',
  providers: [
      FirstDependency,
      { provide: SecondDependency, useClass: FirstDependency }
  ]
})
export class CustomComponent {
  constructor(private firstDependency: FirstDependency,
    private secondDependency: SecondDependency) {
      console.log('firstDependency: ' + firstDependency.innerId);
      console.log('secondDependency: ' + secondDependency.innerId);
  }
}

Le type SecondDependency est remplacé par le type FirstDependency.

useExisting
L’option useExisting permet d’utiliser une instance déjà fournie par le provider.

Par exemple, si on configure le paramètre providers de cette façon:

@Component({
  templateUrl: './custom.component.html',
  providers: [
      FirstDependency,
      { provide: SecondDependency, useExisting: FirstDependency }
  ]
})
export class CustomComponent {
  constructor(private firstDependency: FirstDependency,
    private secondDependency: SecondDependency) {
      console.log('firstDependency: ' + firstDependency.innerId);
      console.log('secondDependency: ' + secondDependency.innerId);
  }
}

Les 2 paramètres firstDependency et secondDependency contiennent la même instance de type FirstDependency.

useValue
L’option useValue permet d’utiliser explicitement une instance. Si on configure le paramètre providers de cette façon:

@Injectable()
class SecondDependency {
  constructor(public innerId: string) {}
}

const dependency = new SecondDependency('other');

@Component({
  templateUrl: './custom.component.html',
  providers: [
      FirstDependency,
      { provide: SecondDependency, useValue: dependency }
  ]
})
export class CustomComponent {
  constructor(private firstDependency: FirstDependency,
    private secondDependency: SecondDependency) {
      console.log('firstDependency: ' + firstDependency.innerId);
      console.log('secondDependency: ' + secondDependency.innerId);
  }
}

Le paramètre SecondDependency contiendra l’instance créée au préalable.

useFactory

L’option useFactory permet d’utiliser une fonction factory pour instancier un objet à injecter dans le cas où l’instanciation nécessite l’implémentation d’une logique. La fonction factory peut comporter des arguments qui seront injectés.

Par exemple, si on redéfinit la classe SecondDependency de cette façon:

@Injectable()
class SecondDependency {
  innerId: string;
 
  constructor(firstDependency: FirstDependency) {
    this.innerId = firstDependency.innerId;
  }
}

Si on implémente la fonction factory de cette façon:

let dependencyFactory = (firstDependency: FirstDependency) => {
  return new SecondDependency(firstDependency);
};

Il est possible de configurer le provider pour que la fonction factory crée l’instance de l’objet SecondDependency à injecter:

@Component({
  templateUrl: './comp-second-mod.component.html',
  providers: [
    FirstDependency,   
    { provide: SecondDependency, useFactory: dependencyFactory, deps: [ FirstDependency ] }
  ]
})
export class CustomComponent {
  constructor(private firstService: FirstServiceService,
    private firstDependency: FirstDependency,
    private secondDependency: SecondDependency) {
      console.log('firstDependency content: ' + firstDependency.innerId);
      console.log('secondDependency content: ' + secondDependency.innerId);
  }
}

Ainsi, la fonction factory dependencyFactory crée une instance de SecondDependency et l’injecte dans le composant CustomComponent.

En utilisant le paramètre “providedIn” dans @Injectable()

Le décorateur @Injectable() est utilisé pour indiquer qu’un objet est injectable en utilisant l’injection de dépendances. On précise son utilisation plus bas. Ce décorateur permet d’indiquer directement le provider d’un objet à injecter en utilisant le paramètre providedIn.

Pour déclarer en utilisant le paramètre providedIn, la déclaration est:

@Injectable({
  providedIn: 'root'
})
class Dependency {}

Dans ce cas, le provider sera le module root et l’instance injectée est un singleton.

Pour indiquer un module en tant que provider, on indique le type du module, la déclaration est du type:

import { ItemModule } from '../item.module.ts';
 
@Injectable({
  providedIn: ItemModule
})
class Dependency {}

Exemples d’implémentation de l’injection

Pour implémenter l’injection, après avoir précisé le provider, il faut indiquer qu’un objet est injectable en utilisant les décorateurs:

  • @Inject() utilisable sur les paramètres du constructeur d’un composant ou
  • @Injectable() utilisable sur la classe de l’objet à injecter.

En utilisant @Inject()

Le décorateur @Inject() est plus rarement utilisé, il permet d’indiquer que l’élément est injectable. Il se déclare dans les paramètres du constructeur du composant où l’élément doit être injecté. Si on utilise @Inject(), il n’y a pas d’autres décorateurs à préciser sur la classe de l’objet à injecter.

Par exemple:

class FirstDependency {}
 
@Component({
  providers: [ FirstDependency ]
})
export class CustomComponent {
  constructor(@Inject(FirstDependency) private firstDependency) {}
}

En utilisant @Injectable()

La décorateur @Injectable() peut être utilisé directement sur la classe de l’objet à injecter. C’est le décorateur utilisé le plus couramment. Si on utilise @Injectable(), il n’est pas nécessaire d’utiliser @Inject.

Par exemple:

@Injectable()
class FirstDependency {}
 
@Component({
  providers: [ FirstDependency ]
})
export class CustomComponent {
  constructor(private firstDependency: FirstDependency) {}
}

@Injectable() permet de préciser directement le provider avec le paramètre providedIn.

Injecter des services

Les composants sont très liés à leur template, par exemple ils permettent de mettre à disposition des données à afficher. L’existence de l’instance du composant ne survit pas au passage d’un composant à l’autre. il est donc nécessaire de prévoir un type d’élément permettant de stocker des données dont l’existence va survivre aux changements de vue. Les éléments utilisés pour être partagés entre les différents composants sont les services, ils permettent:

  • d’effectuer des traitements communs à plusieurs composants,
  • de mettre à disposition des propriétés utilisables par plusieurs composants.

D’un point de vue implémentation, un service est une classe injectable, il n’y a pas de différence entre un service et une simple classe à injecter. Ainsi, tous les éléments indiqués dans le paragraphe précédent sont valable pour les services.

Par crééer un service avec l’CLI Angular, il faut exécuter dans le répertoire de l’application ou dans le répertoire d’un module, l’instruction suivante:

ng generate service <nom du service>

ou

ng g s <nom du service>

Le fichier du service sera généré avec le décorateur suivant:

@Injectable({
  providedIn: 'root'
})

Ce paramétrage permet de configurer le service pour que le provider soit le module root. L’instance du service est un singleton injectable dans toute l’application.

Pour résumer…

Pour injecter un service, il faut:

  • Quel sera le provider de ce service: le module root, module importé ou un composant. Suivant le choix du provider, une nouvelle instance du service ou un singleton sera utilisé à chaque injection.
  • Suivant le provider choisi, il faut choisir la syntaxe à utiliser:
    • Décorateur @Injectable() avec le paramètre providedIn.
    • Paramètre providers dans le décorateur @Component() ou @NgModule() + décorateur @Inject().
    • Paramètre providers dans le décorateur @Component() ou @NgModule() + décorateur @Injectable().

Les syntaxes peuvent être synthétiser dans ce tableau:

Syntaxe Commentaires
Décorateur @Injectable() avec le paramètre providedIn
@Injectable({
    providedIn: 'root'
})
export class InjectedService {}

@Component({
    ...
})
export class ServiceConsumerComponent() {
    constructor(service: InjectedService) {}
}
Cette syntaxe est la plus triviale.
La valeur du paramètre providedIn dans @Injectable() peut être:

  • 'root' pour indiquer le module root, dans ce cas le service sera un singleton.
  • utilisé comme provider, le service sera un singleton utilisable si le service est chargé.
Paramètre providers dans le décorateur @Component() + @Inject()
export class InjectedService {}

@Component({
  providers: [ InjectedService ],
  ...
})
export class ServiceConsumerComponent() {
  constructor(
     @Inject(InjectedService) private service) 
  {}
}
Une nouvelle instance du service sera instanciée à chaque injection.
Paramètre providers dans le décorateur @NgModule() + Inject()
export class InjectedService {}

@NgModule({
  providers: [ InjectedService ],
  ...
})
export class CustomModule() {}

@Component({
  ...
})
export class ServiceConsumerComponent() {
  constructor(
    @Inject(InjectedService) private service) 
  {}
}
Le service injecté est un singleton utilisable si le module est chargé.
Paramètre providers dans le décorateur @NgModule() + le décorateur @Injectable()
@Injectable()
export class InjectedService {}

@NgModule({
  providers: [ InjectedService ],
  ...
})
export class CustomModule() {}

@Component({
  ...
})
export class ServiceConsumerComponent() {
  constructor(service: InjectedService) {}
}
Le service injecté est un singleton utilisable si le module est chargé.

La syntaxe avec le paramètre providers dans le décorateur @NgModule() et @Component() autorise des options:

@Component({
  providers: [
    ...
    { provide: InjectedService, <option>  }
  ]
})
export class ServiceConsumerComponent(
  constructor(service: InjectedService) {}
)

Les options peuvent être:

  • { provide: InjectedService, useClass: OtherTypeService } pour injecter une instance du type OtherTypeService quand le type demandé est InjectedService.
  • { provide: InjectedService, useExisting: OtherTypeService } pour injecter une instance existante de type OtherTypeService quand le type demandé est InjectedService.
  • { provide: InjectedService, useValue: new InjectedService() } pour injecter une instance particulière quand le type demandé est InjectedService.
  • { provide: InjectedService, useFactory: () => { return new InjectedService(); } } pour utiliser une logique particulière implémentée dans une factory.
Share on FacebookShare on Google+Tweet about this on TwitterShare on LinkedInEmail this to someonePrint this page