MyBatis 是一款优秀的持久层框架,它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息,将接口和 Java 的 POJOs(Plain Ordinary Java Object,普通的 Java对象)映射成数据库中的记录。
1.添加依赖
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.2</version>
</dependency>
2.配置application.properties
# 数据库url
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/demo?characterEncoding=utf8&serverTimezone=GMT%2B8
# 数据库用户名
spring.datasource.username=demo
# 数据库密码
spring.datasource.password=demo
# 数据库驱动
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
#mapper xml 文件地址
mybatis.mapper-locations=classpath*:mapper/*Mapper.xml
#sql打印
mybatis.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
#设定超时被废弃的连接占到多少比例时要被关闭或上报
spring.datasource.abandon-when-percentage-full
#使用Hikari pool时,是否允许连接池暂停,默认为: false
spring.datasource.allow-pool-suspension
#是否允许替代的用户名.
spring.datasource.alternate-username-allowed
#指定updates是否自动提交.
spring.datasource.auto-commit
#指定默认的catalog.
spring.datasource.catalog
#设置当连接被归还时,是否要提交所有还未完成的事务
spring.datasource.commit-on-return
#指定连接被创建,再被添加到连接池之前执行的sql.
spring.datasource.connection-init-sql
#使用DBCP connection pool时,指定初始化时要执行的sql
spring.datasource.connection-init-sqls
#在使用DBCP connection pool时指定要配置的属性
spring.datasource.connection-properties.[key]
#指定校验连接合法性执行的sql语句
spring.datasource.connection-test-query
#指定连接的超时时间,毫秒单位.
spring.datasource.connection-timeout
#在初始化数据库时,遇到错误是否继续,默认false
spring.datasource.continue-on-error
#指定Data (DML)脚本
spring.datasource.data
#指定数据源的全限定名.
spring.datasource.data-source-class-name
#指定jndi的地址
spring.datasource.data-source-jndi
#使用Hikari connection pool时,指定要设置的属性
spring.datasource.data-source-properties.[key]
#使用Tomcat connection pool,指定要设置的属性
spring.datasource.db-properties
#是否自动提交.
spring.datasource.default-auto-commit
#指定连接默认的catalog.
spring.datasource.default-catalog
#是否设置默认连接只读.
spring.datasource.default-read-only
#指定连接的事务的默认隔离级别.
spring.datasource.default-transaction-isolation
#指定driver的类名,默认从jdbc url中自动探测.
spring.datasource.driver-class-name
#是否采用FIFO返回连接.
spring.datasource.fair-queue
#使用Hikari connection pool时,在心跳检查时传递的属性
spring.datasource.health-check-properties.[key]
#指定连接多久没被使用时,被设置为空闲,默认为10ms
spring.datasource.idle-timeout
#当初始化连接池时,是否忽略异常.
spring.datasource.ignore-exception-on-pre-load
#当连接创建时,执行的sql
spring.datasource.init-sql
#指定启动连接池时,初始建立的连接数量
spring.datasource.initial-size
#当创建连接池时,没法创建指定最小连接数量是否抛异常
spring.datasource.initialization-fail-fast
#指定初始化数据源,是否用data.sql来初始化,默认: true
spring.datasource.initialize
#指定内部查询是否要被隔离,默认为false
spring.datasource.isolate-internal-queries
#使用Tomcat connection pool时,指定jdbc拦截器,分号分隔
spring.datasource.jdbc-interceptors
#指定JDBC URL.
spring.datasource.jdbc-url
#是否开启JMX,默认为: false
spring.datasource.jmx-enabled
#指定jndi的名称.
spring.datasource.jndi-name
#使用Hikari connection pool时,多少毫秒检测一次连接泄露.
spring.datasource.leak-detection-threshold
#使用DBCP connection pool,是否追踪废弃statement或连接,默认为: false
spring.datasource.log-abandoned
#当使用Tomcat connection pool是否打印校验错误.
spring.datasource.log-validation-errors
#指定连接数据库的超时时间.
spring.datasource.login-timeout
#指定连接池中最大的活跃连接数.
spring.datasource.max-active
#指定连接池中连接的最大年龄
spring.datasource.max-age
#指定连接池最大的空闲连接数量.
spring.datasource.max-idle
#指定连接池中连接的最大生存时间,毫秒单位.
spring.datasource.max-lifetime
#指定最大的打开的prepared statements数量.
spring.datasource.max-open-prepared-statements
#指定连接池等待连接返回的最大等待时间,毫秒单位.
spring.datasource.max-wait
#指定连接池最大的连接数,包括使用中的和空闲的连接.
spring.datasource.maximum-pool-size
#指定一个空闲连接最少空闲多久后可被清除.
spring.datasource.min-evictable-idle-time-millis
#指定必须保持连接的最小值(For DBCP and Tomcat connection pools)
spring.datasource.min-idle
#指定连接维护的最小空闲连接数,当使用HikariCP时指定.
spring.datasource.minimum-idle
#指定数据源名.
spring.datasource.name
#指定运行每个idle object evictor线程时的对象数量
spring.datasource.num-tests-per-eviction-run
#指定数据库密码.
spring.datasource.password
#指定schema要使用的Platform(schema-${platform}.sql),默认为: all
spring.datasource.platform
#指定连接池名字.
spring.datasource.pool-name
#指定是否池化statements.
spring.datasource.pool-prepared-statements
#在等待连接时,如果线程被中断,是否传播中断状态.
spring.datasource.propagate-interrupt-state
#当使用Hikari connection pool时,是否标记数据源只读
spring.datasource.read-only
#指定Hikari connection pool是否注册JMX MBeans.
spring.datasource.register-mbeans
#指定当连接超过废弃超时时间时,是否立刻删除该连接.
spring.datasource.remove-abandoned
#指定连接应该被废弃的时间.
spring.datasource.remove-abandoned-timeout
#在归还连接时,是否回滚等待中的事务.
spring.datasource.rollback-on-return
#指定Schema (DDL)脚本.
spring.datasource.schema
#指定初始化脚本的语句分隔符,默认: ;
spring.datasource.separator
#指定SQL scripts编码.
spring.datasource.sql-script-encoding
#指定打印废弃连接前的超时时间.
spring.datasource.suspect-timeout
#当从连接池借用连接时,是否测试该连接.
spring.datasource.test-on-borrow
#创建时,是否测试连接
spring.datasource.test-on-connect
#在连接归还到连接池时是否测试该连接.
spring.datasource.test-on-return
#当连接空闲时,是否执行连接测试.
spring.datasource.test-while-idle
#指定空闲连接检查、废弃连接清理、空闲连接池大小调整之间的操作时间间隔
spring.datasource.time-between-eviction-runs-millis
#指定事务隔离级别,使用Hikari connection pool时指定
spring.datasource.transaction-isolation
#指定JDBC URL.
spring.datasource.url
#是否对连接进行包装,防止连接关闭之后被使用.
spring.datasource.use-disposable-connection-facade
#比较方法名时是否使用String.equals()替换==.
spring.datasource.use-equals
#是否对连接操作加锁
spring.datasource.use-lock
#指定数据库名.
spring.datasource.username
#指定多少ms执行一次连接校验.
spring.datasource.validation-interval
#指定获取连接时连接校验的sql查询语句.
spring.datasource.validation-query
#指定连接校验查询的超时时间.
spring.datasource.validation-query-timeout
#设定连接校验的超时时间,当使用Hikari connection pool时指定
spring.datasource.validation-timeout
#用来测试查询的validator全限定名.
spring.datasource.validator-class-name
#指定数据源的全限定名.
spring.datasource.xa.data-source-class-name
#指定传递给XA data source的属性
spring.datasource.xa.properties
# 原文参考 https://segmentfault.com/a/1190000004316491
mysql5.x使用的驱动类是com.mysql.jdbc.Driver
mysql8.x使用的驱动类是com.mysql.cj.jdbc.Driver
3.编写测试类
3.1Controller
@RestController
@RequestMapping("/demo")
public class DemoController {
@Resource
private UserMapper userMapper;
@GetMapping
public Object get() {
return "demo 20210730";
}
@GetMapping("/user")
public Object getUser(Long id) {
return userMapper.selectById(id);
}
}
3.2Entity
@Data
public class User {
private Long id;
private String userName;
}
3.3Mapper
@Mapper
public interface UserMapper {
User selectById(Long id);
}
3.4mapper.xml
<?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.lhy.demo.mapper.UserMapper">
<resultMap id="BaseResultMap" type="com.xxx.demo.entity.User">
<result column="id" jdbcType="INTEGER" property="id"/>
<result column="user_name" jdbcType="VARCHAR" property="userName"/>
</resultMap>
<sql id="Base_Column_List">
`id`,`user_name`
</sql>
<select id="selectById" resultMap="BaseResultMap">
select
<include refid="Base_Column_List"/>
from user
where id = #{id}
</select>
</mapper>