springboot2.x基础教程：集成mybatis最佳实践

前面文章介绍过SpringBoot结合Jpa实现对数据库的操作。今天介绍下SprigBoot集成Mybatis的相关知识点。
Mybatis作为一个半自动化的ORM框架,根据条件动态拼接SQL，是其一大优点。贴合原生SQL的写法，方便开发人员灵活的编写复杂的SQL语句。
SpringBoot集成Mybatis的配置还是相当简单的，教程并且会给出常见针对Mysql数据CURD、分页、批量操作的写法。

SpringBoot配置Mybatis

引入依赖

    org.mybatis.spring.boot
    mybatis-spring-boot-starter
    2.0.1



    com.github.pagehelper
    pagehelper
    5.1.2


    mysql
    mysql-connector-java
    runtime

配置数据源

这里使用springboot默认的数据连接池hikari,号称最快的数据库链接池，allowMultiQueries=true开启批量更新。

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/spring?autoReconnect=true&useSSL=false&characterEncoding=utf-8&failOverReadOnly=false&allowMultiQueries=true
    driver-class-name: com.mysql.jdbc.Driver
    username: root
    password: 123456
    hikari:
      maximum-pool-size: 50
      connection-test-query: SELECT 1
      #1分钟后释放
      idle-timeout: 600000
      minimum-idle: 10
      auto-commit: true
      validation-timeout: 250

配置Mybatis参数

这里有两种配置一种直接在springboot默认的application.yml中配置，一种单独提取出来配置，本文采用第二种。

mybatis:
  #指定配置mybatis参数配置地址
  config-location: classpath:mybatis-config.xml
  #指定接口xml地址
  mapper-locations: classpath:mappers/*.xml

这里贴出mybatis-config.xml的配置:

增删改查最优写法

针对这张表给出Mybatis常见动态SQL写法

image

首先编辑Mapper层接口，注意要加上@Mapper注解

@Mapper
@Repository
public interface UserMapper {
    //插入
    int insert(UserDO userDO);
    //分页查询
    List select(UserDO userDO);
    //更新
    int update(UserDO userDO);
    //删除
    int delete(UserDO userDO);
    //批量插入
    int insertBatch(List list);
    //批量更新
    int updateBatch(List list);
    //批量删除
    int deleteBatch(Long[] array);
}

前面配置了mapper-locations为classpath:mappers/*.xml，即mapper对应的xml文件放在src/main/resources/mappers目录下,

    
        id,name,account,age,forbidden,login_time,passwd
    
    
        insert into tb_user(
        
            id,
            account,
            passwd,
            name,
            
                age,
            
            
                forbidden,
            
            
                login_time,
            
        
        )values (
        
            #{id},
            #{account},
            #{passwd},
            #{name},
            
                #{age},
            
            
                #{forbidden},
            
            
                #{loginTime},
            
        
        )
    
    
        select
        
        from tb_user
        
            
                and account=#{account}
            
            
                and name like concat('%',#{name},'%')
            
        
    
    
        update tb_user
        
            
                name=#{name},
            
            
                age=#{age}
            
        
        where id=#{id}
    

    
        delete from tb_user where id=#{id}
    
    
        
            SELECT
            LAST_INSERT_ID()
        
        insert into tb_user(
        account,passwd,name,age,forbidden,login_time
        )values
        
            (#{user.account},
            #{user.passwd},
            #{user.name},
            #{user.age},
            #{user.forbidden},
            #{user.loginTime})
        

    
    
        
            update tb_user
            
                
                    name=#{name},
                
                
                    age=#{age}
                
            
            where id=#{id}
        
    
    
        delete from tb_user
        where id in
        
            #{id}
        
    

单元测试用例

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserMapperTest {
    @Autowired
    UserMapper userMapper;
    //插入
    @Test
    public void testAdd(){
        UserDO userDO=new UserDO();
        userDO.setPasswd("codehome");
        userDO.setAccount("codehome");
        userDO.setName("name");
        userDO.setForbidden(true);
        userDO.setLoginTime(LocalDateTime.now());
        userMapper.insert(userDO);
    }
    //分页
    @Test
    public void page(){
        PageHelper.startPage(0,10);
        UserDO userDO=new UserDO();
        userDO.setName("n");
       PageInfo userDOPage= new PageInfo<>(userMapper.select(userDO));
    }
    //更新
    @Test
    public void update(){
        UserDO userDO=new UserDO();
        userDO.setId(1L);
        userDO.setName("编程之家");
        userMapper.update(userDO);
    }
    //删除
    @Test
    public void delete(){
        UserDO userDO=new UserDO();
        userDO.setId(1L);
        userMapper.delete(userDO);
    }
    //批量插入
    @Test
    public void testAddBatch(){
        UserDO userDO=new UserDO();
        userDO.setPasswd("codehome");
        userDO.setAccount("codehome");
        userDO.setName("name");
        userDO.setForbidden(true);
        userDO.setLoginTime(LocalDateTime.now());
        UserDO userDO1=new UserDO();
        userDO1.setPasswd("codehome");
        userDO1.setAccount("codehome");
        userDO1.setName("name");
        userDO1.setForbidden(true);
        userDO1.setLoginTime(LocalDateTime.now());
        userMapper.insertBatch(Arrays.asList(userDO,userDO1));
    }
    //批量更新
    @Test
    public void testUpdateBatch(){
        UserDO userDO=new UserDO();
        userDO.setPasswd("codehome1");
        userDO.setAccount("codehome1");
        userDO.setName("name1");
        userDO.setId(1L);
        userDO.setForbidden(true);
        userDO.setLoginTime(LocalDateTime.now());
        UserDO userDO1=new UserDO();
        userDO.setId(2L);
        userDO1.setPasswd("codehome2");
        userDO1.setAccount("codehome2");
        userDO1.setName("name2");
        userDO1.setForbidden(true);
        userDO1.setLoginTime(LocalDateTime.now());
        userMapper.insertBatch(Arrays.asList(userDO,userDO1));
    }
    @Test
    public void deleteBatch(){
        userMapper.deleteBatch(new Long[]{1L,2L});
    }
}

这里举出的例子使用了if、set、where、foreach、trim、sql等标签，更详细的解释可以参考官方动态 SQL
以上就是对springboot集成Mybatis的配置，跟常见CURD与批量操作，更多的内容篇幅有限大家可以参考文中给出的链接。
千里之行，始于足下。这里是SpringBoot教程系列第十四篇，所有项目源码均可以在我的GitHub上面下载源码。