SpringBoot整合MyBatis完整详细版

野性酷女 2023-06-19 14:25 159阅读 0赞

写在前面： 从2018年底开始学习SpringBoot，也用SpringBoot写过一些项目。现在想对学习Springboot的一些知识总结记录一下。如果你也在学习SpringBoot，可以关注我，一起学习，一起进步。

相关文章：

【Springboot系列】Springboot入门到项目实战

上一篇写了SpringBoot整合JdbcTemplate，JdbcTemplate虽然简单，但在实际开发中用的并不多，因为它没有MyBatis方便，MyBatis是一个优秀的持久层框架，在实体类和SQL语句之间建立了映射关系，MyBatis支持普通SQL查询，存储过程和高级映射。MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及结果集的检索。MyBatis使用简单的XML或者注解进行配置和原始映射，将查询出的数据库记录映射成java对象。这篇来看看在Spring Boot中MyBatis要如何使用。

目录

搭建项目

1、项目结构

2、创建SpringBoot项目

3、添加相关依赖

4、编写相关配置

表结构设计

1、表结构

2、建表

编写代码

1、编写实体类

2、编写xml文件，SQL查询

3、编写Mapper接口

3、编写业务层类

测试应用

1、编写测试Controller

2、测试应用

本文章项目下载地址：SpringBoot整合Mybatis，增删改查分页动态查询。

搭建项目

1、项目结构

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70

2、创建SpringBoot项目

创建一个SpringBoot项目，添加Web依赖，MyBatis依赖以及MySQL驱动依赖，如下：

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 1

3、添加相关依赖

创建完成后，添加对应的依赖，完整的pom.xml文件如下。

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <parent>
  6.         <groupId>org.springframework.boot</groupId>
  7.         <artifactId>spring-boot-starter-parent</artifactId>
  8.         <version>2.2.1.RELEASE</version>
  9.         <relativePath/> <!-- lookup parent from repository -->
  10.     </parent>
  11.     <groupId>com.mcy</groupId>
  12.     <artifactId>springboot-mybatis</artifactId>
  13.     <version>0.0.1-SNAPSHOT</version>
  14.     <name>springboot-mybatis</name>
  15.     <description>Demo project for Spring Boot</description>
  17.     <properties>
  18.         <java.version>1.8</java.version>
  19.     </properties>
  21.     <dependencies>
  22.         <dependency>
  23.             <groupId>org.springframework.boot</groupId>
  24.             <artifactId>spring-boot-starter-web</artifactId>
  25.         </dependency>
  26.         <dependency>
  27.             <groupId>com.alibaba</groupId>
  28.             <artifactId>druid</artifactId>
  29.             <version>1.0.9</version>
  30.         </dependency>
  31.         <dependency>
  32.             <groupId>org.mybatis.spring.boot</groupId>
  33.             <artifactId>mybatis-spring-boot-starter</artifactId>
  34.             <version>2.1.1</version>
  35.         </dependency>
  37.         <dependency>
  38.             <groupId>mysql</groupId>
  39.             <artifactId>mysql-connector-java</artifactId>
  40.             <scope>runtime</scope>
  41.         </dependency>
  42.         <dependency>
  43.             <groupId>org.springframework.boot</groupId>
  44.             <artifactId>spring-boot-starter-test</artifactId>
  45.             <scope>test</scope>
  46.             <exclusions>
  47.                 <exclusion>
  48.                     <groupId>org.junit.vintage</groupId>
  49.                     <artifactId>junit-vintage-engine</artifactId>
  50.                 </exclusion>
  51.             </exclusions>
  52.         </dependency>
  53.     </dependencies>
  55.     <build>
  56.         <plugins>
  57.             <plugin>
  58.                 <groupId>org.springframework.boot</groupId>
  59.                 <artifactId>spring-boot-maven-plugin</artifactId>
  60.             </plugin>
  61.         </plugins>
  62.     </build>
  64. </project>

4、编写相关配置

在src/main/resources下找到application.properties文件，在该配置文件中配置数据源。

  1. spring.datasource.url=jdbc:mysql://localhost:3306/mybatis?serverTimezone=GMT%2B8
  2. spring.datasource.username=root
  3. spring.datasource.password=root
  4. spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
  6. #连接池的配置
  7. spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
  9. server.port=80
  11. #配置mapper  xml文件所在的路径
  12. mybatis.mapper-locations=classpath:mapper/*.xml
  13. #mybatis别名包扫描，映射类所在的包名，对应实体类的包名
  14. mybatis.type-aliases-package=com.mcy.springbootmybatis.entity

这里需要注意的是两个配置xml和实体类包路径不能出错，不然会报错。

  1. #配置mapper  xml文件所在的路径
  2. mybatis.mapper-locations=classpath:mapper/*.xml
  3. #mybatis别名包扫描，映射类所在的包名，对应实体类的包名
  4. mybatis.type-aliases-package=com.mcy.springbootmybatis.entity

表结构设计

1、表结构

设计了一张tb_user用户表，表结构如下。

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 2

2、建表

执行以下脚本在数据库中创建tb_user表。

  1. CREATE TABLE `tb_user` (
  2.   `id` int(11) NOT NULL AUTO_INCREMENT,
  3.   `name` varchar(255) DEFAULT NULL,
  4.   `username` varchar(255) DEFAULT NULL,
  5.   `password` varchar(255) DEFAULT NULL,
  6.   PRIMARY KEY (`id`)
  7. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

编写代码

在项目中新建4个包，分别为entity（放置持久化类）、controller（控制器）、mapper（定义数据访问接口的包）、service（业务逻辑处理类）。在resources目录下创建mapper文件夹。代码中有详细的注释，下面直接贴代码。

1、编写实体类

实体类User.java，其代码如下（和数据库字段需要对应，继承分页公共类MyEverpage）。

  1. public class User extends MyEverpage {
  2.     private Integer id;
  3.     private String name;
  4.     private String username;
  5.     private String password;
  7.     public Integer getId() {
  8.         return id;
  9.     }
  11.     public void setId(Integer id) {
  12.         this.id = id;
  13.     }
  15.     public String getName() {
  16.         return name;
  17.     }
  19.     public void setName(String name) {
  20.         this.name = name;
  21.     }
  23.     public String getUsername() {
  24.         return username;
  25.     }
  27.     public void setUsername(String username) {
  28.         this.username = username;
  29.     }
  31.     public String getPassword() {
  32.         return password;
  33.     }
  35.     public void setPassword(String password) {
  36.         this.password = password;
  37.     }
  38. }

分页查询参数公共类MyEverpage.java，代码如下。

  1. /**
  2.  * 分页类
  3.  * @author Administrator
  4.  *
  5.  */
  6. public class MyEverpage {
  7.     private int limit;
  8.     private int offset;
  10.     public int getLimit() {
  11.         return limit;
  12.     }
  14.     public void setLimit(int limit) {
  15.         this.limit = limit;
  16.     }
  18.     public int getOffset() {
  19.         return offset;
  20.     }
  22.     public void setOffset(int offset) {
  23.         this.offset = offset;
  24.     }
  26. }

2、编写xml文件，SQL查询

在resources/mapper文件夹下新建一个UserMapper.xml文件，编写查询语句，代码如下（这里的xml路径一定要和application.properties配置文件中的路径一致）。

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE mapper
  3.         PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  4.         "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  5. <!--
  6.     namespace命名空间，作用就是对sql进行分类化管理，理解sql隔离
  7. 注意：使用mapper代理方法开发，namespace有特殊重要的作用，namespace等于mapper接口地址
  8. -->
  9. <mapper namespace="com.mcy.springbootmybatis.mapper.UserMapper">
  10.     <!-- 查询所有-->
  11.     <select id="findAll" resultType="User">
  12.         select * from tb_user
  13.     </select>
  14.     <!-- 根据姓名查询-->
  15.     <select id="findByName" parameterType="User" resultType="User">
  16.         select * from tb_user where name=#{name}
  17.     </select>
  18.     <!-- 根据用户名模糊查询-->
  19.     <select id="findByUsernameLike" parameterType="User" resultType="User">
  20.         select * from tb_user where username like "%"#{username}"%"
  21.     </select>
  22.     <!-- 根据id查询-->
  23.     <select id="findById" parameterType="User" resultType="User">
  24.         select * from tb_user where id = #{id}
  25.     </select>
  26.     <!--多条件动态查询-->
  27.     <select id="find" parameterType="User" resultType="User">
  28.         select * from tb_user where 1=1
  29.         <if test="name != '' and name != null">
  30.             and name =#{name}
  31.         </if>
  32.         <if test="username != '' and username != null">
  33.             and username =#{username}
  34.         </if>
  35.     </select>
  36.     <!-- 分页查询所有-->
  37.     <select id="findByPageAll" parameterType="User" resultType="User">
  38.         select * from tb_user limit #{offset},#{limit}
  39.     </select>
  40.     <!-- 增加 -->
  41.     <insert id="addSave" parameterType="User">
  42.         insert into tb_user values(null, #{name}, #{username}, #{password})
  43.     </insert>
  44.     <!-- 修改 -->
  45.     <update id="update" parameterType="User">
  46.         update tb_user set name=#{name}, username=#{username}, password=#{password}
  47.         where id=#{id}
  48.     </update>
  49. </mapper>

3、编写Mapper接口

UserMapper.java接口，代码如下（需要添加@Mapper注解，方法名需要额xml中的id值对应）。

  1. import com.mcy.springbootmybatis.entity.User;
  2. import org.apache.ibatis.annotations.Mapper;
  4. import java.util.List;
  6. @Mapper
  7. public interface UserMapper {
  8.     //查询所有，方法名需要和UserMapper.xml中的id对应
  9.     public List<User> findAll();
  11.     //根据姓名查询
  12.     public List<User> findByName(String name);
  14.     //根据用户名模糊查询
  15.     public List<User> findByUsernameLike(String username);
  17.     //根据id查询
  18.     public User findById(Integer id);
  20.     //多条件动态查询
  21.     public List<User> find(User user);
  23.     //分页查询
  24.     public List<User> findByPageAll(User user);
  26.     //新增
  27.     public void addSave(User user);
  29.     //修改
  30.     public void update(User user);
  31. }

3、编写业务层类

UserService.java业务层类。

  1. import com.mcy.springbootmybatis.entity.User;
  2. import com.mcy.springbootmybatis.mapper.UserMapper;
  3. import org.springframework.beans.factory.annotation.Autowired;
  4. import org.springframework.stereotype.Service;
  6. import java.util.List;
  8. @Service
  9. public class UserService {
  10.     @Autowired
  11.     private UserMapper userMapper;
  13.     //查询所有，方法名需要和UserMapper.xml中的id对应
  14.     public List<User> findAll(){
  15.         return userMapper.findAll();
  16.     };
  18.     //根据姓名查询
  19.     public List<User> findByName(String name){
  20.         return userMapper.findByName(name);
  21.     };
  23.     //根据用户名模糊查询
  24.     public List<User> findByUsernameLike(String username){
  25.         return userMapper.findByUsernameLike(username);
  26.     };
  28.     //根据id查询
  29.     public User findById(Integer id){
  30.         return userMapper.findById(id);
  31.     };
  33.     //多条件动态查询
  34.     public List<User> find(User user){
  35.         return userMapper.find(user);
  36.     };
  38.     //分页查询
  39.     public List<User> findByPageAll(User user){
  40.         return userMapper.findByPageAll(user);
  41.     };
  43.     //新增
  44.     public void addSave(User user){
  45.         userMapper.addSave(user);
  46.     };
  48.     //修改
  49.     public void update(User user){
  50.         userMapper.update(user);
  51.     };
  52. }

测试应用

1、编写测试Controller

访问控制器UserController.java类，代码如下。

  1. import com.mcy.springbootmybatis.entity.User;
  2. import com.mcy.springbootmybatis.service.UserService;
  3. import org.springframework.beans.factory.annotation.Autowired;
  4. import org.springframework.web.bind.annotation.RequestMapping;
  5. import org.springframework.web.bind.annotation.RestController;
  7. import java.util.List;
  9. @RestController
  10. @RequestMapping("/user")
  11. public class UserController {
  12.     @Autowired
  13.     private UserService userService;
  15.     //查询所有，方法名需要和UserMapper.xml中的id对应
  16.     @RequestMapping("/findAll")
  17.     public List<User> findAll(){
  18.         return userService.findAll();
  19.     };
  21.     //根据姓名查询
  22.     @RequestMapping("/findByName")
  23.     public List<User> findByName(String name){
  24.         return userService.findByName(name);
  25.     };
  27.     //根据用户名模糊查询
  28.     @RequestMapping("/findByUsernameLike")
  29.     public List<User> findByUsernameLike(String username){
  30.         return userService.findByUsernameLike(username);
  31.     };
  33.     //根据id查询用户对象
  34.     @RequestMapping("/findById")
  35.     public User findById(Integer id){
  36.         return userService.findById(id);
  37.     }
  39.     //多条件动态查询
  40.     @RequestMapping("/find")
  41.     public List<User> find(User user){
  42.         return userService.find(user);
  43.     };
  45.     //分页查询
  46.     @RequestMapping("/findByPageAll")
  47.     public List<User> findByPageAll(User user){
  48.         return userService.findByPageAll(user);
  49.     };
  51.     //新增
  52.     @RequestMapping("/addSave")
  53.     public String addSave(){
  54.         User user = new User();
  55.         user.setName("张三");
  56.         user.setUsername("admin");
  57.         user.setPassword("admin");
  58.         userService.addSave(user);
  59.         user.setName("李四");
  60.         user.setUsername("123456");
  61.         user.setPassword("123456");
  62.         userService.addSave(user);
  63.         user.setName("王五");
  64.         user.setUsername("user");
  65.         user.setPassword("123456");
  66.         userService.addSave(user);
  67.         return "数据保存成功！";
  68.     };
  70.     //修改
  71.     @RequestMapping("/update")
  72.     public String update(){
  73.         User user = userService.findById(1);
  74.         user.setName("诸葛亮");
  75.         userService.update(user);
  76.         return "修改成功！";
  77.     };
  78. }

2、测试应用

运行项目，在浏览器中访问http://localhost/user/addSave，调用添加方法，添加保存方法中对应的数据，执行成功后返回“数据保存成功！”，如图。

20191206224538980.png

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 3

测试查询所有方法，在浏览器中输入http://localhost/user/findAll，查询数据库中所有数据，如图

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 4

测试修改方法，在浏览器中输入http://localhost/user/update，修改成功返回“修改成功！”，如图

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 5

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 6

测试动态查询，在浏览器中输入http://localhost/user/find?name=李四，查询返回结果如图。

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 7

测试分页查询，在浏览器中输入http://localhost/user/findByPageAll?offset=1&limit=2，从索引为1开始查询，查询3条数据，索引是从0开始的，查询结构如图。

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 8

基本查询就这些了，有什么不足之处，欢迎大家指出，期待与你的交流。

发表评论

表情：
评论列表 （有 0 条评论，159人围观）

还没有评论，来说两句吧...

相关阅读