使用Java程序生成Mysql數據庫說明文檔

一. 引入依賴

<dependency>
    <groupId>com.lowagie</groupId>
    <artifactId>itext</artifactId>
    <version>2.1.7</version>
</dependency>

<dependency>
    <groupId>com.lowagie</groupId>
    <artifactId>itext-rtf</artifactId>
    <version>2.1.7</version>
</dependency>

二. 生成說明文檔

package dispatch.service;
import java.awt.Color;
import java.io.FileOutputStream;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import com.lowagie.text.Cell;
import com.lowagie.text.Document;
import com.lowagie.text.PageSize;
import com.lowagie.text.Paragraph;
import com.lowagie.text.Table;
import com.lowagie.text.rtf.RtfWriter2;
/**
 * 數據字典生成器 Mysql
 *
 */
public class Test {
    //鍵類型字典
    private static Map<String,String> keyType = new HashMap<String,String>();
    //初始化jdbc
    static{
        try {
            keyType.put("PRI", "主鍵");
            keyType.put("UNI", "唯一鍵");
            Class.forName("com.mysql.jdbc.Driver");
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
    }
    private static String url = "jdbc:mysql://127.0.0.1:3306/schema_name?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&allowMultiQueries=true&useSSL=true&verifyServerCertificate=false";//鏈接url
    private static String username = "xxx"; //用戶名
    private static String password = "xxx"; //密碼
    private static String schema = "schema_name"; //目標數據庫 名
    //查詢所有表的sql語句
    private static String sql_get_all_tables = "select table_name,TABLE_COMMENT from INFORMATION_SCHEMA.tables where TABLE_SCHEMA='"+schema+"' and TABLE_TYPE='BASE TABLE'";
    //查詢所有字段的sql語句
    private static String sql_get_all_columns = "select column_name,data_type,character_octet_length,COLUMN_COMMENT,is_nullable,COLUMN_key from information_schema.`COLUMNS` where TABLE_NAME='{table_name}' and TABLE_SCHEMA='"+schema+"'";
    public static void main(String[] args) throws Exception {
        //初始化word文檔
        Document document = new Document(PageSize.A4);
        RtfWriter2.getInstance(document,new FileOutputStream("/Users/xxx/work/word.doc"));
        document.open();
        //查詢開始
        Connection conn = getConnection();
        //獲取所有表
        List tables = getDataBySQL(sql_get_all_tables,conn);
        int i=1;
        for (Iterator iterator = tables.iterator(); iterator.hasNext();) {
            String [] arr = (String []) iterator.next();
            //循環獲取字段信息
            System.out.print(i+".正在處理數據表-----------"+arr[0]);
            addTableMetaData(document,arr,i);
            List columns = getDataBySQL(sql_get_all_columns.replace("{table_name}", arr[0]),conn);
            addTableDetail(document,columns);
            addBlank(document);
            System.out.println("...done");
            i++;
        }
        document.close();
        conn.close();
    }
    /**
     * 添加一個空行
     * @param document
     * @throws Exception
     */
    public static void addBlank(Document document)throws Exception{
        Paragraph ph = new Paragraph("");
        ph.setAlignment(Paragraph.ALIGN_LEFT);
        document.add(ph);
    }
    /**
     * 添加包含字段詳細信息的表格
     * @param document
     * @param arr1
     * @param columns
     * @throws Exception
     */
    public static void addTableDetail(Document document,List columns)throws Exception{
        Table table = new Table(6);
        table.setWidth(100f);//表格 寬度100%
        table.setBorderWidth(1);
        table.setBorderColor(Color.BLACK);
        table.setPadding(0);
        table.setSpacing(0);
        Cell cell1 = new Cell("序號");// 單元格
        cell1.setHeader(true);

        Cell cell2 = new Cell("列名");// 單元格
        cell2.setHeader(true);

        Cell cell3 = new Cell("類型");// 單元格
        cell3.setHeader(true);

        Cell cell4 = new Cell("長度");// 單元格
        cell4.setHeader(true);

        Cell cell5 = new Cell("鍵");// 單元格
        cell5.setHeader(true);

        Cell cell6 = new Cell("說明");// 單元格
        cell6.setHeader(true);
        //設置表頭格式
        table.setWidths(new float[]{8f,30f,15f,8f,10f,29f});
        cell1.setHorizontalAlignment(Cell.ALIGN_CENTER);
        cell1.setBackgroundColor(Color.gray);
        cell2.setHorizontalAlignment(Cell.ALIGN_CENTER);
        cell2.setBackgroundColor(Color.gray);
        cell3.setHorizontalAlignment(Cell.ALIGN_CENTER);
        cell3.setBackgroundColor(Color.gray);
        cell4.setHorizontalAlignment(Cell.ALIGN_CENTER);
        cell4.setBackgroundColor(Color.gray);
        cell5.setHorizontalAlignment(Cell.ALIGN_CENTER);
        cell5.setBackgroundColor(Color.gray);
        cell6.setHorizontalAlignment(Cell.ALIGN_CENTER);
        cell6.setBackgroundColor(Color.gray);
        table.addCell(cell1);
        table.addCell(cell2);
        table.addCell(cell3);
        table.addCell(cell4);
        table.addCell(cell5);
        table.addCell(cell6);
        table.endHeaders();// 表頭結束
        int x = 1;
        for (Iterator iterator = columns.iterator(); iterator.hasNext();) {
            String [] arr2 = (String []) iterator.next();
            Cell c1 = new Cell(x+"");
            Cell c2 = new Cell(arr2[0]);
            Cell c3 = new Cell(arr2[1]);
            Cell c4 = new Cell(arr2[2]);

            String key = keyType.get(arr2[5]);
            if(key==null)key = "";
            Cell c5 = new Cell(key);
            Cell c6 = new Cell(arr2[3]);
            c1.setHorizontalAlignment(Cell.ALIGN_CENTER);
            c2.setHorizontalAlignment(Cell.ALIGN_CENTER);
            c3.setHorizontalAlignment(Cell.ALIGN_CENTER);
            c4.setHorizontalAlignment(Cell.ALIGN_CENTER);
            c5.setHorizontalAlignment(Cell.ALIGN_CENTER);
            c6.setHorizontalAlignment(Cell.ALIGN_CENTER);
            table.addCell(c1);
            table.addCell(c2);
            table.addCell(c3);
            table.addCell(c4);
            table.addCell(c5);
            table.addCell(c6);
            x++;
        }
        document.add(table);
    }
    /**
     * 增加表概要信息
     * @param dcument
     * @param arr
     * @param i
     * @throws Exception
     */
    public static void addTableMetaData(Document dcument,String [] arr,int i) throws Exception{
        Paragraph ph = new Paragraph(i+". 表名: "+arr[0]+"        說明: "+(arr[1]==null?"":arr[1]));
        ph.setAlignment(Paragraph.ALIGN_LEFT);
        dcument.add(ph);
    }
    /**
     * 把SQL語句查詢出列表
     * @param sql
     * @param conn
     * @return
     */
    public static List getDataBySQL(String sql,Connection conn){
        Statement stmt = null;
        ResultSet rs = null;
        List list = new ArrayList();
        try {
            stmt = conn.createStatement();
            rs = stmt.executeQuery(sql);
            while(rs.next()){
                String [] arr = new String[rs.getMetaData().getColumnCount()];
                for(int i=0;i<arr.length;i++){
                    arr[i] = rs.getString(i+1);
                }
                list.add(arr);
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }finally{
            try {
                if(rs!=null)rs.close();
                if(stmt!=null)stmt.close();
            } catch (SQLException e) {
                e.printStackTrace();
            }
        }
        return list;
    }
    /**
     * 獲取數據庫連接
     * @return
     */
    public static Connection getConnection(){
        try {
            return DriverManager.getConnection(url, username, password);
        } catch (SQLException e) {
            e.printStackTrace();
        }
        return null;
    }
}

三. 文檔效果