SpringBoot中使用MyBatis-Plus實現(xiàn)分頁接口的詳細教程

更新時間：2024年03月29日 09:09:55 作者：洛可可白

MyBatis-Plus是一個MyBatis的增強工具,在MyBatis的基礎上只做增強不做改變,為簡化開發(fā)、提高效率而生,在SpringBoot項目中使用MyBatis-Plus可以大大簡化分頁邏輯的編寫,本文將介紹如何在 SpringBoot項目中使用MyBatis-Plus實現(xiàn)分頁接口

MyBatis-Plus分頁接口實現(xiàn)教程：Spring Boot中如何編寫分頁查詢

MyBatis-Plus 是一個 MyBatis 的增強工具，在 MyBatis 的基礎上只做增強不做改變，為簡化開發(fā)、提高效率而生。它提供了強大的分頁插件，可以輕松實現(xiàn)分頁查詢的功能。在 Spring Boot 項目中使用 MyBatis-Plus 可以大大簡化分頁邏輯的編寫。本文將介紹如何在 Spring Boot 項目中使用 MyBatis-Plus 實現(xiàn)分頁接口。

MyBatis-Plus 簡介

MyBatis-Plus（簡稱 MP）是 MyBatis 的一個增強工具，在 MyBatis 的基礎上只做增強不做改變，為簡化開發(fā)、提高效率而生。它提供了代碼生成器、分頁插件、性能分析插件、全局通用操作、MetaObject 等一系列功能，使得 MyBatis 變得更加易用。

Spring Boot 簡介

Spring Boot 是 Spring 的一個模塊，用于簡化新 Spring 應用的初始搭建以及開發(fā)過程。Spring Boot 旨在簡化配置，通過約定大于配置的原則，提供了大量的默認配置，使得開發(fā)者能夠快速啟動和部署 Spring 應用。

實現(xiàn)步驟

1. 添加 MyBatis-Plus 依賴

在 pom.xml 文件中添加 MyBatis-Plus 的依賴：

        <!--mybatis-plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.3.1</version>
        </dependency>

Springboot只能使用3.1.5及以下版本?。?！

2. 配置分頁插件

在 Spring Boot 的配置類中添加分頁插件的配置：

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
//@MapperScan("com.example.demo.mapper")
public class MybatisPlusConfig {

    /**
     * 新增分頁攔截器，并設置數(shù)據(jù)庫類型為mysql
     *
     * @return
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

3. 創(chuàng)建服務層接口

創(chuàng)建一個服務層接口，用于定義分頁查詢的方法：

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private UserMapper userMapper;

    @Override
    public Result listPageUser(@RequestParam Integer page, @RequestParam Integer pageSize) {
        //分頁參數(shù)
        Page<UserEntity> rowPage = new Page<>(page, pageSize);
        //queryWrapper組裝查詢where條件
        LambdaQueryWrapper<UserEntity> queryWrapper = new LambdaQueryWrapper<>();
        rowPage = userMapper.selectPage(rowPage, queryWrapper);
        return Result.success("數(shù)據(jù)列表", rowPage);
    }
}

4. 創(chuàng)建控制器

創(chuàng)建一個控制器，用于處理 HTTP 請求并調(diào)用服務層的分頁查詢方法：

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserServiceImpl userServiceImpl;

    @PostMapping("/listPage")
    @Operation(summary = "列表分頁")
    public Result listPageUser(@RequestParam Integer page, @RequestParam Integer pageSize) {
        return userServiceImpl.listPageUser(page, pageSize);
    }
}

5. 運行應用并測試

啟動 Spring Boot 應用，并通過 Postman 或其他 API 測試工具發(fā)送 POST 請求到 /user/listPage 端點，傳遞 page 和 pageSize 參數(shù)，即可測試分頁查詢功能。

6.全部代碼

import com.alibaba.excel.EasyExcel;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.example.common.req.IdParam;
import com.example.common.resp.Result;
import com.example.system.entity.UserEntity;
import com.example.system.mapper.UserMapper;
import com.example.system.resp.LoginResp;
import com.example.system.service.UserService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.servlet.http.HttpSession;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

import java.io.IOException;
import java.io.InputStream;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.text.SimpleDateFormat;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.Objects;

/**
 * <p>
 * 用戶表 前端控制器
 * </p>
 *
 * @author he
 * @since 2024-03-23
 */
@Tag(name = "用戶")
@RestController
@RequestMapping("/userEntity")
public class UserController {

    @Autowired
    private UserMapper userMapper;
    @Autowired
    private UserService userService;
    private final String id = "User_id";
    SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

    @Operation(summary = "列表")
    @PostMapping("/list")
    public Result listUser() {
        return Result.success("數(shù)據(jù)列表", userService.list());
    }

    @Operation(summary = "存在")
    @PostMapping("/exist")
    public Result existUser(@RequestBody @Validated IdParam param) {
        QueryWrapper<UserEntity> wrapper = new QueryWrapper<>();
        wrapper.eq(id.toLowerCase(Locale.ROOT), param.getId());
        long count = userService.count(wrapper);
        if (count == 0) return Result.success("ID不存在", false);
        return Result.success("ID已存在", true);
    }

    @Operation(summary = "保存")
    @PostMapping("/insert")
    public Result insertUser(@RequestBody @Validated UserEntity param) {
        QueryWrapper<UserEntity> wrapper = new QueryWrapper<>();
        wrapper.eq(id.toLowerCase(Locale.ROOT), param.getId());
        if (userService.count(wrapper) != 0) return Result.failure("ID已存在", sdf.format(new Date()));
        if (userService.save(param)) return Result.success("保存成功", sdf.format(new Date()));
        return Result.failure("保存失敗", sdf.format(new Date()));
    }

    @Operation(summary = "刪除")
    @PostMapping("/delete")
    public Result deleteUser(@RequestBody @Validated IdParam param) {
        QueryWrapper<UserEntity> wrapper = new QueryWrapper<>();
        wrapper.eq(id.toLowerCase(Locale.ROOT), param.getId());
        if (userService.count(wrapper) == 0) return Result.failure("ID不存在", param.getId());
        if (userService.remove(wrapper)) return Result.success("刪除成功", param.getId());
        return Result.failure("刪除失敗", param.getId());
    }

    @Operation(summary = "修改")
    @PostMapping("/update")
    public Result updateUser(@RequestBody @Validated UserEntity param) {
        QueryWrapper<UserEntity> wrapper = new QueryWrapper<>();
        wrapper.eq(id.toLowerCase(Locale.ROOT), param.getId());
        if (userService.count(wrapper) == 0) return Result.failure("ID不存在", sdf.format(new Date()));
        if (userService.updateById(param)) return Result.success("修改成功", sdf.format(new Date()));
        return Result.failure("修改失敗", sdf.format(new Date()));
    }

    @Operation(summary = "查詢")
    @PostMapping("/select")
    public Result selectUser(@RequestBody @Validated IdParam param) {
        QueryWrapper<UserEntity> wrapper = new QueryWrapper<>();
        wrapper.eq(id.toLowerCase(Locale.ROOT), param.getId());
        if (userService.count(wrapper) == 0) return Result.failure("ID不存在", param.getId());
        return Result.success(userService.getOne(wrapper));
    }

    @Operation(summary = "查詢byAcc")
    @PostMapping("/selectByAcc/{param}")
    public Result selectUserByAcc(@PathVariable @Validated String param) {
        QueryWrapper<UserEntity> wrapper = new QueryWrapper<>();
        String acc = "User_acc";
        wrapper.eq(acc.toLowerCase(Locale.ROOT), param);
        if (userService.count(wrapper) == 0) return Result.failure("賬號不存在", sdf.format(new Date()));
        return Result.success(userService.getOne(wrapper));
    }

    @Operation(summary = "列表分頁")
    @PostMapping("/listPage")
    public Result listPageUser(@RequestParam Integer page, @RequestParam Integer pageSize) {
        //分頁參數(shù)
        Page<UserEntity> rowPage = new Page(page, pageSize);
        //queryWrapper組裝查詢where條件
        LambdaQueryWrapper<UserEntity> queryWrapper = new LambdaQueryWrapper<>();
        rowPage = userMapper.selectPage(rowPage, queryWrapper);
        return Result.success("數(shù)據(jù)列表", rowPage);
    }

    @Operation(summary = "導出數(shù)據(jù)")
    @PostMapping("exportExcel")
    public void exportExcelUser(HttpServletResponse response) throws IOException {
        response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
        response.setCharacterEncoding("utf-8");
        String fileName = URLEncoder.encode("輪播圖", StandardCharsets.UTF_8).replaceAll("\\+", "%20");
        List<UserEntity> list = userService.list();
        response.setHeader("Content-disposition", "attachment;filename*=" + fileName + ".xlsx");
        EasyExcel.write(response.getOutputStream(), UserEntity.class).sheet("輪播圖").doWrite(list);
    }

    @Operation(summary = "導入數(shù)據(jù)")
    @PostMapping("/importExcel")
    public Result importExcelUser(MultipartFile file) {
        try {
            //獲取文件的輸入流
            InputStream inputStream = file.getInputStream();
            List<UserEntity> list = EasyExcel.read(inputStream) //調(diào)用read方法
                    //注冊自定義監(jiān)聽器，字段校驗可以在監(jiān)聽器內(nèi)實現(xiàn)
                    //.registerReadListener(new UserListener())
                    .head(UserEntity.class) //對應導入的實體類
                    .sheet(0) //導入數(shù)據(jù)的sheet頁編號，0代表第一個sheet頁，如果不填，則會導入所有sheet頁的數(shù)據(jù)
                    .headRowNumber(1) //列表頭行數(shù)，1代表列表頭有1行，第二行開始為數(shù)據(jù)行
                    .doReadSync();//開始讀Excel，返回一個List<T>集合，繼續(xù)后續(xù)入庫操作
            //模擬導入數(shù)據(jù)庫操作
            for (UserEntity entity : list) {
                userService.saveOrUpdate(entity);
            }
            return Result.success("導入成功", sdf.format(new Date()));
        } catch (IOException exception) {
            throw new RuntimeException(exception);
        }
    }

}

結語

通過上述步驟，我們在 Spring Boot 項目中使用 MyBatis-Plus 實現(xiàn)了一個分頁查詢接口。MyBatis-Plus 提供的分頁插件極大地簡化了分頁邏輯的編寫，使得開發(fā)者能夠更專注于業(yè)務邏輯的實現(xiàn)。通過學習和實踐，你可以更深入地理解 MyBatis-Plus 和 Spring Boot 的強大功能，以及如何將它們應用到實際的開發(fā)工作中。

以上就是SpringBoot中使用MyBatis-Plus實現(xiàn)分頁接口的詳細教程的詳細內(nèi)容，更多關于SpringBoot MyBatis-Plus分頁接口的資料請關注腳本之家其它相關文章！

您可能感興趣的文章: