3 自定义Mybatis框架
3.1 查询所有分析
selectList方法大致分为五步：
1.根据配置文件创建Connection对象
2.获取预处理对象PreparedStatement
3.执行查询操作
4.遍历查询结果集并封装为List
5.返回List对象
其中第一步需要配置文件SqlMapConfig.xml中的信息，解析xml的技术已经成熟，这里不做赘述。
<property name="driver" value="com.mysql.jdbc.Driver"/> <property name="url" value="jdbc:mysql://localhost:3306/eesy_mybatis"/> <property name="username" value="root"/> <property name="password" value="root"/>
第二步获取预处理对象PreparedStatement
conn.prepareStatement(queryString);
需要传入sql语句，需要用到UserDao.xml中定义的sql语句
<mapper namespace="dao.UserDao"> <!-- 配置查询所有操作 --> <select id="findAll" resultType="domain.User"> select * from user; </select> </mapper>
第四步进行数据的封装，需要知道数据库中存储的数据对应的java中的类
对应上面代码中的 resultType
纵观整个解析的过程，如果想要让selectList方法执行，还必须要提供映射信息，映射信息包含两部分：sql和封装结果的实体类名，可以将这两个信息封装成一个映射类Mapper作为map的value，其中map的key为类似于"dao.UserDao.findAll"的字符串。
具体流程如下图：
总结一下：
SqlMapConfig.xml 中包含连接数据库的信息、映射配置信息
UserDao.xml 中包含sql语句和封装的实体类信息
可以使用dom4j技术来解析xml
3.2 创建代理对象的分析
// 使用SqlSession创建Dao接口的代理对象 UserDao userDao = (UserDao) session.getMapper(UserDao.class);
getMapper的具体实现如下：
public <T> T getMapper(Class<T> daoInterfaceClass) { return (T) Proxy.newProxyInstance(daoInterfaceClass.getClassLoader(), new Class[]{daoInterfaceClass}, new MapperProxy(cfg.getMappers(), connection)); }
使用代理
第一个参数是类加载器：使用和被代理对象相同的类加载器
第二个参数是代理对象要实现的接口：和被代理对象实现相同的接口
第三个参数是如何代理：我们自己提供一个增强的方法
3.3 使用Mybatis时用到的类（接口）
class Resources
class SqlSessionFactoryBuilder
interface SqlSessionFactory
interface SqlSession
3.4 准备工作
将之前写的Mybatis测试类中所需要的方法创建出来
3.4.1 Resources 类
package mybatis.io; import java.io.InputStream; /** * 使用类加载器读取配置文件的类 */ public class Resources { /** * 根据传入的参数，获取字节输入流 * @param filePath * @return */ public static InputStream getResourceAsStream(String filePath){ return Resources.class.getClassLoader().getResourceAsStream(filePath); } }
3.4.2 SqlSession 接口
package mybatis.sqlsession; /** * 自定义Mybatis中和数据库交互的核心类 * 里面可以创建dao接口的代理对象 */ public interface SqlSession<T> { /** * 很具参数创建一个代理对象 * @param daoInterfaceClass dao的接口字节码 * @return */ T getMapper(Class<T> daoInterfaceClass); /** * 释放资源 */ void close(); }
3.4.3 SqlSessionFactory 接口
package mybatis.sqlsession; public interface SqlSessionFactory { /** * 用于打开一个新SqlSession对象 * @return */ SqlSession openSession(); }
3.4.4 SqlSessionFactoryBuilder 类
package mybatis.sqlsession; import java.io.InputStream; /** * 用于创建SqlSessionFactory对象 */ public class SqlSessionFactoryBuilder { public SqlSessionFactory build(InputStream in){ return null; } }
3.5 解析XML的工具类介绍
package mybatis.utils; import mybatis.io.Resources; import mybatis.cfg.Configuration; import mybatis.cfg.Mapper; import org.dom4j.Attribute; import org.dom4j.Document; import org.dom4j.Element; import org.dom4j.io.SAXReader; import java.io.IOException; import java.io.InputStream; import java.lang.reflect.Method; import java.lang.reflect.ParameterizedType; import java.lang.reflect.Type; import java.util.HashMap; import java.util.List; import java.util.Map; /** * 用于解析配置文件 */ 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)){ //表示驱动 //获取property标签value属性的值 String driver = propertyElement.attributeValue("value"); cfg.setDriver(driver); } if("url".equals(name)){ //表示连接字符串 //获取property标签value属性的值 String url = propertyElement.attributeValue("value"); cfg.setUrl(url); } if("username".equals(name)){ //表示用户名 //获取property标签value属性的值 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"); if(attribute != null){ System.out.println("使用的是XML"); //表示有resource属性，用的是XML //取出属性的值 String mapperPath = attribute.getValue();//获取属性的值"dao/IUserDao.xml" //把映射配置文件的内容获取出来，封装成一个map Map<String,Mapper> mappers = loadMapperConfiguration(mapperPath); //给configuration中的mappers赋值 cfg.setMappers(mappers); } } //返回Configuration return 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语句和要封装的实体类全限定类名） */ private static Map<String,Mapper> loadMapperConfiguration(String mapperPath)throws IOException { InputStream in = null; try{ //定义返回值对象 Map<String,Mapper> mappers = new HashMap<String,Mapper>(); //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(); //创建Key String key = namespace+"."+id; //创建Value Mapper 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(); } } }
需要在 pom.xml 中导入 dom4j、jaxen
<dependency> <groupId>dom4j</groupId> <artifactId>dom4j</artifactId> <version>1.6.1</version> </dependency> <dependency> <groupId>jaxen</groupId> <artifactId>jaxen</artifactId> <version>1.1.6</version> </dependency>
3.5.1 在 mybatis.cfg 包下创建Configuration类和Mapper类
Configuration类中存储了"dao.UserDao.findAll"与一个Mapper对象的映射
Mapper对象中封装 执行的SQL语句 以及 结果类型的全限定类名
由于可能有多条sql语句，所以Configuration中的setMappers方法应该不断地往map中追加数据，而不是替换，使用 putAll 追加数据时必须先把map new出来，不然空指针。
package mybatis.cfg; import java.util.Map; public class Configuration { private String driver; private String url; private String username; private String password; private Map<String, Mapper> mappers = new HashMap<String, Mapper>(); public String getDriver() { return driver; } public void setDriver(String driver) { this.driver = driver; } public String getUrl() { return url; } public void setUrl(String url) { this.url = url; } public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public String getPassword() { return password; } public void setPassword(String password) { this.password = password; } public Map<String, Mapper> getMappers() { return mappers; } public void setMappers(Map<String, Mapper> mappers) { this.mappers.putAll(mappers); // 追加方式添加至map } }
package mybatis.cfg; /** * 用于封装 执行的SQL语句 以及 结果类型的全限定类名 */ public class Mapper { private String queryString; private String resultType; // 实体类全限定类名 public String getQuerryString() { return queryString; } public void setQueryString(String querryString) { this.queryString = querryString; } public String getResultType() { return resultType; } public void setResultType(String resultType) { this.resultType = resultType; } }
3.6 SqlSessionFactoryBuilder 类的实现
package mybatis.sqlsession; import mybatis.cfg.Configuration; import mybatis.sqlsession.defaults.DefaultSqlSessionFactory; import mybatis.utils.XMLConfigBuilder; import java.io.InputStream; /** * 用于创建SqlSessionFactory对象 */ public class SqlSessionFactoryBuilder { /** * 根据参数的字节输入流构建一个SqlSessionFactory工厂 * @param in * @return */ public SqlSessionFactory build(InputStream config){ Configuration cfg = XMLConfigBuilder.loadConfiguration(config); return new DefaultSqlSessionFactory(cfg); } }
SqlSessionFactoryBuilder 类中有一个 public SqlSessionFactory build(InputStream config)方法，需要返回一个SqlSessionFactory的对象。
3.6.1 SqlSessionFactory 接口的实现类
package mybatis.sqlsession.defaults; import mybatis.cfg.Configuration; import mybatis.sqlsession.SqlSession; import mybatis.sqlsession.SqlSessionFactory; /** * SqlSessionFactory 接口的实现 */ public class DefaultSqlSessionFactory implements SqlSessionFactory { private Configuration cfg; public DefaultSqlSessionFactory(Configuration cfg){ this.cfg = cfg; } /** * 创建一个新的操作数据库对象 * @return */ public SqlSession openSession() { return new DefaultSqlSession(cfg); } }
SqlSessionFactory 中有一个 public SqlSession openSession() 方法，需要返回一个SqlSession的对象。
3.6.2 SqlSession 接口的实现类
package mybatis.sqlsession.defaults; import mybatis.cfg.Configuration; import mybatis.sqlsession.SqlSession; import mybatis.sqlsession.proxy.MapperProxy; import mybatis.utils.DataSourceUtil; import javax.sql.DataSource; import java.lang.reflect.Proxy; import java.sql.Connection; public class DefaultSqlSession implements SqlSession { private Configuration cfg; private Connection connection; public DefaultSqlSession(Configuration cfg){ this.cfg = cfg; connection = DataSourceUtil.getConnection(cfg); } /** * 创建代理对象 * @param daoInterfaceClass dao的接口字节码 * @param <T> * @return */ public <T> T getMapper(Class<T> daoInterfaceClass) { // 使用代理 // 被代理对象的类加载器 // 相同的接口 // 如何代理 return (T) Proxy.newProxyInstance(daoInterfaceClass.getClassLoader(), new Class[]{daoInterfaceClass}, new MapperProxy(cfg.getMappers(), connection)); } /** * 释放资源 */ public void close() { if(connection != null){ try{ connection.close(); }catch (Exception e){ e.printStackTrace(); } } } }
DefaultSqlSession 中使用到的工具类 DataSourceUtil 为：
package mybatis.utils; import mybatis.cfg.Configuration; import java.sql.Connection; import java.sql.DriverManager; /** * 创建数据源的工具类 */ public class DataSourceUtil { public static Connection getConnection(Configuration cfg){ try{ // 注册驱动 Class.forName(cfg.getDriver()); return DriverManager.getConnection(cfg.getUrl(), cfg.getUsername(), cfg.getPassword()); }catch (Exception e){ throw new RuntimeException(e); } } }
该类的 public <T> T getMapper(Class<T> daoInterfaceClass) 方法通过代理模式来实现
public static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h)
loader: 用哪个类加载器去加载代理对象
interfaces:动态代理类需要实现的接口
h:动态代理方法在执行时，会调用h里面的invoke方法去执行
需要定义一个类 MapperProxy 来作为上面的h，该类必须实现 InvocationHandler 接口：
package mybatis.sqlsession.proxy; import mybatis.cfg.Mapper; import mybatis.utils.Executor; import java.lang.reflect.InvocationHandler; import java.lang.reflect.Method; import java.sql.Connection; import java.util.Map; public class MapperProxy implements InvocationHandler { // key : 全限定类名 + 方法名 private Map<String, Mapper> mappers; private Connection conn; public MapperProxy(Map<String, Mapper> mappers, Connection conn){ this.mappers = mappers; this.conn = conn; } // 对方法进行增强，其实就是调用selectList方法 @Override public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { String methodName = method.getName(); // 获取方法所在类的名称 String className = method.getDeclaringClass().getName(); String key = className + "." + methodName; Mapper mapper = mappers.get(key); if (mapper == null){ throw new IllegalArgumentException("传入的参数有误"); } // 调用工具类查询所有 return new Executor().selectList(mapper, conn); } }
MapperProxy 中的使用到的工具类 Execute 为（中间定义了selectList方法）：
package mybatis.utils; import mybatis.cfg.Mapper; import java.beans.PropertyDescriptor; import java.lang.reflect.Method; import java.sql.Connection; import java.sql.PreparedStatement; import java.sql.ResultSet; import java.sql.ResultSetMetaData; import java.util.ArrayList; import java.util.List; /** * 负责执行SQL语句，并且封装结果集 */ public class Executor { public <E> List<E> selectList(Mapper mapper, Connection conn) { PreparedStatement pstm = null; ResultSet rs = null; try { //1.取出mapper中的数据 String queryString = mapper.getQueryString();//select * from user String resultType = mapper.getResultType();//com.itheima.domain.User 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(); //取出结果集的元信息：ResultSetMetaData ResultSetMetaData 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实现属性的封装） PropertyDescriptor pd = new PropertyDescriptor(columnName,domainClass);//要求：实体类的属性和数据库表的列名保持一种 //获取它的写入方法 Method writeMethod = pd.getWriteMethod(); //把获取的列的值，给对象赋值 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(); } } } }
3.7 基于注解的查询所有
修改 resources.SqlMapConfig.xml 中的语法为注解相应的形式：
<mappers> <mapper class="dao.UserDao" /> </mappers>
给 dao.UserDao 添加注解：
@Select("select * from user") List<User> findAll();
新建一个 mybatis.annotations.Select 注解：
package mybatis.annotations; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface Select { /** * 配置sql语句 */ String value(); }
在 utils.XMLConfigBuilder 中添加根据传入的参数，得到dao中所有被select注解标注的方法：
基于反射的原理，传入一个全限定类名，再通过这个类名获取字节码对象、方法，将带有注解的方法的相关信息加入到Mapper对象中。
/** * 根据传入的参数，得到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); //获取当前方法的返回值，还要求必须带有泛型信息 Type type = method.getGenericReturnType();//List<User> //判断type是不是参数化的类型 if(type instanceof ParameterizedType){ //强转 ParameterizedType ptype = (ParameterizedType)type; //得到参数化类型中的实际类型参数 Type[] types = ptype.getActualTypeArguments(); //取出第一个 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; }
此时运行test程序即可看到查询数据库的结果。
源码链接：
https://download.csdn.net/download/HNU_Csee_wjw/12651838
