自定义mybatis的分析
1、执行查询所有分析
1)连接数据库的信息,有了他们就能创建Connection对象
<!--配置连接数据库的4个基本信息-->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"></property>
<property name="url" value="jdbc:mysql://192.168.171.131:3306/mybatis"></property>
<property name="username" value="root"></property>
<property name="password" value="root"></property>
</dataSource>
2)有了他,就有了映射配置信息
<mappers>
<mapper resource="com/itheima/dao/IUserDao.xml"></mapper>
</mappers>
3)有了他,就有了执行的SQL语句,就可以获取PreparedStatement; 此配置中还有封装的实体类全限定类名;
<mapper namespace="com.itheima.dao.IUserDao">
<!--配置查询所有,id是dao方法的名称-->
<select id="findAll" resultType="com.itheima.domain.User">
select * from user;
</select>
</mapper>
1)2)3)读取配置文件,用到的技术是解析XML的技术;
此处用的是dom4j解析xml技术
4)selectList方法
- 根据配置文件的信息创建Connection对象;注册驱动,获取连接;
- 获取预处理对象PreparedStatement,此时需要SQL语句,conn.prepareStatement(sql);
- 执行查询,ResultSet resultSet=preparedStatement.executeQuery();
- 遍历结果集用于封装
- 返回list,return list;
4、遍历结果集用于封装,此处使用反射封装 E element = (E)Class.forName(配置的全限定类名).newInstance();
List<E> list = new ArrayList();
while(resultSet.next()){
E element = (E)Class.forName(配置的全限定类名).newInstance();
// 进行封装,把每个rs内容都添加到element中
// 把element加入到list中
list.add(element);
}
5)要想让selectList方法执行,需要给方法提供2个信息
- 第一个:连接信息
- 第二个:映射信息,包含了2个部分,把这2个信息组合起来定义成一个对象,Mapper对象
- 执行的SQL语句
- 封装结果的实体类全限定类名
- key是String类型,com.itheima.dao.IUserDao.findAll;Mapper对象包含String sql;String domainClassPath
2、创建代理对象的分析
3、自己编写mybatis框架的代码
- 删除pom.xml中的Mybatis的jar包
<!--mybatis-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.5</version>
</dependency>
- 创建测试类com.itheima.test.MybatisTest
com.itheima.test.MybatisTest类
package com.itheima.test;
import com.itheima.dao.IUserDao;
import com.itheima.domain.User;
import com.itheima.mybatis.io.Resources;
import com.itheima.mybatis.sqlsession.SqlSession;
import com.itheima.mybatis.sqlsession.SqlSessionFactory;
import com.itheima.mybatis.sqlsession.SqlSessionFactoryBuilder;
import java.io.InputStream;
import java.util.List;
public class MybatisTest {
public static void main(String[] args) throws Exception {
//1. 读取配置文件
InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
//2. 创建SqlSessionFactory工厂
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = builder.build(in);
//3. 使用工厂生产SqlSession对象
SqlSession session = factory.openSession();
//4. 使用SqlSession对象创建Dao接口的代理对象
IUserDao userDao = session.getMapper(IUserDao.class);
//5. 使用代理对象执行方法
List<User> users = userDao.findAll();
for(User user : users){
System.out.println(user);
}
//6. 释放资源
session.close();
in.close();
}
}
com.itheima.mybatis.io包
class Resources,使用类加载器读取配置文件的类
package com.itheima.mybatis.io;
import java.io.InputStream;
/**
* 使用类加载器读取配置文件的类
*/
public class Resources {
//根据传入的参数获取一个字节输入流
public static InputStream getResourceAsStream(String filePath){
//后面的getResourceAsStream(filePath)是ClassPath类加载器的API 表示返回读取指定资源的输入流
return Resources.class.getClassLoader().getResourceAsStream(filePath);
}
}
com.itheima.mybatis.sqlsession包
class SqlSessionFactoryBuilder,用于创建一个SqlSessionFactory对象
package com.itheima.mybatis.sqlsession;
import com.itheima.mybatis.cfg.Configuration;
import com.itheima.mybatis.sqlsession.defaults.DefaultSqlSessionFactory;
import com.itheima.mybatis.utils.XMLConfigBuilder;
import java.io.InputStream;
//用于创建一个SqlSessionFactory对象
public class SqlSessionFactoryBuilder {
//根据参数的字节输入流来构建一个SqlSessionFactory工厂
public SqlSessionFactory build(InputStream config){
Configuration cfg = XMLConfigBuilder.loadConfiguration(config);
return new DefaultSqlSessionFactory(cfg);
}
}
1、用到工具类:class XMLConfigBuilder,解析配置文件,在com.itheima.mybatis.utils包
1)解析主配置文件,SqlMapConfig.xml,获取数据库的连接信息,<mappers>标签中的映射配置文件信息
2)依据<mapper>标签,判断使用了resource还是class属性,并去解析映射配置文件信息
<mapper resource="com/itheima/dao/IUserDao.xml"/>
<mapper class="com.itheima.dao.IUserDao"/>
3)返回Configuration信息,包含数据库连接信息,Map<String,Mapper> mappers( HashMap集合)
4)其中集合的Key是String类型,由dao的全限定类名和方法名组成;
5)其中集合的value是自定义Mapper对象,存放了执行SQL语句和要封装的实体类全限定类名;
package com.itheima.mybatis.utils;
import com.itheima.mybatis.annotation.Select;
import com.itheima.mybatis.cfg.Configuration;
import com.itheima.mybatis.cfg.Mapper;
import com.itheima.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,取出属性的值
//获取属性的值"com/itheima/dao/IUserDao.xml"
String mapperPath = attribute.getValue();
//把映射配置文件的内容获取出来,封装成一个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 映射配置文件的位置"com/itheima/dao/IUserDao.xml"
* @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属性取值,是组成map中key的部分
String namespace = root.attributeValue("namespace");
//5.获取所有的select节点
List<Element> selectElements = root.selectNodes("//select");
//6.遍历select节点集合,对每一个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();
//创建Map的Key,String类型
String key = namespace+"."+id;
//创建Map的Value,自定义的Mapper类型
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注解标注的方法。传入参数"com.itheima.dao.IUserDao",标注的方法findAll();
* 根据方法名称和类名,以及方法上注解value属性的值,组成Mapper的必要信息 @Select("select * from user")
* @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);
//获取当前方法的返回值List<User>,还要求必须带有泛型信息
Type type = method.getGenericReturnType();
//判断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;
}
}
2、用到自定义的配置类:class Configuration,com.itheima.mybatis.cfg包
封装数据库的连接信息,dao的全限定类名和方法名,执行SQL语句和要封装的实体类全限定类名;
package com.itheima.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>();
public Map<String, Mapper> getMappers() {
return mappers;
}
public void setMappers(Map<String, Mapper> mappers) {
// 不能使用这种方式赋值,后面一个return的mappers(映射配置文件中有多个sql时就有了多一个mapper封装对象)会覆盖前面的一个;
// 相当于主配置文件SqlMapConfig.xml中mapper标签永远只有一个了
// 主配置文件中一个mapper标签对应一个映射文件,而一个映射文件对应一个mappers集合对象,包含多个sql语句
// this.mappers = 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 usename) {
this.username = usename;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
}
3、用到自定义的配置类,class Mapper,com.itheima.mybatis.cfg包,封装执行sql语句和结果类型的全限定类名
package com.itheima.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;
}
}
4、用到自定义注解,@interface Select,com.itheima.mybatis.annotation包
package com.itheima.mybatis.annotation;
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();
}
interface SqlSessionFactory,接口,用于创建一个新的SqlSession对象
package com.itheima.mybatis.sqlsession;
public interface SqlSessionFactory {
//用于创建一个新的SqlSession对象
SqlSession openSession();
}
class DefaultSqlSessionFactory,SqlSessionFactory接口的实现类,在com.itheima.mybatis.sqlsession.defaults包下
package com.itheima.mybatis.sqlsession.defaults;
import com.itheima.mybatis.cfg.Configuration;
import com.itheima.mybatis.sqlsession.SqlSession;
import com.itheima.mybatis.sqlsession.SqlSessionFactory;
//SqlSessionFactory接口的实现类
public class DefaultSqlSessionFactory implements SqlSessionFactory{
Configuration cfg;
public DefaultSqlSessionFactory(Configuration cfg){
this.cfg = cfg;
}
//用于创建一个新的操作数据库对象
public SqlSession openSession() {
return new DefaultSqlSession(cfg);
}
}
interface SqlSession,接口,创建dao接口的代理对象
package com.itheima.mybatis.sqlsession;
//自定义mybatis中和数据库交互的核心类
//它里面可以创建dao接口的代理对象
public interface SqlSession {
//根据参数创建一个代理对象,传的参数为dao的接口字节码
//泛型需要先声明再使用,<T>表自定义泛型类型,<E>表不确定泛型类型
<T> T getMapper(Class<T> daoInterfaceClass);
//释放资源
void close();
}
class DefaultSqlSession,SqlSession接口的实现类,创建代理对象;
//3. 使用工厂生产SqlSession对象
SqlSession session = factory.openSession();
//4. 使用SqlSession对象创建Dao接口的代理对象
IUserDao userDao = session.getMapper(IUserDao.class);
package com.itheima.mybatis.sqlsession.defaults;
import com.itheima.mybatis.cfg.Configuration;
import com.itheima.mybatis.sqlsession.SqlSession;
import com.itheima.mybatis.sqlsession.proxy.MapperProxy;
import com.itheima.mybatis.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 conn;
public DefaultSqlSession(Configuration cfg){
this.cfg = cfg;
conn = DataSourceUtil.getConnection(cfg);
}
//用户创建代理对象
public <T> T getMapper(Class<T> daoInterfaceClass) {
return (T)Proxy.newProxyInstance(daoInterfaceClass.getClassLoader(),
new Class[]{daoInterfaceClass},new MapperProxy(cfg.getMappers(),conn));
}
//用于释放资源
public void close() {
if(conn != null) {
try {
conn.close();
} catch (SQLException e) {
e.printStackTrace();
}
}
}
}
用到自定义的工具类,class DataSourceUtil,用于创建数据源的工具类,在com.itheima.mybatis.utils包下
package com.itheima.mybatis.utils;
import com.itheima.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);
}
}
}
用到动态代理,class MapperProxy implements InvocationHandler,在com.itheima.mybatis.sqlsession.proxy包下
用于对方法进行增强,增强其实就是调用selectList方法
package com.itheima.mybatis.sqlsession.proxy;
import com.itheima.mybatis.cfg.Mapper;
import com.itheima.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{
//map的key是全限定类名+方法名
Map<String,Mapper> mappers;
private Connection conn;
public MapperProxy(Map<String,Mapper> mappers , Connection conn){
this.mappers = mappers;
this.conn = conn;
}
//用于对方法进行增强,我们的增强其实就是调用selectList方法
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
//1. 获取方法名
String methodName = method.getName();
//2. 获取方法所在类的名称,因为没有实现类,所以拿到的实际上是那个namespace
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);
}
}
用到工具类,class Executor,在com.itheima.mybatis.utils包下
负责执行SQL语句,依据resultType指定的类型,封装返回的结果集(实体类对象)到List集合
动态代理将sql语句的执行结果,封装到Dao接口的代理对象中,IUserDao userDao,使用代理对象执行方法
//4. 使用SqlSession对象创建Dao接口的代理对象
IUserDao userDao = session.getMapper(IUserDao.class);
//5. 使用代理对象执行方法
List<User> users = userDao.findAll();
package com.itheima.mybatis.utils;
import com.itheima.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中的数据,select * from user
String queryString = mapper.getQueryString();
//com.itheima.domain.User
String 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();
//取出结果集的元信息: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();
}
}
}
}
源码:day01_eesy_04mybatis_design