Java--MyBatis配置文件

Posted 2022-06-06 MinggeQingchun

mybatis的主配置文件：主要定义了数据库的配置信息，SQL映射文件的位置，如mybatis-config.xml；mybatis.xml

1、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">

2、根元素，<configuration>

3、主要包含

（1）定义别名

（2）数据源

（3）mapper 文件

如下简单格式：

<?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">

<!--
    1、约束文件
        <!DOCTYPE configuration
            PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
            "http://mybatis.org/dtd/mybatis-3-config.dtd">
        mybatis-3-config.dtd：约束文件名称
    2、configuration：根标签
-->
<configuration>

    <!-- settings：mybatis全局行为 -->
    <settings>
        <!-- 设置mybatis输出日志 -->
        <setting name="logImpl" value="STDOUT_LOGGING" />
    </settings>

    <!--定义别名-->
    <typeAliases>
        <!--
            第一种方式：
            指定一个类型一个自定义别名
            type:自定义类型的全限定名称
            alias:别名
        -->
        <typeAlias type="com.mycompany.domain.User" alias="user" />
        <typeAlias type="com.mycompany.vo.ViewUser" alias="vUser" />

        <!--
          第二种方式
          <package> name是包名， 这个包中的所有类，类名就是别名（类名不区分大小写）
        -->
        <package name="com.mycompany.domain" />
        <package name="com.mycompany.vo" />

    </typeAliases>

    <!--
        环境配置：数据库的连接信息
            default：必须和某个environment的id值一样
            告诉mybatis使用哪个数据库的连接信息（访问哪个数据库）
    -->
    <environments default="development">

        <!--
            environment：一个数据库的配置，环境
            id：一个唯一值（可自定义，表示环境的名称）
         -->
        <environment id="development">
            <!--
                transactionManaer：mybatis的事务类型
                    type：JDBC（表示使用JDBC中的Connection对象的commit，rollback做事务处理）
            -->
            <transactionManager type="JDBC"/>
            <!--
                dataSource：表示数据源，连接数据库的
                    type：表述数据源的类型，POOLED表示使用连接池
            -->
            <dataSource type="POOLED">
                <!--
                   driver, user, username, password 是固定的，不能自定义。
                -->
                <!-- 数据库驱动类名 -->
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <!-- 连接数据库的URL字符串 -->
                <property name="url" value="jdbc:mysql://localhost:3306/ssm"/>
                <!-- 访问数据库的用户名 -->
                <property name="username" value="root"/>
                <!-- 访问数据库的密码 -->
                <property name="password" value="123456"/>
            </dataSource>
        </environment>

    </environments>

    <!-- sql mapper（SQL映射文件）的位置 -->
    <mappers>
        <!--
            一个mapper标签指定一个文件的位置；从类路径开始的路径信息（target/classes）类路径
        -->
        <mapper resource="com/mycompany/dao/UserDao.xml"/>
    </mappers>
</configuration>

一、<settings>标签

settings是 MyBatis 中全局的调整设置，它们会改变 MyBatis 的运行时行为，需要谨慎使用

主要有如下设置

    <settings>  
	        <!-- 该配置影响的所有映射器中配置的缓存的全局开关。默认值true -->  
	      <setting name="cacheEnabled" value="true"/>  
	      <!--延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。 特定关联关系中可通过设置fetchType属性来覆盖该项的开关状态。默认值false  -->  
	      <setting name="lazyLoadingEnabled" value="true"/>  
	        <!-- 是否允许单一语句返回多结果集（需要兼容驱动）。 默认值true -->  
	      <setting name="multipleResultSetsEnabled" value="true"/>  
	      <!-- 使用列标签代替列名。不同的驱动在这方面会有不同的表现， 具体可参考相关驱动文档或通过测试这两种不同的模式来观察所用驱动的结果。默认值true -->  
	      <setting name="useColumnLabel" value="true"/>  
	      <!-- 允许 JDBC 支持自动生成主键，需要驱动兼容。 如果设置为 true 则这个设置强制使用自动生成主键，尽管一些驱动不能兼容但仍可正常工作（比如 Derby）。 默认值false  -->  
	      <setting name="useGeneratedKeys" value="false"/>  
	     <!--  指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示取消自动映射；PARTIAL 只会自动映射没有定义嵌套结果集映射的结果集。 FULL 会自动映射任意复杂的结果集（无论是否嵌套）。 -->   
	     <!-- 默认值PARTIAL -->  
	      <setting name="autoMappingBehavior" value="PARTIAL"/>  
	        
	      <setting name="autoMappingUnknownColumnBehavior" value="WARNING"/>  
	     <!--  配置默认的执行器。SIMPLE 就是普通的执行器；REUSE 执行器会重用预处理语句（prepared statements）； BATCH 执行器将重用语句并执行批量更新。默认SIMPLE  -->  
	      <setting name="defaultExecutorType" value="SIMPLE"/>  
	      <!-- 设置超时时间，它决定驱动等待数据库响应的秒数。 -->  
	      <setting name="defaultStatementTimeout" value="25"/>  
	        
	      <setting name="defaultFetchSize" value="100"/>  
	      <!-- 允许在嵌套语句中使用分页（RowBounds）默认值False -->  
	      <setting name="safeRowBoundsEnabled" value="false"/>  
	      <!-- 是否开启自动驼峰命名规则（camel case）映射，即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射。  默认false -->  
	      <setting name="mapUnderscoreToCamelCase" value="false"/>  
	      <!-- MyBatis 利用本地缓存机制（Local Cache）防止循环引用（circular references）和加速重复嵌套查询。  
	             默认值为 SESSION，这种情况下会缓存一个会话中执行的所有查询。  
	            若设置值为 STATEMENT，本地会话仅用在语句执行上，对相同 SqlSession 的不同调用将不会共享数据。  -->  
	      <setting name="localCacheScope" value="SESSION"/>  
	      <!-- 当没有为参数提供特定的 JDBC 类型时，为空值指定 JDBC 类型。 某些驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER。  -->  
	      <setting name="jdbcTypeForNull" value="OTHER"/>  
	    <!--   指定哪个对象的方法触发一次延迟加载。  -->  
	      <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>  
    </settings>  

二、<typeAliases>标签

定义别名，Mybatis 支持默认别名，也可采用自定义别名方式来开发，主要使用在<select resultType=”别名”>

<!--定义别名-->
    <typeAliases>
        <!--
            第一种方式：定义单个类型的别名
            指定一个类型一个自定义别名
            type:自定义类型的全限定名称
            alias:别名
        -->
        <typeAlias type="com.mycompany.domain.User" alias="user" />
        <typeAlias type="com.mycompany.vo.ViewUser" alias="vUser" />

        <!--
          第二种方式：批量定义别名，扫描整个包下的类，别名为类名
          <package> name是包名， 这个包中的所有类，类名就是别名（类名不区分大小写）
        -->
        <package name="com.mycompany.domain" />
        <package name="com.mycompany.vo" />

    </typeAliases>

三、<environments>标签

环境配置：数据库的连接信息

default：必须和某个environment的id值一样

告诉mybatis使用哪个数据库的连接信息（访问哪个数据库）

<!--
        环境配置：数据库的连接信息
            default：必须和某个environment的id值一样
            告诉mybatis使用哪个数据库的连接信息（访问哪个数据库）
    -->
    <environments default="development">

        <!--
            environment：一个数据库的配置，环境
            id：一个唯一值（可自定义，表示环境的名称）
         -->
        <environment id="development">
            <!--
                transactionManaer：mybatis的事务类型
                    type：JDBC（表示使用JDBC中的Connection对象的commit，rollback做事务处理）
            -->
            <transactionManager type="JDBC"/>
            <!--
                dataSource：表示数据源，连接数据库的
                    type：表述数据源的类型，POOLED表示使用连接池
            -->
            <dataSource type="POOLED">
                <!--
                   driver, user, username, password 是固定的，不能自定义。
                -->
                <!-- 数据库驱动类名 -->
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <!-- 连接数据库的URL字符串 -->
                <property name="url" value="jdbc:mysql://localhost:3306/ssm"/>
                <!-- 访问数据库的用户名 -->
                <property name="username" value="root"/>
                <!-- 访问数据库的密码 -->
                <property name="password" value="123456"/>
            </dataSource>
        </environment>

    </environments>

一般为了方便对数据库连接的管理，DB 连接四要素数据一般都是存放在一个专门的属性文件中的，MyBatis主配置文件需要从这个属性文件中读取这些数据

如下，我们在

1、在 classpath 路径下，创建 properties 文件；

在 resources 目录创建 jdbc.properties 文件，文件名称自定义；如

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/ssm
jdbc.user=root
jdbc.password=123456

2、在主配置文件中使用properties标签

<configuration>

    <!--指定properties文件的位置，从类路径根开始找文件-->
    <properties resource="jdbc.properties" />

3、 在dataSource下使用 properties 文件: 语法 $key

    <dataSource type="POOLED">
        <!--
            driver, user, username, password 是固定的，不能自定义。
        -->
        <!-- 数据库驱动类名 -->
        <property name="driver" value="$jdbc.driver"/>
        <!-- 连接数据库的URL字符串 -->
        <property name="url" value="$jdbc.url"/>
        <!-- 访问数据库的用户名 -->
        <property name="username" value="$jdbc.user"/>
        <!-- 访问数据库的密码 -->
        <property name="password" value="$jdbc.password"/>
    </dataSource>

四、<transactionManager>标签

1、 默认需要手动提交事务

Mybatis 框架是对 JDBC 的封装，所以 Mybatis 框架的事务控制方式，本身也是用 JDBC 的 Connection对象的 commit(), rollback() .

Connection 对象的 setAutoCommit()方法来设置事务提交方式的。自动提交和手工提交

<!--
    transactionManager:mybatis提交事务，回顾事务的方式
    type: 事务的处理的类型
    （1）JDBC : 表示mybatis底层是调用JDBC中的Connection对象的，commit， rollback
    （2）MANAGED : 把mybatis的事务处理委托给其它的容器（一个服务器软件，一个框架（spring））
-->
<transactionManager type="JDBC"/>

该标签用于指定 MyBatis所使用的事务管理器。MyBatis 支持两种事务管理器类型：JDBC 与 MANAGED。

JDBC：使用 JDBC 的事务管理机制。即通过 Connection 的 commit()方法提交，通过 rollback()方法 回滚。但默认情况下，MyBatis 将自动提交功能关闭了，改为了手动提交。即程序中需要显式的对 事务进行提交或回滚。从日志的输出信息中可以看到

 MANAGED：由容器来管理事务的整个生命周期（如 Spring 容器）

2、自动提交事务

设置自动提交的方式，factory 的 openSession() 分为有参数和无参数的。

有参数为 true，使用自动提交，可以修改 MyBatisUtil 的 getSqlSession()方法

session = factory.openSession(true);

再执行 insert 操作，无需执行 session.commit()，事务是自动提交的

五、<dataSource>标签

dataSource：表示数据源，连接数据库的

<!--
   dataSource：表示数据源，连接数据库的

   type：表述数据源的类型，POOLED表示使用连接池
  （1）POOLED: 使用连接池， mybatis会创建PooledDataSource类
  （2）UPOOLED: 不使用连接池， 在每次执行sql语句，先创建连接，执行sql，在关闭连接
    mybatis会创建一个UnPooledDataSource，管理Connection对象的使用
  （3）JNDI：java命名和目录服务（windows注册表）
-->
<dataSource type="POOLED">

六、<mappers>标签

1、<mapper resource=" " />

使用相对于类路径的资源，从 classpath 路径查找文件

<!-- sql mapper（SQL映射文件）的位置 -->
    <mappers>
        <!-- 第一种方式：指定多个mapper文件
            一个mapper标签指定一个文件的位置
                从类路径开始的路径信息（target/classes）类路径
        -->
<!--        <mapper resource="com/mycompany/dao/UserDao.xml"/>-->
<!--        <mapper resource="com/mycompany/dao/MyUserDao.xml"/>-->

    </mappers>

2、<package name=""/>

指定包下的所有 Dao 接口

<!-- sql mapper（SQL映射文件）的位置 -->
    <mappers>

        <!-- 第二种方式：使用包名
            name：xml文件（mapper文件）中所在的包名，这个包中所有xml文件一次都能加载给mybatis
            使用package的要求：
             1、mapper文件名称需要和接口名称一样（区分大小写）
             2、mapper文件和dao接口需要在同一目录
        -->
        <package name="com.mycompany.dao" />

    </mappers>

注：

此种方法要求 Dao 接口名称和 mapper 映射文件名称相同，且在同一个目录中

相对较全的主配置文件如下：

<?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的主配置文件：主要定义了数据库的配置信息，SQL映射文件的位置
    1、约束文件
        <!DOCTYPE configuration
            PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
            "http://mybatis.org/dtd/mybatis-3-config.dtd">
        mybatis-3-config.dtd：约束文件名称
    2、configuration：根标签
-->
<configuration>

    <!--指定properties文件的位置，从类路径根开始找文件-->
    <properties resource="jdbc.properties" />

    <!-- settings：mybatis全局行为 -->
    <settings>
        <!-- 设置mybatis输出日志 -->
        <setting name="logImpl" value="STDOUT_LOGGING" />
    </settings>

    <!--定义别名-->
    <typeAliases>
        <!--
            第一种方式：
            指定一个类型一个自定义别名
            type:自定义类型的全限定名称
            alias:别名
        -->
        <typeAlias type="com.mycompany.domain.User" alias="user" />

        <!--
          第二种方式
          <package> name是包名， 这个包中的所有类，类名就是别名（类名不区分大小写）
        -->
        <package name="com.mycompany.domain" />
        <package name="com.mycompany.vo" />

    </typeAliases>


    <!--配置插件-->
    <plugins>
        <plugin interceptor="com.github.pagehelper.PageInterceptor" />
    </plugins>


    <!--
        环境配置：数据库的连接信息
            default：必须和某个environment的id值一样
            告诉mybatis使用哪个数据库的连接信息（访问哪个数据库）
    -->
    <environments default="development">

        <!--
            environment：一个数据库的配置，环境
            id：一个唯一值（可自定义，表示环境的名称）
         -->
        <environment id="development">
            <!--
              transactionManager:mybatis提交事务，回顾事务的方式
                 type: 事务的处理的类型
                     （1）JDBC : 表示mybatis底层是调用JDBC中的Connection对象的，commit， rollback
                     （2）MANAGED : 把mybatis的事务处理委托给其它的容器（一个服务器软件，一个框架（spring））
            -->
            <transactionManager type="JDBC"/>
            <!--
                dataSource：表示数据源，连接数据库的

                type：表述数据源的类型，POOLED表示使用连接池
                    （1）POOLED: 使用连接池， mybatis会创建PooledDataSource类
                    （2）UPOOLED: 不使用连接池， 在每次执行sql语句，先创建连接，执行sql，在关闭连接
                              mybatis会创建一个UnPooledDataSource，管理Connection对象的使用
                    （3）JNDI：java命名和目录服务（windows注册表）
            -->
            <dataSource type="POOLED">
                <!--
                   driver, user, username, password 是固定的，不能自定义。
                -->
                <!-- 数据库驱动类名 -->
                <property name="driver" value="$jdbc.driver"/>
                <!-- 连接数据库的URL字符串 -->
                <property name="url" value="$jdbc.url"/>
                <!-- 访问数据库的用户名 -->
                <property name="username" value="$jdbc.user"/>
                <!-- 访问数据库的密码 -->
                <property name="password" value="$jdbc.password"/>
            </dataSource>
        </environment>

        <!--表示线上的数据库，是项目真实使用的库-->
        <environment id="online">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/onlinedb"/>
                <property name="username" value="root"/>
                <property name="password" value="admin123456"/>
            </dataSource>
        </environment>

    </environments>

    <!-- sql mapper（SQL映射文件）的位置 -->
    <mappers>
        <!-- 第一种方式：指定多个mapper文件
            一个mapper标签指定一个文件的位置
                从类路径开始的路径信息（target/classes）类路径
        -->
<!--        <mapper resource="com/mycompany/dao/UserDao.xml"/>-->
<!--        <mapper resource="com/mycompany/dao/MyUserDao.xml"/>-->

        <!-- 第二种方式：使用包名
            name：xml文件（mapper文件）中所在的包名，这个包中所有xml文件一次都能加载给mybatis
            使用package的要求：
             1、mapper文件名称需要和接口名称一样（区分大小写）
             2、mapper文件和dao接口需要在同一目录
        -->
        <package name="com.mycompany.dao" />

    </mappers>
</configuration>