前言
SpringBoot
是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置,从而使开发人员不再需要定义样板化的配置。
在SpringBoot
中,如果需要访问数据库,只需要引入spring-boot-starter-data-jpa
这个starter即可。这个starter默认引入的orm
是hibernate
,hibernate
自然有其自身的优缺点,这里不做讨论。本文讨论的是如何在SpringBoot
环境中引入mybatis
。
pom.xml
如果需要使用mybatis
,只需要引入mybatis-spring-boot-starter
即可,如下:
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.2.0</version>
</dependency>
相关的mybatis
,mybatis-spring
,mybatis-spring-boot-autofigure
等都会被引入。
到这里,mybatis的集成工作基本就完成了。spring默认会扫描@mapper
注解的接口并实例化为mapper,并通过环境变量mybatis.mapper-locations
的值确定包含mapper的xml文件的路径。
控制
@mapper
注解的扫描包路径
在你的@SpringBootApplication
注解的类上添加如下注解即可:
@MapperScan(value = "com.xxx.xxx", annotationClass = Mapper.class)
SpringBoot
启动后,会扫描此包下所有的包含@mapper
的接口(或类?),并实例化,如果你想指定实例化对象的名字,可通过如下注解:
@Repository("xxxXXXX")
这样如果需要注入此对象,可使用@Resource(name = "xxxXXXX")
注解.
控制包含mapper的xml文件的路径
SpringBoot
会扫描环境变量mybatis.mapper-locations
值所指向的路径,例如classpath:db/mapper/**/*.xml
,此值可以通过多种方式指定。
- 通过环境变量指定
System.setProperty("mybatis.mapper-locations", "classpath:db/mapper/**/*.xml")
; - 通过application.properties文件指定
mybatis.mapper-locations=classpath:db/mapper/**/*.xml
多说一句
mybatis
支持通过@mapper
注解或xml文件来实例化mapp对象,两种方式各有其优缺点。我个人比较倾向于使用注解的方式,因为使用注解来编程器效率是十分高效的,且代码后期的维护也较为容易。不过由于目前xml的一些功能使用注解还不能实现,因此推荐xml文件和注解两种方式混用。具体方式就是使用mybatis-generator
来生成固定的包含mapper的xml文件;使用注解来编写需要自定义的mapper接口文件(在接口文件中可以使用@select
、@update
等注解)。
完
mybatis
分页及拦截器的配置将在后续文章中继续。