一起来学SpringBoot | 第七篇：整合Mybatis

超、凢脫俗 2022-05-23 11:24 162阅读 0赞

>  *  \*\*本文作者：\*\*唐亚峰

*  **本文链接：**[http://blog.battcn.com/2018/05/09/springboot/v2-orm-mybatis/][http_blog.battcn.com_2018_05_09_springboot_v2-orm-mybatis]
 *  \*\*版权声明：\*\*本博客所有文章除特别声明外，均采用[CC BY-NC-SA 3.0][]许可协议。转载请注明出处！

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

## 强烈推荐 ##

分享一个大神的人工智能教程。零基础！通俗易懂！风趣幽默！还带黄段子！希望你也加入到人工智能的队伍中来！[http://www.captainbed.net][http_www.captainbed.net]

> `SpringBoot`是为了简化`Spring`应用的创建、运行、调试、部署等一系列问题而诞生的产物，**`自动装配的特性让我们可以更好的关注业务本身而不是外部的XML配置，我们只需遵循规范，引入相关的依赖就可以轻易的搭建出一个 WEB 工程`**

`MyBatis`是一款优秀的持久层框架，它**支持定制化 SQL、存储过程以及高级映射，几乎避免了所有的 JDBC 代码和手动设置参数以及获取结果集，使用简单的 XML 或注解来配置和映射原生信息，将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录，在国内可谓是占据了半壁江山……**

## ORM对比图 ##

以下针对\*\*`Spring JDBC`、`Spring Data Jpa`、`Mybatis`\*\*三款框架做了个粗略的对比。**一般应用的性能瓶颈并不是在于ORM，所以这三个框架技术选型应该考虑`项目的场景`、`团队的技能掌握情况`、`开发周期(开发效率)`…**

## ORM对比图 ##

<table> 
 <thead> 
  <tr> 
   <th>框架对比</th> 
   <th>Spring JDBC</th> 
   <th>Spring Data Jpa</th> 
   <th>Mybatis</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>性能</td> 
   <td>性能最好</td> 
   <td>性能最差</td> 
   <td>居中</td> 
  </tr> 
  <tr> 
   <td>代码量</td> 
   <td>多</td> 
   <td>少</td> 
   <td>多</td> 
  </tr> 
  <tr> 
   <td>学习成本</td> 
   <td>低</td> 
   <td>高</td> 
   <td>居中</td> 
  </tr> 
  <tr> 
   <td>推荐指数</td> 
   <td>❤❤❤</td> 
   <td>❤❤❤❤❤</td> 
   <td>❤❤❤❤❤</td> 
  </tr> 
 </tbody> 
</table>

> **个人观点**

抛开学习成本而言，对于业务简单的中小型项目中使用`Spring Data Jpa`开发无异于是最快速的。但是鉴于国内市场环境而言，掌握`Mybatis`无异于是佳的选择，低学习成本和动态SQL解耦的特点使得更容易被人们所接受。对于业务复杂且对性能要求较高的项目来说`Mybatis`往往能更好的胜任，可以自己进行SQL优化，同时更让我喜欢的是[Mybatis分页插件][Mybatis]与[通用Mapper(单表CURD无需自己手写)][Mapper_CURD]有了这两款插件的支持，还有什么理由拒绝`Mybatis`呢

## 导入依赖 ##

在`pom.xml`中添加`Mybatis`的依赖包`mybatis-spring-boot-starter`，该包拥有自动装配的特点

<dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>1.3.2</version>
    </dependency>
    
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
    
    <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>
        <scope>test</scope>
    </dependency>

## 连接数据库 ##

与\*\*`SpringDataJpa`、`Spring JDBC`\*\*一样，需要在`application.properties`中添加数据源的配置，同时也需要添加对`mybatis`的配置

spring.datasource.url=jdbc:mysql://localhost:3306/chapter6?useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&allowMultiQueries=true&useSSL=false
    spring.datasource.username=root
    spring.datasource.password=root
    # 注意注意
    mybatis.mapper-locations=classpath:mapper/*.xml
    mybatis.type-aliases-package=com.winterchen.entity
    # 驼峰命名规范 如：数据库字段是  order_id 那么 实体字段就要写成 orderId
    mybatis.configuration.map-underscore-to-camel-case=true

**`mybatis.configuration.map-underscore-to-camel-case`是一个非常好的配置项，合理的命名规范可以让我们省略很多不必要的麻烦，比如xx-mapper.xml中的`resultMap`的映射可以省略掉了**

## 具体编码 ##

完成基本配置后，接下来进行具体的编码操作。

### 表结构 ###

创建一张`t_user`的表

CREATE TABLE `t_user` (
      `id` int(8) NOT NULL AUTO_INCREMENT COMMENT '主键自增',
      `username` varchar(50) NOT NULL COMMENT '用户名',
      `password` varchar(50) NOT NULL COMMENT '密码',
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='用户表';

### 实体类 ###

package com.winterchen.entity;
    
    import java.io.Serializable;
    
    /** * Created by Donghua.Chen on 2018/6/7. */
    public class User implements Serializable { 
    
        private static final long serialVersionUID = 8655851615465363473L;
    
        private Long id;
        private String username;
        private String password;
    
           public User() { 
        }
    
        public User(String username, String password) { 
            this.username = username;
            this.password = password;
        }
    
        public User(Long id, String username, String password) { 
            this.id = id;
            this.username = username;
            this.password = password;
        }
    
        // TODO 省略get set
    }

### 持久层 ###

这里提供了两种方式操作接口，第一种带`@Select`注解的是`Mybatis3.x`提供的新特性，同理它还有\*\*`@Update`、`@Delete`、`@Insert`等等一系列注解\*\*，第二种就是传统方式了，写个接口映射，然后在XML中写上我们的SQL语句…

UserMapper

package com.winterchen.mapper;
    
    import com.winterchen.entity.User;
    import org.apache.ibatis.annotations.Mapper;
    import org.apache.ibatis.annotations.Param;
    import org.apache.ibatis.annotations.Select;
    
    import java.util.List;
    
    /** * t_user 操作：演示两种方式 * <p>第一种是基于mybatis3.x版本后提供的注解方式<p/> * <p>第二种是早期写法，将SQL写在 XML 中<p/> * * Created by Donghua.Chen on 2018/6/7. */
    @Mapper
    public interface UserMapper { 
    
    
        /** * 根据用户名查询用户结果集 * * @param username 用户名 * @return 查询结果 */
        @Select("SELECT * FROM t_user WHERE username = #{username}")
        List<User> findByUsername(@Param("username") String username);
    
    
        /** * 保存用户信息 * * @param user 用户信息 * @return 成功 1 失败 0 */
        int insert(User user);
    }

> `UserMapper`映射文件

<?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.winterchen.mapper.UserMapper">
    
      <insert id="insert" parameterType="com.winterchen.entity.User">
        INSERT INTO `t_user`(`username`,`password`) VALUES (#{username},#{password})
      </insert>
    
    </mapper>

### 测试 ###

完成数据访问层接口后，最后编写一个`junit`测试类来检验代码的正确性。

package com.winterchen;
    
    import com.winterchen.entity.User;
    import com.winterchen.mapper.UserMapper;
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    
    import java.util.List;
    
    @RunWith(SpringRunner.class)
    @SpringBootTest
    public class SpringBootMybatisApplicationTests { 
    
        private static final Logger log = LoggerFactory.getLogger(SpringBootMybatisApplicationTests.class);
    
        @Autowired
        private UserMapper userMapper;
    
        @Test
        public void test1() throws Exception { 
            final int row1 = userMapper.insert(new User("u1", "p1"));
            log.info("[添加结果] - [{}]", row1);
            final int row2 = userMapper.insert(new User("u2", "p2"));
            log.info("[添加结果] - [{}]", row2);
            final int row3 = userMapper.insert(new User("u1", "p3"));
            log.info("[添加结果] - [{}]", row3);
            final List<User> u1 = userMapper.findByUsername("u1");
            log.info("[根据用户名查询] - [{}]", u1);
        }
    
    }

## 总结 ##

更多`Mybatis`的骚操作，请参考[官方文档][Link 1]

目前很多大佬都写过关于\*\*`SpringBoot`\*\*的教程了，如有雷同，请多多包涵，本教程基于最新的`spring-boot-starter-parent：2.0.1.RELEASE`编写，包括新版本的特性都会一起介绍…

## 说点什么 ##

springboot技术交流群：681513531

个人博客：[https://blog.winterchen.com][https_blog.winterchen.com]

全文代码：[https://github.com/WinterChenS/springboot-learning-experience][https_github.com_WinterChenS_springboot-learning-experience]

*  \*\*本文作者：\*\*唐亚峰
 *  **本文链接：**[http://blog.battcn.com/2018/05/09/springboot/v2-orm-mybatis/][http_blog.battcn.com_2018_05_09_springboot_v2-orm-mybatis]
 *  \*\*版权声明：\*\*本博客所有文章除特别声明外，均采用[CC BY-NC-SA 3.0][]许可协议。转载请注明出处！

[http_blog.battcn.com_2018_05_09_springboot_v2-orm-mybatis]: http://blog.battcn.com/2018/05/09/springboot/v2-orm-mybatis/
[CC BY-NC-SA 3.0]: https://creativecommons.org/licenses/by-nc-sa/3.0/
[http_www.captainbed.net]: http://www.captainbed.net/luischen
[Mybatis]: https://gitee.com/free/Mybatis_PageHelper
[Mapper_CURD]: https://gitee.com/free/Mapper
[Link 1]: http://www.mybatis.org/mybatis-3/zh/index.html
[https_blog.winterchen.com]: https://blog.winterchen.com
[https_github.com_WinterChenS_springboot-learning-experience]: https://github.com/WinterChenS/springboot-learning-experience