mybatis进阶之自定义mybatis框架(代码片段)

黑马程序员官方 黑马程序员官方     2022-12-04     167

关键词:

MyBatis进阶之自定义MyBatis框架

1. 自定义MyBatis框架流程分析

2. 自定义框架原理介绍

3. 准备工作:

1) 创建maven工程

Groupid:com.itheima
ArtifactId:custom-mybatis
Packing:jar

2) 添加pom依赖:

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.15</version>
</dependency>
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.12</version>
</dependency>
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
</dependency>
<dependency>
    <groupId>dom4j</groupId>
    <artifactId>dom4j</artifactId>
    <version>1.6.1</version>
</dependency>
<dependency>
    <groupId>jaxen</groupId>
    <artifactId>jaxen</artifactId>
    <version>1.1.6</version>
</dependency>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.12</version>
</dependency>

4. 自定义MyBatis框架的实现步骤

需要定义的类的分析:

  1. 加载类加载目录下的资源文件 Resources.java
  2. 映射文件解析后信息类 Mapper.java
  3. 保存配置文件的配置信息 Configuration.java
  4. 配置文件解析的工具类XMLConfigBuilder.java
  5. SQL语句的执行对象Executor.java
  6. 获取数据源的工具类JdbcUtil.java
  7. SqlSession接口及实现类
  8. SqlSessionFactory接口及实现类
  9. SqlSessionFactory的构建者类SqlSessionFactoryBuilder.java
  10. 动态代理的处理类MapperProxyFactory.java

两大步:

1-4 : 是我们前面提到的 解析xml,封装对象;

5-10: 是得到sqlsession,获取代理对象,执行sql的核心代码;

包结构参考:

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-q35ax5hv-1666607263836)(assets/1597236187962.png)]

1)定义加载资源类Resources.java

/**
 * 加载资源的工具类
 */
public class Resources 

    /**
     * 加载类加载目录下的资源
     * @param path
     * @return
     */
    public static  InputStream getResourceAsStream(String path)
        return Resources.class.getClassLoader().getResourceAsStream(path);
    

2)定义mybatis映射配置信息类 Mapper.java

/**
 * 映射的配置信息类
 */
@Data
public class Mapper 

    private String queryString;// SQL语句

    private String resultType;// 实体类全限定名

    

3)定义mybatis核心配置信息类 Configuration.java

/**
 * mybatis配置的实体类
 * 用来保存mybatis.xml解析过程中的节点属性
 */
@Data
public class Configuration 

    private String driver;      //jdbc驱动类
    private String url;         //jdbc连接字符串
    private String username;    //数据库连接用户名
    private String password;    //数据库连接密码

    private Map<String, Mapper> mappers = new HashMap<String, Mapper>();//映射文件
    
    public void setMappers(Map<String, Mapper> mappers) 
        this.mappers.putAll(mappers);//此处需要使用追加的方式
    
  

4)配置文件解析的工具类XMLConfigBuilder

/**
 *  用于解析配置文件:
 *      sqlmapconfig.xml
 *      xxxMapper.xml
 */
public class XMLConfigBuilder 

    //定义封装连接信息的配置对象(mybatis的配置对象)
    private static Configuration cfg = new Configuration();

    /**
     * 解析主配置文件,把里面的内容填充到DefaultSqlSession所需要的地方
     * 使用的技术:dom4j+xpath
     */
    public static Configuration loadConfiguration(InputStream config)
        try

            //1.获取SAXReader对象
            SAXReader reader = new SAXReader();
            //2.根据字节输入流获取Document对象
            Document document = reader.read(config);
            //3.获取根节点
            Element root = document.getRootElement();

            //4. 解析数据源信息
            loadDataSourceElement(root);

            //5. 加载mapper
            loadMapperElement(root);

            //6. 返回Configuration
            return cfg;

        catch(Exception e)
            throw new RuntimeException(e);
        finally
            try 
                config.close();
            catch(Exception e)
                e.printStackTrace();
            
        

    

    /**
     * 解析数据源信息
     */
    public static void loadDataSourceElement(Element root) 
        //1.使用xpath中选择指定节点的方式,获取所有property节点
        List<Element> propertyElements = root.selectNodes("//property");
        //2.遍历节点
        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);
            
        
    


    /**
     * 加载mapper
     */
    public static void loadMapperElement(Element root) throws Exception 
        //取出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方式mapper----");
                //表示有resource属性,用的是XML
                //取出属性的值
                String mapperPath = attribute.getValue();//获取属性的值"com/itheima/dao/IUserDao.xml"
                //把映射配置文件的内容获取出来,封装成一个map
                Map<String,Mapper> mappers = loadMapperConfiguration(mapperPath);
                //给configuration中的mappers赋值
                cfg.setMappers(mappers);
            
        
    



    /**
     * 根据传入的参数,解析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();
        
    



5)SQL语句的执行对象Executor.java

/**
 * 负责执行SQL语句,并且封装结果集
 */
public class Executor 

    /**
     * 根据mapper查询多条数据
     * @param mapper
     * @param conn
     * @param <E>
     * @return
     */
    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 = extraction(rs, domainClass);
                //把赋好值的对象加入到集合中
                list.add(obj);
            
            return list;
         catch (Exception e) 
            throw new RuntimeException(e);
         finally 
            release(conn, pstm, rs);
        
    

    /**
     * 根据mapper查询数据,查询一条数据,如果结果集中有多条数据,返回第一条数据封装的实体对象
     * @param mapper
     * @param conn
     * @param <E>
     * @return
     */
    public <E> E selectOne(Mapper mapper, Connection conn) 
        PreparedStatement pstm = null;
        ResultSet rs = null;
        try 
            //1.取出mapper中的数据
            String queryString = mapper.getQueryString();//select * from user where id = ?
            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.封装结果集
            if (rs.next()) 
                //将结果集中的数据封装到实体中
                E obj = extraction(rs, domainClass);
                return obj;
            
            return null;
         catch (Exception e) 
            throw new RuntimeException(e);
         finally 
            release(conn, pstm, rs);
        
    

    /**
     * 将结果集中的一条数据封装到实体对象中
     * @param rs
     * @param domainClass
     * @param <E>
     * @return
     * @throws Exception
     */
    private <E> E extraction(ResultSet rs,Class domainClass) throws Exception
        //实例化要封装的实体类对象
        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);
        

        return  obj;
    

    private void release(Connection conn, 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();
            
        

        if (conn != null) 
            try 
                conn.close();
             catch (Exception e) 
                e.printStackTrace();
            
        
    

6)编写获取数据源的工具类JdbcUtil

/**
 * 用于创建数据源的工具类
 */
public class JdbcUtil 

    /**
     * 用于获取一个连接
     * @param cfg
     * @return
     */
    public static Connection getConnection(Configuration cfg)
        try 
            Class.forName(cfg.getDriver());
            return DriverManager.getConnection(cfg.getUrl(), cfg.getUsername()mybatis扩展之自定义类型处理器处理枚举类型

全局配置:<typeHandlers><typeHandlerhandler="com.gong.mybatis.typeHandler.MyEnumEmpStatusTypeHandler"javaType="com.gong.mybatis.bean.EmpStatus"/><!--<typeHandlerhandler="org.apache.ibatis 查看详情

玩转springboot原理篇(自动装配前凑之自定义stater)(代码片段)

的pom文件中可以看出,mybatis-spring-boot-starter包会自动引入mybatis-spring-boot-autoconfigure以及mybatis相关依赖包。SqlSessionFactoryExceptionlogger.debug(encoding=xmlns:xsi=xsi:schemaLocation=<modelVersion><groupI 查看详情

mybatis框架的进阶

文章目录1,标题2,标题3,标题1,标题2,标题3,标题 查看详情

mybatis进阶----mybatisplus增删改查(代码片段)

前言在持久层框架中mybatis应用比较多,而且比重在逐渐的上升。通常项目的组合是SSM。mybatis之所以火,是因为他的灵活,使用方便,优化比较容易。mybatis的直接执行sql语句,sql语句是写在xml文件中,使用... 查看详情

jvm进阶之自定义类加载器(代码片段)

自定义类加载器1.作用2.场景3.注意4.实现1.作用隔离加载类在某些框架内进行中间件与应用的模块隔离,把类加载到不同的环境。修改类加载的方式类的加载模型并非强制的,应该根据实际情况在某个时间点按需进行动态... 查看详情

jvm进阶之自定义类加载器(代码片段)

自定义类加载器1.作用2.场景3.注意4.实现1.作用隔离加载类在某些框架内进行中间件与应用的模块隔离,把类加载到不同的环境。修改类加载的方式类的加载模型并非强制的,应该根据实际情况在某个时间点按需进行动态... 查看详情

《java手写系列》-手写mybatis框架(代码片段)

文章目录1.自定义SqlSessionFactory接口2.自定义SqlSession接口3.自定义DefaultSqlSession实现类4.自定义DefaultSqlSessionFactory5.自定义SqlSessionFactoryBuilder本章接着上一章手写MyBatis,主要这集中在sqlSession对象的获取!1.自定义SqlSessionFact 查看详情

mybatis(代码片段)

...述 1.什么是框架 2.三层架构 3.持久层技术解决方案 4.mybatis概述 5.mybatis的环境搭建 6.mybatis入门案例自定义Mybatis框架Mybatis框架快速入门框架概述 1.什么是框架    它是我们软件开发中的一套解决方案,不同的框架解决... 查看详情

mybatis学习进阶

二、mybatis进阶    高级映射查询缓存和spring整合1、入门阶段复习      mybatis:一个持久层框架低成本,高回报。让程序员把精力放在sql语句上,对sql语句优化非常方便,适用于需求变化较多的... 查看详情

《java手写系列》-手写mybatis框架(代码片段)

...自定义Configuration类4.解析配置文件4.1.解析mapper.xml4.2.解析mybatis-config.xml下面接着第一章内容,手写MyBatis框架!1.自定义Resources类Resources类的作用是获取一个类加载器,根据配置文件的路径&#x 查看详情

自定义mybatis框架(代码片段)

一、流程分析二、使用Maven构建项目这里时使用的dom4j的工具包来解析xml文件。 <dependencies> <!--日志坐标--> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version&g 查看详情

mybatis框架使用指南(进阶)(代码片段)

Mybatis映射文件深入动态sqlif标签if标签:判断语句(单条件分支)。必须结合test属性联合使用。常用场景:在WHERE条件中使用if标签。根据条件判断动态拼接查询条件。在UPDATE更新列中使用if标签。只更新有变化的... 查看详情

如何自定义mybatis框架

MyBatis入门到自定义MyBatis框架第一个MyBatis程序(XML配置)在上一篇中,简单总结了一下原生JDBC的一些局限性,同时引出了MyBatis这个框架,算较为详细的整理如何搭建MyBatis的工作环境这一篇,我们在开篇,现在搭建好工作环境的... 查看详情

mybatis进阶使用——动态sql

MyBatis的强大特性之一就是它的动态SQL。如果你有使用JDBC或者其他类似框架的经验,你一定会体会到根据不同条件拼接SQL语句的痛苦。然而利用动态SQL这一特性可以彻底摆脱这一痛苦MyBatis精简了元素种类,在MyBatis3中,我们只需... 查看详情

mybatis框架(代码片段)

MyBatis是支持普通SQL查询,存储过程和高级映射的优秀==持久层框架==。MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及对结果集的检索封装。MyBatis可以使用简单的XML或注解用于配置和原始映射,将接口... 查看详情

mybatis进阶功能介绍(代码片段)

前言MyBatis本是apache的一个开源项目iBatis,而我们对于mybatis上的使用包括最基本的使用CRUD上的使用,而本篇文章会除了会介绍CRUD的使用、以及集成redis,以及如何开启多级缓存,多数据源,以及Mybatis插件实现原理... 查看详情

了解mybatis框架(代码片段)

MyBatis是一款优秀的持久层框架,它支持自定义SQL、存储过程以及高级映射。MyBatis免除了几乎所有的JDBC代码以及设置参数和获取结果集的工作。MyBatis可以通过简单的XML或注解来配置和映射原始类型、接口和JavaPOJO(PlainOld... 查看详情

android进阶之自定义view(文字圆形边框)(代码片段)

最近写自定义的view写了很多,打算好好完整学习一下,顺便也是记录下,首先来看看效果大概是实现上面的效果吧,其实做起来很简单,只需要继承TextView,然后在外面画上一个框即可,代码如下:public... 查看详情