MyBatis Generator (MBG)，修改源码以适应 MySQL 大小写敏感配置的各种情况、适应分表时动态替换表名
本文对应的项目
- github: https://github.com/uncleAndyChen/mybatis-generator
- gitee: https://gitee.com/uncleAndyChen/mybatis-generator
本文实现方式是修改 MyBatis Generator 源码，最新的实现方式是通过 MyBatis Generator 扩展来实现，点击前往。
通过本项目，可以学到的知识点
- 可以理解使用MBG的大致流程。
- 本文中用到的MBG配置可以作为一个标准配置的参考。
- spring boot 2.1.1 获取 application.yml 配置信息，项目【create-table-property】是一个很好的参考。
- 通过MBG如何生成dal与model项目。
- 生成的代码，绝大部分可直接使用，比如简单的增、删、改、查。
- 对应数据库表的实体类，一张表一个实体类，可用于在各层传递基于表数据的业务数据。
- 通过 IDEA 管理多项目。
- 获取项目源码，用 IDEA 导入的时候，指向根目录的 pom.xml 即可。
先了解一下 lower_case_table_names 参数
官方文档：Identifier Case Sensitivity
- lower_case_table_names是mysql一个大小写敏感设置的属性，此参数不可以动态修改，必须重启数据库。
- unix,linux下lower_case_table_names默认值为 0 .Windows下默认值是 1 .Mac OS X下默认值是 2。
参数说明
lower_case_table_names=0表名存储为给定的大小写。比较时：区分大小写。大小写敏感（Unix，Linux默认）。
创建的库表将原样保存在磁盘上。如create database TeSt;将会创建一个TeSt的目录，create table AbCCC …将会原样生成AbCCC.frm。SQL语句也会原样解析。
lower_case_table_names=1表名存储为小写。比较时：不区分大小写。大小写不敏感（Windows默认）。
创建的库表时，MySQL将所有的库表名转换成小写存储在磁盘上。SQL语句同样会将库表名转换成小写。如需要查询以前创建的Test_table（生成Test_table.frm文件），即便执行select * from Test_table，也会被转换成select * from test_table，致使报错表不存在。
lower_case_table_names=2表名存储为给定的大小写。比较时：小写。
创建的库表将原样保存在磁盘上。但SQL语句将库表名转换成小写。
不适用场景
如果开发环境、生产环境均配置成1或者2，则本文中有关大小写敏感的修改都是无意义的。
但是如果分库时依赖表名替换，则又是适用的，见以下【适用场景】中的场景二。
适用场景
最终目标：MBG 生成的xml文件中的sql脚本的表名，保持与对应表名在建表时的大小写一致，保持大小写敏感（表名可在MBG需要的配置文件中配置，以该配置为准）。这样可以适应以上lower_case_table_names的三种配置值。
为了达到以上目标，运行生成表配置内容的项目，一定要连接参数lower_case_table_names配置为0或者2的数据库服务器，并且是配置为0或者2之后才创建的数据表，否则，生成的表配置内容的表名，是以全部小写为基准的，并非驼峰式命名法。表配置内容生成好之后，重新生成 mapper 时连接的数据库服务器的lower_case_table_names配置值，对生成结果没有影响。
场景一
- 其中有数据库服务器被设置成大小写不敏感（比如阿里云的云数据库，截至目前2018年12月9号，还不支持配置成大小写敏感），即
lower_case_table_names=1，且该参数不能修改。 - 为了统一命名规范使用驼峰式命名法，包括：数据库名、数据库表名、数据库字段名、编程语言。这样的话，可以控制
lower_case_table_names的linux服务器，就可以将该参数设置为0，即大小写敏感。 - 用 MGB 生成的 Mapper 类名，以及 xml 文件中的表名，需要与创建表名时的原始大小写一致，以适应在
lower_case_table_names=0（linux）或者lower_case_table_names=2（windows）的情况。
当然，读到这里，你可能会觉得奇怪，数据库的库名、表名、字段名，业界都是用下划线分开的，其余字母全是小写，所以，该参数被配置成什么都不需要关心。
如果你也这么认为，那么，本文对你是没有价值的。
本文要解决的问题是，数据库的库名、表名、字段名，需要保持跟 Java 的编码规范一致的场景。如果都统一成一种编码规则，比如统一用驼峰式命名法，那么，不用在两种编码习惯上切换，可以提高编码效率和减少不必要的麻烦，且继续往下看。
场景二
- 分表，利用MyBatis插件，根据业务规则，对表名进行动态替换。
- 如
erpTrade表分成了120个表，那么在某一次业务操作中，需要将erpTrade替换成erpTrade_xyz，其中xyz为从001到120的其中一个数字，则需要将MBG生成的xml里sql脚本中的表名用 `（左上角数字键1左边、Tab键上边、Esc键下边的键）引起来。
将会分享我的基于 MyBatis 插件分库分表项目。
需求场景
- 首先，我项目的 Java 代码规范是变量命名应用驼峰式命名法（Camel-Case）。数据库表名及字段名，则用下划线命名法（即用下划线分隔不同单词）。
- 我用 MBG 生成的代码，通过配置可以将下划线去掉，同时将下划线后的第一个字母转为大写，这样是符合驼峰式命名法的。
- 但是，问题来了。我们项目前后端分离，前端调用 Restful Api，在传递的参数中难免需要以表名来定义对象，而以字段名作为对象的属性来传递参数，而 Java 写的 Api 在接收参数时，是用 Pojo 来跟前端传的参数匹配的。
- 这样有两个问题，前端在传参数的时候需要将表名和字段名由下划线命名法转为驼峰式命名法，Java 代码也以同样的方式定义对应的类名以及属性字段，在这个过程中，容易出错，相对直接 copy 表名及字段名，需要做额外的工作，而且前后端都有。
- 如果数据库表名和字段名本身就是驼峰式命名法的话，写代码的时候直接 copy 表名或字段名，这样既不容易出错，还能节省时间。说干就干，改！表名及字段名遵循驼峰式命名法。
- 这样做的目的无非是让大家能偷偷懒，还减少出错的概率，同时也轻松的达到了统一代码规范的目的。
- 在windows环境下，如果遇到
lower_case_table_names=1或者该参数未配置（未配置的时候默认为1），运行MBG，生成的sql脚本，全是小写，需要花费额外时间来解决环境问题。 - 为了一劳永逸，有了本文和对应的项目。
- 随着业务发展，到了需要分库分表的时候，本文所解决的问题，更是不可或缺。
解决办法
- 怎么破？查了很多资料，也看了官方文档，都没有找到相应的配置，也就是说，保持数据库表名大小写来生成对应的类和 mapper 文件，是不能通过配置来解决的。
- 只能看源码了。思路是：一步步跟踪，找到了真正取数据库表名的地方。
- 虽然过程比较痛苦，但是达到目的之后，还是小有成就感的。
- 其实改动很少，只是找到要改的地方才是关键。就象平时改 Bug 一样，修改可能很小，但是找到要修改的地方才是最花时间和精力的，每每这个时候，就非常渴求得力的测试人才。
废话少说，下面切入正题。
关于 MBG (MyBatis Generator)
笔者写这篇文章的时候，Release 最新版本是1.3.5（2016年九月7号发布），该版本已经足够满足本文提到的需求了，作者主导的项目均采用该版本。
- 下载地址：MyBatis Generator Release 1.3.5
- 官方文档
关于 MBG 的介绍，看官网文档足够了，本文的重点是修改源代码，让 MBG 在生成的代码里，对应的类和 mapper 文件保持与对应的表名大小写不变。
备注，实现方式已经改为通过扩展来解决问题了，不过，如果需要研究一下源码，还是有必要往下读的。
作为研究，作者去mybatis/generator 官方 github 下载了最新版 V1.3.7（2018年7月5号发布），用最新版重新操作了一遍。
下载的源码文件是generator-mybatis-generator-1.3.7.zip，解压之后，找到目录 generator-mybatis-generator-1.3.7\core\mybatis-generator-core，这个目录就是我们需要的源码目录。该目录下，只保留 src 目录和 pom.xml，其余删除。
用 IDEA 导入项目，如果依赖下载很慢，建议添加阿里云仓库，在 pom.xml，倒数第二行后面、最后一行前面，插入以下内容：
maven-ali
http://maven.aliyun.com/nexus/content/groups/public/
true
true
always
fail
修改源码
才下操作，均针对最新版 v1.3.7。
一共需要修改 org.mybatis.generator.api.IntrospectedTable 这个类的两个方法。
/**
* Gets the fully qualified table name at runtime.
*
* @return the fully qualified table name at runtime
*/
public String getFullyQualifiedTableNameAtRuntime() {
// return internalAttributes
// .get(InternalAttribute.ATTR_FULLY_QUALIFIED_TABLE_NAME_AT_RUNTIME);
return this.getTableConfiguration().getTableName();
}
/**
* Gets the aliased fully qualified table name at runtime.
*
* @return the aliased fully qualified table name at runtime
*/
public String getAliasedFullyQualifiedTableNameAtRuntime() {
// return internalAttributes
// .get(InternalAttribute.ATTR_ALIASED_FULLY_QUALIFIED_TABLE_NAME_AT_RUNTIME);
return this.getTableConfiguration().getTableName();
}
这两个方法里面的前两行注释了的代码是官方的，最后那行代码是修改之后的。
生成对应的类和 mapper 文件
对应的测试数据库脚本
create schema if not exists mbg default character set utf8;
use mbg;
set names utf8;
drop table if exists erpTrade;
create table erpTrade
(
tradeID int not null auto_increment,
tid bigint comment '订单号',
shopID int,
memberID bigint comment '针对的会员ID，同步会员时反写',
buyerNick national varchar(50),
sellerID bigint comment '店铺用户，主旺旺 ID',
primary key (tradeID)
);
drop table if exists erpEnterpriseMember;
create table erpEnterpriseMember
(
memberID bigint not null auto_increment,
shopID int,
nickname varchar(50) comment '会员昵称',
realName varchar(50) comment '真实姓名',
sex int comment '性别 1.男 2.女 3.未知',
created int,
modified int,
primary key (memberID)
);
drop table if exists erpShopConfig;
create table erpShopConfig
(
ID int not null auto_increment,
shopID int,
mobile varchar(200) comment '接收短信手机号，多个以逗号隔开',
email varchar(200) comment '邮箱地址，多个以逗号隔开',
isNotifyBalanceLess int comment '当短信账户余额为X条时，系统免费发送短信提醒您及时充值。',
balanceLessValue int comment '余额不足提醒值',
isNotifyBeforeExpire int comment '是否发送软件快到期提醒',
beforeDaysExpire int comment '软件快到期提醒时间，提前天数',
created int,
modified int,
primary key (ID)
);
生成表配置信息的 Java 工具类
MBG 基于一个 xml 配置文件，在这个配置文件里，有跟表相关的配置，为了达到我的需求，需要一张表对应一行配置信息，所以，我写了一个类来自动生成，这样，在增减表，或者别的项目里面，可以简单的运行这个类来生成，减少手工劳动。
更详细的，请看：https://github.com/uncleAndyChen/mybatis-generator/tree/master/create-table-property
MBG需要的配置文件比较全面的，在工作中实际用到的文件内容如下：
<generatorConfiguration>
<classPathEntry location="mysql-connector-java-5.1.31.jar"/>
<context id="Mysql" targetRuntime="MyBatis3" defaultModelType="flat">
<commentGenerator>
<property name="suppressDate" value="true"/>
<property name="suppressAllComments" value="true"/>
commentGenerator>
<jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://192.168.0.130:3306/mbg?useUnivalue=true&characterEncoding=utf8&autoReconnect=true&failOverReadOnly=false"
userId="root" password="root">
jdbcConnection>
<javaTypeResolver>
<property name="forceBigDecimals" value="false"/>
javaTypeResolver>
<javaModelGenerator targetPackage="mybatis.generator.model.entity" targetProject="mybatis.generator.model/src/main/java/">
<property name="enableSubPackages" value="true"/>
<property name="trimStrings" value="true"/>
javaModelGenerator>
<sqlMapGenerator targetPackage="mappers\original" targetProject="mybatis.generator.dal\src\main\resources">
<property name="enableSubPackages" value="true"/>
sqlMapGenerator>
<javaClientGenerator type="XMLMAPPER" targetPackage="mybatis.generator.dal.mapper"
targetProject="mybatis.generator.dal/src/main/java/">
<property name="enableSubPackages" value="true"/>
javaClientGenerator>
<table tableName="erpEnterpriseMember" domainObjectName="EnterpriseMember"><property name="useActualColumnNames" value="true"/><generatedKey identity="true" type="post" column="memberID" sqlStatement="Mysql"/>table>
<table tableName="erpShopConfig" domainObjectName="ShopConfig"><property name="useActualColumnNames" value="true"/><generatedKey identity="true" type="post" column="ID" sqlStatement="Mysql"/>table>
<table tableName="erpTrade" domainObjectName="erpTrade"><property name="useActualColumnNames" value="true"/><generatedKey identity="true" type="post" column="tradeID" sqlStatement="Mysql"/>table>
context>
generatorConfiguration>
运行 MBG
- 以 IntelliJ IDEA 为例
为了测试，除了从官网下载的 MBG 源码外，另外添加了两个模块。
先创建一个空项目，然后导入 MBG，添加两个测试模块，或者直接从码云下载我的代码。注意模块的包路径要与配置文件里的一致，否则会提示路径找不到。
创建一个空项目
导入模块
直接运行源码
新建一个启动应用，选 MBG 下的 ShellRunner 作为启动入口
按下图所示，在参数一栏写：-configfile generatorConfig.xml -overwrite，选 mybatis-generator-1.3.5 模块
接下来，应该知道如何运行或者调试了吧。
生成 jar 包，一次生成，随处运行
- 将 MBG 打包成 jar 包，把该 jar 包和 mysql-connector-java-5.1.31.jar、generatorConfig.xml 一起放到项目的根目录下，在 dos 窗口，或者 IDEA 的 Terminal 窗口直接运行下面的命令。
java -Dfile.encoding=UTF-8 -cp mybatis-generator-1.3.5.jar org.mybatis.generator.api.ShellRunner -configfile generatorConfig.xml -overwrite
- 推荐用这种方式。这样不需要将 MBG 项目添加到公司的具体项目，而且通常这项工作由某一个人做就行了，其它项目组成员，可以不知道该工具的存在。
下面是生成 MBG jar 包的步骤
按 Ctrl+Alt+Shift+s，进入项目设置界面
生成 MBG jar 包第一步，配置
生成 MBG jar 包第二步，Build Artifacts…
注意事项
- 当表结构发生变化时，需要重新运行 MBG 生成新的代码，所以，生成的代码，不能有修改行为，否则下次重新生成后，改过的代码会被覆盖。
- 重新生成时，*Mapper.xml 文件会被改写错，MBG 没有重新生成该文件，而是改写，这种改写有问题，还没来得及深究。
- 针对第2点的问题，我的解决办法是，重新生成前，将对应的 *Mapper.xml 删掉。如果只生成一张表的代码，则只删除对应的 mapper 文件即可，Pojo 文件重新生成后是正确的，不用管。
- 也可以用下面的脚本简单粗暴的删除全部 xml 文件。反正会重新生成，如果文件内容跟原来一致，不会产生新的 svn/git 提交。需要注意的是，下面的脚本我是在 idea 的 Terminal 窗口执行的，这里的命令语法请保持 linux 风格。这样更省事儿，推荐这种方案，这样不用每次变更某一张表的时候找到对应的表配置，也不用单独去删除对应的 mapper.xml 文件，只要把所有表的配置都操持有效（即不要注释掉）就行，省时省力！
# 注意：*Mapper.xml 文件，每次重新生成都需要先删除，否则部分内容会重复生成，导致错误
del/f/s/q C:\workspace\mbg\mybatis-generator\demo-domain-dal\src\main\java\demo\domain\dal\mapper\original\*.*
del/f/s/q C:\workspace\mbg\mybatis-generator\demo-domain-model\src\main\java\demo\domain\model\entity\*.*
del/f/s/q C:\workspace\mbg\mybatis-generator\demo-domain-dal\src\main\resources\mappers\original\*.xml
java -Dfile.encoding=UTF-8 -cp mybatis-generator-1.3.7.jar;mybatis-generator-enhance.jar org.mybatis.generator.api.ShellRunner -configfile generatorConfig.xml -overwrite
关于作者
- github: https://github.com/uncleAndyChen
- gitee: https://gitee.com/uncleAndyChen
- 个人博客：https://www.lovesofttech.com
- CSDN博客：https://blog.csdn.net/runAndRun
- 邮箱：[email protected]