官方文档:http://mybatis.org/spring-boot-starter/mybatis-spring-boot-autoconfigure/
github文档:https://github.com/mybatis
0、简介
- 全局配置文件:Configure
- SqlSessionFactory: 自动配置好了
- SqlSession:自动配置了 SqlSessionTemplate 组合了SqlSession
- @Import(AutoConfiguredMapperScannerRegistrar.class):只要我们写的操作MyBatis的接口标注了 @Mapper ,就会被自动扫描进来
最佳实践:
- 引入mybatis-starter
- 配置application.yaml,指定mapper-location位置即可
- 编写Mapper接口并标注@Mapper注解
- 简单方法直接注解方式
- 复杂方法编写xxxxMapper.xml进行绑定映射
- @MapperScan("com.wust.mapper") ,使得该包下的接口可以不用标注@Mapper注解就能识别到
1、导入相关依赖
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.1</version>
</dependency>
2、配置数据源
spring:
datasource:
username: root
password: 123456
#?serverTimezone=UTC解决时区的报错
url: jdbc:mysql://localhost:3306/test?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
driver-class-name: com.mysql.cj.jdbc.Driver
type: com.alibaba.druid.pool.DruidDataSource
#Spring Boot 默认是不注入这些属性值的,需要自己绑定
#druid 数据源专有配置
initialSize: 5
minIdle: 5
maxActive: 20
maxWait: 60000
timeBetweenEvictionRunsMillis: 60000
minEvictableIdleTimeMillis: 300000
validationQuery: SELECT 1 FROM DUAL
testWhileIdle: true
testOnBorrow: false
testOnReturn: false
poolPreparedStatements: true
#配置监控统计拦截的filters,stat:监控统计、log4j:日志记录、wall:防御sql注入
#如果允许时报错 java.lang.ClassNotFoundException: org.apache.log4j.Priority
#则导入 log4j 依赖即可,Maven 地址:https://mvnrepository.com/artifact/log4j/log4j
filters: stat,wall,log4j
maxPoolPreparedStatementPerConnectionSize: 20
useGlobalDataSourceStat: true
connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500
3、创建数据库表对应的实体类
package com.wust.springboot.bean;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private Integer id;
private String name;
private String pwd;
}
4、创建mapper接口
@Mapper
public interface UserMapper {
//@Select("select * from user")
List<User> getAllUsers();
}
5、创建对应的mapper映射文件(resources/mapper/*)
<?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="com.wust.springboot.mapper.UserMapper">
<select id="getAllUsers" resultType="User">
select * from user;
</select>
</mapper>
6、配置mapper映射文件的位置以及实体类的简写
mybatis:
config-location: classpath:mybatis/mybatis-config.xml #全局配置文件位置
mapper-locations: classpath:mapper/*.xml #sql映射文件位置
type-aliases-package: com.wust.springboot.bean #设置全类名缩写
configuration: #相当于配置mybaitis xml配置文件中的setting项
map-underscore-to-camel-case: true #开启驼峰命名转换规则,数据库:user_id -> java bean:userId
7、测试
@RestController
public class UserController {
@Autowired
UserMapper userMapper;
@GetMapping("/users")
public List<User> users(){
return userMapper.getAllUsers();
}
}
- 这里偷懒省去了编写Service层的代码,在真实开发中还是得”墨守成规“。另外也可以使用注解开发,这样可以省去第5、6步以及yml配置文件中的步骤,然后对第四步进行更改即可
@Mapper
public interface UserMapper {
@Select("select * from user")
List<User> getAllUsers();
}