MyBatis（30）如何在 MyBatis 中使用 XML 和注解混合配置方式

在MyBatis中，你可以灵活地选择XML配置方式、注解方式，或者将这两种方式混合使用来配置你的映射器（Mapper）。使用混合配置方式，你可以结合两者的优势，例如，利用XML配置复杂查询和动态SQL，同时使用注解简化简单映射的配置。下面我们将详细探讨如何在MyBatis中实现这种混合配置方式。

基本概念

在MyBatis中，映射器（Mapper）是一个接口，你可以通过XML文件或者注解来提供SQL映射语句。MyBatis在启动时会自动扫描这些接口和映射文件，创建映射器的代理对象供你在代码中调用。

使用注解

注解配置是一种比较直观且易于理解的配置方式。你可以直接在Mapper接口的方法上使用@Select、@Insert、@Update等注解来指定SQL语句，如下所示：

public interface UserMapper {
    @Select("SELECT * FROM users WHERE id = #{id}")
    User getUserById(int id);
}

使用XML

XML配置允许你编写更加复杂的SQL语句和动态SQL。通常，你会为每个Mapper接口创建一个同名的XML文件，并在其中定义SQL映射语句，如下所示：

<!-- UserMapper.xml -->
<mapper namespace="com.example.mapper.UserMapper">
    <select id="getUserById" resultType="com.example.domain.User">
        SELECT * FROM users WHERE id = #{id}
    </select>
</mapper>

混合使用XML和注解

当你需要混合使用XML和注解时，关键是要确保MyBatis能够找到并正确处理所有的映射配置。以下步骤展示了如何实现混合配置：

1. 配置MyBatis的SQLSessionFactory

   首先，你需要配置MyBatis的SqlSessionFactory，确保它能够加载到所有的Mapper接口和XML映射文件。如果你使用的是基于XML的MyBatis配置文件，你可以在其中指定Mapper接口和XML文件的位置：

   <configuration>
       <mappers>
           <mapper class="com.example.mapper.UserMapper"/>
           <mapper resource="com/example/mapper/UserMapper.xml"/>
       </mappers>
   </configuration>
   

   如果你使用Java配置，你可以通过SqlSessionFactoryBean设置Mapper接口和XML映射文件的位置：

   @Bean
   public SqlSessionFactory sqlSessionFactory() throws Exception {
       SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
       sessionFactory.setDataSource(dataSource());
       sessionFactory.setMapperLocations(
           new PathMatchingResourcePatternResolver().getResources("classpath*:com/example/mapper/*.xml"));
       sessionFactory.setTypeAliasesPackage("com.example.domain");
       return sessionFactory.getObject();
   }
   

2. 注意Mapper接口和XML映射文件的匹配

   当你在Mapper接口和对应的XML文件中定义相同的映射方法时，需要确保它们能够正确匹配。这通常是通过确保XML文件中的namespace属性与Mapper接口的全路径名匹配，以及方法的id与接口方法名匹配来实现的。

3. 分别定义注解和XML映射

   你可以在Mapper接口中使用注解定义一些简单的SQL映射，而将更复杂的SQL语句和动态SQL放在XML映射文件中。

示例

假设你有一个UserMapper接口，你希望通过注解配置一个简单的查询方法，同时通过XML配置一个复杂的查询方法：

public interface UserMapper {
    @Select("SELECT * FROM users WHERE id = #{id}")
    User getUserById(int id);
}

然后，在UserMapper.xml中定义另一个方法的映射：

<mapper namespace="com.example.mapper.UserMapper">
    <select id="findUsersByName" resultType="com.example.domain.User">
        SELECT * FROM users WHERE name LIKE #{name}
    </select>
</mapper>

在上面的配置中，getUserById方法通过注解配置，而findUsersByName方法通过XML配置。这样，你就可以在同一个Mapper接口中享受到注解和XML两种配置方式的优势。

结论

MyBatis允许你灵活地使用XML和注解两种方式来配置SQL映射，甚至可以在同一个Mapper接口中混合使用这两种方式。这种混合配置方式既可以让你快速地通过注解配置简单的SQL语句，也可以利用XML配置的强大功能来处理更复杂的SQL和动态SQL。只需确保正确配置SqlSessionFactory，以便MyBatis能够识别并加载所有的映射信息。