MyBatis Generator 快速入門指南

啟動說明

java -jar mybatis-generator-core-x.x.x.jar -configfile \temp\generatorConfig.xml -overwrite

原始碼方式：執行ShellRunner檔案

聯絡人：Nick 953374957

原始碼修改記錄

修改記錄：

1、Mapper.xml空格改成四個空格
修改詳情：

org.mybatis.generator.api.dom.OutputUtilities

mybatis-generator 裡面我覺得首先最應該改的就是 OutputUtilities 這個類，它裡面有個 xmlIndent 方法是用來控制生成的 xml 檔案中空格的縮排，預設是兩個空格
但四個空格對於我們來說已經深入骨髓了，所以必須改。 在 sb.append
 
( "  " ) 裡面增加兩個空格就可以了。 

2、修改dao包下的名稱，由原來的XXXMapper改成XXXDao
修改詳情：
org.mybatis.generator.api.IntrospectedTable

calculateJavaClientAttributes方法(大概820行)
 sb.append("Mapper");註釋掉改成 sb.append("Dao");

3、修改Mybatis的Model生成JavaDoc註釋內容：
1)generatorConfig.xml配置裡面設定成：<property name="suppressAllComments" value="false"
 
/>
程式碼修改詳情：
org.mybatis.generator.internal.DefaultCommentGenerator裡面的添加註釋程式碼去掉，改成

------------------------------ code start ----------------------------------------
field.addJavaDocLine("/**");
field.addJavaDocLine(" * @Fields "+field.getName()+" "+introspectedColumn.getRemarks());
field.addJavaDocLine
 
(" */");

------------------------------ code end ---------------------------------------------

4、org.mybatis.generator.internal.DefaultCommentGenerator修改XXXDao.java(XXXMapper.java)的介面方法的Javadoc註釋
搜尋org.mybatis.generator.internal.DefaultCommentGenerator如下方法，並註釋方法裡面內容，
public void addGeneralMethodComment(Method method,
            IntrospectedTable introspectedTable)

改成：

method.addJavaDocLine("/**");
method.addJavaDocLine(" * @Title " + method.getName());
for (Parameter parameter : method.getParameters()) {
     method.addJavaDocLine(" * @param " + parameter.getName());
}
String returnType = method.getReturnType().toString();
returnType = returnType.lastIndexOf(".") != -1 ? returnType.substring(returnType.lastIndexOf(".") + 1) : returnType;
method.addJavaDocLine(" * @return " + returnType);
method.addJavaDocLine(" */");

5、註釋掉Model裡面Getter和Setter方法的註釋，根據需要自己加上配置
搜尋org.mybatis.generator.internal.DefaultCommentGenerator如下方法：
public void addGetterComment(Method method,
            IntrospectedTable introspectedTable,
            IntrospectedColumn introspectedColumn)

public void addSetterComment(Method method,
            IntrospectedTable introspectedTable,
            IntrospectedColumn introspectedColumn)

6、註釋掉Mapper.xml裡面的<!-- 註釋 -->,實際使用未用到
搜尋org.mybatis.generator.internal.DefaultCommentGenerator如下方法：
public void addComment(XmlElement xmlElement) 

7、XML裡面每個SQL增加一個換行
org.mybatis.generator.api.dom.xml.XmlElement裡面getFormattedContent裡面加上：
if(indentLevel == 1) {
    //每個insert/update/select之間插入一個空行
    OutputUtilities.newLine(sb);
}

8、修改mybatis的mapper.xml檔案裡面insert和update不根據欄位判斷的非動態SQL
org.mybatis.generator.codegen.mybatis3.xmlmapper.XMLMapperGenerator
裡面的getSqlMapElement方法

註釋掉：
addInsertElement(answer);
addUpdateByPrimaryKeyWithoutBLOBsElement(answer);

對應的是mapper.xml裡面的
<insert id="insert" parameterType="xxx" ></insert>
<update id="updateByPrimaryKey" parameterType="xxx" ></update>

原始碼修改之後，使用說明


<property name="suppressAllComments" value="false"/>配置生成註釋，預設註釋已經修改
javaModelGenerator裡面targetProject可以配置非src，以便於區分原始碼和業務程式碼，如：targetProject="target"
table裡面配置整合的父類可用，該屬性也可以再javaModelGenerator裡面配置公用
<property name="rootClass" value="xxx.BaseModel"/>
table裡面配置插入返回主鍵配置<generatedKey column="id" sqlStatement="MySql" identity="true"/>