Mybatis核心配置文件详解

161 阅读2分钟

持续创作,加速成长!这是我参与「掘金日新计划 · 10 月更文挑战」的第6天,点击查看活动详情

1.Mybatis核心配置文件

mybatis的核心文件不需要有这么多的东西,这个是一个模板。Mybatis核心配置文件只需要定义好数据源和mapper映射文件所在位置便可以使mybatis正常工作,下面会详细介绍这些标签的作用。

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

    <!--
    Mybatis核心配置文件中的标签必须安装指定的顺序配置
    The content of element type "configuration" must match
    "(properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,
    objectWrapperFactory?,reflectorFactory?,plugins?,environments?,
    databaseIdProvider?,mappers?)".
    -->



    <!--引入properties文件,此后就可以在当前文件中使用${key}的方式访问value-->
    <properties resource="jdbc.properties" />

    <!--
        typeAliases:设置类型别名,即为某个具体的类型设置一个别名
        在Mybatis的范围中,就可以使用别名表示一个具体的类型
    -->
    <typeAliases>
        <!--
            type:设置需要起别名的类型
            alias:设置某个类型的别名
        -->
        <!--<typeAlias type="com.atguigu.mybatis.pojo.User" alias="abc"></typeAlias>-->
        <!--若不设置alias,当前类型拥有默认的别名,即类名且不区分大小写-->
        <!--<typeAlias type="com.atguigu.mybatis.pojo.User"></typeAlias>-->
        <!--通过包设置类型别名,指定包下所有的类型将全部拥有默认的别名,即类名且不区分大小写-->
        <package name="com.atguigu.mybatis.pojo"/>
    </typeAliases>

    <!--
        environments:设置连接数据库的环境
        属性:
        default:设置默认使用的环境id,比方这里你可以填development(开发)或者test(测试)
    -->
    <environments default="development">
        <!--
            environment:设置一个具体的连接数据库的环境
            属性:
            id:设置环境的唯一标识,不能重复,值随便你填
        -->
        <environment id="development">
            <!--
                transactionManager:设置事务管理器
                属性:
                type:设置事务管理的方式
                type="JDBC|MANAGED"
                JDBC:表示使用JDBC中原生的事务管理方式。意思是自动提交可以手动开启或关闭,也可以手动提交事务或回滚事务
                MANAGED:被管理,比如可以将事务交给spring管理
            -->
            <transactionManager type="JDBC"/>
            <!--
                dataSource:设置数据源
                属性:
                type:设置数据源的类型
                type="POOLED|UNPOOLED|JNDI"
                POOLED:表示使用数据库连接池
                UNPOOLED:表示不使用数据库连接池
                JNDI:表示使用上下文中的数据源
            -->
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>

        <environment id="test">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/ssm?serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>
    <!--引入映射文件-->
    <mappers>
        <!--<mapper resource="mappers/UserMapper.xml"/>-->

        <!--
            已包的方式引入映射文件,但是必须满足两个条件
            1.mapper接口和映射文件所在的包必须一致
            2.mapper接口的名字和映射文件的名字必须一致
        -->
        <package name="com.atguigu.mybatis.mapper"/>
    </mappers>
</configuration>

2.environments 标签

environments的作用是设置连接数据库的环境

这个标签是一个复数,说明里面可以放置多个相同类型的标签。比方说开发中有多个数据环境,如:开发环境和测试环境,那么你就可以在environments标签里定义两个environment标签,让这两个标签去定义不同的数据环境

<environments default="development">
        <!--
            environment:设置一个具体的连接数据库的环境
            属性:
            id:设置环境的唯一标识,不能重复,值随便你填
        -->
        <environment id="development">
            开发环境的数据库信息
        </environment>

        <environment id="test">
            测试环境的数据库信息
        </environment>
    </environments>

那mybatis怎么知道你要用哪个数据库呢?你定义的environment都有一个唯一的id,你将这个id填到environments标签的default属性即可。

3.properties标签

大家看下,标题1里定义的测试环境的数据库信息,比如

<property name="driver" value="com.mysql.cj.jdbc.Driver"/>

后期修改里面的信息会不会很麻烦呢?

解决办法:

我们可以定义一个properties文件,然后将数据库信息放到里面,再通过引用这个文件的内容来填写我们的数据库信息,好处是以后修改数据库信息很方便。那么问题来了我们定义的properties文件和mybatis的核心配置文件根本就没关系,我们又怎么能够引用里面的数据呢properties标签的作用就是帮我们在mybatis的核心配置文件里面引入properties文件的信息,然后我们就可以用${key}的方式访问value的值

具体步骤如下图所示:

image-20221029185436120.png

image-20221029185500601.png

properties文件内容如下:

jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/ssm?serverTimezone=UTC
jdbc.username=root
jdbc.password=123456

mybatis核心配置文件

<?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">
<configuration>
    
    <properties resource="jdbc.properties" />
    
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>
</configuration>

4.typeAliases标签

这个标签的作用就是可以给全限定的类名起别名,以后如果需要使用这个某个类,那就不需要写全类名了,写它的别名即可。好处是别名可以起得简单。

<typeAliases>
        <!--
            type:设置需要起别名的类型
            alias:设置某个类型的别名
        -->
        <!--<typeAlias type="com.atguigu.mybatis.pojo.User" alias="abc"></typeAlias>-->
        <!--若不设置alias,当前类型拥有默认的别名,即类名且不区分大小写-->
        <!--<typeAlias type="com.atguigu.mybatis.pojo.User"></typeAlias>-->
        <!--通过包设置类型别名,指定包下所有的类型将全部拥有默认的别名,即类名且不区分大小写-->
        <package name="com.atguigu.mybatis.pojo"/>
    </typeAliases>

我们可以发现,起别名有三种方式:

  1. 通过typeAliases的子标签typeAlias的type属性指定全类名,接着用alias属性指定别名
  2. 通过typeAliases的子标签typeAlias的type属性指定全类名,别名自动给你起,即别名是类名且不区分大小写
  3. 通过package的name属性,指定实体类所在的包位置,那么这个包下面的所有类都会有别名,别名是类名且不区分大小写

别名起好后,可以在mybatis的映射文件里面使用

<!--<select id="getAllUser" resultType="abc">-->
 <!--<select id="getAllUser" resultType="user">-->
<select id="getAllUser" resultType="User">
    select * from t_user
</select>

注意:在mybatis的核心配置文件里面标签放置的位置是有要求的,比如typeAliases标签要放在properties标签后面。如果你的标签放置的位置错误了,那么configuration会报错,你把鼠标放上去,他会告诉你,标签的放置顺序。

5.mappers标签

这个标签的作用主要就是告诉mybatis映射文件所在位置

<mappers>
        <mapper resource="mappers/UserMapper.xml"/>
        <mapper resource="mappers/xxxMapper.xml"/>

    </mappers>

在实际开发过程中,我们要操作的表是很多的,所以不止有一个映射文件。如果你在mappers标签里面定义多个mapper标签不是不行,只是繁琐。解决办法也简单,可以采用如下的配置方式:

<!--引入映射文件-->
    <mappers>
        <!--
            已包的方式引入映射文件,但是必须满足两个条件
            1.mapper接口和映射文件所在的包必须一致
            2.mapper接口的名字和映射文件的名字必须一致
        -->
        <package name="com.atguigu.mybatis.mapper"/>
    </mappers>

image-20221029191837576.png

注意:resources目录如果连续创建父子目录的时候要aaa/bbb,不要aaa.bbb