Spring Boot MyBatis 连接数据库配置示例

 更新时间:2017年02月24日 11:44:46   作者:catoop  
本篇文章主要介绍了Spring Boot MyBatis 连接数据库示例的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下。

最近比较忙,没来得及抽时间把MyBatis的集成发出来,其实mybatis官网在2015年11月底就已经发布了对SpringBoot集成的Release版本,示例代码:spring-boot_jb51.rar

前面对JPA和JDBC连接数据库做了说明,本文也是参考官方的代码做个总结。

先说个题外话,SpringBoot默认使用 org.apache.tomcat.jdbc.pool.DataSource

现在有个叫 HikariCP 的JDBC连接池组件,据说其性能比常用的 c3p0、tomcat、bone、vibur 这些要高很多。

我打算把工程中的DataSource变更为HirakiDataSource,做法很简单:

首先在application.properties配置文件中指定dataSourceType

spring.datasource.type=com.zaxxer.hikari.HikariDataSource

然后在pom中添加Hikari的依赖

<dependency>
  <groupId>com.zaxxer</groupId>
  <artifactId>HikariCP</artifactId>
  <!-- 版本号可以不用指定,Spring Boot会选用合适的版本 -->
</dependency>

言归正传,下面说在spring Boot中配置MyBatis。

关于在Spring Boot中集成MyBatis,可以选用基于注解的方式,也可以选择xml文件配置的方式。通过对两者进行实际的使用,还是建议使用XML的方式(官方也建议使用XML)。

下面将介绍通过xml的方式来实现查询,其次会简单说一下注解方式,最后会附上分页插件(PageHelper)的集成。

一、通过xml配置文件方式

1、添加pom依赖

<dependency>
  <groupId>org.mybatis.spring.boot</groupId>
  <artifactId>mybatis-spring-boot-starter</artifactId>
  <!-- 请不要使用1.0.0版本,因为还不支持拦截器插件,1.0.1-SNAPSHOT 是博主写帖子时候的版本,大家使用最新版本即可 -->
  <version>1.0.1-SNAPSHOT</version>
</dependency>

2、创建接口Mapper(不是类)和对应的Mapper.xml文件

定义相关方法,注意方法名称要和Mapper.xml文件中的id一致,这样会自动对应上

StudentMapper.Java

package org.springboot.sample.mapper;

import java.util.List;

import org.springboot.sample.entity.Student;

/**
 * StudentMapper,映射SQL语句的接口,无逻辑实现
 *
 * @author 单红宇(365384722)
 * @create 2016年1月20日
 */
public interface StudentMapper extends MyMapper<Student> {

  List<Student> likeName(String name);

  Student getById(int id);

  String getNameById(int id);

}

MyMapper.java

package org.springboot.sample.config.mybatis;

import tk.mybatis.mapper.common.Mapper;
import tk.mybatis.mapper.common.MySqlMapper;

/**
 * 被继承的Mapper,一般业务Mapper继承它
 *
 */
public interface MyMapper<T> extends Mapper<T>, MySqlMapper<T> {
  //TODO
  //FIXME 特别注意,该接口不能被扫描到,否则会出错
}

StudentMapper.xml

<?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="org.springboot.sample.mapper.StudentMapper">

  <!-- type为实体类Student,包名已经配置,可以直接写类名 -->
  <resultMap id="stuMap" type="Student">
    <id property="id" column="id" />
    <result property="name" column="name" />
    <result property="sumScore" column="score_sum" />
    <result property="avgScore" column="score_avg" />
    <result property="age" column="age" />
  </resultMap>

  <select id="getById" resultMap="stuMap" resultType="Student">
    SELECT *
    FROM STUDENT
    WHERE ID = #{id}
  </select>

  <select id="likeName" resultMap="stuMap" parameterType="string" resultType="list">
    SELECT *
    FROM STUDENT
    WHERE NAME LIKE CONCAT('%',#{name},'%')
  </select>

  <select id="getNameById" resultType="string">
    SELECT NAME
    FROM STUDENT
    WHERE ID = #{id}
  </select>


</mapper> 

3、实体类

package org.springboot.sample.entity;

import java.io.Serializable;

/**
 * 学生实体
 *
 * @author  单红宇(365384722)
 * @create  2016年1月12日
 */
public class Student implements Serializable{

  private static final long serialVersionUID = 2120869894112984147L;

  private int id;
  private String name;
  private String sumScore;
  private String avgScore;
  private int age;

  // get set 方法省略

}

4、修改application.properties 配置文件

mybatis.mapper-locations=classpath*:org/springboot/sample/mapper/sql/mysql/*Mapper.xml
mybatis.type-aliases-package=org.springboot.sample.entity

5、在Controller或Service调用方法测试

  @Autowired
  private StudentMapper stuMapper;

  @RequestMapping("/likeName")
  public List<Student> likeName(@RequestParam String name){
    return stuMapper.likeName(name);
  }

二、使用注解方式

查看官方Git上的代码使用注解方式,配置上很简单,使用上要对注解多做了解。至于xml和注解这两种哪种方法好,众口难调还是要看每个人吧。

1、启动类(我的)中添加@MapperScan注解

@SpringBootApplication
@MapperScan("sample.mybatis.mapper")
public class SampleMybatisApplication implements CommandLineRunner {

  @Autowired
  private CityMapper cityMapper;

  public static void main(String[] args) {
    SpringApplication.run(SampleMybatisApplication.class, args);
  }

  @Override
  public void run(String... args) throws Exception {
    System.out.println(this.cityMapper.findByState("CA"));
  }

}

2、在接口上使用注解定义CRUD语句

package sample.mybatis.mapper;

import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Select;

import sample.mybatis.domain.City;

/**
 * @author Eddú Meléndez
 */
public interface CityMapper {

  @Select("SELECT * FROM CITY WHERE state = #{state}")
  City findByState(@Param("state") String state);

}

其中City就是一个普通Java类。

三、集成分页插件

这里与其说集成分页插件,不如说是介绍如何集成一个plugin。MyBatis提供了拦截器接口,我们可以实现自己的拦截器,将其作为一个plugin装入到SqlSessionFactory中。

有位开发者写了一个分页插件,我觉得使用起来还可以,挺方便的。

项目地址: Mybatis-PageHelper_jb51.rar

下面简单介绍下:

首先要说的是,Spring在依赖注入bean的时候,会把所有实现MyBatis中Interceptor接口的所有类都注入到SqlSessionFactory中,作为plugin存在。既然如此,我们集成一个plugin便很简单了,只需要使用@Bean创建PageHelper对象即可。

1、添加pom依赖

<dependency>
  <groupId>com.github.pagehelper</groupId>
  <artifactId>pagehelper</artifactId>
  <version>4.1.0</version>
</dependency>

2、新增MyBatisConfiguration.java

package org.springboot.sample.config;

import java.util.Properties;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.github.pagehelper.PageHelper;

/**
 * MyBatis 配置
 *
 * @author 单红宇(365384722)
 * @create 2016年1月21日
 */
@Configuration
public class MyBatisConfiguration {

  private static final Logger logger = LoggerFactory.getLogger(MyBatisConfiguration.class);

  @Bean
  public PageHelper pageHelper() {
    logger.info("注册MyBatis分页插件PageHelper");
    PageHelper pageHelper = new PageHelper();
    Properties p = new Properties();
    p.setProperty("offsetAsPageNum", "true");
    p.setProperty("rowBoundsWithCount", "true");
    p.setProperty("reasonable", "true");
    pageHelper.setProperties(p);
    return pageHelper;
  }

}

3、分页查询测试

  @RequestMapping("/likeName")
  public List<Student> likeName(@RequestParam String name){
    PageHelper.startPage(1, 1);
    return stuMapper.likeName(name);
  }

更多参数使用方法,详见PageHelper说明文档。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • Java中注解@JsonFormat的用法详解

    Java中注解@JsonFormat的用法详解

    这篇文章主要给大家介绍了关于Java中注解@JsonFormat用法的相关资料,以及分享了@JsonFormat 将枚举序列化为对象的方法,文中给出了详细的代码实例,需要的朋友可以参考下
    2023-01-01
  • com.mysql.jdbc.Driver 和 com.mysql.cj.jdbc.Driver的区别及设定serverTimezone的方法

    com.mysql.jdbc.Driver 和 com.mysql.cj.jdbc.Driver的区

    这篇文章主要介绍了com.mysql.jdbc.Driver 和 com.mysql.cj.jdbc.Driver的区别以及设定serverTimezone的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-09-09
  • Java中List与数组之间的相互转换

    Java中List与数组之间的相互转换

    在日常Java学习或项目开发中,经常会遇到需要int[]数组和List列表相互转换的场景,然而往往一时难以想到有哪些方法,最后可能会使用暴力逐个转换法,往往不是我们所满意的,下面这篇文章主要给大家介绍了关于Java中List与数组之间的相互转换,需要的朋友可以参考下
    2023-05-05
  • SpringBoot自动配置之自定义starter的实现代码

    SpringBoot自动配置之自定义starter的实现代码

    这篇文章主要介绍了SpringBoot自动配置之自定义starter的实现代码,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-10-10
  • Java中enum枚举类型的基本特性详解

    Java中enum枚举类型的基本特性详解

    这篇文章主要介绍了Java中enum枚举类型的基本特性详解,enum关键字用于创建一个新类型,其中包含一组数量有限的命名变量,并视这些变量为常规程序组件,实践表明这是一种非常有用的类型,需要的朋友可以参考下
    2023-11-11
  • Spring Bean创建的另一条捷径

    Spring Bean创建的另一条捷径

    这篇文章主要为大家介绍了Spring Bean创建的另一条方法捷径详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-08-08
  • Java GUI制作简单的管理系统

    Java GUI制作简单的管理系统

    这篇文章主要为大家详细介绍了Java GUI制作简单的管理系统的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-01-01
  • Mybatis一对一延迟加载实现过程解析

    Mybatis一对一延迟加载实现过程解析

    这篇文章主要介绍了Mybatis一对一延迟加载实现过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-10-10
  • java 自动生成略缩图示例代码

    java 自动生成略缩图示例代码

    本篇文章,在前辈的经验基础上,分别对单图生成略缩图和批量生成略缩图做个小结
    2013-07-07
  • 用Java产生100个1-150间不重复数字

    用Java产生100个1-150间不重复数字

    这篇文章主要介绍了用Java产生100个1-150间不重复数字,需要的朋友可以参考下
    2017-02-02

最新评论