我们环境搭建(环境搭建传送门)好之后,今天我们来看一下MyBatis的入门案例,熟悉之后,我们就来自定义一下MyBatis框架
目录
- MyBatis的入门案例
- 自定义MyBatis框架
- 在入门案例的基础上进行修改,首先修改` pom.xml `的依赖如下:
- 编写读取配置文件类 Resources
- 编写构建者类 SqlSessionFactoryBuilder
- 编写 SqlSessionFactory 接口
- 编写 SqlSession 接口
- 导入提前准备的工具类 XMLConfigBuilder,用于解析 XML 文件
- 编写自定义注解 Select
- 编写自定义 Mybatis 的配置类 Configuration
- 编写 Mapper 类
- 完善 SqlSessionFactoryBuilder 类
- 编写 DefaultSqlSessionFactory 类
- 编写 DefaultSqlSession 类
- 编写数据库工具类 DataSourceUtil
- 编写代理类 MapperProxy
- 导入提前准备好的工具类 Executor ,用于执行jdbc相关操作
- 总结:
MyBatis的入门案例
编写测试类
package com.test;
import com.Dao.UserDao;
import com.Doamin.User;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.InputStream;
import java.util.List;
/**
* @author zhang
*/
public class MyBatisTest {
//入门案例
public static void main(String[] args)throws Exception {
//读取配置文件
InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
//创建SqlSessionFactory工厂
//我们直接调用接口就好,具体实现的细节MyBatis已经帮我们实现了
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = builder.build(in);
//使用工厂生产SqlSession对象
SqlSession session = factory.openSession();
//使用SqlSession创建Dao接口的代理对象
UserDao userDao = session.getMapper(UserDao.class);
//使用代理对象执行方法
List<User> users = userDao.findAll();
for (User user : users){
System.out.println(user);
}
//释放资源
session.close();
in.close();
}
}
对于上面代码的具体分析如下图:
什么是“创建者模式”呢?
比如我们要开一个工厂,首先我们要选址吧,然后还要买器材等乱七八糟的东西,费时又费力。这时我们找一个包工团队,只要给钱,就能办好。代码里面的SqlSessionFactoryBuilder就是这样的团队。里面所有繁琐的事都不用管了。
为什么要使用工厂模式创建Session对象呢?直接用new不行吗?
比如我们刚开始new了1这个对象,我们都是web项目,要部署到服务器上的,要是以后我想new一个2对象咋办呢?只能直接改源码,然后重新部署到服务器上,这显然不是一个好办法。所以我们把这个new关键字给屏蔽了,而是使用工厂为我们去生产一个Session对象,很好的为我们解决了类之间的依赖关系 .
现在我们直接运行的话是不行的,因为这个框架并不知道你查询完了之后要封装到哪里去。框架在设计之初肯定是所有的表所有的实体类都能封装。
我们在UserDao.xml文件下除了SQL语句之外,还应该提供另外一个配置,这个配置就是resultType
返回类型。就是说我们查询完之后要封装到哪里去呢?就在com.Domain.User
当中
<select id="findAll" resultType="com.Doamin.User">
select * from user
</select>
最后就可以成功运行了:
注意,Mybatis 是支持注解配置的,如果想使用注解进行开发,那么首先修改 Dao接口:
public interface UserDao {
/**
* 查询所有用户
* @return
*/
@Select("select * from user")
List<User> findAll();
}
然后修改修改 SqlMapConfig.xml:
<!-- 告知 mybatis 映射配置的位置 -->
<!-- 如果是用注解来配置的话,此处应该使用class属性指定被注解的Dao全限定类名,而不是之前的resource -->
<mappers>
<mapper class="com.Dao.UserDao"/>
</mappers>
注意事项:
在使用基于注解的 Mybatis 配置时,请
移除 xml 的映射配置(UserDao.xml)
。
总结
MyBatis的入门案例可分为以下几个步骤:
- 读取配置文件
- 创建SqlSessionFactory工厂
- 创建SqlSession
- 创建Dao接口的代理对象
- 执行Dao中的方法
- 释放资源
注意:
- 不用忘记在映射配置中告知MyBatis要封装到哪个实体类中
- 配置方式:指定实体类的全限定类名
MyBatis基于注解的的案例:
把UserDao.xml移除
,在Dao接口的方法上@Select注解
,并且指定SQL语句- 同时需要在SqlMapConfig.xml中的mapper配置时,使用
class属性
指定Dao接口的全限定类名。
我们在开发的时候,肯定是越简单越好,所以都是采用不写dao实现类的方式,不管你使用XML还是注解配置。虽然MyBatis支持写dao实现类,但是感觉是多此一举了。
最后的结构图如下:
自定义MyBatis框架
思路分析 :
- MyBatis在使用代理dao的方式实现增删改查时做了什么事呢?
1、创建代理对象
2、在代理对象中调用 selectList
分析如下图:
对于Java动态代理InvocationHandler和Proxy,大家可以看看这两篇文章:
Java动态代理InvocationHandler和Proxy学习笔记
Java中InvocationHandler接口中第一个参数proxy详解
在入门案例的基础上进行修改,首先修改pom.xml
的依赖如下:
<!-- 导入依赖 -->
<dependencies>
<!-- 数据库驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.20</version>
<scope>runtime</scope>
</dependency>
<!-- 日志 -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<!-- JUnit -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency>
<!-- 使用POM依赖 -->
<dependency>
<groupId>com.googlecode.protobuf-java-format</groupId>
<artifactId>protobuf-java-format</artifactId>
<version>1.4</version>
</dependency>
<!-- 解析 xml 的 dom4j -->
<dependency>
<groupId>dom4j</groupId>
<artifactId>dom4j</artifactId>
<version>1.6.1</version>
</dependency>
<!-- dom4j 的依赖包 jaxen -->
<dependency>
<groupId>jaxen</groupId>
<artifactId>jaxen</artifactId>
<version>1.1.6</version>
</dependency>
</dependencies>
移除 Mybatis 依赖后,根据入门案例依次编写所需类或接口:
编写读取配置文件类 Resources
package com.mybatis.io;
import java.io.InputStream;
/**
* @author zhang
* 使用类加载器读取配置文件的类
*/
public class Resources {
/**
* 根据传入的参数,获取一个字节输入流
* @param filePath
* @return
*/
public static InputStream getResourceAsStream(String filePath) {
return Resources.class.getClassLoader().getResourceAsStream(filePath);
}
}
编写构建者类 SqlSessionFactoryBuilder
package com.mybatis.sqlsession;
import java.io.InputStream;
/**
* @author zhang
* 用于创建一个SqlSessionFactory对象
*/
public class SqlSessionFactoryBuilder {
/**
* 通过字节输入流构建一个SqlSessionFactory工厂
* @param config
* @return
*/
public SqlSessionFactory build(InputStream config){
// 先返回null防止报错,后面进行修改
return null;
}
}
编写 SqlSessionFactory 接口
package com.mybatis.sqlsession;
/**
* @author zhang
*/
public interface SqlSessionFactory {
/**
* 用于打开一个新的SqlSession对象
* @return
*/
SqlSession openSession();
}
编写 SqlSession 接口
注意,泛型必须先声明 () 后使用 (T)
package com.mybatis.sqlsession;
/**
* @author zhang
* 自定义Mybatis中和数据库交互的核心类,可以创建dao接口的代理对象
*/
public interface SqlSession {
/**
* 根据参数创建一个代理对象
* @param daoInterfaceClass dao的接口字节码
* @param <T>
* @return
*/
<T> T getMapper(Class<T> daoInterfaceClass);
//释放资源
void close();
}
导入提前准备的工具类 XMLConfigBuilder,用于解析 XML 文件
package com.mybatis.utils;
import com.mybatis.annotations.Select;
import com.mybatis.io.Resources;
import com.mybatis.cfg.Configuration;
import com.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();//获取属性的值"com/itheima/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;
}
}
编写自定义注解 Select
package com.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语句
*
* @return
*/
String value();
}
编写自定义 Mybatis 的配置类 Configuration
package com.mybatis.cfg;
import java.util.Map;
/**
* @author zhang
* 自定义MyBatis的配置类
*/
public class Configuration {
private String driver;
private String url;
private String username;
private String password;
// 必须new一个集合出来,不然下面调用putAll会空指针异常
private Map<String, Mapper> mappers = new HashMap<String, Mapper>();
public Map<String, Mapper> getMappers() {
return mappers;
}
public void setMappers(Map<String, Mapper> mappers) {
// 这里应该使用put的方式,直接赋值的话会覆盖原本Map集合中的内容
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;
}
}
编写 Mapper 类
package com.mybatis.cfg;
/**
* @author zhang
* 用于封装执行的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;
}
}
完善 SqlSessionFactoryBuilder 类
package com.mybatis.sqlsession;
import com.mybatis.cfg.Configuration;
import com.mybatis.sqlsession.defaults.DefaultSqlSessionFactory;
import com.mybatis.utils.XMLConfigBuilder;
import jdk.nashorn.internal.runtime.regexp.joni.Config;
import java.io.InputStream;
/**
* @author zhang
* 用于创建一个SqlSessionFactory对象
*/
public class SqlSessionFactoryBuilder {
/**
* 通过字节输入流构建一个SqlSessionFactory工厂
* @param config
* @return
*/
public SqlSessionFactory build(InputStream config){
Configuration cfg = XMLConfigBuilder.loadConfiguration(config);
return new DefaultSqlSessionFactory(cfg);
}
}
编写 DefaultSqlSessionFactory 类
package com.mybatis.sqlsession.defaults;
import com.mybatis.cfg.Configuration;
import com.mybatis.sqlsession.SqlSession;
import com.mybatis.sqlsession.SqlSessionFactory;
import jdk.nashorn.internal.runtime.regexp.joni.Config;
/**
* @author zhang
* SqlSessionFactory接口的实现类
*/
public class DefaultSqlSessionFactory implements SqlSessionFactory {
private Configuration cfg;
public DefaultSqlSessionFactory(Configuration cfg){
this.cfg = cfg;
}
/**
* 用于创建一个新的操作数据库对象
* @return
*/
@Override
public SqlSession openSession() {
return new DefaultSqlSession(cfg);
}
}
编写 DefaultSqlSession 类
package com.mybatis.sqlsession.defaults;
import com.mybatis.cfg.Configuration;
import com.mybatis.sqlsession.SqlSession;
import com.mybatis.sqlsession.proxy.MapperProxy;
import com.mybatis.utils.DataSourceUtil;
import java.lang.reflect.Proxy;
import java.sql.Connection;
/**
* @author
* DefaultSqlSession接口的实现类
*/
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) {
Proxy.newProxyInstance(daoInterfaceClass.getClassLoader(),
new Class[]{daoInterfaceClass},new MapperProxy(cfg.getMappers(),connection));
return null;
}
//用于释放资源
@Override
public void close() {
if (connection != null){
try {
connection.close();
}catch (SQLException e){
e.printStackTrace();
}
}
}
}
编写数据库工具类 DataSourceUtil
package com.mybatis.utils;
import com.mybatis.cfg.Configuration;
import java.sql.Connection;
import java.sql.DriverManager;
/**
* @author zhang
* 用于创建数据源的工具类
*/
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);
}
}
}
编写代理类 MapperProxy
package com.mybatis.sqlsession.proxy;
import com.mybatis.cfg.Mapper;
import com.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是权限的类名+方法名
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.组合kry、
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);
}
}
导入提前准备好的工具类 Executor ,用于执行jdbc相关操作
package com.mybatis.utils;
import com.mybatis.cfg.Mapper;
import com.mybatis.sqlsession.proxy.MapperProxy;
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;
/**
* @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.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();
}
}
}
}
至此,自定义 Mybatis 环境搭建完成,最终的项目结构如图:
运行结果和之前的测试案例一样:
总结:
最后提一下,要是运行的时候报空指针错误,大家可以看看这篇文章,都是粗心的犯的错。空指针报错