了解include组件
预备知识:
加载页面的活动周期:初始阶段,组件创建阶段,事件处理阶段,响应阶段或显示阶段或渲染显示阶段
include的组件是zk的一个包含组件,其他类似动态技术(jsp,freemarker等)都有相关功能
include 的src属性指定的页面可以是zhtml,zul或者其他的servlet生成的页面(jsp,html,jsf 等等等)
include另外一个重要属性是mode,即include加载模式,三个值auto(默认)、instant,defer,
当然你可以覆盖mode的值
1,include组件指定mode的值,
2,修改org.zkoss.zul.include.mode的值
Library.setProperty("org.zkoss.zul.include.mode","instant")
或者修改zk.xml配置文件里的
<library-property>
<name>org.zkoss.zul.include.mode</name> <value>auto</value>
</library-property>
下面讲解这三种模式instant,defer,auto
instant:
即时,立即,组件创建阶段,在include组件创建完毕后,会自动调用include对应类
org.zkoss.zul.Include (标准组件在org.zkoss.zul.*下都有对应的类) 的afterCompose方法,立即加载src页面
//AfterCompose//
public void afterCompose() {
_afterComposed = true;
fixModeOnly();
if (_instantMode) {
final Execution exec = getExecution();
final Map old = setupDynams(exec);
final String attrRenderedKey = ATTR_RENDERED+'$'+getUuid();
final String oldSrc = (String) exec.getAttribute(attrRenderedKey);
if (!Objects.equals(oldSrc, _src)) {
try {
getChildren().clear();
final int j = _src.indexOf('?');
exec.createComponents(j >= 0 ? _src.substring(0, j) : _src,
this, _dynams);
// TODO: convert query string to arg
exec.setAttribute(attrRenderedKey, _src);
} finally {
restoreDynams(exec, old);
}
}
} else {
// just in case
getChildren().clear();
}
}
在上面的方法中我们看到内部其实是使用的createComponents方法创建的,
createComponents方法创建【父组件的子组件】即include组件的子组件,当然也是include组件父组件的子组件,
注意:不会创建src页面对应的Page对象,desktop.getPage("src指定页面page指令id的名称")获取的是null。
举例理解instant:
<div>
<include mode="instant" src="b.zul"/>
</div>
这里其实等于将b.zul的内容拷贝到<div>里
instant模式就像jsp中的<%include%>静态指令的行为,将<%include%>指定的页面
直接插入当前页面,而不是<jsp:include/>动态的行为,
另外,现在有一个问题,如果src的值是b.html呢?
解决这个问题之前,要先了解createComponents,
该方法要求uri或者content的内容必须符合ZUML语法
因此上面的问题的答案是否定的,html不符合zuml语法
defer:
懒加载,懒到什么程度呢?在组件显示阶段或响应阶段才会加载src指定的页面
显示阶段会自动调用renderProperties方法
protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
throws java.io.IOException {
super.renderProperties(renderer);
setChildPage(null);
render(renderer, "comment", _comment);
if (_instantMode &&_afterComposed)
return; //instant mode (done by redrawChildren())
final UiEngine ueng =
((WebAppCtrl)getDesktop().getWebApp()).getUiEngine();
Component old = ueng.setOwner(this);
try {
if (_progressStatus == 1) {
_progressStatus = 2;
} else if (_src != null && _src.length() > 0) {
final StringWriter sw = new StringWriter();
include(sw);
//Don't output sw directly if getChildPage() is not null
//Otherwise, script of the included zul page will be evaluated
//first (since it is part of rc.temp)
boolean done = false;
if (getChildPage() == null) { //only able to handle non-ZUL page
final HtmlPageRenders.RenderContext rc =
HtmlPageRenders.getRenderContext(null);
if (rc != null && !rc.included) { //Use z$ea only if not included
final Writer cwout = rc.temp;
cwout.write("<div id=\"");
cwout.write(getUuid());
cwout.write("\" style=\"display:none\">");
if (_comment)
cwout.write("\n<!--\n");
Files.write(cwout, sw.getBuffer());
if (_comment)
cwout.write("\n-->\n");
cwout.write("</div>");
renderer.render("z$ea", "content");
done = true;
}
}
if (!done) {
renderer.render("content", sw.toString());
if (_renderResult != null && _renderResult.length() > 0)
renderer.renderDirectly("_childjs", "function(){" + _renderResult + '}');
}
}
} finally {
_renderResult = null;
ueng.setOwner(old);
}
}
在该方法中,关键代码
final StringWriter sw = new StringWriter();
include(sw);
include内部调用了Servlet相关方法RequestDispatcher.include,与<jsp:include/>行为一样,这里就不介绍内部代码了,
如果你了解Servlet相关api,那么应该清楚RequestDispatcher.include的行为,该方法会发送一个http请求,
请求src指定的页面,web容器拦截这个请求,处理请求,响应结果
举例理解defer:
<window>
<include mode="defer" src="b.zul"/>
</window>
RequestDispatcher.include会发送一个http请求,请求src指定的目标页获取解析结果,即普通的html页面
并将html页面写入response的out流中
因为defer模式中,对src的获取是基于http请求的,所以src可以是任何servlet,不仅仅是zhtml,zul
auto模式:自动选择模式
private void fixModeOnly() { //called by afterCompose
if ("auto".equals(_mode)) {
if (_src != null && !_progressing && !_localized) {
_instantMode = _src.endsWith(".zul") || _src.endsWith(".zhtml");
} else
_instantMode = false;
} else
_instantMode = "instant".equals(_mode);
}
从上面的代码中,auto模式时,如果src的后缀是zul,zhtml结尾则使用instant模式,反之使用defer模式
传递参数:
a.zul include b.zul
1,在请求a.zul页面的时候,给b.zul传递参数
1)Executions.getCurrent().setAttribute()
2)a.zul url地址后追加参数,a.zul?name=333或者b.zul?name=323
或者
3)include组件定义动态参数 <include name="333/>
2,已经响应完毕的时候,现在修改include的src, 重新加载src指定的页面
1)Executions.getCurrent().setAttribute()
2)Executions.getCurrent().pushArg(arg)
3)iclude.setDynamicProperty(name, value)
4)b.zul?name=323
5)当然可以设置组件作用域对象,include.setAttribute,但生命周期太长