日本综合一区二区|亚洲中文天堂综合|日韩欧美自拍一区|男女精品天堂一区|欧美自拍第6页亚洲成人精品一区|亚洲黄色天堂一区二区成人|超碰91偷拍第一页|日韩av夜夜嗨中文字幕|久久蜜综合视频官网|精美人妻一区二区三区

RELATEED CONSULTING
相關(guān)咨詢
選擇下列產(chǎn)品馬上在線溝通
服務(wù)時(shí)間：8:30-17:00
你可能遇到了下面的問題
關(guān)閉右側(cè)工具欄

新聞中心

這里有您想知道的互聯(lián)網(wǎng)營(yíng)銷解決方案
好用！一鍵生成數(shù)據(jù)庫文檔，這個(gè)開源的文檔生成工具值得了解

 簡(jiǎn)介

創(chuàng)新互聯(lián)建站是一家專注于做網(wǎng)站、網(wǎng)站建設(shè)與策劃設(shè)計(jì),晉中網(wǎng)站建設(shè)哪家好?創(chuàng)新互聯(lián)建站做網(wǎng)站,專注于網(wǎng)站建設(shè)十年,網(wǎng)設(shè)計(jì)領(lǐng)域的專業(yè)建站公司;建站業(yè)務(wù)涵蓋:晉中等地區(qū)。晉中做網(wǎng)站價(jià)格咨詢:13518219792

在企業(yè)級(jí)開發(fā)中、我們經(jīng)常會(huì)有編寫數(shù)據(jù)庫表結(jié)構(gòu)文檔的時(shí)間付出，從業(yè)以來，待過幾家企業(yè)，關(guān)于數(shù)據(jù)庫表結(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ù)庫、經(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ù)庫支持
  •  多種格式文檔
  •  靈活擴(kuò)展
  •  支持自定義模板

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

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

文檔生成支持

  •  html
  •  word
  •  markdown

文檔截圖

  •  html

  •  word

  •  markdwon

  

使用方式

普通方式

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

Maven 插件 

 
 
 
 
    
  
  
  
  
  1.   
    2. 
  
  
  
  
  2.       
    3. 
  
  
  
  
  3.           
    4. 
  
  
  
  
  4.             cn.smallbun.screw  
    5. 
  
  
  
  
  5.             screw-maven-plugin  
    6. 
  
  
  
  
  6.             ${lastVersion}  
    7. 
  
  
  
  
  7.               
    8. 
  
  
  
  
  8.                   
    9. 
  
  
  
  
  9.                   
    10. 
  
  
  
  
  10.                     com.zaxxer  
    11. 
  
  
  
  
  11.                     HikariCP  
    12. 
  
  
  
  
  12.                     3.4.5  
    13. 
  
  
  
  
  13.                   
    14. 
  
  
  
  
  14.                   
    15. 
  
  
  
  
  15.                   
    16. 
  
  
  
  
  16.                     mysql  
    17. 
  
  
  
  
  17.                     mysql-connector-java  
    18. 
  
  
  
  
  18.                     8.0.20  
    19. 
  
  
  
  
  19.                   
    20. 
  
  
  
  
  20.               
    21. 
  
  
  
  
  21.               
    22. 
  
  
  
  
  22.                   
    23. 
  
  
  
  
  23.                 root  
    24. 
  
  
  
  
  24.                   
    25. 
  
  
  
  
  25.                 password  
    26. 
  
  
  
  
  26.                   
    27. 
  
  
  
  
  27.                 com.mysql.cj.jdbc.Driver  
    28. 
  
  
  
  
  28.                   
    29. 
  
  
  
  
  29.                 jdbc:mysql://127.0.0.1:3306/xxxx  
    30. 
  
  
  
  
  30.                   
    31. 
  
  
  
  
  31.                 HTML  
    32. 
  
  
  
  
  32.                   
    33. 
  
  
  
  
  33.                 false  
    34. 
  
  
  
  
  34.                   
    35. 
  
  
  
  
  35.                 freemarker  
    36. 
  
  
  
  
  36.                   
    37. 
  
  
  
  
  37.                 測(cè)試文檔名稱  
    38. 
  
  
  
  
  38.                   
    39. 
  
  
  
  
  39.                 數(shù)據(jù)庫文檔生成  
    40. 
  
  
  
  
  40.                   
    41. 
  
  
  
  
  41.                 ${project.version}  
    42. 
  
  
  
  
  42.                   
    43. 
  
  
  
  
  43.                 數(shù)據(jù)庫文檔  
    44. 
  
  
  
  
  44.              
    45. 
  
  
  
  
  45.                
    46. 
  
  
  
  
  46.                   
    47. 
  
  
  
  
  47.                     compile  
    48. 
  
  
  
  
  48.                       
    49. 
  
  
  
  
  49.                         run  
    50. 
  
  
  
  
  50.                       
    51. 
  
  
  
  
  51.                   
    52. 
  
  
  
  
  52.               
    53. 
  
  
  
  
  53.           
    54. 
  
  
  
  
  54.       
    55. 
  
  
  
  
  55.  
    56.

擴(kuò)展模塊

pojo生成功能

功能簡(jiǎn)介

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

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

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

  •  MySQL

使用方式

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

常見問題

  •  生成后文檔亂碼？

          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.   
    2. 
  
  
  
  
  2.        com.oracle.ojdbc  
    3. 
  
  
  
  
  3.        ojdbc8  
    4. 
  
  
  
  
  4.        19.3.0.0  
    5. 
  
  
  
  
  5.       
    6. 
  
  
  
  
  6.       
    7. 
  
  
  
  
  7.        cn.easyproject  
    8. 
  
  
  
  
  8.        orai18n  
    9. 
  
  
  
  
  9.        12.1.0.2.0  
    10. 
  
  
  
  
  10.      
    11.
  •  MySQL數(shù)據(jù)庫表和列字段有說明、生成文檔沒有說明？

    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)版本為最新即可。 


網(wǎng)站名稱：好用！一鍵生成數(shù)據(jù)庫文檔，這個(gè)開源的文檔生成工具值得了解
網(wǎng)址分享：http://www.dlmjj.cn/article/dppopjd.html