Travailler avec l'application
Interface IWebApplication
Dans Fano Framework, l'application doit implémenter l'interface IWebApplication. Actuellement, elle ne fournit aucune méthode à l'exception de la méthode run() héritée de l'interface IRunnable étant son parent.
Implémentation intégrée
Le Fano Framework fournit des implémentations intégrées de IWebApplication :
| Implémentation | Description |
|---|---|
| TCgiWebApplication | Une application Web CGI implémentant le protocole CGI. Il s'agit essentiellement d'une application interpréteur de commande s'exécutant puis se termine après avoir terminé son travail. |
| TDaemonWebApplication | Est une application Web s'exécutant en permanence et écoute les requêtes jusqu'à ce qu'elle soit terminée manuellement. Elle est principalement utilisée pour les applications Web FastCGI, SCGI et uwsgi. |
Interface IAppServiceProvider
Le TCgiWebApplication dépend de l'instance de l'interface IAppServiceProvider tandis que TDaemonWebApplication dépend de IDaemonAppServiceProvider. Ils fournissent des services essentiels pour l'application. Le code suivant est la déclaration de cette interface :
- Type
- IAppServiceProvider=Interface(IServiceProvider)
- ['{41032A70-F31D-45A6-AE26-574888BE4D07}']
- Function getContainer():IDependencyContainer;
- Property container:IDependencyContainer read getContainer;
-
- Function getErrorHandler():IErrorHandler;
- Property errorHandler:IErrorHandler read getErrorHandler;
-
- Function getDispatcher():IDispatcher;
- Property dispatcher:IDispatcher read getDispatcher;
-
- Function getEnvironment():ICGIEnvironment;
- Property env:ICGIEnvironment read getEnvironment;
-
- Function getRouter():IRouter;
- Property router:IRouter read getRouter;
-
- Function getStdIn():IStdIn;
- Property stdIn:IStdIn read getStdIn;
- End;
-
- IDaemonAppServiceProvider = interface(IAppServiceProvider)
- ['{4FF6129E-171F-429C-BE5B-7A8B941D3626}']
- Function getServer() : IRunnableWithDataNotif;
- Property server : IRunnableWithDataNotif read getServer;
-
- Function getProtocol():IProtocolProcessor;
- Property protocol:IProtocolProcessor read getProtocol;
-
- Function getOutputBuffer():IOutputBuffer;
- Property outputBuffer:IOutputBuffer read getOutputBuffer;
-
- Function getStdOut():IStdOut;
- Property stdOut:IStdOut read getStdOut;
- End;
Le Fano Framework fournit plusieurs implémentations intégrées de cette interface que vous pouvez utiliser ou étendre :
| Implémentation | Description |
|---|---|
| TBasicAppServiceProvider | Classe abstraite implémentant l'interface IAppServiceProvider. La plupart des méthodes ont déjà une implémentation, à l'exception de sa méthode register() que vous devez implémenter pour enregistrer les dépendances spécifiques à votre application. Pour les applications Web CGI, cette classe est celle que vous devez utiliser. |
| TDaemonAppServiceProvider | La classe abstraite hérite de la classe TBasicAppServiceProvider implémentant l'interface IDaemonAppServiceProvider. La plupart des méthodes ont déjà une implémentation, à l'exception de sa méthode register() que vous devez implémenter pour enregistrer les dépendances spécifiques à votre application. Pour un service d'application Web, cette classe est celle que vous devez utiliser. |
| TServerAppServiceProvider | Classe fournissant un serveur de travail pour le service de l'application Web. |
| TFastCgiAppServiceProvider | Classe fournissant des services essentiels pour l'application Web FastCGI. |
| TScgiAppServiceProvider | Classe fournissant des services essentiels pour l'application Web SCGI. |
| TUwsgiAppServiceProvider | Classe fournissant des services essentiels pour l'application Web uwsgi. |
| TMhdAppServiceProvider | Classe fournissant des services essentiels pour l'application Web libmicrohttpd. |
Interface IRouteBuilder
Lors de la création d'une instance d'application, vous devez également implémenter l'interface IRouteBuilder étant chargée de configurer les itinéraires d'application.
Application CGI
TCgiWebApplication est une classe intégrée implémentant le protocole CGI. Sa tâche consiste essentiellement à lire les variables d'environnement CGI que le serveur Web envoie et à appeler le gestionnaire de requêtes approprié.
Sa méthode constructeur attend deux paramètres, une instance de l'interface IAppServiceProvider et IRouteBuilder. Le premier paramètre doit fournir les services essentiels requis par l'application et également enregistrer toutes les dépendances de l'application.
Pour l'application CGI, Fano Framework fournit la classe abstraite TBasicAppServiceProvider que vous devez étendre pour enregistrer vos dépendances d'application. Vous devez implémenter sa méthode register().
Le dernier paramètre est une instance de la classe responsable de la création des routes d'application. Fano Framework fournit la classe abstraite de base TRouteBuilder que vous devez étendre. Vous devez implémenter sa méthode buildRoutes(). Veuillez noter que vous n'êtes pas obligé d'hériter de la classe TRouteBuilder. Vous pouvez utiliser n'importe quelle classe tant qu'elle implémente l'interface IRouteBuilder.
- appInstance:=TCgiWebApplication.create(TAppServiceProvider.create(),TAppRoutes.create());
Où TAppServiceProvider est déclaré comme suit :
- TAppServiceProvider=Class(TBasicAppServiceProvider)
- Public
- Procedure register(const container : IDependencyContainer); override;
- End;
- ...
- Procedure TAppServiceProvider.register(const container : IDependencyContainer);Begin
- //inscrivez ici tous les services requis pour l'application
- End;
-
- TAppRoutes=class(TRouteBuilder)
- Public
- Procedure buildRoutes(Const container:IDependencyContainer;Const Router:IRouter); override;
- End;
- ...
- Procedure TAppRoutes.buildRoutes(Const container:IDependencyContainer;Const Router:IRouter);Begin
- //inscrivez tous les itinéraires ici
- End;
Service d'application Web
L'application Web s'exécutant en permanence en arrière-plan doit configurer un fournisseur de services héritant de TDaemonAppServiceProvider, comme une application Web utilisant le protocole FastCGI, SCGI ou uwsgi, car l'application dépend de l'interface IDaemonAppServiceProvider.
Application FastCGI
Pour créer une application Web prenant en charge le protocole FastCGI, créez un fournisseur de services d'application utilisant TFastCgiAppServiceProvider comme indiqué dans le code suivant :
Vous pouvez remplacer TInetSvrFactory par la classe TUnixSvrFactory si vous souhaitez utiliser le fichier de socket de domaine Unix au lieu du port TCP.
Vous pouvez remplacer TInetSvrFactory par TBoundSvrFactory si vous souhaitez créer une application FastCGI s'exécutant et est gérée par un serveur Web, par exemple Apache avec le module mod_fcgid.
TInetSvrFactory, TUnixSvrFactory et TBoundSvrFactory utilisent select pour surveiller si le socket est prêt pour l'opération d'entrée/sortie. Pour utiliser epoll, remplacez par TEpollInetSvrFactory, TEpollUnixSvrFactory et TEpollBoundSvrFactory. Si vous utilisez FreeBSD, pour utiliser kqueue, remplacez-le par TKqueueInetSvrFactory, TKqueueUnixSvrFactory et TKqueueBoundSvrFactory. Vous devez ajouter une définition de compilation conditionnelle $DEFINE USE_KQUEUE ou ajouter la ligne -dUSE_KQUEUE dans le fichier build.cfg.
Application SCGI
Pour créer une application Web prenant en charge le protocole SCGI (Simple Common Gateway Interface), créez un fournisseur de services d'application utilisant TScgiAppServiceProvider comme indiqué dans le code suivant :
Application Uwsgi
Pour créer une application Web prenant en charge le protocole uwsgi, créez un fournisseur de services d'application utilisant TUwsgiAppServiceProvider comme indiqué dans le code suivant :
Application HTTP
Pour créer une application Web prenant en charge le protocole http à l'aide de libmicrohttpd, créez un fournisseur de services d'application qui utilise TMhdAppServiceProvider et remplissez également la configuration du serveur Web comme indiqué dans le code suivant :
- var
- svrConfig:TMhdSvrConfig;
- (* ... *)
- svrConfig.host:='exemple.fano';
- svrConfig.port:=8080;
- svrConfig.documentRoot:=getCurrentDir() + '/public';
- svrConfig.serverName:='exemple.fano';
- svrConfig.serverAdmin:='admin@exemple.fano';
- svrConfig.serverSoftware:='Fano Framework Web App';
- svrConfig.timeout:=120; // délai d'expiration de la connexion en secondes
-
- appInstance:=TDaemonWebApplication.create(
- TMhdAppServiceProvider.create(
- TAppServiceProvider.create(),
- svrConfig
- ),
- TAppRoutes.create()
- );
Utiliser l'adresse IPv6
Si vous souhaitez créer un serveur d'application Web lié à l'adresse IPv6, remplacez TInetSvrFactory, TEpollInetSvrFactory, TKqueueInetSvrFactory par la classe TInet6SvrFactory, TEpollInet6SvrFactory, TKqueueInet6SvrFactory respectivement.
Vous devrez peut-être remplacer l'adresse du serveur dans le module proxy du serveur Web. Par exemple, pour une application SCGI utilisant le module Apache mod_proxy_scgi, vous devez modifier la configuration de l'hôte virtuel comme indiqué dans l'exemple suivant.
|
# Adresse IPv4 # ProxyPassMatch ^/(.*)$ "scgi://127.0.0.1:20477" # Adresse IPv6 ProxyPassMatch ^/(.*)$ "scgi://[::1]:20477" |
Veuillez noter que l'adresse IPv6 doit être entre crochets.
Pour les applications Web basées sur libmicrohttpd, vous pouvez ajouter la prise en charge de l'adresse IPv6 en définissant le champ useIPv6 de l'enregistrement TMhdSvrConfig sur true. Si vous avez besoin à la fois d'IPv4 et d'IPv6, définissez le champ dualStack de TMhdSvrConfig sur true.
Comment choisir l'implémentation d'IWebApplication ?
| Implémentation | Avantages | Inconvénients |
|---|---|---|
| Application CGI | Facile à configurer, en particulier sur un hébergement partagé où vous ne possédez pas de privilège d'administrateur de serveur. | Pas très performant par rapport à l'application FastCGI ou SCGI en raison du fonctionnement du protocole CGI. |
| Application FastCGI | Les performances sont bonnes par rapport à l'application CGI. | Nécessite un privilège d'administrateur de serveur pour la configuration. Vous ne pouvez pas déployer facilement l'application sur un hébergement partagé. |
| Application SCGI | Les performances sont bonnes par rapport à l'application CGI et peut-être légèrement meilleures que FastCGI en raison d'une spécification de protocole plus simple. | Nécessite un privilège d'administrateur de serveur pour la configuration. Vous ne pouvez pas déployer facilement l'application sur un hébergement partagé. |
| Application uwsgi | Les performances sont comparables au protocole SCGI mais nécessitent moins de bande passante réseau en raison de l'utilisation du protocole binaire. | Nécessite un privilège d'administrateur de serveur pour la configuration. Vous ne pouvez pas déployer facilement l'application sur un hébergement partagé. |