SpringBoot2.X基础教程：SpringBoot整合MyBatis【附源码】

た入场券 2022-09-14 06:25 231阅读 0赞

> 微信号：hzy1014211086，如果你正在学习Spring Boot，可以加入我们的Spring技术交流群，共同成长

### 文章目录 ###

*  一、准备数据表
 *  二、添加依赖
 *  三、配置数据源
 *  四、编写领域对象
 *  五、注解配置方式
 *   *  新增
     *  修改
     *  查询
     *  删除
 *  六、XML配置方式
 *   *  新增
     *  修改
     *  查询
     *  删除
 *  七、源码

--------------------

上篇文章我们介绍了 [Spring Boot 对传统 JdbcTemplate 的集成][Spring Boot _ JdbcTemplate]，这篇文章我给大家介绍 Spring Boot 集成 MyBatis。这里分别介绍注解方式以及XML方式的整合。

# 一、准备数据表 #

CREATE TABLE `spring_boot`.`article`  (
      `id` int(11) NOT NULL AUTO_INCREMENT,
      `title` varchar(255) NULL COMMENT '文章标题',
      `author` varchar(255) NULL COMMENT '作者',
      PRIMARY KEY (`id`)
    ) COMMENT = '文章表';

# 二、添加依赖 #

<dependencies>
    	
    		<dependency>
    			<groupId>org.mybatis.spring.boot</groupId>
    			<artifactId>mybatis-spring-boot-starter</artifactId>
    			<version>2.2.0</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>mysql</groupId>
    			<artifactId>mysql-connector-java</artifactId>
    			<scope>runtime</scope>
    		</dependency>
    </dependencies>

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASmF2Yeeoi-W6j-mxvA_size_20_color_FFFFFF_t_70_g_se_x_16]

> 大家要注意依赖版本兼容性

# 三、配置数据源 #

spring.datasource.url = jdbc:mysql://139.196.20.xxx:3306/spring_boot?useUnicode=true&characterEncoding=utf-8
    spring.datasource.username = root
    spring.datasource.password = 123456
    spring.datasource.driver-class-name = com.mysql.cj.jdbc.Driver

# 四、编写领域对象 #

@Data
    @NoArgsConstructor
    public class Blog {
        
      private Integer id;
      private String title;
      private String author;
    }

# 五、注解配置方式 #

## 新增 ##

@RestController
    public class BlogController {
        
    
      @Autowired
      public BlogService blogService;
    
      /**
       * 新增一篇文章
       *
       * @param blog 文章实体类
       * @return
       */
      @PostMapping(value = "/create")
      public Object create(@RequestBody Blog blog) {
        
        if (StringUtils.isBlank(blog.getTitle())) {
        
          return ResponseUtil.fail(ResultEnums.BAD_ARGUMENT_VALUE.getCode(), "请输入文章标题");
        }
        if (StringUtils.isBlank(blog.getAuthor())) {
        
          return ResponseUtil.fail(ResultEnums.BAD_ARGUMENT_VALUE.getCode(), "请输入文章作者");
        }
        return blogService.create(blog);
      }
    }
    
    @Service
    public class BlogServiceImpl implements BlogService {
        
    
      @Autowired
      private BlogMapper blogMapper;
    
      @Override
      public Object create(Blog blog) {
        
        int count = blogMapper.create(blog);
        if (count > 0) {
        
          return ResponseUtil.ok("插入成功");
        } else {
        
          return ResponseUtil.fail(ResultEnums.SERIOUS.getCode(), "插入失败");
        }
      }
    }
    
    @Mapper
    public interface BlogMapper {
        
      @Insert("INSERT INTO article(title, author) VALUES(#{title}, #{author})")
      int create(Blog blog);
    }

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASmF2Yeeoi-W6j-mxvA_size_20_color_FFFFFF_t_70_g_se_x_16 1]

## 修改 ##

@RestController
    public class BlogController {
        
    
      @Autowired
      public BlogService blogService;
    
      /**
       * 通过id修改文章
       *
       * @param blog
       * @return
       */
      @PostMapping(value = "/updateById")
      public Object updateById(@RequestBody Blog blog) {
        
        if (StringUtils.isBlank(blog.getTitle())) {
        
          return ResponseUtil.fail(ResultEnums.BAD_ARGUMENT_VALUE.getCode(), "请输入文章标题");
        }
        if (StringUtils.isBlank(blog.getAuthor())) {
        
          return ResponseUtil.fail(ResultEnums.BAD_ARGUMENT_VALUE.getCode(), "请输入文章作者");
        }
        return blogService.updateById(blog);
      }
    }
    
    @Service
    public class BlogServiceImpl implements BlogService {
        
    
      @Autowired
      private BlogMapper blogMapper;
    
      @Override
      public Object updateById(Blog blog) {
        
        int count = blogMapper.updateById(blog);
        if (count > 0) {
        
          return ResponseUtil.ok("修改成功");
        } else {
        
          return ResponseUtil.fail(ResultEnums.SERIOUS.getCode(), "修改失败");
        }
      }
    }
    
    @Mapper
    public interface BlogMapper {
        
      @Update("UPDATE article SET title=#{title},author=#{author} WHERE id=#{id}")
      int updateById(Blog blog);
    }

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASmF2Yeeoi-W6j-mxvA_size_20_color_FFFFFF_t_70_g_se_x_16 2]

## 查询 ##

@RestController
    public class BlogController {
        
    
      @Autowired
      public BlogService blogService;
    
      /**
       * 查询所有文章
       *
       * @return
       */
      @GetMapping(value = "/getAll")
      public List<Blog> getAll() {
        
        return blogService.getAll();
      }
    
    
      /**
       * 通过标题查询文章
       *
       * @param title
       * @return
       */
      @GetMapping(value = "/getByTitle")
      public Object getByTitle(String title) {
        
        if (StringUtils.isBlank(title)) {
        
          return ResponseUtil.fail(ResultEnums.BAD_ARGUMENT_VALUE.getCode(), "请输入文章标题");
        }
        return blogService.getByTitle(title);
      }
    }
    
    @Service
    public class BlogServiceImpl implements BlogService {
        
    
      @Autowired
      private BlogMapper blogMapper;
    
      @Override
      public List<Blog> getAll() {
        
        return blogMapper.getAll();
      }
    
    
      @Override
      public List<Blog> getByTitle(String title) {
        
        return blogMapper.getByTitle(title);
      }
    }
    
    @Mapper
    public interface BlogMapper {
        
    
      @Select("SELECT * FROM article")
      @Results({
        
        @Result(column = "id", property = "id", javaType = Integer.class),
        @Result(property = "title", column = "title", javaType = String.class),
        @Result(property = "author", column = "author", javaType = String.class)
      })
      List<Blog> getAll();
    
      @Select("SELECT * FROM article WHERE title = #{title}")
      @Results({
        
        @Result(column = "id", property = "id", javaType = Integer.class),
        @Result(property = "title", column = "title", javaType = String.class),
        @Result(property = "author", column = "author", javaType = String.class)
      })
      List<Blog> getByTitle(String title);
    }

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASmF2Yeeoi-W6j-mxvA_size_20_color_FFFFFF_t_70_g_se_x_16 3]  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASmF2Yeeoi-W6j-mxvA_size_20_color_FFFFFF_t_70_g_se_x_16 4]

## 删除 ##

@RestController
    public class BlogController {
        
    
      @Autowired
      public BlogService blogService;
    
      /**
       * 通过ID删除文章
       *
       * @param id
       * @return
       */
      @PostMapping(value = "/deleteById")
      public Object deleteById(Integer id) {
        
        if (null == id || 0 == id.longValue()) {
        
          return ResponseUtil.fail(ResultEnums.BAD_ARGUMENT_VALUE.getCode(), "请输入文章id");
        }
        return blogService.deleteById(id);
      }
    }
    
    @Service
    public class BlogServiceImpl implements BlogService {
        
    
      @Autowired
      private BlogMapper blogMapper;
      
      @Override
      public Object deleteById(Integer id) {
        
        int count = blogMapper.deleteById(id);
        if (count > 0) {
        
          return ResponseUtil.ok("删除成功");
        } else {
        
          return ResponseUtil.fail(ResultEnums.SERIOUS.getCode(), "删除失败");
        }
      }
    }
    
    @Mapper
    public interface BlogMapper {
        
      @Delete("DELETE FROM article WHERE id = #{id}")
      int deleteById(Integer id);
    }

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASmF2Yeeoi-W6j-mxvA_size_20_color_FFFFFF_t_70_g_se_x_16 5]

# 六、XML配置方式 #

修改application.properties 配置文件

#指定bean所在包
    mybatis.type-aliases-package=com.fish.chapter6.domain
    #指定映射文件
    mybatis.mapperLocations=classpath:mapper/*.xml

## 新增 ##

@Mapper
    public interface BlogMapper {
        
      int create(Blog blog);
    }

<insert id="create" parameterType="com.fish.chapter6.domain.Blog">
        INSERT INTO article (title, author) VALUES (#{title}, #{author})
    </insert>

## 修改 ##

@Mapper
    public interface BlogMapper {
        
      int updateById(Blog blog);
    }

<update id="updateById" parameterType="com.fish.chapter6.domain.Blog">
        UPDATE article SET title = #{title}, author = #{author} WHERE id = #{id}
    </update>

## 查询 ##

@Mapper
    public interface BlogMapper {
        
    
      List<Blog> getAll();
      
      List<Blog> getByTitle(@Param("title") String title);
      
    }

<select id="getByTitle" resultMap="BaseResultMap">
            select
            <include refid="Base_Column_List"/>
            from article
            <where>
                <if test="title != null and title !=''">
                    AND title = #{title,jdbcType=VARCHAR}
                </if>
            </where>
    </select>
    
    <select id="getAll" resultMap="BaseResultMap">
        select
        <include refid="Base_Column_List"/>
        from article
    </select>

## 删除 ##

@Mapper
    public interface BlogMapper {
        
      int deleteById(@Param("id") Integer id);
    }

<delete id="deleteById" parameterType="java.lang.Integer">
        DELETE FROM article WHERE id = #{id}
    </delete>

更多mybatis数据访问操作的使用请参考：[MyBatis官方中文参考文档  
][MyBatis_]

> 彩蛋，很多小伙伴会发现一个问题，项目启动一段时间放那里不动，然后在访问接口时，就会报错，这和我们使用的数据源有关（Hikari），在后面《数据源详解》章节我会教大家如何解决。

# 七、源码 #

本文的相关例子可以查看下面仓库中的 **chapter6** 目录：

*  Gitee：https://gitee.com/hezhiyuan007/spring-boot-study
 *  Github：https://github.com/java-fish-0907/spring-boot-study

[Spring Boot _ JdbcTemplate]: https://blog.csdn.net/qq_35620342/article/details/120482647
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASmF2Yeeoi-W6j-mxvA_size_20_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/0cfd9b59ed65413e802ed024845eb23a.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASmF2Yeeoi-W6j-mxvA_size_20_color_FFFFFF_t_70_g_se_x_16 1]: /images/20220828/9e2dc296e9d5476384bb709d84e27434.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASmF2Yeeoi-W6j-mxvA_size_20_color_FFFFFF_t_70_g_se_x_16 2]: /images/20220828/5be7525070354220bd7eaf85f1f541b1.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASmF2Yeeoi-W6j-mxvA_size_20_color_FFFFFF_t_70_g_se_x_16 3]: /images/20220828/99d72716190e4444a5cb8e8f196a0fcf.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASmF2Yeeoi-W6j-mxvA_size_20_color_FFFFFF_t_70_g_se_x_16 4]: /images/20220828/a2dd3144db634a3cb63d311426050a91.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASmF2Yeeoi-W6j-mxvA_size_20_color_FFFFFF_t_70_g_se_x_16 5]: /images/20220828/96f16f4d969b4fb880e74e48048598b5.png
[MyBatis_]: https://mybatis.org/mybatis-3/zh/java-api.html