Mybatis学习记录

Mybatis学习笔记

今天开始复习一下mybatis的知识，虽然在学校的时候简单用过，但是随着工作中使用的是jpa就逐渐耽搁了。。。现在又要重新复习一下简单用法，顺便再浅浅地看一下源码。
mybatis其实是一种帮助我们转换java对象和数据库表的一种框架，所以我们直接通过一个例子来剖析mybatis是如何帮我们生成实际的sql语句并且返回结果的。

1. public void SessionTest() {
2.         try (InputStream resourceAsStream = Resources.getResourceAsStream("mybatis-config.xml")) {
3.             SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
4.             SqlSession sqlSession = sqlSessionFactory.openSession();
5.             User user = new User();
6.             user.setId(1L);;
7.             user.setUserName(null);
8.             user.setPassword("America");
9.             UserMapper mapper = sqlSession.getMapper(UserMapper.class);
10.             User byCondition = mapper.selectByCondition(user);
11.             System.out.println(byCondition);
13.             User byCondition2 = mapper.selectByCondition(user);
14.             System.out.println(byCondition2);
15.             sqlSession.close();
16.         } catch (IOException e) {
17.             throw new RuntimeException(e);
18.         }
19.     }
22. //UserMapper
23. public interface UserMapper {
24.     User selectByCondition(User user);
25. }

复制代码

mybatis的用法和一些标签就不在这里介绍了，因为我也不怎么了解（在工作中不怎么使用，在这里主要看一下mybatis的核心功能）。从上面的示例代码可以看出，mybatis的查询逻辑多半就是在我们生成的SqlSession对象中，有同学看到了第一行代码

1. InputStream resourceAsStream = Resources.getResourceAsStream("mybatis-config.xml")

复制代码

这里就是使用mybatis中的一个Resources对象读取我们的一些配置，配置也可以贴出来,这个配置是我从官网直接粘贴的，把配置改成自己的。

1. <?xml version="1.0" encoding="UTF-8" ?>
2. <!DOCTYPE configuration
3.         PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
4.         "https://mybatis.org/dtd/mybatis-3-config.dtd">
5. <configuration>
7.     <properties resource="jdbc.properties"/>
9.     <environments default="development">
10.         <environment id="development">
11.             <transactionManager type="JDBC"/>
12.             <dataSource type="POOLED">
13.                 <property name="driver" value="${jdbc.driver}"/>
14.                 <property name="url" value="${jdbc.url}"/>
15.                 <property name="username" value="${jdbc.username}"/>
16.                 <property name="password" value="${jdbc.password}"/>
17.             </dataSource>
18.         </environment>
19.     </environments>
20.     <mappers>
21.         <mapper resource="mapper/UserMapper.xml"/>
22.     </mappers>
24. </configuration>

复制代码

这些是最基本的配置标签，不过已经足够我们来使用mybatis的查询功能咯。
通过读取配置并且得到了SqlSession后，可以看到

1. UserMapper mapper = sqlSession.getMapper(UserMapper.class);

复制代码

这里是通过jdk动态代理生成的我们定义的UserMapper代理类,时序图在下面（画得不是很好）

最底层获取到代理对象的一行代码如图所示

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

复制代码

获取到代理对象之后，接着执行mapper中定义的方法就会执行sql语句了，这里要注意，UserMapper定义的方法始终是要对应到一个mapper文件里面真正想要执行的语句

1. <?xml version="1.0" encoding="UTF-8" ?>
2. <!DOCTYPE mapper
3.         PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
4.         "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
5. <mapper namespace="org.example.mapper.UserMapper">
6.     <select id="selectUser" resultType="org.example.entity.User">
7.         select * from User where id = #{id}
8.     </select>
10.     <insert id="insertUser" parameterType="org.example.entity.User">
11.         insert into user values(#{id}, #{userName}, #{password})
12.     </insert>
14.     <select id="selectByCondition" parameterType="org.example.entity.User" resultType="org.example.entity.User">
15.         select * from user
16.         <where>
17.             <if test="id!=0">
18.                 and id = #{id}
19.             </if>
20.             <if test="userName!=null">
21.                 and userName = #{userName}
22.             </if>
23.         </where>
24.     </select>
26. </mapper>

复制代码

接下来就是查询方法的执行逻辑咯。
执行语句就是下面这一句

1. User byCondition = mapper.selectByCondition(user);

复制代码

上面我们知道了mybatis使用jdk动态代理帮我们生成了一个代理对象，jdk动态代理执行方法实际上就是执行了参数中继承了InvocationHandler的对象的invoke方法，也就是MapperProxy的invoke方法，我们看一下MapperProxy的invoke方法

1. @Override
2.   public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
3.     try {
4.       if (Object.class.equals(method.getDeclaringClass())) {
5.         return method.invoke(this, args);
6.       } else {
7.         return cachedInvoker(method).invoke(proxy, method, args, sqlSession);
8.       }
9.     } catch (Throwable t) {
10.       throw ExceptionUtil.unwrapThrowable(t);
11.     }
12.   }
15. private MapperMethodInvoker cachedInvoker(Method method) throws Throwable {
16.     try {
17.       return MapUtil.computeIfAbsent(methodCache, method, m -> {
18.         if (m.isDefault()) {
19.           try {
20.             if (privateLookupInMethod == null) {
21.               return new DefaultMethodInvoker(getMethodHandleJava8(method));
22.             } else {
23.               return new DefaultMethodInvoker(getMethodHandleJava9(method));
24.             }
25.           } catch (IllegalAccessException | InstantiationException | InvocationTargetException
26.               | NoSuchMethodException e) {
27.             throw new RuntimeException(e);
28.           }
29.         } else {
30.           return new PlainMethodInvoker(new MapperMethod(mapperInterface, method, sqlSession.getConfiguration()));
31.         }
32.       });
33.     } catch (RuntimeException re) {
34.       Throwable cause = re.getCause();
35.       throw cause == null ? re : cause;
36.     }
37.   }

复制代码

这里又调用了cacheInvoker方法构建了一个内部对象MapperMethodInvoker的invoke方法，该对象有两个实现列，我们选择其中一个看一下。

1. private static class PlainMethodInvoker implements MapperMethodInvoker {
2.     private final MapperMethod mapperMethod;
4.     public PlainMethodInvoker(MapperMethod mapperMethod) {
5.       super();
6.       this.mapperMethod = mapperMethod;
7.     }
9.     @Override
10.     public Object invoke(Object proxy, Method method, Object[] args, SqlSession sqlSession) throws Throwable {
11.       return mapperMethod.execute(sqlSession, args);
12.     }
13.   }

复制代码

接着往下走，进入MapperMethod的execute方法

1. public Object execute(SqlSession sqlSession, Object[] args) {
2.     Object result;
3.     switch (command.getType()) {
4.       case INSERT: {
5.         Object param = method.convertArgsToSqlCommandParam(args);
6.         result = rowCountResult(sqlSession.insert(command.getName(), param));
7.         break;
8.       }
9.       case UPDATE: {
10.         Object param = method.convertArgsToSqlCommandParam(args);
11.         result = rowCountResult(sqlSession.update(command.getName(), param));
12.         break;
13.       }
14.       case DELETE: {
15.         Object param = method.convertArgsToSqlCommandParam(args);
16.         result = rowCountResult(sqlSession.delete(command.getName(), param));
17.         break;
18.       }
19.       case SELECT:
20.         if (method.returnsVoid() && method.hasResultHandler()) {
21.           executeWithResultHandler(sqlSession, args);
22.           result = null;
23.         } else if (method.returnsMany()) {
24.           result = executeForMany(sqlSession, args);
25.         } else if (method.returnsMap()) {
26.           result = executeForMap(sqlSession, args);
27.         } else if (method.returnsCursor()) {
28.           result = executeForCursor(sqlSession, args);
29.         } else {
30.           Object param = method.convertArgsToSqlCommandParam(args);
31.           result = sqlSession.selectOne(command.getName(), param);
32.           if (method.returnsOptional()
33.               && (result == null || !method.getReturnType().equals(result.getClass()))) {
34.             result = Optional.ofNullable(result);
35.           }
36.         }
37.         break;
38.       case FLUSH:
39.         result = sqlSession.flushStatements();
40.         break;
41.       default:
42.         throw new BindingException("Unknown execution method for: " + command.getName());
43.     }
44.     if (result == null && method.getReturnType().isPrimitive() && !method.returnsVoid()) {
45.       throw new BindingException("Mapper method '" + command.getName()
46.           + " attempted to return null from a method with a primitive return type (" + method.getReturnType() + ").");
47.     }
48.     return result;
49.   }

复制代码

这里可以看到基本都是执行sqlSession的对应方法，而sqlSession相关的方法都是其内部的Executor来执行的。好像有点简单了，不过主要是为了给自己看哈哈哈哈，先记录这样吧。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！