Mybatis中 XML配置详解

接下来我将为大家详细讲解Mybatis中XML配置的详细攻略。

Mybatis中 XML配置详解

在Mybatis框架中，配置文件主要用于描述连接池、事务、日志等全局性配置信息，同时还描述Mybatis的具体操作接口以及实现类的映射关系。Mybatis中的配置文件主要包含两种：一是mybatis-config.xml，用于描述全局性配置信息；二是映射配置文件，用于描述具体操作接口以及实现类的映射关系。下面针对这两种配置文件进行详细讲解。

mybatis-config.xml

mybatis-config.xml是Mybatis中最重要的配置文件之一，它主要用于描述全局性配置信息，例如连接池的配置、事务的管理、日志的记录等等。

下面我们来看一个简单的mybatis-config.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">
<configuration>
    <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://localhost:3306/test" />
                <property name="username" value="root" />
                <property name="password" value="" />
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/example/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

在该示例中，我们定义了一个连接池（dataSource），并且指定使用的事务管理器（transactionManager），还指定了需要使用的Mapper文件。

映射配置文件

映射配置文件主要用于描述具体操作接口以及实现类的映射关系。在Mybatis中，这个映射关系是采用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="com.example.mapper.UserMapper">
    <select id="getUserById" parameterType="int" resultType="com.example.model.User">
        select * from users where id=#{id}
    </select>
</mapper>

在该示例中，我们定义了一个名为getUserById的查询语句，指定了该语句的参数为一个整数类型的id，返回值为com.example.model.User。

另外值得注意的是，在实际开发过程中，我们还可以使用Mybatis注解来代替映射文件，例如：

public interface UserMapper {
    @Select("Select * from users where id = #{id}")
    User getUserById(int id);
}

这样就可以直接使用UserMapper接口来进行数据操作了。

示例1

下面我们来看一个实际的示例，首先我们需要定义一个表：

CREATE TABLE `users` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(255) NOT NULL,
  `email` varchar(255) NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

然后，我们定义一个User的实体类：

public class User {
    private int id;
    private String name;
    private String email;
    // getter and setter methods
}

接下来，我们定义一个UserMapper接口：

public interface UserMapper {
    User getUserById(int id);
}

我们需要定义对应的映射文件UserMapper.xml，内容如下：

<?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="com.example.mapper.UserMapper">
    <select id="getUserById" parameterType="int" resultType="com.example.model.User">
        select * from users where id=#{id}
    </select>
</mapper>

最后，我们编写测试用例：

public class MybatisTest {
    private SqlSessionFactory factory;
    @Before
    public void setup() throws Exception {
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        factory = new SqlSessionFactoryBuilder().build(inputStream);
    }
    @Test
    public void testGetUserById() {
        try (SqlSession session = factory.openSession()) {
            UserMapper mapper = session.getMapper(UserMapper.class);
            User user = mapper.getUserById(1);
            assertEquals(1, user.getId());
            assertEquals("Alice", user.getName());
            assertEquals("[e-mail]", user.getEmail());
        }
    }
}

测试用例中我们首先获取到了UserMapper接口的实现类，然后调用getUserById方法进行查询，最后进行断言。

示例2

在Mybatis中，还支持一些高级特性的使用，例如动态SQL、缓存等等。下面我们来看一个使用动态SQL的示例。

首先，我们定义了一个UserQuery的查询条件类：

public class UserQuery {
    private String name;
    private String email;
    // getter and setter methos
}

然后，我们定义了一个UserMapper接口：

public interface UserMapper {
    List<User> getUserListByQuery(UserQuery query);
}

我们需要定义对应的映射文件UserMapper.xml，内容如下：

<?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="com.example.mapper.UserMapper">
    <select id="getUserListByQuery" parameterType="com.example.model.UserQuery" resultType="com.example.model.User">
        select * from users
        <where>
            <if test="name != null">
                and name like '%${name}%'
            </if>
            <if test="email != null">
                and email like '%${email}%'
            </if>
        </where>
    </select>
</mapper>

最后，我们编写测试用例：

public class MybatisTest {
    private SqlSessionFactory factory;
    @Before
    public void setup() throws Exception {
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        factory = new SqlSessionFactoryBuilder().build(inputStream);
    }
    @Test
    public void testGetUserListByQuery() {
        try (SqlSession session = factory.openSession()) {
            UserMapper mapper = session.getMapper(UserMapper.class);
            UserQuery query = new UserQuery();
            query.setName("li");
            List<User> userList = mapper.getUserListByQuery(query);
            assertEquals(2, userList.size());
        }
    }
}

测试用例中我们首先获取到了UserMapper接口的实现类，然后调用getUserListByQuery方法进行查询，最后进行断言。

以上就是对于Mybatis中XML配置的详细攻略，希望对大家有所帮助。