怎么一键生成数据库文档
本篇内容介绍了“怎么一键生成数据库文档”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!
公司主营业务:网站设计制作、成都网站制作、移动网站开发等业务。帮助企业客户真正实现互联网宣传,提高企业的竞争能力。成都创新互联是一支青春激扬、勤奋敬业、活力青春激扬、勤奋敬业、活力澎湃、和谐高效的团队。公司秉承以“开放、自由、严谨、自律”为核心的企业文化,感谢他们对我们的高要求,感谢他们从不同领域给我们带来的挑战,让我们激情的团队有机会用头脑与智慧不断的给客户带来惊喜。成都创新互联推出凉山州免费做网站回馈大家。
数据库文档图
MySQL MariaDB TIDB Oracle SqlServer PostgreSQL Cache DB
引入screw
核心包,HikariCP
数据库连接池,HikariCP
号称性能最出色的数据库连接池。
cn.smallbun.screw
screw-core
1.0.3
com.zaxxer
HikariCP
3.4.5
mysql
mysql-connector-java
8.0.20
配置数据源,设置
useInformationSchema
可以获取tables
注释信息。
spring.datasource.url=jdbc:mysql://45.93.1.5:3306/fire?useUnicode=true&characterEncoding=UTF-8&useSSL=false
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.xa.properties.useInformationSchema=true
screw
有两种执行方式,第一种是pom
文件配置,另一种是代码执行。
org.springframework.boot
spring-boot-maven-plugin
cn.smallbun.screw
screw-maven-plugin
1.0.3
com.zaxxer
HikariCP
3.4.5
mysql
mysql-connector-java
8.0.20
root
123456
com.mysql.cj.jdbc.Driver
jdbc:mysql://41.92.6.5:3306/fire
HTML
false
freemarker
数据库文档生成
${project.version}
fire数据库文档
compile
run
配置完以后在
maven project
->screw
双击执行ok。
代码生成方式也非常简单。
@SpringBootTest
public 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 ignoreTableName = Arrays.asList("a", "test_group");
// 忽略表前缀,如忽略a开头的数据库表
List ignorePrefix = Arrays.asList("a", "t");
// 忽略表后缀
List 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();
}
}
screw
有
HTML
、DOC
、MD
三种格式的文档。
代码中的修改
.fileType(EngineFileType.HTML)
或者pom
文件
MD
DOC
文档样式
HTML
文档样式
MD
文档样式
“怎么一键生成数据库文档”的内容就介绍到这里了,感谢大家的阅读。如果想了解更多行业相关的知识可以关注创新互联网站,小编将为大家输出更多高质量的实用文章!
网站名称:怎么一键生成数据库文档
文章链接:http://cdiso.cn/article/igesij.html