快捷導航

在MyBatis中使用接口映射的步驟詳解

更新時間：2024年06月26日 11:24:59 作者：Victor356

在MyBatis中使用接口映射是一種基于Java接口而非XML映射文件的方式來綁定SQL查詢和操作,這種方法使用注解來指定SQL語句,并將其直接關(guān)聯(lián)到接口方法上,本文給大家介紹了在MyBatis中使用接口映射的步驟,需要的朋友可以參考下

前言

在MyBatis中使用接口映射是一種基于Java接口而非XML映射文件的方式來綁定SQL查詢和操作。這種方法使用注解來指定SQL語句，并將其直接關(guān)聯(lián)到接口方法上。通過這種方式，可以省去編寫XML映射文件的工作，而且使得SQL語句和Java代碼的關(guān)系更直觀。

1. 定義一個Mapper接口

首先，定義一個接口來表示你的數(shù)據(jù)庫操作。例如，如果你有一個User表，你可以創(chuàng)建一個UserMapper接口：

public interface UserMapper {
    @Select("SELECT * FROM users WHERE id = #{id}")
    User getUserById(Integer id);
    
    @Insert("INSERT INTO users(name, email) VALUES(#{name}, #{email})")
    @Options(useGeneratedKeys = true, keyProperty = "id")
    void insertUser(User user);
    
    @Update("UPDATE users SET name=#{name}, email=#{email} WHERE id=#{id}")
    void updateUser(User user);
    
    @Delete("DELETE FROM users WHERE id=#{id}")
    void deleteUser(Integer id);
}

這個接口定義了基本的增刪改查操作，并通過注解@Select、@Insert、@Update、@Delete與SQL語句相關(guān)聯(lián)。

2. 配置MyBatis使用注解

接下來，在MyBatis配置文件中指定你的接口。你無需指定XML文件，因為你用注解定義了SQL語句。

mybatis-config.xml 示例（無需mapper XML聲明）

<configuration>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis"/>
                <property name="username" value="root"/>
                <property name="password" value="password"/>
            </dataSource>
        </environment>
    </environments>
    
    <mappers>
        <mapper class="org.example.mapper.UserMapper"/>
    </mappers>
</configuration>

3. 在代碼中使用Mapper接口

創(chuàng)建SqlSessionFactory和SqlSession，然后通過SqlSession獲取Mapper接口的實例。

try (SqlSession session = sqlSessionFactory.openSession()) {
    UserMapper mapper = session.getMapper(UserMapper.class);
    
    // 使用mapper操作數(shù)據(jù)庫
    User user = mapper.getUserById(1);
    System.out.println(user.getName());
    
    // 更多的數(shù)據(jù)庫操作...
}

4. 深入源碼分析

在MyBatis初始化過程中，當你調(diào)用getMapper(Class<T> type)方法時，MyBatis內(nèi)部使用了JDK動態(tài)代理來創(chuàng)建Mapper接口的實現(xiàn)。

public <T> T getMapper(Class<T> type) {
    return configuration.<T>getMapper(type, this);
}

在Configuration類中，getMapper方法會調(diào)用mapperRegistry中的getMapper方法，該方法最終調(diào)用了MapperProxyFactory來創(chuàng)建Mapper代理：

public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
    final MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);
    if (mapperProxyFactory == null) {
        throw new BindingException("Type " + type + " is not known to the MapperRegistry.");
    }
    try {
        return mapperProxyFactory.newInstance(sqlSession);
    } catch (Exception e) {
        throw new BindingException("Error getting mapper instance. Cause: " + e, e);
    }
}

MapperProxyFactory創(chuàng)建代理對象：

public T newInstance(SqlSession sqlSession) {
    final MapperProxy<T> mapperProxy = new MapperProxy<>(sqlSession, mapperInterface, methodCache);
    return newInstance(mapperProxy);
}

protected T newInstance(MapperProxy<T> mapperProxy) {
    return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[]{mapperInterface}, mapperProxy);
}

MapperProxy是實際的代理類，它實現(xiàn)了InvocationHandler接口。每當你調(diào)用一個Mapper接口的方法時，都會調(diào)用invoke方法。在這個方法中，MyBatis會判斷該調(diào)用是否對應(yīng)一個SQL操作，并執(zhí)行相應(yīng)的SQL語句：

public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    if (Object.class.equals(method.getDeclaringClass())) {
        return method.invoke(this, args);
    } else {
        final MapperMethod mapperMethod = cachedMapperMethod(method);
        return mapperMethod.execute(sqlSession, args);
    }
}