MyBatis 入门系列【2】 简单的增删改查

91 阅读6分钟

1. Xml 映射文件

MyBatis致力于减少使用成本,让用户能更专注于编写SQL语句。

MyBatis的真正强大在于它的语句映射,这是它的魔力所在。由于它的异常强大,映射器的XML文件就显得相对简单。如果拿它跟具有相同功能的JDBC代码进行对比,你会立即发现省掉了将近95%的代码。

Mapper Xml映射文件只有很少的几个顶级元素(按照应被定义的顺序列出):

  • cache – 该命名空间的缓存配置。
  • cache-ref – 引用其它命名空间的缓存配置。
  • resultMap – 描述如何从数据库结果集中加载对象,是最复杂也是最强大的元素。
  • parameterMap – 老式风格的参数映射。此元素已被废弃,并可能在将来被移除!请使用行内参数映射。文档中不会介绍此元素。
  • sql – 可被其它语句引用的可重用语句块。
  • insert – 映射插入语句。
  • update – 映射更新语句。
  • delete – 映射删除语句。
  • select – 映射查询语句。

1.1 select

select元素来定义查询操作,一个简单的查询示例如下:

<select id="selectOneById" resultType="org.pearl.mybatis.demo.pojo.entity.User" databaseId="mysql">
    select * from base_user where user_id = #{id}
</select>

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最强大的特性,如果你对其理解透彻,许多复杂的映射问题都能迎刃而解。 resultTyperesultMap之间只能同时使用一个。
flushCache将其设置为true后,只要语句被调用,都会导致本地缓存和二级缓存被清空,默认值:false
useCache将其设置为true后,将会导致本条语句的结果被二级缓存缓存起来,默认值:对 select元素为true
timeout这个设置是在抛出异常之前,驱动程序等待数据库返回请求结果的秒数。默认值为未设置(unset)(依赖数据库驱动)。
fetchSize这是一个给驱动的建议值,尝试让驱动程序每次批量返回的结果行数等于这个设置值。 默认值为未设置(unset)(依赖驱动)。
statementType可选STATEMENTPREPAREDCALLABLE。这会让MyBatis分别使用 StatementPreparedStatementCallableStatement,默认值:PREPARED
resultSetTypeFORWARD\_ONLY,SCROLL\_SENSITIVE, SCROLL\_INSENSITIVEDEFAULT(等价于 unset) 中的一个,默认值为unset (依赖数据库驱动)。
databaseId如果配置了数据库厂商标识(databaseIdProvider),MyBatis会加载所有不带 databaseId或匹配当前databaseId的语句;如果带和不带的语句都有,则不带的会被忽略。
resultOrdered这个设置仅针对嵌套结果select语句:如果为true,将会假设包含了嵌套结果集或是分组,当返回一个主结果行时,就不会产生对前面结果集的引用。 这就使得在获取嵌套结果集的时候不至于内存不够用。默认值:false
resultSets这个设置仅适用于多结果集的情况。它将列出语句执行后返回的结果集并赋予每个结果集一个名称,多个名称之间以逗号分隔。

1.2 insert、update、delete

数据变更语句insertupdatedelete的实现非常接近:

<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后,只要语句被调用,都会导致本地缓存和二级缓存被清空,默认值:(对 insertupdatedelete 语句)true
timeout 这个设置是在抛出异常之前,驱动程序等待数据库返回请求结果的秒数。默认值为未设置(unset)(依赖数据库驱动)。
statementType可选STATEMENTPREPAREDCALLABLE。这会让 MyBatis 分别使用 StatementPreparedStatementCallableStatement,默认值:PREPARED
useGeneratedKeys(仅适用于 insertupdate)这会令 MyBatis 使用 JDBCgetGeneratedKeys 方法来取出由数据库内部生成的主键(比如:像 MySQLSQL Server 这样的关系型数据库管理系统的自动递增字段),默认值:false
keyProperty(仅适用于 insertupdate)指定能够唯一识别对象的属性,MyBatis 会使用 getGeneratedKeys 的返回值或 insert 语句的 selectKey 子元素设置它的值,默认值:未设置(unset)。如果生成列不止一个,可以用逗号分隔多个属性名称。
keyColumn(仅适用于 insertupdate)设置生成键值在表中的列名,在某些数据库(像 PostgreSQL)中,当主键列不是表中的第一列的时候,是必须设置的。如果生成列不止一个,可以用逗号分隔多个属性名称。
databaseId如果配置了数据库厂商标识(databaseIdProvider),MyBatis 会加载所有不带 databaseId 或匹配当前 databaseId 的语句;如果带和不带的语句都有,则不带的会被忽略。

1.3 sql

sql这个元素可以用来定义可重用的 SQL 代码片段,以便在其它语句中使用。

2. 案例演示

2.1 增删改查

Mapper接口声明方法:

public interface UserMapper {
    User selectOneById(Long id);

    int insertUser(@Param("user") User user);

    int updateUserById(@Param("user")User user);

    int deleteUserById(Long id);
}

Mapper Xml文件添加SQL映射:

<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="org.pearl.mybatis.demo.dao.UserMapper">
    <!--插入用户-->
    <insert id="insertUser" parameterType="user">
        INSERT INTO base_user (user_id,user_name,login_name)
        VALUES (#{user.userId},#{user.userName},#{user.loginName})
    </insert>

    <!--根据ID修改用户-->
    <update id="updateUserById" parameterType="user">
        UPDATE base_user  SET
            user_name=#{user.userName },
            login_name= #{user.loginName}
        WHERE user_id = #{user.userId }
    </update>

    <!--根据ID删除用户-->
    <delete id="deleteUserById">
        DELETE FROM base_user WHERE  user_id= #{id}
    </delete>

    <!--根据ID查询用户-->
    <select id="selectOneById" resultType="user" databaseId="mysql">
    select * from base_user where user_id = #{id}
  </select>
</mapper>

执行SQL

public class Test003 {
    public static void main(String[] args) throws IOException {
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        SqlSession sqlSession = sqlSessionFactory.openSession();

        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        // 插入
        User user = new User();
        user.setUserId(333333L);
        user.setUserName("liSi");
        user.setLoginName("lilili");
        int result = mapper.insertUser(user);
        System.out.println(result);
        // 修改
        user.setUserId(33L);
        int i1 = mapper.updateUserById(user);
        System.out.println(i1);
        // 删除
        int i = mapper.deleteUserById(44L);
        System.out.println(i);

        // 提交事务
        sqlSession.commit();
        // 关闭会话
        sqlSession.close();
    }
}

2.2 通用 SQL 片段

定义通用的SQL片段:

    <!--定义通用SQL 片段 某个表的某些列-->
    <sql id="commonSql">
        ${alias}.user_id,${alias}.user_name,${alias}.login_name 
    </sql>

alias参数可以静态地(在加载的时候)确定下来,并且可以在不同的 include 元素中定义不同的参数值:

    <!--根据ID查询用户-->
    <select id="selectOneById" resultType="user" databaseId="mysql">
    select
        <include refid="commonSql"><property name="alias" value="base_user"/></include>
     from base_user where user_id = #{id}
  </select>

也可以在 include 元素的 refid 属性或内部语句中使用属性值,例如:

<sql id="sometable">
  ${prefix}Table
</sql>

<sql id="someinclude">
  from
    <include refid="${include_target}"/>
</sql>

<select id="select" resultType="map">
  select
    field1, field2, field3
  <include refid="someinclude">
    <property name="prefix" value="Some"/>
    <property name="include_target" value="sometable"/>
  </include>
</select>