参考：https://blog.csdn.net/weixin_44832837/article/details/106194503写的很好
一、Mybatis自定义概述
1.学习目标
首先明确，学习自定义Mybatis是为了更好的理解Mybatis的工作过程及实现原理，而不是真的为了实现一个Mybatis框架。
首先还是从Mybatis的入门案例开始
类与类之间的关系
二、Mybatis自定义的实现
下面开始对这些步骤进行逐步分析
1、读取配置文件
目的：获取主配置文件的输入流in。
方法：使用类加载器进行获取。
在这里，对使用类加载器获取主配置文件输入流进行了简单的封装，没有什么复杂的操作。
package com.mybatis.io;
import java.io.InputStream;
/**
* 该类实现功能：使用类加载器读取配置文件
*/
public class Resources {
public static InputStream getResourceAsStream(String filepath){
return Resources.class.getClassLoader().getResourceAsStream(filepath);
}
}
2、SqlSessionFactoryBuilder类
目的：使用SqlSessionFactoryBuilder类生产SqlSessionFactory
方法：SqlSessionFactoryBuilder类有一个build()方法，该方法参数是InputStream类型的变量，实参就是上一步中获取到是主配置文件的输入流in，获取到主配置文件输入流之后，需要对输入流对象in进行解析，并且封装到Configuration对象cfg。然后再生产出SqlSessionFactory工厂。
package com.mybatis.sqlsession;
/**
* 功能：创建一个SqlSessionFactory对象
*/
public class SqlSessionFactoryBuilder {
/**
* 根据参数的字节输入流来构建SqlSessionFactory对象
* @param in
* @return
*/
public SqlSessionFactory build(InputStream in) {//in 是主配置文件
Configuration cfg= XMLConfigBuilder.loadConfiguration(in);//cfg是Configuration
return new DefaultSqlSessionFactory(cfg);
}
}
上面是SqlSessionFactory的build方法。然而，可以发现，并不存在Configuration和XMLConfigBuilder类，因此需要新建Configuration和XMLConfigBuilder类。
主配置文件SqlMapConfig.xml
<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
<!--配置环境-->
<environments default="mysql">
<!--配置mysql环境-->
<environment id="mysql">
<!--配置事务类型-->
<transactionManager type="JDBC"></transactionManager>
<!--配置数据源（连接池）-->
<dataSource type="POOLED">
<!--配置连接数据库的4个基本信息-->
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/test01"/>
<property name="username" value="root"/>
<property name="password" value="064078"/>
</dataSource>
</environment>
</environments>
<!--指定映射配置文件（每个Dao独立的配置文件）的位置，-->
<mappers>
<mapper resource="IUserDao.xml"/>
<!--注解-->
<!--<mapper class="com.mbtest.dao.IUserDao"/>-->
</mappers>
</configuration>
根据主配置文件得到的Configuration类
package com.mybatis.config;
import java.util.HashMap;
import java.util.Map;
/**
* 自定义mybatis的配置类
*/
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 Map<String, Mapper> getMappers() {
return mappers;
}
public void setMappers(Map<String, Mapper> mappers) {
this.mappers.putAll(mappers);//此处使用追加的方式
}
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;
}
}
Configuration类存在的价值就是对主配置文件解析结果的封装，因此，可以发现，Configuration类的发生同主配置文件的发生存在着关联。其中的setMapper()方法，因为这个方法很特殊，其不能像其它setter方法一个直接使用this.xxx = xxx进行赋值操作，因为主配置文件中的<mappers>标签下可能有多个<mapper>元素，如果直接赋值前面的<mapper>会被覆盖掉。
XmlConfigBuilder：解析xml文件，返回configuration对象
package com.mybatis.utils;
//import com.mybatis.annotations.Select;
import com.mybatis.annotation.Select;
import com.mybatis.config.Configuration;
import com.mybatis.config.Mapper;
import com.mybatis.io.Resources;
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();//获取属性的值"com/mbtest/dao/IUserDao.xml"
//把映射配置文件的内容获取出来，封装成一个map
Map<String,Mapper> mappers = loadMapperConfiguration(mapperPath);
//给configuration中的mappers赋值
cfg.setMappers(mappers);
}else{
System.out.println("使用的是注解");
//表示没有resource属性，用的是注解
//获取class属性的值
String daoClassPath = mapperElement.attributeValue("class");
//根据daoClassPath获取封装的必要信息
Map<String,Mapper> mappers = loadMapperAnnotation(daoClassPath);
//给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();
}
}
/**
* 根据传入的参数，得到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;
}
}
3、SqlSessionFactory
目的：生产SqlSession对象sqlSession，基于面向接口编程的思想，这里的SqlSessionFactory应当是一个接口而不是实现类。
方法：通过分析测试类，SqlSessionFactory中应当有一个openSession()方法用以获取sqlSession对象。有了这个接口之后，开始编写它的实现类DefaultSqlSessionFactory，这个实现类的编写也不难，因为其是工厂，工厂就要生产产品，对于这个工厂来说，它要生产的产品就是sqlSession对象，而方法就是其接口中定义的方法openSessiom()，
package com.mybatis.sqlsession;
public interface SqlSessionFactory {
/**
* 打开一个新的SqlSession对象
*/
SqlSession openSession();
}
package com.mybatis.sqlsession.defaults;
import com.mybatis.config.Configuration;
import com.mybatis.sqlsession.SqlSession;
import com.mybatis.sqlsession.SqlSessionFactory;
/**
*SqlSession接口的实现类
*/
public class DefaultSqlSessionFactory implements SqlSessionFactory {
private Configuration cfg;//连接数据库信息，mapper信息（Sql语句+封装类型）
public DefaultSqlSessionFactory(Configuration cfg){
this.cfg=cfg;
}
/**
* 用于创建一个新的数据库操作对象
* @return
*/
public SqlSession openSession() {
return new DefaultSqlSession(cfg) ;
}
}
所谓生产产品，其实就是new一个类的对象，在这里，也就是new一个SqlSession的对象。SqlSession应该是一个接口，不能new，因此，还要写一个SqlSession的实现类DefaultSqlSession。此外对于产品SqlSession的对象sqlSession来说，其应当包含配置信息configuration，因此，还要向其传递已经封装好的Configuration参数cfg。
4、SqlSession
目的：获取dao接口的代理对象mapper，并且在执行完成后可以释放资源。
方法：如何获取dao接口的代理对象呢？这里利用的是java的反射。首先，基于面向接口编程的思想，先定义一个SqlSession接口
package com.mybatis.sqlsession;
/**
* mybatis中和数据交互的核心类
* 功能：可以创建dao接口的代理对象
* daoInterfaceClass:dao接口的字节码
*/
public interface SqlSession {
<T> T getMapper(Class<T> daoInterfaceClass);
/**
*释放资源
*/
void close();
}
然后再编写其实现类DefaultSqlSession。通过前面的分析，可以发现，这个类要实现两个功能，一个是创建代理对象，一个是释放资源。首先要实现的是代理对象的创建。目前，关于代理对象，已知的是其接口的字节码文件。因此，可以 通过其接口的字节码文件利用Java代理（Proxy）来实现代理对象的创建，并通过实现InvocationHandler接口实现对代理对象功能的增强。
package com.mybatis.sqlsession.defaults;
import com.mybatis.config.Configuration;
import com.mybatis.sqlsession.SqlSession;
import com.mybatis.sqlsession.proxy.*;
import com.mybatis.utils.DataSourceUtil;
import java.lang.reflect.Proxy;
import java.sql.Connection;
/**
* @author 黑马程序员
* @Company http://www.ithiema.com
* SqlSession接口的实现类
*/
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
*/
@Override
public <T> T getMapper(Class<T> daoInterfaceClass) {
return (T) Proxy.newProxyInstance(daoInterfaceClass.getClassLoader(),
new Class[]{daoInterfaceClass},new MapperProxy(cfg.getMappers(),connection));
}
/**
* 用于释放资源
*/
@Override
public void close() {
if(connection != null) {
try {
connection.close();
} catch (Exception e) {
e.printStackTrace();
}
}
}
}
具体实现时，使用了Proxy 的静态工厂方法 newProxyInstance 创建动态代理类实例。
这里有三个参数：
1）loader : 类加载器，这里可以通过参数中的Class类型的对象daoInterfaceClass调用getClassLoader()方法来获取类加载器。
2）interfaces ：实现的全部接口，这里的代理对象只实现了IUserDao接口，也就是参数中的daoInterfaceClass
3）h ：处理器，处理器实现代理对象的增强。
通过分析，前两个参数都可以通过参数daoInterfaceClass获取，而第三个参数h目前还没有。因此，需要创建一个InvocationHandler对象，而InvocationHandler是并不是一个类，而是接口，因此创建一个InvocationHandler的实现类MapperProxy来对代理对象增强。
package com.mybatis.sqlsession.proxy;
import com.mybatis.config.Mapper;
import com.mybatis.utils.Executor;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.sql.Connection;
import java.util.Map;
/**
* @author 黑马程序员
* @Company http://www.ithiema.com
*/
public class MapperProxy implements InvocationHandler {
//map的key是全限定类名+方法名
private Map<String,Mapper> mappers;
private Connection conn;
public MapperProxy(Map<String,Mapper> mappers,Connection conn){
this.mappers = mappers;
this.conn = conn;
}
/**
* 用于对方法进行增强的，我们的增强其实就是调用selectList方法
* @param proxy
* @param method
* @param args
* @return
* @throws Throwable
*/
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
//1.获取方法名
String methodName = method.getName();
//2.获取方法所在类的名称
String className = method.getDeclaringClass().getName();
//3.组合key
String key = className+"."+methodName;
//4.获取mappers中的Mapper对象
Mapper mapper = mappers.get(key);
//5.判断是否有mapper
if(mapper == null){
throw new IllegalArgumentException("传入的参数有误");
}
//6.调用工具类执行查询所有
return new Executor().selectList(mapper,conn);
}
}
因为要使用代理对象操作数据库，因此必须有一个Connection对象以获取连接，然而之前并没有提到Connection对象，那Connection对象从哪里来呢？可以直接在MapperProxy类中直接创建一个吗？答案是可以的。但是之前提到过，SqlSession需要释放资源，那么这个资源是什么呢？其实就是Connection对象。因此，将Connection对象定义在SqlSession实现类DefaultSqlSession中更加的合理。因此，在DefaultSqlSession声明Connection对象connection并使用工具类获取Connection对象。
关于获取Connection对象的工具类，这里直接提供代码
package com.mybatis.utils;
import com.mybatis.config.Configuration;
import java.sql.Connection;
import java.sql.DriverManager;
/**
*用于创建数据源的工具类
*/
public class DataSourceUtil {
/**
* 用于获取一个连接
* @param cfg
* @return
*/
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);
}
}
}
得到了connection对象之后，想要操作数据库，必须要有sql语句和结果集对应的实体类对象。因此，需要一个Mapper类来封装，那么sql语句和结果集实体类从哪里来呢？答案是xml配置文件，也就是入门案例中的IUserDao.xml文件。至于解析，在解析主配置文件的时候已经一起做了。
package com.mybatis.config;
public class Mapper {
private String queryString;//执行的sql语句
private String resultType;//封装结果的实体类的全限定类名
public String getQueryString() {
return queryString;
}
public void setQueryString(String queryString) {
this.queryString = queryString;
}
public String getResultType() {
return resultType;
}
public void setResultType(String resultType) {
this.resultType = resultType;
}
}
当代理对象获取Connection连接对象和包含sql语句和结果集对应的实体类对象的Mapper集合后，就可以使用invoke()方法将其封装到代理对象中去。
然后这里又出现了一个新的类Executor可以发现，Executor类的静态方法selectList()方法执行了sql查询语句并将结果集返回。
package com.mybatis.utils;
import com.mybatis.config.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;
/**
* @author 黑马程序员
* @Company http://www.ithiema.com
* 负责执行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();
}
}
}
}
至此，代理对象的创建以及其功能的增强都已实现。
5. 使用代理对象mapper执行方法获得结果集users
6. 释放资源
扫一扫
472
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
