快捷導(dǎo)航

Mybatis Mapper接口和xml綁定的多種方式、內(nèi)部實(shí)現(xiàn)原理和過程解析

更新時間：2023年11月15日 15:09:57 作者：say榮帥

在Mybatis中,我們需要創(chuàng)建一個與實(shí)體類對應(yīng)的Mapper接口,然后在該接口上添加方法,這些方法對應(yīng)著SQL語句,這篇文章主要介紹了Mybatis Mapper接口和xml綁定的多種方式、內(nèi)部實(shí)現(xiàn)原理和過程,需要的朋友可以參考下

一、綁定方式

1. XML文件方式

在Mybatis中，我們需要創(chuàng)建一個與實(shí)體類對應(yīng)的Mapper接口，然后在該接口上添加方法，這些方法對應(yīng)著SQL語句。然后，我們需要創(chuàng)建一個XML文件，這個文件中包含了SQL語句和映射關(guān)系。

例如，我們有一個User實(shí)體類和一個UserMapper接口：

public interface UserMapper {
    User getUserById(int id);
}

然后，我們可以創(chuàng)建一個名為UserMapper.xml的文件，內(nèi)容如下：

<mapper namespace="com.example.dao.UserMapper">
    <select id="getUserById" resultType="com.example.entity.User">
        SELECT * FROM user WHERE id = #{id}
    </select>
</mapper>

在這個XML文件中，namespace屬性指定了Mapper接口的全限定名，id屬性指定了SQL語句的唯一標(biāo)識符，resultType屬性指定了查詢結(jié)果的類型。

2. 注解方式

Mybatis也支持通過注解的方式來進(jìn)行映射。首先，需要在Mapper接口上添加@Mapper注解，然后在方法上添加@Select、@Insert、@Update、@Delete等注解來指定SQL語句。

例如，我們可以將上面的UserMapper接口改為注解方式：

import org.apache.ibatis.annotations.*;
@Mapper
public interface UserMapper {
    @Select("SELECT * FROM user WHERE id = #{id}")
    User getUserById(int id);
}

在這個例子中，@Mapper注解表示這是一個Mapper接口，@Select注解表示這是一個查詢語句，#{id}是參數(shù)占位符。

3. 需要注意

啟動類上添加@MapperScan注解指定掃描路徑

@SpringBootApplication
@MapperScan("com.example.mapper") // 指定掃描路徑
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

不用@MapperScan注解，也可以在mybatis-config.xml中配置mapper映射文件的位置和命名空間

<configuration>
    <mappers>
        <mapper resource="com/example/mapper/UserMapper.xml"/> // 指定Mapper映射文件的位置和名稱
    </mappers>
</configuration>

二、實(shí)現(xiàn)原理

1. 原理

Mybatis的Mapper接口和xml綁定的原理主要依賴于JDK動態(tài)代理技術(shù)。

而Mybatis中MapperProxy代理類是mybatis實(shí)現(xiàn)Mapper接口和xml綁定的核心類之一。它實(shí)現(xiàn)了InvocationHandler接口，用于攔截Mapper接口方法的調(diào)用，并將方法名和參數(shù)傳遞給SqlSession對象執(zhí)行相應(yīng)的SQL語句。

2. MapperProxy代理類的實(shí)現(xiàn)過程

首先，通過JDK動態(tài)代理技術(shù)生成一個MapperProxy代理類實(shí)例。這個代理類實(shí)現(xiàn)了Mapper接口，并重寫了接口中的方法。
在重寫的方法中，MapperProxy會攔截方法調(diào)用，并將方法名和參數(shù)傳遞給SqlSession對象執(zhí)行相應(yīng)的SQL語句。
SqlSession對象會根據(jù)Mapper接口的namespace值找到對應(yīng)的mapper.xml文件，并根據(jù)id值找到對應(yīng)的SQL語句。然后，根據(jù)返回值類型和參數(shù)類型等信息，生成相應(yīng)的Java代碼。這些Java代碼會包含對SqlSession的操作，例如查詢、更新等操作。最終，SqlSession對象會將這些Java代碼編譯成字節(jié)碼，并加載到JVM中運(yùn)行。
當(dāng)SQL語句執(zhí)行完畢后，SqlSession對象會將結(jié)果返回給MapperProxy代理類。然后，MapperProxy代理類會將結(jié)果映射為Java對象，并返回給調(diào)用者。

3. MapperProxy代理類源碼

下面是MapperProxy代理class的核心方法實(shí)現(xiàn)：mybatis3.5.9

public class MapperProxy<T> implements InvocationHandler, Serializable {
  @Override
  public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    try {
      if (Object.class.equals(method.getDeclaringClass())) {
        return method.invoke(this, args);
      } else {
        return cachedInvoker(method).invoke(proxy, method, args, sqlSession);
      }
    } catch (Throwable t) {
      throw ExceptionUtil.unwrapThrowable(t);
    }
  }
  private MapperMethodInvoker cachedInvoker(Method method) throws Throwable {
    try {
      return MapUtil.computeIfAbsent(methodCache, method, m -> {
        if (m.isDefault()) {
          try {
            if (privateLookupInMethod == null) {
              return new DefaultMethodInvoker(getMethodHandleJava8(method));
            } else {
              return new DefaultMethodInvoker(getMethodHandleJava9(method));
            }
          } catch (IllegalAccessException | InstantiationException | InvocationTargetException
              | NoSuchMethodException e) {
            throw new RuntimeException(e);
          }
        } else {
          return new PlainMethodInvoker(new MapperMethod(mapperInterface, method, sqlSession.getConfiguration()));
        }
      });
    } catch (RuntimeException re) {
      Throwable cause = re.getCause();
      throw cause == null ? re : cause;
    }
  }
  private MethodHandle getMethodHandleJava9(Method method)
      throws NoSuchMethodException, IllegalAccessException, InvocationTargetException {
    final Class<?> declaringClass = method.getDeclaringClass();
    return ((Lookup) privateLookupInMethod.invoke(null, declaringClass, MethodHandles.lookup())).findSpecial(
        declaringClass, method.getName(), MethodType.methodType(method.getReturnType(), method.getParameterTypes()),
        declaringClass);
  }
  private MethodHandle getMethodHandleJava8(Method method)
      throws IllegalAccessException, InstantiationException, InvocationTargetException {
    final Class<?> declaringClass = method.getDeclaringClass();
    return lookupConstructor.newInstance(declaringClass, ALLOWED_MODES).unreflectSpecial(method, declaringClass);
  }
}

到此這篇關(guān)于Mybatis Mapper接口和xml綁定的多種方式、內(nèi)部實(shí)現(xiàn)原理和過程的文章就介紹到這了,更多相關(guān)Mybatis Mapper接口和xml綁定內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: