1 项目搭建
新建项目,在IDEA中,点击File -> new -> Project
进入这个页面,选择Spring Initializr,注意你要提前自己配置一下JDK环境,我这里使用的JDK版本是 22
这里是选择工程的依赖,为了简单我们这里使用Lombok插件,在使用的时候注意安装Lombok对应的idea插件,要不然代码会报错。核心的依赖是Spring web(也就是SpringMVC,用来提供Web接口)、MyBatis和Mysql的驱动。
2 项目配置
完成上面的步骤之后,你的工程就已经出来了,删除一些不需要的文件,这里我没有删,大概是这样的一个结构:
3 pom配置
首先是pom文件,我们来看一下:
```xml
<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.2.4</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>demo</name>
<description>demo</description>
<properties>
<java.version>22</java.version>
</properties>
<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>3.0.3</version>
</dependency>
<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter-test</artifactId>
<version>3.0.3</version>
<scope>test</scope>
</dependency>
</dependencies>
<repositories>
<repository>
<id>nexus-aliyun</id>
<name>nexus-aliyun</name>
<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>public</id>
<name>aliyun nexus</name>
<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludes>
<exclude>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>
</project>
这是一个maven的项目,所以需要配置一下maven,打开settings,搜索maven,配置Maven Home和settings file,当然,你也可以使用默认的配置。配置完成后点击OK即可。
4 创建mapper文件夹及其他几个必要文件夹
需要在java包和resources包下各创建一个文件夹,来存放mapper接口和mapper.xml文件。
5 数据源和mybatis配置
为了演示,我在本地创建了一个test数据库,在application.properties文件中配置数据源和mapper接口的位置:
#spring.application.name=demo
spring.datasource.url=jdbc:mysql://10.132.16.211:3306/onetest?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf-8&useSSL=false
spring.datasource.username=root
spring.datasource.password=+*Root@1234@!1ml078/
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
mybatis.mapper-locations=classpath:mapper/*.xml
6 启动类配置
启动类只需要加入一个注解指定mapper接口的位置即可:@MapperScan(“com.example.mapper”)
package com.example;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
//@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
@MapperScan("com.example.mapper")
@SpringBootApplication()
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
配置到此结束。
7 Mapper接口和XML自动生成
这里给大家推荐一款非常好用的idea插件:better-mybatis-generator,在idea的插件仓库可以直接下载。
下载好之后,你需要配置一下datasource插件,位置在界面的右侧栏。 依次点击 + 号,选择Data Source下的Mysql数据库。
在这个页面,先下载Mysql驱动(注意,一定要下载),然后配置下面四项即可。
配置完成之后点击Test Connection,如果出现下面这样的,就表示你配置完成了。
注意:idea的datasource插件配置完成之后默认是不会显示你的数据库表的,需要设置一下。 在Schemas这一栏,勾选All 即可。
配置完成之后,我们就可以使用插件自动生成接口了:
为了方便演示,我在本地的test库创建了一个user表,结构如下:
CREATE TABLE `user` (`id` int(11) NOT NULL AUTO_INCREMENT,`username` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '账号',`nickname` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '昵称',`password` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '密码',PRIMARY KEY (`id`)) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
在user表上右键选择 mybatis-generator:
进入自动生成页面之后,需要配置的地方有3处,设置名称和选择项目的对应文件夹即可。
点击ok之后,Mapper接口、User实体类和Mapper.xml文件就都生成好了,我们看下生成的结果:
UserMapper:
package com.example.mapper;
import com.example.entity.User;
import java.util.List;
public interface UserMapper {
int deleteByPrimaryKey(Integer id);
int insert(User record);
int insertSelective(User record);
User selectByPrimaryKey(Integer id);
# 自己后加的,其他是生成的
List<User> selectAll();
int updateByPrimaryKeySelective(User record);
int updateByPrimaryKey(User record);
}
8 测试
完成上面的步骤,就表示你的项目已经成功集成了Mybatis,那么我们现在可以对集成的结果进行一个测试,看看还有没有问题,是不是可以投入使用。
写了一个UserController接口用来查询user表的数据:
package com.example.controller;
import com.example.entity.User;
import com.example.mapper.UserMapper;
import jakarta.annotation.Resource;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
/**
* @param
* @description: TODO
* @date: 2024/4/16 20:03
* @version: 1.0
* @return
*/
@RestController
@RequestMapping("/user")
public class UserController {
@Resource
private UserMapper userMapper;
@GetMapping
public List<User> findAll(){
return userMapper.selectAll();
}
}
这里写的不是很规范哈,为了方便,我偷懒直接在controller里面引入了UserMapper,同学们可不要学我哦,一般要建一个service层做数据处理使用的。
UserMapper的selectAll接口:
<sql id="Base_Column_List"
id, username, nickname, `password`</sql<select id="selectAll" resultType="com.example.entity.User"
select <include refid="Base_Column_List" / from user order by id desc
</select
写完之后,启动一下工程:
OK,启动成功,访问端口默认是 8080。为了演示效果,我们需要自己在数据库插入一条测试数据:
然后我们打开浏览器,请求一下接口试试:
非常完美~ 数据请求成功!
至此,SpringBoot集成Mybatis完工。