velocity中使用枚举

版权声明：本文为博主原创文章，转载请注明出处，欢迎使劲喷

一、为什么要在velocity中使用枚举

1.目前接触到的系统，枚举通常用来在程序中定义数据字典。

举个支付的例子，比如一个字段用来标识一条记录的状态，如下：

010000　　微信支付

010001　　支付宝支付

010002　　银联支付

我们在程序中需要用这些定义的字典去做相应的处理，比如微信支付时，我们调用微信支付的逻辑，等等。

2.当涉及与前端的交互时，我们可能需要从前端把三种支付方式对应的code值传到后台。此时，如果在页面上直接写010000这样的值，那么页面的逻辑就很不直观了，今天写的时候你还能认知，为了防止自己忘了，除了加注释别无办法。

为了解决后台可用，且前端页面直观，所以我们希望尝试在页面上直接用枚举来解决问题。

3.当然，这种方式同时可以使我们摆脱巨长的constants类，需要哪个枚举就直接获取哪个枚举，直观方便。

二、实现

1.先看页面如何处理（velocity页面中）

#set($payment=$enumTool.getInstance("Payment"))//直接写明要获取的枚举类型名称
#if($payment.get("Payment_WX") == $param.code)//通过枚举值获取其code值
    //做微信支付页面逻辑
#end

后台中使用到枚举的地方如下

if(param.equals(Payment.Payment_WX.getCode())){//直接使用枚举值做逻辑判断
         //微信逻辑处理
}

2.实现

2.1枚举的定义

/**
 * Created by Bright on 2017/3/13.
 *
 * @author :
 */
public enum Payment {
    Payment_WX("010000","微信支付"),
    Payment_ZFB("010001","支付宝支付"),
    Payment_YL("010002","银联支付");

    public static Map<String,String> map = new HashMap<String, String>();

    static{
        Payment[] values = Payment.values();
        if(values.length > 0){
            for(Payment product : values){
                map.put(product.getCode(),product.getName());
            }
        }
    }

    Payment(String code, String name){
        this.code = code;
        this.name = name;
    }

    private String code;

    private String name;

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

2.2VelocityEnumTools的实现

/**
 * Created by Bright on 2017/3/13.
 *
 * @author :
 */
public class VelocityEnumTools {

    public static final Logger logger = LoggerFactory.getLogger(VelocityEnumTools.class);

    public static Map<String, Map<String, String>> map = new HashMap<String, Map<String, String>>();

    /**
     * 需要在页面控制的enum，如Payment类似添加即可
     */
    static {
        map.put(Payment.class.getSimpleName(), getEnumMap(Payment.class));
    }

    public static Map<String, String> getInstance(String enumKey) {
        return map.get(enumKey);
    }

    public static <T> Map<String, String> getEnumMap(Class<T> clazz) {

        Map<String, String> map = new HashMap<String, String>();
        try {
            if (clazz.isEnum()) {
                Object[] enumConstants = clazz.getEnumConstants();
                for (int i = 0; i < enumConstants.length; i++) {
                    T t = (T) enumConstants[i];
                    Field code = t.getClass().getDeclaredField("code");
                    code.setAccessible(true);
                    map.put(t.getClass().getDeclaredFields()[i].getName(), (String) code.get(t));
                }
            }
        } catch (NoSuchFieldException e) {
            logger.error("枚举工具启动报错：{}", e);
        } catch (IllegalAccessException e) {
            logger.error("枚举工具启动报错：{}", e);
        }
        return map;
    }

}

2.3velocity-tools配置

<?xml version="1.0" encoding="UTF-8"?>
<toolbox>
    <tool>
        <key>enumTool</key>
        <class>com.bright.core.enumconstant.VelocityEnumTools</class>
    </tool>
    <tool>
        <key>stringTool</key>
        <class>org.apache.commons.lang.StringUtils</class>
    </tool>
    <tool>
        <key>dateTool</key>
        <class>org.apache.velocity.tools.generic.DateTool</class>
    </tool>
</toolbox>