MybatisPlus拓展篇

逻辑删除

• 逻辑删除的操作就是增加一个字段表示这个数据的状态，如果一条数据需要删除，我们通过改变这条数据的状态来实现，这样既可以表示这条数据是删除的状态，又保留了数据以便以后统计。

1. 在表中增加一列字段，表示是否删除的状态，这里使用的字段类型为int类型，通过1表示该条数据可用，0表示该条数据不可用。
   
2. 实体类添加一个字段为Integer,用于对应表中的字段

   @Data
   @AllArgsConstructor
   @NoArgsConstructor
   public class User extends Model<User> {private Long id;private String name;private Integer age;private String email;@TableLogic(value = "1",delval = "0")private Integer status;
   }
   

3. 测试逻辑删除效果

@Test
void logicDelete(){userMapper.deleteById(7L);
}

• 还可以通过全局配置来实现逻辑删除的效果
  

通用枚举

• 当想要表示一组信息，这组信息只能从一些固定的值中进行选择，不能随意写，在这种场景下，枚举就非常的合适。

1. 在表中添加一个字段，表示性别，使用int来描述，因为int类型可以通过0和1这两个值来表示两个不同的性别
   
2. 编写枚举类

public enum GenderEnum {MAN(0,"男"),WOMAN(1,"女");@EnumValueprivate Integer gender;private String genderName;GenderEnum(Integer gender, String genderName) {this.gender = gender;this.genderName = genderName;}
}

3. 实体类添加相关字段

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User extends Model<User> {private Long id;private String name;private Integer age;private String email;private GenderEnum gender;private Integer status;
}

4. 添加数据

@Test
void enumTest(){User user = new User();user.setName("liu");user.setAge(29);user.setEmail("[e-mail]");user.setGenderEnum(GenderEnum.MAN);user.setStatus(1);userMapper.insert(user);
}

字段类型处理器

• 在某些场景下，在实体类中是使用Map集合作为属性接收前端传递过来的数据的，但是这些数据存储在数据库时，使用的是json格式的数据进行存储，json本质是一个字符串，就是varchar类型。那怎么做到实体类的Map类型和数据库的varchar类型的互相转换，这里就需要使用到字段类型处理器来完成。

1. 实体类

   @Data
   @AllArgsConstructor
   @NoArgsConstructor
   public class User extends Model<User> {private Long id;private String name;private Integer age;private String email;private GenderEnum gender;private Integer status;private Map<String,String> contact;//联系方式
   }
   

2. 在数据库中添加一个字段，为varchar类型
   
3. 为实体类添加上对应的注解，实现使用字段类型处理器进行不同类型数据转换

   @Data
   @AllArgsConstructor
   @NoArgsConstructor
   @TableName(autoResultMap = true)//查询时将json字符串封装为Map集合
   public class User extends Model<User> {private Long id;private String name;private Integer age;private String email;private GenderEnum gender;private Integer status;@TableField(typeHandler = FastjsonTypeHandler.class)//指定字段类型处理器private Map<String,String> contact;//联系方式
   }
   

4. 引入字段类型处理器依赖Fastjson

   <dependency><groupId>com.alibaba</groupId><artifactId>fastjson</artifactId><version>1.2.76</version>
   </dependency>
   

自动填充功能

• 在项目中有一些属性，如果我们不希望每次都填充的话，我们可以设置为自动填充，比如常见的时间，创建时间和更新时间可以设置为自动填充。

1. 在实体类中，添加对应字段，并为需要自动填充的属性指定填充时机

@Data
@NoArgsConstructor
@AllArgsConstructor
@TableName(autoResultMap = true)
public class User extends Model<User> {@TableIdprivate Long id;private String name;private Integer age;private String email;private Integer status;private GenderEnum gender;@TableField(typeHandler = FastjsonTypeHandler.class)private Map<String,String> contact;@TableField(fill = FieldFill.INSERT)private Date createTime;@TableField(fill = FieldFill.INSERT_UPDATE)private Date updateTime;
}

2. 编写自动填充处理器，指定填充策略

   @Component
   public class MyMetaHandler implements MetaObjectHandler {@Overridepublic void insertFill(MetaObject metaObject) {setFieldValByName("createTime",new Date(),metaObject);setFieldValByName("updateTime",new Date(),metaObject);}@Overridepublic void updateFill(MetaObject metaObject) {setFieldValByName("updateTime",new Date(),metaObject);}
   }
   

3. 设置一下mysql时区，更新yml连接配置

set GLOBAL time_zone='+8:00'
select NOW();

防全表更新与删除插件

• 在实际开发中，全表更新和删除是非常危险的操作，在MybatisPlus中,提供了插件和防止这种危险操作的发生。
• 实现步骤：

1. 注入MybatisPlusInterceptor类，并配置BlockAttackInnerInterceptor拦截器

@Configuration
public class MybatisPlusConfig {@Beanpublic MybatisPlusInterceptor mybatisPlusInterceptor() {MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));interceptor.addInnerInterceptor(new BlockAttackInnerInterceptor());return interceptor;}
}

2. 测试全表更新，会出现抛出异常，防止了全表更新

@SpringBootTest
public class QueryTest {@Autowiredprivate UserService userService;@Testvoid allUpdate(){User user = new User();user.setId(999L);user.setName("wang");user.setEmail("[e-mail]");userService.saveOrUpdate(user,null);}
}

MybatisX快速开发插件

插件安装

• MybatisX是一款IDEA提供的插件，目的是为了我们简化Mybatis以及MybatisPlus框架而生。
• 在IDEA中安装插件

1. 首先选择File -> Settings->Plugins
   
2. 搜索MybatisX，点击安装
   
3. 重启IDEA，让该插件生效，至此MybatisX插件就安装完毕

---

• 插件安装好以后，我们来看一下插件的功能

1. Mapper接口和映射文件的跳转功能
   
   

逆向工程

• 逆向工程就是通过数据库表结构，逆向产生Java工程的结构，包括以下几点：

1. 实体类
2. Mapper接口
3. Mapper映射文件
4. Service接口
5. Service实现类

• 实现步骤：

1. 首先使用IDEA连接mysql,填写连接信息，测试连接通过
   
   
2. 找到表右键，选择插件的逆向工程选项
   
3. 编写逆向工程配置信息
   
4. 编写生成信息
   

常见需求代码生成

• 虽然Mapper接口中提供了一些常见方法，我们可以直接使用这些常见的方法来完成sql操作，但是对于实际场景中各种复杂的操作需求来说，依然是不够用的，所以MybatisX提供了更多的方法，以及可以根据这些方法直接生成对应的sql语句，这样使得开发变得更加的简单。
• 可以根据名称联想常见的操作

@Mapper
public interface UserMapper extends BaseMapper<User> {//添加操作int insertSelective(User user);//删除操作int deleteByNameAndAge(@Param("name") String name, @Param("age") Integer age);//修改操作int updateNameByAge(@Param("name") String name, @Param("age") Integer age);//查询操作List<User> selectAllByAgeBetween(@Param("beginAge") Integer beginAge, @Param("endAge") Integer endAge);
}

• 在映射配置文件中，会生成对应的sql，并不需要我们编写

<insert id="insertSelective">insert into powershop_user<trim prefix="(" suffix=")" suffixOverrides=","><if test="id != null">id,</if><if test="name != null">name,</if><if test="age != null">age,</if><if test="email != null">email,</if></trim>values<trim prefix="(" suffix=")" suffixOverrides=","><if test="id != null">#{id,jdbcType=BIGINT},</if><if test="name != null">#{name,jdbcType=VARCHAR},</if><if test="age != null">#{age,jdbcType=INTEGER},</if><if test="email != null">#{email,jdbcType=VARCHAR},</if></trim>
</insert><delete id="deleteByNameAndAge">deletefrom powershop_userwhere name = #{name,jdbcType=VARCHAR}AND age = #{age,jdbcType=NUMERIC}
</delete><update id="updateNameByAge">update powershop_userset name = #{name,jdbcType=VARCHAR}where age = #{age,jdbcType=NUMERIC}
</update><select id="selectAllByAgeBetween" resultMap="BaseResultMap">select<include refid="Base_Column_List"/>from powershop_userwhereage between #{beginAge,jdbcType=INTEGER} and #{endAge,jdbcType=INTEGER}
</select>

乐观锁

问题引入

• 并发请求就是在同一时刻有多个请求同时请求服务器资源，如果是获取信息，没什么问题，但是如果是对于信息做修改操作呢，那就会出现问题。
• 比如目前商品的库存只剩余1件了，这个时候有多个用户都想要购买这件商品，都发起了购买商品的请求，那么能让这多个用户都购买到么，肯定是不行的，因为多个用户都买到了这件商品，那么就会出现超卖问题，库存不够是没法发货的。所以在开发中就要解决这种超卖的问题。
  

---

核心问题：一个请求在执行的过程中，其他请求不能改变数据，如果是一次完整的请求，在该请求的过程中其他请求没有对于这个数据产生修改操作，那么这个请求是能够正常修改数据的。如果该请求在改变数据的过程中，已经有其他请求改变了数据，那该请求就不去改变这条数据

• 想要解决这类问题，最常见的就是加锁的思想，锁可以用验证在请求的执行过程中，是否有数据发生改变。

• 常见的数据库锁类型有两种，悲观锁和乐观锁。一次完成的修改操作是，先查询数据，然后修改数据。

  • 悲观锁：悲观锁是在查询的时候就锁定数据，在这次请求未完成之前，不会释放锁。等到这次请求完毕以后，再释放锁，释放了锁以后，其他请求才可以对于这条数据完成读写。
  • 悲观锁的优缺点：能够保证读取到的信息就是当前的信息，保证了信息的正确性，但是并发效率很低。
  • 在实际开发中使用悲观锁的场景很少，因为在并发时我们是要保证效率的。
  • 乐观锁：乐观锁是通过表字段完成设计的，核心思想是，在读取的时候不加锁，其他请求依然可以读取到这个数据，在修改的时候判断一个数据是否有被修改过，如果有被修改过，那本次请求的修改操作失效。

• 具体的通过sql是实现

Update  表  set 字段 = 新值，version = version + 1 where version = 1

• 这样做的操作是不会对于数据读取产生影响，并发的效率较高。但是可能目前看到的数据并不是真实信息数据，是被修改之前的，但是在很多场景下是可以容忍的，并不是产生很大影响。

乐观锁的使用

1. 在数据库表中添加一个字段version,表示版本，默认值是1
   
2. 找到实体类，添加对应的属性，并使用@Version标注为这是一个乐观锁字段信息

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {private Long id;private String name;private Integer age;private String email;@Versionprivate Integer version;
}

3. 通过拦截器的配置，让每条修改的sql语句在执行的时候，都加上版本控制的功能

@Configuration
public class MybatisPlusConfig {@Beanpublic MybatisPlusInterceptor mybatisPlusInterceptor(){MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());return interceptor;}
}

效果测试

• 接下来模拟一下，当出现多个修改请求的时候，是否能够做到乐观锁的效果。
• 乐观锁的效果是，一个请求在修改的过程中，是允许另一个请求查询的，但是修改时会通过版本号是否改变来决定是否修改，如果版本号变了，证明已经有请求修改过数据了，那这次修改不生效，如果版本号没有发生变化，那就完成修改。

---

@Test
void updateTest2(){//模拟操作1的查询操作User user1 = userMapper.selectById(6L);//模拟操作2的查询操作User user2 = userMapper.selectById(6L);//模拟操作2的修改操作user2.setName("lisi");userMapper.updateById(user2);//模拟操作1的修改操作user1.setName("zhangsan");userMapper.updateById(user1);
}

• 代码的执行过程
  1. 操作1的查询：此时版本为2
     
  2. 操作2的查询：此时版本为2
     
  3. 操作2的修改：此时检查版本，版本没有变化，所以完成修改，并将版本改为3
     
  4. 操作1的修改：此时检查版本，版本已经有最初获取的版本信息发生了变化，所以杜绝修改
     

代码生成器

• 代码生成器和逆向工程的区别在于，代码生成器可以生成更多的结构，更多的内容，允许我们能够配置生成的选项更多。

1. 引入依赖

   <!--代码生成器依赖-->
   <dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-generator</artifactId><version>3.5.3</version>
   </dependency><!--freemarker模板依赖-->
   <dependency><groupId>org.freemarker</groupId><artifactId>freemarker</artifactId><version>2.3.31</version>
   </dependency>
   

2. 编写代码生成器代码
   • 示例一：

   public class CodeGenerator {/*SELECT table_nameFROM information_schema.tablesWHERE table_schema = 'xxx'ORDER BY table_name DESC;*/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 (!ipt.equals("")) {return ipt;}}throw new MybatisPlusException("请输入正确的" + tip + "！");}public static void main(String[] args) {// 代码生成器AutoGenerator mpg = new AutoGenerator();// 全局配置GlobalConfig gc = new GlobalConfig();String projectPath = System.getProperty("user.dir");gc.setOutputDir(projectPath + "/src/main/java");//设置代码生成路径gc.setFileOverride(true);//是否覆盖以前文件gc.setOpen(false);//是否打开生成目录gc.setAuthor("xxx");//设置项目作者名称gc.setIdType(IdType.AUTO);//设置主键策略gc.setBaseResultMap(true);//生成基本ResultMapgc.setBaseColumnList(true);//生成基本ColumnListgc.setServiceName("%sService");//去掉服务默认前缀gc.setDateType(DateType.ONLY_DATE);//设置时间类型mpg.setGlobalConfig(gc);// 数据源配置DataSourceConfig dsc = new DataSourceConfig();dsc.setUrl("jdbc:mysql://localhost:3306/care_home?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");dsc.setDriverName("com.mysql.cj.jdbc.Driver");dsc.setUsername("root");dsc.setPassword("xxx");mpg.setDataSource(dsc);// 包配置PackageConfig pc = new PackageConfig();pc.setParent("com.test");pc.setMapper("com/test/mapper");pc.setXml("mapper.xml");pc.setEntity("com/test/pojo");pc.setService("com/test/service");pc.setServiceImpl("service.impl");pc.setController("com/test/controller");mpg.setPackageInfo(pc);// 策略配置StrategyConfig sc = new StrategyConfig();sc.setNaming(NamingStrategy.underline_to_camel);sc.setColumnNaming(NamingStrategy.underline_to_camel);sc.setEntityLombokModel(true); //自动lomboksc.setRestControllerStyle(true);sc.setControllerMappingHyphenStyle(true);sc.setLogicDeleteFieldName("deleted");//设置逻辑删除//设置自动填充配置TableFill gmt_create = new TableFill("create_time", FieldFill.INSERT);TableFill gmt_modified = new TableFill("update_time", FieldFill.INSERT_UPDATE);ArrayList<TableFill> tableFills=new ArrayList<>();tableFills.add(gmt_create);tableFills.add(gmt_modified);sc.setTableFillList(tableFills);//乐观锁sc.setVersionFieldName("version");sc.setRestControllerStyle(true);//驼峰命名//  sc.setTablePrefix("tbl_"); 设置表名前缀sc.setInclude(scanner("表名，多个英文逗号分割").split(","));mpg.setStrategy(sc);// 生成代码mpg.execute();}}
   

   • 示例二：

/*** @author 缘友一世* date 2023/7/19-16:09*/
public class CodeGenerator {public static void main(String[] args) {String projectPath = System.getProperty("user.dir"); // 获取当前项目的绝对路径String MainPath=projectPath+"/src/main/java";String url="jdbc:mysql://localhost:3306/db2?serverTimezone=Asia/Shanghai&characterEncoding=utf8&useUnicode=true&useSSL=false";String username="root";String password="xxx";String author="yang";String moduleName="system";String mapperLocation=projectPath+"/src/main/resources/mapper/"+moduleName;String parentPackageName="com.yang";/*CREATE TABLE x_user (id int(11) NOT NULL AUTO_INCREMENT,username varchar(50) NOT NULL ,password varchar(100) DEFAULT NULL,email varchar(50) DEFAULT NULL,phone varchar(20) DEFAULT NULL,status int(1) DEFAULT NULL,avatar varchar(200) DEFAULT NULL,deleted INT(1) DEFAULT 0,PRIMARY KEY (id))ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;DELETE FROM x_userWHERE id > 20;*//** SELECT table_nameFROM information_schema.tablesWHERE table_schema = 'xxx'ORDER BY table_name DESC; */String tables="x_user";FastAutoGenerator.create(url, username, password).globalConfig(builder -> {builder.author(author) // 设置作者//.enableSwagger() // 开启 swagger 模式//.fileOverride() // 覆盖已生成文件.outputDir(MainPath); // 指定输出目录}).dataSourceConfig(builder -> builder.typeConvertHandler((globalConfig, typeRegistry, metaInfo) -> {int typeCode = metaInfo.getJdbcType().TYPE_CODE;if (typeCode == Types.SMALLINT) {// 自定义类型转换return DbColumnType.INTEGER;}return typeRegistry.getColumnType(metaInfo);})).packageConfig(builder -> {builder.parent(parentPackageName) // 设置父包名.moduleName(moduleName) // 设置父包模块名.pathInfo(Collections.singletonMap(OutputFile.xml, mapperLocation)); // 设置mapperXml生成路径}).strategyConfig(builder -> {builder.addInclude(tables) // 设置需要生成的表名.addTablePrefix("x_"); // 设置过滤表前缀}).templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板.execute();}}

执行SQL分析打印

• 可以使用MybatisPlus提供的SQL分析打印的功能，来获取SQL语句执行的时间。

1. 由于该功能依赖于p6spy组件，所以需要在pom.xml中先引入该组件

   <dependency><groupId>p6spy</groupId><artifactId>p6spy</artifactId><version>3.9.1</version>
   </dependency>
   

2. 在application.yml中进行配置

spring:datasource:driver-class-name: com.p6spy.engine.spy.P6SpyDriverurl: jdbc:p6spy:mysql

3. 在resources下，创建 spy.properties配置文件

#3.2.1以上使用modulelist=com.baomidou.mybatisplus.extension.p6spy.MybatisPlusLogFactory,com.p6spy.engine.outage.P6OutageFactory# 自定义日志打印
logMessageFormat=com.baomidou.mybatisplus.extension.p6spy.P6SpyLogger#日志输出到控制台
appender=com.baomidou.mybatisplus.extension.p6spy.StdoutLogger# 使用日志系统记录 sql
#appender=com.p6spy.engine.spy.appender.Slf4JLogger# 设置 p6spy driver 代理
deregisterdrivers=true# 取消JDBC URL前缀
useprefix=true# 配置记录 Log 例外,可去掉的结果集error,info,batch,debug,statement,commit,rollback,result,resultset.
excludecategories=info,debug,result,commit,resultset# 日期格式
dateformat=yyyy-MM-dd HH:mm:ss# 实际驱动可多个
#driverlist=org.h2.Driver# 是否开启慢SQL记录
outagedetection=true# 慢SQL记录标准 2 秒
outagedetectioninterval=2

4. 测试：执行查询所有的操作，可以看到sql语句的执行时间
   

多数据源

• 分库分表：当一个项目的数据库的数据十分庞大时，在完成SQL操作的时候，需要检索的数据就会更多，我们会遇到性能问题，会出现SQL执行效率低的问题。
• 针对这个问题，我们的解决方案是，将一个数据库中的数据，拆分到多个数据库中，从而减少单个数据库的数据量，从分摊访问请求的压力和减少单个数据库数据量这两个方面，都提升了效率。

---

• 在MybatisPlus中，如何演示数据源切换的效果

1. 先创建一个新的模块，将之前模块中的内容复制过来
   
2. 引入依赖

<dependency><groupId>com.baomidou</groupId><artifactId>dynamic-datasource-spring-boot-starter</artifactId><version>3.1.0</version>
</dependency>

3. 创建新的数据库，提供多数据源环境
   
   
4. 编写配置文件，指定多数据源信息

spring:datasource:dynamic:primary: masterstrict: falsedatasource:master:username: rootpassword: xxxurl: jdbc:mysql://localhost:3306/mybatisplus?serverTimezone=UTC&characterEncoding=utf8&useUnicode=true&useSSL=falsedriver-class-name: com.mysql.cj.jdbc.Driverslave_1:username: rootpassword: xxxurl: jdbc:mysql://localhost:3306/mybatisplus2?serverTimezone=UTC&characterEncoding=utf8&useUnicode=true&useSSL=falsedriver-class-name: com.mysql.cj.jdbc.Driver

5. 创建多个Service，分别使用@DS注解描述不同的数据源信息

@Service
@DS("master")
public class UserServiceImpl extends ServiceImpl<UserMapper,User> implements UserService {
}

@Service
@DS("slave_1")
public class UserServiceImpl2 extends ServiceImpl<UserMapper, User> implements UserService{
}

6. 测试service多数据源环境执行结果

@SpringBootTest
class Mp03ApplicationTests {@Autowiredprivate UserServiceImpl userServiceImpl;@Autowiredprivate UserServiceImpl2 userServiceImpl2;@Testpublic void select(){User user = userServiceImpl.getById(1L);System.out.println(user);}@Testpublic void select2(){User user = userServiceImpl2.getById(1L);System.out.println(user);}
}

7. 观察测试结果，发现结果可以从两个数据源中获取