SpringBoot-整合mybatis

本篇文章主要介绍SpringBoot如何配置数据源、mybatis、mybatis-plus

数据源配置

1、添加数据库驱动(mysql)

<!-- 驱动类 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>

2、添加spring-boot-starter-jdbc

JDBC是Java提供的一种访问数据库的标准规范，通过jdbc访问数据库之前通常需要先获取数据的连接，数据的连接属于耗时操作，一般需要用数据连接池DataSource。DataSource是JDK提供一个标准接口在javax.sql.DataSource
spring-boot-starter-jdbc默认提供了对Hikari的数据库连接池的集成，另外它提供一个JdbcTemplate和事务。

<!-- JdbcTemplate及jdbc事务，默认引用了HikariCP数据源 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
    <version>2.0.5.RELEASE</version>
</dependency>

3、数源库的配置

spring.datasource.driverClassName=com.mysql.jdbc.Driver
spring.datasource.url=
spring.datasource.username=
spring.datasource.password=
# 可选配置，使用什么数据源
spring.datasource.type=com.zaxxer.hikari.hIkari.HikariDatasource

4、Hikari连接池的设置

## 连接池名字 
spring.datasource.hikari.pool-name=MyHikariCP 
## 最小空闲连接数量 
spring.datasource.hikari.minimum-idle=10 
## 空闲连接存活最大时间，默认600000（10分钟） 
spring.datasource.hikari.idle-timeout=600000 
## 连接池最大连接数，默认是10 
spring.datasource.hikari.maximum-pool-size=10 
## 此属性控制从池返回的连接的默认自动提交行为,默认值：true 
spring.datasource.hikari.auto-commit=true 
## 此属性控制池中连接的最长生命周期，值0表示无限生命周期，默认1800000即30分钟 spring.datasource.hikari.max-lifetime=1800000 
## 数据库连接超时时间,默认30秒，即30000 
spring.datasource.hikari.connection-timeout=30000

mybatis集成使用

1、添加mybatis-spring-boot-starter

<!-- mybatis -->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
</dependency>

2、定义与数据库对应的实体对象、数据库访问接口、以及接口的映射xml（如有）

@Data
public class StUser {
    private Long id;
    private Date createTime;
    private Date updateTime;
    private String name;
    private String telephone;
}

public interface StUserDao {
    StUser queryById(Long id);
    Long save(StUser stUser);
}

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="zmx.springboot.dao.StUserDao">

    <sql id="Base_Column_List" >
        id, create_time, update_time, name, telephone
    </sql>

    <select id="queryById" resultType="zmx.springboot.entity.StUser">
        select <include refid="Base_Column_List"/>
        from st_user
        where id = #{id}
    </select>

    <insert id="save" parameterType="zmx.springboot.entity.StUser">
        INSERT INTO st_user (id, create_time, update_time, name, telephone)
        VALUES(#{id}, now(), now(), #{name}, #{telephone});
    </insert>

</mapper>

3、设置mybatis的配置@MapperScan，设置扫描指定包中的mybatis接口，否则需要在每个接口上面标注@Mapper。也可以定义的启动入口Application类中，也可以单独配置。

@Configuration
// 扫描指定包中的接口
@MapperScan("zmx.springboot.dao")
public class MyBatisConfig {

}

4、设置mybatis的mapper映射文件目录和其它的配置信息

# 指定mybatis的mapper映射文件目录
mybatis.mapper-locations=classpath:mapper/*.xml
# 日志输出方式
mybatis.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
# 是否启用下划线与驼峰式命名规则的映射
mybatis.configuration.map-underscore-to-camel-case=true

mybatis-plus集成

mybatis-plus官方文档

1、添加mybatis-plus依赖

<!-- mybatis-plus -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <!-- mybatis-plus内部引用了spring-boot-autoconfigure,它的版本可能比我们spring-boot-starter-web版本要高，建议排掉 -->
    <exclusions>
        <exclusion>
            <artifactId>spring-boot-autoconfigure</artifactId>
            <groupId>org.springframework.boot</groupId>
        </exclusion>
    </exclusions>
</dependency>

有mybatis-plus内部引用了spring-boot-autoconfigure,它的版本可能比我们spring-boot-starter-web版本要高，建议排掉，不然加入依赖后报错@AliasFor nonexistent attribute 'proxyBeanMethods' in annotation，mybatis-plus也引用了mybatis依赖，也可以去掉外部的mybatis信赖配置。

2、配置@MapperScan与mybatis一样

3、添加mybatis-plus的注解、接口（BaseMapper、IService）和基类（ServiceImpl）

@TableName("st_user")
public class StUser {
    @TableId(value = "id", type = IdType.ASSIGN_ID)
    private Long id;
    private Date createTime;
    private Date updateTime;
    private String name;
    private String telephone;
}

public interface StUserDao extends BaseMapper<StUser> {
}

@Slf4j
@Service
public class StUserServiceImpl extends ServiceImpl<StUserDao, StUser> implements StUserService {
}

4、也可以使用mybatis提供的其它功能

/**
 * 自动填充字段
 */
@Bean
public MetaObjectHandler autoFillCreateOrUpdateTimeHandler() {
    return new AutoFillCreateOrUpdateTimeHandler();
}

public class AutoFillCreateOrUpdateTimeHandler implements MetaObjectHandler {

    /**
     * 插入元对象字段填充（用于插入时对公共字段的填充）
     *
     * @param metaObject 元对象
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        // 起始版本 3.3.0(推荐使用)
        this.strictInsertFill(metaObject, "createTime", Date.class, new Date());

    }

    /**
     * 更新元对象字段填充（用于更新时对公共字段的填充）
     *
     * @param metaObject 元对象
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        this.strictUpdateFill(metaObject, "updateTime", Date.class, new Date());
    }

}

@TableName("st_user")
public class StUser {
    @TableId(value = "id", type = IdType.ASSIGN_ID)
    private Long id;
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;
    @TableField(fill = FieldFill.UPDATE)
    private Date updateTime;
    private String name;
    private String telephone;
}