springboot + tk.mybatis

一、配置文件

1、yml文件增加（其他例如：mybatis配置和datasource配置等均不变），如果基本配置的话，以下这两个也不用增加

mapper:
    mappers: com.common.dao
    not-empty: false
    identity: MYSQL

pagehelper:
    helperDialect: mysql
    reasonable: true
    supportMethodsArguments: true
    params: count=countSql

2、pom.xml

<dependency>
    <groupId>tk.mybatis</groupId>
    <artifactId>mapper-spring-boot-starter</artifactId>
    <version>2.0.0</version>
</dependency>
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>1.1.1</version>
</dependency>

使用generator自动生成代码

<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.5</version> # 1.3.6就报错了
    <configuration>
        <configurationFile>....../generator.xml</configurationFile>
        <overwrite>true</overwrite>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.34</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.5</version>
        </dependency>
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper</artifactId>
            <version>3.4.0</version>
        </dependency>
    </dependencies>
</plugin>

3、generator配置文件网上有完整的，这里我贴上来一个我自己的，这个使用tk.mybatis的插件，生成的实体类会包含注解：

<?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>
    <properties resource="generator.properties"/> #这里记录了数据库连接

    <context defaultModelType="flat" id="mysql" targetRuntime="MyBatis3Simple">
        <!-- 生成的Java文件的编码 -->
        <property name="javaFileEncoding" value="UTF-8"/>
        <!-- 生成根Mapper，用户可以看后边代码 -->
        <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
            <property name="mappers" value=".目录.BaseMapper"/>
        </plugin>

        <jdbcConnection driverClass="${driverClassName}"
                        connectionURL="${url}"
                        userId="${username}" password="${password}">
        </jdbcConnection>

        <javaModelGenerator targetPackage="com.common.model.auto"
                            targetProject="src/main/java">
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <sqlMapGenerator targetPackage="mybatis.auto"
                         targetProject="src/main/resources">
        </sqlMapGenerator>

        <!--
            1，ANNOTATEDMAPPER：会生成使用Mapper接口+Annotation的方式创建（SQL生成在annotation中），不会生成对应的XML；
            2，XMLMAPPER：会生成Mapper接口，接口完全依赖XML；
        -->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.common.dao.auto"
                             targetProject="src/main/java">
        </javaClientGenerator>

        <table schema="" tableName="t_city" domainObjectName="TcityEntity"></table>
        ......
    </context>
</generatorConfiguration>

项目内使用maven命令：mybatis-generator:generate -e

二、运行代码

1、mapper.xml

现在xml生成的里面均不包含sql语句了，其实我测试了删除这个xml也行，实体类已经有了表、主键、列注解，使用tk.mysql即可。

2、mapper.java

根mapper如下：

import tk.mybatis.mapper.common.Mapper;
import tk.mybatis.mapper.common.MySqlMapper;

// 继承的这2个里面就包含了crud、以及分页、条件查询的所有组件了
public interface BaseMapper<T> extends Mapper<T>, MySqlMapper<T>{
}

其他继承主mapper的mapper文件如下：

public interface TcityEntityMapper extends BaseMapper<TcityEntity> {
}

3、controller

代码如下：

import com.github.pagehelper.PageHelper;
import tk.mybatis.mapper.entity.Example;
......

@RestController
@RequestMapping("/city")
public class CityController {

    @Autowired
    private TcityEntityMapper cityDao;

    @RequestMapping("add")
    public Object add() {
        TcityEntity entity = new TcityEntity();
        entity.setId(100000);
        entity.setCityName("test");
//        cityDao.insert(entity);

        # 返回主键
        int i = cityDao.insertUseGeneratedKeys(entity);
        return i;
    }

    # 简单测试主键查询
    @RequestMapping("/simple")
    public Object simple(){
        return cityDao.selectByPrimaryKey(1);
    }

    @RequestMapping("/tk")
    public Object tk() {
        //分页，根据默认配置
        int page = 1;
        int pageSize = 5;
        PageHelper.startPage(page, pageSize);

        // tk.mybatis有一个内置的example类
        Example example = new Example(TcityEntity.class);
        example.setOrderByClause("id desc");

        Example.Criteria criteria = example.createCriteria();
        criteria.andBetween("id", 0, 100);
        example.and(criteria);

        return cityDao.selectByExample(example);
    }
}

访问：http://localhost:8080/city/tk
结果：

[{“id”:100,”cityCode”:”331100”,”cityName”:”x”,”provCode”:”330000”,”py”:”L”,”isDelete”:false,”sort”:null,”updateTime”:1449553403000},{“id”:99,……}]

四、其他问题

Application方法增加了@MapperScan(“mapper目录”)，但是仍旧是扫描不到，无论是引入
import org.mybatis.spring.annotation.MapperScan;
还是
import tk.mybatis.spring.annotation.MapperScan;
均不行。

引入tk.mybatis的MapperScan报范型转型错误，引入org则报找不到mapper文件，也是奇怪了。

网上的解决案例：https://yq.aliyun.com/articles/5831 ，我没有试验。这个是通过java文件配置，因为这个是简单配置，就单纯使用yml配置了，所以就暂时不改了。

测试成功的朋友帮忙告诉我一声。