Setting Up ZK Spring using Maven"

From Documentation
(→‎Adding ZK Spring library dependencies: remove jboss.el , zk version with zkspring version)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{ZKSpringEssentialsPageHeader}}
 
{{ZKSpringEssentialsPageHeader}}
−
{{ZKSpringEssentialsHeadingToc}}
 
  
−
===Purpose===
+
= Create a New Project with ZK Archetype =
−
Setup ZK Spring Integration Library using maven configurations
 
  
−
===Example===
+
The simplest way to create a ZK maven project is using the archetype: '''zk-ee-eval-archetype-webapp-spring'''. A project generated by this archetype will include required ZK and spring dependencies and ZK maven evaluation repository.
  
−
==== Add ZK Maven repository to your pom.xml file ====
+
If you use maven in a command line console, you need to specify ZK archetype catalog URL to generate your project. Please refer to [[ZK Installation Guide/Quick Start/Create and Run Your First ZK Application with Eclipse and Maven#Create_a_Maven_Project_with_a_Command_Line_Interface | Create a Maven Project with a Command Line Interface]].
−
By default, while resolving project dependencies Maven will only look into Maven central repository [http://repo1.maven.org/maven2]. In order to use ZK Maven repository, add the following <repositories> elements into pom.xml under the root <project> element.
 
  
−
<source lang="xml">
+
If you use eclipse, you can add the catalog URL via Window / Preferences / Maven / Archetypes, please refer to [[ZK Installation Guide/Quick Start/Create and Run Your First ZK Application with Eclipse and Maven#Add ZK Maven Archetype]]
−
<repositories>
 
−
    <repository>
 
−
      <id>zk repository</id>
 
−
      <url>http://mavensync.zkoss.org/maven2</url>
 
−
    </repository>
 
−
  </repositories>
 
−
</source>
 
−
 
 
−
Note that ZK Maven repository URL is [http://mavensync.zkoss.org/maven2 http://mavensync.zkoss.org/maven2].
 
  
−
==== Adding ZK Spring library dependencies ====
+
= Adding ZK Spring Dependencies =
  
−
Add the following dependencies and Maven can resolve them by connecting to [http://mavensync.zkoss.org/maven2 ZK Maven repository].
+
After creating a project, you still need to add ZK Spring dependencies. ZK Spring has 2 artifacts, you can add them to your requirement.
  
−
For ZK '''5''', you can use '''3.0''' or '''3.1'''.
+
For ZK '''5''', you can use '''3.0''' or above.
  
−
For ZK '''6''', you should use '''3.1'''.
+
For ZK '''6+''' '''3.2'''
  
−
'''ZK Spring Core''''
+
For ZK '''8+''' or above, you should use '''4.0.0''' or above.
−
<source lang="xml">
 
  
 +
'''Required for both modules'''
 +
<source lang='xml'>
 
<dependency>
 
<dependency>
−
<groupId>org.zkoss.zk</groupId>
+
    <groupId>org.zkoss.zk</groupId>
−
<artifactId>zkspring-core</artifactId>
+
    <artifactId>zkplus</artifactId>
−
<version>3.1</version>
+
    <version>${zk.version}</version>
 
</dependency>
 
</dependency>
−
 
 
</source>
 
</source>
  
−
You can add zkspring-webflow or zkspring-security according to your requirement.
+
'''ZK Spring Core'''
 +
<source lang="xml">
  
−
'''ZK Spring Webflow'''
 
−
<source lang="xml">
 
 
<dependency>
 
<dependency>
 
<groupId>org.zkoss.zk</groupId>
 
<groupId>org.zkoss.zk</groupId>
−
<artifactId>zkspring-webflow</artifactId>
+
<artifactId>zkspring-core</artifactId>
−
<version>3.1</version>
+
<version>${zkspring.version}</version>
 
</dependency>
 
</dependency>
−
 
 
</source>
 
</source>
 +
Check the available versions at [https://mavensync.zkoss.org/maven2/org/zkoss/zk/zkspring-core/ CE repository].
  
 
'''ZK Spring Security'''
 
'''ZK Spring Security'''
Line 57: Line 44:
 
<groupId>org.zkoss.zk</groupId>
 
<groupId>org.zkoss.zk</groupId>
 
<artifactId>zkspring-security</artifactId>
 
<artifactId>zkspring-security</artifactId>
−
<version>3.1</version>
+
<version>${zkspring.version}</version>
 
</dependency>
 
</dependency>
 +
</source>
 +
Check the available versions at [https://mavensync.zkoss.org/maven2/org/zkoss/zk/zkspring-security/ CE repository]
 +
 +
 +
'''ZK Spring Webflow'''
  
−
</source>
+
discontinued since 4.0.0
 +
 
 +
==ZKSpring 6 ==
 +
Notice that this version depends on [https://spring.io/blog/2022/11/16/spring-framework-6-0-goes-ga Spring Framework 6.0] and requires Jakarta EE.
  
−
===Configuration===
+
= Configuration in web.xml =
−
* You need to declare Spring ContextLoaderListener in the web.xml file to be able to declare and register your Spring beans with Spring framework.  
+
You need to declare Spring <code>ContextLoaderListener</code> in the <code>web.xml</code> file to be able to declare and register your Spring beans with Spring framework.  
 
<source lang="xml">
 
<source lang="xml">
 
<listener>
 
<listener>
Line 69: Line 64:
 
</listener>
 
</listener>
 
</source>
 
</source>
 +
 +
 +
= Example Project =
 +
* [https://github.com/zkoss/zkspring/tree/master/zkspringessentials/zkspringcoresec zkspring example project for spring 5 or before].
 +
* [https://github.com/zkoss/zkspring/tree/6.0.0/zkspringessentials/zkspringcoresec zkspring example project for spring 6]
  
 
=Version History=
 
=Version History=
−
{{LastUpdated}}
+
 
 
{| border='1px' | width="100%"
 
{| border='1px' | width="100%"
 
! Version !! Date !! Content
 
! Version !! Date !! Content
 
|-
 
|-
−
| &nbsp;
+
| 3.1.1
−
| &nbsp;
+
| 2014/10/07
−
| &nbsp;
+
| rewrite for supported Spring version
 +
|-
 +
| 4.0.0
 +
| 2019/01
 +
| update for 4.0.0
 
|}
 
|}
 
{{ZKSpringEssentialsPageFooter}}
 
{{ZKSpringEssentialsPageFooter}}

Latest revision as of 04:30, 17 January 2024

DocumentationZK Spring EssentialsGetting Started with ZK SpringSetting Up ZK Spring using Maven
Setting Up ZK Spring using Maven



Create a New Project with ZK Archetype

The simplest way to create a ZK maven project is using the archetype: zk-ee-eval-archetype-webapp-spring. A project generated by this archetype will include required ZK and spring dependencies and ZK maven evaluation repository.

If you use maven in a command line console, you need to specify ZK archetype catalog URL to generate your project. Please refer to Create a Maven Project with a Command Line Interface.

If you use eclipse, you can add the catalog URL via Window / Preferences / Maven / Archetypes, please refer to ZK Installation Guide/Quick Start/Create and Run Your First ZK Application with Eclipse and Maven#Add ZK Maven Archetype

Adding ZK Spring Dependencies

After creating a project, you still need to add ZK Spring dependencies. ZK Spring has 2 artifacts, you can add them to your requirement.

For ZK 5, you can use 3.0 or above.

For ZK 6+ 3.2

For ZK 8+ or above, you should use 4.0.0 or above.

Required for both modules 

<dependency>
    <groupId>org.zkoss.zk</groupId>
    <artifactId>zkplus</artifactId>
    <version>${zk.version}</version>
</dependency>

ZK Spring Core 

<dependency>
	<groupId>org.zkoss.zk</groupId>
	<artifactId>zkspring-core</artifactId>
	<version>${zkspring.version}</version>
</dependency>

Check the available versions at CE repository.

ZK Spring Security 

<dependency>
	<groupId>org.zkoss.zk</groupId>
	<artifactId>zkspring-security</artifactId>
	<version>${zkspring.version}</version>
</dependency>

Check the available versions at CE repository


ZK Spring Webflow

discontinued since 4.0.0

ZKSpring 6

Notice that this version depends on Spring Framework 6.0 and requires Jakarta EE.

Configuration in web.xml

You need to declare Spring ContextLoaderListener in the web.xml file to be able to declare and register your Spring beans with Spring framework. 

<listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>


Example Project

Version History

Version Date Content
3.1.1 2014/10/07 rewrite for supported Spring version
4.0.0 2019/01 update for 4.0.0


Last Update : 2024/01/17

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.


Retrieved from "https://www.zkoss.org/_w/index.php?title=ZK_Spring_Essentials/Getting_Started_with_ZK_Spring/Setting_Up_ZK_Spring_using_Maven&oldid=56556"