SpringBoot与Mybatis-plus实战

随着互联网技术的快速发展,企业级应用对开发效率和性能的要求越来越高。Spring Boot 作为一款快速开发框架,以其简洁、快速、配置方便等优点,得到了广泛的应用。而 MyBatis-Plus 作为 MyBatis 的增强工具,在简化开发、提高效率方面有着显著优势。本文将详细介绍如何在 Spring Boot 项目中集成 MyBatis-Plus,通过具体案例展示其强大功能。

二、基础环境搭建

2.1 创建 Spring Boot 项目

首先,我们使用 Spring Initializr 创建一个基础的 Spring Boot 项目。选择以下依赖:

  • Spring Web
  • MySQL Driver
  • MyBatis-Plus Boot Starter

创建项目后,项目结构如下:

├── src
│   ├── main
│   │   ├── java
│   │   │   └── com
│   │   │       └── example
│   │   │           └── mybatisplusdemo
│   │   │               ├── MybatisplusdemoApplication.java
│   │   │               ├── controller
│   │   │               ├── entity
│   │   │               ├── mapper
│   │   │               ├── service
│   │   │               └── service
│   │   │                   └── impl
│   │   └── resources
│   │       ├── application.yml
│   │       └── mapper
│   │           └── UserMapper.xml
└── pom.xml

2.2 配置数据库连接

application.yml 中配置数据库连接信息:

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatisplusdemo?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
    username: root
    password: root

mybatis-plus:
  mapper-locations: classpath:/mapper/*.xml
  type-aliases-package: com.example.mybatisplusdemo.entity

2.3 创建数据库表

我们以用户信息表为例,创建 user 表:

CREATE TABLE `user` (
  `id` BIGINT(20) NOT NULL AUTO_INCREMENT COMMENT '主键ID',
  `name` VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
  `age` INT(11) NULL DEFAULT NULL COMMENT '年龄',
  `email` VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

三、MyBatis-Plus 基本使用

3.1 创建实体类

entity 包下创建 User 实体类:

package com.example.mybatisplusdemo.entity;

import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;

@Data
@TableName("user")
public class User {
    @TableId
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

3.2 创建 Mapper 接口

mapper 包下创建 UserMapper 接口:

package com.example.mybatisplusdemo.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.mybatisplusdemo.entity.User;
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface UserMapper extends BaseMapper<User> {
}

3.3 配置 MyBatis-Plus

application 类中添加 @MapperScan 注解:

package com.example.mybatisplusdemo;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.example.mybatisplusdemo.mapper")
public class MybatisplusdemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(MybatisplusdemoApplication.class, args);
    }
}

3.4 创建 Service 层

service 包下创建 UserService 接口:

package com.example.mybatisplusdemo.service;

import com.baomidou.mybatisplus.extension.service.IService;
import com.example.mybatisplusdemo.entity.User;

public interface UserService extends IService<User> {
}

service.impl 包下创建 UserServiceImpl 实现类:

package com.example.mybatisplusdemo.service.impl;

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.example.mybatisplusdemo.entity.User;
import com.example.mybatisplusdemo.mapper.UserMapper;
import com.example.mybatisplusdemo.service.UserService;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
}

3.5 创建 Controller 层

controller 包下创建 UserController 控制器:

package com.example.mybatisplusdemo.controller;

import com.example.mybatisplusdemo.entity.User;
import com.example.mybatisplusdemo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

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

    @Autowired
    private UserService userService;

    @GetMapping("/list")
    public List<User> list() {
        return userService.list();
    }

    @PostMapping("/add")
    public boolean add(@RequestBody User user) {
        return userService.save(user);
    }

    @PutMapping("/update")
    public boolean update(@RequestBody User user) {
        return userService.updateById(user);
    }

    @DeleteMapping("/delete/{id}")
    public boolean delete(@PathVariable Long id) {
        return userService.removeById(id);
    }
}

至此,一个简单的 Spring Boot 与 MyBatis-Plus 项目就搭建完成了。下面我们将深入了解 MyBatis-Plus 的更多高级功能。

四、MyBatis-Plus 高级功能

4.1 条件构造器

MyBatis-Plus 提供了丰富的条件构造器,能够轻松实现复杂的查询需求。以下是一些常见的条件构造器示例。

4.1.1 使用 QueryWrapper 进行查询
package com.example.mybatisplusdemo.controller;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.example.mybatisplusdemo.entity.User;
import com.example.mybatisplusdemo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

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

    @Autowired
    private UserService userService;

    @GetMapping("/list")
    public List<User> list() {
        return userService.list();
    }

    @GetMapping("/findByName")
    public List<User> findByName(@RequestParam String name) {
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.eq("name", name);
        return userService.list(queryWrapper);
    }

    @PostMapping("/add")
    public boolean add(@RequestBody User user) {
        return userService.save(user);
    }

    @PutMapping("/update")
    public boolean update(@RequestBody User user) {
        return userService.updateById(user);
    }

    @DeleteMapping("/delete/{id}")
    public boolean delete(@PathVariable Long id) {
        return userService.removeById(id);
    }
}
4.1.2 使用 LambdaQueryWrapper 进行查询
package com.example.mybatisplusdemo.controller;

import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.example.mybatisplusdemo.entity.User;
import com.example.mybatisplusdemo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

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

    @Autowired
    private UserService userService;

    @GetMapping("/list")
    public List<User> list() {
        return userService.list();
    }

    @GetMapping("/findByAge")
    public List<User> findByAge(@RequestParam Integer age) {
        LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
        queryWrapper.eq(User::getAge, age);
        return userService.list(queryWrapper);
    }

    @PostMapping("/add")
    public boolean add(@RequestBody User user) {
        return userService.save(user);
    }

    @PutMapping("/update")
    public boolean update(@RequestBody User user) {
        return userService.updateById(user);
    }

    @DeleteMapping("/delete/{id}")
    public boolean delete(@PathVariable Long id) {
        return userService.removeById(id);
    }
}

4.2 分页查询

MyBatis-Plus 提供了简单易用的分页查询功能。以下示例展示了如何使用分页查询。

4.2.1 配置分页插件

在配置类中添加分页插件:

package com.example.mybatisplusdemo.config;

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();
    }
}
4.2.2 使用分页查询
package com.example.mybatisplusdemo.controller;

import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.example.mybatisplusdemo.entity.User;
import com.example.mybatisplusdemo.service.User

Service;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

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

    @Autowired
    private UserService userService;

    @GetMapping("/list")
    public List<User> list() {
        return userService.list();
    }

    @GetMapping("/findByAge")
    public List<User> findByAge(@RequestParam Integer age) {
        LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
        queryWrapper.eq(User::getAge, age);
        return userService.list(queryWrapper);
    }

    @GetMapping("/page")
    public Page<User> page(@RequestParam Integer pageNum, @RequestParam Integer pageSize) {
        return userService.page(new Page<>(pageNum, pageSize));
    }

    @PostMapping("/add")
    public boolean add(@RequestBody User user) {
        return userService.save(user);
    }

    @PutMapping("/update")
    public boolean update(@RequestBody User user) {
        return userService.updateById(user);
    }

    @DeleteMapping("/delete/{id}")
    public boolean delete(@PathVariable Long id) {
        return userService.removeById(id);
    }
}

4.3 逻辑删除

MyBatis-Plus 支持逻辑删除,即在删除记录时并不实际删除数据,而是标记删除状态。

4.3.1 配置逻辑删除

在实体类中添加逻辑删除注解:

package com.example.mybatisplusdemo.entity;

import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableLogic;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;

@Data
@TableName("user")
public class User {
    @TableId
    private Long id;
    private String name;
    private Integer age;
    private String email;
    @TableLogic
    private Integer deleted;
}
4.3.2 更新数据库表

更新数据库表,添加逻辑删除字段:

ALTER TABLE `user` ADD `deleted` INT(1) NOT NULL DEFAULT 0 COMMENT '逻辑删除标志';
4.3.3 使用逻辑删除

UserController 中,删除记录时逻辑删除:

package com.example.mybatisplusdemo.controller;

import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.example.mybatisplusdemo.entity.User;
import com.example.mybatisplusdemo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

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

    @Autowired
    private UserService userService;

    @GetMapping("/list")
    public List<User> list() {
        return userService.list();
    }

    @GetMapping("/findByAge")
    public List<User> findByAge(@RequestParam Integer age) {
        LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
        queryWrapper.eq(User::getAge, age);
        return userService.list(queryWrapper);
    }

    @GetMapping("/page")
    public Page<User> page(@RequestParam Integer pageNum, @RequestParam Integer pageSize) {
        return userService.page(new Page<>(pageNum, pageSize));
    }

    @PostMapping("/add")
    public boolean add(@RequestBody User user) {
        return userService.save(user);
    }

    @PutMapping("/update")
    public boolean update(@RequestBody User user) {
        return userService.updateById(user);
    }

    @DeleteMapping("/delete/{id}")
    public boolean delete(@PathVariable Long id) {
        return userService.removeById(id);
    }
}

4.4 自动填充

MyBatis-Plus 支持自动填充功能,可以在插入或更新数据时自动填充指定字段。

4.4.1 配置自动填充

在实体类中添加自动填充注解:

package com.example.mybatisplusdemo.entity;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;

import java.time.LocalDateTime;

@Data
@TableName("user")
public class User {
    @TableId
    private Long id;
    private String name;
    private Integer age;
    private String email;
    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime createTime;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime updateTime;
}
4.4.2 配置自动填充处理器

创建自动填充处理器:

package com.example.mybatisplusdemo.handler;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        this.strictInsertFill(metaObject, "createTime", LocalDateTime::now, LocalDateTime.class);
        this.strictInsertFill(metaObject, "updateTime", LocalDateTime::now, LocalDateTime.class);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.strictUpdateFill(metaObject, "updateTime", LocalDateTime::now, LocalDateTime.class);
    }
}

五、总结

本文详细介绍了如何在 Spring Boot 项目中集成 MyBatis-Plus,涵盖了基础配置、实体类创建、Mapper 接口编写、Service 层实现以及 Controller 层的基本操作。同时,深入探讨了 MyBatis-Plus 的高级功能,包括条件构造器、分页查询、逻辑删除和自动填充。通过这些内容,读者可以全面了解和掌握 MyBatis-Plus 的使用方法,从而在实际项目中提升开发效率和代码质量。

希望本文对您有所帮助,如果在使用过程中遇到问题,建议查阅 MyBatis-Plus 官方文档或社区资源,获取更多支持和帮助。

  • 18
    点赞
  • 14
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值