JavaWeb之SpringBoot整合MyBatis

JavaWeb学习中关于SpringBoot整合MyBatis的相关知识 💯💤

SpringBoot+MyBatis

SpringBoot整合Mybatis可以使用xml方式，也可以使用全注解的方式，在SQL语句比较简单时，使用全注解方式比较方便，SQL语句复杂时则不适合写在代码中，使用xml配置比较清晰简洁。

¶一 准备工作

¶1.1 建表

CREATE TABLE `user` (
  `id` int(13) NOT NULL AUTO_INCREMENT COMMENT '主键',
  `name` varchar(33) DEFAULT NULL COMMENT '姓名',
  `age` int(3) DEFAULT NULL COMMENT '年龄',
  `money` double DEFAULT NULL COMMENT '账户余额',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8

¶1.2 配置相关依赖

主要依赖包括mybatis-spring-boot-starter和mysql-connector-java。

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>1.3.2</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

¶1.3 配置 application.properties

由于我使用的是比较新的Mysql连接驱动，所以配置文件可能和之前有一点不同。

#数据库配置
spring.datasource.url=jdbc:mysql://127.0.0\
  .1:3306/springboot?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

#使用xml方式加载Mybatis映射文件
mybatis.mapper-locations=classpath:mapper/*Mapper.xml

¶1.4 创建用户类 Bean

User.java

public class User {
    private int id;
    private String name;
    private int age;
    private double money;
    ...
    省略getter、setter以及toString方法
}

¶二 全注解的方式

¶2.1 Dao 层

项目目录下建立dao包，新建dao层接口UserDao.java

@Mapper
@Repository
public interface UserDao {
    /**
     * 通过名字查询用户信息
     */
    @Select("select * from user where name = #{name}")
    User findUserByName(@Param("name") String name);

    /**
     * 查询所有用户
     */
    @Select("select * from user")
    List<User> findAllUser();

    /**
     * 插入用户信息
     */
    @Insert("insert into user(name, age, money) values (#{name}, #{age}, #{money})")
    void insertUser(@Param("name") String name, @Param("age") Integer age, @Param("money") Double money);

    /**
     * 根据id更新用户信息
     */
    @Update("UPDATE  user SET name = #{name},age = #{age},money= #{money} WHERE id = #{id}")
    void updateUser(@Param("name") String name, @Param("age") Integer age, @Param("money") Double money,
                    @Param("id") int id);

    /**
     * 根据id删除用户信息
     */
    @Delete("DELETE from user WHERE id = #{id}")
    void deleteUser(@Param("id") int id);
}

⭐️注解说明：

1. 在dao层的类需要加上 @Mapper的注解，这个注解是mybatis提供的，标识这个类是一个数据访问层的bean，并交给spring容器管理，并且可以省去之前的xml映射文件。在编译的时候，添加了这个类也会相应的生成这个类的实现类daoImpl。
2. 使用IDEA时，在service中注入bean的时候，会显示报错，但是不影响运行，这是因为 @mapper不是spring提供的，当需要自动注入这个bean的时候idea不能 预检测到这个bean是否可以注入到容器中。如果要消除这个报错，可以在dao层的类上面加上一个 @Repository，这个注解是spring提供的，这样就可以预检测到mapper的bean是可以注册到spring容器里面的。
3. 如果接口有两个及其以上的参数时，就需要用 @Param这个注解了，不然在对应的xml文件，它分辨不出来这个参数是哪一个就会报错，用这个注解的意思就是说标识这个参数的名称，以便让接受参数的一方更好的找到并利用这个值。

¶2.2 Service 层

@Service
public class UserService {
    @Autowired
    private UserDao userDao;//上面注意中说了这里可能会报错哦！

    /**
     * 根据名字查找用户
     */
    public User selectUserByName(String name) {
        return userDao.findUserByName(name);
    }

    /**
     * 查找所有用户
     */
    public List<User> selectAllUser() {
        return userDao.findAllUser();
    }

    /**
     * 插入两个用户
     */
    public void insertService() {
        userDao.insertUser("zhangsan", 22, 3000.0);
        userDao.insertUser("lisi", 19, 3000.0);
    }

    /**
     * 根据id 删除用户
     */

    public void deleteService(int id) {
        userDao.deleteUser(id);
    }

    /**
     * 模拟事务。如果转账中途出了意外，更新操作不会生效。
     */
    @Transactional
    public void changemoney() {
        userDao.updateUser("zhangsan", 22, 2000.0, 7);
        // 模拟转账过程中可能遇到的意外状况
        // int temp = 1 / 0;
        userDao.updateUser("lisi", 19, 4000.0, 8);
    }
}

¶2.3 Controller 层

@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    private UserService userService;

    @RequestMapping("/query")
    public User testQuery() {
        return userService.selectUserByName("lisi");
    }

    @RequestMapping("/insert")
    public List<User> testInsert() {
        userService.insertService();
        return userService.selectAllUser();
    }

    @RequestMapping("/changemoney")
    public List<User> testchangemoney() {
        userService.changemoney();
        return userService.selectAllUser();
    }

    @RequestMapping("/delete")
    public String testDelete() {
        userService.deleteService(3);
        return "OK";
    }
}

¶2.4 启动类

@SpringBootApplication
// 此注解表示动态扫描DAO接口所在包，实际上不加下面这条语句也可以找到
@MapperScan("cn.sucrelt.springbootmybatis.dao")
public class SpringBootMyBatisApplication {

	public static void main(String[] args) {
		SpringApplication.run(SpringBootMyBatisApplication.class, args);
	}
}

¶2.5 测试

运行SpringBoot启动类，访问浏览器：http://localhost:8080/user/insert查看结果。

¶三 xml 的方式

使用xml方式进行MyBatis的配置时需要进行如下改动：

¶3.1 Dao 层改动

不再使用注解编写SQL语句，

@Mapper
public interface UserDao {
    /**
     * 通过名字查询用户信息
     */
    User findUserByName(String name);
}

¶3.2 新建Dao接口的映射文件

在resources目录下新建mapper文件夹，用于存放dao接口的映射文件。

UserMapper.xml

<?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="cn.sucrelt.springbootmybatis.dao.UserDao">
    <select id="findUserByName" parameterType="String" resultType="cn.sucrelt.springbootmybatis.domain.User">
        SELECT * FROM user WHERE name = #{name}
    </select>
</mapper>

¶3.2 配置文件的改动

配置文件中加入MyBatis映射文件的路径

mybatis.mapper-locations=classpath:mapper/*.xml