Mybatis之接口式编程

最新推荐文章于 2021-08-13 21:09:17 发布

秃头哥编程

最新推荐文章于 2021-08-13 21:09:17 发布

阅读量363

点赞数

CC 4.0 BY-SA版权

分类专栏： Mybatis 文章标签： Mybatis 接口式编程原理

本文链接：https://blog.youkuaiyun.com/a_helloword/article/details/80314469

Mybatis 专栏收录该内容

2 篇文章

订阅专栏

本文探讨了MyBatis的传统方法及其存在的问题，并介绍了如何通过接口式编程来提高代码的可读性和维护性。通过定义代理接口并将其与XML映射文件关联，可以有效地避免命名空间错误等问题。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1.传统方法的弊端

还记得在Mybatis入门&配置文件&映射文件这篇文章中，我们写的Mybatis访问数据库执行sql语句的代码。是通过如下代码

// 读取Message.xml中的sql语句 
messages = sqlSession.selectList("Message.getList", message);
sqlSession.commit();

首先Message对应的是Message.xml文件中的namespace，getList是我们sql语句的id，通过Message.getList我们就可以访问该映射文件中的sql语句。这样做有什么坏处呢？有以下四个缺点

为了确保命名空间的唯一性，namespace我们一般起的都是比较长的，这样通过namespace.id取sql语句，就会存在出错的可能性，因为你可能手误啥的，关键是不管比怎么写，它是一个字符串，不会给你报错啊。真正等你运行起来的时候，一大堆代码，那时候就一脸懵逼了。
selectList方法的第二个参数是Object，也就是说你可以传入任何类型，当然，正确的答案就是传入符合sql语句定义的parameterType，然而因为方法要求的是Object类型，所以你传啥都不会报错，这又埋下了隐患。
selectList方法返回的一个Object类型，万一你手抖用了一个错误的类型去接它的返回值，这又是一个隐患。
最后还得sqlSession.commit()，这个也很容易忘记。

基于以上，我们就使用接口式编程，这也正是Mybatis提倡我们做的。

2.接口式编程

其实在Mybatis中，所谓接口编程，就是我们定义一个代理接口，对应相应的数据表的配置文件，比如一个Message.xml，对应数据库中的message表，Message.xml如下

<!-- 一个名字空间 -->
<mapper namespace="Message">
    <!-- 和数据库的表字段相对应 ,type表示相应的实体类--> 
    <resultMap type="com.codeliu.bean.Message" id="MessageResult"> 
        <!-- 主键 column表示数据库中的字段，property表示实体类对应的属性--> 
        <id column="id" jdbcType="INTEGER" property="id"/> 
        <result column="command" jdbcType="VARCHAR" property="command"/> 
        <result column="description" jdbcType="VARCHAR" property="description"/> 
        <result column="content" jdbcType="VARCHAR" property="content"/> 
    </resultMap> 
    <!-- 同一个命名空间下的id要唯一 --> 
    <select id="getList" resultMap="MessageResult" parameterType="com.codeliu.bean.Message"> 
        select id,command,description,content from message
        <where> 
            <if test="command != null and !&quot;&quot;.equals(command.trim())"> 
                and command = #{command} 
            </if> 
            <if test="description != null and !&quot;&quot;.equals(description.trim())"> 
                and description like '%' #{description} '%' 
            </if> 
        <where>
    </select>
</mapper>

我们定义一个接口IMessage.java，代码如下

package com.codeliu.dao;

import com.codeliu.bean.Message;
public interface IMessage {
    /** 
     * 函数名对应Message.xml中相应SQL语句的id
     * @param message 对应Message.xml中相应SQL语句的parameterType
     * @return
     */ 
    public Message getList(Message message);
}

可以看到该接口中有一个方法，方法名对应sql语句的id，参数是sql语句的parameterType，返回值是sql语句查询结果的对应的实体。

有了这个接口，我就可以改变上面那个读取数据的方式。把上面两句注释掉，换成如下的语句

IMessage imessage = sqlSession.getMapper(IMessage.class); 
// 这个parameters就是传进来的参数
messages = imessage.getList(parameters);

记得还要改映射文件Message.xml的namespace，一开始的值为Message，现在改成该接口的完整路径，也就是com.codeliu.dao.IMessage。这样就形成了一种对应关系，如果Message.xml中有多个sql语句，就可以在接口中添加对应的方法，这样就避免了上述的四个缺点。