MyBatis中的配置文件详解

目录

• 前言
• 全局配置文件
• 映射配置文件

前言

在 MyBATis 中，配置文件分为 全局配置文件（核心配置文件） 和 映射配置文件 。通过这两个配置文件，MyBatis 可以根据需要动态地生成 SQL 语句并执行，同时将结果集转换成 Java 对象，使得在 Java 程序中操作数据库变得更加方便和灵活。

全局配置文件

全局配置文件（Core Configuration File），是 MyBatis 的核心配置文件，通常命名为 mybatis-config.XML 。这个文件包含 MyBatis 运行时所需的核心配置信息，如数据库连接信息、事务管理器、别名、映射文件等。

全局配置文件通常的结构

configuration（配置）

properties（属性）

settings（设置）

typeAliases（类型别名）

typeHandlers（类型处理器）

objectFactory（对象工厂）

plugins（插件）

environments（环境配置）

– environment（环境变量）

---- transactionManager（事务管理器）

---- dataSource（数据源）

databaseIdProvider（数据库厂商标识）

mappers（映射器）

常见全局配置标签

settings 标签中的属性

简单示例：

在Java持久层框架：MyBatis介绍文章的案例基础上

1.typeAliases 标签：设置别名的标签。可以简化类型名称的书写，如可以用一个别名代替一个类全名

首先，在 mybatis.xml 配置文件中配置以下内容

<!-- typeAliases：设置别名，简化类型名称的书写。用一个别名代替一个类全名 -->
<typeAliases>
    <!-- 即 user 名称可以替代 cn.edu.MyBatisDemo.model.User 类全名 -->

    <!-- 设置单个别名的方式 -->
    <!-- <typeAlias type="cn.edu.MyBatisDemo.model.User" alias="user" /> -->

    <!-- 设置多个别名的方式，别名默认为类名（首字母为小写） -->
    <!-- 可以使用 @Alias() 注解在实体类的上方设置自定义的别名 -->
    <package name="cn.edu.MyBatisDemo.model" />
</typeAliases>

接着，在其他配置文件（如 UserMapper.xml ）中使用到 cn.edu.MyBatisDemo.model.User 的类全名都可以写成 user 名称

最后，测试结果

结果如图：

2.mappers 标签：指定映射文件路径的标签。MyBatis 会加载这些文件并将其应用于相应的数据库操作

首先，在 mybatis.xml 配置文件中配置以下内容

<!-- POJO对象与数据表的映射配置 -->
<mappers>
    <!-- 1.类路径 -->
    <!-- <mapper resource="cn/edu/MyBatisDemo/model/UserMapper.xml" /> -->

    <!-- 2.包全名（注：映射文件与接口必须在同一个包和相同的文件名）-->
    <package name="cn.edu.MyBatisDemo.mapper" />
</mappers>

接着，查看映射文件与接口是否在同一个包里和相同的文件名

最后，测试结果

结果如图：

映射配置文件

映射配置文件（Mapping Configuration File），用于定义 SQL 语句和结果集的映射关系。每个映射配置文件都对应于数据库中的一个表或一个存储过程。映射配置文件通常会以 .xml 格式保存，并且命名方式通常是 [实体名] Map.xml 或者 [表名] Map.xml 。

常见映射配置标签

简单示例：

在上面的案例基础上，再实现用户的编程客栈增删改功能

首先，在接口 UserMapper 上声明增删改的方法

public void insert(User us编程er); // 新增用户
public void update(User user); // 修改用户信息
public void delete(int id); // 删除指定用户

接着，在 UserMapper.xml 映射文件中添加对应的标签来实现

<!-- 通过 useGeneratedKeys 和 keyProperty 属性获取 mysql 自增的主键 id 值 -->
<!-- useGeneratedKeys：开启添加记录后返回其 id 值 -->
<!-- keyProperty：设置返回的值放到对象指定的属性值上 -->
<insert id="insert" useGeneratedKeys="true" keyProperty="id">
    INSERT INTO `user` (`name`,`password`,`date`,`state`) VALUES (#{name},#{password},#{date},#{state})
</insert>

<update id="update" >
    UPDATE `user` SET `name`=#{name},`password`=#{password},`date`=#{date},`state`=#{state} WHERE `id`=#{id}
</update>

<delete id="delete" >
    DELETE FROM `user` WHERE `id`=#{id}
</delete>

最后，测试结果

package cn.edu.MyBatisDemo.test;
import cn.edu.MyBatisDemo.mapper.UserMapper;
import cn.edu.MyBatisDemo.model.User;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Test;
import java.io.IOException;
import java.io.InputStream;
import java.util.Date;
public class MyBatisTest {
    @Test
    public void test() throws IOException {
        //1.根据配置文件创建数据库连接会话的工厂类
        InputStream inputStream = Resources.getResourceAsStream("mybatis.xml");
        //获取工厂类
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        //2.通过工厂类获取数据库连接的会话
        SqlSession sqlSession = sqlSessionFactory.openSessiohttp://www.devze.comn();
        //3.通过 sqlSession 操作数据库
        try {
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            //新增用户信息
            User insertUser = new User("诸葛亮","ccc",new Date(),1); // 在实体类中添加对应的参数构造方法
            userMapper.insert(insertUser);
            //获取新增用户的 id 值
            int id = insertUser.getId();
            //查看指定用户
            User selectUser = userMapper.selectUserById(id);
            System.out.println(selectUser);
            /**
             *  //修改指定用户
             *  User updateUser = new User("曹操","ccc",new Date(),1);
             *  updateUser.setId(20230815);
             *  userMapper.update(updateUser);
             *
             *  //删除指定用户
             *  userMapper.delete(20230815);
             */
            sqlSession.commit();
        } finally {
            sqlSession.close();
        }
    }
}
结

结果如图：

注

参数数量

在案例的 selectUserById 方法中，只传递一个 id 值作为参数（单个参数），在 UserMapper.xml 映射文件中通过 #{id} 来接收。通常情况下，使用相同名字输入在 #{} 内，也可以使用任意字符串输入在 #{} 内。

但是，在多个参数的情况下，MyBatis 会把参数封装成 Map 对象，#{} 内将从 Map 对象中获取对应值，其获取方式分为三种：

书写格式1：参数1—param1,参数2—param2 …

书写格式2：参数1—arg0,参数2—arg1 …

书写格式3：在接口方法的参数上使用 @Param() 注解指定名字

另外，也可以将多个参数封装成 POJO 对象，通过 #{ POJO 对象属性} 形式获取传递的值

参数类型

当接口方法上的参数类型为集合或数组时，同样 MyBatis 也是将参数封装成 Map 对象，然后分别通过 #{collection} 和 #{array} 方式获取参数值。另外，List 集合可以通过 #{list} 方式获取。

书写格式1：参数1—#{collection[0]},参数2—#{collection[1]} …

书写格式2：参数1—#{array[0]},参数2—#{array[1]} …

书写格式3：参数1—#{list[0]},参数2—#{list[1]} …

参数符号

在映射文件中，获取参数所使用的参数符号分为两种：#{} 和 ${} 。

#{}：PreparedStatement 对象来执行的 SQL 语句（预编译，基本情况下使用该参数符号）

${}：Statement 对象来执行的 SQL 语句 （拼接成 SQL 语句，存在注入攻击风险。一般用于传入数据库对象，如表名、order by 排序字段）

select 标签属性

resultType 属性

1.当返回结果为 List 集合类型时，resultType 属性值为类全名或设置的别名

2.当返回结果为 Map 集合类型时，resultType 属性值为已设定的别名 map

resultMap 属性

1.自定义数据库字段与对象属性的对应名字

2.实现关联查询

到此这篇关于MyBatis：配置文件的文章就介绍到这了,更多相关MyBatis配置文件内容请搜索编程客栈(www.devze.com)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程客栈(www.devze.com)！