Spring Boot整合Mybatis-Plus 增删改查+ 分页基本使用完整示例

一时失言乱红尘 2023-10-07 12:31 23阅读 0赞

### 写在前面 ###

MyBatis的增强方案确实有不少，甚至有种感觉是现在如果只用 “裸MyBatis”，不来点增强插件都不好意思了。这不，在上一篇文章[《Spring Boot项目利用MyBatis Generator进行数据层代码自动生成》][Spring Boot_MyBatis Generator] 中尝试了一下 MyBatis Generator。这次来点更加先进的 Mybatis-Plus，SQL语句都不用写了，分页也是自动完成，嗯，真香！

--------------------

### 数据库准备 ###

CREATE TABLE tbl_user
    (
    	user_id BIGINT(20) NOT NULL COMMENT '主键ID',
    	user_name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
    	user_age INT(11) NULL DEFAULT NULL COMMENT '年龄',
    	PRIMARY KEY (user_id)
    ) charset = utf8;

--------------------

### MyBatis-Plus加持 ###

*  **工程搭建** （不赘述了）
 *  **依赖引入**

<dependency>
    	<groupId>com.baomidou</groupId>
    	<artifactId>mybatis-plus-boot-starter</artifactId>
    	<version>3.1.0</version>
    </dependency>
    
    <dependency>
    	<groupId>org.projectlombok</groupId>
    	<artifactId>lombok</artifactId>
    </dependency>
    
    <dependency>
    	<groupId>com.alibaba</groupId>
    	<artifactId>druid-spring-boot-starter</artifactId>
    	<version>1.1.9</version>
    </dependency>
    
    <dependency>
    	<groupId>mysql</groupId>
    	<artifactId>mysql-connector-java</artifactId>
    	<scope>runtime</scope>
    	<version>8.0.12</version>
    </dependency>

主要是 Mybatis Plus、Lombok（不知道Lombok干嘛的？[可以看这里][Link 1]）、Druid连接池 等依赖。

*  **MyBatis Plus配置**

项目配置

mybatis-plus:
      mapper-locations: classpath:/mapper/*Mapper.xml

新增 MyBatis Plus配置类

@Configuration
    @MapperScan("cn.codesheep.springbtmybatisplus.mapper")
    public class MyBatisConfig {
        
    }

> 看到没，几乎零配置啊，下面就可以写业务逻辑了

--------------------

### 业务编写 ###

*  **实体类**

@Data
    @TableName("tbl_user")
    public class User {
        
        @TableId(value = "user_id")
        private Long userId;
        private String userName;
        private Integer userAge;
    }

*  **Mapper类**

public interface UserMapper extends BaseMapper<User> {
        
    }

> 这里啥接口方法也不用写，就可以实现增删改查了！

*  **Service类**

Service接口：

public interface UserService extends IService<User> {
        
        int insertUser( User user );
        int updateUser( User user );
        int deleteUser( User user );
        User findUserByName( String userName );
        IPage getUserPage( Page page, User user );
    }

Service实现：

@Service
    @AllArgsConstructor
    public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
        
    
        // 增
        @Override
        public int insertUser(User user) {
        
            return baseMapper.insert( user );
        }
    
        // 改
        @Override
        public int updateUser(User user) {
        
            return baseMapper.updateById( user );
        }
    
        // 删
        @Override
        public int deleteUser(User user) {
        
            return baseMapper.deleteById( user.getUserId() );
        }
    
        // 查
        @Override
        public User findUserByName( String userName ) {
        
            return baseMapper.getUserByName( userName );
        }
    }

*  **Controller类**

@RestController
    @RequestMapping("/user")
    public class UserContorller {
        
    
        @Autowired
        private UserService userService;
    
        // 增
        @PostMapping( value = "/insert")
        public Object insert( @RequestBody User user ) {
        
            return userService.insertUser( user );
        }
    
        // 改
        @PostMapping( value = "/update")
        public Object update( @RequestBody User user ) {
        
            return userService.updateUser( user );
        }
    
        // 删
        @PostMapping( value = "/delete")
        public Object delete( @RequestBody User user ) {
        
            return userService.deleteUser( user );
        }
    
        // 查
        @GetMapping( value = "/getUserByName")
        public Object getUserByName( @RequestParam String userName ) {
        
            return userService.findUserByName( userName );
        }
    }

通过以上几个简单的步骤，我们就实现了 `tbl_user`表的增删改查，传统 MyBatis的 XML文件一个都不需要写！

--------------------

### 实际实验【《乡爱》加持】 ###

*  **启动项目**

很牛批的 logo就会出现

[![Mybatis Plus Logo][]][Mybatis Plus Logo 1]Mybatis Plus Logo

接下来通过 Postman来发送增删改查的请求

*  **插入记录**

通过 Postman随便插入几条记录 `POST localhost:8089/user/insert`

{
        "userId":3,"userName":"刘能","userAge":"58"}
    {
        "userId":4,"userName":"赵四","userAge":"58"}
    {
        "userId":5,"userName":"谢广坤","userAge":"58"}
    {
        "userId":6,"userName":"刘大脑袋","userAge":"58"}

[![发送插入请求][format_png]][format_png 1]发送插入请求

[![插入结果][format_png 2]][format_png 2 1]插入结果

*  **修改记录**

修改记录时需要带用户ID，比如我们修改 `赵四` 那条记录的名字为 `赵四（Zhao Four）`

[![发送修改请求][format_png 3]][format_png 3 1]发送修改请求

[![修改结果][format_png 4]][format_png 4 1]修改结果

*  **删除记录**

修改记录时同样需要带用户ID，比如删除ID=6 那条 `刘大脑袋`的记录

[![image.png][]][image.png 1]image.png

*  **查询记录**（普通查询，下文讲分页查询）

比如，按照名字来查询：`GET localhost:8089/user/getUserByName?userName=刘能`

--------------------

### 最关心的分页问题 ###

*  **首先装配分页插件**

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

*  **Mapper类**

public interface UserMapper extends BaseMapper<User> {
        
    
        // 普通查询
        User getUserByName( String userName );
    
        // 分页查询
        IPage<List<User>> getUsersPage( Page page, @Param("query") User user );
    }

*  **Service类**

@Service
    @AllArgsConstructor
    public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
        
    
        // 查：普通查
        @Override
        public User findUserByName( String userName ) {
        
            return baseMapper.getUserByName( userName );
        }
    
        // 分页查
        @Override
        public IPage getUserPage(Page page, User user) {
        
            return baseMapper.getUsersPage( page, user );
        }
    }

*  **Controller类**

@GetMapping( value = "/page")
    public Object getUserPage( Page page, User user ) {
        
    	return userService.getUserPage( page, user );
    }

实际实验一下，我们分页查询 `年龄 = 58` 的多条记录：

[![分页查询结果][format_png 5]][format_png 5 1]分页查询结果

可以看到结果数据中，除了给到当前页数据，还把总记录条数，总页数等一并返回了，很是优雅呢 ！

--------------------

### 写在最后 ###

> 由于能力有限，若有错误或者不当之处，还请大家批评指正，一起学习交流！

> 本文转载自https://www.codesheep.cn/2019/04/12/springbt-mybatis-plus/  
> 如有侵权，请联系作者删除

[Spring Boot_MyBatis Generator]: https://www.codesheep.cn/2019/02/14/mybatis-generator/
[Link 1]: https://www.codesheep.cn/2018/04/09/SpringBoot%E4%BC%98%E9%9B%85%E7%BC%96%E7%A0%81%E4%B9%8B%EF%BC%9ALombok%E5%8A%A0%E6%8C%81/
[Mybatis Plus Logo]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91c2VyLWdvbGQtY2RuLnhpdHUuaW8vMjAxOS80LzEyLzE2YTBlYzExODlhZGRjNDA?x-oss-process=image/format,png
[Mybatis Plus Logo 1]: https://user-gold-cdn.xitu.io/2019/4/12/16a0ec1189addc40?w=963&h=309&f=png&s=11313
[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91c2VyLWdvbGQtY2RuLnhpdHUuaW8vMjAxOS80LzEyLzE2YTBlYzExODc1YjNjNmE?x-oss-process=image/format,png
[format_png 1]: https://user-gold-cdn.xitu.io/2019/4/12/16a0ec11875b3c6a?w=1006&h=306&f=png&s=32446
[format_png 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91c2VyLWdvbGQtY2RuLnhpdHUuaW8vMjAxOS80LzEyLzE2YTBlYzExODdmYTQ2ZTk?x-oss-process=image/format,png
[format_png 2 1]: https://user-gold-cdn.xitu.io/2019/4/12/16a0ec1187fa46e9?w=472&h=213&f=png&s=25839
[format_png 3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91c2VyLWdvbGQtY2RuLnhpdHUuaW8vMjAxOS80LzEyLzE2YTBlYzExYTc1M2Y4OTU?x-oss-process=image/format,png
[format_png 3 1]: https://user-gold-cdn.xitu.io/2019/4/12/16a0ec11a753f895?w=1015&h=343&f=png&s=40857
[format_png 4]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91c2VyLWdvbGQtY2RuLnhpdHUuaW8vMjAxOS80LzEyLzE2YTBlYzExOWY2NDdmZDQ?x-oss-process=image/format,png
[format_png 4 1]: https://user-gold-cdn.xitu.io/2019/4/12/16a0ec119f647fd4?w=469&h=206&f=png&s=27448
[image.png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91c2VyLWdvbGQtY2RuLnhpdHUuaW8vMjAxOS80LzEyLzE2YTBlYzExODc2YjgzMWQ?x-oss-process=image/format,png
[image.png 1]: https://user-gold-cdn.xitu.io/2019/4/12/16a0ec11876b831d?w=1025&h=316&f=png&s=35848
[format_png 5]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91c2VyLWdvbGQtY2RuLnhpdHUuaW8vMjAxOS80LzEyLzE2YTBlYzExODg5MzQ5MGE?x-oss-process=image/format,png
[format_png 5 1]: https://user-gold-cdn.xitu.io/2019/4/12/16a0ec118893490a?w=1180&h=932&f=png&s=108868