简单精干之 MyBatis-Plus

最新推荐文章于 2024-08-15 17:37:41 发布
最新推荐文章于 2024-08-15 17:37:41 发布
阅读量593 收藏 1
点赞数 1
分类专栏： 项目常用框架 文章标签： spring boot spring java mybatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_34369588/article/details/122307404
版权

官网地址：https://baomidou.com/

以下缺少相关依赖的，比如 commons.lang 等包，则自行导入。

1、依赖

	<!--    mybatis-plus        -->
	<dependency>
		<groupId>com.baomidou</groupId>
		<artifactId>mybatis-plus-boot-starter</artifactId>
		<version>${mybatis-plus.version}</version>
	</dependency>
	<!--    实体类工具       -->
	<dependency>
		<groupId>org.projectlombok</groupId>
		<artifactId>lombok</artifactId>
	</dependency>

注：自行选择版本。相应的数据库等依赖自行添加，数据库以 mysql 8.0x 为例。

2、配置文件

2.1 application.properties

server.servlet.context-path=/model/
server.tomcat.uri-encoding=UTF-8
spring.application.name=model
# 使用开发环境配置‘dev’，如生产环境，则改为 ‘prod’
spring.profiles.active=prod
# 数据库连接池
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://${datasource.host}:${datasource.port}/model?useSSL=false&useUnicode=true&characterEncoding=utf-8&allowMultiQueries=true&zeroDateTimeBehavior=CONVERT_TO_NULL&serverTimezone=Asia/Shanghai
spring.datasource.initialization-mode=always
# 针对bean被重复定义，重复则覆盖
spring.main.allow-bean-definition-overriding=true
# 将所有数字转为 String 类型返回，避免前端处理数据不正确
spring.jackson.generator.write-numbers-as-strings=true
# 和数据库字段进行印射，最终成为驼峰命名
mybatis-plus.configuration.map-underscore-to-camel-case=true
# Jackson 设置时间格式
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
spring.jackson.time-zone=GMT+8

2.2 application-prod.properties

# 服务器端口
server.port=20000
# 服务地址
server.host=localhost
# 数据库地址、账号密码
datasource.host=localhost
datasource.port=3306
spring.datasource.username=root
spring.datasource.password=123456

3、实体类

3.1 po（对应数据库表）

package com.pky.model.commons.domain.po;

import java.io.Serializable;
import lombok.Data;

/**
 * 用户基本信息表（user_info）实体
 * @author pky
 */
@Data
public class UserInfo implements Serializable {
    /**
     * 用户ID
     * （mybatis_plus 提供的主键生成策略（ASSIGN_ID/雪花算法主键；AUTO/自增主键；ASSIGN_UUID/排除中划线的UUID主键））
     */
    @TableId(type = IdType.ASSIGN_ID)
    private String userId;
    /**
     * 用户名
     */
    private String userName;
    /**
     * 密码
     */
    private String password;
    /**
     * 邮箱
     */
    private String email;
    /**
     * 手机号
     */
    private String phone;
    /**
     * 创建时间
     */
    private String created;
    /**
     * 修改时间
     */
    private String updated;

    private static final long serialVersionUID = 1894561L;
}

3.2 vo （接收前端参数实体）

package com.pky.model.commons.domain.vo;

import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.Data;

import javax.validation.constraints.Email;
import javax.validation.constraints.NotBlank;
import java.util.Date;

/**
 * 保存用户信息【接收】实体
 * @author pky
 */
@Data
@JsonInclude(JsonInclude.Include.NON_NULL)
public class UserSaveVo {

    /**
     * 用户ID
     */
    private String userId;
    /**
     * 用户名
     */
    @NotBlank(message = "用户名不可为空")
    private String userName;
    /**
     * 联系电话
     */
    @Email
    private String email;
    /**
     * 手机号
     */
    private String phone;

}

4、Mapper

package com.pky.model.commons.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.pky.model.commons.domain.table.UserInfo;

/**
 * 用户基本信息表（user_info）Mapper
 * @author pky
 */
public interface UserInfoMapper extends BaseMapper<UserInfo> {
}

5、Service

5.1 接口

  包括模糊搜索、分页、排序等接口。待完善

package com.pky.model.commons.services.po;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.IService;
import com.pky.model.commons.domain.po.UserInfo;
import com.pky.model.commons.domain.vo.UserSaveVo;

import java.util.List;


/**
 * 用户基本信息表（user_info）业务接口
 * @author pky
 */
public interface UserInfoService extends IService<UserInfo> {

    /**
     * 通过用户名获取用户列表
     * @param userName 用户名
     * @return 用户列表
     */
    List<UserInfo> getByUserName(String userName);
    
    /**
     * 通过email获取用户信息
     * @param email 邮箱（唯一）
     * @return 用户信息
     */
    UserInfo getByEmail(String email);
    
    /**
     * 保存用户信息
     * @param userSaveVo 保存用户信息【接收】实体
     * @return 保存后的用户信息
     * @throws Exception 除了自定义的 ServiceException 外，其他都为代码错误
     */
    UserInfo save(UserSaveVo userSaveVo) throws Exception;

    /**
     * 条件分页搜索排序用户信息
     * @param keyword 关键字（用户名、手机号），为空表示全部
     * @param sortType 排序类型：1/创建时间升序排序; 2/创建时间降序排序，为空则不指定排序
     * @param pageNum 当前页
     * @param pageSize 每页条数
     * @return 分页后的用户信息
     */
    IPage<UserInfo> getPageByConditional(String keyword, Integer sortType, int pageNum, int pageSize);

}

5.2 实现类

  包括模糊搜索、分页、排序等实现。待完善

package com.pky.model.commons.services.po.impl;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.pky.model.commons.domain.po.UserInfo;
import com.pky.model.commons.domain.vo.UserSaveVo;
import com.pky.model.commons.mapper.UserInfoMapper;
import com.pky.model.commons.services.po.UserInfoService;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.BeanUtils;
import org.springframework.stereotype.Service;

import java.util.Date;
import java.util.List;

/**
 * 用户基本信息表（user_info）业务逻辑，为了解耦，只操作本表，不涉及其他表逻辑，若需要联合其他表，则需要在上一层 Service 中添加【响应】的业务逻辑来整合。
 * @author pky
 */
@Service
public class UserInfoServiceImpl extends ServiceImpl<UserInfoMapper, UserInfo> implements UserInfoService {
    /**
     * 通过用户名获取用户列表
     * @param userName 用户名
     * @return 用户列表
     */
    @Override
    public List<UserInfo> getByUserName(String userName) {
        return lambdaQuery().eq(UserInfo::getUserName, userName).list();
    }
    
    /**
     * 通过email获取用户信息
     * @param email 邮箱（唯一）
     * @return 用户信息
     */
    @Override
    public UserInfo getByEmail(String email) {
        return lambdaQuery().eq(UserInfo::getEmail, email).one();
    }
    
    /**
     * 保存用户信息
     * @param userSaveVo 保存用户信息【接收】实体
     * @return 保存后的用户信息
     * @throws Exception 除了自定义的 ServiceException 外，其他都为代码错误
     */
    @Override
    public UserInfo save(UserSaveVo userSaveVo) throws Exception {
        // 拷贝用户基本信息
        UserInfo userInfo = new UserInfo();
        BeanUtils.copyProperties(userSaveVo, userInfo);
        // 新增
        if(userSaveVo.getUserId() == null) {
            // 数据库表中的新增时间已默认当前时间，因此无需再设置
            save(userInfo);
        }
        // 修改
        else {
            // 获取用户信息
            UserInfo user = getById(userSaveVo.getUserId());
            if(user == null) {
                // TODO 抛异常，全局捕获（用户信息不存在）
            }
            userInfo.setUpdated(new Date());
            updateById(userInfo);
        }
        return userInfo;
    }

    /**
     * 条件分页搜索排序用户信息
     * @param keyword 关键字（用户名、手机号），为空表示全部
     * @param sortType 排序类型：1/创建时间升序排序; 2/创建时间降序排序，为空则默认按用户ID升序排序
     * @param pageNum 当前页
     * @param pageSize 每页条数
     * @return 分页后的用户信息
     */
    @Override
    public IPage<UserInfo> getPageByConditional(String keyword, Integer sortType, int pageNum, int pageSize) {
        IPage<UserInfo> pageInfo = new Page<>(pageNum, pageSize);
        return lambdaQuery()
                .func(condition -> {
                    if(StringUtils.isNotBlank(keyword)) {
                        condition.like(UserInfo::getUserName, keyword).or().like(UserInfo::getPhone, keyword);
                    }
                })
                .func(condition -> {
                    if(sortType == null) {
                        condition.orderByAsc(UserInfo::getUserId);
                    }
                    else if(sortType == 1) {
                        condition.orderByAsc(UserInfo::getCreated);
                    }
                    else {
                        condition.orderByDesc(UserInfo::getCreated);
                    }
                })
                .page(pageInfo);
    }
}

6、配置类

package com.pky.model.commons.config;

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;

/**
 * mybatis-plus 配置类
 * @author pky
 */
@Configuration
@MapperScan("com.pky.model..*.mapper*")
public class MybatisPlusConfig {

    /**
     * mybatis-plus 配置
     * @return MybatisPlus拦截器
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // 分页配置
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

7、Controller

package com.pky.model.commons.controller.user;

import com.pky.model.commons.domain.table.UserInfo;
import com.pky.model.commons.service.table.UserInfoService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

/**
 * 用户信息控制器
 * @author pky
 */
@RestController
@RequestMapping(value = "api/commons/user/info")
public class UserInfoController {

    private final UserInfoService userInfoService;
    @Autowired
    UserInfoController(UserInfoService userInfoService) {
        this.userInfoService = userInfoService;
    }

    /**
     * 通过用户名获取用户信息
     * @param userName 用户名
     * @return 用户列表
     */
    @GetMapping(value = "")
    public List<UserInfo> getByUserName(String userName) {
        return userInfoService.getByUserName(userName);
    }
}

8、测试

  浏览器输入对应 API 地址，如下通过用户名获取用户信息的 Json 结果：

[
    {
        "userId": "8964598465900",
        "userName": "pky",
        "email": "pkyShare@qq.com",
        "phone": "13500000000",
        "created": "2022-01-03 09:00:00",
        "updated": null
    },
    {
        "userId": "8964598465984",
        "userName": "pky",
        "email": "pkyShare2@qq.com",
        "phone": "13600000000",
        "created": "2022-01-04 13:52:07",
        "updated": null
    }
]

注：以上返回格式未处理，可自行定义返回结构。为 null 不返回的后续处理。

PkyShare
关注
专栏目录
Mybatis Plus 简单实用
真正的大师,永远都怀着一颗学徒的心----易大师
03-26 391
Mybatis Plus的通用crud 需求： 存在一张 tb_employee 表，且已有对应的实体类 Employee，实现tb_employee 表的 CRUD 操作我们需要做什么呢？ 基于 Mybatis： 需要编写 EmployeeMapper 接口，并在 EmployeeMapper.xml 映射文件中手动编写 CRUD 方法对应的sql语句。 基于 MP： 只需要创建 Employe...
mybatis-plus简单使用
@龙猫的博客
08-10 1万+
mybatis-plus简单使用官方网址mybatis和JPA比较mybatis-plus和mybatis比较mysql建表DDL、DMLmaven添加依赖包基本使用通用新增方法常用注解排除非表字段的3种方式Mybatis-Plus查询方法普通查询(selectById、selectBatchIds、selectByMap)条件构造器查询select不列出全部字段condition作用实体类作为条...
MybatisPlus代码生成器
hsuan_CSDN的博客
10-28 816
1 ：引入相关依赖jar包 2：编写类 package com.yunfan.hr.config; import com.baomidou.mybatisplus.annotation.DbType; import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.generator.Auto...
MyBatis-Plus框架
qq_42108331的博客
07-09 1610
MyBatis-Plus
MyBatis Plus 实战详解
最新发布
weixin_65837469的博客
08-15 491
MyBatis Plus（简称MP）是MyBatis的增强工具，旨在简化开发、提高效率。它保留了MyBatis的强大功能，并在其基础上进行了扩展和优化，提供了强大的CRUD操作、配置选项、条件构造器等功能。本文将详细介绍MyBatis Plus的安装、配置、基本操作以及分页和条件查询的使用。
MyBatisPlus--代码生成器
qq_45917176的博客
04-19 1603
官网地址：代码生成器（新） | MyBatis-Plus (baomidou.com) 1、引入依赖 在pom.xml中引入 <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.5.1</version> </dependency>.
【Java系列】Mybatis-Plus 使用介绍二
颜淡慕潇
06-04 1万+
LambdaQueryWrapper 是MyBatis-Plus 提供的一个查询条件构造器，它可以通过 Lambda 表达式来构造查询条件，使得查询条件更加简洁、易读。LambdaUpdateWrapper 是 MyBatis-Plus 提供的一个更新条件构造器，它可以通过 Lambda 表达式来构造更新条件，使得
[Mybatis-Plus笔记] MybatisPlus-07-代码生成器及相关依赖
Cey_Tao的博客
09-23 3224
输出的文件包含 controller, entity, mapper, service，以及 mapperXml 文件在指定的路径下。如上面的代码中 src\\main\\java\\ 相对路径是可行的（注意要用 \\ 而不能用 / ）新建一个类与 main 函数，调用生成器的 api 即可，代码可以直接复制做简单的修改。★ 如果你的项目是先建了空项目再添加的模块，那么起始路径会在项目文件夹下而不是模块下。输出目录可以用相对路径，默认起始路径在项目文件夹下（pom.xml 同级）
MyBatis-Plus入门+MyBatis-Plus文档手册 中文pdf高清版.rar
11-09
mybatis在持久层框架中还是比较火的，一般项目都是基于ssm。虽然mybatis可以直接在xml中...《MyBatis-Plus入门文档》主要介绍了MyBatis-Plus入门使用，以及关于mybatis-plus的更多介绍及特性，感兴趣的可以下载学习一下
mybatis-plus源码（mybatis-plus-3.5.1.zip）
03-03
MyBatis-Plus是MyBatis的扩展框架，它提供了许多高级特性，使得在实际开发中操作数据库变得更加简便。此源码包`mybatis-plus-3.5.1.zip`包含了MyBatis-Plus 3.5.1版本的全部源代码，有助于我们深入理解其内部实现...
MyBatis-Plus 的官方示例(mybatis-plus-samples-master.zip)
05-05
本工程为 MyBatis-Plus 的官方示例，项目结构如下： mybatis-plus-sample-quickstart: 快速开始示例 mybatis-plus-sample-quickstart-springmvc: 快速开始示例（Spring MVC版本） mybatis-plus-sample-reduce-...
mybatis-plus最新代码生成器项目源码 ：mybatis-plus-generator.zip
07-20
mybatis-plus最新代码生成器项目源码 ：mybatis-plus-generator.zip mybatis-plus最新代码生成器项目源码 ：mybatis-plus-generator.zip mybatis-plus最新代码生成器项目源码 ：mybatis-plus-generator.zip ...
mybatis-plus-generator-ui:对mybatis-plus-generator进行封装，通过Web UI快速生成兼容的Spring boot，mybatis-plus框架的各类业务代码
03-20
提供一致的Web UI用于生成兼容mybatis-plus框架的相关功能代码，包括Entity，Mapper，Mapper.xml，Service，Controller等，可以自定义模板以及各种输出参数，也可以通过SQL查询语句直接生成代码。 使用方法 ♡maven...
MyBatis动态设置要连接的数据库地址，用户名，密码
殇神马的博客
09-04 3409
MyBatis动态设置数据库连接的url，用户名，密码
完全解决idea中com.baomidou报错
热门推荐
weixin_45875257的博客
11-11 2万+
完全解决idea中com.baomidou报错 pom.xml里添加： <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.4.2<ersion> </dependency> 清除yml文件中所有mybatis、mybatis
MyBatisPlus
weixin_52234593的博客
05-11 642
MyBatisPlus的功能及其使用。
Mybatis-Plus使用全解
weixin_33850015的博客
08-06 1万+
2019独角兽企业重金招聘Python工程师标准>>> ...
Dynamic DataSource 多数据源配置【 Springboot + DataSource + MyBatis Plus + Druid】
IT小郭的技术博客
10-23 8628
MybatisPlus多数据源配置主要解决的是多数据库连接和切换的问题。在一些大型应用中，由于数据量的增长或者业务模块的增多，可能需要访问多个数据库。这时，就需要配置多个数据源。
Mybatis-Plus与Mybatis全面对比解析
- **自动化程度**：Mybatis需要开发者在XML中编写SQL语句，而Mybatis-Plus提供了更为便捷的方法，如自动填充CRUD（创建、读取、更新、删除）操作，支持条件构造器，使得动态SQL的编写更为简单。 - **扩展性**：...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值