JSP(JSTL)中使用常量防止硬编码

来源：互联网发布：李鸿章知乎编辑：程序博客网时间：2024/05/21 18:14

this.state="01";通常的做法是写一个类（接口）来存放常量
public interface MyConstant
{
public static final String STATE_01= "01";
}

然后在程序中这样写就可以了
this.state=MyConstant.STATE_01;

在Java程序中这样就可以避免硬编码了。可是JSP中呢？当然，如果JSP中允许使用Scriplet的话当然也可以直接使用常量了，不过现在JSP中一般不允许出现<%%>这样的代码，比如在JSTL中怎么办呢？

<c:if test=${state=='01'}>

</c:if>

这样又出现了'01'这样的硬编码了，该如何使用常量类中的变量呢?

下面介绍用JspTag的方式来处理：

首先在/WEB-INF/tags/下建立my-tag.tld描述文件：

<?xml version="1.0" encoding="UTF-8" ?>
<taglib xmlns="http://java.sun.com/xml/ns/j2ee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd"
version="2.0">
    <description>my tag</description>
    <display-name>my tag</display-name>
    <tlib-version>1.0</tlib-version>
    <short-name>my-tag</short-name>
    <uri>/my-tag</uri>

<tag>
    
        <description>MyConstant常量</description>
        <name>MyConstant</name>
        <tag-class>com.test.util.tag.MyConstantTag</tag-class>
        <body-content>JSP</body-content>
        <attribute>
            <description>必填参数var：指定初始化MyConstant中某个变量，为空则报异常</description>
            <name>var</name>
            <required>true</required>
            <rtexprvalue>true</rtexprvalue>
         </attribute>
        <attribute>
            <description>变量作用范围(默认为page)</description>
            <name>scope</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
         </attribute>

</tag>

</taglib>

还要在web.xml中配置<jsp-config/>：

<jsp-config>

</jsp-config>

JSP中：

头部引入：<my-tag:MyConstant var="STATE_01"/>

用${STATE_01}便可使用常量

之前的情况就可以像如下方式一样使用java的常量：

<c:if test=${state==STATE_01}>

</c:if>

当然最重要的还是com.test.util.tag.MyConstantTag，它继承了TagSupport并重写doStartTag()方法，才使得JSP中可以直接使用java中的常量：

关于这个类，还是大家自己体会吧，用的时候复制就可以了。

public class MyConstantTag extends TagSupport {
    private static final long serialVersionUID = 3258417209566116146L;
    private final Log log = LogFactory.getLog(MyConstantTag.class);
    public String clazz = MyConstant.class.getName();
    protected String scope = null;
    protected String var = null;

    public int doStartTag() throws JspException {
        Class c = null;
        int toScope = PageContext.PAGE_SCOPE;
        if (scope != null) {
            toScope = getScope(scope);
        }
        try {
            c = Class.forName(clazz);
        } catch (ClassNotFoundException cnf) {
           log.error("ClassNotFound - maybe a typo?");
            throw new JspException(cnf.getMessage());
        }

       try {
            if (var == null || var.length() == 0) {
                throw new JspException("常量参数var必须填写！");
            } else {
                try {
                    Object value = c.getField(var).get(this);
                    pageContext.setAttribute(c.getField(var).getName(), value, toScope);
                } catch (NoSuchFieldException nsf) {
                    log.error(nsf.getMessage());
                    throw new JspException(nsf);
                }
            }
         } catch (IllegalAccessException iae) {
            log.error("Illegal Access Exception - maybe a classloader issue?");
            throw new JspException(iae);
        }
     return (SKIP_BODY);
}
/**
* @jsp.attribute
*/
    public void setScope(String scope) {
        this.scope = scope;
    }

    public String getScope() {
        return (this.scope);
    }

/**
* @jsp.attribute
*/
    public void setVar(String var) {
        this.var = var;
     }

    public String getVar() {
        return (this.var);
    }

/**
* Release all allocated resources.
*/
    public void release() {
        super.release();
        clazz = null;
        scope = MyConstant.class.getName();
    }

    private static final Map scopes = new HashMap();
        static {
            scopes.put("page", new Integer(PageContext.PAGE_SCOPE));
            scopes.put("request", new Integer(PageContext.REQUEST_SCOPE));
            scopes.put("session", new Integer(PageContext.SESSION_SCOPE));
            scopes.put("application", new Integer(PageContext.APPLICATION_SCOPE));
        }
        public int getScope(String scopeName) throws JspException {
            Integer scope = (Integer) scopes.get(scopeName.toLowerCase());

        if (scope == null) {
            throw new JspException("Scope '" + scopeName + "' not a valid option");
        }

return scope.intValue();
}
}