Créer son propre composant Expression Builder

La classe ExpressionBuilder permet de générer des expressions durant l'analyse de la page.

Les ExpressionBuilder se basent sur des balises ayant la forme suivante :

<%$ prefixe  : valeur %> .

Lors de l'analyse de la page, un générateur d'expression va être instancié dès lecture de la balise <%$. Le type de générateur dépendra du préfixe. Par exemple, dans le cas suivant <%$ AppSettings: imgDirectory %>, une classe AppSettingsExpressionBuilder va être instanciée.

La seconde partie de l'expression (valeur) va être passée en paramètre de la classe de génération idoine afin d'être évaluée et de retourner la valeur attendue par le contrôle.

Sans que l'on se soit vraiment douté de ce concept, la plupart des codes l'utilisent. Voici quelques exemples très communs :

<%$ AppSettings: imgDirectory %> : permet de récupérer une valeur dans la section AppSettings du Web.Config ;

<%$ ConnectionStrings : MyNorthwind %>: permet de récupérer une chaine de connexion précisée dans le Web.Config ;

<%$ Resources : Libelle, ApplicationLabel %>: permet de récupérer la valeur de la clé ApplicationLabel dans le fichier ressource Libelle.resx.

Pour des raisons de sécurité et de cache, certains clients demandent une mise en oeuvre particulière des répertoires du serveur Microsoft Internet Information Server. Cette mise en place implique un premier répertoire virtuel contenant le code de l'application et un second contenant toutes les images de l'application.

Les raisons de ce découpage sont multiples allant des droits sur les répertoires à la mise en cache des images.

Afin de ne pas modifier le code source avant livraison (et donc d'éviter des risques d'oubli), il est nécessaire de mettre en configuration le chemin menant au répertoire des images. Cette variable pointera sur le répertoire image de l'application durant la phase de développement et pourra pointer vers l'alias IIS lors de la qualification puis la production.

Dans le fichier web.config, il suffit de créer une section AppSettings ainsi que la variable ImgDirectory.

<appSettings>
   <add key="imgDirectory" value="/Images" />
</appSettings>

Afin de réaliser son propre composant, il faut créer une classe héritant de System.Web.Compilation.ExpressionBuilder.

La classe ExpressionBuilder est une classe abstraite. Elle définit plusieurs fonctions dont une abstraite, donc à redéfinir : GetCodeExpression.

/// <summary>
/// Cette méthode sera appelée lors de l'exécution de la page 
/// </summary>
public override CodeExpression GetCodeExpression(BoundPropertyEntry entry, object parsedData, ExpressionBuilderContext context)
{
   // OBTENIR une référence de la classe en cours
   CodeTypeReferenceExpression thisType = new CodeTypeReferenceExpression(base.GetType());
   // RECUPERER l'expression passée en paramètre 
   CodePrimitiveExpression expression = new CodePrimitiveExpression(entry.Expression.Trim().ToString());
   // NOMMER la fonction qui va être appelée
   string evaluationMethod = "FormatExpression";
   // RETOURNER l'expression qui appellera la méthode définie
   return new CodeMethodInvokeExpression(thisType, evaluationMethod, new CodeExpression[] { expression });
}

Il faut ensuite définir la méthode définition dans la variable evaluationMethod.

public static string FormatExpression(string expression)
{
   // RECUPERER les deux parties
   // La première représente la clé dans le web.config, section appSettings
   // La seconde le sous-répertoire + fichier
   string[] stringParts = expression.Split(',');
   if (stringParts.Length == 2)
   {
      return ConfigurationManager.AppSettings[stringParts[0].Trim()] + stringParts[1].Trim();
   }
   if ("this.src".Equals(stringParts[2].Trim()))
   {
      return "this.src='" + ConfigurationManager.AppSettings[stringParts[0].Trim()] + stringParts[1].Trim() + "'";
   }
   return ConfigurationManager.AppSettings[stringParts[0].Trim()] + stringParts[1].Trim();
}

Cette méthode transforme la valeur en paramètre en tableau afin de récupérer la valeur à rechercher dans le ConfigurationManager et le chemin du fichier.

Ces deux valeurs seront concaténées et le résultat retourné.

Une fois la classe codée, il faut définir notre nouvelle Expression Builder dans le web.config.

<system.web>
   <compilation debug="true" targetFramework="4.0">
      <expressionBuilders>
         <add expressionPrefix="iisdir" type="MonExpressionBuilder.MonExpressionBuilder"/>
      </expressionBuilders>
   </compilation>
</system.web>

Attribut expressionPrefix : nom du tag

Attribut type : namespace.classe

Enfin, il ne nous reste plus qu'à utiliser notre nouveau composant dans une page aspx :

<body>
    <form id="form1" runat="server">
    	<div>
    	<img alt="Logo" src="<asp:Literal runat='server' Text='<%$ iisdir: imgDirectory, /logo.gif %>' />" />
    	</div>
    </form>
</body