# 数据库文档生成工具

**Repository Path**: liuhangjun/dbDocGenerator

## Basic Information

- **Project Name**: 数据库文档生成工具
- **Description**: 基于springboot开发的数据库文档生成工具，简单配置，快速生成
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 242
- **Created**: 2018-09-10
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

数据库文档生成工具
====
    简单配置，就能够生成数据库文档。欢迎大家提意见

使用方法  
----
    1.修改application.properties的数据库配置信息  
    2.修改application.properties中的属性 application.generator中的信息
    3.运行Application.java  
    4.生成文件的格式类似2018-03-07_05-45-453.xls

使用的框架  
----
    1.spring boot  
    2.spring jdbc  
    3.freemaker  

支持的数据库 
----
    1.mysql  
    
支持生成的文档类型
----
	1.word，不太好看，但是可以修改文档,v.15移除，不再支持
	2.excel，还算好看吧，可以修改文档
	3.html，最好看了，ヾ(◍°∇°◍)ﾉﾞ，但是不能修改

如何扩展已支持更多数据库
----
    1.在pom.xml加入数据库驱动包
    2.修改application.properties的数据库配置信息
    3.创建一个新的类，继承cn.wuwenyao.db.doc.generator.dao.impl.AbstractDbInfoDao
    4.在枚举类cn.wuwenyao.db.doc.generator.enums.DbType增加一个新的枚举
    
如何扩展已支持更多的生成文档类型
----
	1.创建一个新的类，继承cn.wuwenyao.db.doc.generator.service.impl.AbstractGeneratorServiceImpl
	2.在枚举类cn.wuwenyao.db.doc.generator.enums.TargetFileType中增加一个新的枚举
	
更新日志
----
	1.v1.0,完成基本架构，支持生成word文档
	2.v1.1,优化架构，支持生成excel文档，比word文档好看点，笑
	3.v1.2，支持生成html文档
	4.v1.3,增加索引信息的生成
	5.v1.3.1 增加新的html模板，优化生成文档的速度
	
效果图
----
 ![Excel例子](https://gitee.com/shiqiyue/dbDocGenerator/raw/master/doc/excel.gif "例子")
 ![Html例子](https://gitee.com/shiqiyue/dbDocGenerator/raw/master/doc/html.gif "例子")
 ![Html例子](https://gitee.com/shiqiyue/dbDocGenerator/raw/master/doc/html-menu.gif "例子")
样例下载
----
  1.[WORD样例](http://gitee.com/shiqiyue/dbDocGenerator/tree/master/doc/word-sample.doc)  
  2.[EXCEL样例](http://gitee.com/shiqiyue/dbDocGenerator/tree/master/doc/excel-sample.xls)  
  3.[HTML样例](http://gitee.com/shiqiyue/dbDocGenerator/tree/master/doc/html-sample.html)