mysql数据库表结构文档自动生成工具

1.首先创建项目结构

 

2.web.xml配置

<?xml version="1.0" encoding="UTF-8"?>

<web-app
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://java.sun.com/xml/ns/javaee" version="3.0">
    <error-page>
        <error-code>404</error-code>
        <location>/NewFile.jsp</location>
    </error-page>
    <context-param>

        <param-name>contextConfigLocation</param-name>

        <param-value>classpath:spring-mybatis.xml</param-value>

    </context-param>
    <listener>

        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>

    </listener>
    <servlet>

        <servlet-name>dispatcherServlet</servlet-name>

        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>


        <init-param>

            <param-name>contextConfigLocation</param-name>

            <param-value>classpath:spring-mvc.xml</param-value>

        </init-param>

        <load-on-startup>1</load-on-startup>

    </servlet>
    <servlet-mapping>

        <servlet-name>dispatcherServlet</servlet-name>

        <url-pattern>/</url-pattern>

    </servlet-mapping>
    <filter>

        <filter-name>characterEncodingFilter</filter-name>

        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>


        <init-param>

            <param-name>encoding</param-name>

            <param-value>UTF-8</param-value>

        </init-param>
        <!-- 改变了字符集编码问题,注释掉 -->
        <!-- <init-param>
            <param-name>forceEncoding</param-name>
            <param-value>true</param-value>
        </init-param> -->

    </filter>
    <filter-mapping>

        <filter-name>characterEncodingFilter</filter-name>

        <url-pattern>/*</url-pattern>

    </filter-mapping>
    <!-- 跨域 -->
    <filter>
  <filter-name>CORS</filter-name>
  <filter-class>com.thetransactioncompany.cors.CORSFilter</filter-class>
  <init-param>
   <param-name>cors.allowOrigin</param-name>   <!--配置授信的白名单的域名! -->
   <param-value>*</param-value>
  </init-param>
  <init-param>
   <param-name>cors.supportedMethods</param-name>
   <param-value> GET, POST, HEAD, PUT, DELETE </param-value>
  </init-param>
  <init-param>
   <param-name>cors.supportedHeaders</param-name>
   <param-value> Accept, Origin, X-Requested-With, Content-Type, Last-Modified </param-value>
  </init-param>
  <init-param>
   <param-name>cors.exposedHeaders</param-name>
   <param-value>Set-Cookie</param-value>
  </init-param>
  <init-param>
   <param-name>cors.supportsCredentials</param-name>
   <param-value>true</param-value>
  </init-param>
 </filter>
 <filter-mapping>
  <filter-name>CORS</filter-name>
  <url-pattern>/*</url-pattern>
 </filter-mapping>
</web-app>

3.jar包引入:pom.xml配置

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com</groupId>
  <artifactId>dbcps</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <dependencies>
    <!-- https://mvnrepository.com/artifact/com.lowagie/itext -->
    <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>
    <!-- 数据库 -->
          <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.24</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/commons-dbcp/commons-dbcp -->
        <dependency>
            <groupId>commons-dbcp</groupId>
            <artifactId>commons-dbcp</artifactId>
            <version>1.4</version>
        </dependency>
        <!-- mybatis -->
        <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.2.8</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis-spring -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>1.3.1</version>
        </dependency>
</dependencies>
  <build>
    <plugins>
        <plugin>

            <groupId>org.apache.maven.plugins</groupId>

            <artifactId>maven-compiler-plugin</artifactId>

            <version>3.3</version>
            <configuration>

                <!-- http://maven.apache.org/plugins/maven-compiler-plugin/ -->

                <encoding>utf-8</encoding>
                <source>1.8</source>

                <target>1.8</target>

            </configuration>

        </plugin>
        <plugin>

            <groupId>org.apache.tomcat.maven</groupId>

            <artifactId>tomcat7-maven-plugin</artifactId>

            <version>2.2</version>
            <configuration>

                <path>/</path>

                <port>8080</port>

                <uriEncoding>UTF-8</uriEncoding>

            </configuration>

        </plugin>
    </plugins>
</build>
</project>

4.java代码实现


package dbdoc;  
  
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 
 * @author Eric zhou 
 * 
 */  
public class MYSQL_DBDocer {  
    //键类型字典  
    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://localhost:3306/库名";//链接url  
    private static String username = "###"; //用户名  
    private static String password = "###"; //密码  
    private static String schema = "###"; //目标数据库 名  
    //查询所有表的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("E:/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;  
    }  
}  
源码链接:资源 链接


版权声明:本文为weixin_41913929原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。