J2EE项目数据字典设计

欢迎转载，转载请注明出处http://blog.csdn.net/wklken/archive/2011/05/07/6402557.aspx 

 

这里的数据字典并非是数据库的数据字典，而是在项目编码过程中涉及到一些类似字典查询的操作。

 

 

 

需求：

     在项目开发中，一些变量需要在多个地方使用，但这些变量的值是在某一范围内，且每一个值对应一个翻译的字面量。

Ø  若是使用数据库存储，因为变量值是固定的，多余的数据库访问没有必要；

Ø  若是直接硬编码到代码中，若是需要进行修改的时候，造成维护困难；

Ø  若是以常量方式书写到类中并在使用时引用，你将发现你的常量类Constants里面内容庞杂，命名和使用都极其困难。

 

常见此类键值对：

     1.省代码表，省编码对应一个描述信息

          2.XX类型，例如操作类型，包装类型

 

这类键值对特点：在库中存储的是数字或字母编码，但在展示的时候使用的却是其翻译

 

处理方式：

1.       将键值对内容书写到XML文件中；

2.       系统启动时读取加载入内存；

3.       使用时直接调用翻译。

 

 XML文档结构设计:【dtd晚点补上，一些细节优点模糊了】

<?xml version="1.0"  encoding="UTF-8" ?>
<dics>
    <table id="BUSSINESS">
        <field id="TYPE">
            <row>
                <value><!--[CDATA[01]]></value>
                <desc><![CDATA[空运进口]]></desc>
            </row>
            <row>
                <value><![CDATA[02]]></value>
                <desc><![CDATA[空运出口]]></desc>
            </row>
        </field>
        <field id="AB">
            <row>
                <value><![CDATA[1]]></value>
                <desc><![CDATA[进口]]></desc>
            </row>
            <row>
                <value><![CDATA[2]]></value>
                <desc><![CDATA[出口]]></desc>
            </row>
        </field>
    </table>
    <table id="TRADE">
        <field id="TYPE">
            <row>
                <value><![CDATA[11]]></value>
                <desc><![CDATA[一般贸易]]></desc>
            </row>
            <row>
                <value><![CDATA[12]]></value>
                <desc><![CDATA[易货贸易]]--></desc>
            </row>
            
        </field>
    </table>
    
</dics>

 

然后是在内存中存储形式:

数据结构

使用LinkedHashMap【你有可能需要将其按序展现在下拉列表中】

LinkedHashMap<String,LinkedHashMap<String,LinkedHashMap<String,String> > > sysDic;

 

囧，是不是有点混乱，画个图吧

 

 

 

然后，在系统加载的时候读入内存

 

根据个人偏好吧，可以使用JDK自带的，或者JDOM，个人偏好Dom4j

使用Dom4j，然后根据xpath进行节点选取，代码少，并且简介

 

以下是逐层读取的函数代码

/**
     * 初始化数据字典
     */
    public static void initSysDic() {
        try {
            SAXReader reader = new SAXReader();
            Document document = reader.read(new File(
                    "src/main/resources/system/sysDic.xml"));

            LinkedHashMap<String, LinkedHashMap<String, LinkedHashMap<String, String>>> sysDic = buildSysDic(document);

            SysDicUtil.setSysDic(sysDic);

        } catch (Exception e) {
            e.printStackTrace();
        }
    }


@SuppressWarnings("unchecked")
    public static LinkedHashMap<String, LinkedHashMap<String, LinkedHashMap<String, String>>> buildSysDic(Document document) {
        String xpath = "dics/table";

        
        List<Node> tables = document.selectNodes(xpath);

        return handleTables(tables);
    }

/**
     * 处理一组table
     * 
     * @param tables
     * @return
     */
    
    private static LinkedHashMap<String, LinkedHashMap<String, LinkedHashMap<String, String>>> handleTables(
            List<Node> tables) {
        LinkedHashMap<String, LinkedHashMap<String, LinkedHashMap<String, String>>> tableMap = new LinkedHashMap<String, LinkedHashMap<String, LinkedHashMap<String, String>>>();

        Node table = null;
        String id = null;
        LinkedHashMap<String, LinkedHashMap<String, String>> field = null;
        for (int i = 0, len = tables.size(); i < len; i++) {
            table = tables.get(i);

            id = table.selectSingleNode("@id").getText();
            System.out.println(id);
            
            field = handleFields(table.selectNodes("field"));

            tableMap.put(id, field);
        }
        return tableMap;
    }


/**
     * 处理一组field
     * 
     * @param fields
     * @return
     */
    private static LinkedHashMap<String, LinkedHashMap<String, String>> handleFields(
            List<Node> fields) {
        LinkedHashMap<String, LinkedHashMap<String, String>> fieldMap = new LinkedHashMap<String, LinkedHashMap<String, String>>();

        Node field = null;
        String id = null;
        LinkedHashMap<String, String> row = null;
        for (int i = 0, len = fields.size(); i < len; i++) {
            field = fields.get(i);

            id = field.selectSingleNode("@id").getText();
            System.out.println(id);
            row = handleRows(field.selectNodes("row"));

            fieldMap.put(id, row);

        }

        return fieldMap;
    }


/**
     * 处理一组row
     * 
     * @param rows
     * @return
     */
    private static LinkedHashMap<String, String> handleRows(List<Node> rows) {
        LinkedHashMap<String, String> rowMap = new LinkedHashMap<String, String>();

        Node row = null;
        String key = null;
        String value = null;
        for (int i = 0, len = rows.size(); i < len; i++) {
            row = rows.get(i);

            key = row.selectSingleNode("value").getText();
            value = row.selectSingleNode("desc").getText();
            rowMap.put(key, value);

            System.out.println(key + "  " + value);
        }

        return rowMap;
    }

 

最后，是获取及使用

import java.util.LinkedHashMap;
/**
 * 数据字典工具类，获取数据字典相关信息
 * @author ken
 *
 */
public class SysDicUtil {

    private static LinkedHashMap<String,LinkedHashMap<String,LinkedHashMap<String,String> > > sysDic;
    
    private SysDicUtil() {
        // TODO Auto-generated constructor stub
    }
    
    public static void setSysDic(LinkedHashMap<String,LinkedHashMap<String,LinkedHashMap<String,String>> > aSysDic)
    {
        sysDic = aSysDic;
    }
    
    /**
     * 获取某一数据字典所有 值-描述 
     * @param tableName
     * @param fieldName
     * @return
     */
    public static LinkedHashMap<String,String> getAllFields(String tableName,String fieldName)
    {
        
        if(sysDic.containsKey(tableName))
        {
            LinkedHashMap<String,LinkedHashMap<String,String> > subDic = sysDic.get(tableName);
            
            if(subDic.containsKey(fieldName))
            {
                return subDic.get(fieldName);
            }else{
                return null;
            }
        }else{
            return null;
        }
    }
    /**
     * 获取某个数据字典某个域 值对应的描述
     * @param tableName
     * @param fieldName
     * @param value
     * @return
     */
    public static String getFieldDesc(String tableName,String fieldName,String value)
    {
        if(sysDic.containsKey(tableName))
        {
            if(sysDic.get(tableName).containsKey(fieldName))
            {
                return sysDic.get(tableName).get(fieldName).get(value);
            }else{
                return value;
            }
            
            
        }else{
            return value;
        }
    }    
}

 

使用:

获取单个值对应描述:SysDicUtil.getFieldDesc("OP", "TYPE", 值)

【其实这里方法可以加个重载的，参数("A.B",值)】

获取一整个列表:SysDicUtil.getAllFields("OP", "TYPE")