自定義簡易Mybatis框架

Mybatis執行流程分析

• Mybatis代碼編寫流程:
  
• Mybatis配置文件加載過程:

需求分析及技術概述

• 根據上述的功能結構圖, 得出如下需求:

1. 需要具有配置文件加載模塊. 2. 支持使用構建者進行SessionFactory構建. 3. 支持使用工廠模式構建Session對象. 4. 可以使用代理模式, 構建DAO接口實現類對象. 5. 使用反射機制, 封裝ResultSet結果集. 6. 支持使用.xml文件編寫SQL語句. 7. 支持使用注解方式進行SQL查詢.

• 項目技術要點

1. 解析UserDao.xml; SqlMapConfig.xml需要使用dom4j, xpath技術2. 使用Configuration類(類似于Map結構)存儲SqlMapConfig中配置信息3. SqlMapConfig中包含連接池, 使用DataSource類根據配置信息, 創建連接池4. 使用構建者, 工廠, 代理模式開發5. 使用Java反射機制, 自定義注解.

項目搭建(本項目只構建Select * from tableName; 主要用于理解Mybatis執行過程)

本項目使用maven進行構建, pom.xml文件需引入如下依賴包:

<dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>5.1.6</version></dependency><dependency><groupId>log4j</groupId><artifactId>log4j</artifactId><version>1.2.17</version></dependency> <!-- 使用dom4j與xpath解析xml--><dependency><groupId>dom4j</groupId><artifactId>dom4j</artifactId><version>1.6.1</version></dependency> <!-- xpath技術--><dependency><groupId>jaxen</groupId><artifactId>jaxen</artifactId><version>1.1.6</version></dependency>

項目目錄結構:

本項目分為如下幾塊內容:

配置文件加載(包括SqlMapConfig.xml; Mapper.xml, 注解). 配置數據源. Session工廠 SqlSession

第一部分內容如下:

• 配置文件加載類實體編寫(用于封裝SqlMapConfig.xml文件內容):

/*** 自定義Mybatis的配置文件* @author regotto*/ public class Configuration {private String driver;private String username;private String url;private String password;private Map<String, Mapper> mappers = new HashMap<>(16);//....屬性get, set方法 }

• 注解定義

/*** select語句的注解, 運行期有效, 用于修飾方法* @author regotto*/ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface Select {/*** 配置SQL語句* @return*/String value(); }

• 工具類準備(Xml文件解析, 數據源配置, Sql執行結果集封裝):
• • 獲取XML配置文件的輸入流:

public class Resources {public static InputStream getResourceAsStream(String filePath) {return Resources.class.getClassLoader().getResourceAsStream(filePath);} }

• • Xml文件解析(將配置文件內容解析后, 并將其封裝到Configuration實體中)

public class XMLConfigBuilder {/*** 解析主配置文件，把里面的內容填充到DefaultSqlSession所需要的地方* 使用的技術： dom4j+xpath*/public static Configuration loadConfiguration(InputStream config){try{//定義封裝連接信息的配置對象（mybatis的配置對象）Configuration cfg = new Configuration();//1.獲取SAXReader對象SAXReader reader = new SAXReader();//2.根據字節輸入流獲取Document對象Document document = reader.read(config);//3.獲取根節點Element root = document.getRootElement();//4.使用xpath中選擇指定節點的方式，獲取所有property節點List<Element> propertyElements = root.selectNodes("//property");//5.遍歷節點for(Element propertyElement : propertyElements){//判斷節點是連接數據庫的哪部分信息//取出name屬性的值String name = propertyElement.attributeValue("name");if("driver".equals(name)){String driver = propertyElement.attributeValue("value");cfg.setDriver(driver);}if("url".equals(name)){String url = propertyElement.attributeValue("value");cfg.setUrl(url);}if("username".equals(name)){String username = propertyElement.attributeValue("value");cfg.setUsername(username);}if("password".equals(name)){//表示密碼//獲取property標簽value屬性的值String password = propertyElement.attributeValue("value");cfg.setPassword(password);}}//取出mappers中的所有mapper標簽，判斷他們使用了resource還是class屬性List<Element> mapperElements = root.selectNodes("//mappers/mapper");//遍歷集合for(Element mapperElement : mapperElements){//判斷mapperElement使用的是哪個屬性Attribute attribute = mapperElement.attribute("resource");//在mapper中只有兩種屬性: resource, classif(attribute != null){//表示有resource屬性，用的是XML, 取出屬性的值String mapperPath = attribute.getValue();//獲取屬性的值"com/itheima/dao/IUserDao.xml"//把映射配置文件的內容獲取出來，封裝成一個mapMap<String,Mapper> mappers = loadMapperConfiguration(mapperPath);//給configuration中的mappers賦值cfg.setMappers(mappers);}else{//表示沒有resource屬性，用的是注解 獲取class屬性的值String daoClassPath = mapperElement.attributeValue("class");//根據daoClassPath獲取封裝的必要信息Map<String, Mapper> mappers = loadMapperAnnotation(daoClassPath);//給configuration中的mappers賦值cfg.setMappers(mappers);}}//返回Configurationreturn cfg;}catch(Exception e){throw new RuntimeException(e);}finally{try {config.close();}catch(Exception e){e.printStackTrace();}}}/*** 根據傳入的參數，解析XML，并且封裝到Map中* @param mapperPath 映射配置文件的位置* @return map中包含了獲取的唯一標識（key是由dao的全限定類名和方法名組成）* 以及執行所需的必要信息（value是一個Mapper對象，里面存放的是執行的SQL語句和要封裝的實體類全限定類名(ResultSet的類型)）*/private static Map<String,Mapper> loadMapperConfiguration(String mapperPath)throws IOException {InputStream in = null;try{//定義返回值對象Map<String,Mapper> mappers = new HashMap<String,Mapper>(16);//1.根據路徑獲取字節輸入流in = Resources.getResourceAsStream(mapperPath);//2.根據字節輸入流獲取Document對象SAXReader reader = new SAXReader();Document document = reader.read(in);//3.獲取根節點Element root = document.getRootElement();//4.獲取根節點的namespace屬性取值String namespace = root.attributeValue("namespace");//是組成map中key的部分//5.獲取所有的select節點List<Element> selectElements = root.selectNodes("//select");//6.遍歷select節點集合for(Element selectElement : selectElements){//取出id屬性的值 組成map中key的部分String id = selectElement.attributeValue("id");//取出resultType屬性的值 組成map中value的部分String resultType = selectElement.attributeValue("resultType");//取出文本內容 組成map中value的部分String queryString = selectElement.getText();//創建KeyString key = namespace+"."+id;//創建ValueMapper mapper = new Mapper();mapper.setQueryString(queryString);mapper.setResultType(resultType);//把key和value存入mappers中mappers.put(key,mapper);}return mappers;}catch(Exception e){throw new RuntimeException(e);}finally{in.close();}}/*** 根據傳入的參數，得到dao中所有被select注解標注的方法。* 根據方法名稱和類名，以及方法上注解value屬性的值，組成Mapper的必要信息* @param daoClassPath* @return*/private static Map<String,Mapper> loadMapperAnnotation(String daoClassPath)throws Exception{//定義返回值對象Map<String,Mapper> mappers = new HashMap<String, Mapper>();//1.得到dao接口的字節碼對象Class daoClass = Class.forName(daoClassPath);//2.得到dao接口中的方法數組Method[] methods = daoClass.getMethods();//3.遍歷Method數組for(Method method : methods){//取出每一個方法，判斷是否有select注解boolean isAnnotated = method.isAnnotationPresent(Select.class);if(isAnnotated){//創建Mapper對象Mapper mapper = new Mapper();//取出注解的value屬性值Select selectAnno = method.getAnnotation(Select.class);String queryString = selectAnno.value();mapper.setQueryString(queryString);//獲取當前方法的返回值且返回值必須具有泛型(Generic泛型的意思)// List<User>Type type = method.getGenericReturnType();//判斷type是不是參數化的類型if(type instanceof ParameterizedType){//強轉ParameterizedType ptype = (ParameterizedType)type;//得到參數化類型中的實際類型參數, 因為像Map<K,V>這種存在多個泛型, 所以Type是數組Type[] types = ptype.getActualTypeArguments();//取出第一個, 我們的List<User>只有一個, 所以取出第一個Class domainClass = (Class)types[0];//獲取domainClass的類名String resultType = domainClass.getName();//給Mapper賦值mapper.setResultType(resultType);}//組裝key的信息//獲取方法的名稱String methodName = method.getName();String className = method.getDeclaringClass().getName();String key = className+"."+methodName;//給map賦值mappers.put(key,mapper);}}return mappers;} }

• • 數據源配置

//獲得一個Connection對象 public class DataSource {public static Connection getConnection(Configuration configuration) {try {Class.forName(configuration.getDriver());return DriverManager.getConnection(configuration.getUrl(),configuration.getUsername(),configuration.getPassword());} catch (Exception e) {throw new RuntimeException(e);}} }

• • 結果集封裝(Sql執行后的ResultSet封裝)

/*** @author regotto* 負責執行SQL語句，并且封裝結果集*/ public class Executor {public <E> List<E> selectList(Mapper mapper, Connection conn) {PreparedStatement pstm = null;ResultSet rs = null;try {//1.取出mapper中的數據// select * from userString queryString = mapper.getQueryString();//com.regotto.domain.UserString resultType = mapper.getResultType();Class domainClass = Class.forName(resultType);//2.獲取PreparedStatement對象pstm = conn.prepareStatement(queryString);//3.執行SQL語句，獲取結果集rs = pstm.executeQuery();//4.封裝結果集List<E> list = new ArrayList<E>();//定義返回值while(rs.next()) {//實例化要封裝的實體類對象E obj = (E)domainClass.newInstance();//取出結果集的元信息：ResultSetMetaDataResultSetMetaData rsmd = rs.getMetaData();//取出總列數int columnCount = rsmd.getColumnCount();//遍歷總列數for (int i = 1; i <= columnCount; i++) {//獲取每列的名稱，列名的序號是從1開始的String columnName = rsmd.getColumnName(i);//根據得到列名，獲取每列的值Object columnValue = rs.getObject(columnName);//給obj賦值：使用Java內省機制（借助PropertyDescriptor實現屬性的封裝, 底層還是反射機制）//獲取對應domainClass這個類中的columnName的所有操作//要求：實體類的屬性和數據庫表的列名保持一種PropertyDescriptor pd = new PropertyDescriptor(columnName,domainClass);//獲取它的寫入方法(即setXXX(...))Method writeMethod = pd.getWriteMethod();//把獲取的列的值，給對象賦值(即obj.setXXX(columnValue))writeMethod.invoke(obj,columnValue);}//把賦好值的對象加入到集合中list.add(obj);}return list;} catch (Exception e) {throw new RuntimeException(e);} finally {release(pstm,rs);}}private void release(PreparedStatement pstm,ResultSet rs){if(rs != null){try {rs.close();}catch(Exception e){e.printStackTrace();}}if(pstm != null){try {pstm.close();}catch(Exception e){e.printStackTrace();}}} }

第二部分內容:

• SqlSession工廠(此部分使用工廠模型, 構建者模型):
• • SqlSession工廠接口:

/*** SqlSessionFactory, 制定Session* @author regotto*/ public interface SqlSessionFactory {/*** 返回一個SqlSession對象* @return sqlSession*/SqlSession openSession(); }

• • 工廠建造器:

/*** 根據配置文件創建SqlSessionFactory* @author regotto*/ public class SqlSessionFactoryBuilder {public SqlSessionFactory build(InputStream inputStream) {Configuration configuration = XMLConfigBuilder.loadConfiguration(inputStream);return new DefaultSqlSessionFactory(configuration);} }

• • 默認Session工廠:

/*** 默認的SqlSessionFactory實現* @author regotto*/ public class DefaultSqlSessionFactory implements SqlSessionFactory {private Configuration configuration;public DefaultSqlSessionFactory(Configuration configuration) {this.configuration = configuration;}/*** 創建一個默認的Session* @return*/@Overridepublic SqlSession openSession() {return new DefaultSqlSession(configuration);} }

第三部分內容:

• SqlSession
• • Mapper實體:

/***封裝XXXDao.xml中的resultType和SQL語句* @author regotto*/ public class Mapper {private String resultType;private String queryString;//get, set方法...

• • SqlSession接口:

public interface SqlSession {/*** 通過tClass獲得代理對象* @param daoInterfaceClass* @param <T>* @return 代理對象*/<T> T getMapper(Class<T> daoInterfaceClass);/*** 關閉Session資源*/void close(); }

• • MapperProxy(生成Dao接口代理類):

/*** 代理對象* @author regotto*/ public class MapperProxy implements InvocationHandler {/*** String內存儲*/private Map<String, Mapper> mappers;private Connection connection;public MapperProxy(Map<String, Mapper> mappers, Connection connection) {this.mappers = mappers;this.connection = connection;}/*** 方法增強, 調用selectList* 在此處執行SQL, 對數據庫進行操作* @param proxy 代理對象* @param method 執行方法* @param args 執行方法的參數* @return Object 返回代理對象* @throws Throwable*/@Overridepublic Object invoke(Object proxy, Method method, Object[] args) throws Throwable {String methodName = method.getName();//獲取方法所在的類名String className = method.getDeclaringClass().getName();String key = className + "." + methodName;//查看XXXDao.xml中是否有代理對象對應的類和方法Mapper mapper = mappers.get(key);if (mapper == null) {throw new IllegalArgumentException("傳入的Class對象錯誤");}return new Executor().selectList(mapper, connection);} }

• • 默認SqlSession實現:

/*** 默認的Session* @author regotto*/ public class DefaultSqlSession implements SqlSession {/*** 封裝SqlMapConfig配置信息* 包含DataSource, Mappers(封裝XXXDao.xml的namespace, sql標簽的id, returnType, sql語句)*/private Configuration configuration;/*** 數據庫連接對象*/private Connection connection;public DefaultSqlSession(Configuration configuration) {this.configuration = configuration;this.connection = DataSource.getConnection(configuration);}/*** 創建代理對象* @param daoInterfaceClass 需要創建代理對象的class* @param <T> 針對所有的class* @return 代理對象*/@Overridepublic <T> T getMapper(Class<T> daoInterfaceClass) {return (T) Proxy.newProxyInstance(daoInterfaceClass.getClassLoader(),new Class[]{daoInterfaceClass},new MapperProxy(configuration.getMappers(), connection));}/*** 釋放資源*/@Overridepublic void close() {if (connection != null) {try {connection.close();} catch (SQLException e) {e.printStackTrace();}}} }

測試類:

/*** @author regotto*/ public class MybatisTest {public static void main(String[] args) throws Exception {InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");SqlSessionFactoryBuilder sessionFactoryBuilder = new SqlSessionFactoryBuilder();SqlSessionFactory sessionFactory = sessionFactoryBuilder.build(inputStream);SqlSession sqlSession = sessionFactory.openSession();//獲得代理對象UserDao userDao = sqlSession.getMapper(UserDao.class);List<User> users = userDao.findAll();for (User u: users) {System.out.println(u);}sqlSession.close();inputStream.close();} }

總結

斷點調試, 理解Mybatis執行過程, 根據Mybatis執行過程, 模擬實現. 遇到問題, 理清思路, debug調試.

總結

以上是生活随笔為你收集整理的Mybatis执行流程分析_自定义简易Mybatis框架的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。