spring Cache + Redis 開發數據字典以及自定義標簽

一、數據庫表結構

1、  分類表：dict_type

       

2、  子項表：dict_entry

 

二、頁面維護功能示意圖：

1、  分類管理 點擊子項管理進入子項管理頁面

    

2、子項管理

    

三、數據字典添加到緩存：

數據字典為了讀取效率高效，減少與數據庫的交互，通常會把數據字典所有數據添加到緩存當中，如果是一台服務器部署，只需放到本機中就可以，如果需要部署到多台服務器分布式部署的話需要把數據字典同步到Redis服務器中。

1、  springboot 在dictTypeService中把數據字典放到本機緩存中

對數據字典進行增刪改查時需要調用refreshDictCache()方法來刷新緩存，保證緩存中數據為最新數據

2、  如果使用springboot + Redis做緩存的使用的方法，在dictTypeService中把數據字典放到Redis服務器中

@Cacheable(value="dictEntry", key="T(String).valueOf('dictEntryMap')")

使用此注解調用此方法時，系統會先從Redis服務器獲取數據字典，如果取不到數據，系統會再去數據庫讀取。

@CacheEvict(value="dictEntry", key="T(String).valueOf('dictTypeNameMap')")

方法使用此注解，對數據字典進行增刪改查時，系統會自動同步到Redis服務器，保證數據庫數據與redis數據保持一致。

三、把數據字典做成自定義標簽

1、  創建輔助類（自定義標簽調用）

package com.hydwltech.iems.epum.common.utils;

import java.util.ArrayList;
import java.util.List;

import org.apache.commons.lang.StringUtils;

import com.hydwltech.iems.epum.entity.dict.DictEntryOV;
import com.hydwltech.iems.epum.service.dict.DictTypeService;

/**
 * 數據字典工具類
 **/
public class DictUtil {
    private static DictTypeService getDictTypeService() {
        return SpringWebContextUtil.getApplicationContext().getBean(DictTypeService.class);
    }

    /**
     * 根據類型編碼獲取子項列表
     * 
     * @param dictTypeCode 類型編碼
     * @return List<{@link DictEntryOV}}> 子項數據對象
     */
    @SuppressWarnings("unchecked")
    public static List<DictEntryOV> getDictEntryList(String dictTypeCode) {
        return (List<DictEntryOV>) getDictTypeService().getDictEntryMap().get(dictTypeCode);
    }

    /**
     * 根據類型編碼和子項編碼獲得子項名稱
     * 
     * @param dictTypeCode  類型編碼
     * @param dictEntryCode 子項編碼
     * @return String 子項名稱
     */
    public static String getDictEntryName(String dictTypeCode, String dictEntryCode) {
        if (StringUtils.isBlank(dictTypeCode)) {
            return null;
        }
        if (StringUtils.isBlank(dictEntryCode)) {
            return null;
        }
        List<DictEntryOV> ovlist = (List<DictEntryOV>) getDictTypeService().getDictEntryMap().get(dictTypeCode);
        String entryCode = null;
        if (isInteger(dictEntryCode)) {
            List<String> nameMapKeys = new ArrayList<String>();
            for (DictEntryOV dictOv : ovlist) {
                String[] names = dictOv.getDictEntryCode().split(",");
                boolean namesIsInt = true;
                for (int i = 0; i < names.length; i++) {
                    if (!isInteger(names[i])) {
                        namesIsInt = false;
                        break;
                    }
                }
                if (namesIsInt) {
                    nameMapKeys.add(dictOv.getDictEntryCode());
                }
            }

            for (String parm : nameMapKeys) {
                if (parm.split(",").length == 1) {
                    int parm1 = Integer.parseInt(parm.split(",")[0]);
                    if (Integer.parseInt(dictEntryCode) == parm1) {
                        entryCode = parm;
                    }
                } else if (parm.split(",").length == 2) {
                    int parm1 = Integer.parseInt(parm.split(",")[0]);
                    int parm2 = Integer.parseInt(parm.split(",")[1]);
                    if (Integer.parseInt(dictEntryCode) >= parm1 && Integer.parseInt(dictEntryCode) <= parm2) {
                        entryCode = parm;
                    }
                }
            }
        } else {
            entryCode = dictEntryCode;
        }

        String entryName = null;
        if (StringUtils.isNotBlank(entryCode)) {
            for (DictEntryOV dictEntryOV : ovlist) {
                if (entryCode.equals(dictEntryOV.getDictEntryCode())) {
                    entryName = dictEntryOV.getDictEntryName();
                }
            }
        }
        
        return entryName;
    }

    /**
     * 根據類型編碼和子項編碼獲得子項對象
     * 
     * @param dictTypeCode  類型編碼
     * @param dictEntryCode 子項編碼
     * @return DictEntryOV 子項名稱
     */
    public static DictEntryOV getDictEntry(String dictTypeCode, String dictEntryCode) {
        if (StringUtils.isBlank(dictTypeCode)) {
            return null;
        }
        if (StringUtils.isBlank(dictEntryCode)) {
            return null;
        }
        List<DictEntryOV> ovlist = (List<DictEntryOV>) getDictTypeService().getDictEntryMap().get(dictTypeCode);
        DictEntryOV entryOv = null;
        for (DictEntryOV dictEntryOV : ovlist) {
            if (dictEntryCode.equals(dictEntryOV.getDictEntryCode())) {
                entryOv = dictEntryOV;
            }
        }
        return entryOv;
    }

    /**
     * 根據類型編碼和子項編碼獲得子項名稱
     * 
     * @param dictTypeCodeAndEntryCode 類型編碼和子項編碼合成字符串兩個變量已逗號隔開
     * @return String 子項名稱
     */
    public static String getDictEntryNameByCodes(String dictTypeCodeAndEntryCode) {
        if (StringUtils.isBlank(dictTypeCodeAndEntryCode)) {
            return null;
        }
        String[] params = dictTypeCodeAndEntryCode.split(",");
        String dictTypeCode = params[0];
        String dictEntryCode = params[1];
        List<DictEntryOV> ovlist = (List<DictEntryOV>) getDictTypeService().getDictEntryMap().get(dictTypeCode);
        String entryName = null;
        for (DictEntryOV dictEntryOV : ovlist) {
            if (dictEntryCode.equals(dictEntryOV.getDictEntryCode())) {
                entryName = dictEntryOV.getDictEntryName();
            }
        }
        return entryName;
    }

    /**
     * 根據類型編碼獲得類型名稱
     * 
     * @param dictTypeCode 類型編碼
     * @return String 子項名稱
     */
    public static String getDictTypeName(String dictTypeCode) {
        if (StringUtils.isBlank(dictTypeCode)) {
            return null;
        }
        String type = (String) getDictTypeService().getDictTypeNameMap().get(dictTypeCode);
        return type;

    }

    /**
     * 根據類型編碼和子項名稱獲得子項類型編碼
     * 
     * @param dictTypeCode  類型編碼
     * @param dictEntryName 子項名稱
     * @return String 子項編碼
     */
    public static String getDictEntryCodeByEntryName(String dictTypeCode, String dictEntryName) {
        if (StringUtils.isBlank(dictTypeCode)) {
            return null;
        }
        if (StringUtils.isBlank(dictEntryName)) {
            return null;
        }
        List<DictEntryOV> ovlist = (List<DictEntryOV>) getDictTypeService().getDictEntryMap().get(dictTypeCode);
        String entryCode = null;
        for (DictEntryOV ov : ovlist) {
            if (dictEntryName.equals(ov.getDictEntryName())) {
                entryCode = ov.getDictEntryCode();
            }
        }
        return entryCode;
    }

    /** 驗證是否是整數 */
    private static boolean isInteger(String param) {
        try {
            Integer.valueOf(param);
            return true;
        } catch (Exception e) {
            // TODO: handle exception
        }
        return false;
    }
}

2、  自定義JSTL標簽類

   （1）需要定義幾個標簽，就寫幾個獨立的標簽類

  （2）定義標簽類，在頁面輸出下拉菜單數據

package com.hydwltech.iems.epum.common.utils.tag;

import java.util.List;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.TagSupport;

import com.hydwltech.iems.epum.common.utils.DictUtil;
import com.hydwltech.iems.epum.entity.dict.DictEntryOV;

public class ValueDictEntryListUtil extends TagSupport{

    /**
     * 
     */
    private static final long serialVersionUID = 1L;
    
    private String var;

    @Override
    public int doStartTag() throws JspException {
        try {
            StringBuffer strBuffer = new StringBuffer();
            List<DictEntryOV> ovList = DictUtil.getDictEntryList(var);
            for (int i = 0; i < ovList.size(); i++) {
                strBuffer.append("<li>");
                strBuffer.append("<a href=\"###\" value="+ovList.get(i).getDictEntryCode()+">" + ovList.get(i).getDictEntryName() + "</a>");
                strBuffer.append("</li>");
            }
            pageContext.getOut().print(strBuffer.toString());
        } catch (Exception e) {
            // TODO: handle exception
        }
        return EVAL_BODY_INCLUDE;
    }
    

    public String getVar() {
        return var;
    }

    public void setVar(String var) {
        this.var = var;
    }
}

（3）、創建tld文件

      在WEB-INF下創建tld文件 dict.tld

<?xml version="1.0" encoding="UTF-8"?>  
<!DOCTYPE taglib PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN"    
    "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">
<taglib>
    <tlib-version>1.0</tlib-version><!-- 標簽庫版本 -->
    <jsp-version>1.2</jsp-version>  <!-- 標簽庫要求的JSP規范版本 -->
    <short-name>dict</short-name>   <!-- JSP頁面編寫工具可以用來創建助記名的可選名字 -->
    <!-- 
         為自定義標簽庫設置一個uri，uri以/開頭，/后面的內容隨便寫，如這里的/gacl ，
         在Jsp頁面中引用標簽庫時，需要通過uri找到標簽庫
         在Jsp頁面中就要這樣引入標簽庫：
         <%@taglib uri="/security/encrypt" prefix="encrypt"%>
     -->
    <!-- <uri>/security/encrypt</uri> -->
    <tag>
        <name>entry</name>
        <tag-class>com.hydwltech.iems.epum.common.utils.tag.ValueDictEntryNameUtil</tag-class>
        <body-content>JSP</body-content>
        <attribute>
            <name>typeCode</name>
            <rtexprvalue>true</rtexprvalue>
        </attribute>
        <attribute>
            <name>entryCode</name>
            <rtexprvalue>true</rtexprvalue>
        </attribute>
    </tag>
    
    <tag>
        <name>type</name>
        <tag-class>com.hydwltech.iems.epum.common.utils.tag.ValueDictTypeNameUtil</tag-class>
        <body-content>JSP</body-content>
        <attribute>
            <name>var</name>
            <rtexprvalue>true</rtexprvalue>
        </attribute>
    </tag>
    
    <tag>
        <name>select</name>
        <tag-class>com.hydwltech.iems.epum.common.utils.tag.ValueDictEntryListUtil</tag-class>
        <body-content>JSP</body-content>
        <attribute>
            <name>var</name>
            <rtexprvalue>true</rtexprvalue>
        </attribute>
    </tag>
</taglib>  

（4）、JSP頁面調用標簽

      A、導入自定義標簽

       <%@ taglib prefix="dict" uri="/WEB-INF/tag/dict.tld"%>

      

    B、下拉菜單調用此標簽

       <dict:select var="equipEablePatrol"/>

 

效果如下圖：

除了下拉菜單標簽，還可以根據自己的需求開發其他自定義標簽。

四、相關技術鏈接

      關於自定義標簽轉自：https://blog.csdn.net/bilahepan/article/details/54801540

      關於Springboot  + cacheable + Redis轉自：https://blog.csdn.net/moshowgame/article/details/80792774