如何扩充struts验证框架，进行多表单页面的验证
类别: JAVA教程 
struts的validator的客户端验证，不能进行多表单页面的验证，原因是由<html:script>标签生成的javascipt是根据每个表单，生成一段代码。例如：
<html:javascript formName="searchSgbySjForm" dynamicJavascript="true" staticJavascript="false"/>生成 var bCancel = false;
function validateSearchSgbySjForm(form) { if (bCancel) return true; else return validateRequired(form) && validateDate(form); }
function required () { this.aa = new Array("sgfssjq", "事故发生时间起 不可为空.", new Function ("varName", "this.datePatternStrict=\'yyy-MM-dd\'; return this[varName];")); this.ab = new Array("sgfssjz", "事故发生时间止 不可为空.", new Function ("varName", "this.datePatternStrict=\'yyy-MM-dd\'; return this[varName];")); }
function DateValidations () { this.aa = new Array("sgfssjq", "事故发生时间起 不是有效的日期类型.", new Function ("varName", "this.datePatternStrict=\'yyy-MM-dd\'; return this[varName];")); this.ab = new Array("sgfssjz", "事故发生时间止 不是有效的日期类型.", new Function ("varName", "this.datePatternStrict=\'yyy-MM-dd\'; return this[varName];")); }
如果有多个的话required和DateValidations 都会重复的，而javascript是只认最后一个函数的。所以，会导致验证出错。
再写一个标签 ，主要根据原来的代码修改，代码如下:
/* * $Header: /home/cvs/jakarta-struts/src/share/org/apache/struts/taglib/html/JavascriptValidatorTag.java,v 1.52 2004/08/07 04:17:52 martinc Exp $ * $Revision: 1.52 $ * $Date: 2004/08/07 04:17:52 $ * * Copyright 2001-2004 The Apache Software Foundation. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */
package com.tmri.acd.tag;
import java.io.IOException;import java.util.ArrayList;import java.util.Collections;import java.util.Comparator;import java.util.Iterator;import java.util.List;import java.util.Locale;import java.util.Map;
import javax.servlet.jsp.JspException;import javax.servlet.jsp.JspWriter;import javax.servlet.jsp.PageContext;import javax.servlet.jsp.tagext.BodyTagSupport;
import org.apache.commons.validator.Field;import org.apache.commons.validator.Form;import org.apache.commons.validator.ValidatorAction;import org.apache.commons.validator.ValidatorResources;import org.apache.commons.validator.util.ValidatorUtils;import org.apache.commons.validator.Var;import org.apache.struts.Globals;import org.apache.struts.action.ActionMapping;import org.apache.struts.config.ModuleConfig;import com.tmri.acd.tag.TagUtils;import org.apache.struts.util.MessageResources;import org.apache.struts.validator.Resources;import org.apache.struts.validator.ValidatorPlugIn;import java.util.StringTokenizer;
/** * Custom tag that generates JavaScript for client side validation based * on the validation rules loaded by the <code>ValidatorPlugIn</code> * defined in the struts-config.xml file. * * @version $Revision: 1.52 $ $Date: 2004/08/07 04:17:52 $ * @since Struts 1.1 */public class JavascriptValidatorTag extends BodyTagSupport {
/** * A Comparator to use when sorting ValidatorAction objects. */ private static final Comparator actionComparator = new Comparator() { public int compare(Object o1, Object o2) {
ValidatorAction va1 = (ValidatorAction) o1; ValidatorAction va2 = (ValidatorAction) o2;
if ((va1.getDepends() == null || va1.getDepends().length() == 0) && (va2.getDepends() == null || va2.getDepends().length() == 0)) { return 0;
} else if ( (va1.getDepends() != null && va1.getDepends().length() > 0) && (va2.getDepends() == null || va2.getDepends().length() == 0)) { return 1;
} else if ( (va1.getDepends() == null || va1.getDepends().length() == 0) && (va2.getDepends() != null && va2.getDepends().length() > 0)) { return -1;
} else { return va1.getDependencyList().size() - va2.getDependencyList().size(); } } };
/** * The start of the HTML comment hiding JavaScript from old browsers. * @since Struts 1.2 */ protected static final String HTML_BEGIN_COMMENT = "/n<!-- Begin /n";
/** * The end of the HTML comment hiding JavaScript from old browsers. * @since Struts 1.2 */ protected static final String HTML_END_COMMENT = "//End --> /n";
// ----------------------------------------------------------- Properties
/** * The servlet context attribute key for our resources. */ protected String bundle = Globals.MESSAGES_KEY;
/** * The default locale on our server. * @deprecated This variable is no longer used. */ protected static Locale defaultLocale = Locale.getDefault();
/** * The name of the form that corresponds with the action name * in struts-config.xml. Specifying a form name places a * <script> </script> around the javascript. */ protected String formName = null;
/** * formName is used for both Javascript and non-javascript validations. * For the javascript validations, there is the possibility that we will * be rewriting the formName (if it is a ValidatorActionForm instead of just * a ValidatorForm) so we need another variable to hold the formName just for * javascript usage. */ protected String jsFormName = null;
/** * The line ending string. */ protected static String lineEnd = System.getProperty("line.separator");
/** * The current page number of a multi-part form. * Only valid when the formName attribute is set. */ protected int page = 0;
/** * This will be used as is for the JavaScript validation method name if it has a value. This is * the method name of the main JavaScript method that the form calls to perform validations. */ protected String methodName = null;
/** * Include language attribute in the <script> element. This property is * ignored in XHTML mode. * @since Struts 1.2 */ protected boolean scriptLanguage = true;
/** * The static JavaScript methods will only be printed if this is set to "true". */ protected String staticJavascript = "true";
/** * The dynamic JavaScript objects will only be generated if this is set to "true". */ protected String dynamicJavascript = "true";
/** * The src attribute for html script element (used to include an external script * resource). The src attribute is only recognized * when the formName attribute is specified. */ protected String src = null;
/** * The JavaScript methods will enclosed with html comments if this is set to "true". */ protected String htmlComment = "true";
/** * Hide JavaScript methods in a CDATA section for XHTML when "true". */ protected String cdata = "true";
/** * Gets the key (form name) that will be used * to retrieve a set of validation rules to be * performed on the bean passed in for validation. */ public String getFormName() { return formName; }
/** * Sets the key (form name) that will be used * to retrieve a set of validation rules to be * performed on the bean passed in for validation. * Specifying a form name places a * <script> </script> tag around the javascript. */ public void setFormName(String formName) { this.formName = formName; }
/** * @return Returns the jsFormName. */ public String getJsFormName() { return jsFormName; } /** * @param jsFormName The jsFormName to set. */ public void setJsFormName(String jsFormName) { this.jsFormName = jsFormName; } /** * Gets the current page number of a multi-part form. * Only field validations with a matching page numer * will be generated that match the current page number. * Only valid when the formName attribute is set. */ public int getPage() { return page; }
/** * Sets the current page number of a multi-part form. * Only field validations with a matching page numer * will be generated that match the current page number. * Only valid when the formName attribute is set. */ public void setPage(int page) { this.page = page; }
/** * Gets the method name that will be used for the Javascript * validation method name if it has a value. This overrides * the auto-generated method name based on the key (form name) * passed in. */ public String getMethod() { return methodName; }
/** * Sets the method name that will be used for the Javascript * validation method name if it has a value. This overrides * the auto-generated method name based on the key (form name) * passed in. */ public void setMethod(String methodName) { this.methodName = methodName; }
/** * Gets whether or not to generate the static * JavaScript. If this is set to \'true\', which * is the default, the static JavaScript will be generated. */ public String getStaticJavascript() { return staticJavascript; }
/** * Sets whether or not to generate the static * JavaScript. If this is set to \'true\', which * is the default, the static JavaScript will be generated. */ public void setStaticJavascript(String staticJavascript) { this.staticJavascript = staticJavascript; }
/** * Gets whether or not to generate the dynamic * JavaScript. If this is set to \'true\', which * is the default, the dynamic JavaScript will be generated. */ public String getDynamicJavascript() { return dynamicJavascript; }
/** * Sets whether or not to generate the dynamic * JavaScript. If this is set to \'true\', which * is the default, the dynamic JavaScript will be generated. */ public void setDynamicJavascript(String dynamicJavascript) { this.dynamicJavascript = dynamicJavascript; }
/** * Gets whether or not to delimit the * JavaScript with html comments. If this is set to \'true\', which * is the default, the htmlComment will be surround the JavaScript. */ public String getHtmlComment() { return htmlComment; }
/** * Sets whether or not to delimit the * JavaScript with html comments. If this is set to \'true\', which * is the default, the htmlComment will be surround the JavaScript. */ public void setHtmlComment(String htmlComment) { this.htmlComment = htmlComment; }
/** * Gets the src attribute\'s value when defining * the html script element. */ public String getSrc() { return src; }
/** * Sets the src attribute\'s value when defining * the html script element. The src attribute is only recognized * when the formName attribute is specified. */ public void setSrc(String src) { this.src = src; }
/** * Render the JavaScript for to perform validations based on the form name. * * @exception JspException if a JSP exception has occurred */ public int doStartTag() throws JspException {
JspWriter writer = pageContext.getOut(); try { writer.print(this.renderJavascript());
} catch (IOException e) { throw new JspException(e.getMessage()); }
return EVAL_BODY_TAG;
}
/** * Returns fully rendered JavaScript. * @since Struts 1.2 */ protected String renderJavascript() throws JspException { StringBuffer results = new StringBuffer();
ModuleConfig config = TagUtils.getInstance().getModuleConfig(pageContext); ValidatorResources resources = (ValidatorResources) pageContext.getAttribute( ValidatorPlugIn.VALIDATOR_KEY + config.getPrefix(), PageContext.APPLICATION_SCOPE);
Locale locale = TagUtils.getInstance().getUserLocale(this.pageContext, null);
Form form = resources.getForm(locale, formName);
if ("true".equalsIgnoreCase(dynamicJavascript) && form == null) { throw new JspException("No form found under \'" + formName + "\' in locale \'" + locale + "\'"); }
if (form != null) { if ("true".equalsIgnoreCase(dynamicJavascript)) { results.append( this.createDynamicJavascript(config, resources, locale, form));
} else if ("true".equalsIgnoreCase(staticJavascript)) { results.append(this.renderStartElement()); if ("true".equalsIgnoreCase(htmlComment)) { results.append(HTML_BEGIN_COMMENT); } } }
if ("true".equalsIgnoreCase(staticJavascript)) { results.append(getJavascriptStaticMethods(resources)); }
if (form != null && ("true".equalsIgnoreCase(dynamicJavascript) || "true".equalsIgnoreCase(staticJavascript))) {
results.append(getJavascriptEnd()); }
return results.toString(); }
/** * Generates the dynamic JavaScript for the form. * @param config * @param resources * @param locale * @param form */ private String createDynamicJavascript( ModuleConfig config, ValidatorResources resources, Locale locale, Form form) throws JspException {
StringBuffer results = new StringBuffer();
MessageResources messages = (MessageResources) pageContext.getAttribute( bundle + config.getPrefix(), PageContext.APPLICATION_SCOPE); //获取验证 List actions = this.createActionList(resources, form);
final String methods = this.createMethods(actions, this.stopOnError(config));
String formName = form.getName(); jsFormName = formName; if(jsFormName.charAt(0) == \'/\') { String mappingName = TagUtils.getInstance().getActionMappingName(jsFormName); ActionMapping mapping = (ActionMapping) config.findActionConfig(mappingName); if (mapping == null) { JspException e = new JspException(messages.getMessage("formTag.mapping", mappingName)); pageContext.setAttribute(Globals.EXCEPTION_KEY, e, PageContext.REQUEST_SCOPE); throw e; } jsFormName = mapping.getAttribute(); } //验证输出 results.append(this.getJavascriptBegin(methods)); results.append(" { /n"); for (Iterator i = actions.iterator(); i.hasNext();) { ValidatorAction va = (ValidatorAction) i.next(); int jscriptVar = 0; String functionName = null;
if (va.getJsFunctionName() != null && va.getJsFunctionName().length() > 0) { functionName = va.getJsFunctionName(); } else { functionName = va.getName(); }
//输出函数 results.append(" function " + functionName + " () { /n");// results.append(" function " + functionName + " () { /n"); for (Iterator x = form.getFields().iterator(); x.hasNext();) { Field field = (Field) x.next();
// Skip indexed fields for now until there is a good way to handle // error messages (and the length of the list (could retrieve from scope?)) if (field.isIndexed() || field.getPage() != page || !field.isDependency(va.getName())) {
continue; }
String message = Resources.getMessage(messages, locale, va, field);
message = (message != null) ? message : "";
// prefix variable with \'a\' to make it a legal identifier results.append( " this.a" + jscriptVar++ + " = new Array(/"" + field.getKey() + "/", /"" + escapeQuotes(message) + "/", ");
results.append("new Function (/"varName/", /"");
Map vars = field.getVars(); // Loop through the field\'s variables. Iterator varsIterator = vars.keySet().iterator(); while (varsIterator.hasNext()) { String varName = (String) varsIterator.next(); Var var = (Var) vars.get(varName); String varValue = var.getValue(); String jsType = var.getJsType();
// skip requiredif variables field, fieldIndexed, fieldTest, fieldValue if (varName.startsWith("field")) { continue; }
if (Var.JSTYPE_INT.equalsIgnoreCase(jsType)) { results.append( "this." + varName + "=" + ValidatorUtils.replace(varValue, "//", "////") + "; "); } else if (Var.JSTYPE_REGEXP.equalsIgnoreCase(jsType)) { results.append( "this." + varName + "=/" + ValidatorUtils.replace(varValue, "//", "////") + "/; "); } else if (Var.JSTYPE_STRING.equalsIgnoreCase(jsType)) { results.append( "this." + varName + "=\'" + ValidatorUtils.replace(varValue, "//", "////") + "\'; "); // So everyone using the latest format doesn\'t need to change their xml files immediately. } else if ("mask".equalsIgnoreCase(varName)) { results.append( "this." + varName + "=/" + ValidatorUtils.replace(varValue, "//", "////") + "/; "); } else { results.append( "this." + varName + "=\'" + ValidatorUtils.replace(varValue, "//", "////") + "\'; "); } }
results.append(" return this[varName];/"));/n"); } results.append(" } /n/n"); results.append( " " + functionName + "= new " + functionName + "();/n"); } //long 修改 results.append(" var formValidationResult;/n");
results.append(" formValidationResult = " + methods + "; /n"); results.append(" return (formValidationResult == 1);/n }/n ");
results.append(" } /n/n"); return results.toString(); }
private String escapeQuotes(String in) { if (in == null || in.indexOf("/"") == -1) { return in; } StringBuffer buffer = new StringBuffer(); StringTokenizer tokenizer = new StringTokenizer(in, "/"", true);
while (tokenizer.hasMoreTokens()) { String token = tokenizer.nextToken(); if (token.equals("/"")) { buffer.append("//"); } buffer.append(token); }
return buffer.toString(); }
/** * Determines if validations should stop on an error. * @param config The <code>ModuleConfig</code> used to lookup the * stopOnError setting. * @return <code>true</code> if validations should stop on errors. */ private boolean stopOnError(ModuleConfig config) { Object stopOnErrorObj = pageContext.getAttribute( ValidatorPlugIn.STOP_ON_ERROR_KEY + \'.\' + config.getPrefix(), PageContext.APPLICATION_SCOPE);
boolean stopOnError = true;
if (stopOnErrorObj instanceof Boolean) { stopOnError = ((Boolean) stopOnErrorObj).booleanValue(); }
return stopOnError; }
/** * Creates the JavaScript methods list from the given actions. * @param actions A List of ValidatorAction objects. * @param stopOnError If true, behaves like released version of struts 1.1 * and stops after first error. If false, evaluates all validations. * @return JavaScript methods. */ private String createMethods(List actions, boolean stopOnError) { StringBuffer methods = new StringBuffer(); final String methodOperator = stopOnError ? " && " : " & ";
Iterator iter = actions.iterator(); while (iter.hasNext()) { ValidatorAction va = (ValidatorAction) iter.next();
if (methods.length() > 0) { methods.append(methodOperator); } //LONG修改 String strMethod = va.getMethod(); if (va.getJsFunctionName() != null && va.getJsFunctionName().length() > 0) { strMethod = va.getJsFunctionName(); } else { strMethod = va.getName(); }
methods.append(va.getMethod()) .append("(form," + strMethod + ")"); }
return methods.toString(); }
/** * Get List of actions for the given Form. * @param resources * @param form * @return A sorted List of ValidatorAction objects. */ private List createActionList(ValidatorResources resources, Form form) {
List actionMethods = new ArrayList();
Iterator iterator = form.getFields().iterator(); while (iterator.hasNext()) { Field field = (Field) iterator.next();
for (Iterator x = field.getDependencyList().iterator(); x.hasNext();) { Object o = x.next();
if (o != null && !actionMethods.contains(o)) { actionMethods.add(o); } } }
List actions = new ArrayList();
// Create list of ValidatorActions based on actionMethods iterator = actionMethods.iterator(); while (iterator.hasNext()) { String depends = (String) iterator.next(); ValidatorAction va = resources.getValidatorAction(depends);
// throw nicer NPE for easier debugging if (va == null) { throw new NullPointerException( "Depends string /"" + depends + "/" was not found in validator-rules.xml."); }
if (va.getJavascript() != null && va.getJavascript().length() > 0) { actions.add(va); } else { iterator.remove(); } }
Collections.sort(actions, actionComparator);
return actions; }
/** * Release any acquired resources. */ public void release() { super.release(); bundle = Globals.MESSAGES_KEY; formName = null; jsFormName = null; page = 0; methodName = null; staticJavascript = "true"; dynamicJavascript = "true"; htmlComment = "true"; cdata = "true"; src = null; }
/** * Returns the opening script element and some initial javascript. */ protected String getJavascriptBegin(String methods) { StringBuffer sb = new StringBuffer(); String name = jsFormName.replace(\'/\', \'_\'); // remove any \'/\' characters name = jsFormName.substring(0, 1).toUpperCase() + jsFormName.substring(1, jsFormName.length());
sb.append(this.renderStartElement());
if (this.isXhtml() && "true".equalsIgnoreCase(this.cdata)) { sb.append("<![CDATA[/r/n"); }
if (!this.isXhtml() && "true".equals(htmlComment)) { sb.append(HTML_BEGIN_COMMENT); }// sb.append("/n var bCancel = false; /n/n");
if (methodName == null || methodName.length() == 0) { sb.append( " function validate" + name + "(form) { /n"); } else { sb.append( " function " + methodName + "(form) { /n"); } sb.append("/n var bCancel = false; /n/n"); sb.append(" if (bCancel) /n"); sb.append(" return true; /n"); sb.append(" else /n");
// Always return true if there aren\'t any Javascript validation methods if (methods == null || methods.length() == 0) { sb.append(" return true; /n"); } else { //Making Sure that Bitwise operator works: }
// sb.append(" } /n/n");
return sb.toString(); }
protected String getJavascriptStaticMethods(ValidatorResources resources) { StringBuffer sb = new StringBuffer();
sb.append("/n/n");
Iterator actions = resources.getValidatorActions().values().iterator(); while (actions.hasNext()) { ValidatorAction va = (ValidatorAction) actions.next(); if (va != null) { String javascript = va.getJavascript(); if (javascript != null && javascript.length() > 0) { sb.append(javascript + "/n"); } } }
return sb.toString(); }
/** * Returns the closing script element. */ protected String getJavascriptEnd() { StringBuffer sb = new StringBuffer();
sb.append("/n"); if (!this.isXhtml() && "true".equals(htmlComment)){ sb.append(HTML_END_COMMENT); }
if (this.isXhtml() && "true".equalsIgnoreCase(this.cdata)) { sb.append("]]>/r/n"); }
sb.append("</script>/n/n");
return sb.toString(); }
/** * Constructs the beginning <script> element depending on XHTML * status. * @since Struts 1.2 */ protected String renderStartElement() { StringBuffer start = new StringBuffer("<script type=/"text/javascript/"");
// there is no language attribute in XHTML if (!this.isXhtml() && this.scriptLanguage) { start.append(" language=/"Javascript1.1/""); }
if (this.src != null) { start.append(" src=/"" + src + "/""); }
start.append("> /n"); return start.toString(); }
/** * Returns true if this is an xhtml page. */ private boolean isXhtml() { return TagUtils.getInstance().isXhtml(this.pageContext); }
/** * Returns the cdata setting "true" or "false". * @return String - "true" if JavaScript will be hidden in a CDATA section */ public String getCdata() { return cdata; }
/** * Sets the cdata status. * @param cdata The cdata to set */ public void setCdata(String cdata) { this.cdata = cdata; }
/** * Gets whether or not the <script> element will include the * language attribute. * @return true if language attribute will be included. * @since Struts 1.2 */ public boolean getScriptLanguage() { return this.scriptLanguage; }
/** * Sets whether or not the <script> element will include the * language attribute. * @since Struts 1.2 */ public void setScriptLanguage(boolean scriptLanguage) { this.scriptLanguage = scriptLanguage; }
}
客户端如下引用：
<html:javascript1 formName="searchSgbySjForm" dynamicJavascript="true" staticJavascript="false"/>
生成代码如下：
function validateSearchSgbySjForm(form) {
var bCancel = false;
if (bCancel) return true; else { function required () { this.a0 = new Array("sgfssjq", "事故发生时间起 不可为空.", new Function ("varName", "this.datePatternStrict=\'yyy-MM-dd\'; return this[varName];")); this.a1 = new Array("sgfssjz", "事故发生时间止 不可为空.", new Function ("varName", "this.datePatternStrict=\'yyy-MM-dd\'; return this[varName];")); }
required= new required(); function DateValidations () { this.a0 = new Array("sgfssjq", "事故发生时间起 不是有效的日期类型.", new Function ("varName", "this.datePatternStrict=\'yyy-MM-dd\'; return this[varName];")); this.a1 = new Array("sgfssjz", "事故发生时间止 不是有效的日期类型.", new Function ("varName", "this.datePatternStrict=\'yyy-MM-dd\'; return this[varName];")); }
DateValidations= new DateValidations(); var formValidationResult; formValidationResult = validateRequired(form,required) && validateDate(form,DateValidations); return (formValidationResult == 1); } }
可见DateValidations和required作为子函数，所以不会重复。
最后，修改静态js文件，主要增加了传入数组的功能，加入如下:
- 上一篇: EMF－Ecore模型概述
- 下一篇: FreeMarker设计指南(1)
