Load JavaScript and CSS from Server Nearby"

From Documentation
Line 61: Line 61:
  
 
===Hosting ZK Static Resource===
 
===Hosting ZK Static Resource===
1. Create a WAR with all ZK JARs only (without your application code)
+
 
2. configure <tt>web.xml</tt> as a normal ZK application
+
# Create a WAR with all ZK JARs only (without your application code)
2. deploy such special '''ZK WAR''' to a server near your customer and add the URL to your implementation of URLEncoder.
+
# configure <tt>web.xml</tt> as a normal ZK application
 +
# deploy such special '''ZK WAR''' to a server near your customer and add the URL to your implementation of URLEncoder.
  
 
<i>Don't know how to deploy on server ?  Please refer to [[ZK Installation Guide|Installation Guide]]</i>.
 
<i>Don't know how to deploy on server ?  Please refer to [[ZK Installation Guide|Installation Guide]]</i>.

Revision as of 09:54, 21 April 2020


DocumentationZK Developer's ReferencePerformance TipsLoad JavaScript and CSS from Server Nearby
Load JavaScript and CSS from Server Nearby


If some of the client machines are far away from the application server, we could set up a server nearby the clients to host ZK's JavaScript and CSS files, and then configure the application server to generate the URLs of JavaScript and CSS (and iamges it refers) from the the sever nearby the clients.

URLEncoder.png

*Notice : the ZK static resource server is a simple server which deploy official ZK library, not your whole application.

How to

  1. Implement the Encodes.URLEncoder
  2. Add library-property configuration to the zk.xml
    Document : ZK Configuration Reference/zk.xml/The Library Properties/org.zkoss.web.servlet.http.URLEncoder.
  3. Host ZK static resouce server

Following is a sample :

Configuration

<library-property>
    <name>org.zkoss.web.servlet.http.URLEncoder</name>
    <value>org.zkoss.test.TestEncoder</value> <!-- Where the Implementation Class is -->
</library-property>

Implementation

package org.zkoss.test;
import javax.servlet.ServletContext;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import org.zkoss.web.servlet.http.Encodes.URLEncoder;
public class TestEncoder implements URLEncoder {

	@Override
	public String encodeURL(ServletContext ctx, ServletRequest request, ServletResponse response,
	String uri, URLEncoder defaultEncoder) throws Exception {
		if (isStaticResource(uri)) {
			return getResourceHost() + uri.replace("~./", "");
		} else {
			return defaultEncoder.encodeURL(ctx, request, response, uri, defaultEncoder);
		}
	}
	/**
	 * file .wcs : CSS File
	 * file .wpd : Javscript File
	 */
	private boolean isStaticResource(String url) {
		// zul.lang.wpd should not be a static resource
		return url.startsWith("~./") && !url.endsWith("zul.lang.wpd") && (url.endsWith(".wpd") || url.endsWith(".wcs"));
	}

	/**
	 * Detect where the ip is/ who is login / what kind of resouce server will
	 * 
	 * @return the host name include protocol prefix. (Client will retrieve resource from it)
	 */
	private String getResourceHost() {
		return "http://SomeWhereNearbyMe/DefaultContext/zkau/web/";
	}

}

Hosting ZK Static Resource

  1. Create a WAR with all ZK JARs only (without your application code)
  2. configure web.xml as a normal ZK application
  3. deploy such special ZK WAR to a server near your customer and add the URL to your implementation of URLEncoder.

Don't know how to deploy on server ? Please refer to Installation Guide.

Version History

Last Update : 2020/04/21


Version Date Content
     



Last Update : 2020/04/21

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