From Documentation

Avant de commencer

Les Servlet Containers sont nouveaux pour vous(aka., Java Web Server)?

Avant de développer des applications Web en Java (et exécuter la démo ZK sur votre machine), vous devez installer un Servlet container. Apache Tomcat est un des Servlet containers les plus populaires grâce à sa grande simplicité d'installation et d'utilisation.

Vous débutez avec le langage Java?

Il n'est pas nécessaire de connaitre Java pour utiliser ZK. En effet, toutes les interfaces utilisateurs riches peuvent être implémentées dans un langage à balises (similaire à HTML) appelé ZUML. Cependant, pour finaliser une application Web, vous (ou l'un des membres de votre équipe) devez avoir une connaissance basique du Java.

Vous trouverez ici quelques tutoriels Java intéressants.

Préparer un environnement pour exécuter ZK

Prérequis

Si vous n'avez pas installé les applications suivantes sur votre ordinateur, merci de les télécharger et de les installer.

• Java SE Development Kit (JDK)
• Application Server
• ZK Library

Installer Java SE Development Kit (JDK)

1. Téléchargez JDK 6 Update 14.

2. Suivez le lien Installation instructions pour finaliser l'installation.

Installer un serveur d'applications - Apache Tomcat

1. Téléchargez Apache Tomcat 6.0
2. Suivez le lien Apache Setup instructions pour finaliser l'installation.

Note: Nous vous suggérons d'utiliser le port 8080.

Installer la librairie ZK

1. Depuis ZK Studio 0.9.4 qui est compilé avec la dernière version stable de la librairie ZK, actuellement ZK3.6.1.
2. Téléchargez la dernière version de ZK library.
3. Décompressez zk-bin-xxx.zip sur votre disque dur, (ex C:\), merci de vous rendre ici pour obtenir la liste des dossiers et fichiers inclus dans la distribution ZK.

Préparer Eclipse IDE (Recommandé)

Installer Eclipse

1. Téléchargez et installez Eclipse IDE for Java EE Developers

Installer ZK Studio

Suivez le Guide d'installation pas à pas pour installer ZK Studio.

Définir un Server RunTime (Apache Tomcat)

1. Allez dans le menu Windows > Preferences...
2. Sélectionnez Server > Runtime Environments, ensuite cliquez sur Add
3. Sélectionnez Apache > Apache Tomcat v6.0 et cliquez sur Next
4. Sélectionnez votre dossier d'installation d'Apache Tomcat ex. C:\Program Files\Apache Software Foundation\Tomcat 6.0
5. Cliquez sur Finish

Configurer la librairie ZK Library

Vu que ZK Studio est déjà compilé avec la librairie ZK (par exemple, ZK 3.6.1), vous ne devez pas la configurer. Pour de plus amples informations, merci de vous référer à How to Import ZK library

Exécuter une application démo

Aucune installation n'est nécessaire

Visitez ZK Demo pour tester la simplicité et la richesse de ZK sans plus attendre!!

Exécuter une application démo

Note: Vérifiez que vous avez installé les packages suivants:

1. Java JDK
2. Un serveur d'application (Tomcat)
3. Eclipse (OPTIONNEL)

Si vous n'avez pas installé ces packages, merci de vous rendre au chapitre précédent.

Télécharger la démo ZK

1. Téléchargez zk-demo-3.6.1.zip.
2. Décompressez zk-demo-3.6.1.zip sur votre C:\

Exécuter la démo sans IDE

1. Copiez zkdemo.war (ex. C:\zk-demo-3.6.1\zkdemo.war) dans le dossier $TOMCAT_HOME\webapps.
2. Démarrez Apache Tomcat.
3. Ouvrez votre navigateur et allez à l'adresse http://localhost:8080/zkdemo/userguide.

Exécuter la démo avec un IDE

1. Sélectionnez File > Import .
2. Dans la boite de dialogue, sélectionnez Web > WAR file et ensuite cliquez sur Next.
3. Utilisez le bouton Browse pour atteindre le fichier zkdemo.war (ex. C:\zk-demo-3.6.1\zkdemo.war).
4. Cliquez sur Finish pour importer le Web Project.
5. Faites un click-droit sur le projet zkdemo dans l'explorateur et sélectionnez Run As > Run on Server
6. Sélectionnez Apache > Tomcat v6.0 Server dans la boite de dialogue serveur et cliquez sur Finish
7. Un navigateur va être activé, et cliquez sur le lien ZK Demo pour atteindre la démo zk.

Exécuter la démo sur d'autres serveurs d'applications

IBM WebSphere

BEA WebLogic

JBoss

Oracle OC4J and Oracle OPMN Release 3

Liferay

Pluto

Jetty

Resin

Créer une application "hello world" (sans IDE)

Créer un projet web

Créez la structure de projet ci-dessous dans le dossier $TOMCAT_HOME\webapps, par exemple MyApp (ex.C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\MyApp\).

+MyApp 
    +WEB-INF 
       +lib
       web.xml
       zk.xml
  index.zul

Déployer la librairie ZK

Copiez les fichiers jar suivants dans $TOMCAT_HOME\webapps\PROJECT NAME\WEB-INF\lib

zk-bin-3.6.0\dist\lib\*.jar
zk-bin-3.6.0\dist\lib\ext\*.jar
zk-bin-3.6.0\dist\lib\zkforge\*.jar

Créer le fichier"web.xml"

Copiez les lignes suivantes dans $TOMCAT_HOME\webapps\PROJECT NAME\WEB-INF\web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5">
  <display-name>MyApp</display-name>
  <listener>
  	<description>
  	Used to cleanup when a session is destroyed</description>
  	<display-name>
  	ZK Session Cleaner</display-name>
  	<listener-class>org.zkoss.zk.ui.http.HttpSessionListener</listener-class>
  </listener>
  <servlet>
  	<description>
  	The servlet loads the DSP pages.</description>
  	<servlet-name>dspLoader</servlet-name>
  	<servlet-class>
  	org.zkoss.web.servlet.dsp.InterpreterServlet</servlet-class>
  </servlet>
  <servlet>
  	<description>
  	ZK loader for ZUML pages</description>
  	<servlet-name>zkLoader</servlet-name>
  	<servlet-class>
  	org.zkoss.zk.ui.http.DHtmlLayoutServlet</servlet-class>
  	<init-param>
  		<param-name>update-uri</param-name>
  		<param-value>/zkau</param-value>
  	</init-param>
  	<load-on-startup>1</load-on-startup>
  </servlet>
  <servlet>
  	<description>
  	The asynchronous update engine for ZK</description>
  	<servlet-name>auEngine</servlet-name>
  	<servlet-class>
  	org.zkoss.zk.au.http.DHtmlUpdateServlet</servlet-class>
  </servlet>
  <servlet-mapping>
  	<servlet-name>dspLoader</servlet-name>
  	<url-pattern>*.dsp</url-pattern>
  </servlet-mapping>
  <servlet-mapping>
  	<servlet-name>zkLoader</servlet-name>
  	<url-pattern>*.zul</url-pattern>
  </servlet-mapping>
  <servlet-mapping>
  	<servlet-name>zkLoader</servlet-name>
  	<url-pattern>*.zhtml</url-pattern>
  </servlet-mapping>
  <servlet-mapping>
  	<servlet-name>auEngine</servlet-name>
  	<url-pattern>/zkau/*</url-pattern>
  </servlet-mapping>
  <welcome-file-list>
    <welcome-file>index.html</welcome-file>
    <welcome-file>index.htm</welcome-file>
    <welcome-file>index.jsp</welcome-file>
    <welcome-file>default.html</welcome-file>
    <welcome-file>default.htm</welcome-file>
    <welcome-file>default.jsp</welcome-file>
    <welcome-file>index.zul</welcome-file>
  </welcome-file-list>
</web-app>

Créez le fichier "zk.xml"

Copiez les lignes suivantes dans $TOMCAT_HOME\webapps\PROJECT NAME\WEB-INF\zk.xml

<?xml version="1.0" encoding="UTF-8"?>
 
<!--
	Created by ZK Studio
-->
 
<zk>
 
</zk>

Créez votre première page web

Créez index.zul dans $TOMCAT_HOME\webapps\PROJECT NAME\ et copiez y les lignes suivantes.

 <window title="My First window" border="normal" width="200px"> 
 Hello, World! 
 </window>

Exécuter votre application

1. Démarrez Apache Tomcat.
2. Allez à l'adresse http://localhost:8080/MyApp/.

Créer une application "hello world" (avec un IDE)

Note: Vérifiez d'avoir bien installé Java JDK, Application Server, et ZK Studio . Si pas, référez vous au chapitre précédent.

Créer un nouveau "ZK Project"

Grâce à ZK Studio, vous n'avez plus besoin de créer un nouveau Dynamic Web Project et configurer les paramètres pour ZK! Vous pouvez créer directement un nouveau ZK Project, choisir votre Package ZK et vous relaxer pendant que ZK Studio fait le reste pour vous.

Le swf suivant illustre comment créer un nouveau projet ZK avec Eclipse 3.4 et ZK Studio:

Pour le détail des étapes, merci de vous référez à Create a New ZK Project

Créer un nouveau fichier ZUL

1. Faites un click-droit sur le dossier WebContent dans le Project Explorer ou dans le Package Explorer et sélectionnez New > ZUL.

2. Tapez index.zul dans la zone de texte File name et cliquez sur Finish.

3. Le nouveau fichier ZUL sera ouvert dans le ZUL Editor.

Exécuter le fichier ZUL

1. Faites un click-droit sur le projet MyApp dans l'explorateur et dans la boite de dialogue Menu sélectionnez Run As > Run on Server

2. Sélectionnez Apache > Tomcat v6.0 Server dans la boite de dialogue server et ensuite cliquez sur Finish

3. Observez le résultat dans votre navigateur.

Créer une réelle application avec une base de données

Référez vous à cet article.

Annexe A. Le contenu de la distribution binaire

Ce chapitre décrit le contenu de la librairie ZK.

/doc

Ce dossier contient plusieurs documents dont les copyrights et les notes concernant les différentes versions.

/dist/lib

Ce dossier contient les librairies nécessaires pour pouvoir exécuter ZK.

/dist/lib/zkforge

Ce dossier contient les composants de ZK Forge, tel que FCKeditor. Ce dossier est optionnel selon que vous l'utilisiez ou non.

/dist/lib/ext

Ce dossier contient les librairies externes requises pour exécuter ZK. Toutefois, ces librairies sont habituelles, il se peut donc que vous les ayez installées dans votre container.

Vous trouvez aussi des fichiers jar optionnels. Vous pouvez choisir de les copier ou non selon vos besoins.

/dist/src

Ce dossier contient les codes sources au format JAR. Ces fichiers JAR sont utilisés pour effectuer du débogage dans un IDE tel qu'Eclipse. Vous ne pouvez pas compiler les libraires à partir de ces fichiers. Si vous souhaitez compiler les librairies à partir des sources, veuillez télécharger et décompresser l'archive zk-src-3.5.2.tar.gz.

/dist/xsd

Ce dossier contient les fichiers XSD qui peuvent s'avérer utiles pour développer des applications ZK.

/dist/WEB-INF

Ce dossier contient les fichiers TLD. Ceux-ci sont en fait une partie des fichiers JAR et sont donc automatiquement chargés. Nous les mettons ici à disposition comme référence.

Annexe B. Le contenu de la distribution démo

Ce chapitre décrit le contenu de l'archive zk-demo-3.5.2.zip.

/

Ce dossier contient les exécutables: zkdemo.war, zkdemo-min.war, zkdemos.ear et zkdemos-min.ear. Référez vous au chapitre Installation pour de plus amples détails.

/zkdemo

Ce dossier contient le code source de la démo.

/MyApp

Ce dossier contient une application Web vide à partir de laquelle vous pouvez démarrer votre propre nouvelle application.