MyBatis学习笔记——逆向工程之代码生成器

MyBatis Generator

代码生成器，顾名思义，就是帮你生成一些代码，从数据库分析表，生成Bean类、Mapper接口、Mapper XML。

加入Jar依赖

pom.xml加入如下依赖：

        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.7</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.7</version>
        </dependency>

当然，如果只是使用Maven作为Jar包管理，而不是构建，则只需要上面的依赖即可。

MyBatis Generator Config

代码生成需要配置一些参数和规则。

<?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>

    <!-- targetRuntime="MyBatis3Simple":生成简单版的CRUD -->
    <context id="DB2Tables" targetRuntime="MyBatis3Simple">

        <!-- jdbcConnection:指定如何连接到目标数据库 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
            connectionURL="jdbc:mysql://localhost:3306/mybatis" userId="root"
            password="root">
        </jdbcConnection>

        <!-- Java类型解析器: -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <!-- javaModelGenerator:指定javaBean的生成策略 -->
        <!-- targetPackage="com.shen.mybaties.bean",目标包名 -->
        <!-- targetProject=".\src\main\java",目标工程 -->
        <javaModelGenerator
            targetPackage="com.shen.mybaties.bean"
            targetProject=".\src\main\java">
            <property name="enableSubPackages" value="true" />
            <property name="trimStrings" value="true" />
        </javaModelGenerator>


        <!-- sqlMapGenerator:sql映射生成策略 -->
        <sqlMapGenerator targetPackage="com.shen.mybaties.dao"
            targetProject=".\src\main\conf">
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>

        <!-- javaClientGenerator:指定mapper接口的位置 -->
        <javaClientGenerator type="XMLMAPPER"
            targetPackage="com.shen.mybaties.dao"
            targetProject=".\src\main\java">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>

        <!-- 指定逆向分析哪些表,根据表要创建javaBean -->
        <!-- domainObjectName:生成的javaBean类名 -->
        <table tableName="tbl_employee" domainObjectName="Employee"></table>
        <table tableName="tbl_dept" domainObjectName="Department"></table>

    </context>
</generatorConfiguration>

几个重要的属性：
（1）context，其中的targetRuntime重要，配置生成的代码版本（类型）。
（2）jdbcConnection，指定如何连接到目标数据库，配置一些数据库连接的参数。
（3）javaModelGenerator，生成javaBean的策略，配置生成到哪个包下，在哪个工程下。
（4）sqlMapGenerator，生成sql映射的策略，配置生成到哪个包下，在哪个工程下。
（5）javaClientGenerator，生成Mapper接口的策略，配置生成到哪个包下，在哪个工程下。
（6）table，指定分析哪些表，哪些表需要逆向生成代码。其中的属性domainObjectName是指定该表对应的JavaBean的类名。
具体参考：配置详情查看官网

使用代码生成器

maven

若使用Maven，默认命名为generatorConfig.xml，且需要放在/src/main/resources下;若需要修改，则在POM中使用configurationFile指定位置。示例如下：

    <build>
        <resources>
            <resource>
                <directory>${basedir}</directory>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.7</version>
                <configuration>
                    <configurationFile>mbg_plus.xml</configurationFile>
                    <overwrite>true</overwrite>
                    <verbose>true</verbose>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>5.1.38</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>

注意：directory：指定属性文件的目录，build的过程需要找到它，并且将其放到targetPath下，默认的directory是${basedir}/src/main/resources。
这里我们改成工程根目录。
使用mybatis-generator:generate执行代码生成。

java代码执行

如果不使用Maven生成，使用基于配置文件的Java代码生成，则可以随意起名，代码中找的到就好。
下面采用的是基于Java代码的形式，代码如下：

        List<String> warnings = new ArrayList<String>();
        boolean overwrite = true;
        File configFile = new File("mbg.xml");
        ConfigurationParser cp = new ConfigurationParser(warnings);
        Configuration config = cp.parseConfiguration(configFile);
        DefaultShellCallback callback = new DefaultShellCallback(overwrite);
        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        myBatisGenerator.generate(null);

其中需要做修改的是configFile的路径。

其他方式

其他生成方式参考：http://www.mybatis.org/generator/running/running.html

执行结果

代码生成器会按照我们的配置，执行生成代码，这里使用的targetRuntime=MyBatis3。

测试带条件的复杂查询

都建立在targetRuntime=MyBatis3的基础上。
（1）场景一：查询所有员工信息

    @Test
    public void testMyBatis3() throws IOException {
        SqlSessionFactory sqlSessionFactory = getSqlSessionFactory();
        SqlSession openSession = sqlSessionFactory.openSession();
        try {
            EmployeeMapper mapper = openSession.getMapper(EmployeeMapper.class);
            // xxxExample就是封装查询条件的
            // 查询所有,传入null,即可
            List<Employee> emps = mapper.selectByExample(null);
            for (Employee emp : emps) {
                System.out.println(emp);
            }
        } finally {
            openSession.close();
        }
    }

（2）场景二：带有条件的查询

    @Test
    public void testMyBatis3() throws IOException {
        SqlSessionFactory sqlSessionFactory = getSqlSessionFactory();
        SqlSession openSession = sqlSessionFactory.openSession();
        try {
            EmployeeMapper mapper = openSession.getMapper(EmployeeMapper.class);
            // 封装员工查询条件的example
            EmployeeExample example = new EmployeeExample();
            // 创建一个Criteria,这个Criteria就是封装查询条件的
            Criteria criteria = example.createCriteria();
            criteria.andLastNameLike("%e%");
            criteria.andGenderEqualTo("0");

            Criteria criteria2 = example.createCriteria();
            criteria2.andEmailLike("%t%");

            Criteria criteria3 = example.createCriteria();
            criteria3.andGenderEqualTo("1");

            example.or(criteria2);
            example.or(criteria3);

            List<Employee> emps = mapper.selectByExample(example);

            for (Employee emp : emps) {
                System.out.println(emp);
            }
        } finally {

上面的会发出select id, last_name, gender, email, d_id from tbl_employee WHERE ( last_name like ? and gender = ? ) or( email like ? ) or( gender = ? )
且传入的参数为%e%(String), 0(String), %t%(String), 1(String)
所有的And语句都拼在第一个Criteria中，如果要加或语句，则封装在新的Criteria，然后将两个Criteria用Or连接。