Creating ZK Component with Maven Archetype"

From Documentation
(Created page with "=How to create ZK Component Maven project= == Create Project of Maven== *'''[File]''' -> '''[New]''' -> '''[Other]''' --> '''[Maven Project]''' *:[[File:ZK_Installation_Guide_Mav...")
 
Line 1: Line 1:
 +
{{ZKInstallationGuidePageHeader}}
 +
 
=How to create ZK Component Maven project=
 
=How to create ZK Component Maven project=
 
== Create Project of Maven==
 
== Create Project of Maven==

Revision as of 08:57, 28 July 2011


DocumentationZK Component Development EssentialsZK Component OverviewCreating ZK Component with Maven Archetype
Creating ZK Component with Maven Archetype



How to create ZK Component Maven project

Create Project of Maven

  • [File] -> [New] -> [Other] --> [Maven Project]
    ZK Installation Guide Maven step1.png
  • Make sure Create a simple project is not ticked in the first screen of the New Maven Project wizard and click Next >.
    ZK Installation Guide Maven Archetype step1.png
  • From the Select an Archetype screen, we'll need to add the ZK archetype catalog. Click Configure....
    ZK Installation Guide Maven Archetype step2.png
  • From the Maven archetypes catalogs setting, click Add Remote Catalog... and add the catalog file:
    ZK Installation Guide Maven Archetype step3.png
http://mavensync.zkoss.org/maven2/
  • Click Verify... and then OK to add the catalog.
    • Remote catalog is empty.[1]
  • Click OK in the "Preferences" dialogue.
  • Now you should be able to find zk in the Catalog dropdown list.
    ZKComDevEss Maven CreateComponent setp4.png
  • Select the zk-archetype-component from the list. (At time of writing this is at version 0.8.0).
  • Next, fill in details for group id, artifact id, version number and package name.
    ZKComDevEss Maven CreateComponent setp5.png
    • Property zk-version-since is missing.[2]
  • Click Finish and the Eclipse status bar should say ' Creating zk-archetype-component ' and ' Updating Maven Dependencies '. If this is the first time you deal with ZK libraries, Maven will download the necessary dependencies to compile and run this example, and would be stored in .m2/repository in your home directory.
    ZKComDevEss Maven CreateComponent setp6.png
  1. ↑ If you receive the error message 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 are released, there are two possible workarounds:
    1. Install the "Older version" 0.10.x from the Installing m2eclipse website. You'll need to first uninstall m2eclipse 0.12.x, restart and then install 0.10.x from these install sites:
      http://m2eclipse.sonatype.org/sites/m2e/0.10.2.20100623-1649/
    2. 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. please refer to Use the command line version of Maven for creating the project.
  2. ↑ The first time you run this wizard, m2eclipse will not yet have downloaded the zk archetype, and might not populate the zk-version-since property correctly, leading to an error message like:
    • Unable to create project from archetype [org.zkoss:zk-archetype-component:0.8.0 -> http://mavensync.zkoss.org/maven2/], Archetype org.zkoss:zk-archetype-component:0.8.0 is not configured Property zk-version-since is missing.
    The simple workaround is to just try again - this time the zk-version-since property should appear in the list. If it is still missing - add it with the value Example and try again.

How to run Maven project on Run-Jetty-Run

  1. Goto Run Configurations
    ZKComDevEss Maven CreateComponent run1.png
  2. Double click on Jetty Webapp
    • It will auto fill Project / Port / Context / WebApp Dir
    ZKComDevEss Maven CreateComponent run2.png
  3. Click Run and browse http://127.0.0.1:8080/mycomps/

Packing your component

  1. Goto Run As > Maven package
    ZKComDevEss Maven CreateComponent pak1.png
  2. Your project will be pack into a war file and a zip file with source code.
    ZKComDevEss Maven CreateComponent pak2.png

Use the command line version of Maven for creating the project

  • Here describes how to set up Maven.
  • Go to the folder for your Eclipse workspace, then run this command.
  • Calling archetype:generate -DarchetypeCatalog=http://mavensync.zkoss.org/maven2/ the plugin will first ask to choose the archetype from the zk catalog. Just enter the number of the archetype.
  • It then asks you to enter the values for the groupId, the artifactId and the version of the project to create and the base package for the sources.
  • It then asks for confirmation of the configuration and performs the creation of the project.
  • In the following example, we selected the component archetype (numbered 1) and set groupId to org.test, artifactId to mycomps, version to 1.0-SNAPSHOT and package to org.test.mycomps.
$ 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: : 1
Downloading: http://mavensync.zkoss.org/maven2//org/zkoss/zk-archetype-component/0.8.0/zk-archetype-component-0.8.0.jar
20K downloaded  (zk-archetype-component-0.8.0.jar)
Downloading: http://mavensync.zkoss.org/maven2//org/zkoss/zk-archetype-component/0.8.0/zk-archetype-component-0.8.0.pom
1K downloaded  (zk-archetype-component-0.8.0.pom)
Define value for property 'groupId': : org.test
Define value for property 'artifactId': : mycomps
Define value for property 'version': 1.0-SNAPSHOT:
Define value for property 'package': org.test: org.test.mycomps
Define value for property 'component-class': : Mylabel
Define value for property 'component-name': : mylabel
[INFO] Using property: zk-version-since = 5.0.6
Confirm properties configuration:
groupId: org.test
artifactId: mycomps
version: 1.0-SNAPSHOT
package: org.test.mycomps
component-class: Mylabel
component-name: mylabel
zk-version-since: 5.0.6
Y:
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 34 seconds
[INFO] Finished at: Thu Jul 28 16:27:55 CST 2011
[INFO] Final Memory: 13M/150M
[INFO] ------------------------------------------------------------------------

Import Maven project into Eclipse

  • [File] -> [Import] -> [Maven] --> [Existing Maven Projects]
    ZKComDevEss Maven CreateComponent import1.png
  • After this you should get three new projects in your Package explorer.
    ZKComDevEss Maven CreateComponent setp6.png
Retrieved from "https://www.zkoss.org/_w/index.php?title=ZK_Component_Development_Essentials/ZK_Component_Overview/Creating_ZK_Component_with_Maven_Archetype&oldid=20438"