Create and Run Your First ZK Application with Eclipse and Maven"
From Documentation
Jimmyshiau (talk | contribs) |
Jimmyshiau (talk | contribs) |
||
| Line 12: | Line 12: | ||
:[[ZK_Installation_Guide/Setting_up_IDE/Maven/Setting_up_Maven_on_Eclipse | Install M2eclipse]] | :[[ZK_Installation_Guide/Setting_up_IDE/Maven/Setting_up_Maven_on_Eclipse | Install M2eclipse]] | ||
==Add ZK Maven Archetype== | ==Add ZK Maven Archetype== | ||
| − | *'''[Window]''' -> '''[Preferences]''' -> '''[Maven]''' --> '''[Archetypes]''' | + | *'''[Window]''' -> '''[Preferences]''' -> '''[Maven]''' --> '''[Archetypes]''', click ''Add Remote Catalog'' and type in the catalog file as illustrated: |
| − | + | *:[[File:ZK_Installation_Guide_Quick_Start_Create_and_Run_with Eclipse_and_Maven.png]] | |
| − | |||
| − | *:[[File: | ||
http://mavensync.zkoss.org/maven2/ | http://mavensync.zkoss.org/maven2/ | ||
*Click '''Verify''' and then '''OK''' to add the catalog. | *Click '''Verify''' and then '''OK''' to add the catalog. | ||
| Line 24: | Line 22: | ||
#: http://m2eclipse.sonatype.org/sites/m2e/0.10.2.20100623-1649/ | #: http://m2eclipse.sonatype.org/sites/m2e/0.10.2.20100623-1649/ | ||
#Install the “newer version” from the following site: http://download.eclipse.org/technology/m2e/releases You first will need to uninstall m2eclipse 0.12.x, restart Eclipse before you can install the “newer” version from the website above. (Please note: the newer version of M2eclipse plugin is not compatible with the old Maven Project. Therefore you must enable your maven project with the latest M2eclipse plugin from the Installing m2eclipse website.) | #Install the “newer version” from the following site: http://download.eclipse.org/technology/m2e/releases You first will need to uninstall m2eclipse 0.12.x, restart Eclipse before you can install the “newer” version from the website above. (Please note: the newer version of M2eclipse plugin is not compatible with the old Maven Project. Therefore you must enable your maven project with the latest M2eclipse plugin from the Installing m2eclipse website.) | ||
| − | #Create the plugin from the archetype using the Maven command line tool mvn, then use import existing maven project to add the generated project to Eclipse. For more details, please refer to [[ | + | #Create the plugin from the archetype using the Maven command line tool mvn, then use import existing maven project to add the generated project to Eclipse. For more details, please refer to [[#Use_the_command_line_version_of_Maven_to_create_a_project | Use the command line version of Maven to create a project]]. |
</ref> | </ref> | ||
---- | ---- | ||
<references/> | <references/> | ||
| − | |||
| − | |||
=Create a "Hello World" application with ZK Maven Archetype= | =Create a "Hello World" application with ZK Maven Archetype= | ||
Revision as of 07:55, 22 June 2012
M2eclipse is the first and most mature of the projects aimed at integrating Apache Maven within the Eclipse IDE.
Prepare Eclipse
Install Eclipse
Please follow the installation guide for your Eclipse:
Install M2eclipse
Please follow the installation guide for your M2eclipse:
Add ZK Maven Archetype
- [Window] -> [Preferences] -> [Maven] --> [Archetypes], click Add Remote Catalog and type in the catalog file as illustrated:
http://mavensync.zkoss.org/maven2/
- Click Verify and then OK to add the catalog.
- If the Remote catalog is empty.[1]
- ↑
If an error message appears stating that the Remote catalog is empty, this is most likely due to a bug in the m2eclipse plugin in v0.12.x, MNGECLIPSE-2757.
Until m2eclipse 0.13.x or newer versions are released and available, there are two possible workarounds:
- Install the "older version" 0.10.x from the Installing m2eclipse website. Users will first need to uninstall m2eclipse 0.12.x, restart, and then install 0.10.x available from the following site:
- Install the “newer version” from the following site: http://download.eclipse.org/technology/m2e/releases You first will need to uninstall m2eclipse 0.12.x, restart Eclipse before you can install the “newer” version from the website above. (Please note: the newer version of M2eclipse plugin is not compatible with the old Maven Project. Therefore you must enable your maven project with the latest M2eclipse plugin from the Installing m2eclipse website.)
- Create the plugin from the archetype using the Maven command line tool mvn, then use import existing maven project to add the generated project to Eclipse. For more details, please refer to Use the command line version of Maven to create a project.
Create a "Hello World" application with ZK Maven Archetype
Create a Maven Project
- [File] -> [New] -> [Other] --> [Maven Project]
- Make sure Create a simple project is unticked in the first screen of the New Maven Project wizard and click Next >.
- From the Select an Archetype screen, select zk[1] from the catalog dropdown list.
- Select zk-archetype-webapp from the list. (At the time of writing this is at version 0.8.0).
- Next, fill in details for group id, artifact id, version number and package name.
- If the property zk-version-since is missing.[2]
- Click Finish and the Eclipse status bar should say ' Creating zk-archetype-webapp ' and ' Updating Maven Dependencies '. If this is the user's first time dealing with ZK libraries, Maven will download the necessary dependencies to compile and run this example, and would be stored in .m2/repository in the user's home directory.
- ↑ To add a ZK archetype catalog, click Configure then refer to Use ZK Maven Archetype for the complete instruction.
- ↑
Users who are running this wizard for the first time, zk archetype would not have been downloaded into m2eclipse yet, and as a result may not populate the zk-version-since property correctly, leading to an error message like the following:
Unable to create project from archetype [org.zkoss:zk-archetype-webapp:0.8.0 -> http://mavensync.zkoss.org/maven2/], Archetype org.zkoss:zk-archetype-webapp:0.8.0 is not configured property ''zk-version-since'' is missing.
The simple workaround for this problem is to just try again after clicking ‘Finish’ to end the ZK Maven web project wizard. When re-running the wizard, the zk-version-since property should appear in the list this time.
How to run Maven project on Run-Jetty-Run (Optional)
Notice that Run-Jetty-Run is optional. The speed of deployment is much faster, but the server is Jetty embedded in Run-Jetty-Run. If you prefer to use your own server, you could skip this step.
- Go to Run Configurations
- Double click on Jetty Webapp
- It will automatically fill-out Project / Ports / Context / WebApp Dir
- Click Run and start browsing local ZK application at http://127.0.0.1:8080/myapp/
Packing your project
- Go to Run As > Maven install
- The project will then be packed into a war file and a zip file with source code.
Use the command line version of Maven to create a project
- For instructions on how to set up maven, please refer to Maven.
- Go to the folder in Eclipse workspace, then run the following command:
- Calling archetype:generate -DarchetypeCatalog=http://mavensync.zkoss.org/maven2/ - the plugin will first ask to choose the archetype from the zk catalog, please just enter the number of the archetype.
- It will then ask users to enter the values for groupId, the artifactId and the version of the project to create and the base package for the sources.
- It will then ask for confirmation of the configuration and perform the creation of the project.
- In the following example, webapp archetype (number 2) is selected and groupId is set to org.test, artifactId to myapp, version to 1.0-SNAPSHOT and package to org.test.myapp.
$ mvn archetype:generate -DarchetypeCatalog=http://mavensync.zkoss.org/maven2/
[INFO] Scanning for projects...
[INFO] Searching repository for plugin with prefix: 'archetype'.
[INFO] ------------------------------------------------------------------------
[INFO] Building Maven Default Project
[INFO] task-segment: [archetype:generate] (aggregator-style)
[INFO] ------------------------------------------------------------------------
[INFO] Preparing archetype:generate
[INFO] No goals needed for project - skipping
[INFO] [archetype:generate {execution: default-cli}]
[INFO] Generating project in Interactive mode
[INFO] No archetype defined. Using maven-archetype-quickstart (org.apache.maven.archetypes:maven-archetype-quickstart:1.0)
Choose archetype:
1: http://mavensync.zkoss.org/maven2/ -> zk-archetype-component (zk-archetype-component)
2: http://mavensync.zkoss.org/maven2/ -> zk-archetype-webapp (zk-archetype-webapp)
Choose a number: : 2
Downloading: http://mavensync.zkoss.org/maven2//org/zkoss/zk-archetype-webapp/0.8.0/zk-archetype-webapp-0.8.0.jar
11K downloaded (zk-archetype-webapp-0.8.0.jar)
Downloading: http://mavensync.zkoss.org/maven2//org/zkoss/zk-archetype-webapp/0.8.0/zk-archetype-webapp-0.8.0.pom
1K downloaded (zk-archetype-webapp-0.8.0.pom)
Define value for property 'groupId': : org.test
Define value for property 'artifactId': : myapp
Define value for property 'version': 1.0-SNAPSHOT:
Define value for property 'package': org.test: org.test.myapp
[INFO] Using property: zk-version-since = 5.0.6
Confirm properties configuration:
groupId: org.test
artifactId: myapp
version: 1.0-SNAPSHOT
package: org.test.myapp
zk-version-since: 5.0.6
Y:
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 22 seconds
[INFO] Finished at: Thu Jul 28 12:07:19 CST 2011
[INFO] Final Memory: 12M/150M
[INFO] ------------------------------------------------------------------------
Import a Maven project into Eclipse
- [File] -> [Import] -> [Maven] --> [Existing Maven Projects]
- After this, the user should now get a new project in the Package explorer.
Version History
| Version | Date | Content |
|---|---|---|