Data Access 之 MyBatis（三） - SQL Mapping XML（Part A）

RiemannHypothesis

发布于 2022-08-19 17:08:10

8190

发布于 2022-08-19 17:08:10

文章被收录于专栏：Elixir

一、SQL Mapping XML

MyBatis 的真正强大在于它的语句映射，这是它的魔力所在。由于它的异常强大，映射器的 XML 文件就显得相对简单。如果拿它跟具有相同功能的 JDBC 代码进行对比，你会立即发现省掉了将近 95% 的代码。MyBatis 致力于减少使用成本，让开发者能更专注于 SQL 代码。

mapper标签中的namespace属性即命名空间是指该映射文件所实现的Dao层的接口类

SQL 映射文件只有很少的几个顶级元素（按照应被定义的顺序列出）：

cache – 该命名空间的缓存配置。
cache-ref – 引用其它命名空间的缓存配置。
resultMap – 描述如何从数据库结果集中加载对象，是最复杂也是最强大的元素。
sql – 可被其它语句引用的可重用语句块。
insert – 映射插入语句。
update – 映射更新语句。
delete – 映射删除语句。
select – 映射查询语句。二、工程搭建新建一个maven工程mybatis-mapping-xml，工程搭建步骤与上一篇QA 由浅入深持久层框架（二） - MyBatis Config XML中的搭建步骤一致。

三、insert, update 和 delete

数据变更语句 insert，update 和 delete 的实现非常接近，他们都拥有以下属性，其中红色字体标注的属性是常用的属性。

属性	描述
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 的语句；如果带和不带的语句都有，则不带的会被忽略。

获取自增主键的值

数据存储在支持自增主键的数据库中，如何获取数据插入成功后数据库生成的主键值？

在EmployeeDaoTest中修改insertEmploye的测试方法，打印出插入成功后的主键值

@Test
public void insertEmployee() {

    Employee employee = new Employee();
    employee.setEmpName("peter");
    employee.setGender(0);
    employee.setEmail("peter@gmail.com");

    EmployeeDao employeeDao = openSession.getMapper(EmployeeDao.class);
    employeeDao.insertEmployee(employee);
    openSession.commit();
    System.out.println("ID为：" + employee.getId());
}

执行测试方法

数据库中显示成功插入数据库

但是获取到的主键值为null，MyBatis是如何获取自增主键的值的？

修改insertEmployee方法对应的SQL语句，增加两个属性

<insert id="insertEmployee" useGeneratedKeys="true" keyProperty="id">
    INSERT INTO t_employee(empname,gender,email) values (#{empName},#{gender},#{email})
</insert>

useGeneratedKeys：默认为false，即不使用生成的主键
keyProperty：将自增主键赋值给指定的属性

再次执行测试方法

现实成功打印出主键的值，且与数据库中生成的主键一致

useGeneratedKeys="true"就表示是MyBatis调用了Statement接口中的getGenerateKeys()方法，获取数据库自动生成的主键值，然后赋值给keyProperty属性指定的实体类属性

获取非自增主键的值

对于不支持自定生成主键的数据库如Oracle则可以使用selectKey子标签，selectKey标签内的语句可以设置运行顺序，是先执行还是后执行；设置为先执行则可以先查出最大的id，进行+1操作，然后在赋值给新插入的id。

selectKey标签有以下属性

属性	描述
keyProperty	selectKey 语句结果应该被设置到的目标属性。如果生成列不止一个，可以用逗号分隔多个属性名称。
keyColumn	返回结果集中生成列属性的列名。如果生成列不止一个，可以用逗号分隔多个属性名称。
resultType	结果的类型。通常 MyBatis 可以推断出来，但是为了更加准确，写上也不会有什么问题。MyBatis 允许将任何简单类型用作主键的类型，包括字符串。如果生成列不止一个，则可以使用包含期望属性的 Object 或 Map。
order	可以设置为 BEFORE 或 AFTER。如果设置为 BEFORE，那么它首先会生成主键，设置 keyProperty 再执行插入语句。如果设置为 AFTER，那么先执行插入语句，然后是 selectKey 中的语句 - 这和 Oracle 数据库的行为相似，在插入语句内部可能有嵌入索引调用。
statementType	和前面一样，MyBatis 支持 STATEMENT，PREPARED 和 CALLABLE 类型的映射语句，分别代表 Statement, PreparedStatement 和 CallableStatement 类型。

在EmployeeDao接口中新增一个insert的方法，不实用自增主键。

int insertEmployeeWithAllProperties(Employee employee);

在employee.xml中增加响应的SQL映射语句，使用selectKey标签查出来的并经过计算后得出的值作为插入的id主键值

<insert id="insertEmployeeWithAllProperties">
    <selectKey order="BEFORE" resultType="integer" keyProperty="id">
        select max(id)+1 from t_employee
    </selectKey>
    INSERT INTO t_employee(id,empname,gender,email) values (#{id},#{empName},#{gender},#{email})
</insert>

order属性定义了selectKey标签中SQL语句的执行顺序是先执行

在EmployeeDaoTest中增加测试方法insertEmployeeWithAllProperties

@Test
public void insertEmployeeWithAllProperties() {

    Employee employee = new Employee();
    employee.setEmpName("hulk");
    employee.setGender(0);
    employee.setEmail("hulk@gmail.com");

    EmployeeDao employeeDao = openSession.getMapper(EmployeeDao.class);
    employeeDao.insertEmployeeWithAllProperties(employee);
    openSession.commit();
    System.out.println("ID为：" + employee.getId());
}

执行测试