Mybatis 系列7

Posted 2020-11-03 一只阿木木

【Mybatis 系列10-结合源码解析mybatis 执行流程】

【Mybatis 系列9-强大的动态sql 语句】

【Mybatis 系列8-结合源码解析select、resultMap的用法】 

【Mybatis 系列7-结合源码解析核心CRUD配置及用法】

【Mybatis 系列6-结合源码解析节点配置objectFactory、databaseIdProvider、plugins、mappers】

【Mybatis 系列5-结合源码解析TypeHandler】 

【Mybatis 系列4-结合源码解析节点typeAliases】

【Mybatis 系列3-结合源码解析properties节点和environments节点】

【Mybatis 系列2-配置文件】

【Mybatis 系列1-环境搭建】

 

 

 

上篇系列6中 简单地给mybatis的配置画上了一个句号。

 

那么从本篇文章开始，将会介绍mapper映射文件的配置。这是mybatis的核心之一

 

要学好

 

在mapper文件中，以mapper作为根节点，其下面可以配置的元素节点有： select, insert, update, delete, cache, cache-ref, resultMap, sql 。

本篇文章将简单介绍 insert, update, delete 的配置及使用，以后会对mybatis的源码进行深入讲解。 相信，看到insert, update, delete， 我们就知道其作用了，顾名思义嘛，myabtis 作为持久层框架，必须要对CRUD啊。

 

好啦，咱们就先来看看 insert, update, delete 怎么配置， 能配置哪些元素吧：

 1 <?xml version="1.0" encoding="UTF-8" ?>   
 2 <!DOCTYPE mapper   
 3 PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"  
 4 "http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd"> 
 5 
 6 <!-- mapper 为根元素节点， 一个namespace对应一个dao -->
 7 <mapper namespace="com.dy.dao.UserDao">
 8 
 9     <insert
10       <!-- 1. id （必须配置）
11         id是命名空间中的唯一标识符，可被用来代表这条语句。 
12         一个命名空间（namespace） 对应一个dao接口, 
13         这个id也应该对应dao里面的某个方法（相当于方法的实现），因此id 应该与方法名一致 -->
14       
15       id="insertUser"
16       
17       <!-- 2. parameterType （可选配置, 默认为mybatis自动选择处理）
18         将要传入语句的参数的完全限定类名或别名， 如果不配置，mybatis会通过ParameterHandler 根据参数类型默认选择合适的typeHandler进行处理
19         parameterType 主要指定参数类型，可以是int, short, long, string等类型，也可以是复杂类型（如对象） -->
20       
21       parameterType="com.demo.User"
22       
23       <!-- 3. flushCache （可选配置，默认配置为true）
24         将其设置为 true，任何时候只要语句被调用，都会导致本地缓存和二级缓存都会被清空，默认值：true（对应插入、更新和删除语句） -->
25       
26       flushCache="true"
27       
28       <!-- 4. statementType （可选配置，默认配置为PREPARED）
29         STATEMENT，PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement，默认值：PREPARED。 -->
30       
31       statementType="PREPARED"
32       
33       <!-- 5. keyProperty (可选配置， 默认为unset)
34         （仅对 insert 和 update 有用）唯一标记一个属性，MyBatis 会通过 getGeneratedKeys 的返回值或者通过 insert 语句的 selectKey 子元素设置它的键值，默认：unset。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。 -->
35       
36       keyProperty=""
37       
38       <!-- 6. keyColumn     (可选配置)
39         （仅对 insert 和 update 有用）通过生成的键值设置表中的列名，这个设置仅在某些数据库（像 PostgreSQL）是必须的，当主键列不是表中的第一列的时候需要设置。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。 -->
40       
41       keyColumn=""
42       
43       <!-- 7. useGeneratedKeys (可选配置， 默认为false)
44         （仅对 insert 和 update 有用）这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键（比如：像 mysql 和 SQL Server 这样的关系数据库管理系统的自动递增字段），默认值：false。  -->
45       
46       useGeneratedKeys="false"
47       
48       <!-- 8. timeout  (可选配置， 默认为unset, 依赖驱动)
49         这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为 unset（依赖驱动）。 -->
50       timeout="20">
51 
52     <update
53       id="updateUser"
54       parameterType="com.demo.User"
55       flushCache="true"
56       statementType="PREPARED"
57       timeout="20">
58 
59     <delete
60       id="deleteUser"
61       parameterType="com.demo.User"
62       flushCache="true"
63       statementType="PREPARED"
64       timeout="20">
65 </mapper>

 

以上就是一个模板配置， 哪些是必要配置，哪些是根据自己实际需求，看一眼就知道了。

 

下面， 还是用第一篇文章《深入浅出Mybatis系列（一）---Mybatis入门》里面的demo来示例吧：

数据库 （user表）：

项目结构： 

 

 

 

User.java:

 

 1 package com.dy.entity;
 2 
 3 public class User {
 4 
 5     private int id;
 6     private String name;
 7     private String password;
 8     private int age;
 9     private int deleteFlag;
10     
11     public int getId() {
12         return id;
13     }
14     public void setId(int id) {
15         this.id = id;
16     }
17     public String getName() {
18         return name;
19     }
20     public void setName(String name) {
21         this.name = name;
22     }
23     public String getPassword() {
24         return password;
25     }
26     public void setPassword(String password) {
27         this.password = password;
28     }
29     public int getAge() {
30         return age;
31     }
32     public void setAge(int age) {
33         this.age = age;
34     }
35     public int getDeleteFlag() {
36         return deleteFlag;
37     }
38     public void setDeleteFlag(int deleteFlag) {
39         this.deleteFlag = deleteFlag;
40     }
41     
42 }

 

UserDao.java:

 1 package com.dy.dao;
 2 
 3 import com.dy.entity.User;
 4 
 5 public interface UserDao {
 6 
 7     public void insertUser (User user);
 8     
 9     public void updateUser (User user);
10     
11     public void deleteUser (User user);
12     
13 }

 

userDao.xml:

 1 <?xml version="1.0" encoding="UTF-8" ?>   
 2 <!DOCTYPE mapper   
 3 PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"  
 4 "http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd"> 
 5 
 6 <mapper namespace="com.dy.dao.UserDao">
 7    
 8    <!-- 对应userDao中的insertUser方法，  -->
 9    <insert id="insertUser" parameterType="com.dy.entity.User">
10            insert into user(id, name, password, age, deleteFlag) 
11                values(#{id}, #{name}, #{password}, #{age}, #{deleteFlag})
12    </insert>
13    
14    <!-- 对应userDao中的updateUser方法 -->
15    <update id="updateUser" parameterType="com.dy.entity.User">
16            update user set name = #{name}, password = #{password}, age = #{age}, deleteFlag = #{deleteFlag}
17                where id = #{id};
18    </update>
19     
20    <!-- 对应userDao中的deleteUser 方法 --> 
21    <delete id="deleteUser" parameterType="com.dy.entity.User">
22            delete from user where id = #{id};
23    </delete>
24 </mapper>

 

这样，一个简单的映射关系就建立了。

仔细观察上面parameterType, "com.dy.entity.User"，包名要是再长点呢，每次都这样写，写得蛋疼了。别忘了之前讲的 typeAliases（别名）， 那么这个地方，用上别名，岂不是技能跟蛋疼的长长的包名说拜拜了。

在哪儿配？ 当然是在mybatis 的全局配置文件（我这儿名字是mybatis-conf.xml）， 不要认为是在mapper的配置文件里面配置哈。 mybatis-conf.xml:

1 <typeAliases>
2       <!--
3       通过package, 可以直接指定package的名字， mybatis会自动扫描你指定包下面的javabean,
4       并且默认设置一个别名，默认的名字为： javabean 的首字母小写的非限定类名来作为它的别名。
5       也可在javabean 加上注解@Alias 来自定义别名， 例如： @Alias(user) 
6       <package name="com.dy.entity"/>
7        -->
8       <typeAlias alias="user" type="com.dy.entity.User"/>
9   </typeAliases>

 

这样，一个别名就取好了，咱们可以把上面的 com.dy.entity.User 都直接改为user 了。 这多方便呀！ 我这儿数据库用的是mysql, 我把user表的主键id 设置了自动增长， 以上代码运行正常，

 

那么问题来了，我要是换成oracle数据库怎么办？

 

oracle 可是不支持id自增长啊？ 怎么办？请看下面：

 1 <!-- 对应userDao中的insertUser方法，  -->
 2    <insert id="insertUser" parameterType="com.dy.entity.User">
 3            <!-- oracle等不支持id自增长的，可根据其id生成策略，先获取id 
 4            
 5         <selectKey resultType="int" order="BEFORE" keyProperty="id">
 6               select seq_user_id.nextval as id from dual
 7         </selectKey>
 8         
 9         -->   
10            insert into user(id, name, password, age, deleteFlag) 
11                values(#{id}, #{name}, #{password}, #{age}, #{deleteFlag})
12    </insert>

 

同理，如果我们在使用mysql的时候，想在数据插入后返回插入的id, 我们也可以使用 selectKey 这个元素：

 1 <!-- 对应userDao中的insertUser方法，  -->
 2    <insert id="insertUser" parameterType="com.dy.entity.User">
 3            <!-- oracle等不支持id自增长的，可根据其id生成策略，先获取id 
 4            
 5         <selectKey resultType="int" order="BEFORE" keyProperty="id">
 6               select seq_user_id.nextval as id from dual
 7         </selectKey>
 8         
 9         --> 
10         
11         <!-- mysql插入数据后，获取id -->
12         <selectKey keyProperty="id" resultType="int" order="AFTER" >
13                SELECT LAST_INSERT_ID() as id
14            </selectKey>
15           
16            insert into user(id, name, password, age, deleteFlag) 
17                values(#{id}, #{name}, #{password}, #{age}, #{deleteFlag})
18    </insert>

 

这儿，我们就简单提一下 <selectKey> 这个元素节点吧:

1 <selectKey
2         <!-- selectKey 语句结果应该被设置的目标属性。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。 -->
3         keyProperty="id"
4         <!-- 结果的类型。MyBatis 通常可以推算出来，但是为了更加确定写上也不会有什么问题。MyBatis 允许任何简单类型用作主键的类型，包括字符串。如果希望作用于多个生成的列，则可以使用一个包含期望属性的 Object 或一个 Map。 -->
5         resultType="int"
6         <!-- 这可以被设置为 BEFORE 或 AFTER。如果设置为 BEFORE，那么它会首先选择主键，设置 keyProperty 然后执行插入语句。如果设置为 AFTER，那么先执行插入语句，然后是 selectKey 元素 - 这和像 Oracle 的数据库相似，在插入语句内部可能有嵌入索引调用。 -->
7         order="BEFORE"
8         <!-- 与前面相同，MyBatis 支持 STATEMENT，PREPARED 和 CALLABLE 语句的映射类型，分别代表 PreparedStatement 和 CallableStatement 类型。 -->
9         statementType="PREPARED">

 

本篇文章主要介绍了insert, update, delete的配置及用法。

 

下篇文章将介绍复杂的 select相关的配置及用法， 待这些都讲完后，会先根据源码分析一下mybatis的整个运行流程，然后再深入mybatis的用法。

 

 

by:一只阿木木