MyBatis-Plus自定義SQL和復(fù)雜查詢的實(shí)現(xiàn)

更新時(shí)間：2024年10月13日 09:17:34 作者：Flying_Fish_Xuan

MyBatis-Plus增強(qiáng)了MyBatis的功能,提供注解和XML兩種自定義SQL方式,支持復(fù)雜查詢?nèi)缍啾黻P(guān)聯(lián)、動(dòng)態(tài)分頁(yè)等,通過(guò)注解如@Select、@Insert、@Update、@Delete實(shí)現(xiàn)CRUD操作,本文就來(lái)介紹一下,感興趣的可以了解一下

MyBatis-Plus 是 MyBatis 的增強(qiáng)版，提供了許多開箱即用的 CRUD 操作。然而，在實(shí)際項(xiàng)目中，開發(fā)者常常需要編寫自定義 SQL 以處理更復(fù)雜的查詢需求。MyBatis-Plus 提供了靈活的機(jī)制，允許開發(fā)者通過(guò)注解或 XML 自定義 SQL，同時(shí)也能支持復(fù)雜查詢、動(dòng)態(tài) SQL 等高級(jí)操作。

1. 自定義 SQL 的兩種方式

MyBatis-Plus 支持兩種自定義 SQL 的方式：

注解方式：直接在 Mapper 接口上通過(guò)注解編寫 SQL 語(yǔ)句。
XML 方式：通過(guò) Mapper 配置文件的方式編寫自定義 SQL。

2. 通過(guò)注解編寫自定義 SQL

MyBatis-Plus 支持在 Mapper 接口方法上直接使用注解編寫 SQL 語(yǔ)句。常見(jiàn)的注解包括：

@Select：用于查詢。
@Insert：用于插入。
@Update：用于更新。
@Delete：用于刪除。

2.1 查詢示例

假設(shè)有一個(gè) User 表，包含 id、username 和 email 字段。通過(guò)注解編寫自定義 SQL 查詢用戶信息：

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.demo.model.User;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;

import java.util.List;

@Mapper
public interface UserMapper extends BaseMapper<User> {

    // 根據(jù)用戶名查詢用戶
    @Select("SELECT * FROM user WHERE username = #{username}")
    User findByUsername(String username);

    // 查詢所有用戶
    @Select("SELECT * FROM user")
    List<User> findAll();
}

2.2 插入示例

通過(guò)注解實(shí)現(xiàn)插入用戶記錄：

import org.apache.ibatis.annotations.Insert;

@Mapper
public interface UserMapper extends BaseMapper<User> {

    @Insert("INSERT INTO user (username, email) VALUES (#{username}, #{email})")
    void insertUser(User user);
}

2.3 動(dòng)態(tài) SQL

MyBatis-Plus 還支持通過(guò) @SelectProvider、@UpdateProvider 等注解來(lái)實(shí)現(xiàn)動(dòng)態(tài) SQL。以下是通過(guò) @SelectProvider 動(dòng)態(tài)生成查詢 SQL 的示例：

import org.apache.ibatis.annotations.SelectProvider;
import org.apache.ibatis.builder.annotation.ProviderContext;
import java.util.Map;

@Mapper
public interface UserMapper extends BaseMapper<User> {

    @SelectProvider(type = SqlProvider.class, method = "findByCondition")
    List<User> findByCondition(Map<String, Object> conditions);

    class SqlProvider {
        public String findByCondition(Map<String, Object> params, ProviderContext context) {
            StringBuilder sql = new StringBuilder("SELECT * FROM user WHERE 1=1");
            if (params.get("username") != null) {
                sql.append(" AND username = #{username}");
            }
            if (params.get("email") != null) {
                sql.append(" AND email = #{email}");
            }
            return sql.toString();
        }
    }
}

在此示例中，通過(guò) @SelectProvider 動(dòng)態(tài)生成 SQL，根據(jù)傳入的條件查詢用戶。

3. 通過(guò) XML 編寫自定義 SQL

除了注解方式，MyBatis-Plus 還支持通過(guò) XML 文件編寫自定義 SQL。XML 配置的方式可以編寫更復(fù)雜、靈活的查詢和動(dòng)態(tài) SQL。

3.1 XML 配置基本結(jié)構(gòu)

首先，在 resources/mapper/ 目錄下創(chuàng)建 UserMapper.xml，并通過(guò) namespace 綁定 UserMapper 接口。

<?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.demo.mapper.UserMapper">

    <!-- 查詢所有用戶 -->
    <select id="findAll" resultType="com.example.demo.model.User">
        SELECT * FROM user
    </select>

    <!-- 根據(jù)用戶名查詢用戶 -->
    <select id="findByUsername" resultType="com.example.demo.model.User">
        SELECT * FROM user WHERE username = #{username}
    </select>

    <!-- 插入用戶 -->
    <insert id="insertUser">
        INSERT INTO user (username, email) VALUES (#{username}, #{email})
    </insert>

</mapper>

3.2 XML 動(dòng)態(tài) SQL 示例

MyBatis 的動(dòng)態(tài) SQL 標(biāo)簽可以用于構(gòu)建靈活的 SQL 語(yǔ)句，常見(jiàn)的動(dòng)態(tài) SQL 標(biāo)簽有：

<if>：根據(jù)條件拼接 SQL。
<choose>：類似于 switch-case。
<where>：智能拼接條件。
<foreach>：用于處理集合（如 IN 查詢）。

以下示例展示如何使用動(dòng)態(tài) SQL 實(shí)現(xiàn)根據(jù)條件查詢用戶：

<select id="findByCondition" resultType="com.example.demo.model.User">
    SELECT * FROM user
    <where>
        <if test="username != null">
            AND username = #{username}
        </if>
        <if test="email != null">
            AND email = #{email}
        </if>
    </where>
</select>

4. 復(fù)雜查詢的實(shí)現(xiàn)

在實(shí)際開發(fā)中，復(fù)雜查詢經(jīng)常涉及多表關(guān)聯(lián)查詢、分頁(yè)、動(dòng)態(tài)條件查詢等。MyBatis-Plus 提供了良好的支持，結(jié)合 SQL 注解、XML 和查詢構(gòu)造器等機(jī)制，可以實(shí)現(xiàn)靈活的復(fù)雜查詢。

4.1 多表關(guān)聯(lián)查詢

MyBatis-Plus 支持通過(guò)自定義 SQL 實(shí)現(xiàn)多表關(guān)聯(lián)查詢（如 JOIN 查詢）。

<select id="findUserWithRole" resultType="com.example.demo.model.User">
    SELECT u.id, u.username, r.role_name
    FROM user u
    LEFT JOIN role r ON u.role_id = r.id
    WHERE u.id = #{id}
</select>

在此示例中，user 表通過(guò) role_id 關(guān)聯(lián) role 表，查詢用戶的角色信息。

4.2 動(dòng)態(tài)分頁(yè)查詢

結(jié)合 MyBatis-Plus 提供的分頁(yè)插件和動(dòng)態(tài) SQL，可以實(shí)現(xiàn)復(fù)雜的分頁(yè)查詢。首先，需要引入分頁(yè)插件：

import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MyBatisPlusConfig {

    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }
}

然后在 UserMapper.xml 中實(shí)現(xiàn)分頁(yè)查詢：

<select id="findByCondition" resultType="com.example.demo.model.User">
    SELECT * FROM user
    <where>
        <if test="username != null">
            AND username = #{username}
        </if>
        <if test="email != null">
            AND email = #{email}
        </if>
    </where>
</select>

在服務(wù)層調(diào)用時(shí)使用分頁(yè)功能：

import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.example.demo.mapper.UserMapper;
import com.example.demo.model.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.Map;

@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    public Page<User> findUsersByCondition(Page<User> page, Map<String, Object> conditions) {
        return userMapper.findByCondition(page, conditions);
    }
}

5. 使用查詢構(gòu)造器進(jìn)行復(fù)雜查詢

MyBatis-Plus 提供了一個(gè)查詢構(gòu)造器 Wrapper，用于簡(jiǎn)化條件查詢。常見(jiàn)的查詢構(gòu)造器有：

QueryWrapper：用于構(gòu)建查詢條件。
UpdateWrapper：用于構(gòu)建更新條件。

5.1 使用 QueryWrapper 進(jìn)行復(fù)雜查詢

QueryWrapper 是 MyBatis-Plus 提供的條件構(gòu)造器，允許開發(fā)者使用鏈?zhǔn)秸Z(yǔ)法構(gòu)建查詢條件。

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.example.demo.mapper.UserMapper;
import com.example.demo.model.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    public List<User> findUsersByCondition(String username, String email) {
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.eq(username != null, "username", username)
                    .like(email != null, "email", email);
        return userMapper.selectList(queryWrapper);
    }
}

在此示例中，QueryWrapper 用于根據(jù)條件動(dòng)態(tài)構(gòu)建 SQL 查詢，eq 和 like 方法會(huì)根據(jù)傳入的參數(shù)生成相應(yīng)的 SQL 語(yǔ)句。

5.2 使用 UpdateWrapper 進(jìn)行復(fù)雜更新

類似于查詢，UpdateWrapper 用于構(gòu)建更新條件。

import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;

public

 void updateUserEmail(Integer id, String email) {
    UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
    updateWrapper.eq("id", id).set("email", email);
    userMapper.update(null, updateWrapper);
}

6. 總結(jié)

MyBatis-Plus 提供了靈活的自定義 SQL 和復(fù)雜查詢機(jī)制，支持通過(guò)注解、XML 和查詢構(gòu)造器實(shí)現(xiàn)靈活的數(shù)據(jù)庫(kù)操作。

注解方式：簡(jiǎn)單、直觀，適合快速開發(fā)常見(jiàn)的 SQL 操作。
XML 方式：適用于復(fù)雜 SQL 和動(dòng)態(tài) SQL，通過(guò) MyBatis 提供的標(biāo)簽，可以靈活地編寫條件查詢、多表關(guān)聯(lián)查詢等。
查詢構(gòu)造器：通過(guò) QueryWrapper 和 UpdateWrapper，開發(fā)者可以以鏈?zhǔn)秸Z(yǔ)法構(gòu)建復(fù)雜查詢條件。

到此這篇關(guān)于MyBatis-Plus自定義SQL和復(fù)雜查詢的實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)MyBatis-Plus自定義SQL和復(fù)雜查詢內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: