SSM中使用通用mapper

用过 MyBatis Generator(以下简称MBG)插件的都知道，使用该插件可以很方便的生成实体类、Mapper接口以及对应的XML文件。

本文是基于SSM（Spring+SpringMVC+MyBatis）的webapp工程，讲解如何使用通用mapper，加速开发，解决原生MyBatis的不足。

对通用mapper不熟的，可以阅读：https://www.jianshu.com/p/5f84624e96bc

---

如果要使用MyBatis Generator(MBG)插件，需要在pom.xml中添加mybatis-generator-maven-plugin插件，并引入插件依赖mybatis-generator-core。

 <!-- Mybatis Generator依赖 --> <dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-core</artifactId> <version>1.3.7</version> <scope>compile</scope> <optional>true</optional> </dependency> 

<!--添加maven插件 （mybatis-generator）--> <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.3.6</version> <configuration> <configurationFile>${basedir}/src/main/resources/generator/generatorConfig.xml</configurationFile> <overwrite>true</overwrite> <verbose>true</verbose> </configuration> <dependencies> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>${mysql.version}</version> </dependency> <dependency> <groupId>tk.mybatis</groupId> <artifactId>mapper</artifactId> <version>${mapper.version}</version> </dependency> </dependencies> </plugin> 

pom.xml中添加MBG插件

ssm-mapper工程的完整pom.xml见：https://github.com/ljheee/my-ssm-mapper/blob/master/pom.xml

可以看到mybatis-generator-maven-plugin插件中的<configuration>引用了一个generatorConfig.xml。

generatorConfig.xml也是MBG最重要的配置文件。

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> <!--generatorConfig.xml文件，命名必须是这个名字--> <properties resource="jdbc.properties"/> <!--MyBatis3Simple表示不生成Example，flat表示一张表生成一个POJO--> <context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat"> <property name="beginningDelimiter" value="`"/> <property name="endingDelimiter" value="`"/> <!--引入通用mapper的支持--> <plugin type="tk.mybatis.mapper.generator.MapperPlugin"> <property name="mappers" value="tk.mybatis.mapper.common.Mapper"/> <property name="caseSensitive" value="true"/> </plugin> <jdbcConnection driverClass="${jdbc.driver}" connectionURL="${jdbc.url}" userId="${jdbc.username}" password="${jdbc.password}"> </jdbcConnection> <!--java 代码方式生成时，不能引用其他配置--> <!--<jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"--> <!--connectionURL="jdbc:mysql://localhost:3306/test?useUnicode=true"--> <!--userId="root"--> <!--password="12345678">--> <!--</jdbcConnection>--> <javaModelGenerator targetPackage="com.ljheee.tk.model" targetProject="src/main/java"/> <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources"/> <javaClientGenerator targetPackage="com.ljheee.tk.mapper" targetProject="src/main/java" type="XMLMAPPER"/> <table tableName="user_info"> <generatedKey column="id" sqlStatement="JDBC"/> </table> </context> </generatorConfiguration> 

该generatorConfig.xml配置文件，命名必须是这个名字。

它的根节点<generatorConfiguration>，包含以下子元素（有严格的顺序）：
1. <properties> (0个或1个)
2. <classPathEntry> (0个或多个)
3. <context> (1个或多个)

<properties resource="jdbc.properties"/>
引入数据库连接的信息。

<classPathEntry location="E:\mysql\mysql-connector-java-5.1.29.jar"/>
这个元素的作用是将MBG运行时需要用到的jar包(或zip格式)添加到classpath下。

<context>是最重要的节点，它有几个可选属性：

• defaultModelType:这个属性很重要，这个属性定义了MBG如何生成实体类。这个属性有以下可选值：

  • conditional:这是默认值,这个模型和下面的hierarchical类似，除了如果那个单独的类将只包含一个字段，将不会生成一个单独的类。 因此,如果一个表的主键只有一个字段,那么不会为该字段生成单独的实体类,会将该字段合并到基本实体类中。

  • flat:该模型为每一张表只生成一个实体类。这个实体类包含表中的所有字段。这种模型最简单，推荐使用。

  • hierarchical:如果表有主键,那么该模型会产生一个单独的主键实体类,如果表还有BLOB字段， 则会为表生成一个包含所有BLOB字段的单独的实体类,然后为所有其他的字段生成一个单独的实体类。 MBG会在所有生成的实体类之间维护一个继承关系。

• targetRuntime:此属性用于指定生成的代码的运行时环境。该属性支持以下可选值：

  • MyBatis3:这是默认值

  • MyBatis3Simple

  • Ibatis2Java2

  • Ibatis2Java5 一般情况下使用默认值即可，有关这些值的具体作用以及区别请查看中文文档的详细内容。

• introspectedColumnImpl:该参数可以指定扩展org.mybatis.generator.api.IntrospectedColumn该类的实现类。该属性的作用可以查看扩展MyBatis Generator。

一般情况下，我们使用如下的配置即可：
<context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">

MyBatis3Simple表示不生成Example，flat表示一张表生成一个POJO。

<context>下的子节点

javaModelGenerator指定POJO 生成后的存放路径
<javaModelGenerator targetPackage="com.ljheee.tk.entity" targetProject="src/main/java"/>

sqlMapGenerator指定Mapper.xml存放路径
<sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources"/>

javaClientGenerator指定 PojoMapper.java接口 存放路径
<javaClientGenerator targetPackage="com.ljheee.tk.mapper" targetProject="src/main/java" type="XMLMAPPER"/>

table指定逆向工程，要从哪个数据库表中生成，可有多个
<table tableName="user_info">
<generatedKey column="id" sqlStatement="JDBC"/>
</table>

执行MBG，生成代码

1、Maven运行MBG

在pom.xml中完成MBG插件配置的，Maven插件列表就会出现mybatis-generator，点击运行即可，如下图：

除此之外，没有添加MBG插件配置的，还可以使用Java编码方式运行MBG。

2、使用Java编码方式运行MBG

Java代码很容易。这种方式，一定确保pom.xml中加入了mybatis-generator-core依赖。

List<String> warnings = new ArrayList<String>(); boolean overwrite = true; ConfigurationParser cp = new ConfigurationParser(warnings); Configuration config = cp.parseConfiguration( Generator.class.getResourceAsStream("/generator/generatorConfig.xml")); DefaultShellCallback callback = new DefaultShellCallback(overwrite); MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings); myBatisGenerator.generate(null); 

你只需要在你当前的项目中创建一个类，添加一个main方法，在main中写上上面的代码即可。

3、使用Maven命令运行MBG

在pom.xml这一级目录的命令行窗口执行mvn mybatis-generator:generate即可（前提是配置了mvn）。

完整工程：https://github.com/ljheee/my-ssm-mapper
Spring+SpringMVC+MyBatis+通用mapper
使用druid数据库连接池。
极简版-脚手架工程。