文章目录
前言
上篇浅析mybatis执行原理,仿照mybatis做一个自定义的orm映射框架。理了思路,先写下要实现哪些功能,这个文档会持续更新,对应的代码也会持续更新下去。
- 支持
xml
和注解的方式将我们的mapper
定义sql
获取,即以下两种配置
<!--使用xml写sql-->
<!--<mapper resource="mybatis/DeptEmpMapper.xml"></mapper>-->
<!--注解sql-->
<mapper class="fast.cloud.nacos.mybatis.mapper.DeptEmpMapper"></mapper>
- 给
xxxMapper.java
文件添加jdk动态代理
,这样是为了统一实现使用jdbc去查询,而不用每个都去写实现。 - 实现数据库字段和实体属性,这个用注解实现。
- 尽量遵循
mybatis
框架的设计风格。
实现
pom
依赖
<!-- 日志坐标 -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.12</version>
</dependency>
<!-- 解析xml的dom4j -->
<dependency>
<groupId>dom4j</groupId>
<artifactId>dom4j</artifactId>
<version>1.6.1</version>
</dependency>
<!-- mysql驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.6</version>
</dependency>
<!-- dom4j的依赖包jaxen -->
<dependency>
<groupId>jaxen</groupId>
<artifactId>jaxen</artifactId>
<version>1.1.6</version>
</dependency>
定义全局配置Configuration
在看mybatis
源码的时候,它会把所有的xml
配置文件映射成一个Configuration
对象。所以这里也建一个,代码如下:
import fast.cloud.nacos.custom.mybatis.mapper.Mapper;
import java.util.Map;
/**
* 核心配置类
* 1.数据库信息
* 2.sql 的 map 集合
*/
public class Configuration {
private String username; //用户名
private String password;//密码
private String url;//地址
private String driver;//驱动
//map 集合 Map<唯一标识,Mapper> 用于保存映射文件中的 sql 标识及 sql 语句
private Map<String, Mapper> mappers;
//key为column,value为properties
private Map<String,String> typeAliasesMap;
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 String getUrl() {
return url;
}
public void setUrl(String url) {
this.url = url;
}
public String getDriver() {
return driver;
}
public void setDriver(String driver) {
this.driver = driver;
}
public Map<String, Mapper> getMappers() {
return mappers;
}
public void setMappers(Map<String, Mapper> mappers) {
this.mappers = mappers;
}
public Map<String, String> getTypeAliasesMap() {
return typeAliasesMap;
}
public void setTypeAliasesMap(Map<String, String> typeAliasesMap) {
this.typeAliasesMap = typeAliasesMap;
}
}
xml
解析类XMLConfigBuilder
将配置的xml解析成Configuration
,还要注意的是两种方式,第一种loadMapperConfiguration
,读取我们自己的xxxMapper.xml
里面的sql
,还有一种方式是读取xxxMapper.java
文件,这种方式我们可以读取注解里面的sql
。殊途同归,两种方式都要符合一个规范。
- 把
类的全限定名
+.
+方法名
作为唯一的key
(mybatis为了更加唯一,前面还加上了uuid,这里不做那么复杂) - 把读到
sql
,以及返回类型封装起来最为value
,这里这个对象叫做Mapper.java
代码如下:
/**
* 用于解析配置文件
*/
public class XMLConfigBuilder {
/**
* 解析主配置文件,把里面的内容填充到 DefaultSqlSession 所需要的地方
* 使用的技术:
* dom4j+xpath
*
* @param session
*/
public static void loadConfiguration(DefaultSqlSession session, 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 中package标签package标签
List<Element> packageElements = root.selectNodes("//mappers/package");
if (!CollectionUtils.isEmpty(packageElements)) {
Element element = packageElements.get(0);
String packageName = element.attribute("name").getValue();
Set<Class<?>> mapperSet = ClassUtil.getClasses(packageName);
mapperSet.forEach(clz -> {
String className = clz.getName();
Method method = clz.getMethods()[0];
String methodName = method.getName();
String returnType = method.getReturnType().getName();
String key = className + "." + methodName;
// 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);
});
} else {
//取出 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/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);
}
}
}
List<Element> typeAliasesElements = root.selectNodes("//typeAliases/package");
//2. 解析实体类中的注解拿到映射数据
if (!CollectionUtils.isEmpty(typeAliasesElements)) {
String packageName = typeAliasesElements.get(0).attribute("name").getValue();
Set<Class<?>> entitySet = ClassUtil.getClasses(packageName);
Map<String, String> colProMap = new HashMap<>();
entitySet.forEach(clz -> {
Field[] fields = clz.getDeclaredFields();
Stream.of(fields).forEach(field -> {
String proName = field.getName();
ORMColumn annotation = field.getAnnotation(ORMColumn.class);
if (annotation != null) {
String colName = annotation.name();
colProMap.put(colName, proName);
}
});
});
cfg.setTypeAliasesMap(colProMap);
}
//把配置对象传递给 DefaultSqlSession
session.setCfg(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;
}
}
数据库打交道的SqlSession
系列
抽象工厂SqlSessionFactory
/**
* SqlSessionFactory 的接口
*/
public interface SqlSessionFactory {
/**
* 创建一个新的 SqlSession 对象
*/
SqlSession openSession();
}
默认实现工厂DefaultSqlSessionFactory
/**
* SqlSessionFactory 的默认实现
*/
public class DefaultSqlSessionFactory implements SqlSessionFactory {
private InputStream config = null;
public void setConfig(InputStream config) {
this.config = config;
}
@Override
public SqlSession openSession() {
DefaultSqlSession session = new DefaultSqlSession();
//调用工具类解析 xml 文件
XMLConfigBuilder.loadConfiguration(session, config);
return session;
}
}
默认实现DefaultSqlSession
public class DefaultSqlSession implements SqlSession {
//核心配置对象
private Configuration cfg;
public void setCfg(Configuration cfg) {
this.cfg = cfg;
}
//连接对象
private Connection conn;
//调用 DataSourceUtils 工具类获取连接
public Connection getConn() {
try {
conn = DataSourceUtil.getConnection(cfg);
return conn;
} catch (Exception e) {
throw new RuntimeException(e);
}
}
/**
* 动态代理:
* 涉及的类:Proxy
* 使用的方法:newProxyInstance
* 方法的参数:
* ClassLoader:和被代理对象使用相同的类加载器,通常都是固定的
* Class[]:代理对象和被代理对象要求有相同的行为。(具有相同的方法)
* InvocationHandler:如何代理。需要我们自己提供的增强部分的代码
*/
@Override
public <T> T getMapper(Class<T> daoClass) {
conn = getConn();
System.out.println(conn);
T daoProxy = (T) Proxy.newProxyInstance(daoClass.getClassLoader(), new
Class[]{daoClass}, new MapperProxyFactory(cfg.getMappers(), conn, cfg.getTypeAliasesMap()));
return daoProxy;
}
//释放资源
@Override
public void close() {
try {
System.out.println(conn);
conn.close();
} catch (SQLException e) {
e.printStackTrace();
}
}
//查询所有方法
public <E> List<E> selectList(String statement) {
Mapper mapper = cfg.getMappers().get(statement);
Map<String, String> typeAliasesMap = cfg.getTypeAliasesMap();
return new Executor().selectList(mapper, typeAliasesMap, conn);
}
}
建造者模式SqlSessionFactoryBuilder
public class SqlSessionFactoryBuilder {
/**
* 根据传入的流,实现对 SqlSessionFactory 的创建
*
* @param in 它就是 SqlMapConfig.xml 的配置以及里面包含的 IUserDao.xml 的配置
* @return
*/
public SqlSessionFactory build(InputStream in) {
DefaultSqlSessionFactory factory = new DefaultSqlSessionFactory();
//给 factory 中 config 赋值
factory.setConfig(in);
return factory;
}
}
动态代理MapperProxyFactory
这个是重头戏,取出当前执行的方法名称以及取出当前执行的方法所在类,找到对应的mapper
统一执行sql,封装结果,返回。
public class MapperProxyFactory implements InvocationHandler {
private Map<String, Mapper> mappers;
private Connection conn;
private Map<String, String> typeAliasesMap;
public MapperProxyFactory(Map<String, Mapper> mappers, Connection conn, Map<String, String> typeAliasesMap) {
this.mappers = mappers;
this.conn = conn;
this.typeAliasesMap = typeAliasesMap;
}
/**
* 对当前正在执行的方法进行增强
* 取出当前执行的方法名称
* 取出当前执行的方法所在类
* 拼接成 key
* 去 Map 中获取 Value(Mapper)
* 使用工具类 Executor 的 selectList 方法x
*/
@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.使用 key 取出 mapper
Mapper mapper = mappers.get(key);
if (mapper == null) {
throw new IllegalArgumentException("传入的参数有误,无法获取执行的必要条件 ");
}
//5.创建 Executor 对象
Executor executor = new Executor();
return executor.selectList(mapper, typeAliasesMap, conn);
}
}
执行器Executor
对jdbc
的封装,这里有个typeAliasesMap
,做下字段和属性的映射关系。
/**
* 负责执行 SQL 语句,并且封装结果集
*/
public class Executor {
public <E> List<E> selectList(Mapper mapper, Map<String, String> typeAliasesMap, Connection conn) {
PreparedStatement pstm = null;
ResultSet rs = null;
try {
//1.取出 mapper 中的数据
String queryString = mapper.getQueryString();//select * from user
String resultType = mapper.getResultType();//com.domain.User
Class domainClass = Class.forName(resultType);//User.class
//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();//User 对象
//取出结果集的元信息: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);
String proName = typeAliasesMap.getOrDefault(columnName, columnName);
//给 obj 赋值:使用 Java 内省机制(借助 PropertyDescriptor 实现属性的封装)
PropertyDescriptor pd = new
PropertyDescriptor(proName, domainClass);//要求:实体类的属性和数据库表的列名保持一种
//获取它的写入方法
Method writeMethod = pd.getWriteMethod();//setUsername(String username);
//把获取的列的值,给对象赋值
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();
}
}
}
}
测试
测试前准备,需要把jar
依赖过来,以及配置xml
,还有就是定义实体,mapper
,这里还继续延续上节的代码,测试。
测试xml方式
- xml配置
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<typeAliases> <!--配置实体类的别名-->
<package name="fast.cloud.nacos.mybatis.entity"/>
</typeAliases>
<environments default="MySQLDevelopment">
<environment id="MySQLDevelopment">
<transactionManager type="JDBC"></transactionManager> <!--事务-->
<dataSource type="POOLED"> <!--数据库连接-->
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/demo?characterEncoding=utf-8"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
<mappers>
<!--使用xml写sql-->
<mapper resource="mybatis/DeptEmpMapper.xml"></mapper>
</mappers>
</configuration>
- 测试方法
@Test
public void testMybatis() throws IOException {
//1. 加载核心配置文件
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
//2. 解析核心配置文件并创建SqlSessionFactory对象
SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(inputStream);
//3. 创建核心对象
SqlSession sqlSession = sqlSessionFactory.openSession();
//4. 得到Mapper代理对象
DeptEmpMapper deptEmpMapper = sqlSession.getMapper(DeptEmpMapper.class);
//5. 调用自定义的方法实现查询功能
List<DeptEmp> list = deptEmpMapper.getEmpTotalByDept();
for (DeptEmp de : list) {
System.out.println(de);
}
//6. 关闭sqlSession
sqlSession.close();
}
运行结果
测试注解方式
- 添加注解的sql
//Mapper接口 不用编写实现类
public interface DeptEmpMapper {
@Select("SELECT deptno, COUNT(*) AS total FROM emp GROUP BY deptno")
List<DeptEmp> getEmpTotalByDept();
}
- xml配置
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<typeAliases> <!--配置实体类的别名-->
<package name="fast.cloud.nacos.mybatis.entity"/>
</typeAliases>
<environments default="MySQLDevelopment">
<environment id="MySQLDevelopment">
<transactionManager type="JDBC"></transactionManager> <!--事务-->
<dataSource type="POOLED"> <!--数据库连接-->
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/demo?characterEncoding=utf-8"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
<mappers>
<!--使用xml写sql-->
<!--<mapper resource="mybatis/DeptEmpMapper.xml"></mapper>-->
<!--注解sql-->
<mapper class="fast.cloud.nacos.mybatis.mapper.DeptEmpMapper"></mapper>
<!--<package name="fast.cloud.nacos.mybatis.mapper"/>-->
</mappers>
</configuration>
- 测试方法不变,运行结果如下: