Springboot + screw 数据库快速开发文档

1、方式1

• 引入依赖

• 
      cn.smallbun.screw
      screw-core
      1.0.5
   

• /**
   * 文档生成
  Springboot2.X + screw数据库快速开发文档（74） - 纯粹而又极致的光--木九天 - OSCHINA - 中文开源技术交流社区
  screw: 简洁好用的数据库表结构文档工具，支持MySQL/MariaDB/SqlServer/Oracle/PostgreSQL/TIDB/CacheDB 数据库。
   */
  public static void main(String[] args) {
     //数据源
     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();
  }

• 方式2
• maven 插件的方式 （使用mavn 打包方式）
• mvn clean package

• 
      
          
              cn.smallbun.screw
              screw-maven-plugin
              1.0.5
              
                  
                  
                      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