JAVA：Spring Boot整合MyBatis Plus持久层

news2024/11/16 21:57:59

1、简述

MyBatis Plus是MyBatis的增强工具包，它在MyBatis的基础上进行了扩展，提供了许多便捷的功能，例如通用CRUD操作、分页插件、代码生成器等。使用MyBatis Plus，开发者可以更加方便地进行持久层操作，并且减少了很多重复劳动。

在这里插入图片描述

官网地址：https://baomidou.com/

2、环境准备

在开始整合之前，我们需要准备好以下环境：

JDK 1.8或以上版本
Maven 3.x
Spring Boot 2.x
MyBatis Plus

你可以通过Maven或者Gradle等工具来管理项目依赖，确保将Spring Boot和MyBatis Plus的相关依赖添加到项目中：

<!-- mybatis -->
<dependency>
  <groupId>com.baomidou</groupId>
  <artifactId>mybatis-plus-boot-starter</artifactId>
  <version>3.1.2</version>
</dependency>
<!-- mysql -->
<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <scope>runtime</scope>
</dependency>
<!-- lombok -->
<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
  <optional>true</optional>
</dependency>

3、配置数据源

在Spring Boot项目中，我们需要配置数据源以便连接数据库。在application.properties或application.yml文件中添加数据库相关的配置，包括数据库URL、用户名、密码等信息。

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydatabase
    username: root
    password: yourpassword
    driver-class-name: com.mysql.cj.jdbc.Driver

配置当前Mybatis当前mapper扫描xml的路径：

mybatis:
  mapper-locations: classpath*:/mapper/**/*.xml
  #实体扫描，多个package用逗号或者分号分隔
  typeAliasesPackage: com.xhl.shiro.modules.*.entity

4、编写实体类

接下来，我们需要创建与数据库表对应的实体类。这些实体类通常使用JPA注解或者MyBatis Plus的注解来映射数据库表和Java对象之间的关系。

import com.baomidou.mybatisplus.annotation.TableName;

@TableName("user")
public class User {
    private Long id;
    private String username;
    private String password;
    
    // Getters and setters
}

5、编写Mapper接口

使用MyBatis Plus，我们不需要编写XML形式的Mapper文件，只需要创建Mapper接口并继承BaseMapper接口即可。MyBatis Plus会根据命名规范自动生成SQL语句。

import com.baomidou.mybatisplus.core.mapper.BaseMapper;

public interface UserMapper extends BaseMapper<User> {
    // 自定义方法
}

配置Mybatis的Mapper类文件的包扫描路径：

@SpringBootApplication
@MapperScan(basePackages = {"com.xhl.shiro.modules.mapper"})
public class BootLaunchApplication {
    public static void main(String[] args) {
        SpringApplication.run(BootLaunchApplication.class, args);
    }
}

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="com.xhl.oauth2.modules.mapper.UserMapper">
    <resultMap id="userMap" type="com.xhl.oauth2.modules.vo.SysUserVo">
        <id property="userId" column="user_id"/>
        <result property="userName" column="username"/>
        <result property="password" column="password"/>
        <collection property="roles" ofType="string">
            <result column="role_name" property="roleName"/>        </collection>
    </resultMap>
    <select id="selectOneUserByUserName" parameterType="String" resultMap="userMap">
        select u.*
             ,sr.role_name
        from sys_user u
                 LEFT JOIN sys_user_role sru on u.user_id= sru.user_id
                 LEFT JOIN sys_role sr on sru.role_id = sr.role_id
        where username= #{userName}
	</select>
</mapper>

6、编写Service层

在Service层，我们可以编写业务逻辑代码，调用Mapper层进行数据库操作：

import org.springframework.stereotype.Service;

@Service
public class UserService {
    private final UserMapper userMapper;

    public UserService(UserMapper userMapper) {
        this.userMapper = userMapper;
    }
    
    // 自定义业务方法
}

7、整合测试

至此，我们已经完成了Spring Boot与MyBatis Plus的整合。可以编写一些简单的测试用例来验证持久层操作是否正常。

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class UserServiceTest {
    @Autowired
    private UserService userService;

    @Test
    public void testInsert() {
        User user = new User();
        user.setUsername("test");
        user.setPassword("123456");
        userService.save(user);
    }

    // 更多测试方法
}