springboot整合mybatis步骤，与踩坑排错

一、前言

本文简单回顾一下springboot整合mybatis步骤，俗话说，刀放着不用会生锈，同理，学习也是如此，需要常常温故知新。

在整合过程中，也遇到了一些坑，具体看章节四，看你有没有遇到同样的问题

二、整合步骤

1.项目创建

创建一个普通的maven项目，或者你直接创建一个springboot项目也可以。

这里就不一一贴图了哈

2.依赖引入

要引入mybatis的核心支持，主要有mybatis-spring-boot-starter，druid-spring-boot-starter，mysql-connector-java，其他的根据自己需要引入。

<?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">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>demo-maven-create-boot</artifactId>
    <version>1.0-SNAPSHOT</version>

    <parent>
        <artifactId>spring-boot-starter-parent</artifactId>
        <groupId>org.springframework.boot</groupId>
        <version>2.3.7.RELEASE</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

<!--        mybatis支持-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.3</version>
        </dependency>

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.10</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>
</project>

3.配置

在项目的src/main/resources下创建application.properties文件，写入数据库的连接参数与myabtis的一些配置信息，（这一步你用yml格式文件也可以的）如下：

#数据库路径
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/demo?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=false
#数据库驱动
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
#数据库用户名
spring.datasource.username=root
#数据库用户密码
spring.datasource.password=*****
#数据库连接池
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
#mybatis类型别名配置，这里指定一个包，该包下的类的别名与类名一致
mybatis.type-aliases-package=org.lys.model
#指定mapper文件的位置
mybatis.mapper-locations=classpath:mybatis/mapper/*.xml

三、验证

1、创建一个简单的表来测试，如下：

2、自定义添加一些数据

3、实体类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private int id;

    private String name;
}

4、接口

@Mapper
public interface UserMapper {

    /**
     * 所有用户
     *
     * @return {@code List<User>}
     */
    List<User> getAllUsers();

    /**
     * 通过id查找用户
     *
     * @param id id
     * @return {@code User}
     */
    @Select("select * from user where id=#{id}")
    User getUserById(int id);

    /**
     * 插入用户
     *
     * @param user 用户
     * @return int
     */
    int insertUser(User user);

    /**
     * 批量查询
     *
     * @param ids id
     * @return {@code List<User>}
     */
    List<User> getAllUsersByIds(@Param("ids")Integer[] ids);

}

5、mapper文件

<?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="org.lys.dao.UserMapper">
    <insert id="insertUser" parameterType="User">
<!--        使用自带的UUID生成主键-->
        <selectKey resultType="Integer" keyProperty="id" order="BEFORE">
            select uuid();
        </selectKey>
        insert into user values (#{id}, #{name})
    </insert>

    <select id="getAllUsers" resultType="User">
        select * from user;
    </select>

    <select id="getAllUsersByIds" resultType="User">
        select * from user where id in
        <foreach collection="ids" open="(" close=")" item="id" separator=",">
            #{id}
        </foreach>
    </select>
</mapper>

6、测试

在需要引入的地方，直接注入相应的接口，即可直接调用。

@Autowired
private UserMapper userMapper;

四、踩坑排错

1.添加注解无法识别

解决：注意检查大小写，是**@Select**，而不是**@select**，这个注解是首字母是大写开头的哦。其他的注解在使用的时候也要注意哦！

2.IDEA社区版报各种颜色的错误

解决：上面的提示不影响程序运行，可忽略，就是看着不好看。可能是由于我使用的是IDEA社区版的原因，社区版不同于旗舰版，社区版少很多的支持。（推荐用IDEA旗舰版）

3.jar包打包后运行报错

我是这样打的jar包：

结果发现打包出来的包不可运行，咋一看上面打包出来的jar包只要几兆大小，说明我们项目需要用到的一些依赖包它没有给打包进来。

解决：由于我们创建的是maven项目，在pom.xml文件里添加一个maven插件，重新package即可，如下：

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <!--项目的启动类-->
                <mainClass>org.lys.DemoApplication</mainClass>
                <layout>ZIP</layout>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>repackage</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

4.单元测试不可用

解决：经过检查，发现是自己没有添加单元测试的相关依赖，需要添加spring-boot-starter-test这个依赖，如下：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
</dependency>

测试类这样写，记得添加@RunWith(SpringRunner.class)、@SpringBootTest 这两个注解。

@RunWith(SpringRunner.class)
@SpringBootTest(classes = DemoApplication.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class UserTest {
	
    @Test
    public void fun1(){
        //你的代码逻辑
    }
    
    @Test
    public void fun1(){
     	//你的代码逻辑   
    }
    //······
}

注意：在注解@springbootTest里面要指定启动类，否则加载不到上下文，会报下面的错误。

五、总结

操作一遍下来，整合步骤还是很容易的，因为Springboot为我们做了很多的自动化配置，你需要用到的技术，只需要引入响应的依赖，再加点基础参数接口。但是要注意一些细节，以免犯一些低级的错误。

本期分享到这，下期见！