手写简单的Mybatis
Mybatis 原理分析：
//1、读取配置文件
InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
//2、创建SqlSessionFactory工厂
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = builder.build(in);
//3、使用工厂生产SqlSession对象
SqlSession sqlSession = factory.openSession();
//4、使用SqlSession创建Dao接口的代理对象
IUserDao userDao = sqlSession.getMapper(IUserDao.class);
//5、使用代理对象执行方法
List<User> users = userDao.findAll();
for (User user : users) {
System.out.println(user);
}
//6、释放资源
sqlSession.close();
in.close();
从Mybatis的使用上来看，可以看出Mybatis的运行逻辑是：
1.解析xml配置文件（包括主配置文件和映射文件）
2.根据xml配置文件创建SqlSessionFactory
3.由SqlSessionFactory 创建 sqlSession对象用来执行mapper接口中定义的方法，并封装到实体类
查看源码分析类型：
class Resources Resources为类 可用来加载字节流
class SqlSessionFactoryBuilder SqlSessionFactoryBuilder也是类，用来构建SqlSessionFactory
interface SqlSessionFactory SqlSessionFactory是接口，内含有新建执行sql的对象，但需要实现类才能使用
interface SqlSession SqlSession也是接口，是又SqlSessionFactory 实现类的方法传创建出来的，同样需要实现类才能使用
所以我们自己传创建Mybatis 可根据其类型功能创建：
1.新建Resources类，含有getResourceAsStream静态方法，可返回字节输入流
package cn.blogsx.mybatis.io;
import java.io.InputStream;
/*
使用类加载器读取配置文件的类
*/
public class Resources {
/**
* 根据传入的参数 获取一个字节输入流
* @param filePath
* @return
*/
public static InputStream getResourceAsStream(String filePath) {
return Resources.class.getClassLoader().getResourceAsStream(filePath);
}
}
2.创建SqlSessionFactoryBuilder 类，含有build成员方法，可根据输入流返回SqlSessionFactory 对象
package cn.blogsx.mybatis.sqlsession;
import cn.blogsx.mybatis.cfg.Configuration;
import cn.blogsx.mybatis.sqlsession.defaults.DefaultSqlSessionFactory;
import cn.blogsx.utils.XMLConfigBuilder;
import java.io.InputStream;
/*
用于创建sqlSessionFactory对象
*/
public class SqlSessionFactoryBuilder {
/**
* 更据配置文件字节输入流创建sqlSessionFactory工厂
* @param in
* @return
*/
public SqlSessionFactory build(InputStream in) {
Configuration cfg = XMLConfigBuilder.loadConfiguration(in);
return new DefaultSqlSessionFactory(cfg);
}
}
3.新建SqlSessionFactory接口的实现类和SqlSession接口的实现类，分别用来创建各自的对象
package cn.blogsx.mybatis.sqlsession.defaults;
import cn.blogsx.mybatis.cfg.Configuration;
import cn.blogsx.mybatis.sqlsession.SqlSession;
import cn.blogsx.mybatis.sqlsession.proxy.MapperProxy;
import cn.blogsx.utils.DataSourceUtil;
import java.lang.reflect.Proxy;
import java.sql.Connection;
import java.sql.SQLException;
/**
* SqlSession接口的实现类
*/
public class DefaultSqlSession implements SqlSession {
private Configuration cfg;
private Connection connecion;
public DefaultSqlSession(Configuration cfg) {
this.cfg = cfg;
this.connecion = 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(), connecion));
}
/**
* 用于释放资源
*/
public void close() {
if (connecion != null) {
try {
connecion.close();
} catch (SQLException e) {
e.printStackTrace();
}
}
}
}
package cn.blogsx.mybatis.sqlsession.defaults;
import cn.blogsx.mybatis.cfg.Configuration;
import cn.blogsx.mybatis.sqlsession.SqlSession;
import cn.blogsx.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);
}
}
4.自定义配置类
package cn.blogsx.mybatis.cfg;
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>(); //此处必须使用new 初始化，否则会抛空指针异常
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;
}
}
package cn.blogsx.mybatis.cfg;
/**
* 用于封装执行的sql和全限定类名
*/
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;
}
}
5.定义用于实现mapper接口的动态代理类
package cn.blogsx.mybatis.sqlsession.proxy;
import cn.blogsx.mybatis.cfg.Mapper;
import cn.blogsx.utils.Executor;
import com.sun.org.apache.bcel.internal.generic.ACONST_NULL;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.sql.Connection;
import java.util.Map;
public class MapperProxy implements InvocationHandler {
private Map<String,Mapper> mappers;
private Connection conn;
//map的key是全限定类名+方法名
public MapperProxy(Map<String,Mapper> mappers,Connection conn) {
this.mappers=mappers;
this.conn=conn;
}
/**
* 用于对方法增强，我们的增强其实就是调用selectList方法
* @param proxy
* @param method
* @param args
* @return
* @throws Throwable
*/
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);
}
}
6.定义底层的xml解析器，sql执行器，以及创建数据原的类
xml解析器
package cn.blogsx.utils;
import cn.blogsx.mybatis.annocations.Select;
import cn.blogsx.mybatis.cfg.Mapper;
import cn.blogsx.mybatis.cfg.Configuration;
import cn.blogsx.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;
/**
* @author
* @Company http://www.ithiema.com
* 用于解析配置文件
*/
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();//获取映射文件位置："cn/blogsx/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; // cn.blogsx.dao.IUserDao.findAll
//创建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;
}
}
sql执行器
package cn.blogsx.utils;
import cn.blogsx.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();
}
}
}
}
数据源获取类
package cn.blogsx.utils;
import cn.blogsx.mybatis.cfg.Configuration;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;
/**
* 用于创建数据源的类
*/
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);
}
}
}