亲宝软件园·资讯

展开

SpringBoot整合MyBatis-Plus SpringBoot中整合MyBatis-Plus的方法示例

Asurplus、 人气:0
想了解SpringBoot中整合MyBatis-Plus的方法示例的相关内容吗,Asurplus、在本文为您仔细讲解SpringBoot整合MyBatis-Plus的相关知识和一些Code实例,欢迎阅读和指正,我们先划重点:SpringBoot整合MyBatis-Plus,SpringBoot,MyBatis-Plus整合,下面大家一起来学习吧。

MyBatis 框架相信大家都用过,虽然 MyBatis 可以直接在 xml 中通过 SQL 语句操作数据库,很是灵活。但正其操作都要通过 SQL 语句进行,就必须写大量的 xml 文件,很是麻烦。于是 MyBatis-Plus 应运而生,作为 MyBatis 的增强工具,更是为我们开发效率得到了质的飞跃。

一、简介

1、MyBatis

MyBatis 是一款优秀的持久层框架,它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录。

官方文档:
https://mybatis.org/mybatis-3/zh/index.html

2、MyBatis-Plus

MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。

官方文档:
https://mybatis.plus/guide/

二、开发前戏

1、引入 MyBatis-Plus

在 pom.xml 文件中引入 MyBatis-Plus 所需依赖

<!-- mybatis-plus -->
<dependency>
  <groupId>com.baomidou</groupId>
  <artifactId>mybatis-plus-boot-starter</artifactId>
  <version>3.3.1</version>
</dependency>
<!-- mybatis-plus代码生成器 -->
<dependency>
  <groupId>com.baomidou</groupId>
  <artifactId>mybatis-plus-generator</artifactId>
  <version>3.3.1.tmp</version>
</dependency>
<!-- mybatisPlus Freemarker 模版引擎 -->
<dependency>
  <groupId>org.freemarker</groupId>
  <artifactId>freemarker</artifactId>
</dependency>
<!-- mysql连接 -->
<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <scope>runtime</scope>
</dependency>

freemarker 作为 MyBatis-Plus 自动生成代码时作为模板使用,还可选用 velocity 作为模板

<dependency>
  <groupId>org.apache.velocity</groupId>
  <artifactId>velocity-engine-core</artifactId>
  <version>2.2</version>
</dependency>

本次我们选用 freemarker 作为模板

2、配置信息

在 application.yml 文件中,配置 mybatis-plus 的信息

# mybatis配置
mybatis-plus:
 # xml文件路径
 mapper-locations: classpath:mapper/*.xml
 # 实体类路径
 type-aliases-package: com.zyxx.sbm.entity
 configuration:
  # 驼峰转换
  map-underscore-to-camel-case: true
  # 是否开启缓存
  cache-enabled: false
  # 打印sql
  log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
 # 全局配置
 global-config:
  # 数据库字段驼峰下划线转换
  db-column-underline: true
  # id自增类型(数据库id自增)
  id-type: 0

我们主要配置了:

/**
 * 数据库ID自增
 */
AUTO(0),
/**
 * 该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT)
 */
NONE(1),
/**
 * 用户输入ID
 * <p>该类型可以通过自己注册自动填充插件进行填充</p>
 */
INPUT(2),

/* 以下3种类型、只有当插入对象ID 为空,才自动填充。 */
/**
 * 分配ID (主键类型为number或string),
 * 默认实现类 {@link com.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator}(雪花算法)
 *
 * @since 3.3.0
 */
ASSIGN_ID(3),
/**
 * 分配UUID (主键类型为 string)
 * 默认实现类 {@link com.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator}(UUID.replace("-",""))
 */
ASSIGN_UUID(4);

MyBatis-Plus 默认的是推特的“雪花算法”,但是这样生成的主键 id 会比较长,本次我们选择数据库自增策略

我们还需要在项目启动类加上

@MapperScan("com.zyxx.sbm.mapper")
@ComponentScan(basePackages = {"com.zyxx"})

扫描我们 mapper 包下面的文件,有时你会发现不在启动类当前包下面的文件无法扫描,于是加上第二个注解,扫描其他文件

3、自动生成代码类

import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import org.apache.commons.lang3.StringUtils;

import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;

/**
 * 代码生成器
 *
 * @Author Lizhou
 */
public class CodeGenerator {

  /**
   * <p>
   * 读取控制台内容
   * </p>
   */
  public static String scanner(String tip) {
    Scanner scanner = new Scanner(System.in);
    StringBuilder help = new StringBuilder();
    help.append("请输入" + tip + ":");
    System.out.println(help.toString());
    if (scanner.hasNext()) {
      String ipt = scanner.next();
      if (StringUtils.isNotEmpty(ipt)) {
        return ipt;
      }
    }
    throw new MybatisPlusException("请输入正确的" + tip + "!");
  }

  /**
   * 自动生成代码
   */
  public static void main(String[] args) {
    // 代码生成器
    AutoGenerator mpg = new AutoGenerator();
    // TODO 全局配置
    GlobalConfig gc = new GlobalConfig();
    String projectPath = System.getProperty("user.dir");
    // 生成文件的输出目录【默认 D 盘根目录】
    gc.setOutputDir(projectPath + "/src/main/java");
    // 作者
    gc.setAuthor("lizhou");
    // 是否打开输出目录
    gc.setOpen(false);
    // controller 命名方式,注意 %s 会自动填充表实体属性
    gc.setControllerName("%sController");
    // service 命名方式
    gc.setServiceName("%sService");
    // serviceImpl 命名方式
    gc.setServiceImplName("%sServiceImpl");
    // mapper 命名方式
    gc.setMapperName("%sMapper");
    // xml 命名方式
    gc.setXmlName("%sMapper");
    // 开启 swagger2 模式
    gc.setSwagger2(true);
    // 是否覆盖已有文件
    gc.setFileOverride(true);
    // 是否开启 ActiveRecord 模式
    gc.setActiveRecord(true);
    // 是否在xml中添加二级缓存配置
    gc.setEnableCache(false);
    // 是否开启 BaseResultMap
    gc.setBaseResultMap(true);
    // XML columList
    gc.setBaseColumnList(false);
    // 全局 相关配置
    mpg.setGlobalConfig(gc);

    // TODO 数据源配置
    DataSourceConfig dsc = new DataSourceConfig();
    dsc.setUrl("jdbc:mysql://127.0.0.1:3306/sbm?useUnicode=true&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC&useSSL=true&characterEncoding=UTF-8");
    dsc.setDriverName("com.mysql.jdbc.Driver");
    dsc.setUsername("root");
    dsc.setPassword("123456");
    mpg.setDataSource(dsc);

    // TODO 包配置
    PackageConfig pc = new PackageConfig();
    // 父包名。如果为空,将下面子包名必须写全部, 否则就只需写子包名
    pc.setParent("com.zyxx.sbm");
    // Entity包名
    pc.setEntity("entity");
    // Service包名
    pc.setService("service");
    // Service Impl包名
    pc.setServiceImpl("service.impl");
    mpg.setPackageInfo(pc);

    // TODO 自定义配置
    InjectionConfig cfg = new InjectionConfig() {
      @Override
      public void initMap() {
        // to do nothing
      }
    };
    // 输出文件配置
    List<FileOutConfig> focList = new ArrayList<>();
    focList.add(new FileOutConfig("/templates/mapper.xml.ftl") {
      @Override
      public String outputFile(TableInfo tableInfo) {
        // 自定义输入文件名称
        return projectPath + "/src/main/resources/mapper/" + tableInfo.getEntityName() + "Mapper.xml";
      }
    });
    // 自定义输出文件
    cfg.setFileOutConfigList(focList);
    mpg.setCfg(cfg);
    mpg.setTemplate(new TemplateConfig().setXml(null));

    // TODO 策略配置
    StrategyConfig strategy = new StrategyConfig();
    // 数据库表映射到实体的命名策略,驼峰原则
    strategy.setNaming(NamingStrategy.underline_to_camel);
    // 字数据库表字段映射到实体的命名策略,驼峰原则
    strategy.setColumnNaming(NamingStrategy.underline_to_camel);
    // 实体是否生成 serialVersionUID
    strategy.setEntitySerialVersionUID(false);
    // 是否生成实体时,生成字段注解
    strategy.setEntityTableFieldAnnotationEnable(true);
    // 使用lombok
    strategy.setEntityLombokModel(true);
    // 设置逻辑删除键
    strategy.setLogicDeleteFieldName("del_flag");
    // TODO 指定生成的bean的数据库表名
    strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
    // 驼峰转连字符
    strategy.setControllerMappingHyphenStyle(true);
    mpg.setStrategy(strategy);
    // 选择 freemarker 引擎需要指定如下加,注意 pom 依赖必须有!
    mpg.setTemplateEngine(new FreemarkerTemplateEngine());
    mpg.execute();
  }
}

我们需要改变的就是:

三、开发进行中

1、创建数据表

我们创建一个用户信息表 user_info


drop table if exists user_info;

/*==============================================================*/
/* Table: user_info                       */
/*==============================================================*/
create table user_info
(
  id          bigint(20) not null auto_increment comment '主键id',
  account       varchar(32) comment '账号',
  password       varchar(32) comment '密码',
  name         varchar(32) comment '姓名',
  phone        varchar(11) comment '电话',
  avatar        varchar(255) comment '头像',
  sex         tinyint(1) comment '性别(0--未知1--男2--女)',
  create_time     datetime comment '创建时间',
  create_user     bigint(20) comment '创建人',
  status        tinyint(1) default 0 comment '状态(0--正常1--冻结)',
  del_flag       tinyint(1) default 0 comment '删除状态(0,正常,1已删除)',
  primary key (id)
)
type = InnoDB;

alter table user_info comment '用户信息表';

 2、生成代码

我们利用刚刚创建的自动生成代码类,生成关于 user_info 数据表的 controller、service、mapper、xml、entity 等文件

生成方法:

生成的文件就自动放在我们配置的包下面

3、代码鉴赏

UserInfo.java 文件

import com.baomidou.mybatisplus.annotation.*;
import com.baomidou.mybatisplus.extension.activerecord.Model;
import com.zyxx.common.annotation.Dict;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;

import java.io.Serializable;

/**
 * <p>
 * 用户信息表
 * </p>
 *
 * @author lizhou
 * @since 2020-07-06
 */
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@TableName("sys_user_info")
@ApiModel(value="SysUserInfo对象", description="用户信息表")
public class UserInfo extends Model<UserInfo> {

  @ApiModelProperty(value = "ID")
  @TableId(value = "id", type = IdType.AUTO)
  private Long id;

  @ApiModelProperty(value = "登录账号")
  @TableField("account")
  private String account;

  @ApiModelProperty(value = "登录密码")
  @TableField("password")
  private String password;

  @ApiModelProperty(value = "姓名")
  @TableField("name")
  private String name;

  @ApiModelProperty(value = "电话")
  @TableField("phone")
  private String phone;

  @ApiModelProperty(value = "头像")
  @TableField("avatar")
  private String avatar;

  @ApiModelProperty(value = "性别(0--未知1--男2--女)")
  @TableField("sex")
  private Integer sex;

  @ApiModelProperty(value = "状态(0--正常1--冻结)")
  @TableField("status")
  private Integer status;

  @ApiModelProperty(value = "创建时间")
  @TableField("create_time")
  private String createTime;

  @ApiModelProperty(value = "创建人")
  @TableField("create_user")
  private Long createUser;

  @ApiModelProperty(value = "删除状态(0--未删除1--已删除)")
  @TableField("del_flag")
  @TableLogic
  private Integer delFlag;

  @Override
  protected Serializable pkVal() {
    return this.id;
  }
}

UserInfoMapper.java 文件

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.zyxx.sbm.entity.UserInfo;

/**
 * <p>
 * 用户信息表 Mapper 接口
 * </p>
 *
 * @author lizhou
 * @since 2020-07-06
 */
public interface UserInfoMapper extends BaseMapper<UserInfo> {

}

继承了 BaseMapper 抽象类,使得有了 CRUD 的基本方法

UserInfoMapper.xml 文件

<?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.zyxx.sbm.mapper.UserInfoMapper">

  <!-- 通用查询映射结果 -->
  <resultMap id="BaseResultMap" type="com.zyxx.sbm.entity.UserInfo">
    <id column="id" property="id" />
    <result column="account" property="account" />
    <result column="password" property="password" />
    <result column="name" property="name" />
    <result column="phone" property="phone" />
    <result column="avatar" property="avatar" />
    <result column="sex" property="sex" />
    <result column="status" property="status" />
    <result column="create_time" property="createTime" />
    <result column="create_user" property="createUser" />
    <result column="del_flag" property="delFlag" />
  </resultMap>

</mapper>

UserInfoService.java 文件

import com.baomidou.mybatisplus.extension.service.IService;
import com.zyxx.common.utils.LayTableResult;
import com.zyxx.common.utils.ResponseResult;
import com.zyxx.sbm.entity.UserInfo;

/**
 * <p>
 * 用户信息表 服务类
 * </p>
 *
 * @author lizhou
 * @since 2020-07-06
 */
public interface UserInfoService extends IService<UserInfo> {

}

UserInfoServiceImpl.java 文件

import com.zyxx.sbm.entity.UserInfo;
import com.zyxx.sbm.service.UserInfoService;
import org.springframework.stereotype.Service;

import java.util.List;

/**
 * <p>
 * 用户信息表 服务实现类
 * </p>
 *
 * @author lizhou
 * @since 2020-07-06
 */
@Service
public class UserInfoServiceImpl extends ServiceImpl<UserInfoMapper, UserInfo> implements UserInfoService {

}

UserInfoController.java 文件

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

/**
 * <p>
 * 用户信息表 前端控制器
 * </p>
 *
 * @author lizhou
 * @since 2020-07-06
 */
@Controller
@RequestMapping("/user-info")
public class UserInfoController {

}

四、开始使用

1、分页查询

我们在 service 的实现类中写一个 分页查询用户的方法,listUserInfo()

@Override
public void listUserInfo(Integer page, Integer limit, UserInfo UserInfo) {
  QueryWrapper<SysUserInfo> queryWrapper = new QueryWrapper<>();
  if (StringUtils.isNotBlank(sysUserInfo.getName())) {
    queryWrapper.like("name", sysUserInfo.getName());
  }
  queryWrapper.orderByDesc("create_time");
  IPage<SysUserInfo> iPage = page(new Page<>(page, limit), queryWrapper);
  long total = iPage.getTotal();
  List<UserInfo> list = iPage.getRecords();
}

我们传入了查询条件:根据用户名称查询,再根据用户的注册时间倒序排序,最后分页查询

我们还可以使用 lambda 的方式来写查询条件,例如:

queryWrapper.lambda().eq(SysUserInfo::getName, sysUserInfo.getName());

这样,就能避免写数据库字段的时候写错了

2、分页插件

注意:这时候,我们查询数据,发现分页并没有起作用,我们还需要配置 MyBatis-Plus 的分页插件

创建 MybatisPlusConfig.java 文件

package com.zyxx.common.mybatis;

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

/**
 * mybatis配置
 *
 * @Author Lizhou
 */
@EnableTransactionManagement
@Configuration
public class MybatisPlusConfig {

  /**
   * 分页插件
   */
  @Bean
  public PaginationInterceptor paginationInterceptor() {
    return new PaginationInterceptor();
  }
}

这时候,我们的分页就正常了,分页默认从1开始,所以不用考虑page = (page-1)*limit 才能使用,1-20的数据,就传入 1,20,20-40的数据就传入 2,20 就可以了

其它的增删改查的方法也是使用很方便的,如果涉及到多表联查,我们还是在 xml 文件中写 sql 吧

五、总结

加载全部内容

相关教程
猜你喜欢
用户评论