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> <!--版本号可以不用指定,SpringBoot会选用合适的版本--> </dependency>
言归正传,下面说在springBoot中配置MyBatis。
关于在SpringBoot中集成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
packageorg.springboot.sample.mapper; importjava.util.List; importorg.springboot.sample.entity.Student; /** *StudentMapper,映射SQL语句的接口,无逻辑实现 * *@author单红宇(365384722) *@create2016年1月20日 */ publicinterfaceStudentMapperextendsMyMapper<Student>{ List<Student>likeName(Stringname); StudentgetById(intid); StringgetNameById(intid); }
MyMapper.java
packageorg.springboot.sample.config.mybatis; importtk.mybatis.mapper.common.Mapper; importtk.mybatis.mapper.common.MySqlMapper; /** *被继承的Mapper,一般业务Mapper继承它 * */ publicinterfaceMyMapper<T>extendsMapper<T>,MySqlMapper<T>{ //TODO //FIXME特别注意,该接口不能被扫描到,否则会出错 }
StudentMapper.xml
<?xmlversion="1.0"encoding="UTF-8"?> <!DOCTYPEmapperPUBLIC"-//mybatis.org//DTDMapper3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mappernamespace="org.springboot.sample.mapper.StudentMapper"> <!--type为实体类Student,包名已经配置,可以直接写类名--> <resultMapid="stuMap"type="Student"> <idproperty="id"column="id"/> <resultproperty="name"column="name"/> <resultproperty="sumScore"column="score_sum"/> <resultproperty="avgScore"column="score_avg"/> <resultproperty="age"column="age"/> </resultMap> <selectid="getById"resultMap="stuMap"resultType="Student"> SELECT* FROMSTUDENT WHEREID=#{id} </select> <selectid="likeName"resultMap="stuMap"parameterType="string"resultType="list"> SELECT* FROMSTUDENT WHERENAMELIKECONCAT('%',#{name},'%') </select> <selectid="getNameById"resultType="string"> SELECTNAME FROMSTUDENT WHEREID=#{id} </select> </mapper>
3、实体类
packageorg.springboot.sample.entity; importjava.io.Serializable; /** *学生实体 * *@author单红宇(365384722) *@create2016年1月12日 */ publicclassStudentimplementsSerializable{ privatestaticfinallongserialVersionUID=2120869894112984147L; privateintid; privateStringname; privateStringsumScore; privateStringavgScore; privateintage; //getset方法省略 }
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 privateStudentMapperstuMapper; @RequestMapping("/likeName") publicList<Student>likeName(@RequestParamStringname){ returnstuMapper.likeName(name); }
二、使用注解方式
查看官方Git上的代码使用注解方式,配置上很简单,使用上要对注解多做了解。至于xml和注解这两种哪种方法好,众口难调还是要看每个人吧。
1、启动类(我的)中添加@MapperScan注解
@SpringBootApplication @MapperScan("sample.mybatis.mapper") publicclassSampleMybatisApplicationimplementsCommandLineRunner{ @Autowired privateCityMappercityMapper; publicstaticvoidmain(String[]args){ SpringApplication.run(SampleMybatisApplication.class,args); } @Override publicvoidrun(String...args)throwsException{ System.out.println(this.cityMapper.findByState("CA")); } }
2、在接口上使用注解定义CRUD语句
packagesample.mybatis.mapper; importorg.apache.ibatis.annotations.Param; importorg.apache.ibatis.annotations.Select; importsample.mybatis.domain.City; /** *@authorEddúMeléndez */ publicinterfaceCityMapper{ @Select("SELECT*FROMCITYWHEREstate=#{state}") CityfindByState(@Param("state")Stringstate); }
其中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
packageorg.springboot.sample.config; importjava.util.Properties; importorg.slf4j.Logger; importorg.slf4j.LoggerFactory; importorg.springframework.context.annotation.Bean; importorg.springframework.context.annotation.Configuration; importcom.github.pagehelper.PageHelper; /** *MyBatis配置 * *@author单红宇(365384722) *@create2016年1月21日 */ @Configuration publicclassMyBatisConfiguration{ privatestaticfinalLoggerlogger=LoggerFactory.getLogger(MyBatisConfiguration.class); @Bean publicPageHelperpageHelper(){ logger.info("注册MyBatis分页插件PageHelper"); PageHelperpageHelper=newPageHelper(); Propertiesp=newProperties(); p.setProperty("offsetAsPageNum","true"); p.setProperty("rowBoundsWithCount","true"); p.setProperty("reasonable","true"); pageHelper.setProperties(p); returnpageHelper; } }
3、分页查询测试
@RequestMapping("/likeName") publicList<Student>likeName(@RequestParamStringname){ PageHelper.startPage(1,1); returnstuMapper.likeName(name); }
更多参数使用方法,详见PageHelper说明文档。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持毛票票。