修改mybatis-generator-1.3.2源码实现自定义代码生成详解（二）

  上一篇对mybatis-generator-core源码的基础修改作了说明，也可以说是最想改的地方，这一篇将在此基础上再做进一步的修改。
  首先说说上一篇最后提到的关于自定义注释的问题，想实现这个功能就需要修改org.mybatis.generator.internal.DefaultCommentGenerator这个类。我将里面一些主要的方法讲下。
  addJavaFileComment(CompilationUnit compilationUnit)
  给Java文件加注释，这个注释是在文件的顶部，也就是package上面。

  addComment(XmlElement xmlElement)
  给生成的XML文件加注释。大象将这个方法清空了，不生成注释。

  addClassComment(InnerClass innerClass,IntrospectedTable introspectedTable)
  Java类的类注释。

请注意红线的getRemarks()方法，这个remarks属性在原来的FullyQualifiedTable里面是没有的，这是大象自己加上去的，就是为了保存表的注释信息。那是在哪里加进去的呢？请看org.mybatis.generator.internal.db.DatabaseIntrospector这个类，大概浏览下就会发现，数据库表以及列的信息读取，类型设置都是由它来完成的，定位到608行，正好这里是个空行，插入几行代码。如下：

  这样我们就取到了表的注释信息，看到这里应该就会明白了吧？
  另外我需要说明的是，想通过databaseMetaData.getTables()来获得表注释的童鞋，这个做法是没用的，大象已经试过了，这个结果集里面的rs.getString("REMARKS")得到的是一个空字符串，什么都木有。而且大象还想吐槽下，网上一大堆说返回的这个结果集是10列，呵呵，是的么？我debug了好久发现它还是只有5列，不知道这10列是从哪来的，请打印出10列的童鞋告之是怎么做的，我用的mysql驱动是5.1.29

  addFieldComment(Field field, IntrospectedTable introspectedTable,IntrospectedColumn introspectedColumn)
  Java属性注释。注释为空就不给属性添加。

  addGetterComment(Method method,IntrospectedTable introspectedTable,IntrospectedColumn introspectedColumn)
  给getter方法加注释。这里添加注释的方法和Field一样，大象把这个方法以及addSetterComment方法都清空了，因为我比较习惯把注释加到属性上面，如果你习惯在getter方法上面加注释可以自行改一下。
  上面这些修改做完后，记得要在org.mybatis.generator.codegen.mybatis3.model.BaseRecordGenerator的61行增加下面这行代码：
  commentGenerator.addClassComment(topLevelClass, introspectedTable);
  因为mybatis-generator源码中本来就是不加类注释的。
  大家都在不同的公司，要求肯定都不一样，大象没法满足所有人，只对该类做了一定程度的修改，姑且把它当做一个示例模板吧，主要是弄明白怎么改就成了。

  mybatis-generator在1.3.2版里对生成xml的namespace作了修改，不再用表名当为namespace的值，而是用包结构+类名+Mapper后缀的形式设置，大象不喜欢这么复杂做法，所以这里需要改一改，只保留类名+Mapper的命名形式。去掉org.mybatis.generator.api.IntrospectedTable类的907行与908行代码。

  接下来再来说说对大对象类型的处理，mybatis-generator默认会把所有jdbcType为：BINARY、BLOB、CLOB、LONGVARBINARY、LONGVARCHAR、VARBINARY这些类型都作为大对象，反应出来的效果就是生成的pojo类会多一个类名+WithBLOBs.java的文件(含有的大对象个数大于1时)，而在XML里面也会增加一个id为ResultMapWithBLOBs的resultMap，它继承BaseResultMap，大象一向喜欢简单的风格，这看得太不爽了。如果你觉得无所谓，不需要修改，请跳过这段往下看。
  表中的text或blob等类型，通过databaseMetaData.getColumns()取出来后，它的rs.getInt("DATA_TYPE")值是与java.sql.Types对应的。
  text类型的值：Types.LONGVARCHAR
  blob类型是值：Types.LONGVARBINARY
  它用org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl解析java类型与jdbc类型，然后设置到org.mybatis.generator.api.IntrospectedColumn的jdbcTypeName属性里，最关键的地方到了，IntrospectedColumn类第156行有个isBLOBColumn()方法，它就是用来判断是否生成xxxWithBLOBs.java和ResultMapWithBLOBs的条件。当然mybatis-generator不会这么直接用，它在里面定义了一个Rules接口，由它来统一进行调用。所以我们只需要把isBLOBColumn()里面的代码都去掉，直接返回false就可以了，再结合配置文件中的columnOverride属性就能达到目的。

  jdbcType指定的值就是生成xml后result里面对应的类型，javaType与生成的pojo里面属性类型一致，这里其实可以不定义javaType，但是当数据库的表字段有的定义为tinyint时，如果不给它指定类型，那么默认生成的java类型就是java.lang.Byte，假如你想转换类型，而且保证不会超出字段类型的大小限制，那么你可以将它的javaType设为java.lang.Integer
  经过这么一番修改之后，输出结果已经比较理想了，但是xml文件看上去还是有点问题，元素与元素之间没空行，看起来好别扭。恩，这里要给它加上空行，所以请找到org.mybatis.generator.api.dom.xml.XmlElement类的getFormattedContent方法，这个方法有个参数：indentLevel，通过名字我们可以很直观的理解它的作用就是来控制缩进等级，它的初始值为0，这表示不缩进，当变成1时就是缩进一级，也即缩进四个空格，后面以此类推，我们应该还注意到，方法内部用到了递归，所以它是从最底元素开始，再一步步返回，所以我们就应该在indentLevel为1的元素后面加上换行。

在生成xml的文件里面，我们看到有一个update元素，id为updateByPrimaryKey，这个基本上用不到，但是你还不能在table里加上enableUpdateByPrimaryKey="false"，如果你这么做，虽然updateByPrimaryKey没有了，但updateByPrimaryKeySelective也会消失。所以这时请看看org.mybatis.generator.codegen.mybatis3.xmlmapper.XMLMapperGenerator这个类，getSqlMapElement()里面，有大量的addXXX方法，这些方法里面每个都用到了Rules规则来处理是否执行，比如我们在table里面加了enableDeleteByExample="false"，它对应的是addDeleteByExampleElement()，而它又调用了introspectedTable.getRules().generateDeleteByExample()方法，再进入到generateDeleteByExample()里面，我们可以看到红线部分，上一篇大象讲过，在加载配置文件的时候，TableConfiguration会将table中的这些属性设置到对应的属性里，所以说其实最后还是回到了判断enableDeleteByExample的布尔值上面。

  上面啰嗦了一大堆，现在再来解决之前提到的问题，如何去掉id为updateByPrimaryKey的update元素，注释掉addUpdateByPrimaryKeyWithoutBLOBsElement()或直接去掉这行代码，跟踪代码你会发现，它和addUpdateByPrimaryKeySelectiveElement()的rules验证里面都用到了enableUpdateByPrimaryKey的值。或者你不想采取我说的这个办法，而是改BaseRules的generateUpdateByPrimaryKeyWithoutBLOBs()，让它直接返回false
  最后大象再唠叨一句，这些addXXX方法的顺序决定了生成xml文件中的元素顺序，所以有代码洁癖的人可以作下调整。
  上一篇加这一篇都是讲怎么少量的改动源码以实现自定义文件输出，写的比较凌乱，不是很系统，完全是从实用的角度出发，关键还是大象水平有限，有什么错误还请大家帮我指出来，谢谢！
  改了这么多，总要看下效果吧，下一篇大象将写个测试看看生成的结果，然后用maven assembly将它打包生成一个zip，它将包含：

本文为菠萝大象原创，如要转载请注明出处。http://www.blogjava.net/bolo

posted on 2015-03-25 16:33 菠萝大象阅读(26552) 评论(0) 编辑收藏所属分类: mybatis-generator

随笔分类(67)

随笔档案(67)

搜索

积分与排名

最新随笔

最新评论

阅读排行榜

评论排行榜


只有注册用户登录后才能发表评论。




网站导航: 博客园 IT新闻 Chat2DB C++博客博问管理
相关文章: 修改mybatis-generator-1.3.2源码实现自定义代码生成详解（三）修改mybatis-generator-1.3.2源码实现自定义代码生成详解（二）修改mybatis-generator-1.3.2源码实现自定义代码生成详解（一）