Mybatis-generator源码学习和修改

╰半夏微凉° 2022-09-24 14:22 172阅读 0赞

# MyBatis Generator 快速入门指南 #

参考：  
mybatis配置说明：[http://generator.sturgeon.mopaas.com/index.html][http_generator.sturgeon.mopaas.com_index.html]  
大象修改博客：[http://www.blogjava.net/bolo/archive/2015/03/25/423826.html][http_www.blogjava.net_bolo_archive_2015_03_25_423826.html]  
Mybatis-Generator详细配置：[http://www.jianshu.com/p/e09d2370b796][http_www.jianshu.com_p_e09d2370b796]

## 启动说明 ##

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

源码方式：运行ShellRunner文件

修改后源码下载地址：[https://github.com/wu6660563/MybatisGenerator][https_github.com_wu6660563_MybatisGenerator]

联系人：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"/>`

[http_generator.sturgeon.mopaas.com_index.html]: http://generator.sturgeon.mopaas.com/index.html
[http_www.blogjava.net_bolo_archive_2015_03_25_423826.html]: http://www.blogjava.net/bolo/archive/2015/03/25/423826.html
[http_www.jianshu.com_p_e09d2370b796]: http://www.jianshu.com/p/e09d2370b796
[https_github.com_wu6660563_MybatisGenerator]: https://github.com/wu6660563/MybatisGenerator