MyBatis解析全局配置文件

MyBatis解析全局配置文件

MyBaits基础应用：

文档：MyBatis

链接：http://note.youdao.com/noteshare?id=5d41fd41d970f1af9185ea2ec0647b64

传统JDBC和Mybatis相比的弊病

传统JDBC

​

Connection conn = null;
PreparedStatement pstmt = null;
try {         
    // 1.加载驱动         
    Class.forName("com.mysql.jdbc.Driver");          
    // 2.创建连接         
    conn = DriverManager.getConnection("jdbc:mysql://localhost:3306/mybatis_example", "root", "123456");           
    // SQL语句         
    String sql = "select id,user_name,create_time from t_user where id=?";          
    // 获得sql执行者         
    pstmt = conn.prepareStatement(sql);
    pstmt.setInt(1, 1);          
    // 执行查询         
    //ResultSet rs= pstmt.executeQuery();         
    pstmt.execute();
    ResultSet rs = pstmt.getResultSet();
    rs.next();
    User user = new User();
    user.setId(rs.getLong("id"));
    user.setUserName(rs.getString("user_name"));
    user.setCreateTime(rs.getDate("create_time"));
    System.out.println(user.toString());
}

传统JDBC的问题如下：

1.数据库连接创建，释放频繁造成西戎资源的浪费，从而影响系统性能，使用数据库连接池可以解决问题。

2.sql语句在代码中硬编码，造成代码的不已维护，实际应用中sql的变化可能较大，sql代码和java代码没有分离开来维护不方便。

3.使用preparedStatement向有占位符传递参数存在硬编码问题因为sql中的where子句的条件不确定，同样是修改不方便/

4.对结果集中解析存在硬编码问题，sql的变化导致解析代码的变化，系统维护不方便。

mybatis对传统的JDBC的解决方案

1、数据库连接创建、释放频繁造成系统资源浪费从而影响系统性能，如果使用数据库连接池可解决此问题。

解决：在SqlMapConfig.xml中配置数据连接池，使用连接池管理数据库链接。

2、Sql语句写在代码中造成代码不易维护，实际应用sql变化的可能较大，sql变动需要改变java代码。

解决：将Sql语句配置在XXXXmapper.xml文件中与java代码分离。

3、向sql语句传参数麻烦，因为sql语句的where条件不一定，可能多也可能少，占位符需要和参数一一对应。

解决：Mybatis自动将java对象映射至sql语句，通过statement中的parameterType定义输入参数的类型。

4、对结果集解析麻烦，sql变化导致解析代码变化，且解析前需要遍历，如果能将数据库记录封装成pojo对象解析比较方便。

解决：Mybatis自动将sql执行结果映射至java对象，通过statement中的resultType定义输出结果的类型。

Mybaits整体体系图

​

​

一个Mybatis最简单的使用列子如下：

​

String resource = "mybatis-config.xml";
Reader reader;
try {
    //将XML配置文件构建为Configuration配置类             
    reader = Resources.getResourceAsReader(resource);             
    // 通过加载配置文件流构建一个SqlSessionFactory  
    DefaultSqlSessionFactory SqlSessionFactory
    sqlMapper = new SqlSessionFactoryBuilder().build(reader);             
    // 数据源 执行器  
    DefaultSqlSession SqlSession session = sqlMapper.openSession();
    try {                 
        // 执行查询 底层执行jdbc                 
        // User user = (User)session.selectOne("com.tuling.mapper.selectById", 1);                  
        UserMapper mapper = session.getMapper(UserMapper.class);
        System.out.println(mapper.getClass());
        User user = mapper.selectById(1L);
        System.out.println(user.getUserName());
    } catch (Exception e) {
        e.printStackTrace();
    } finally {
        session.close();
    }
} catch (IOException e) {
    e.printStackTrace();
}

总结下就是分为下面四个步骤：

• 从配置文件（通常是XML文件）得到SessionFactory;
• 从SessionFactory得到SqlSession；
• 通过SqlSession进行CRUD和事务的操作；
• 执行完相关操作之后关闭Session。

启动流程分析

​

String resource = "mybatis-config.xml"; 
//将XML配置文件构建为Configuration配置类 
reader = Resources.getResourceAsReader(resource); 
// 通过加载配置文件流构建一个SqlSessionFactory  DefaultSqlSessionFactory

​

通过上面代码发现，创建SqlSessionFactory的代码在SqlSessionFactoryBuilder中，进去一探究竟：

​

//整个过程就是将配置文件解析成Configration对象，然后创建SqlSessionFactory的过程
//Configuration是SqlSessionFactory的一个内部属性
public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
    try {
        XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
        return build(parser.parse());
    } catch (Exception e) {
        throw ExceptionFactory.wrapException("Error building SqlSession.", e);
    } finally {
        ErrorContext.instance().reset();
        try {
            inputStream.close();
        } catch (IOException e) {
            // Intentionally ignore. Prefer previous error.
        }
    }
}

public SqlSessionFactory build(Configuration config) {
    return new DefaultSqlSessionFactory(config);
}

下面我们看下解析配置文件过程中的一些细节。

先给出一个配置文件的列子：

DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    
    <properties resource="org/mybatis/example/config.properties">
      <property name="username" value="dev_user"/>
      <property name="password" value="F2Fa3!33TYyg"/>
    properties>

    
    <settings>
    <setting name="cacheEnabled" value="true"/>
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    settings>

    <typeAliases>

    typeAliases>

    <plugins>
        <plugin interceptor="com.github.pagehelper.PageInterceptor">
            
            
            <property name="pageSizeZero" value="true"/>
        plugin>
    plugins>

    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://10.59.97.10:3308/windty"/>
                <property name="username" value="windty_opr"/>
                <property name="password" value="windty!234"/>
            dataSource>
        environment>
    environments>

    <databaseIdProvider type="DB_VENDOR">
        <property name="MySQL" value="mysql" />
        <property name="Oracle" value="oracle" />
    databaseIdProvider>

    <mappers>
        
        
        
        <mapper resource="./mappers/CbondissuerMapper.xml"/>
    mappers>

​

下面是解析配置文件的核心方法：

try {
    //issue #117 read properties first
    //解析properties标签，并set到Configration对象中
    //在properties配置属性后，在Mybatis的配置文件中就可以使用${key}的形式使用了。
    propertiesElement(root.evalNode("properties"));

    //解析setting标签的配置
    Properties settings = settingsAsProperties(root.evalNode("settings"));
    //添加vfs的自定义实现，这个功能不怎么用
    loadCustomVfs(settings);

    //配置类的别名，配置后就可以用别名来替代全限定名
    //mybatis默认设置了很多别名，参考附录部分
    typeAliasesElement(root.evalNode("typeAliases"));

    //解析拦截器和拦截器的属性，set到Configration的interceptorChain中
    //MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法调用包括：
    //Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
    //ParameterHandler (getParameterObject, setParameters)
    //ResultSetHandler (handleResultSets, handleOutputParameters)
    //StatementHandler (prepare, parameterize, batch, update, query)
    pluginElement(root.evalNode("plugins"));

    //Mybatis创建对象是会使用objectFactory来创建对象，一般情况下不会自己配置这个objectFactory，使用系统默认的objectFactory就好了
    objectFactoryElement(root.evalNode("objectFactory"));
    objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
    reflectorFactoryElement(root.evalNode("reflectorFactory"));

    //设置在setting标签中配置的配置
    settingsElement(settings);

    //解析环境信息，包括事物管理器和数据源，SqlSessionFactoryBuilder在解析时需要指定环境id，如果不指定的话，会选择默认的环境；
    //最后将这些信息set到Configration的Environment属性里面
    environmentsElement(root.evalNode("environments"));

    //
    databaseIdProviderElement(root.evalNode("databaseIdProvider"));

    //无论是 MyBatis 在预处理语句（PreparedStatement）中设置一个参数时，还是从结果集中取出一个值时， 都会用类型处理器将获取的值以合适的方式转换成 Java 类型。解析typeHandler。
    typeHandlerElement(root.evalNode("typeHandlers"));
    //解析Mapper
    mapperElement(root.evalNode("mappers"));
} catch (Exception e) {
    throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
}

​

​

上面解析流程结束后会生成一个Configration对象，包含所有配置信息，然后会创建一个SqlSessionFactory对象，这个对象包含了Configration对象。

简单总结

对于MyBatis启动的流程（获取SqlSession的过程）这边简单总结下：

• SqlSessionFactoryBuilder解析配置文件，包括属性配置、别名配置、拦截器配置、环境（数据源和事务管理器）、Mapper配置等；解析完这些配置后会生成一个Configration对象，这个对象中包含了MyBatis需要的所有配置，然后会用这个Configration对象创建一个SqlSessionFactory对象，这个对象中包含了Configration对象；

这里解析的东西比较多，大致概况：会把所有的信息都解析到Configration对象中，比较简单不多介绍。

文档：MyBatis的二级缓存原理分析（请暂时关注解析缓存内容）

链接：http://note.youdao.com/noteshare?id=b97d399a65e31008fef704164d24c784&sub=wcp1596698664968348

文档：Mybatis解析动态sql原理分析

链接：http://note.youdao.com/noteshare?id=8b076e28061434f6693d99401d3ed400&sub=D948A34AA06045AEB7A01733A98A4C06

文档：Mybatis-设计模式总结.note

链接：http://note.youdao.com/noteshare?id=4975cd9e83f1e73e14a369598a232abe&sub=5D52C27921074712B1AB91C9A72455C0