配置完以后在 maven project->screw 双击执行ok 。
代码生成方式也非常简单 。
@SpringBootTestpublic class ScrewApplicationTests { @Autowired ApplicationContext applicationContext; @Test void contextLoads() { DataSource dataSourceMysql = applicationContext.getBean(DataSource.class); // 生成文件配置 EngineConfig engineConfig = EngineConfig.builder() // 生成文件路径 ， 自己mac本地的地址 ， 这里需要自己更换下路径 .fileOutputDir("D:/") // 打开目录 .openOutputDir(false) // 文件类型 .fileType(EngineFileType.HTML) // 生成模板实现 .produceType(EngineTemplateType.freemarker).build(); // 生成文档配置（包含以下自定义版本号、描述等配置连接） Configuration config = Configuration.builder() .version("1.0.3") .description("生成文档信息描述") .dataSource(dataSourceMysql) .engineConfig(engineConfig) .produceConfig(getProcessConfig()) .build(); // 执行生成 new DocumentationExecute(config).execute(); } /** * 配置想要生成的表+ 配置想要忽略的表 * * @return 生成表配置 */ public static ProcessConfig getProcessConfig() { // 忽略表名 List<String> ignoreTableName = Arrays.asList("a", "test_group"); // 忽略表前缀 ， 如忽略a开头的数据库表 List<String> ignorePrefix = Arrays.asList("a", "t"); // 忽略表后缀 List<String> ignoreSuffix = Arrays.asList("_test", "czb_"); return ProcessConfig.builder() //根据名称指定表生成 .designatedTableName(Arrays.asList("fire_user")) //根据表前缀生成 .designatedTablePrefix(new ArrayList<>()) //根据表后缀生成 .designatedTableSuffix(new ArrayList<>()) //忽略表名 .ignoreTableName(ignoreTableName) //忽略表前缀 .ignoreTablePrefix(ignorePrefix) //忽略表后缀 .ignoreTableSuffix(ignoreSuffix).build(); }}4、文档格式screw 有 HTML、DOC、MD 三种格式的文档 。
代码中的修改
.fileType(EngineFileType.HTML)或者pom文件
<fileType>MD</fileType>DOC文档样式
HTML文档样式
MD文档样式
【一键生成数据库文档，堪称数据库界的Swagger，有点厉害】
推荐阅读
- 银行数据库迁移至MySQL，竟被时间字段这玩意耍了……
- 现在后端都在用什么数据库存储数据？
- Wps文字如何实现一键对齐？
- 淘宝的数据库，主键是如何设计的？
- 秒级搭建各类数据库测试环境
- 微信|微信占用空间太多？教你一键「瘦身」
- 一键解除网页右键限制
- 不推荐别的了，IDEA 自带的数据库工具就很牛逼
- Python 调用数据库存储过程
- SQL Server 数据库中的 ntext、text 和 image