MyBatis
概念
- mybatis是一个优秀的基于java的持久层框架，它内部封装了jdbc，使开发者只需要关注sql语句本身，而不需要花费精力去处理加载驱动、创建连接、创建statement等繁杂的过程。
- mybatis通过xml或注解的方式将要执行的各种statement配置起来，并通过java对象和statement中sql的动态参数进行映射生成最终执行的sql语句。
- 最后mybatis框架执行sql并将结果映射为java对象并返回。采用ORM思想解决了实体和数据库映射的问题，对jdbc进行了封装，屏蔽了jdbc api底层访问细节，使我们不用与jdbc api打交道，就可以完成对数据库的持久化操作。
入门
-
核心配置文件中常用配置
-
properties标签：该标签可以加载外部的properties文件
<properties resource="jdbc.properties"></properties> -
typeAliases标签：设置类型别名
<typeAliases> <typeAlias type="com.cqgcxy.entity.Phone"></typeAlias> </typeAliases> -
settings：功能设置，如：开启驼峰命名转换
<settings> <setting name="mapUnderscoreToCamelCase" value="true"/> </settings> -
mappers标签：加载映射配置
<!--使用相对于类路径的资源引用，例如: --> <mapper resource="org/mybatis/builder/AuthorMapper.xml"/> <!--使用完全限定资源定位符(URL)，例如: --> <mapper url="file:///var/mappers/AuthorMapper.xml" /> <!--使用映射器接口实现类的完全限定类名，例如: --> <mapper class="org.mybatis.builder.AuthorMapper"/> <!--将包内的映射器接口实现全部主册为映射器，例如: --> <package name="org.mybatis.builder"/> -
environments标签：环境配置
- 其中，事务管理器(transactionManager）类型有两种:
- JDBC：这个配置就是直接使用了JDBC的提交和回滚设置，它依赖于从数据源得到的连接来管理事务作用域。
- MANAGED：这个配置几乎没做什么。它从来不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如JEE应用服务器的上下文)。默认情况下它会关闭连接，然而一些容器并不希望这样，因此需要将closeConnection属性设置为false来阻止它默认的关闭行为。
- 其中，数据源(dataSource)类型有三种:
- UNPOOLED：这个数据源的实现只是每次被请求时打开和关闭连接。
- POOLED：这种数据源的实现利用“池”的概念将JDBC连接对象组织起来。
- JNDI：这个数据源的实现是为了能在如EJB或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个JNDI上下文的引用。
- 其中，事务管理器(transactionManager）类型有两种:
-
-
响应API
（1）Resources 工具类，这个类在org.apache.ibatis.io包中。Resources从类路径下、文件系统或一个web URL中加载资源文件。
（2）SqlSessionFactory build(InputStream inputStream)加载mybatis的核心文件输入流构建一个SqlSessionFactory对象。
这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。 你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，但最好还是不要一直保留着它，以保证所有的 XML 解析资源可以被释放给更重要的事情。
（3）SqlSessionFactory有多个个方法创建sqlSession实例。常用的有如下两个：
- openSession()默认开启一个事务，不会自动提交，如更新数据需要手动提交事务。
- openSession(boolean autoCommit)参数如果设置为true则自动提交事务。
SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例。 使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次，多次重建 SqlSessionFactory 被视为一种代码“坏习惯”。因此 SqlSessionFactory 的最佳作用域是应用作用域。 有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。
（4）SqlSession会话对象
SqlSession实例在MyBatis 中是非常强大的一个类。在这里你会看到所有执行语句、提交或回滚事务和获取映射器实例的方法。
执行语句的方法主要有：<T> T selectone(string statement,object parameter) <E> List<E> selectList (string statement,object parameter) int insert (string statement,object parameter) int update (string statement,object parameter) int delete (string statement,object parameter)操作事务的方法主要有:
void commit() void rollback()每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。 绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。 也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中，比如 Servlet 框架中的 HttpSession。
-
命令空间（namespace）
命名空间的作用有两个，一个是利用更长的全限定名来将不同的语句隔离开来，同时也实现了接口绑定。就算你觉得暂时用不到接口绑定，你也应该遵循这里的规定，以防哪天你改变了主意。 长远来看，只要将命名空间置于合适的 Java 包命名空间之中，你的代码会变得更加整洁，也有利于你更方便地使用 MyBatis。
命名解析：为了减少输入量，MyBatis 对所有具有名称的配置元素（包括语句，结果映射，缓存等）使用了如下的命名解析规则。
- 全限定名（比如 “com.mypackage.MyMapper.selectAllThings）将被直接用于查找及使用。
- 短名称（比如 “selectAllThings”）如果全局唯一也可以作为一个单独的引用。 如果不唯一，有两个或两个以上的相同名称（比如 “com.foo.selectAllThings” 和 “com.bar.selectAllThings”），那么使用时就会产生“短名称不唯一”的错误，这种情况下就必须使用全限定名。
-
代理开发方式
Mapper接口开发方法只需要程序员编写Mapper接口(相当于Dao接口)，由Mybatis框架根据接口定义创建接口的动态代理对象，代理对象的方法体同上边Dao接口实现类方法。
Mapper接口开发需要遵循以下规范：
（1）Mapper.xml文件中的namespace与mapper接口的全限定名相同
（2）Mapper接口方法名和Mapper.xml中定义的每个statement的id相同
（3）Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql的parameterType的类型相同
（4）Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同
增删改查
注意事项：
- 增删改查语句使用对应标签
- 有参数的指定参数类型、有返回值的指定返回值类型
- Sql语句中使用#{实体属性名}方式引用实体中的属性值
- 操作使用的API是sqlSession.对应方法(“命名空间.id”[,实体对象]);
- 涉及数据库数据变化的要使用sqlSession对象显示的提交事务，即sqISession.commit()
-
创建数据库表格
SET FOREIGN_KEY_CHECKS=0; -- ---------------------------- -- Table structure for `phone` -- ---------------------------- DROP TABLE IF EXISTS `phone`; CREATE TABLE `phone` ( `phone_id` bigint NOT NULL AUTO_INCREMENT COMMENT '手机编号', `brand_id` bigint NOT NULL COMMENT '品牌编号', `model_number` varchar(50) COLLATE utf8mb4_general_ci NOT NULL COMMENT '型号', `capacity` int NOT NULL COMMENT '存储容量', PRIMARY KEY (`phone_id`) ) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci; -- ---------------------------- -- Records of phone -- ---------------------------- INSERT INTO `phone` VALUES ('1', '1', 'mate60', '256'); INSERT INTO `phone` VALUES ('2', '1', 'p60', '128'); INSERT INTO `phone` VALUES ('3', '2', 'x50', '128'); -
添加相关依赖
<dependencies> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.33</version> </dependency> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.4.6</version> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.12</version> <scope>test</scope> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.20</version> </dependency> </dependencies> -
创建对应实体类Phone
package com.cqgcxy.entity; import lombok.Data; @Data public class Phone { // 手机编号 private Long phoneId; // 品牌编号 private Long brandId; // 手机型号 private String modelNumber; // 手机容量 private Integer capacity; } -
在resources文件夹下创建并编写映射文件mapper/PhoneMapper.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="phoneMapper"> <insert id="insertPhone" parameterType="phone"> INSERT phone VALUES (NULL,#{brandId},#{modelNumber},#{capacity}); </insert> <delete id="deleteById" parameterType="int"> DELETE FROM phone WHERE phone_id = #{phoneId} </delete> <update id="updateById" parameterType="phone"> UPDATE phone SET brand_id = #{brandId},model_number = #{modelNumber},capacity = #{capacity} WHERE phone_id = #{phoneId} </update> <select id="selectById" parameterType="int" resultType="phone"> SELECT * FROM phone WHERE phone_id = #{phoneId} </select> <select id="selectAll" resultType="phone"> SELECT * FROM phone </select> </mapper> -
在resources文件夹下创建并编写核心配置文件SqlMapConfig.xml
<?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> <properties resource="jdbc.properties"></properties> <!-- 设置：定义mybatis的一些全局性设置 --> <settings> <!-- 具体的参数名和参数值 --> <setting name="mapUnderscoreToCamelCase" value="true"/> </settings> <!-- 类型名称：为一些类定义别名 --> <typeAliases> <typeAlias type="com.cqgcxy.entity.Phone"></typeAlias> </typeAliases> <!-- 环境：配置mybatis的环境 --> <environments default="dev"> <!-- 环境变量：可以配置多个环境变量，比如使用多数据源时，就需要配置多个环境变量 --> <environment id="dev"> <!-- 事务管理器 --> <transactionManager type="JDBC"></transactionManager> <!-- 数据源 --> <dataSource type="POOLED"> <property name="driver" value="${jdbc.driver}"/> <property name="url" value="${jdbc.url}"/> <property name="username" value="${jdbc.username}"/> <property name="password" value="${jdbc.password}"/> </dataSource> </environment> </environments> <!-- 映射器：指定映射文件或者映射类 --> <mappers> <mapper resource="mapper/PhoneMapper.xml"></mapper> </mappers> </configuration> -
测试
package com.cqgcxy.mapper; import com.cqgcxy.entity.Phone; import org.apache.ibatis.io.Resources; import org.apache.ibatis.session.SqlSession; import org.apache.ibatis.session.SqlSessionFactory; import org.apache.ibatis.session.SqlSessionFactoryBuilder; import org.junit.Test; import java.io.IOException; import java.io.InputStream; import java.util.List; public class MybatisTest { @Test public void insertPhoneTest() throws IOException { InputStream is = Resources.getResourceAsStream("sqlMapConfig.xml"); SqlSessionFactory sqLSessionFactory = new SqlSessionFactoryBuilder().build(is); SqlSession sqlsession = sqLSessionFactory.openSession(); Phone phone = new Phone(); phone.setBrandId(1l); phone.setModelNumber("mate60plus"); phone.setCapacity(512); int insert = sqlsession.insert("phoneMapper.insertPhone", phone); sqlsession.commit(); if(insert>0){ System.out.println("新增成功!"); } sqlsession.close(); } @Test public void deleteByIdTest() throws IOException { InputStream is = Resources.getResourceAsStream("sqlMapConfig.xml"); SqlSessionFactory sqLSessionFactory = new SqlSessionFactoryBuilder().build(is); SqlSession sqlsession = sqLSessionFactory.openSession(); int delete = sqlsession.delete("phoneMapper.deleteById",4l); sqlsession.commit(); if(delete>0){ System.out.println("删除成功!"); } sqlsession.close(); } @Test public void updateByIdTest() throws IOException { InputStream is = Resources.getResourceAsStream("sqlMapConfig.xml"); SqlSessionFactory sqLSessionFactory = new SqlSessionFactoryBuilder().build(is); SqlSession sqlsession = sqLSessionFactory.openSession(); Phone phone = new Phone(); phone.setPhoneId(4l); phone.setBrandId(1l); phone.setModelNumber("mate60plus"); phone.setCapacity(1024); int update = sqlsession.update("phoneMapper.updateById",phone); sqlsession.commit(); if(update>0){ System.out.println("更新成功!"); } sqlsession.close(); } @Test public void selectByIdTest() throws IOException { InputStream is = Resources.getResourceAsStream("sqlMapConfig.xml"); SqlSessionFactory sqLSessionFactory = new SqlSessionFactoryBuilder().build(is); SqlSession sqlsession = sqLSessionFactory.openSession(); Phone phone = sqlsession.selectOne("phoneMapper.selectById",4l); System.out.println(phone); sqlsession.close(); } @Test public void selectAllTest() throws IOException { InputStream is = Resources.getResourceAsStream("sqlMapConfig.xml"); SqlSessionFactory sqLSessionFactory = new SqlSessionFactoryBuilder().build(is); SqlSession sqlsession = sqLSessionFactory.openSession(); List<Phone> phoneList = sqlsession.selectList("phoneMapper.selectAll"); phoneList.forEach(s->{ System.out.println(s); }); sqlsession.close(); } } -
测试代理方式【重点】
（1）创建PhoneMapper接口
package com.cqgcxy.mapper; import com.cqgcxy.entity.Phone; import java.util.List; public interface PhoneMapper { int insertPhone(Phone phone); int deleteById(Long id); int updateById(Phone phone); Phone selectById(Long id); List<Phone> selectAll(); }（2）修改PhoneMapper.xml中namespace为PhoneMapper的完全限定名
（3）修改测试类
//int insert = sqlsession.delete("phoneMapper.insertPhone",phone); PhoneMapper phoneMapper = sqlsession.getMapper(PhoneMapper.class); int insert = phoneMapper.insertPhone(phone);// int delete = sqlsession.delete("phoneMapper.deleteById",4l); PhoneMapper phoneMapper = sqlsession.getMapper(PhoneMapper.class); int delete = phoneMapper.deleteById(4l);// int update = sqlsession.update("phoneMapper.updateById",phone); PhoneMapper phoneMapper = sqlsession.getMapper(PhoneMapper.class); int update = phoneMapper.updateById(phone);// Phone phone = sqlsession.selectOne("phoneMapper.selectById",4l); PhoneMapper phoneMapper = sqlsession.getMapper(PhoneMapper.class); Phone phone = phoneMapper.selectById(4l);// List<Phone> phoneList = sqlsession.selectList("phoneMapper.selectAll"); PhoneMapper phoneMapper = sqlsession.getMapper(PhoneMapper.class); List<Phone> phoneList = phoneMapper.selectAll();
8.运行结果
-
执行测试类中selectAllTest方法，测试效果截图如下：
-
执行测试类中insertPhoneTest方法，测试效果截图如下：
-
执行测试类中selectByIdTest方法，测试效果截图如下：
-
执行测试类中updateByIdTest方法，测试效果截图如下：
-
执行测试类中deleteByIdTest方法，测试效果截图如下：
XML 映射器
select
查询语句是 MyBatis 中最常用的元素之一——光能把数据存到数据库中价值并不大，还要能重新取出来才有用，多数应用也都是查询比修改要频繁。 MyBatis 的基本原则之一是：在每个插入、更新或删除操作之间，通常会执行多个查询操作。因此，MyBatis 在查询和结果映射做了相当多的改进。一个简单查询的 select 元素是非常简单的。比如：
<select id="selectPerson" parameterType="int" resultType="hashmap">
SELECT * FROM PERSON WHERE ID = #{id}
</select>
这个语句名为 selectPerson，接受一个 int（或 Integer）类型的参数，并返回一个 HashMap 类型的对象，其中的键是列名，值便是结果行中的对应值。
注意参数符号：
#{id}
这就告诉 MyBatis 创建一个预处理语句（PreparedStatement）参数，在 JDBC 中，这样的一个参数在 SQL 中会由一个“?”来标识，并被传递到一个新的预处理语句中，就像这样：
// 近似的 JDBC 代码，非 MyBatis 代码...
String selectPerson = "SELECT * FROM PERSON WHERE ID=?";
PreparedStatement ps = conn.prepareStatement(selectPerson);
ps.setInt(1,id);
当然，使用 JDBC 就意味着使用更多的代码，以便提取结果并将它们映射到对象实例中，而这就是 MyBatis 的拿手好戏。
select 元素允许你配置很多属性来配置每条语句的行为细节。
<select
id="selectPerson"
parameterType="int"
parameterMap="deprecated"
resultType="hashmap"
resultMap="personResultMap"
flushCache="false"
useCache="true"
timeout="10"
fetchSize="256"
statementType="PREPARED"
resultSetType="FORWARD_ONLY">
select属性
| 属性 | 描述 |
|---|---|
id | 在命名空间中唯一的标识符，可以被用来引用这条语句。 |
parameterType | 将会传入这条语句的参数的类全限定名或别名。这个属性是可选的，因为 MyBatis 可以通过类型处理器（TypeHandler）推断出具体传入语句的参数，默认值为未设置（unset）。 |
| parameterMap | 用于引用外部 parameterMap 的属性，目前已被废弃。请使用行内参数映射和 parameterType 属性。 |
resultType | 期望从这条语句中返回结果的类全限定名或别名。 注意，如果返回的是集合，那应该设置为集合包含的类型，而不是集合本身的类型。 resultType 和 resultMap 之间只能同时使用一个。 |
resultMap | 对外部 resultMap 的命名引用。结果映射是 MyBatis 最强大的特性，如果你对其理解透彻，许多复杂的映射问题都能迎刃而解。 resultType 和 resultMap 之间只能同时使用一个。 |
flushCache | 将其设置为 true 后，只要语句被调用，都会导致本地缓存和二级缓存被清空，默认值：false。 |
useCache | 将其设置为 true 后，将会导致本条语句的结果被二级缓存缓存起来，默认值：对 select 元素为 true。 |
timeout | 这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为未设置（unset）（依赖数据库驱动）。 |
fetchSize | 这是一个给驱动的建议值，尝试让驱动程序每次批量返回的结果行数等于这个设置值。 默认值为未设置（unset）（依赖驱动）。 |
statementType | 可选 STATEMENT，PREPARED 或 CALLABLE。这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement，默认值：PREPARED。 |
resultSetType | FORWARD_ONLY，SCROLL_SENSITIVE, SCROLL_INSENSITIVE 或 DEFAULT（等价于 unset） 中的一个，默认值为 unset （依赖数据库驱动）。 |
databaseId | 如果配置了数据库厂商标识（databaseIdProvider），MyBatis 会加载所有不带 databaseId 或匹配当前 databaseId 的语句；如果带和不带的语句都有，则不带的会被忽略。 |
resultOrdered | 这个设置仅针对嵌套结果 select 语句：如果为 true，将会假设包含了嵌套结果集或是分组，当返回一个主结果行时，就不会产生对前面结果集的引用。 这就使得在获取嵌套结果集的时候不至于内存不够用。默认值：false。 |
resultSets | 这个设置仅适用于多结果集的情况。它将列出语句执行后返回的结果集并赋予每个结果集一个名称，多个名称之间以逗号分隔。 |
insert, update 和 delete
数据变更语句 insert，update 和 delete 的实现非常接近：
<insert
id="insertAuthor"
parameterType="domain.blog.Author"
flushCache="true"
statementType="PREPARED"
keyProperty=""
keyColumn=""
useGeneratedKeys=""
timeout="20">
<update
id="updateAuthor"
parameterType="domain.blog.Author"
flushCache="true"
statementType="PREPARED"
timeout="20">
<delete
id="deleteAuthor"
parameterType="domain.blog.Author"
flushCache="true"
statementType="PREPARED"
timeout="20">
| 属性 | 描述 |
|---|---|
id | 在命名空间中唯一的标识符，可以被用来引用这条语句。 |
parameterType | 将会传入这条语句的参数的类全限定名或别名。这个属性是可选的，因为 MyBatis 可以通过类型处理器（TypeHandler）推断出具体传入语句的参数，默认值为未设置（unset）。 |
parameterMap | 用于引用外部 parameterMap 的属性，目前已被废弃。请使用行内参数映射和 parameterType 属性。 |
flushCache | 将其设置为 true 后，只要语句被调用，都会导致本地缓存和二级缓存被清空，默认值：（对 insert、update 和 delete 语句）true。 |
timeout | 这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为未设置（unset）（依赖数据库驱动）。 |
statementType | 可选 STATEMENT，PREPARED 或 CALLABLE。这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement，默认值：PREPARED。 |
useGeneratedKeys | （仅适用于 insert 和 update）这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键（比如：像 MySQL 和 SQL Server 这样的关系型数据库管理系统的自动递增字段），默认值：false。 |
keyProperty | （仅适用于 insert 和 update）指定能够唯一识别对象的属性，MyBatis 会使用 getGeneratedKeys 的返回值或 insert 语句的 selectKey 子元素设置它的值，默认值：未设置（unset）。如果生成列不止一个，可以用逗号分隔多个属性名称。 |
keyColumn | （仅适用于 insert 和 update）设置生成键值在表中的列名，在某些数据库（像 PostgreSQL）中，当主键列不是表中的第一列的时候，是必须设置的。如果生成列不止一个，可以用逗号分隔多个属性名称。 |
databaseId | 如果配置了数据库厂商标识（databaseIdProvider），MyBatis 会加载所有不带 databaseId 或匹配当前 databaseId 的语句；如果带和不带的语句都有，则不带的会被忽略。 |
结果映射
MyBatis 会在幕后自动创建一个 ResultMap，再根据属性名来映射列到 JavaBean 的属性上。如果列名和属性名不能匹配上，可以在 SELECT 语句中设置列别名（这是一个基本的 SQL 特性）来完成匹配。比如：
<select id="selectUsers" resultType="User">
select
user_id as "id",
user_name as "userName",
hashed_password as "hashedPassword"
from some_table
where id = #{id}
</select>
显式使用外部的 resultMap 会怎样，这也是解决列名不匹配的另外一种方式。
<resultMap id="userResultMap" type="User">
<id property="id" column="user_id" />
<result property="username" column="user_name"/>
<result property="password" column="hashed_password"/>
</resultMap>
然后在引用它的语句中设置 resultMap 属性就行了（注意我们去掉了 resultType 属性）。比如:
<select id="selectUsers" resultMap="userResultMap">
select user_id, user_name, hashed_password
from some_table
where id = #{id}
</select>
动态 SQL
动态 SQL 是 MyBatis 的强大特性之一。如果你使用过 JDBC 或其它类似的框架，你应该能理解根据不同条件拼接 SQL 语句有多痛苦，例如拼接时要确保不能忘记添加必要的空格，还要注意去掉列表最后一个列名的逗号。利用动态 SQL，可以彻底摆脱这种痛苦。
使用动态 SQL 并非一件易事，但借助可用于任何 SQL 映射语句中的强大的动态 SQL 语言，MyBatis 显著地提升了这一特性的易用性。
如果你之前用过 JSTL 或任何基于类 XML 语言的文本处理器，你对动态 SQL 元素可能会感觉似曾相识。在 MyBatis 之前的版本中，需要花时间了解大量的元素。借助功能强大的基于 OGNL 的表达式，MyBatis 3 替换了之前的大部分元素，大大精简了元素种类，现在要学习的元素种类比原来的一半还要少。
- if
- choose (when, otherwise)
- trim (where, set)
- foreach
if
使用动态 SQL 最常见情景是根据条件包含 where 子句的一部分。比如：
<select id="findActiveBlogWithTitleLike"
resultType="Blog">
SELECT * FROM BLOG
WHERE state = ‘ACTIVE’
<if test="title != null">
AND title like #{title}
</if>
</select>
这条语句提供了可选的查找文本功能。如果不传入 “title”，那么所有处于 “ACTIVE” 状态的 BLOG 都会返回；如果传入了 “title” 参数，那么就会对 “title” 一列进行模糊查找并返回对应的 BLOG 结果（细心的读者可能会发现，“title” 的参数值需要包含查找掩码或通配符字符）。
如果希望通过 “title” 和 “author” 两个参数进行可选搜索该怎么办呢？首先，我想先将语句名称修改成更名副其实的名称；接下来，只需要加入另一个条件即可。
<select id="findActiveBlogLike"
resultType="Blog">
SELECT * FROM BLOG WHERE state = ‘ACTIVE’
<if test="title != null">
AND title like #{title}
</if>
<if test="author != null and author.name != null">
AND author_name like #{author.name}
</if>
</select>
choose、when、otherwise
有时候，我们不想使用所有的条件，而只是想从多个条件中选择一个使用。针对这种情况，MyBatis 提供了 choose 元素，它有点像 Java 中的 switch 语句。
还是上面的例子，但是策略变为：传入了 “title” 就按 “title” 查找，传入了 “author” 就按 “author” 查找的情形。若两者都没有传入，就返回标记为 featured 的 BLOG（这可能是管理员认为，与其返回大量的无意义随机 Blog，还不如返回一些由管理员挑选的 Blog）。
<select id="findActiveBlogLike"
resultType="Blog">
SELECT * FROM BLOG WHERE state = ‘ACTIVE’
<choose>
<when test="title != null">
AND title like #{title}
</when>
<when test="author != null and author.name != null">
AND author_name like #{author.name}
</when>
<otherwise>
AND featured = 1
</otherwise>
</choose>
</select>
trim、where、set
前面几个例子已经合宜地解决了一个臭名昭著的动态 SQL 问题。现在回到之前的 “if” 示例，这次我们将 “state = ‘ACTIVE’” 设置成动态条件，看看会发生什么。
<select id="findActiveBlogLike"
resultType="Blog">
SELECT * FROM BLOG
WHERE
<if test="state != null">
state = #{state}
</if>
<if test="title != null">
AND title like #{title}
</if>
<if test="author != null and author.name != null">
AND author_name like #{author.name}
</if>
</select>
如果没有匹配的条件会怎么样？最终这条 SQL 会变成这样：
SELECT * FROM BLOG
WHERE
这会导致查询失败。如果匹配的只是第二个条件又会怎样？这条 SQL 会是这样:
SELECT * FROM BLOG
WHERE
AND title like ‘someTitle’
这个查询也会失败。这个问题不能简单地用条件元素来解决。这个问题是如此的难以解决，以至于解决过的人不会再想碰到这种问题。
MyBatis 有一个简单且适合大多数场景的解决办法。而在其他场景中，可以对其进行自定义以符合需求。而这，只需要一处简单的改动：
<select id="findActiveBlogLike"
resultType="Blog">
SELECT * FROM BLOG
<where>
<if test="state != null">
state = #{state}
</if>
<if test="title != null">
AND title like #{title}
</if>
<if test="author != null and author.name != null">
AND author_name like #{author.name}
</if>
</where>
</select>
where 元素只会在子元素返回任何内容的情况下才插入 “WHERE” 子句。而且，若子句的开头为 “AND” 或 “OR”，where 元素也会将它们去除。
如果 where 元素与你期望的不太一样，你也可以通过自定义 trim 元素来定制 where 元素的功能。比如，和 where 元素等价的自定义 trim 元素为：
<trim prefix="WHERE" prefixOverrides="AND |OR ">
...
</trim>
prefixOverrides 属性会忽略通过管道符分隔的文本序列（注意此例中的空格是必要的）。上述例子会移除所有 prefixOverrides 属性中指定的内容，并且插入 prefix 属性中指定的内容。
用于动态更新语句的类似解决方案叫做 set。set 元素可以用于动态包含需要更新的列，忽略其它不更新的列。比如：
<update id="updateAuthorIfNecessary">
update Author
<set>
<if test="username != null">username=#{username},</if>
<if test="password != null">password=#{password},</if>
<if test="email != null">email=#{email},</if>
<if test="bio != null">bio=#{bio}</if>
</set>
where id=#{id}
</update>
这个例子中，set 元素会动态地在行首插入 SET 关键字，并会删掉额外的逗号（这些逗号是在使用条件语句给列赋值时引入的）。
来看看与 set 元素等价的自定义 trim 元素吧：
<trim prefix="SET" suffixOverrides=",">
...
</trim>
注意，我们覆盖了后缀值设置，并且自定义了前缀值。
foreach
动态 SQL 的另一个常见使用场景是对集合进行遍历（尤其是在构建 IN 条件语句的时候）。比如：
<select id="selectPostIn" resultType="domain.blog.Post">
SELECT *
FROM POST P
WHERE ID in
<foreach item="item" index="index" collection="list"
open="(" separator="," close=")">
#{item}
</foreach>
</select>
foreach 元素的功能非常强大，它允许你指定一个集合，声明可以在元素体内使用的集合项（item）和索引（index）变量。它也允许你指定开头与结尾的字符串以及集合项迭代之间的分隔符。这个元素也不会错误地添加多余的分隔符，看它多智能！
提示 你可以将任何可迭代对象（如 List、Set 等）、Map 对象或者数组对象作为集合参数传递给 foreach。当使用可迭代对象或者数组时，index 是当前迭代的序号，item 的值是本次迭代获取到的元素。当使用 Map 对象（或者 Map.Entry 对象的集合）时，index 是键，item 是值。
日志
在 Apache Maven 构建中使用 Log4j
若要使用 Apache Maven 进行生成，请将下面列出的依赖项添加到文件中。pom.xml
pom.xml
<dependencies>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>2.22.0</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>2.22.0</version>
</dependency>
</dependencies>
配置 Log4J
配置 Log4J 比较简单。假设你需要记录这个映射器的日志：
package org.mybatis.example;
public interface BlogMapper {
@Select("SELECT * FROM blog WHERE id = #{id}")
Blog selectBlog(int id);
}
在应用的类路径中创建一个名为 log4j.properties 的文件，文件的具体内容如下：
# 全局日志配置
log4j.rootLogger=ERROR, stdout
# MyBatis 日志配置
log4j.logger.org.mybatis.example.BlogMapper=TRACE
# 控制台输出
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n
上述配置将使 Log4J 详细打印 org.mybatis.example.BlogMapper 的日志，对于应用的其它部分，只打印错误信息。
为了实现更细粒度的日志输出，你也可以只打印特定语句的日志。以下配置将只打印语句 selectBlog 的日志：
log4j.logger.org.mybatis.example.BlogMapper.selectBlog=TRACE
或者，你也可以打印一组映射器的日志，只需要打开映射器所在的包的日志功能即可：
log4j.logger.org.mybatis.example=TRACE
某些查询可能会返回庞大的结果集。这时，你可能只想查看 SQL 语句，而忽略返回的结果集。为此，SQL 语句将会在 DEBUG 日志级别下记录（JDK 日志则为 FINE）。返回的结果集则会在 TRACE 日志级别下记录（JDK 日志则为 FINER)。因此，只要将日志级别调整为 DEBUG 即可：
log4j.logger.org.mybatis.example=DEBUG
但如果你要为下面的映射器 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="org.mybatis.example.BlogMapper">
<select id="selectBlog" resultType="Blog">
select * from Blog where id = #{id}
</select>
</mapper>
这时，你可以通过打开命名空间的日志功能来对整个 XML 记录日志：
log4j.logger.org.mybatis.example.BlogMapper=TRACE
而要记录具体语句的日志，可以这样做：
log4j.logger.org.mybatis.example.BlogMapper.selectBlog=TRACE
的日志，只需要打开映射器所在的包的日志功能即可：
```properties
log4j.logger.org.mybatis.example=TRACE
某些查询可能会返回庞大的结果集。这时，你可能只想查看 SQL 语句，而忽略返回的结果集。为此，SQL 语句将会在 DEBUG 日志级别下记录（JDK 日志则为 FINE）。返回的结果集则会在 TRACE 日志级别下记录（JDK 日志则为 FINER)。因此，只要将日志级别调整为 DEBUG 即可：
log4j.logger.org.mybatis.example=DEBUG
但如果你要为下面的映射器 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="org.mybatis.example.BlogMapper">
<select id="selectBlog" resultType="Blog">
select * from Blog where id = #{id}
</select>
</mapper>
这时，你可以通过打开命名空间的日志功能来对整个 XML 记录日志：
log4j.logger.org.mybatis.example.BlogMapper=TRACE
而要记录具体语句的日志，可以这样做：
log4j.logger.org.mybatis.example.BlogMapper.selectBlog=TRACE
扫一扫
435
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
