自拍偷在线精品自拍偷,亚洲欧美中文日韩v在线观看不卡

好用！一鍵生成數(shù)據(jù)庫(kù)文檔，這個(gè)開源的文檔生成工具值得了解

作者：佚名
開發(fā) 后端
6月份由于工作原因、頻繁設(shè)計(jì)和更改數(shù)據(jù)庫(kù)、經(jīng)常使用自己寫的此插件、節(jié)省了很多時(shí)間，解決了很多問題 ，在僅有且不多的業(yè)余時(shí)間中、進(jìn)行開源準(zhǔn)備，于2020年6月22日，開源，歡迎大家使用、建議、并貢獻(xiàn)。

 簡(jiǎn)介

在企業(yè)級(jí)開發(fā)中、我們經(jīng)常會(huì)有編寫數(shù)據(jù)庫(kù)表結(jié)構(gòu)文檔的時(shí)間付出，從業(yè)以來，待過幾家企業(yè)，關(guān)于數(shù)據(jù)庫(kù)表結(jié)構(gòu)文檔狀態(tài)：要么沒有、要么有、但都是手寫、后期運(yùn)維開發(fā)，需要手動(dòng)進(jìn)行維護(hù)到文檔中，很是繁瑣、如果忘記一次維護(hù)、就會(huì)給以后工作造成很多困擾、無形中制造了很多坑留給自己和后人。

于是萌生了要自己寫一個(gè)插件工具的想法，但由于自己前期在程序設(shè)計(jì)上沒有很多造詣，且能力偏低，有想法并不能很好實(shí)現(xiàn)，隨著工作閱歷的增加，和知識(shí)的不斷儲(chǔ)備，終于在2020年的3月中旬開始進(jìn)行編寫。

4月上旬完成初版，想完善差不多在開源，但由于工作太忙，業(yè)余時(shí)間不足，沒有在進(jìn)行完善，到了6月份由于工作原因、頻繁設(shè)計(jì)和更改數(shù)據(jù)庫(kù)、經(jīng)常使用自己寫的此插件、節(jié)省了很多時(shí)間，解決了很多問題 ，在僅有且不多的業(yè)余時(shí)間中、進(jìn)行開源準(zhǔn)備，于2020年6月22日，開源，歡迎大家使用、建議、并貢獻(xiàn)。

關(guān)于名字，想一個(gè)太難了，好在我這個(gè)聰明的小腦瓜靈感一現(xiàn)，怎么突出它的小，但重要呢？從小就學(xué)過雷鋒的螺絲釘精神，摘自雷鋒日記：雖然是細(xì)小的螺絲釘，是個(gè)細(xì)微的小齒輪，然而如果缺了它，那整個(gè)的機(jī)器就無法運(yùn)轉(zhuǎn)了，慢說是缺了它，即使是一枚小螺絲釘沒擰緊，一個(gè)小齒輪略有破損，也要使機(jī)器的運(yùn)轉(zhuǎn)發(fā)生故障的...，感覺自己寫的這個(gè)工具，很有這意味，雖然很小、但是開發(fā)中缺了它還不行，于是便起名為screw（螺絲釘）。

特點(diǎn)

  •  簡(jiǎn)潔、輕量、設(shè)計(jì)良好
  •  多數(shù)據(jù)庫(kù)支持
  •  多種格式文檔
  •  靈活擴(kuò)展
  •  支持自定義模板

數(shù)據(jù)庫(kù)支持

  •  MySQL
  •  MariaDB
  •  TIDB
  •  Oracle
  •  SqlServer
  •  PostgreSQL
  •  Cache DB（2016）
  •  H2 （開發(fā)中）
  •  DB2  （開發(fā)中）
  •  HSQL  （開發(fā)中）
  •  SQLite（開發(fā)中）
  •  瀚高（開發(fā)中）
  •  達(dá)夢(mèng) （開發(fā)中）
  •  虛谷  （開發(fā)中）
  •  人大金倉(cāng)（開發(fā)中）

文檔生成支持

  •  html
  •  word
  •  markdown

文檔截圖

  •  html

  •  word

  •  markdwon

  

使用方式

普通方式

  •  引入依賴 
  1. <dependency>  
  2.     <groupId>cn.smallbun.screw</groupId>  
  3.     <artifactId>screw-core</artifactId>  
  4.     <version>${lastVersion}</version>  
  5.  </dependency> 
  •  編寫代碼 
  1. /**  
  2.  * 文檔生成  
  3.  */  
  4. void documentGeneration() {  
  5.    //數(shù)據(jù)源  
  6.    HikariConfig hikariConfig = new HikariConfig();  
  7.    hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");  
  8.    hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/database");  
  9.    hikariConfig.setUsername("root");  
  10.    hikariConfig.setPassword("password");  
  11.    //設(shè)置可以獲取tables remarks信息  
  12.    hikariConfig.addDataSourceProperty("useInformationSchema", "true");  
  13.    hikariConfig.setMinimumIdle(2);  
  14.    hikariConfig.setMaximumPoolSize(5);  
  15.    DataSource dataSource = new HikariDataSource(hikariConfig);  
  16.    //生成配置  
  17.    EngineConfig engineConfig = EngineConfig.builder()  
  18.          //生成文件路徑  
  19.          .fileOutputDir(fileOutputDir)  
  20.          //打開目錄  
  21.          .openOutputDir(true)  
  22.          //文件類型  
  23.          .fileType(EngineFileType.HTML)  
  24.          //生成模板實(shí)現(xiàn)  
  25.          .produceType(EngineTemplateType.freemarker)  
  26.          //自定義文件名稱  
  27.          .fileName("自定義文件名稱").build();  
  28.    //忽略表  
  29.    ArrayList<String> ignoreTableName = new ArrayList<>();  
  30.    ignoreTableName.add("test_user");  
  31.    ignoreTableName.add("test_group");  
  32.    //忽略表前綴  
  33.    ArrayList<String> ignorePrefix = new ArrayList<>();  
  34.    ignorePrefix.add("test_");  
  35.    //忽略表后綴      
  36.    ArrayList<String> ignoreSuffix = new ArrayList<>();  
  37.    ignoreSuffix.add("_test"); 
  38.     ProcessConfig processConfig = ProcessConfig.builder()  
  39.          //指定生成邏輯、當(dāng)存在指定表、指定表前綴、指定表后綴時(shí)，將生成指定表，其余表不生成、并跳過忽略表配置   
  40.    //根據(jù)名稱指定表生成  
  41.    .designatedTableName(new ArrayList<>())  
  42.    //根據(jù)表前綴生成  
  43.    .designatedTablePrefix(new ArrayList<>())  
  44.    //根據(jù)表后綴生成   
  45.    .designatedTableSuffix(new ArrayList<>())  
  46.          //忽略表名  
  47.          .ignoreTableName(ignoreTableName)  
  48.          //忽略表前綴 
  49.           .ignoreTablePrefix(ignorePrefix)  
  50.          //忽略表后綴 
  51.           .ignoreTableSuffix(ignoreSuffix).build();  
  52.    //配置  
  53.    Configuration config = Configuration.builder()  
  54.          //版本  
  55.          .version("1.0.0")  
  56.          //描述  
  57.          .description("數(shù)據(jù)庫(kù)設(shè)計(jì)文檔生成")  
  58.          //數(shù)據(jù)源  
  59.          .dataSource(dataSource)  
  60.          //生成配置  
  61.          .engineConfig(engineConfig) 
  62.           //生成配置  
  63.          .produceConfig(processConfig) 
  64.           .build();  
  65.    //執(zhí)行生成  
  66.    new DocumentationExecute(config).execute();  
  67. } 

Maven 插件 

  1. <build>  
  2.     <plugins>  
  3.         <plugin>  
  4.             <groupId>cn.smallbun.screw</groupId>  
  5.             <artifactId>screw-maven-plugin</artifactId>  
  6.             <version>${lastVersion}</version>  
  7.             <dependencies>  
  8.                 <!-- HikariCP -->  
  9.                 <dependency>  
  10.                     <groupId>com.zaxxer</groupId>  
  11.                     <artifactId>HikariCP</artifactId>  
  12.                     <version>3.4.5</version>  
  13.                 </dependency>  
  14.                 <!--mysql driver-->  
  15.                 <dependency>  
  16.                     <groupId>mysql</groupId>  
  17.                     <artifactId>mysql-connector-java</artifactId>  
  18.                     <version>8.0.20</version>  
  19.                 </dependency>  
  20.             </dependencies>  
  21.             <configuration>  
  22.                 <!--username-->  
  23.                 <username>root</username>  
  24.                 <!--password-->  
  25.                 <password>password</password>  
  26.                 <!--driver-->  
  27.                 <driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>  
  28.                 <!--jdbc url-->  
  29.                 <jdbcUrl>jdbc:mysql://127.0.0.1:3306/xxxx</jdbcUrl>  
  30.                 <!--生成文件類型-->  
  31.                 <fileType>HTML</fileType>  
  32.                 <!--打開文件輸出目錄-->  
  33.                 <openOutputDir>false</openOutputDir>  
  34.                 <!--生成模板-->  
  35.                 <produceType>freemarker</produceType>  
  36.                 <!--文檔名稱 為空時(shí):將采用[數(shù)據(jù)庫(kù)名稱-描述-版本號(hào)]作為文檔名稱-->  
  37.                 <fileName>測(cè)試文檔名稱</fileName>  
  38.                 <!--描述-->  
  39.                 <description>數(shù)據(jù)庫(kù)文檔生成</description>  
  40.                 <!--版本-->  
  41.                 <version>${project.version}</version>  
  42.                 <!--標(biāo)題-->  
  43.                 <title>數(shù)據(jù)庫(kù)文檔</title>  
  44.             </configuration> 
  45.              <executions>  
  46.                 <execution>  
  47.                     <phase>compile</phase>  
  48.                     <goals>  
  49.                         <goal>run</goal>  
  50.                     </goals>  
  51.                 </execution>  
  52.             </executions>  
  53.         </plugin>  
  54.     </plugins>  
  55. </build> 

擴(kuò)展模塊

pojo生成功能

功能簡(jiǎn)介

pojo生成功能是基于screw延伸出的擴(kuò)展模塊,目前處于初步開發(fā)的狀態(tài)。在日常的開發(fā)中,經(jīng)過需求分析、建模之后,往往會(huì)先在數(shù)據(jù)庫(kù)中建表,其次在進(jìn)行代碼的開發(fā)。那么pojo生成功能在這個(gè)階段就可以幫助大家節(jié)省一些重復(fù)勞動(dòng)了。

使用pojo生成功能可以直接根據(jù)數(shù)據(jù)庫(kù)生成對(duì)應(yīng)的java pojo對(duì)象。這樣后續(xù)的修改，開發(fā)都會(huì)很方便。

數(shù)據(jù)庫(kù)支持

  •  MySQL

使用方式

  •  引入依賴 
  1. <dependency>  
  2.     <groupId>cn.smallbun.screw</groupId>  
  3.     <artifactId>screw-extension</artifactId>  
  4.     <version>${lastVersion}</version>  
  5.  </dependency> 
  •  編寫代碼 
  1. /**  
  2.  * pojo生成  
  3.  */  
  4. void pojoGeneration() {  
  5.     //數(shù)據(jù)源  
  6.     HikariConfig hikariConfig = new HikariConfig();  
  7.     hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");  
  8.     hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/screw");  
  9.     hikariConfig.setUsername("screw");  
  10.     hikariConfig.setPassword("screw");  
  11.     //設(shè)置可以獲取tables remarks信息 
  12.      hikariConfig.addDataSourceProperty("useInformationSchema", "true");  
  13.     hikariConfig.setMinimumIdle(2);  
  14.     hikariConfig.setMaximumPoolSize(5);  
  15.     DataSource dataSource = new HikariDataSource(hikariConfig);  
  16.     ProcessConfig processConfig = ProcessConfig.builder()  
  17.         //指定生成邏輯、當(dāng)存在指定表、指定表前綴、指定表后綴時(shí)，將生成指定表，其余表不生成、并跳過忽略表配置  
  18.         //根據(jù)名稱指定表生成  
  19.         .designatedTableName(new ArrayList<>())  
  20.         //根據(jù)表前綴生成  
  21.         .designatedTablePrefix(new ArrayList<>())  
  22.         //根據(jù)表后綴生成  
  23.         .designatedTableSuffix(new ArrayList<>()).build();  
  24.     //設(shè)置生成pojo相關(guān)配置  
  25.     PojoConfiguration config = new PojoConfiguration();  
  26.     //設(shè)置文件存放路徑  
  27.     config.setPath("/cn/smallbun/screw/");  
  28.     //設(shè)置包名  
  29.     config.setPackageName("cn.smallbun.screw");  
  30.     //設(shè)置是否使用lombok  
  31.     config.setUseLombok(false);  
  32.     //設(shè)置數(shù)據(jù)源  
  33.     config.setDataSource(dataSource);  
  34.     //設(shè)置命名策略  
  35.     config.setNameStrategy(new HumpNameStrategy());  
  36.     //設(shè)置表過濾邏輯  
  37.     config.setProcessConfig(processConfig);  
  38.     //執(zhí)行生成  
  39.     new PojoExecute(config).execute();  
  40. } 

常見問題

  •  生成后文檔亂碼？

          MySQL：URL加入?characterEncoding=UTF-8。

  •  Caused by: java.lang.NoSuchFieldError: VERSION_2_3_30？

           檢查項(xiàng)目freemarker依賴，這是由于版本過低造成的，升級(jí)版本為2.3.30即可。

  •  java.lang.AbstractMethodError: oracle.jdbc.driver.T4CConnection.getSchema()Ljava/lang/String;

          這是因?yàn)閛racle驅(qū)動(dòng)版本過低造成的，刪除或屏蔽目前驅(qū)動(dòng)版本，驅(qū)動(dòng)添加升級(jí)為以下版本：   

  1. <dependency>  
  2.        <groupId>com.oracle.ojdbc</groupId>  
  3.        <artifactId>ojdbc8</artifactId>  
  4.        <version>19.3.0.0</version>  
  5.     </dependency>  
  6.     <dependency>  
  7.        <groupId>cn.easyproject</groupId>  
  8.        <artifactId>orai18n</artifactId>  
  9.        <version>12.1.0.2.0</version>  
  10.     </dependency> 
  •  MySQL數(shù)據(jù)庫(kù)表和列字段有說明、生成文檔沒有說明？

    URL鏈接加入useInformationSchema=true即可。

  •  java.lang.AbstractMethodError: com.mysql.jdbc.JDBC4Connection.getSchema()Ljava/lang/String;

    這是因?yàn)閙ysql驅(qū)動(dòng)版本過低造成的，升級(jí)mysql驅(qū)動(dòng)版本為最新即可。 

 

責(zé)任編輯：龐桂玉 來源： Java知音
文檔工具語言
相關(guān)推薦

2020-08-06 11:45:37

數(shù)據(jù)庫(kù)文檔Swagger

2023-03-29 07:02:46

開源項(xiàng)目工具

2024-08-13 10:36:25

SpringScrew數(shù)據(jù)庫(kù)

2020-07-29 10:55:07

數(shù)據(jù)庫(kù)工具技術(shù)

2024-04-08 14:07:51

Animagine開源

2010-05-07 14:29:45

Unix--Tripw

2021-05-10 09:22:44

.NET數(shù)據(jù)庫(kù)項(xiàng)目

2018-10-09 14:34:58

開源KubernetesGit

2024-09-30 08:10:22

2023-06-01 15:30:30

Service代碼生成工具

2024-06-21 10:27:21

Service生成工具鴻蒙

2021-04-16 07:31:50

工具Postman接口

2016-08-23 13:35:22

MVCEFNuGet

2024-07-04 10:13:18

2023-04-18 18:22:31

開源工具數(shù)據(jù)庫(kù)

2024-06-21 10:07:06

鴻蒙service生成工具

2021-01-04 09:00:00

JavaScript開發(fā)Web

2019-10-11 11:00:53

Nginx神器前端

2022-08-02 14:27:01

HDF驅(qū)動(dòng)框架驅(qū)動(dòng)開發(fā)

2024-03-15 14:34:12

Oracle數(shù)據(jù)庫(kù)一鍵巡檢
點(diǎn)贊
收藏

51CTO技術(shù)棧公眾號(hào)