文章目录
- 一、创建 SpringBoot 项目
- 二、添加 MyBatis 依赖
- 三、项目结构和数据库表结构
- 四、项目代码
- 1、application.yml
- 2、TestController
- 3、TbUser
- 4、TbUserMapper
- 5、TestServiceImpl
- 6、TestService
- 7、TestApplication
- 8、TbUserMapper.xml
- 9、MyBatisTest
- 五、浏览器测试结果
- 六、Junit 测试结果
- 七、完整 pom.xml 文件
如果对于
MyBatisPlus
的常见基础知识不了解,可以点击 MyBatisPlus 基础原理、常见注解和注意事项简介
如果有对如何使用
SpringBoot
整合MyBatisPlus
框架不清楚的,可以点击 超详细的SpringBoot项目整合MyBatisPlus框架步骤示例,并附带浏览器和Junit测试结果示例代码
一、创建 SpringBoot 项目
本文采用 idea
创建简单的 maven
项目, JDK
版本为1.8。图上项目名字无所谓,我是使用 MayBatisPlus
那个项目修改过来的。
二、添加 MyBatis 依赖
依赖项中的都很重要,包括 MyBatis
和 MySQL
的依赖,还有 SpringBoot
项目的起步依赖,以及对实体类非常有用的 lombok
依赖。MyBatis 和 MyBatisPlus 项目的只是各自的依赖不同,其他都是相同的。
<parent><artifactId>spring-boot-starter-parent</artifactId><groupId>org.springframework.boot</groupId><version>2.7.10</version>
</parent><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId></dependency><dependency><groupId>junit</groupId><artifactId>junit</artifactId><scope>test</scope></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.16.18</version></dependency><dependency><groupId>org.mybatis.spring.boot</groupId><artifactId>mybatis-spring-boot-starter</artifactId><version>2.1.3</version></dependency><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>5.1.38</version></dependency>
</dependencies>
三、项目结构和数据库表结构
该项目整体结构如下:
数据库表结构如下:
四、项目代码
1、application.yml
本文使用 yml 的配置文件,配置文件中按层级配置好数据库的信息,项目启动时,会自动根据配置信息连接到数据库。注:要保证数据库是启动状态的。
配置文件中 mapper-locations
要注意配置,如果你的文件名是自定义的,很可能会找不到 mapper
文件位置。
spring:datasource:url: jdbc:mysql://10.100.5.174:8306/test?allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNulldriver-class-name: com.mysql.jdbc.Driverusername: rootpassword: 各位大佬点点赞mybatis:mapper-locations: classpath:mybatis-mapper/*.xml
2、TestController
这里没啥好说的,如果不清楚,说明基础没有学通。
@RestController
public class TestController {@Autowiredprivate TestService testService;@GetMapping("/select")public TbUser selectById(@Param("id") int id ){return testService.selectById(id);}@GetMapping("/add")public void addTbUser(@Param("id") int id, @Param("username") String username, @Param("password") String password) {TbUser tbUser = new TbUser(id, username, password);testService.addUser(tbUser);}
}
3、TbUser
实体类,一般来说,要与数据库中的表对应上,这里使用了 @TableName
@TableId
@TableField
等 MyBatisPlus
中的注解进行对应。
@Data
@AllArgsConstructor
@NoArgsConstructor
public class TbUser {private int id;private String username;private String password;
}
4、TbUserMapper
这里的代码是与 mapper.xml
文件相对应的,xml
文件中的 id
就是指的这个接口中的方法名。
@Mapper
public interface TbUserMapper {TbUser selectById(int id);void addUser(TbUser tbUser);
}
5、TestServiceImpl
@Service
public class TestServiceImpl implements TestService {@Autowiredprivate TbUserMapper tbUserMapper;@Overridepublic TbUser selectById(int id) {return tbUserMapper.selectById(id);}@Overridepublic void addUser(TbUser tbUser) {tbUserMapper.addUser(tbUser);}
}
6、TestService
public interface TestService {TbUser selectById(int id);void addUser(TbUser tbUser);
}
7、TestApplication
@MapperScan("com.wen.mapper")
@SpringBootApplication
public class TestApplication {public static void main(String[] args) {SpringApplication.run(TestApplication.class);}
}
8、TbUserMapper.xml
文件中有两点要注意:
namespace
:对应哪一个文件的数据库表格,要与TbUserMapper
对应。id
属性:对应TbUserMapper
接口中的方法名。
<?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.wen.mapper.TbUserMapper"><select id="selectById" resultType="com.wen.dto.TbUser">SELECT username, password FROM tb_user WHERE id = #{id}</select><insert id="addUser" parameterType="com.wen.dto.TbUser">INSERT INTO tb_user VALUES (#{id}, #{username}, #{password})</insert>
</mapper>
9、MyBatisTest
用于 Junit
测试使用,这里要注意,因为需要连接数据库,所以要先启动 SpringBoot
项目,所以要添加以下两个注解。
@RunWith(SpringRunner.class)
- 因为
SpringRunner.class
继承了SpringJUnit4ClassRunner.class
且没有进行任何修改。 - 所以
@RunWith(SpringRunner.class)
基本等同于 `@RunWith(SpringJUnit4ClassRunner.class)`` 。 - 作用是让测试在
Spring
容器环境下执行。 - 如果测试类中无此注解,将导致
service
,dao
等自动注入失败。
- 因为
@SpringBootTest(classes = TestApplication.class)
- 确保注解的主类(通常是包含
main
方法的类)在测试类的同一包中或者其子包中。 @SpringBootTest
默认会从当前包中查找主类。
- 确保注解的主类(通常是包含
@RunWith(SpringRunner.class)
@SpringBootTest(classes = TestApplication.class)
public class MyBatisTest {@Autowiredprivate TestService testService;@Testpublic void selectTbUser(){TbUser tbUser = testService.selectById(3);System.out.println(tbUser.toString());}@Testpublic void addTbUser(){testService.addUser(new TbUser(4, "wangwu", "6677"));}
}
五、浏览器测试结果
启动 TestApplication
,也就是启动 SpringBoot
项目,起步依赖会自动识别项目 application.yml
文件中的数据库配置信息,连接数据库,根据 controller
中的访问路径添加参数,就可以做到对数据库的增删改查。
如图所示,在浏览器上访问 localhost:8080/select?id=2
,目的是查询 ID 为 2 的 TbUser
信息。
如图所示,在浏览器上访问 localhost:8080/add?id=3&username=lisi&password=3344
,目的是添加一条用户记录。
可以查看数据库对应信息。
六、Junit 测试结果
运行 selectTbUser()
方法,会出现以下结果。对应浏览器上查询方法。
运行 addTbUser()
方法,会出现以下结果。对应浏览器上查询方法。
可以查看数据库对应信息。
七、完整 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 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>com.wen</groupId><artifactId>springboot-mybatis</artifactId><version>1.0-SNAPSHOT</version><properties><maven.compiler.source>8</maven.compiler.source><maven.compiler.target>8</maven.compiler.target><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding></properties><parent><artifactId>spring-boot-starter-parent</artifactId><groupId>org.springframework.boot</groupId><version>2.7.10</version></parent><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId></dependency><dependency><groupId>junit</groupId><artifactId>junit</artifactId><scope>test</scope></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.16.18</version></dependency><dependency><groupId>org.mybatis.spring.boot</groupId><artifactId>mybatis-spring-boot-starter</artifactId><version>2.1.3</version></dependency><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>5.1.38</version></dependency></dependencies>
</project>