SpringBoot中整合Mybatis

一、Mybatis快速入门

1.1、在相应的模块中添加依赖的坐标

首先创建一个maven项目

在对应的pom.xml文件中引入下面的依赖 

<dependencies>
    <!--mybatis 依赖-->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version>
    </dependency>

    <!--mysql 驱动-->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.46</version>
    </dependency>
</dependencies>

1.2、编写核心配置文件

在resources包中编写mybatis-config.xml配置文件，配置数据库的连接信息，在mybatis官网复制即可。

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <!--配置连接数据库的连接参数-->
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>

    <!--2 加载Mapper接口和SQL语句，将给的例子注释掉。后面第三大步中配置-->
    <!--<mappers>
        <mapper resource="org/mybatis/example/BlogMapper.xml"/>
    </mappers>-->
</configuration>

核心配置文件的作用:

1、配置连接数据库环境信息。

​ 2、通过扫包加载和mapper接口和SQL

1.3、总结

mybatis的使用步骤:

1、引入对应的依赖

2、设置核心配置文件mybatis-config.xml

二、SpringBoot项目中整合Mybatis

创建一个springboot的web项目:

2.1、 在相应的模块中添加依赖的坐标

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>cloud-demo</artifactId>
        <groupId>cn.itcast.demo</groupId>
        <version>1.0</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>user-service</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--mybatis-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
        </dependency>   
    </dependencies>
    <build>
        <finalName>app</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

其中:

1、mybatis-spring-boot-starter

2、mysql-connector-java

这两个依赖是使用mybatis所必须的

2.2、application.yml配置文件中设置数据库等信息

server:
  port: 8081
spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/cloud_user?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=Asia/Shanghai
    username: root
    password: root
    driver-class-name: com.mysql.jdbc.Driver

 
mybatis:
  type-aliases-package: cn.itcast.user.pojo
  mapper-locations: classpath:/mapper/**/*.xml
  configuration:
    map-underscore-to-camel-case: true

其中application.yml配置文件中设置的数据库连接信息,以及mapper.xml的位置设置都是之前在mybatis-config.xml配置文件中设置的。

所以使用springboot整合mybatis后可以删除mybatis-config.xml配置文件

2.3总结

SpringBoot中整合mybatis的使用步骤:

1、引入对应的依赖

2、设置核心配置文件application.yml

三、Mapper.xml文件的放置规则

        mapper中的每一个方法,都应该对应有一条sql语句。可以使用注解的形式,也可以写在对应的mapper.xml中。

下面采用的是注解的形式

如果采用的是mapper.xml的形式,那么要特别注意mapper.xml文件的放置位置

3.1、和mapper放在同级目录

可以看见UserMapper和UserMapper.xml都在cn/itcast/user/mapper/包下

 这种情况下,不需要在application.yml中设置任何的参数

3.2、在application.yml配置文件中指定Mapper.xml的位置

mybatis:
  type-aliases-package: cn.itcast.user.pojo
  mapper-locations: classpath:/mapper/**/*.xml

 例如我现在就指定mapper.xml文件在resources包下的mapper包以及mapper包的子包中。

 

3.3、出现的报错

如果没有按照3.1、3.2中进行操作，就会出现下面的报错

四、通过 MybatisProperties.class定位mapper.xml的位置

我们通过单击application.yml中的mapper-locations可以定位到加载mapper.xml的位置

debug启动项目后,在下面的位置打上断点。可以看见在MybatisProperties.class类中的setMapperLocations方法里面可以获取到mapper.xml的位置 

 五、@param注解的注意点

我们在mapper中如果存在多个参数的时候,会使用到@param注解,使用这个注解要导入对应的mybatis的包,不然会报下面的错误。

导入这个注解

导错包出现的报错