## 项目说明 + 导出orcale数据结构 + 导出orcale主外键关联以及表信息 + 导出orcale自定义类型 ## 数据源更改 + 修改配置 screw-core/src/main/resources/properties中进行修改 + 执行test screw-core/src/test/java/cn.smallbun.screw.core/produce/xxxTest + 根据自己需求进行配置文件修改和对应数据库的导出 ## 特点 + 简洁、轻量、设计良好 + 多数据库支持 + 多种格式文档 + 灵活扩展 + 支持自定义模板 ## 数据库支持 - [x] MySQL - [x] MariaDB - [x] TIDB - [x] Oracle 已完善外键以及自定义主键生成 - [x] SqlServer - [x] PostgreSQL - [x] Cache DB(2016) ## 文档生成支持 - [x] html 已完善外键以及自定义主键生成 - [ ] word 暂时只支持导出表结构信息 - [ ] markdown 暂时只支持导出表结构信息 ## 文档截图 + **html**

HTML

screw-logo

+ **word**

word

+ **markdwon**

markdwon

markdwon

## 使用方式 ### 普通方式 + **引入依赖** ```xml cn.smallbun.screw screw-core ${lastVersion} ``` + **编写代码** ``` java /** * 文档生成 */ void documentGeneration() { //数据源 HikariConfig hikariConfig = new HikariConfig(); hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver"); hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/database"); hikariConfig.setUsername("root"); hikariConfig.setPassword("password"); //设置可以获取tables remarks信息 hikariConfig.addDataSourceProperty("useInformationSchema", "true"); hikariConfig.setMinimumIdle(2); hikariConfig.setMaximumPoolSize(5); DataSource dataSource = new HikariDataSource(hikariConfig); //生成配置 EngineConfig engineConfig = EngineConfig.builder() //生成文件路径 .fileOutputDir(fileOutputDir) //打开目录 .openOutputDir(true) //文件类型 .fileType(EngineFileType.HTML) //生成模板实现 .produceType(EngineTemplateType.freemarker) //自定义文件名称 .fileName("自定义文件名称").build(); //忽略表 ArrayList ignoreTableName = new ArrayList<>(); ignoreTableName.add("test_user"); ignoreTableName.add("test_group"); //忽略表前缀 ArrayList ignorePrefix = new ArrayList<>(); ignorePrefix.add("test_"); //忽略表后缀 ArrayList ignoreSuffix = new ArrayList<>(); ignoreSuffix.add("_test"); ProcessConfig processConfig = ProcessConfig.builder() //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时,将生成指定表,其余表不生成、并跳过忽略表配置 //根据名称指定表生成 .designatedTableName(new ArrayList<>()) //根据表前缀生成 .designatedTablePrefix(new ArrayList<>()) //根据表后缀生成 .designatedTableSuffix(new ArrayList<>()) //忽略表名 .ignoreTableName(ignoreTableName) //忽略表前缀 .ignoreTablePrefix(ignorePrefix) //忽略表后缀 .ignoreTableSuffix(ignoreSuffix).build(); //配置 Configuration config = Configuration.builder() //版本 .version("1.0.0") //描述 .description("数据库设计文档生成") //数据源 .dataSource(dataSource) //生成配置 .engineConfig(engineConfig) //生成配置 .produceConfig(processConfig) .build(); //执行生成 new DocumentationExecute(config).execute(); } ``` ### Maven 插件 ``` xml cn.smallbun.screw screw-maven-plugin ${lastVersion} com.zaxxer HikariCP 3.4.5 mysql mysql-connector-java 8.0.20 root password com.mysql.cj.jdbc.Driver jdbc:mysql://127.0.0.1:3306/xxxx HTML false freemarker 测试文档名称 数据库文档生成 ${project.version} 数据库文档 compile run ``` ### 使用文章 + [SpringBoot整合screw生成数据库文档](https://my.oschina.net/mdxlcj/blog/4341399) ### 使用视频 + [使用screw数据库文档生成工具快速生成数据库文档](https://www.bilibili.com/video/av456302504/) ## 扩展模块 ### pojo生成功能 #### 功能简介   pojo生成功能是基于screw延伸出的扩展模块,目前处于初步开发的状态。在日常的开发中,经过需求分析、建模之后,往往会先在数据库中建表,其次在进行代码的开发。那么pojo生成功能在这个阶段就可以帮助大家节省一些重复劳动了。使用pojo生成功能可以直接根据数据库生成对应的java pojo对象。这样后续的修改,开发都会很方便。 #### 数据库支持 - [x] MySQL #### 使用方式 + **引入依赖** ```xml cn.smallbun.screw screw-extension ${lastVersion} ``` + **编写代码** ``` java /** * pojo生成 */ void pojoGeneration() { //数据源 HikariConfig hikariConfig = new HikariConfig(); hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver"); hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/screw"); hikariConfig.setUsername("screw"); hikariConfig.setPassword("screw"); //设置可以获取tables remarks信息 hikariConfig.addDataSourceProperty("useInformationSchema", "true"); hikariConfig.setMinimumIdle(2); hikariConfig.setMaximumPoolSize(5); DataSource dataSource = new HikariDataSource(hikariConfig); ProcessConfig processConfig = ProcessConfig.builder() //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时,将生成指定表,其余表不生成、并跳过忽略表配置 //根据名称指定表生成 .designatedTableName(new ArrayList<>()) //根据表前缀生成 .designatedTablePrefix(new ArrayList<>()) //根据表后缀生成 .designatedTableSuffix(new ArrayList<>()).build(); //设置生成pojo相关配置 PojoConfiguration config = new PojoConfiguration(); //设置文件存放路径 config.setPath("/cn/smallbun/screw/"); //设置包名 config.setPackageName("cn.smallbun.screw"); //设置是否使用lombok config.setUseLombok(false); //设置数据源 config.setDataSource(dataSource); //设置命名策略 config.setNameStrategy(new HumpNameStrategy()); //设置表过滤逻辑 config.setProcessConfig(processConfig); //执行生成 new PojoExecute(config).execute(); } ``` ## 常见问题 + 生成后文档乱码? MySQL:URL加入`?characterEncoding=UTF-8`。 + Caused by: java.lang.NoSuchFieldError: VERSION_2_3_30? 检查项目`freemarker`依赖,这是由于版本过低造成的,升级版本为`2.3.30`即可。 + java.lang.AbstractMethodError: oracle.jdbc.driver.T4CConnection.getSchema()Ljava/lang/String; 这是因为oracle驱动版本过低造成的,删除或屏蔽目前驱动版本,驱动添加升级为以下版本: ``` xml com.oracle.ojdbc ojdbc8 19.3.0.0 cn.easyproject orai18n 12.1.0.2.0 ``` + MySQL数据库表和列字段有说明、生成文档没有说明? URL链接加入`useInformationSchema=true`即可。 + java.lang.AbstractMethodError: com.mysql.jdbc.JDBC4Connection.getSchema()Ljava/lang/String; 这是因为mysql驱动版本过低造成的,升级mysql驱动版本为最新即可。