MyBatis——XML配置文件

31 阅读2分钟

在MyBatis中,对于简单的SQL语句可以直接通过注解配置SQL语句,但是遇到复杂的SQL语句就不是那么方便了(比如说动态SQL),此时就需要使用XML配置文件配置SQL语句。

XML配置文件默认规则

有了XML配置文件之后,定义Mapper接口的时候就不需要再使用注解了,以下是XML配置文件的定义规则:

1.XML映射文件的名称必须和对应的Mapper接口完全、严格一致,并且XML映射文件必须和Mapper接口放置在相同的包下 (必须同包同名)。

image.png

名称完全一样,并且同包同名。

2.XML映射文件中的namespace属性必须和Mapper接口的全限定名完全一致。

image.png namespace的属性和Mapper接口的全限定名一致。

3.XML映射文件中的SQL语句的id必须和Mapper接口中的方法名完全一致返回类型也必须完全一致。

XML中需要引入头信息(约束),可以直接在Mybatis官方文档中拷贝:

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
  PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="your mapper">
<mapper>

image.png

image.png SQL语句的id和Mapper中的方法名完全一致,返回类型也完全一致(注意,此处返回类型完全一致是指这些数据封装的对象是一致的,都是User实体对象)。

(注意,这里方法名下的红色波浪线不是报错,只是一个警告,因为这个项目是学习项目,里面有很多模块,模块中有很多同名的包和同名的类,idea在扫描的时候发现了这个问题,报了警告,实际上运行是没问题的。)

使用XML配置文件实现查询全部用户

在mapper接口中的代码十分简单:

public List<User> selectAll();

XML文件中定义的SQL会查询user表中的每一个用户,然后将用户的所有字段根据User对象中的属性封装成User实体对象返回,当查询出多条用户记录时,MyBatis 框架会自动将这些一个个创建好的User实体对象封装成一个List集合。所以说方法直接返回List集合即可。

测试XML配置SQL是否成功:

@Test
public void testSelectAll() {
    List<User> userList = userMapper.selectAll();
    for (User user : userList) {
        System.out.println(user);
    }
}

image.png

image.png