快捷導(dǎo)航

Mybatis之@MapKey的實(shí)現(xiàn)

更新時(shí)間：2024年09月26日 09:51:59 作者：一只懶魚a

本文介紹了Mybatis中@MapKey注解的使用場(chǎng)景與效果,包含使用@MapKey和不使用@MapKey注解的區(qū)別,然后通過源碼解析產(chǎn)生各種結(jié)果的原因,具有一定的參考價(jià)值,感興趣的可以了解一下

前言

演示返回單行、多行數(shù)據(jù)，使用@MapKey和不使用@MapKey注解的區(qū)別，然后通過源碼解析產(chǎn)生各種結(jié)果的原因

案例演示

分別演示下列四種情況

單行不使用@MapKey注解
多行不使用@MapKey注解
單行使用@MapKey注解
多行使用@MapKey注解

代碼準(zhǔn)備

創(chuàng)建mybatis-config.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>

    <properties>
        <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://127.0.0.1/test?useUnicode=true&amp;characterEncoding=utf-8&amp;useSSL=false&amp;serverTimezone=Asia/Shanghai&amp;allowPublicKeyRetrieval=true"/>
        <property name="username" value="root"/>
        <property name="password" value="123456"/>
    </properties>

    <settings>
        <setting name="mapUnderscoreToCamelCase" value="true"/>
    </settings>

    <environments default="default">
        <environment id="default">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>

    <mappers>
        <mapper resource="mapper/MapKeyMapper.xml"/>
    </mappers>

</configuration>

創(chuàng)建MapKeyMapper.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.ys.mybatis.mapper.MapKeyMapper">

    <select id="getBlogMapById" resultType="map">
         select id, title from blog where id = #{id}
    </select>

    <select id="listBlogMap" resultType="map">
         select id, title from blog
    </select>

</mapper>

創(chuàng)建接口MapKeyMapper

public interface MapKeyMapper {

    Map<String, Object> getBlogMapById(Integer id);

    Map<String, Object> listBlogMap();
}

創(chuàng)建測(cè)試類MapKeyTest

@Slf4j
public class MapKeyTest {

    private SqlSessionFactory sqlSessionFactory;

    @BeforeEach
    public void init() {
        InputStream inputStream = ConfigurationTest.class.getClassLoader().getResourceAsStream("mybatis-config.xml");
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    }


    @Test
    public void singleRowTest() {

        SqlSession sqlSession = sqlSessionFactory.openSession();

        MapKeyMapper mapper = sqlSession.getMapper(MapKeyMapper.class);
        Map<String, Object> map = mapper.getBlogMapById(1);
        System.out.println(map);

    }

    @Test
    public void multiLineTest() {

        SqlSession sqlSession = sqlSessionFactory.openSession();

        MapKeyMapper mapper = sqlSession.getMapper(MapKeyMapper.class);
        Map<String, Object> map = mapper.listBlogMap();
        System.out.println(map);
    }


}

單行不使用@MapKey注解

執(zhí)行測(cè)試方法singleRowTest

正確返回，map格式為 Map<String,Object>

多行不使用@MapKey注解

執(zhí)行測(cè)試方法multiLineTest

異常返回，拋出 TooManyResultsException

單行使用@MapKey注解

給接口方法添加@MapKey注解

@MapKey("id")
Map<String, Object> getBlogMapById(Integer id);

執(zhí)行測(cè)試方法singleRowTest

正確返回，map格式為 Map<Long,Map<String,Object>>

多行使用@MapKey注解

給接口方法添加@MapKey注解

@MapKey("id")
Map<String, Object> listBlogMap();

執(zhí)行測(cè)試方法multiLineTest

正確返回，map格式為 Map<Long, Map<String,Object>>

源碼解析

默認(rèn)情況下，Mybatis會(huì)通過MapperMethod的 execute 方法對(duì)將要執(zhí)行的方法進(jìn)行分發(fā)。

MapperMethod結(jié)構(gòu)如下：

public class MapperMethod {

  private final SqlCommand command;
  private final MethodSignature method;

  public MapperMethod(Class<?> mapperInterface, Method method, Configuration config) {
    this.command = new SqlCommand(config, mapperInterface, method);
    this.method = new MethodSignature(config, mapperInterface, method);
  }
}

MapperMethod實(shí)例化的過程中，會(huì)實(shí)例化其內(nèi)部屬性MethodSignature

通過源碼我們得出：如果接口方法上存在@MapKey注解，returnsMap 屬性就為true

returnsMap的值決定是執(zhí)行executeForMap還是selectOne方法

返回類型為map，存在@MapKey注解，執(zhí)行executeForMap，否則執(zhí)行selectOne方法

selectOne

執(zhí)行selectOne方法，如果返回的條目數(shù)大于1，則拋出異常。測(cè)試案例2（多行不使用@MapKey注解）就是因?yàn)榉祷氐臈l目數(shù)大于1，拋出了TooManyResultsException異常

selectMap

DefaultMapResultHandler實(shí)例化

DefaultMapResultHandler實(shí)例化的過程中，會(huì)實(shí)例化其內(nèi)部屬性mappedResults，該屬性的類型為Map

handleResult

通過@MapKey指定的key獲取value，再以該value為key，原始value為value，put到mappedResults中，最終將這個(gè)mappedResults返回。因?yàn)樵紇alue的類型是Map<String,Object>，@MapKey指定的key的類型是Long，所以最終返回類型是Map<Long,Map<String,Object>>

到此這篇關(guān)于Mybatis之@MapKey的實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)Mybatis @MapKey內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: