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

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的依赖

com.zaxxer

HikariCP

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

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

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

一、通过xml配置文件方式

1、添加pom依赖

org.mybatis.spring.boot

mybatis-spring-boot-starter

1.0.1-SNAPSHOT

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 {

List 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 extends Mapper, MySqlMapper {

//TODO

//FIXME 特别注意，该接口不能被扫描到，否则会出错

}

StudentMapper.xml

"http://mybatis.org/dtd/mybatis-3-mapper.dtd">

SELECT *

FROM STUDENT

WHERE ID = #{id}

SELECT *

FROM STUDENT

WHERE NAME LIKE CONCAT('%',#{name},'%')

SELECT NAME

FROM STUDENT

WHERE ID = #{id}

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 likeName(@RequestParam Strinhttp://g 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 Melndez

*/

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依赖

com.github.pagehelper

pagehelper

4.1.0

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 likeName(@RequestParam String name){

PageHelper.startPage(1, 1);

return stuMapper.likeName(name);

}

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

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。