SPA数据管理工具的设计

       事先声明，这篇设计也是因为编辑时间较长，被JAVAEYE给拦截了。这个是实现后的设计文档。

       背景：
       SPA以及相关基础数据导出是产品的一个附加功能组件，能够将系统的SPA以及相关数据导入导出到安装在其它平台上，实现SPA的导入导出。
      
       解决问题：
      
        主要有两个：
       1.    数据库中数据的导入导出。
       由于SPA的数据导出到新数据库的时候，原来的数据即时存在的话，也要进行删除，因此，就是直接的数据导入导出的问题。

       2.  和数据库相关文件的导入导出问题。
       由于SPA中有很多表和很多文件相关联，那么一项处理要求就是将SPA相关联的文件备份出来，然后导入到对应系统的相应目录下。由于不需要保留目标平台的数据，因此，这方面的处理就简单了，直接将系统文件备份出来，覆盖到目标目录就可以了。
不牵涉到改变文件名的问题。

       总体来讲，要解决的问题和之前的预想相比，要简单了很多。   

       设计方案：
       1.  hibernate ＋dom4jSession + XML + XPATH＋ANT来完成数据库的备份。将数据库的数据通过Hibernate的配置文件，转换为XML的实体，存储在XML文件中。
      

xml 代码

 

1. <class  
2.         name="Baseline"  
3.         table="baseline"  
4.         node = "Baseline"  
5.     >  
6.         <id  
7.             name="Id"  
8.             type="integer"  
9.             column="ID"  
10.             node = "@Id"  
11.         >  
12.             <generator class="org.hibernate.id.IncrementGenerator"/>  
13.         id>  
14.   
15.         <property  
16.             name="UserMetricsId"  
17.             column="USER_METRICS_ID"  
18.             type="integer"  
19.             not-null="false"  
20.             node = "UserMetricsId"  
21.             length="11"  
22.         />  
23. ……  

        在隐射文件里面，通过配置node节点，定义这个实体对应的xml文件应该是什么样的。我这里的定义很简单。dingy定义类为node="BaseLine"元素，id定义为@Id属性，属性也转换为下级的元素节点。
        在xml中，就是

xml 代码

 

1. <BaseLine Id="">  
2.    <UserMetricsId>8UserMetricsId>  
3. BaseLine>  

        在Hibernate中，将实体转换为实体，比较方便，主要的操作是取得Session的时候，用EntityMode.DOM4J的方式去取得。返回得到Element列表，怎么将Element组装成Document就不用多讲了。
     

java 代码

1.  session = sessionFactory.openSession();    
2. dom4jSession = session.getSession(EntityMode.DOM4J);   
3. dom4jSession.createQuery(xpath).list();  

   
    在导入回去的时候，相当好办。

java 代码

1. dom4jSession.replicate(className, node,ReplicationMode.OVERWRITE);  

       这是将该node更新回数据库，更新方式是覆盖已有的数据，如果存在的话:)
什么叫覆盖已有？就是数据库ID相同的记录，直接覆盖就OK了。

    2. 文件的导入导出
   
    将xml文件压缩为一个文件，其它的各类文件分别也压缩为多个文件，然后统一添加到一个大的压缩文件中。导出的步骤相反。分为两步：
    a.  需要借助Ant的Zip和Expand API。
   

java 代码。

 

1. private void zipFiles(File destFile, String dataPath, List includeFiles) {  
2.         Project project = new Project();  
3.         Zip zip = new Zip();  
4.         zip.setProject(project);  
5.         zip.setTaskName("default");  
6.         zip.setDestFile(destFile);  
7.         FileSet fs = new FileSet();  
8.         fs.setDir(new File(dataPath));  
9.         if(includeFiles!=null && includeFiles.size()>0){  
10.             for (Iterator iter = includeFiles.iterator(); iter.hasNext();) {  
11.                 String element = (String) iter.next();  
12.                 fs.setIncludes(element);  
13.             }  
14.         }          
15.         zip.addFileset(fs);  
16.         zip.setCompress(true);  
17.         zip.setEncoding("GBK");  
18.         zip.execute();  
19. }  

  

java 代码

 

1. /** 
2.  * 将源文件unzip到目的文件，覆盖安装。
   
3.  * @param srcFile    
4.  * @param destFile 
5.  */  
6. public void unzipFile(File srcFile, File destFile){  
7.     Project project = new Project();  
8.        Expand expand = new Expand();  
9.        expand.setProject(project);  
10.        expand.setSrc(srcFile);  
11.        expand.setEncoding("GBK");  
12.        expand.setOverwrite(true);  
13.        expand.setDest(destFile);  
14.        expand.execute();  
15. }  

    b.  在压缩文件中添加Entry，以及解析Entry，需要用到JAVA提供的文件压缩API。
     

java 代码

 

1.     
   
2. public void compressFile(File file,String entryName) throws IOException{  
3.         zos.putNextEntry(new ZipEntry(entryName));        
4.         BufferedInputStream bis=new BufferedInputStream(new FileInputStream(file));  
5.         int n = 0;  
6.         while (n != -1) {  
7.             n = bis.read();  
8.             if (n != -1) {  
9.                 zos.write(n);  
10.                 }  
11.             }  
12.         bis.close();  
13.         zos.closeEntry();  
14.     }  

    这个名字其实起得不好。compressFile也是压缩之意，这里的意思是将file添加到Zip的一个入口。

    相应的，unCompressFile方法是：
   

java 代码

 

1. public void unCompress(ZipFile zipFile, String entryName, File destFile) throws IOException{  
2.     ZipEntry ze = zipFile.getEntry(entryName);  
3.     if(ze!=null){  
4.          BufferedInputStream bis = new BufferedInputStream(zipFile.getInputStream(ze));  
5.             BufferedOutputStream bos = new BufferedOutputStream(new FileOutputStream(destFile));  
6.             int n = 0;  
7.             while (n != -1) {  
8.                 n = bis.read();  
9.                 if (n != -1) {  
10.                     bos.write(n);  
11.                 }  
12.             }  
13.             bos.close();  
14.             bis.close();  
15.     }  
16. }  

    后记：该程序是在前人程序的基础上开发的，据说是之前的牛人写的程序。即便这样，要理解别人的程序还是很难的。特别象我这样，想要理解程序的来龙去脉的时候，更显得艰难。我在不停的Refactor中前行，才能摸清楚程序的意思。
       只有维护的时候，才想到如果有一份需求和设计文档就好了。这个完全不是设计文档，也不是程序的流程。思之，想之……