SpringBoot项目集成依赖Mybatis步骤

下面是SpringBoot项目集成依赖Mybatis步骤的完整攻略。

1. 引入Mybatis相关依赖

在pom.xml文件中添加以下依赖，其中包括Mybatis核心依赖 mybatis-spring-boot-starter ，Mysql驱动包mysql-connector-java以及Mybatis分页插件pagehelper。

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

<!-- MySQL connector dependency -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.26</version>
</dependency>

<!-- Mybatis pagination dependency -->
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>1.3.0</version>
</dependency>

2. 配置数据库连接

在SpringBoot项目的application.properties(或application.yml)文件中添加以下配置信息，配置数据库连接。

#MySQL连接信息
spring.datasource.url=jdbc:mysql://localhost:3306/mydatabase?characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

3. 创建Mybatis配置文件

在项目中的src/main/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>
    <settings>
        <setting name="logImpl" value="STDOUT_LOGGING" />
    </settings>
</configuration>

4. 创建Mapper接口

在项目中创建Mapper接口，用于操作数据库表。

@Mapper
public interface UserMapper {
    @Select("SELECT * FROM user")
    List<User> getAllUsers();
}

5. 创建实体类

在项目中创建实体类，用于与数据库表进行数据交互。

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private int id;
    private String name;
    private String email;
    private String loginName;
    private String password;
}

6. 注册Mapper接口

在SpringBoot启动类中注册Mapper接口。

@SpringBootApplication
@MapperScan(basePackages = {"com.example.demo.mapper"})
public class DemoApplication {

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

这里以在demo项目中的Application.java中为例

7. 测试Mybatis

在Controller中使用UserMapper查询数据库，将数据返回给前端。

@RestController
public class UserController {

    @Autowired
    private UserMapper userMapper;

    @GetMapping("/users")
    public List<User> getAllUsers() {
        return userMapper.getAllUsers();
    }
}

示例1 - 查询所有用户信息

我们看到前面的代码中已经有了查询所有用户信息的 SQL 语句，我们只需在UserController.java中调用该方法即可。我们可以通过在浏览器中访问 http://localhost:8080/users 查看数据是否正确返回。

其中，原数据为：

id	name	email	login_name	password
1	Alex Smith	[e-mail]	alex	123456
2	John Doe	[e-mail]	john	123456
3	Jane Doe	[e-mail]	jane	123456

@RestController
public class UserController {

    @Autowired
    private UserMapper userMapper;

    @GetMapping("/users")
    public List<User> getAllUsers() {
        return userMapper.getAllUsers();
    }
}

返回结果:

[
  {
    "id": 1,
    "name": "Alex Smith",
    "email": "[e-mail]",
    "loginName": "alex",
    "password": "123456"
  },
  {
    "id": 2,
    "name": "John Doe",
    "email": "[e-mail]",
    "loginName": "john",
    "password": "123456"
  },
  {
    "id": 3,
    "name": "Jane Doe",
    "email": "[e-mail]",
    "loginName": "jane",
    "password": "123456"
  }
]

示例2 - 添加用户信息

在Mapper接口中添加插入用户信息，Controller中调用方法，在浏览器中访问地址http://localhost:8080/user，参数为name，email，loginName，password，即可添加新用户。添加成功后，在浏览器中调用接口http://localhost:8080/users，查询所有用户信息。

// Mapper接口中的插入用户信息
@Insert("INSERT INTO user(name, email, login_name, password) values(#{name}, #{email}, #{loginName}, #{password})")
void addUser(User user);

// Controller中调用插入用户信息的方法
@PostMapping("/user")
public void addUser(String name, String email, String loginName, String password) {
    userMapper.addUser(new User(0, name, email, loginName, password));
}

在浏览器中访问 http://localhost:8080/user?name=Lucas&email=[e-mail]&loginName=lucas&password=123456，
执行成功后再次访问http://localhost:8080/users即可看到新增的用户

[
    {
        "id": 1,
        "name": "Alex Smith",
        "email": "[e-mail]",
        "loginName": "alex",
        "password": "123456"
    },
    {
        "id": 2,
        "name": "John Doe",
        "email": "[e-mail]",
        "loginName": "john",
        "password": "123456"
    },
    {
        "id": 3,
        "name": "Jane Doe",
        "email": "[e-mail]",
        "loginName": "jane",
        "password": "123456"
    },
    {
        "id": 4,
        "name": "Lucas",
        "email": "[e-mail]",
        "loginName": "lucas",
        "password": "123456"
    }
]

至此，SpringBoot集成依赖Mybatis的步骤就介绍完了。