零、準備工作
mysql mysql-connector-java 8.0.20 org.mybatis mybatis 3.5.5 org.projectlombok lombok 1.18.12 provided
一、JDBC的複雜
1、概述
惡心的一批，缺點賊多
- 我就是為了執行一個SQL，結果需要寫一堆亂七八糟的垃圾玩意，比如Class.forName、DriverManager.getConnection、connection.createStatement等，惡心不？
- 執行完SQL，我們需要resultSet.getXxx(int num)來手動封裝到我們的entity對象裡，惡心不？
- SQL直接強耦合到業務代碼裡，修改和閱讀都極其惡心。
2、代碼
來一段JDBC代碼看看。
package com.chentongwei.study.jdbc;import com.chentongwei.study.entity.User;import java.sql.*;import java.util.ArrayList;import java.util.List;/** * 真~~惡心！！！ */public class JdbcDemo { public static void main( String[] args ) { try { Class.forName("com.mysql.cj.jdbc.Driver"); } catch (ClassNotFoundException e) { e.printStackTrace(); } Connection connection = null; Statement statement = null; ResultSet resultSet = null; try { connection = DriverManager.getConnection("xxx"); statement = connection.createStatement(); // 隻有這一句是重點，其他都是垃圾！！！ // 隻有這一句是重點，其他都是垃圾！！！ // 隻有這一句是重點，其他都是垃圾！！！ resultSet = statement.executeQuery("SELECT * FROM user"); List userList = new ArrayList<>(); while (resultSet.next()) { int id = resultSet.getInt(1); String name = resultSet.getString(2); int age = resultSet.getInt(3); userList.add(new User(id, name, age)); } } catch (SQLException e) { e.printStackTrace(); } finally { if (null != resultSet) { try { resultSet.close(); } catch (SQLException e) { e.printStackTrace(); } } if (null != statement) { try { statement.close(); } catch (SQLException e) { e.printStackTrace(); } } if (null != connection) { try { connection.close(); } catch (SQLException e) { e.printStackTrace(); } } } }}
/** * Description: *
* Project mybatis-source-study * * @author TongWei.Chen 2020-06-06 17:12:07 */@[email protected]@AllArgsConstructorpublic class User { private Integer id; private String name; private Integer age;}
二、Mybatis的威力
1、概述
它是一個半ORM的架構，為什麼是半？因為它支援你直接用它封裝好的selectOne等這些玩意，它也支援手寫SQL，比Hibernate的絕大優勢就是上手簡單、半ORM，沒錯，這種半ORM卻成為了它的優點之一。這樣我們手寫的SQL想怎麼優化就怎麼優化，不香嗎？
mybatis優勢(其實也是大多數ORM架構的優勢)
- 你寫你的SQL就完事了，什麼Class.forName等垃圾代碼都沒了，但是會額外增加其他幾段代碼，但是如果你用了Spring-Mybatis的話那你直接寫你的SQL就完事了，沒其他花裡胡哨的東西，都給你封裝了。
- 沒有resultSet.getXxx(int num)這種惡心的代碼，他自動給我們映射了，可以猜測到他内部有元件為我們将傳回的ResultSet封裝到了對應的entity裡。
- SQL寫到mapper或者接口的方法注解上，不會摻雜到業務代碼裡。
2、手寫一個Mybatis
2.1、說明
為了更好的表達Mybatis的底層原理，這裡手寫一個簡易版的mybatis來證明它的核心源碼。這裡隻示範注解式的(比如@Select)，不寫mapper檔案了。
2.2、思路
- 得有個interface(也就是Mapper/DAO接口層)
- jdk動态代理為interface産生具體實作
- 具體實作裡肯定要擷取@Select注解裡的SQL
- 然後擷取方法參數值
- SQL裡的參數都是#{xxx}格式，是以我們要有解析方法參數的方法，比如找到#{和}的位置，然後把這段内容替換成具體的參數值
- 得到完整的SQL(拼好參數值的)
- 執行SQL
- 解析結果集到entity上
2.3、實作
2.3.1、interface
package com.chentongwei.mybatis;import com.chentongwei.study.entity.User;import org.apache.ibatis.annotations.Param;import org.apache.ibatis.annotations.Select;import java.util.List;/** * Description: *
* Project mybatis-source-study * * @author TongWei.Chen 2020-06-06 17:32:52 */public interface UserMapper { @Select("SELECT * FROM user WHERE id = #{id} AND name = #{name}") List listUser(@Param("id") Integer id, @Param("name") String name);}
2.3.2、jdk動态代理
public static void main(String[] args) { // jdk動态代理，代理UserMapper接口 UserMapper userMapper = (UserMapper) Proxy.newProxyInstance(MybatisDemo.class.getClassLoader(), new Class[]{UserMapper.class}, new InvocationHandler() { @Override public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { // 擷取@Select注解， Select annotation = method.getAnnotation(Select.class); // 擷取參數，以key-value的形式放到map裡，比如map.put("id", 1); map.put("name", "test"); Map argsMap = buildMethodArgsMap(method, args); if (null != annotation) { // 擷取SQL：SELECT * FROM user WHERE id = #{id} AND name = #{name} String[] values = annotation.value(); // 1個select注解隻能有一個sql，是以直-接values[0] String sql = values[0]; // sql: SELECT * FROM user WHERE id = #{id} AND name = #{name} System.out.println("sql: " + sql); // 将SQL的#{xxx}部分替換成真實的value得到完整的SQL語句 sql = parseSQL(sql, argsMap); System.out.println("parseSQL: " + sql); // 如下部分省略了，SQL都得到了，下面就jdbc執行，封裝就完事了。 // jdbc執行 // ResultSet得到結果集反射到entity裡，反射有方法可以得到傳回值類型和傳回值泛型的，比如List、泛型是User } return null; } }); userMapper.listUser(1, "test");}
這個方法是描述了所有流程：
1.動态代理UserMapper接口
2.代理類執行listUser方法，參數是1，test
3.擷取listUser方法上的@Select注解
4.擷取@Select注解上的值，也就是SQL語句
5.擷取listUser方法的兩個參數值，1和test，且存到map裡，格式是
Map argsMap = new HashMap<>(); argsMap.put("id", 1); argsMap.put("name", "test");
6.将SQL的#{xxx}部分替換成真實的value得到完整的SQL語句
SELECT * FROM user WHERE id = 1 AND name = test`
7.jdbc執行SQL
8.ResultSet得到結果集反射到entity裡
2.3.3、buildMethodArgsMap
public static Map buildMethodArgsMap(Method method, Object[] args) { // 最終參數-參數值都放到這裡 Map argsMap = new HashMap<>(); // 擷取listUser的所有參數 Parameter[] parameters = method.getParameters(); if (parameters.length != args.length) { throw new RuntimeException("參數個數不一緻呀，兄弟"); } // 别問我為什麼這麼寫，因為java8的foreach文法要求内部用外部的變量必須final類型，final就沒法++操作，是以用數組來玩騷套路 int[] index = {0}; Arrays.asList(parameters).forEach(parameter -> { // 擷取每一個參數的@Param注解，裡面的值就是參數key Param paramAnno = parameter.getAnnotation(Param.class); // 擷取參數值：id和name String name = paramAnno.value(); System.out.println(name); // 将參數值放到最終的map裡。id:1、name:test argsMap.put(name, args[index[0]]); index[0] ++; }); return argsMap;}
最終目的就是傳回參數map。
- 擷取listUser方法的所有參數
- 擷取每個參數的@Param注解的值，這個值就是map裡的key
- 擷取傳進來的args[i]作為value
- 将key-value放到map
2.3.4、parseSQL
/** * sql：SELECT * FROM user WHERE id = #{id} AND name = #{name} * argsMap： Map argsMap = new HashMap<>(); argsMap.put("id", 1); argsMap.put("name", "test"); */public static String parseSQL(String sql, Map argsMap) { StringBuilder sqlBuilder = new StringBuilder(); // 周遊sql的每一個字母，判斷是不是#開頭，是的話找到#{，然後請求parseSQLArg方法填充參數值(1，test) for (int i = 0; i
主要就幹了下面這件事：
将SELECT * FROM user WHERE id = #{id} AND name = #{name}換成
SELECT * FROM user WHERE id = 1 AND name = test
但是需要下面的parseSQLArg來進行解析參數，找到#{xxx}中}的位置。
2.3.5、parseSQLArg
/** * argsStringBuilder：放的是key值，比如"id"、"name" * sql：SELECT * FROM user WHERE id = #{id} AND name = #{name} * nextIndex：目前位置是"#{"這個位置。 */private static int parseSQLArg(StringBuilder argsStringBuilder, String sql, int nextIndex) { // 為啥++一次，因為現在nextIndex指向的是{，是以要+1找到{的下一位 nextIndex ++; // 逐個解析SQL的每個字母，判斷是不是"}" for (; nextIndex
找到參數key值放到argsStringBuilder裡且找到}的位置inextIndex并傳回
解析SQL裡的每個char字母，不是}的話就放到argsStringBuilder裡，比如現在位置是{，那麼nextIndex++就是id的i，然後append到argsStringBuilder裡，continue，在for，這時候id的d，在append到argsStringBuilder裡，以此類推，找到}後就return位置。
2.3.6、完整代碼
package com.chentongwei.mybatis;import org.apache.ibatis.annotations.Param;import org.apache.ibatis.annotations.Select;import java.lang.reflect.InvocationHandler;import java.lang.reflect.Method;import java.lang.reflect.Parameter;import java.lang.reflect.Proxy;import java.util.Arrays;import java.util.HashMap;import java.util.Map;/** * Description: *
* Project mybatis-source-study * * @author TongWei.Chen 2020-06-06 17:33:01 */public class MybatisDemo { public static void main(String[] args) { UserMapper userMapper = (UserMapper) Proxy.newProxyInstance(MybatisDemo.class.getClassLoader(), new Class[]{UserMapper.class}, new InvocationHandler() { @Override public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { System.out.println("代理類生效了，方法名：" + method.getName() + ", 參數是：" + Arrays.toString(args)); Select annotation = method.getAnnotation(Select.class); Map argsMap = buildMethodArgsMap(method, args); if (null != annotation) { String[] values = annotation.value(); // 1個select注解隻能有一個sql，是以直接values[0] String sql = values[0]; System.out.println("sql: " + sql); sql = parseSQL(sql, argsMap); System.out.println("parseSQL: " + sql); } return null; } }); userMapper.listUser(1, "test"); } public static String parseSQL(String sql, Map argsMap) { StringBuilder sqlBuilder = new StringBuilder(); for (int i = 0; i buildMethodArgsMap(Method method, Object[] args) { Map argsMap = new HashMap<>(); Parameter[] parameters = method.getParameters(); if (parameters.length != args.length) { throw new RuntimeException("參數個數不一緻呀，兄弟"); } int[] index = {0}; Arrays.asList(parameters).forEach(parameter -> { Param paramAnno = parameter.getAnnotation(Param.class); String name = paramAnno.value(); System.out.println(name); argsMap.put(name, args[index[0]]); index[0] ++; }); return argsMap; }}
2.3.7、測試
上面完整代碼的測試結果如下：
代理類生效了，方法名：listUser, 參數是：[1, test]idnamesql: SELECT * FROM user WHERE id = #{id} AND name = #{name}parseSQL: SELECT * FROM user WHERE id = 1 AND name = test
很明顯發現我們完美的得到了想要的SQL，接下來jdbc，解析ResultSet就完事了。這裡沒涉及。
我們故意寫錯SQL，去掉#後面的{，再看效果
修改UserMapper接口的listUser方法為如下
public interface UserMapper { @Select("SELECT * FROM user WHERE id = #id} AND name = #{name}") List listUser(@Param("id") Integer id, @Param("name") String name);}
輸出結果直接報錯了
Exception in thread "main" java.lang.RuntimeException: 這裡應該是#{sql:SELECT * FROM user WHERE id = index:31 at com.chentongwei.mybatis.MybatisDemo.parseSQL(MybatisDemo.java:54) at com.chentongwei.mybatis.MybatisDemo$1.invoke(MybatisDemo.java:34) at com.sun.proxy.$Proxy0.listUser(Unknown Source) at com.chentongwei.mybatis.MybatisDemo.main(MybatisDemo.java:41)
再次寫錯SQL，将@Param裡的參數名和SQL的參數名寫的不一緻，看效果：
public interface UserMapper { @Select("SELECT * FROM user WHERE id = #{id} AND name = #{name}") List listUser(@Param("id") Integer id, @Param("name1") String name);}
Exception in thread "main" java.lang.RuntimeException: 找不到參數值:name at com.chentongwei.mybatis.MybatisDemo.parseSQL(MybatisDemo.java:62) at com.chentongwei.mybatis.MybatisDemo$1.invoke(MybatisDemo.java:34) at com.sun.proxy.$Proxy0.listUser(Unknown Source) at com.chentongwei.mybatis.MybatisDemo.main(MybatisDemo.java:41)S
3、總結
- mybatis底層源碼肯定比這優化的很多，各種解析元件，不是for每個SQL的字元去拼接
- 實際mybatis底層有自己封裝好的異常，而不是直接RuntimeException
- 這裡僅僅是為了示範原理，是以不涉及到JDBC執行、映射ResultSet到entity等
三、幾張圖
實際mybatis源碼寫的很棒，各個元件封裝的很好，也很清晰，帶有攔截器功能使之可插拔。
下面這個是比較詳細的mybatis核心元件圖
mybatis源碼包也見名知意
資料在精不在多，收藏夾吃灰的已經夠多了。重要的是認真去看，這些就夠了。想要一起學習進步的，或者想要進學習群的都可以關注我私信我就拉你進群