0.官方教程

本文为学习记录, 学习请参照官方教程:官方教程

1.快速启动

1.1pom文件

添加依赖:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>com.mybatis</groupId><artifactId>mybatis3</artifactId><version>1.0-SNAPSHOT</version><dependencies><!-- mybatis --><dependency><groupId>org.mybatis</groupId><artifactId>mybatis</artifactId><version>3.5.5</version></dependency><!-- 单元测试 --><dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>4.12</version></dependency><!-- mysql连接驱动 --><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>5.1.44</version></dependency><!-- lombok --><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>LATEST</version></dependency></dependencies></project>

1.2实体类

创建与数据库表对应的实体类User.class

@Data
@ToString
public class User {/** id */private Integer id;/** 用户名 */private String username;/** 生日 */private Date birthday;
}

1.3Mapper接口

创建与User.class实体类对应的Mapper接口:

public interface UserMapper {/*** 获取所有用户** @author yyf* @date 14:06 2020/8/4* @return java.util.List<com.mybatis.entity.User>*/List<User> getAll();
}

1.4Mapper配置文件

添加与UserMapper.class对应的配置文件, 需要与UserMapper.class在同一路径:

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.mybatis.mapper.UserMapper"><!-- 查询所有用户 --><select id="getAll" resultMap="com.mybatis.entity.User">select * from tbl_user</select>
</mapper>

1.5 myabtis主配置文件

在resources目录下添加主配置文件mybatis.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""http://mybatis.org/dtd/mybatis-3-config.dtd">
<!-- mybatis主配置文件 -->
<configuration><!-- 环境配置 --><environments default="dev"><!-- dev环境配置 --><environment id="dev"><!-- 事务管理器类型 --><transactionManager type="JDBC"/><!-- 数据源类型 --><dataSource type="POOLED"><property name="driver" value="com.mysql.jdbc.Driver"/><property name="url" value="jdbc:mysql://10.1.5.170:3306/test"/><property name="username" value="root"/><property name="password" value="root"/></dataSource></environment></environments><!-- mappers配置文件引入 --><mappers><!-- 包配置 --><package name="com.mybatis.mapper"/></mappers>
</configuration>

1.6测试类

创建测试类, 测试mybatis

public class UserMapperTest {private UserMapper userMapper;private SqlSession sqlSession;private InputStream inputStream;@Beforepublic void init() throws IOException {// 创建sqlSession工厂inputStream = Resources.getResourceAsStream("mybatis.xml");SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);// 获取sqlSessionsqlSession = sqlSessionFactory.openSession();// 获取MapperuserMapper = sqlSession.getMapper(UserMapper.class);}@Afterpublic void after() throws IOException {sqlSession.commit();// 释放资源sqlSession.close();inputStream.close();}@Testpublic void testGetAll() {// 执行sqlList<User> userList = userMapper.getAll();userList.forEach(System.out::println);}
}

2. mybatis主配置文件

详情请参照官方文档:mybatis.xml

2.1 属性（properties）

这些属性可以在外部进行配置，并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性，也可以在 properties 元素的子元素中设置。例如：

<properties resource="db.properties"><property name="driver" value="com.mysql.jdbc.Driver"/>
</properties>

设置好的属性可以在整个配置文件中用来替换需要动态配置的属性值。比如:

<dataSource type="POOLED"><property name="driver" value="${driver}"/><property name="url" value="${url}"/><property name="username" value="${username}"/><property name="password" value="${password}"/>
</dataSource>

这个例子中的driver将会由 properties 元素中设置的相应值来替换。 url, username 和 password由 db.properties 文件中对应的值来替换。这样就为配置提供了诸多灵活选择。
加载顺序:

• 首先读取在 properties 元素体内指定的属性。
• 然后根据 properties 元素中的 resource 属性读取类路径下属性文件，或根据 url 属性指定的路径读取属性文件，并覆盖之前读取过的同名属性。
• 最后读取作为方法参数传递的属性，并覆盖之前读取过的同名属性。

2.2 设置（settings）

这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为, 如:

<!-- 开启懒加载 -->
<settings><setting name="lazyLoadingEnabled" value="true"/>
</settings>

详情参照官方文档

2.3 类型别名（typeAliases）

类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置，意在降低冗余的全限定类名书写。例如：

<!-- 别名配置(配置后不区分大小写) -->
<typeAliases><!-- 单个配置 --><typeAlias type="com.mybatis.entity.User" alias="User" />
</typeAliases>

当这样配置时，User可以用在任何使用 com.mybatis.entity.User 的地方。
也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean，比如：

<typeAliases><!-- 包配置 --><package name="com.mybatis.entity"/>
</typeAliases>

2.4 环境配置（environments）

可以为不同的环境配置不同的数据源,一个数据源对应一个SqlSessionFactory .

<!-- 环境配置 -->
<environments default="dev"><!-- dev环境配置 --><environment id="dev"><!-- 事务管理器类型 --><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>

2.5 映射器（mappers）

引入mapper配置文件

<!-- mappers配置文件引入 -->
<mappers><!-- 单个配置 --><!--<mapper resource="com/mybatis/mapper/UserMapper.xml"/>--><!-- 包配置 --><package name="com.mybatis.mapper"/>
</mappers>

3. mapper配置文件

mapper配置文件主要用来编写sql语句

3.1 mapper根标签

<mapper namespace="com.mybatis.mapper.UserMapper">
</mapper>

• namespace 属性: 值为与mapper配置文件对应的mapper接口的全限定类名.

3.2 insert,update,delete标签

对应相应的sql语句

    <!-- 添加用户 --><insert id="add" parameterType="com.mybatis.entity.User"><!-- 设置获取插入数据后的id --><selectKey keyColumn="id" keyProperty="id" resultType="int" order="AFTER">select last_insert_id()</selectKey>insert into tbl_user(username, birthday) values (#{username}, #{birthday})</insert><!-- 更新用户 --><update id="update" parameterType="com.mybatis.entity.User">update tbl_user set username = #{username}, birthday = #{birthday} where id = #{id}</update><!-- 删除用户 --><delete id="del" parameterType="int">delete from tbl_user where id = #{userId}</delete>

• id属性: 对应mapper接口中的方法名
• parameterType属性: 参数类型

3.3 select标签

编写查询语句

	<!-- 根据用户id获取用户 --><select id="getById" parameterType="int" resultType="User">select * from tbl_user where id = #{id}</select>

• id属性: 对应mapper接口中的方法名
• parameterType属性: 参数类型
• resultType属性: 返回值类型(此处User为别名, 实际类型为com.mybatis.entity.User)

3.4 resultMap标签

使用resultMap标签对查询结果进行结果映射. 如下所示, 查询所有用户, 将结果映射到userMap .

	<!-- 结果集映射 --><resultMap id="userMap" type="User"><id column="id" property="id" javaType="Integer" jdbcType="INTEGER" /><result column="username" property="username" javaType="String" jdbcType="VARCHAR" /><result column="birthday" property="birthday" javaType="Date" jdbcType="DATE" /></resultMap><!-- 查询所有用户 --><select id="getAll" resultMap="userMap">select * from tbl_user</select>

• id属性: 结果集映射的id, 在select标签中使用resultMap属于指定.
• type属性:将结果映射到那个java类
• id标签: 映射id列
• result标签: 映射其他列

3.5 对多查询

场景: 1个用户拥有多个账户
实体类:
User.class

@Data
@ToString
public class User {/** id */private Integer id;/** 用户名 */private String username;/** 生日 */private Date birthday;/** 账户 */private List<Account> accountList;
}

Account.clss

@Data
@ToString
@NoArgsConstructor
@AllArgsConstructor
public class Account {/** id */private Integer id;/** 账户名称 */private String name;/** 账户余额 */private Double money;/** 账户拥有者用户 */private User user;
}

UserMapper.xml

<mapper namespace="com.mybatis.mapper.UserMapper"><!-- 结果集映射 --><resultMap id="userAccountMap" type="User" ><id column="id" property="id" javaType="Integer" jdbcType="INTEGER" /><result column="username" property="username" javaType="String" jdbcType="VARCHAR" /><result column="birthday" property="birthday" javaType="Date" jdbcType="DATE" /><collection property="accountList" ofType="Account"><id property="id" column="aid" /><result column="name" property="name" /><result column="money" property="money" /></collection></resultMap><!-- 查询所有用户 --><select id="getAll" resultMap="userAccountMap">select u.id, u.username, u.birthday, a.id as aid, a.name, a.moneyfromtbl_user uleft jointbl_account a on u.id = a.user_id</select>
</mapper>

3.6 对一查询

场景: 一个账户属于一个用户.
实体类: 同对多查询.
AccountMap.xml

<mapper namespace="com.mybatis.mapper.AccountMapper"><!-- 结果集映射(一对一) --><resultMap id="accountUserMap" type="com.mybatis.entity.Account"><id column="id" property="id" /><result column="name" property="name" /><result column="money" property="money" /><association property="user" column="user_id"><id property="id" column="uid" /><result property="username" column="username" /><result property="birthday" column="birthday" /></association></resultMap><!-- 查询所有(一对一) --><select id="getAll" resultMap="accountUserMap">selecta.id, a.name, a.money, u.id as uid, u.username, u.birthdayfromtbl_account a, tbl_user uwherea.user_id = u.id</select>
</mapper>

4. 动态SQl

详情请参照官方文档.
示例如下:

	<!-- 根据用户ids获取 --><select id="getByIds" resultMap="userMap">select * from tbl_user<where><if test="list != null and list.size() > 0"><foreach collection="list" item="user" open="and id in (" close=")" separator=",">#{user.id}</foreach></if></where></select><!-- 更新用户 --><update id="update" parameterType="com.mybatis.entity.User">update tbl_user<set><if test="username != null"> username = #{username}, </if><if test="birthday != null"> birthday = #{birthday}, </if></set> where id = #{id}</update>

5. 懒加载

开启懒加载设置,在resources\mybatis.xml中添加配置.

<!-- 开启懒加载 -->
<settings><setting name="lazyLoadingEnabled" value="true"/>
</settings>

---

对一查询通常采用立即加载, 使用懒加载可以将fetchType设置为lazy
AccountMapper.xml

<!-- 结果集映射(一对一)(懒加载) -->
<resultMap id="accountUserMapForLazy" type="com.mybatis.entity.Account"><id column="id" property="id" /><result column="name" property="name" /><result column="money" property="money" /><association property="user" column="user_id" select="com.mybatis.mapper.UserMapper.getById" fetchType="eager"/>
</resultMap><!-- 查询所有(一对一)(懒加载) -->
<select id="getAllForLazy" resultMap="accountUserMapForLazy" >select * from tbl_account
</select>

UserMapper.xml

<!-- 根据用户id获取用户 -->
<select id="getById" parameterType="int" resultType="User">select * from tbl_user where id = #{id}
</select>

---

对多查询通常采用懒加载.
场景:一个角色可以属于多个用户.
RoleMapper.xml

<!-- 结果集映射(一对多)(懒加载) -->
<resultMap id="roleMapForLazy" type="com.mybatis.entity.Role"><id property="id" column="id" /><result property="name" column="name" /><collection property="userList" ofType="user" column="id" select="com.mybatis.mapper.UserMapper.getByRole" />
</resultMap><!-- 查询所有(一对多)(懒加载) -->
<select id="getAllForLazy" resultMap="roleMapForLazy">select * from tbl_role
</select>

UserMapper.xml

<!-- 根据角色获取用户 -->
<select id="getByRole" resultType="user">select u.* from tbl_user_role ur left join tbl_user u on ur.user_id = u.id where ur.role_id = #{id};
</select>

6. 关于缓存

一级缓存自动开启.
二级缓存开启, 只需在需要使用缓存的mapper配置文件中填写如下配置:

<!-- 开启二级缓存 -->
<cache />

如果需要关闭某一个sql语句的缓存, 只需要在对应的sql标签添加useCache属性, 如下配置:

<!-- 根据用户名模糊查询 -->
<select id="getByUserName" parameterType="String" resultType="com.mybatis.entity.User" useCache="false">select * from tbl_user where username like concat('%', #{userName}, '%')
</select>