2. 程式人生 > >mybatis-generator資料庫註釋實體類生成以及generatorConfig檔案配置

mybatis-generator資料庫註釋實體類生成以及generatorConfig檔案配置

阿新 • • 發佈：2018-11-22

專案裡新建表時model,mapper以及mapper.xml基本都是用Mybatis Generator(以下簡稱為MBG)自動生成的,但是MBG自動生成的model的註釋實在有點非人類,至少中國人是完全接受不了的,在配置中禁用掉註釋吧,倒是簡單了,可是生成的model類光禿禿的,啥都沒有,欄位方法沒有註釋,使用很不方便,別人看也不知道這個欄位是啥含義,到最後還是要自己新增,一張表多點幾十個欄位,特麼新增累死了,不能這麼幹,得想法子,百度了一下網上,基本有兩種方法,第一種,就是直接修改MGB的原始碼,第二種就是自己寫一個類實現CommentGenerator介面,先說自己寫一個新類實現CommentGenerator介面的方法來使自動生成的model類含有中文註釋吧.

一：首先你得有一個maven專案，這個我就不多提

二：通過mybatis generator實現自動生產model,mapper以及mapper.xml，具體參考 Intellij IDEA 14中使用MyBatis-generator 自動生成MyBatis程式碼 

三：通過檢視你會發現，註解類是在mybatis-generator-core jar包中  org.mybatis.generator.internal包下的DefaultCommentGenerator類。那麼這裡有兩種方法，一種是重寫DefaultCommentGenerator類，另外一種中修改jar包中的原始碼，但很明顯第一種方法比較簡單，這裡也只介紹第一種方法的寫法。

3.1在原始碼中新建一個類MyCommentGenerator,實現CommentGenerator介面,類的程式碼如下:

package org.mybatis.generator;
 
/**
 * Created by 草帽boy on 2017/2/16.
 * mybatis generator 自定義comment生成器.
 * 基於MBG 1.3.2.
 * @author ZhangAY 2016-02-19
 */
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Properties;
 

 
import org.mybatis.generator.api.CommentGenerator;
import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.dom.java.*;
import org.mybatis.generator.api.dom.xml.XmlElement;
import org.mybatis.generator.config.MergeConstants;
import org.mybatis.generator.config.PropertyRegistry;
import org.mybatis.generator.internal.util.StringUtility;
 
public class MyCommentGenerator implements CommentGenerator {
 
    private Properties properties;
    private Properties systemPro;
    private boolean suppressDate;
    private boolean suppressAllComments;
    private String currentDateStr;
 
    public MyCommentGenerator() {
        super();
        properties = new Properties();
        systemPro = System.getProperties();
        suppressDate = false;
        suppressAllComments = false;
        currentDateStr = (new SimpleDateFormat("yyyy-MM-dd")).format(new Date());
    }
 
    public void addJavaFileComment(CompilationUnit compilationUnit) {
        // add no file level comments by default
        return;
    }
 
    /**
     * Adds a suitable comment to warn users that the element was generated, and
     * when it was generated.
     */
    public void addComment(XmlElement xmlElement) {
        return;
    }
 
    public void addRootComment(XmlElement rootElement) {
        // add no document level comments by default
        return;
    }
 
    public void addConfigurationProperties(Properties properties) {
        this.properties.putAll(properties);
 
        suppressDate = StringUtility.isTrue(properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_DATE));
 
        suppressAllComments = StringUtility.isTrue(properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_ALL_COMMENTS));
    }
 
    /**
     * This method adds the custom javadoc tag for. You may do nothing if you do
     * not wish to include the Javadoc tag - however, if you do not include the
     * Javadoc tag then the Java merge capability of the eclipse plugin will
     * break.
     *
     * @param javaElement the java element
     */
    protected void addJavadocTag(JavaElement javaElement, boolean markAsDoNotDelete) {
        javaElement.addJavaDocLine(" *");
        StringBuilder sb = new StringBuilder();
        sb.append(" * ");
        sb.append(MergeConstants.NEW_ELEMENT_TAG);
        if (markAsDoNotDelete) {
            sb.append(" do_not_delete_during_merge");
        }
        String s = getDateString();
        if (s != null) {
            sb.append(' ');
            sb.append(s);
        }
        javaElement.addJavaDocLine(sb.toString());
    }
 
    /**
     * This method returns a formated date string to include in the Javadoc tag
     * and XML comments. You may return null if you do not want the date in
     * these documentation elements.
     *
     * @return a string representing the current timestamp, or null
     */
    protected String getDateString() {
        String result = null;
        if (!suppressDate) {
            result = currentDateStr;
        }
        return result;
    }
 
    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {
        if (suppressAllComments) {
            return;
        }
        StringBuilder sb = new StringBuilder();
        innerClass.addJavaDocLine("/**");
        sb.append(" * ");
        sb.append(introspectedTable.getFullyQualifiedTable());
        sb.append(" ");
        sb.append(getDateString());
        innerClass.addJavaDocLine(sb.toString());
        innerClass.addJavaDocLine(" */");
    }
 
    public void addEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable) {
        if (suppressAllComments) {
            return;
        }
 
        StringBuilder sb = new StringBuilder();
 
        innerEnum.addJavaDocLine("/**");
        //      addJavadocTag(innerEnum, false);
        sb.append(" * ");
        sb.append(introspectedTable.getFullyQualifiedTable());
        innerEnum.addJavaDocLine(sb.toString());
        innerEnum.addJavaDocLine(" */");
    }
 
    public void addFieldComment(Field field, IntrospectedTable introspectedTable,
                                IntrospectedColumn introspectedColumn) {
        if (suppressAllComments) {
            return;
        }
 
        StringBuilder sb = new StringBuilder();
 
        field.addJavaDocLine("/**");
        sb.append(" * ");
        sb.append(introspectedColumn.getRemarks());
        field.addJavaDocLine(sb.toString());
 
        //      addJavadocTag(field, false);
 
        field.addJavaDocLine(" */");
    }
 
    public void addFieldComment(Field field, IntrospectedTable introspectedTable) {
        if (suppressAllComments) {
            return;
        }
 
        StringBuilder sb = new StringBuilder();
 
        field.addJavaDocLine("/**");
        sb.append(" * ");
        sb.append(introspectedTable.getFullyQualifiedTable());
        field.addJavaDocLine(sb.toString());
        field.addJavaDocLine(" */");
    }
 
    public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
 
    }
 
    public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
        if (suppressAllComments) {
            return;
        }
        //      method.addJavaDocLine("/**");
        //      addJavadocTag(method, false);
        //      method.addJavaDocLine(" */");
    }
 
    public void addGetterComment(Method method, IntrospectedTable introspectedTable,
                                 IntrospectedColumn introspectedColumn) {
        if (suppressAllComments) {
            return;
        }
 
        method.addJavaDocLine("/**");
 
        StringBuilder sb = new StringBuilder();
        sb.append(" * ");
        sb.append(introspectedColumn.getRemarks());
        method.addJavaDocLine(sb.toString());
 
        sb.setLength(0);
        sb.append(" * @return ");
        sb.append(introspectedColumn.getActualColumnName());
        sb.append(" ");
        sb.append(introspectedColumn.getRemarks());
        method.addJavaDocLine(sb.toString());
 
        //      addJavadocTag(method, false);
 
        method.addJavaDocLine(" */");
    }
 
    public void addSetterComment(Method method, IntrospectedTable introspectedTable,
                                 IntrospectedColumn introspectedColumn) {
        if (suppressAllComments) {
            return;
        }
 
 
        method.addJavaDocLine("/**");
        StringBuilder sb = new StringBuilder();
        sb.append(" * ");
        sb.append(introspectedColumn.getRemarks());
        method.addJavaDocLine(sb.toString());
 
        Parameter parm = method.getParameters().get(0);
        sb.setLength(0);
        sb.append(" * @param ");
        sb.append(parm.getName());
        sb.append(" ");
        sb.append(introspectedColumn.getRemarks());
        method.addJavaDocLine(sb.toString());
 
        //      addJavadocTag(method, false);
 
        method.addJavaDocLine(" */");
    }
 
    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean markAsDoNotDelete) {
        if (suppressAllComments) {
            return;
        }
 
        StringBuilder sb = new StringBuilder();
 
        innerClass.addJavaDocLine("/**");
        sb.append(" * ");
        sb.append(introspectedTable.getFullyQualifiedTable());
        innerClass.addJavaDocLine(sb.toString());
 
        sb.setLength(0);
        sb.append(" * @author ");
        sb.append(systemPro.getProperty("user.name"));
        sb.append(" ");
        sb.append(currentDateStr);
 
        //      addJavadocTag(innerClass, markAsDoNotDelete);
 
        innerClass.addJavaDocLine(" */");
    }
}

 


3.2.再新建一個類StartUp,用於執行專案,(若是整合Eclipse，可直接執行操作，檢視mybatis與eclipse的整合，這裡不介紹了)也就是執行StartUp類 就會直接生成model,mapper以及mapper.xml，類的程式碼如下:

 

package org.mybatis.generator;
 
/**
 * Created by 草帽boy on 2017/2/16.
 * 啟動檔案，只需要點選執行就行
 */
import java.io.File;
import java.io.IOException;
import java.net.URISyntaxException;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
 
import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.exception.InvalidConfigurationException;
import org.mybatis.generator.exception.XMLParserException;
import org.mybatis.generator.internal.DefaultShellCallback;
 
public class StartUp {
    public static void main(String[] args) throws URISyntaxException {
        try {
            List<String> warnings = new ArrayList<String>();
            boolean overwrite = true;
            //直接獲取generatorConfig.xml的檔案路徑 根據具體情況檢視
            File configFile = new File("E:\\IDEAWorkPlace\\GraduationDesign\\CourseDesignManageSystem\\20170122\\CourseDesignManage\\src\\main\\resources\\generatorConfig.xml");
            ConfigurationParser cp = new ConfigurationParser(warnings);
            Configuration config = cp.parseConfiguration(configFile);
            DefaultShellCallback callback = new DefaultShellCallback(overwrite);
            MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
            myBatisGenerator.generate(null);
        } catch (SQLException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        } catch (InterruptedException e) {
            e.printStackTrace();
        } catch (InvalidConfigurationException e) {
            e.printStackTrace();
        } catch (XMLParserException e) {
            e.printStackTrace();
        }
    }
}

 

3.3 另外需要簡單修改一下generatorConfig.xml中的註釋配置

  <commentGenerator type="org.mybatis.generator.MyCommentGenerator">
           <!-- <property name="suppressDate" value="true"/>
            &lt;!&ndash; 是否去除自動生成的註釋 true：是 ： false:否 &ndash;&gt;
            <property name="suppressAllComments" value="false"/>-->
  </commentGenerator>

commentGenerator 的type是你剛剛重構的MyCommentGenerator類的位置


3.4其中我的檔案結構如下：

 

四：點選執行StartUp，你會發現model,mapper以及mapper.xml都已經產生，其中實體類的 執行的結果如下

 


注意：若是出現中文亂碼，在generatorConfig.xml檔案中增加以下配置

<property name="javaFileEncoding" value="UTF-8"/>

1.以下是generatorConfig.xml配置檔案

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" >
<generatorConfiguration >
<!-- 資料庫驅動包位置 -->  
    <classPathEntry  
        location="D:\repository\mysql\mysql-connector-java\5.1.34\mysql-connector-java-5.1.34.jar" />  
    <context id="context1"> 
         <property name="javaFileEncoding" value="UTF-8"/> 
         <commentGenerator type="com.wareic.utils.MyCommentGenerator"></commentGenerator> 
        <!-- <commentGenerator>  
            是否去除自動生成的註釋 true：是 ： false:否  
            <property name="suppressAllComments" value="true"/>  
        </commentGenerator>   -->
        <!-- 資料庫連結URL、使用者名稱、密碼 -->  
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"  
            connectionURL="jdbc:mysql://17.16.32.2:3306/db_wareic" userId="root" password="123456" />  
        <!-- 生成模型的包名和位置  wareic為專案名稱 -->  
        <javaModelGenerator targetPackage="com.wareic.model" targetProject="wareic/src/main/java" />  
        <!-- 生成的對映檔案報名和位置 -->  
        <sqlMapGenerator targetPackage="com.wareic.mapper" targetProject="wareic/src/main/java" />  
        <!-- 生成DAO的包名和位置 -->  
        <javaClientGenerator targetPackage="com.wareic.mapper" targetProject="wareic/src/main/java" type="XMLMAPPER" />  
        <!-- 要生成的那些表(更改tableName 和domainObjectName 就可以了) -->  
        <table schema="db_wareic" tableName="t_product" domainObjectName="Product" enableCountByExample="false" enableUpdateByExample="false"  
            enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false">  
           <!--  <columnOverride column="FILMID" property="FILMID" />   -->
        </table>  
    </context>  
</generatorConfiguration>

2.執行startUp型別中的main函式

3.MyBatis Generator官網: http://www.mybatis.org/generator/

 

---------------------
作者：王衛東
來源：CSDN
原文：https://blog.csdn.net/wwd0501/article/details/76618363
版權宣告：本文為博主原創文章，轉載請附上博文連結！

相關推薦

mybatis-generator資料庫註釋實體類生成以及generatorConfig檔案配置

專案裡新建表時model,mapper以及mapper.xml基本都是用Mybatis Generator(以下簡稱為MBG)自動生成的,但是MBG自動生成的model的註釋實在有點非人類,至少中國人是完全接受不了的,在配置中禁用掉註釋吧,倒是簡單了,可是生成的model類光禿禿的,啥都沒有,欄位方法沒有註釋

Mybatis最入門---代碼自動生成（generatorConfig.xml配置）

pack ces war map serial file 用戶名 clip 英文 第一種方式：通過Main方法執行配置文件。 --------------------------------------------------------------------------

mybatis generator為實體類生成自定義註釋（讀取資料庫欄位的註釋新增到實體類，不修改原始碼）

我們都知道mybatis generator自動生成的註釋沒什麼實際作用，而且還增加了程式碼量。如果能將註釋從資料庫中撈取到，不僅能很大程度上增加程式碼的可讀性，而且減少了後期手動加註釋的工作量。 1、首先定義註釋生成外掛 package com.cmbc.datapla

mybatis generator為實體類生成自定義註釋（讀取數據庫字段的註釋添加到實體類，不修改源碼）

super() .cn setter www. nts art pca target private 我們都知道mybatis generator自動生成的註釋沒什麽實際作用，而且還增加了代碼量。如果能將註釋從數據庫中撈取到，不僅能很大程度上增加代碼的可讀性，而且減少了後期

springboot使用mybatis-generator-maven-plugin外掛自動生成mybatis實體類與mapper

前面寫過mybatis-plus，也可以使用它進行mapper生成，目前覺得使用mapper會帶來特別多麻煩，並沒有深入研究，有興趣的同鞋可以看官網檢視教程。寫mybatis-generator-maven-plugin原因是，以前使用過，留此先做個筆記。 首先就是在maven配置檔案中新增

MyBatis Generator工具使用(自動生成實體類、SQL定義檔案、Mapper介面)

建立一個ovls-generator工程 核心是MyBatis Generator(它可以生成POJO(實體類)和sql.xml及sql方法和mapper(DAO介面)) 一.導包 mysql-connector-java mybatis mybatis-generator-co

MyBatis Generator (MBG)，如何實現生成的程式碼，對應的類和 mapper 檔案保持與對應的表名大小寫不變

本文對應的示例程式碼，已託管到 github：mybatis-generator 需求場景 首先，我專案的 Java 程式碼規範是變數命名應用駝峰式命名法（Camel-Case）。資料庫表名及欄位名，則用下劃線命名法（即用下劃線分隔不同單詞）。 我用 MBG 生成的程式

MyBatis反向生成Java實體類和Mapper對映檔案

首先在maven中新增 mybatis-generator-maven-plugin 外掛 <plugin> <groupId>org.mybatis.generator</groupId> <ar

使用EF CodeFirst根據實體類生成資料庫

EF CodeFirst 建立資料庫 很多時候，一個專案只有模型層或者某幾個模型類，沒有資料庫指令碼，想建立資料庫來執行專案，只能一個個敲SQL建表語句或圖形化操作，十分耗時間，也很費腦細胞， 最近發現可以利用EF 裡的自動建立資料庫的功能，可以節約不少時間

mybatis 自動生成實體類、mapper.xml檔案

tip： mybatis-generator不支援一對多、多對多對映，需要額外新增 在maven pom中新增 mybatis外掛 <!-- mybatis生成DAO外掛 --> <plugin> <groupId>org.mybat

JFinal極速開發框架使用筆記(四) _JFinalDemoGenerator實體類生成及映射自動化

checked rem 獲取 fig res ner constant 生成器 項目 運行_JFinalDemoGenerator生成實體類和映射之前的項目結構： 運行之後： 生成和改變的文件： 實體類： package com.wazn.model; import

mybatis-generator-maven-plugin外掛自動生成程式碼的配置方法

1. 第一步，在pom檔案中引入如下外掛   //專案示例程式碼： <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-g

【MyBatis Generator】程式碼自動生成工具 generatorConfig.xml配置檔案詳解

MyBatis Generator官網地址：http://www.mybatis.org/generator/index.html MyBaris Generator中文地址：http://mbg.cndocs.ml/ 在MBG中，最主要也最重要的，就是generatorConfig.xml

MyBatisPlus 如何忽略資料庫和實體類之間的對映欄位

引用處： https://www.cnblogs.com/jym-sunshine/p/9540428.html mybatis-plus使用物件屬性進行SQL操作，經常會出現物件屬性非表字段的情況，忽略對映欄位時可以在實體類屬性上使用以下註解： @TableField(exist&nb

MyBatis Generator元件學習（反向生成） - 20181126

一.引言 MyBatis-Plus（簡稱MP）是MyBatis增強工具，在原來基礎上不做改變，為簡化開發、提高效率而生。 MyBatis Generator 是MyBatis 官方出品的一款，用來自動生成MyBatis的 mapper、dao、entity 的框架，讓我們省

在Eclipse下手動搭建SSH框架，並使用Hibernate外掛反向生成實體類和關係對映檔案。

寫在前面： 接觸SSH框架有一段時間了。在整合實戰的過程中遇到了各種各樣的問題，最後都一一解決了。 下面記錄一個SSH框架整合實戰的小演示，這個演示旨在記錄學習SSH框架的艱辛過程。 重點知識： 1，在Eclipse中下手動搭建SSH框架，並把SessionFac

Mybatis Generator（MBG）自動生成dao，entity ，mapper.xml對映

1.在pom.xml中引入依賴 <!--mybatis-generator 自動生成工具--> <dependency> <groupId>org.mybatis.generator

關於mybatis-generator中文註釋 亂碼解決

具體怎麼實現用mybatis-generator實現，可以參照：http://blog.csdn.net/gufeng672/article/details/27196347 中文註釋亂碼的原因是，mybatis-generator輸出檔案使用jdk的預設編碼，而一般jd

MyBatis Generator產生的Example類

http://openwares.net/database/mybatis_generator_example.html Example類用於構造複雜的篩選條件。 基本概念 Criterion Criterion是最基本,最底層的Where條件，用於欄位級的篩選，fe

maven+mybatis+mybatis-generator+sql server 2005自動生成程式碼，加上自定義分頁外掛和批量插入更新外掛

第一步：準備需要的jar包。由於maven只要配置pom.xml就可以從倉庫下載jar包。因此我們首先配置pom.xml。 注意com.microsoft.sqlserver需要自己加入maven倉庫的。 <dependencies> ......