Spring Boot整合Mybatis支持XML配置和全注解两种方式,本篇将详细解说这两种方式的Mybatis整合,主要包含以下5部分内容:
- 数据源配置;
- 数据库连接池配置;
- XML配置方式整合;
- 注解方式整合;
- 事务管理。
数据源配置
数据源配置可以在application.properties或application.yml中配置,例如可以在application.properties中声明以下数据源配置:
spring.datasource.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
这些数据源属性配置都是在spring-boot-autoconfigure包中预先定义好的,只要配置了就会被自动加载并解析。其它更多以spring.datasource开头的属性配置可以在spring-boot-autoconfigure包的spring-configuration-metadata.json中查看。
数据库连接池配置
Spring Boot默认支持多种数据库连接池技术,例如HikariCP、Tomcat connection pool、Commons DBCP2,Spring Boot使用以下算法来选择特定的连接池:
- 如果HikariCP是可用的,总是选择它;
- 否则,如果Tomcat池的数据源可用,就使用它;
- 如果没有HikariCP或Tomcat池的数据源可用,如果Commons DBCP2可用,就使用它。
如果你使用spring-boot-starter-jdbc或spring-boot-starter-data-jpa,会自动添加对HikariCP的依赖,也就是说此时使用HikariCP。当然你也可以强制使用其它的连接池技术,可以通过在application.properties或application.yml中配置spring.datasource.type指定。
可以在application.properties或application.yml中配置连接池属性,不同连接池技术的属性配置前缀不同,可以通过使用各自的前缀(spring.datasource.hikari.*、spring.datasource.tomcat.*、 spring.datasource.dbcp2.*)来微调特定于实现的设置,例如可以在application.properties中配置以下Tomcat连接池属性:
spring.datasource.tomcat.max-wait=10000
spring.datasource.tomcat.max-active=50
spring.datasource.tomcat.test-on-borrow=true
更多连接池属性配置可以在spring-boot-autoconfigure包的spring-configuration-metadata.json中查看。
XML配置方式整合
1.添加依赖
整合Mybatis需要添加Mybatis框架相关jar,可以使用mybatis-spring-boot-starter,本例使用MySQL数据库,所以需要添加MySQL依赖jar,具体Gradle构建文件build.gradle如下:
plugins {
id 'java'
}
group 'spring-boot'
version '1.0-SNAPSHOT'
sourceCompatibility = 1.8
repositories {
jcenter()
}
dependencies {
compile("org.springframework.boot:spring-boot-starter-web:2.0.0.RELEASE")
compile("org.springframework.boot:spring-boot-starter-freemarker:2.0.0.RELEASE")
compile group: 'org.mybatis.spring.boot', name: 'mybatis-spring-boot-starter', version: '1.3.1'
compile group: 'mysql', name: 'mysql-connector-java', version: '6.0.6'
testCompile("org.springframework.boot:spring-boot-starter-test:2.0.0.RELEASE")
}
2.应用属性配置
在resources目录下新增application.properties,添加Freemarker、数据源和Mybatis属性配置,具体配置如下:
#freemarker
spring.freemarker.suffix=.html
#datasource
spring.datasource.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
#mybatis
#MyBatis映射文件的位置
mybatis.mapper-locations=classpath:mapper/*.xml
3.编写模板页面
在resources目录下新建templates目录,然后在该目录下新建bankDetail.html,具体代码如下:
银行信息
序号 | 名称 | 编号 |
${bank.id} | ${bank.bankName} | ${bank.bankCode} |
#if>
4.代码编写
编写银行信息实体类Bank.java:
public class Bank implements Serializable{
private Long id;
private String bankName;
private String bankCode;
//省略getter和setter
}
编写银行信息数据操作类BankMapper.java:
@Mapper
public interface BankMapper {
Bank findById(long id);
}
编写银行信息Service接口BankService.java和实现类BankServiceImpl.java:
public interface BankService {
Optional findById(Long id);
}
@Service
public class BankServiceImpl implements BankService {
@Autowired
private BankMapper bankMapper;
@Override
public Optional findById(Long id) {
Bank bank = bankMapper.findById(id);
return Optional.ofNullable(bank);
}
}
编写http请求处理类BankController.java:
@Controller
@RequestMapping("/banks")
public class BankController {
@Autowired
private BankService bankService;
@RequestMapping("/{id}")
public String findById(@PathVariable Long id, Model model) {
Optional bankOptional = bankService.findById(id);
if (bankOptional.isPresent()) {
model.addAttribute("bank", bankOptional.get());
}
return "bankDetail";
}
}
编写Spring Boot应用启动类Application.java:
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
在resources目录下新建mapper目录,然后在该目录下新建BankMapper.xml,具体代码如下:
SELECT id,bank_name,bank_code FROM BANK WHERE ID = #{id}
完整的代码目录结构如下图:
5.测试
运行Application的main方法启动Web应用,默认访问端口是8080,可以通过在application.properties或application.yml中配置server.port属性指定特定服务端口,例如server.port=9000,通过浏览器访问localhost:9000/banks/1验证结果。
6.代码解析
示例代码中对Mybatis的使用没什么不同,只是在application.properties配置了Mybatis映射文件存放路径:
mybatis.mapper-locations=classpath:mapper/*.xml
配置了Mybatis相关属性后会在应用启动时被加载解析并使用,更多可配置属性可在mybatis-spring-boot-autoconfigure包的spring-configuration-metadata.json中查看。
注解方式整合
注解方式和XML配置方式的不同就是不需要编写映射文件了,所以application.properties中也不需要配置Mybatis映射文件存放路径了,同时数据操作类需要使用Mybatis包中的注解进行标注,例如BankMapper.java如下:
@Mapper
public interface BankMapper {
@Results({
@Result(property = "bankName", column = "bank_name"),
@Result(property = "bankCode", column = "bank_code")
})
@Select("SELECT id,bank_name,bank_code FROM BANK WHERE ID = #{id}")
Bank findById(long id);
@Insert("INSERT INTO BANK(bank_name,bank_code) VALUES(#{bankName},#{bankCode})")
void create(Bank bank);
@Delete("DELETE FROM BANK WHERE id=#{id}")
void deleteById(int id);
@Update("UPDATE BANK SET bank_name=#{bankName},bank_code=#{bankCode} WHERE id=#{id}")
void update(Bank bank);
@Select("SELECT id,bank_name as bankName,bank_code as bankCode FROM BANK")
List findAll();
}
事务管理
使用mybatis-spring-boot-starter会自动添加spring-tx依赖和spring-jdbc依赖,同时Spring Boot会向容器自动注入DataSourceTransactionManager,这样可以不需要额外配置就可以使用@Transactional事务注解,进而在代码中进行事务管理及控制。