數據庫表結構文檔自動生成工具


1.需求描述:

      軟件開發完成后,交付客戶給客戶使用前通常需要數據庫設計文檔,很多程序員甚至項目經理自然會想到采用人海戰術,一個項目組的成員,分模塊來寫,然后合並。作為程序員來說,這種方法是在是太low了。那么能否有自動化工具呢,當然有,用度娘搜索“數據庫文檔生成器”會出來很多個,他們的質量也會參差不齊,要么格式不滿足公司文檔格式需要。所以該問題的終極解決方案是理解數據庫文檔生成器的原理,然后自己動手實現一個,聽起來是不是很難,其實現起來難度並不大,無圖無真相,先上圖。

 

 

    

 

2.技術點解析:

上面生成的效果圖是不是很酷,現在我們就在一步一步解析是怎么生成的。

所需工具

作用

Microsot office

用於生成word文檔模板

開發語言

java

Freemarker

Java 模板語言

jdbc

利用jdbc獲取表的定義

 

 

這個問題可以拆分為:

  1. Word 文檔模板:普通的doc、docx都是二進制文件,操作起來比較麻煩,那么我們可以采用變通的方式,用word 的xml格式。

 

 

另存一個看看,xml格式的doc長啥樣:

 

 

 

天書一樣的xml,是不是是不是很崩潰,其實你沒必要完全看懂,看懂結構,找出你關心的部分即可,如果不會可以來回多試幾次。

 

  1. 表結構元數據:

 

 

寫java的同學,應該知道這是什么了,可能你沒用過,但他就是存在。

 

  1. 將模板和元數據合並生成我們需要的文檔。

從模板xml中找出需要循環的部分,加上foreach標簽:

 

 OK,現在數據有了,模板有了,問題就解決了。

3.代碼實現:

1.獲取表結構列表:

 

2.根據模板生成doc文件

 

 

4.后記:

利用模板+數據的思路,可以生產任何格式復雜格式的文檔,如生成“***報告單.doc”等,並且可以降低開發難度,提高開發速度。

 

Java開發、互聯網架構討論QQ群: 297702426

微信:kevinzhang7234   郵箱:zfj321@qq.com   需要源碼可以聯系我,或者加入以上QQ群

 

更詳細的 講解過程: http://skycity.today/?thread-34.htm   ,及代碼下載。 

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM