目录
1、什么是框架？
2、三层架构
3、持久层技术解决方案
4、mybatis的概述
5、mybatis的入门
mybatis的环境搭建
环境搭建的注意事项
mybatis的入门案例
mybatis基于注解的入门案例
6、自定义 Mybatis框架
分析流程
前期准备
创建 Maven工程
引入相关坐标
引入工具类到项目中
XML配置文件——SqlMapConfig. xml
解析配置文件——XMLConfigBuilder.class
Configuration配置类
读取配置文件类
Mappe类
User实体类
基于XML的自定义 mybatis框架
持久层接口 IUserDao 和 IUserDao. xml
构建者类
SqlsessionFactory接口和实现类
Sqlsession接口和实现类
运行测试类
基于注解方式定义 Mybatis框架
自定义 @Select注解
修改持久层接口
修改 SqlMapConfig. xml
它是我们软件开发中的一套解决方案，不同的框架解决的是不同的问题。
使用框架的好处：框架封装了很多的细节，使开发者可以使用极简的方式实现功能。大大提高开发效率。
表现层：是用于展示数据的
业务层：是处理业务需求
持久层：是和数据库交互的
JDBC技术：
ConnectionPreparedStatementResultSetSpring的JdbcTemplate：Spring中对jdbc的简单封装
Apache的DBUtils：它和Spring的JdbcTemplate很像，也是对Jdbc的简单封装
以上这些都不是框架：
JDBC是规范Spring的JdbcTemplate和Apache的DBUtils都只是工具类mybatis是一个持久层框架，用java编写的。它封装了jdbc操作的很多细节，使开发者只需要关注sql语句本身，而无需关注注册驱动，创建连接等繁杂过程。它使用了ORM思想实现了结果集的封装。
ORM：Object Relational Mappging 对象关系映射。
简单的说：就是把数据库表和实体类及实体类的属性对应起来，让我们可以操作实体类就实现操作数据库表。
userUseriduserIduser_nameuserName今天我们需要做到：实体类中的属性和数据库表的字段名称保持一致。
userUseridIduser_nameuser_name第一步：创建maven工程并导入坐标，导入依赖
<dependencies> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.4.5</version> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.6</version> </dependency> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.12</version> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.10</version> </dependency> </dependencies>第二步：创建实体类和dao的接口
第三步：创建Mybatis的主配置文件
SqlMapConifg.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"> <!-- mybatis的主配置文件 --> <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/eesy_mybatis"/> <property name="username" value="root"/> <property name="password" value="1234"/> </dataSource> </environment> </environments> <!-- 指定映射配置文件的位置，映射配置文件指的是每个dao独立的配置文件 --> <mappers> <mapper resource="com/itheima/dao/IUserDao.xml"/> </mappers> </configuration>第四步：创建映射配置文件
IUserDao.xml
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.itheima.dao.IUserDao"> <!--配置查询所有--> <select id="findAll" resultType="com.itheima.domain.User"> select * from user </select> </mapper>
第一：创建IUserDao.xml 和 IUserDao.java时名称是为了和我们之前的知识保持一致。
在Mybatis中它把持久层的操作接口名称和映射文件也叫做：Mapper，所以：IUserDao 和 IUserMapper是一样的
第二：在idea中创建目录的时候，它和包是不一样的
包在创建时：com.itheima.dao它是三级结构
目录在创建时：com.itheima.dao是一级目录
第三：mybatis的映射配置文件位置必须和dao接口的包结构相同
第四：映射配置文件的mapper标签namespace属性的取值必须是dao接口的全限定类名
第五：映射配置文件的操作配置（select），id属性的取值必须是dao接口的方法名
当我们遵从了第三，四，五点之后，我们在开发中就无须再写dao的实现类。
第三：
创建位置： 必须和持久层接口在相同的包中。
名称： 必须以持久层接口名称命名文件名，扩展名是.xml
另外
不要忘记在映射配置中告知mybatis要封装到哪个实体类中配置的方式：指定实体类的全限定类名
第一步：读取配置文件
第二步：创建SqlSessionFactory工厂
第三步：创建SqlSession
第四步：创建Dao接口的代理对象
第五步：执行dao中的方法
第六步：释放资源
/** * 入门案例 * @param args */ 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(); }
入门案例分析
把IUserDao.xml移除，在dao接口的方法上使用@Select注解，并且指定SQL语句 同时需要在SqlMapConfig.xml中的mapper配置时，使用class属性指定dao接口的全限定类名。
/** * 用户的持久层接口 */ public interface IUserDao { /** * 查询所有操作 * @return */ @Select("select * from user") List<User> findAll(); } <!-- 指定映射配置文件的位置，映射配置文件指的是每个dao独立的配置文件 如果是用注解来配置的话，此处应该使用class属性指定被注解的dao全限定类名 --> <mappers> <mapper class="com.itheima.dao.IUserDao"/> </mappers>构建一个持久层框架，将会涉及到的一些知识点：工厂模式（Factory 工厂模式）、构造者模式（Builder 模式）、代理模式，反射，自定义注解，注解的反射， xml 解析，数据库元数据，元数据的反射等。
创建 mybatis 的工程，工程信息如下：
<groupId>com.itheima</groupId> <artifactId>day01_eesy_04mybatis_design</artifactId> <version>1.0-SNAPSHOT</version> <packaging>jar</packaging>1. 从XML主配置文件中获取连接数据库所需要的信息
<!-- 配置连接数据库的4个基本信息 --> <property name="driver" value="com.mysql.jdbc.Driver"/> <property name="url" value="jdbc:mysql://localhost:3306/eesy_mybatis"/> <property name="username" value="root"/> <property name="password" value="1234"/> //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); } }
2. 从主配置文件中获取映射配置文件（映射配置文件指的是每个dao独立的配置文件）的位置
说明：如果mapper标签 有 resource ，则使用XML配置的方式，否则使用注解方式。
<mappers> <!--<mapper resource="com/itheima/dao/IUserDao.xml"/>--> <mapper class="com.itheima.dao.IUserDao"/> </mappers> //判断mapperElement使用的是哪个属性 Attribute attribute = mapperElement.attribute("resource"); if(attribute != null){} 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/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); } }1）loadMapperConfiguration （XML配置方式）
使用XML方式的话，会进入到 loadMapperConfiguration 方法
传入的参数为 mapperPath 即 映射配置文件的位置 ，从而找到映射配置文件
该方法即构成下图的对象集合 Map<String,Mapper>
/** * 根据传入的参数，解析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(); } }2）loadMapperAnnotation（注解方式）
/** * 根据传入的参数，得到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; }
构建一个SqlSessionFactory工厂，每次返回一个 SqlSessionFactory
/** * 用于创建一个SqlSessionFactory对象 */ public class SqlSessionFactoryBuilder { /** * 根据参数的字节输入流来构建一个SqlSessionFactory工厂 * @param config * @return */ public SqlSessionFactory build(InputStream config){ Configuration cfg = XMLConfigBuilder.loadConfiguration(config); return new DefaultSqlSessionFactory(cfg); } }工厂模式，通过构造函数传入一个 Configuration ，返回 一个 SqlSession （自定义Mybatis中和数据库交互的核心类，即操作数据库的对象）
/** * 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); } }使用代理模式，创建相应DAO接口的代理对象（即相当于自动创建该DAO接口的实现类）
/** * 动态代理： * 涉及的类： Proxy * 使用的方法： newProxyInstance * 方法的参数： * ClassLoader：和被代理对象使用相同的类加载器,通常都是固定的 * Class[]：代理对象和被代理对象要求有相同的行为。（具有相同的方法） * InvocationHandler：如何代理。需要我们自己提供的增强部分的代码 * 用于创建代理对象 * @param daoInterfaceClass dao的接口字节码 * @param <T> * @return T */ @Override public <T> T getMapper(Class<T> daoInterfaceClass) { return (T) Proxy.newProxyInstance(daoInterfaceClass.getClassLoader(), new Class[]{daoInterfaceClass},new MapperProxy(cfg.getMappers(),connection)); }
/** * 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(); } } } } /** * 用于创建数据源的工具类 */ 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); } 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); } } /** * 负责执行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(); } } } }
本篇为本人学习笔记
学习路径：https://www.bilibili.com/video/BV1mE411X7yp?p=16
建议结合视频一起学习，资源来源于网络，如有侵权，请联系删除。
