1. MyBatis简介
1.1 什么是Mybatis
- 是一款优秀的持久层框架
- 避免了几乎所有的JDBC代码和手动设置参数以及获取结果集的过程
- 可以使用简单的XML或注解来配置和映射原生信息,将接口和Java实体类映射成数据库中的记录
- 是一个半自动化的ORM(Object Relationship Mapping)框架
- 官方文档
1.2 持久层
- 完成持久化工作的代码块–>dao层
- 企业级应用,数据持久化将内存中的数据保存到磁盘上加以固化,而持久化的实现过程大多通过各种关系数据库来完成
1.3 第一个程序
- Mybatis核心配置文件
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<!--核心配置文件-->
<configuration>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url"
value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
<!--每一个Mapper.xml都需要在Mybatis核心配置文件中注册-->
<mappers>
<mapper resource="com/gai/dao/UserMapper.xml"/>
</mappers>
</configuration>
- Mybatis工具类
//sqlSessionFactory
public class MybatisUtils {
private static SqlSessionFactory sqlSessionFactory;
static {
try {
//使用mybatis第一步,获取sqlSessionFactory对象
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
} catch (IOException e) {
e.printStackTrace();
}
}
public static SqlSession getSqlSession() {
return sqlSessionFactory.openSession();
}
}
- 实体类
public class User {
private int id;
private String name;
private String pwd;
public User() {
}
public User(int id, String name, String pwd) {
this.id = id;
this.name = name;
this.pwd = pwd;
}
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getPwd() {
return pwd;
}
public void setPwd(String pwd) {
this.pwd = pwd;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", name='" + name + '\'' +
", pwd='" + pwd + '\'' +
'}';
}
}
- 接口类
public interface UserDao {
List<User> getUserList();
}
- Mapper.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">
<!--namespace绑定一个对应的Dao/Mapper接口-->
<mapper namespace="com.gai.dao.UserDao">
<select id="getUserList" resultType="com.gai.pojo.User">
select * from mybatis.user;
</select>
</mapper>
- 测试类
public class UserDaoTest {
@Test
public void test() {
//获得sqlSession对象
SqlSession sqlSession = null;
try {
sqlSession = MybatisUtils.getSqlSession();
//方式一:执行SQL
UserDao mapper = sqlSession.getMapper(UserDao.class);
List<User> userList = mapper.getUserList();
//方式二:不推荐
// List<User> userList = sqlSession.selectList("con.gai.dao.UserDao.getUserList");
for (User user : userList) {
System.out.println(user);
}
} catch (Exception e) {
e.printStackTrace();
} finally {
sqlSession.close();
}
}
}
2. CRUD操作及配置
所有的增删改操作都必须提交事务!
- 编写接口
public interface UserMapper {
//模糊查询
List<User> getUserLike(String value);
//查询全部用户
List<User> getUserList();
//根据ID查询用户
User getUserById(int id);
User getUserById2(Map<String,Object> map);
//insert一个用户
int addUser(User user);
//实体类或数据库中的表字段过多,多使用万能的Map
int addUser2(Map<String, Object> map);
//修改用户
int updateUser(User user);
//删除一个用户
int deleteUser(int id);
}
- 编写对应的mapper中的sql语句
<?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">
<!--namespace绑定一个对应的Dao/Mapper接口-->
<mapper namespace="com.gai.dao.UserMapper">
<select id="getUserLike" resultType="com.gai.pojo.User">
select * from mybatis.user where name like #{value}
</select>
<select id="getUserList" resultType="com.gai.pojo.User">
select * from mybatis.user;
</select>
<select id="getUserById" resultType="com.gai.pojo.User" parameterType="int">
select * from mybatis.user where id = #{id}
</select>
<select id="getUserById2" resultType="com.gai.pojo.User" parameterType="map">
select * from mybatis.user where id = #{id};
</select>
<!--对象中的属性,可以直接取出来-->
<insert id="addUser" parameterType="com.gai.pojo.User">
insert into mybatis.user (id, name, pwd) values (#{id},#{name},#{pwd});
</insert>
<!--传递map的key-->
<insert id="addUser2" parameterType="map">
insert into mybatis.user(id,name,pwd) values (#{userId},#{userName},#{passWord})
</insert>
<update id="updateUser" parameterType="com.gai.pojo.User">
update mybatis.user set name=#{name},pwd=#{pwd} where id=#{id};
</update>
<delete id="deleteUser" parameterType="int">
delete from mybatis.user where id=#{id};
</delete>
</mapper>
2.1 核心配置
- mybatis-config.xml系统核心配置文件,Mybatis的配置文件包含了会深深影响mybatis行为的设置和属性信息
- 能配置的内容如下:
configuration(配置)
properties(属性)
settings(设置)
typeAliases(类型别名)
typeHandlers(类型处理器)
objectFactory(对象工厂)
plugins(插件)
environments(环境配置)
environment(环境变量)
transactionManager(事务管理器)
dataSource(数据源)
databaseIdProvider(数据库厂商标识)
mappers(映射器)
<!--元素节点顺序,顺序不对会报错-->
2.1.1 environments元素
- Mybatis可以配置多种环境,尽管可以配置多个环境,但每个SqlSessionFactory实例只能选择一种环境
- mybatis默认的事务管理器是JDBC,POOLED
2.1.2 properties
- 可以通过properties属性来实现引用配置文件
- 这些属性都是可外部配置且可动态替换的,既可以在典型的Java属性文件中配置,也可通过properties元素的子元素来传递[db.properties]
driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8
<!--核心配置文件-->
<configuration>
<!--引入外部配置文件-->
<properties resource="db.properties">
<property name="username" value="root"/>
<property name="password" value="gaiwei200888"/>
</properties>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${driver}"/>
<property name="url"
value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
</environments>
<!--每一个Mapper.xml都需要在Mybatis核心配置文件中注册-->
<mappers>
<mapper resource="com/gai/dao/UserMapper.xml"/>
</mappers>
</configuration>
2.1.3 typeAliases类型别名
- 是为Java类型设置一个短的名字
- 减少类完全限定名的冗余
<!--可以给实体类起别名-->
<typeAliases>
<!--<typeAlias type="com.gai.pojo.User" alias="User"/>-->
<package name="com.gai.pojo"/><!--默认别名类名首字母小写-->
</typeAliases>
- 实体类较少时使用typeAlias
- 实体多时,使用package,可以在实体类加@Alias注解起DIY别名
2.1.4 settings
- 懒加载
- 日志实现
- 缓存开启
<settings>
<setting name="cacheEnabled" value="true"/>
<setting name="lazyLoadingEnabled" value="true"/>
<setting name="multipleResultSetsEnabled" value="true"/>
<setting name="useColumnLabel" value="true"/>
<setting name="useGeneratedKeys" value="false"/>
<setting name="autoMappingBehavior" value="PARTIAL"/>
<setting name="autoMappingUnknownColumnBehavior" value="WARNING"/>
<setting name="defaultExecutorType" value="SIMPLE"/>
<setting name="defaultStatementTimeout" value="25"/>
<setting name="defaultFetchSize" value="100"/>
<setting name="safeRowBoundsEnabled" value="false"/>
<setting name="mapUnderscoreToCamelCase" value="false"/>
<setting name="localCacheScope" value="SESSION"/>
<setting name="jdbcTypeForNull" value="OTHER"/>
<setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
</settings>
2.1.5 其他配置
- 映射器(mappers)
<mappers>
<!--<mapper resource="com/gai/dao/UserMapper.xml"/>--><!--推荐使用-->
<!--<mapper class="com.gai.dao.UserMapper"/>-->
<package name="com.gai.dao"/>
</mappers>
2.2 生命周期和作用域(Scope)
- 不同的生命周期和作用域时至关重要的,错误的使用会导致非常严重的并发问题
- SqlSessionFactoryBuilder的作用在于创建SqlSessionFactory,创建成功后,SqlSessionFactoryBuilder就失去作用,最佳作用域是方法作用域(局部变量)
- SqlSessionFacotry可以被认为一个数据库连接池,要长期保存他,直到不再使用MyBatis,最佳作用域是应用作用域,最简单的就是使用单例模式
- SqlSession就相当于数据库连接池的请求,线程不安全的,用完即关,最佳作用域是请求或方法作用域
- 这里面每一个Mapper,就代表一个具体的业务
3. ResultMap及分页
3.1 ResultMap
- 解决属性名和数据库字段名不一致的问题
<!--namespace绑定一个对应的Dao/Mapper接口-->
<mapper namespace="com.gai.dao.UserMapper">
<!--结果集映射-->
<resultMap id="userMap" type="com.gai.pojo.User">
<!--column数据库中的字段,property实体类中的属性-->
<result column="pwd" property="password"/>
</resultMap>
<select id="getUserById" resultMap="userMap" parameterType="int">
select id,name,pwd from mybatis.user where id = #{id}
</select>
</mapper>
- resultMap元素是Mybatis中最强大的元素,可以从90%的JDBC resultSets数据提取代码中解放
- ResultMap的设计思想是,对于简单的语句根本不需要配置显示的结果映射,对于复杂一点的语句只需要描述他们的关系就行了
3.2 日志工厂
- 对于以往开发过程,经常使用debug模块来调试,现在使用Mybatis是基于接口,配置文件的源代码执行过程
- Mybatis内置的日志工厂提供日志功能,具体的日志实现由以下几种:
- SLF4J
- LOG4j
- LOG4j2
- JDK logging
<settings>
<setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>
3.2.1 Log4j
- Log4j是apache的一个开源项目,通过使用log4j,可以控制日志信息输送的目的地是控制台、文件
- 通过一个配置文件来灵活进行配置,不需要修改应用的代码
- log4j.properties
#将等级为DEBUG的日志信息输出到console和file这两个目的地,console和file的定义在下面的diamagnetic
log4j.rootLogger=DEBUG,console,file
#控制台输出的相关设置
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Target=System.out
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.ConversionPattern=[%c]-%m%n
#文件输出的相关设置
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.File=./log/gai.log
log4j.appender.file.MaxFileSize=10mb
log4j.appender.file.Threshold=DEBUG
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.ConversionPattern=[%p][%d{yy-MM-dd}][%c]%m%n
#日志输出级别
log4j.logger.org.mybatis=DEBUG
log4j.logger.java.sql=DEBUG
log4j.logger.java.sql.Statement=DEBUG
log4j.logger.java.sql.ResultSet=DEBUG
log4j.logger.java.sql.PreparedStatement=DEBUG
static Logger logger = Logger.getLogger(UserDaoTest.class);
@Test
public void testLog4j() {
logger.info("info:进入log4j方法");
logger.debug("debug:进入log4j方法");
logger.error("error进入log4j方法");
}
3.3 分页
3.3.1 使用limit实现
- 接口
//分页
List<User> getUserByLimit(Map<String, Integer> map);
- Mapper.xml
<!--分页-->
<select id="getUserByLimit" parameterType="map" resultMap="userMap">
select * from mybatis.user limit #{startIndex},#{pageSize};
</select>
- 测试
@Test
public void getUserByLimit() {
SqlSession sqlSession = MybatisUtils.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
HashMap<String, Integer> map = new HashMap<>();
map.put("startIndex", 1);
map.put("pageSize", 2);
List<User> userList = mapper.getUserByLimit(map);
for (User user : userList) {
System.out.println(user);
}
sqlSession.close();
}
3.3.2 RowBounds分页
//分页2
List<User> getUserByLimitRowBounds();
//分页2
List<User> getUserByLimitRowBounds();
@Test
public void getUserByRowBounds() {
SqlSession sqlSession = MybatisUtils.getSqlSession();
//RowBounds去实现
RowBounds rowBounds = new RowBounds(1, 2);
//通过java代码层面实现分页,不推荐
List<User> userList = sqlSession.selectList("com.gai.dao.UserMapper.getUserByLimitRowBounds", null, rowBounds);
for (User user : userList) {
System.out.println(user);
}
sqlSession.close();
}
3.3.3 PageHelper插件
4. 使用注解开发
- 注解在接口上实现
public interface UserMapper {
@Select("select * from user")
List<User> getUsers();
}
- 需要在核心配置文件中绑定接口
<!--绑定接口-->
<mappers>
<mapper class="com.gai.dao.UserMapper"/>
</mappers>
- 本质:反射机制实现
- 底层:动态代理
- Mybatis详细的执行流程
4.1 注解实现CRUD
public interface UserMapper {
@Select("select * from user")
List<User> getUsers();
//方法存在多个参数,所有的参数前面必须加上@Param
@Select("select * from user where id = #{id}")
User getUserById(@Param("id") int id);
@Insert("insert into user(id,name,pwd) values (#{id},#{name},#{pwd})")
int addUser(User user);
@Update("update user set name = #{name},pwd=#{pwd} where id=#{id}")
int updateUser(User user);
@Delete("delete from user where id =#{uid}")
int deleteUser(@Param("uid") int id);
}
- 基本类型参数或String需要加@Param()注解,引用类型不需要加
- #{}可以防止SQL注入,${}不推荐使用
4.2 Lombok
@Data
@AllArgsConstructor
@NoArgsConstructor
@ToString
public class Test {
private int id;
private String name;
private String password;
public Test(int id, String name) {
this.id = id;
this.name = name;
}
}