J'ai fini par jouer avec les décorateurs et j'ai décidé de documenter ce que j'ai découvert pour quiconque veut en profiter avant que la documentation ne sorte. N'hésitez pas à le modifier si vous voyez des erreurs.
Points généraux
- Les décorateurs sont appelés lorsque la classe est déclarée, pas lorsqu'un objet est instancié.
- Plusieurs décorateurs peuvent être définis sur la même classe / propriété / méthode / paramètre.
- Les décorateurs ne sont pas autorisés sur les constructeurs.
Un décorateur valide doit être:
- Affectable à l'un des types de décorateur (
ClassDecorator | PropertyDecorator | MethodDecorator | ParameterDecorator
).
- Renvoie une valeur (dans le cas de décorateurs de classe et de décorateur de méthode) qui peut être affectée à la valeur décorée.
Référence
Décorateur Accessoire formel
Paramètres de mise en œuvre:
target
: Le prototype de la classe ( Object
).
propertyKey
: Le nom de la méthode ( string
| symbol
).
descriptor
: A TypedPropertyDescriptor
- Si vous n'êtes pas familier avec les clés d'un descripteur, je vous recommande de lire à ce sujet dans cette documentation sur Object.defineProperty
(c'est le troisième paramètre).
Exemple - sans arguments
Utilisation:
class MyClass {
@log
myMethod(arg: string) {
return "Message -- " + arg;
}
}
La mise en oeuvre:
function log(target: Object, propertyKey: string, descriptor: TypedPropertyDescriptor<any>) {
const originalMethod = descriptor.value; // save a reference to the original method
// NOTE: Do not use arrow syntax here. Use a function expression in
// order to use the correct value of `this` in this method (see notes below)
descriptor.value = function(...args: any[]) {
// pre
console.log("The method args are: " + JSON.stringify(args));
// run and store result
const result = originalMethod.apply(this, args);
// post
console.log("The return value is: " + result);
// return the result of the original method (or modify it before returning)
return result;
};
return descriptor;
}
Contribution:
new MyClass().myMethod("testing");
Production:
Les arguments de méthode sont: ["testing"]
La valeur de retour est: Message - testing
Remarques:
- N'utilisez pas la syntaxe des flèches lorsque vous définissez la valeur du descripteur. Le contexte de
this
ne sera pas celui de l'instance si vous le faites.
- Il est préférable de modifier le descripteur d'origine que d'écraser le descripteur actuel en renvoyant un nouveau descripteur. Cela vous permet d'utiliser plusieurs décorateurs qui modifient le descripteur sans remplacer ce qu'un autre décorateur a fait. Cela vous permet d'utiliser quelque chose comme
@enumerable(false)
et @log
en même temps (Exemple: mauvais vs bon )
- Utile : l'argument type de
TypedPropertyDescriptor
peut être utilisé pour restreindre les signatures de méthode ( exemple de méthode ) ou les signatures d'accesseur ( exemple d' accesseur ) sur lesquelles le décorateur peut être placé.
Exemple - Avec arguments (Decorator Factory)
Lorsque vous utilisez des arguments, vous devez déclarer une fonction avec les paramètres du décorateur puis renvoyer une fonction avec la signature de l'exemple sans arguments.
class MyClass {
@enumerable(false)
get prop() {
return true;
}
}
function enumerable(isEnumerable: boolean) {
return (target: Object, propertyKey: string, descriptor: TypedPropertyDescriptor<any>) => {
descriptor.enumerable = isEnumerable;
return descriptor;
};
}
Décorateur de méthode statique
Similaire à un décorateur de méthode avec quelques différences:
- Son
target
paramètre est la fonction constructeur elle-même et non le prototype.
- Le descripteur est défini sur la fonction constructeur et non sur le prototype.
Décorateur de classe
@isTestable
class MyClass {}
Paramètre d'implémentation:
target
: La classe sur laquelle le décorateur est déclaré ( TFunction extends Function
).
Exemple d'utilisation : utilisation de l'API de métadonnées pour stocker des informations sur une classe.
Décorateur de propriété
class MyClass {
@serialize
name: string;
}
Paramètres de mise en œuvre:
target
: Le prototype de la classe ( Object
).
propertyKey
: Le nom de la propriété ( string
| symbol
).
Exemple d'utilisation : création d'un @serialize("serializedName")
décorateur et ajout du nom de la propriété à une liste de propriétés à sérialiser.
Décorateur de paramètres
class MyClass {
myMethod(@myDecorator myParameter: string) {}
}
Paramètres de mise en œuvre:
target
: Le prototype de la classe ( Function
—il semble Function
ne plus fonctionner. Vous devez utiliser any
ou Object
ici maintenant pour utiliser le décorateur dans n'importe quelle classe. Ou spécifier le (s) type (s) de classe auquel vous souhaitez le restreindre)
propertyKey
: Le nom de la méthode ( string
| symbol
).
parameterIndex
: L'index du paramètre dans la liste des paramètres de la fonction ( number
).
Exemple simple
Exemple (s) détaillé (s)
@Injectable
dans un décorateur, référez