MyBatis中常見的SQL執(zhí)行方式及其使用方法

更新時間：2023年09月28日 11:00:32 作者：stormjun

MyBatis可能很多人都一直在用,但是MyBatis的SQL執(zhí)行流程可能并不是所有人都清楚了,下面這篇文章主要給大家介紹了關于MyBatis中常見的SQL執(zhí)行方式及其使用的相關資料,需要的朋友可以參考下

引言

MyBatis 是一個基于 Java 的持久層框架，它提供了多種方式來執(zhí)行 SQL 語句，包括直接使用 SqlSession 執(zhí)行、使用映射器（Mapper）執(zhí)行、使用 SqlSessionTemplate 執(zhí)行等。本文將介紹 MyBatis 中常見的 SQL 執(zhí)行方式及其使用方法。

1. 直接使用 SqlSession 執(zhí)行 SQL 語句

在 MyBatis 中，可以通過 SqlSession 對象直接執(zhí)行 SQL 語句。SqlSession 是 MyBatis 的核心類之一，它負責與數(shù)據(jù)庫進行交互和管理事務。SqlSession 提供了多個方法來執(zhí)行 SQL 語句，比如 selectOne、selectList、insert、update 和 delete 等。下面是一個簡單的示例：

public class MyBatisTest {
    public static void main(String[] args) {
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        SqlSession sqlSession = sqlSessionFactory.openSession();
        try {
            // 執(zhí)行查詢語句
            User user = sqlSession.selectOne("com.example.mapper.UserMapper.getUserById", 1);
            System.out.println(user);
            // 執(zhí)行插入語句
            User newUser = new User();
            newUser.setName("Tom");
            newUser.setAge(20);
            int result = sqlSession.insert("com.example.mapper.UserMapper.addUser", newUser);
            System.out.println(result);
            sqlSession.commit();
        } finally {
            sqlSession.close();
        }
    }
}

在上面的示例代碼中，首先讀取了配置文件 mybatis-config.xml，然后通過 SqlSessionFactoryBuilder 將配置文件解析為 SqlSessionFactory 對象，最后通過 SqlSessionFactory 創(chuàng)建 SqlSession 對象。在 SqlSession 中，可以通過 selectOne、selectList、insert、update 和 delete 等方法執(zhí)行 SQL 語句。其中，selectOne 方法用于查詢單個結果，selectList 方法用于查詢多個結果，insert、update 和 delete 方法用于執(zhí)行更新或刪除操作。這些方法的第一個參數(shù)為 SQL 語句的 ID，格式為 “namespace.statementId”，其中 namespace 為映射器的命名空間，statementId 為 SQL 語句的 ID。

2. 使用映射器（Mapper）執(zhí)行 SQL 語句

除了直接使用 SqlSession 執(zhí)行 SQL 語句外，還可以通過映射器（Mapper）執(zhí)行 SQL 語句。映射器是 MyBatis 中用于定義 SQL 語句和 Java 對象之間映射關系的接口，它可以通過 XML 或注解的方式進行定義。下面是一個簡單的映射器示例：

public interface UserMapper {
    // 查詢用戶信息
    User getUserById(int id);
    // 添加用戶信息
    int addUser(User user);
}

在上面的示例代碼中，定義了一個名為 UserMapper 的映射器接口，其中包含了兩個方法：getUserById 和 addUser。這兩個方法的實現(xiàn)方式與直接使用 SqlSession 執(zhí)行 SQL 語句的方式類似，只不過將 SQL 語句和參數(shù)映射的工作放在了映射器接口中。下面是一個使用映射器執(zhí)行 SQL 語句的示例：

public class MyBatisTest {
    public static void main(String[] args) {
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        SqlSession sqlSession = sqlSessionFactory.openSession();
        try {
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            // 執(zhí)行查詢語句
            User user = userMapper.getUserById(1);
            System.out.println(user);
            // 執(zhí)行插入語句
            User newUser = new User();
            newUser.setName("Tom");
            newUser.setAge(20);
            int result = userMapper.addUser(newUser);
            System.out.println(result);
            sqlSession.commit();
        } finally {
            sqlSession.close();
        }
    }
}

在上面的示例代碼中，首先讀取了配置文件 mybatis-config.xml，然后通過 SqlSessionFactoryBuilder 將配置文件解析為SqlSessionFactory 對象，最后通過 SqlSessionFactory 創(chuàng)建 SqlSession 對象。在 SqlSession 中，通過 getMapper 方法獲取映射器接口的實例，然后就可以直接調用映射器接口中的方法執(zhí)行 SQL 語句了。

3. 使用 SqlSessionTemplate 執(zhí)行 SQL 語句

除了直接使用 SqlSession 和映射器執(zhí)行 SQL 語句外，還可以使用 SqlSessionTemplate 執(zhí)行 SQL 語句。SqlSessionTemplate 是 MyBatis-Spring 模塊提供的一個類，它封裝了 SqlSession 的常用操作，可以方便地在 Spring 框架中使用。下面是一個簡單的示例：

public class UserServiceImpl implements UserService {
    private SqlSessionTemplate sqlSessionTemplate;
    public void setSqlSessionTemplate(SqlSessionTemplate sqlSessionTemplate) {
        this.sqlSessionTemplate = sqlSessionTemplate;
    }
    @Override
    public User getUserById(int id) {
        return sqlSessionTemplate.selectOne("com.example.mapper.UserMapper.getUserById", id);
    }
    @Override
    public int addUser(User user) {
        return sqlSessionTemplate.insert("com.example.mapper.UserMapper.addUser", user);
    }
}

在上面的示例代碼中，通過注入 SqlSessionTemplate 對象來執(zhí)行 SQL 語句。SqlSessionTemplate 提供了多個方法來執(zhí)行 SQL 語句，包括 selectOne、selectList、insert、update 和 delete 等。這些方法的使用方式與直接使用 SqlSession 執(zhí)行 SQL 語句的方式類似。

4. SQL 語句的參數(shù)映射

在執(zhí)行 SQL 語句時，需要將 SQL 語句中的參數(shù)映射到 Java 對象中。MyBatis 提供了多種方式來實現(xiàn)參數(shù)映射，包括基本類型參數(shù)、JavaBean 參數(shù)、Map 參數(shù)和注解參數(shù)等。下面是一個簡單的示例：

public interface UserMapper {
    // 查詢用戶信息
    User getUserById(int id);
    // 添加用戶信息
    int addUser(User user);
    // 查詢用戶信息，使用 Map 參數(shù)
    User getUserByIdMap(Map<String, Object> paramMap);
    // 添加用戶信息，使用注解參數(shù)
    @Insert("insert into user(name, age) values(#{user.name}, #{user.age})")
    int addUserAnnotation(@Param("user") User user);
}

在上面的示例代碼中，getUserById 和 addUser 方法使用了 JavaBean 參數(shù)，getUserByIdMap 方法使用了 Map 參數(shù)，addUserAnnotation 方法使用了注解參數(shù)。在使用 JavaBean 參數(shù)和 Map 參數(shù)時，需要將 SQL 語句中的參數(shù)與 Java 對象的屬性進行映射。在使用注解參數(shù)時，需要在 SQL 語句中使用 #{paramName} 的方式，其中 paramName 為注解參數(shù)的名稱。

5. SQL 語句的返回結果映射

在執(zhí)行 SQL 語句時，需要將 SQL 語句中的返回結果映射到 Java 對象中。MyBatis 提供了多種方式來實現(xiàn)返回結果映射，包括基本類型返回、JavaBean 返回、Map 返回和注解返回等。下面是一個簡單的示例：

public interface UserMapper {
    // 查詢用戶信息，返回 JavaBean
    User getUserById(int id);
    // 查詢用戶信息，返回 Map
    Map<String, Object> getUserByIdMap(int id);
    // 查詢用戶信息，使用注解返回
    @Select("select name, age from user where id=#{id}")
    @Results({
            @Result(property = "name", column = "name"),
            @Result(property = "age", column = "age")
    })
    User getUserByIdAnnotation(int id);
}

在上面的示例代碼中，getUserById 方法返回了一個 JavaBean，getUserByIdMap 方法返回了一個 Map，getUserByIdAnnotation 方法使用了注解返回。在使用注解返回時，需要在 SQL 語句中使用 @Results 和 @Result 注解將查詢結果與 JavaBean 的屬性進行映射。