mybatisplus跟排序一起使用 |
您所在的位置：网站首页 › 古代车马很远 › mybatisplus跟排序一起使用 |
mybatisplus跟排序一起使用
|
依赖 com.baomidou mybatis-plus latest-version MybatisPlus的特性**无侵入：**只做增强不做改变，引入它不会对现有工程产生影响; **损耗小：**启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作; **强大的 CRUD 操作：**内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求; **支持 Lambda 形式调用：**通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错; **支持主键自动生成：**支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题; **支持 ActiveRecord 模式：**支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作; **支持自定义全局通用操作：**支持全局通用方法注入（ Write once， use anywhere ）; **内置代码生成器：**采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用; **内置分页插件：**基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询; **分页插件支持多种数据库：**支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库; **内置性能分析插件：**可输出 SQL 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询; **内置全局拦截插件：**提供全表删除 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作 数据库支持
所以在0xml中声明sqlSessionFactory实际为mybatisPlus中的; 我们获取一下sqlSessionFactory的全限定名, package com.codem; import org.mybatis.spring.annotation.MapperScan; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.ConfigurableApplicationContext; @SpringBootApplication //@MapperScan("com.codem.mapper") public class MybatiplusApplication { public static void main(String[] args) { ConfigurableApplicationContext context = SpringApplication.run(MybatiplusApplication.class, args); System.out.println(context.getBean("sqlSessionFactory").getClass()); } }全限定名—> class org.apache.ibatis.session.defaults.DefaultSqlSessionFactory当dataSource作为参数传入MybatisPlus的SqlSessionFactory时,会做一系列处理-----即增强了之前的SqlSessionFactory; 整个案例感受一下 表还是之前的经典表emp与dept 创建一个springboot项目 父依赖 org.springframework.boot spring-boot-starter-parent 2.6.3mybatisplus启动器 com.baomidou mybatis-plus-boot-starter 3.5.1mysql数据库配置 spring: datasource: # 使用druid链接池 type: com.alibaba.druid.pool.DruidDataSource # 数据库要素 driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://127.0.0.1:3306/gavin?useSSL=false&useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai username: gavin password: 955945mybatis配置 mybatis: type-aliases-package: com.gavin.pojo mapper-locations: classpath:com/gavin/mapper/*.xml #按照习惯来吧自动配置的内容 MyBatis PlusAutoConfiguration配置类,MyBatisPlusProperties配置项前缀 mybatis-plus: ***就是对mybatis-plus的参数的设置 SQLSessionFactory已经配置好 mapperlocations 自动配置好的,默认值是classpath*:/mapper/**/*.xml 意为任意包路径下所有的mapper包下的xml文件 实体类 package com.codem.pojo; import java.io.Serializable; import java.util.Date; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; import org.apache.ibatis.annotations.Mapper; /** * emp * @author */ @Data @AllArgsConstructor @NoArgsConstructor public class Emp implements Serializable { private Integer empno; private String ename; private String job; private Integer mgr; private Date hiredate; private Integer sal; private Integer comm; private Integer deptno; private static final long serialVersionUID = 1L; }测试类 package codem; import com.codem.MybatiplusApplication; import com.codem.mapper.EmpMapper; import com.codem.pojo.Emp; import org.junit.jupiter.api.Test; import org.mybatis.spring.annotation.MapperScan; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import java.util.List; @SpringBootTest(classes = MybatiplusApplication.class) //@MapperScan("com.codem.mapper")//扫描mapper所在的包,或者在每一个mapper上夹注解@Mapper public class MybatiplusApplicationTests { @Autowired private EmpMapper empMapper; @Test public void contextLoads() { List emps = empMapper.selectAll(); emps.forEach(System.out::println); } }mapper接口 package com.codem.mapper; import com.codem.pojo.Emp; import org.apache.ibatis.annotations.Mapper; import java.util.List; @Mapper public interface EmpMapper { List selectAll(); }结果—>> Emp(empno=7369, ename=SMITH, job=CLERK, mgr=7902, hiredate=Wed Dec 17 00:00:00 CST 1980, sal=800, comm=null, deptno=20) Emp(empno=7499, ename=ALLEN, job=SALESMAN, mgr=7698, hiredate=Fri Feb 20 00:00:00 CST 1981, sal=1600, comm=300, deptno=30) Emp(empno=7521, ename=WARD, job=SALESMAN, mgr=7698, hiredate=Sun Feb 22 00:00:00 CST 1981, sal=1250, comm=500, deptno=30)看起来跟之前springbootmybatis没有什么太大的区别,但是这只是基础, MyBatis-Plus 提供了大量的个性化配置来满足不同复杂度的工程 Mybatisplus为我们提供了两个接口已简化我们对curd的编写 BaseMapper extends Mapper // // Source code recreated from a .class file by IntelliJ IDEA // (powered by Fernflower decompiler) // package com.baomidou.mybatisplus.core.mapper; import com.baomidou.mybatisplus.core.conditions.Wrapper; import com.baomidou.mybatisplus.core.metadata.IPage; import com.baomidou.mybatisplus.core.toolkit.CollectionUtils; import com.baomidou.mybatisplus.core.toolkit.ExceptionUtils; import java.io.Serializable; import java.util.Collection; import java.util.List; import java.util.Map; import org.apache.ibatis.annotations.Param; public interface BaseMapper extends Mapper { int insert(T entity);//插入 int deleteById(Serializable id);//删除 int deleteById(T entity); int deleteByMap(@Param("cm") Map columnMap); int delete(@Param("ew") Wrapper queryWrapper); int deleteBatchIds(@Param("coll") Collection idList);//批量删除 int updateById(@Param("et") T entity);//更新 int update(@Param("et") T entity, @Param("ew") Wrapper updateWrapper); T selectById(Serializable id);//查找 List selectBatchIds(@Param("coll") Collection idList);//批量查找 List selectByMap(@Param("cm") Map columnMap); default T selectOne(@Param("ew") Wrapper queryWrapper) { List ts = this.selectList(queryWrapper); if (CollectionUtils.isNotEmpty(ts)) { if (ts.size() != 1) { throw ExceptionUtils.mpe("One record is expected, but the query result is multiple records", new Object[0]); } else { return ts.get(0); } } else { return null; } } default boolean exists(Wrapper queryWrapper) { Long count = this.selectCount(queryWrapper); return null != count && count > 0L; } Long selectCount(@Param("ew") Wrapper queryWrapper); List selectList(@Param("ew") Wrapper queryWrapper); List selectMaps(@Param("ew") Wrapper queryWrapper); List selectObjs(@Param("ew") Wrapper queryWrapper); P selectPage(P page, @Param("ew") Wrapper queryWrapper); P selectMapsPage(P page, @Param("ew") Wrapper queryWrapper); }还有另一个接口—>> // // Source code recreated from a .class file by IntelliJ IDEA // (powered by Fernflower decompiler) // package com.baomidou.mybatisplus.extension.service; import com.baomidou.mybatisplus.core.conditions.Wrapper; import com.baomidou.mybatisplus.core.mapper.BaseMapper; import com.baomidou.mybatisplus.core.metadata.IPage; import com.baomidou.mybatisplus.core.toolkit.Assert; import com.baomidou.mybatisplus.core.toolkit.CollectionUtils; import com.baomidou.mybatisplus.core.toolkit.Wrappers; import com.baomidou.mybatisplus.extension.conditions.query.LambdaQueryChainWrapper; import com.baomidou.mybatisplus.extension.conditions.query.QueryChainWrapper; import com.baomidou.mybatisplus.extension.conditions.update.LambdaUpdateChainWrapper; import com.baomidou.mybatisplus.extension.conditions.update.UpdateChainWrapper; import com.baomidou.mybatisplus.extension.kotlin.KtQueryChainWrapper; import com.baomidou.mybatisplus.extension.kotlin.KtUpdateChainWrapper; import com.baomidou.mybatisplus.extension.toolkit.ChainWrappers; import com.baomidou.mybatisplus.extension.toolkit.SqlHelper; import java.io.Serializable; import java.util.Collection; import java.util.List; import java.util.Map; import java.util.Objects; import java.util.function.Function; import java.util.stream.Collectors; import org.springframework.transaction.annotation.Transactional; public interface IService { int DEFAULT_BATCH_SIZE = 1000; default boolean save(T entity) {//节点存储 return SqlHelper.retBool(this.getBaseMapper().insert(entity)); } @Transactional( rollbackFor = {Exception.class}//回滚 ) default boolean saveBatch(Collection entityList) { return this.saveBatch(entityList, 1000);//存储,默认1000 } boolean saveBatch(Collection entityList, int batchSize);//节点存储自定义容量 @Transactional( rollbackFor = {Exception.class} ) default boolean saveOrUpdateBatch(Collection entityList) { return this.saveOrUpdateBatch(entityList, 1000); } boolean saveOrUpdateBatch(Collection entityList, int batchSize); default boolean removeById(Serializable id) { return SqlHelper.retBool(this.getBaseMapper().deleteById(id)); } default boolean removeById(Serializable id, boolean useFill) { throw new UnsupportedOperationException("不支持的方法!"); } default boolean removeById(T entity) { return SqlHelper.retBool(this.getBaseMapper().deleteById(entity)); } default boolean removeByMap(Map columnMap) { Assert.notEmpty(columnMap, "error: columnMap must not be empty", new Object[0]); return SqlHelper.retBool(this.getBaseMapper().deleteByMap(columnMap)); } default boolean remove(Wrapper queryWrapper) { return SqlHelper.retBool(this.getBaseMapper().delete(queryWrapper)); } default boolean removeByIds(Collection list) { return CollectionUtils.isEmpty(list) ? false : SqlHelper.retBool(this.getBaseMapper().deleteBatchIds(list)); } @Transactional( rollbackFor = {Exception.class} ) default boolean removeByIds(Collection list, boolean useFill) { if (CollectionUtils.isEmpty(list)) { return false; } else { return useFill ? this.removeBatchByIds(list, true) : SqlHelper.retBool(this.getBaseMapper().deleteBatchIds(list)); } } @Transactional( rollbackFor = {Exception.class} ) default boolean removeBatchByIds(Collection list) { return this.removeBatchByIds(list, 1000); } @Transactional( rollbackFor = {Exception.class} ) default boolean removeBatchByIds(Collection list, boolean useFill) { return this.removeBatchByIds(list, 1000, useFill); } default boolean removeBatchByIds(Collection list, int batchSize) { throw new UnsupportedOperationException("不支持的方法!"); } default boolean removeBatchByIds(Collection list, int batchSize, boolean useFill) { throw new UnsupportedOperationException("不支持的方法!"); } default boolean updateById(T entity) { return SqlHelper.retBool(this.getBaseMapper().updateById(entity)); } default boolean update(Wrapper updateWrapper) { return this.update((Object)null, updateWrapper); } default boolean update(T entity, Wrapper updateWrapper) { return SqlHelper.retBool(this.getBaseMapper().update(entity, updateWrapper)); } @Transactional( rollbackFor = {Exception.class} ) default boolean updateBatchById(Collection entityList) { return this.updateBatchById(entityList, 1000); } boolean updateBatchById(Collection entityList, int batchSize); boolean saveOrUpdate(T entity); default T getById(Serializable id) { return this.getBaseMapper().selectById(id); } default List listByIds(Collection idList) { return this.getBaseMapper().selectBatchIds(idList); } default List listByMap(Map columnMap) { return this.getBaseMapper().selectByMap(columnMap); } default T getOne(Wrapper queryWrapper) { return this.getOne(queryWrapper, true); } T getOne(Wrapper queryWrapper, boolean throwEx); Map getMap(Wrapper queryWrapper); V getObj(Wrapper queryWrapper, Function mapper); default long count() { return this.count(Wrappers.emptyWrapper()); } default long count(Wrapper queryWrapper) { return SqlHelper.retCount(this.getBaseMapper().selectCount(queryWrapper)); } default List list(Wrapper queryWrapper) { return this.getBaseMapper().selectList(queryWrapper); } default List list() { return this.list(Wrappers.emptyWrapper()); } default E page(E page, Wrapper queryWrapper) { return this.getBaseMapper().selectPage(page, queryWrapper); } default E page(E page) { return this.page(page, Wrappers.emptyWrapper()); } default List listMaps(Wrapper queryWrapper) { return this.getBaseMapper().selectMaps(queryWrapper); } default List listMaps() { return this.listMaps(Wrappers.emptyWrapper()); } default List listObjs() { return this.listObjs(Function.identity()); } default List listObjs(Function mapper) { return this.listObjs(Wrappers.emptyWrapper(), mapper); } default List listObjs(Wrapper queryWrapper) { return this.listObjs(queryWrapper, Function.identity()); } default List listObjs(Wrapper queryWrapper, Function mapper) { return (List)this.getBaseMapper().selectObjs(queryWrapper).stream().filter(Objects::nonNull).map(mapper).collect(Collectors.toList()); } default E pageMaps(E page, Wrapper queryWrapper) { return this.getBaseMapper().selectMapsPage(page, queryWrapper); } default E pageMaps(E page) { return this.pageMaps(page, Wrappers.emptyWrapper()); } BaseMapper getBaseMapper(); Class getEntityClass(); default QueryChainWrapper query() { return ChainWrappers.queryChain(this.getBaseMapper()); } default LambdaQueryChainWrapper lambdaQuery() { return ChainWrappers.lambdaQueryChain(this.getBaseMapper()); } default KtQueryChainWrapper ktQuery() { return ChainWrappers.ktQueryChain(this.getBaseMapper(), this.getEntityClass()); } default KtUpdateChainWrapper ktUpdate() { return ChainWrappers.ktUpdateChain(this.getBaseMapper(), this.getEntityClass()); } default UpdateChainWrapper update() { return ChainWrappers.updateChain(this.getBaseMapper()); } default LambdaUpdateChainWrapper lambdaUpdate() { return ChainWrappers.lambdaUpdateChain(this.getBaseMapper()); } default boolean saveOrUpdate(T entity, Wrapper updateWrapper) { return this.update(entity, updateWrapper) || this.saveOrUpdate(entity); } }在这个接口中也提供了一些方法,用于简化手写的curd以及批量提交/回滚 所以在自动给注入时我们service,或者mapper可以注入 通过实现类来实现接口,最终完成功能; 当有mybatis_plus前缀时会自动去检查下面的配置,比如映射文件地址—>“classpath*:/mapper/**/*.xml”
mybatisPlus实现curd代码—>> 目录结构 service接口 package com.codem.service; import com.baomidou.mybatisplus.extension.service.IService; import com.codem.pojo.Emp; import org.apache.ibatis.annotations.Mapper; public interface EmpService extends IService { }service接口实现类 package com.codem.service.imp; import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl; import com.codem.mapper.EmpMapper; import com.codem.pojo.Emp; import com.codem.service.EmpService; import org.springframework.stereotype.Service; @Service public class empServiceImpl extends ServiceImpl implements EmpService { }配置注解@SpringBootTest(classes = MybatiplusApplication.class),因为测试类也需要启动springboot环境； 所以在测试类之前还需要在springboot启动类上做一些配置– package com.codem; import org.mybatis.spring.annotation.MapperScan; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.ConfigurableApplicationContext; @SpringBootApplication @MapperScan("com.codem.mapper")//扫描包而不是单个注解mapper public class MybatiplusApplication { public static void main(String[] args) { ConfigurableApplicationContext context = SpringApplication.run(MybatiplusApplication.class, args); String[] beanDefinitionNames = context.getBeanDefinitionNames(); for (String definitionName : beanDefinitionNames) { System.out.println(definitionName); } System.out.println("---------------------"); System.out.println(context.getBean("sqlSessionFactory").getClass()); } }测试类---->> package codem; import com.codem.MybatiplusApplication; import com.codem.mapper.EmpMapper; import com.codem.pojo.Emp; import com.codem.service.EmpService; import org.junit.jupiter.api.Test; import org.mybatis.spring.annotation.MapperScan; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import java.util.List; @SpringBootTest(classes = MybatiplusApplication.class) //@MapperScan("com.codem.mapper") public class MybatiplusApplicationTests { /* @Autowired private EmpMapper empMapper;*/ @Autowired EmpService empService; @Test public void contextLoads() { List emps = empService.list(); // List emps = empMapper.selectAll(); emps.forEach(System.out::println); } }跟之前对比,对于一些基本的curd我们就不需要在xml配置文件中写对应的sql语句了,但是还是需要xml映射文件的; MyBatis-Plus 配置参数详解 MybatisPlus中的注解mybatisplus注解所在的包 mybatis-plus-annotation
@TableName 表注解 //指定对应的表名, 指定映射 resultMap,可以理解为类构造对应mapper中的resultMap //autoResultMap---自动构建resultMap @TableName(value = "emp" ,resultMap ="empconstructor",autoResultMap = true) public class Emp implements Serializable {@TableId 主键注解 //主键字段名, 主键--自增 @TableId(value = "empno",type = IdType.AUTO) private Integer empno; //IdType.INPUT----insert前自行set主键值
关于jdbcType和typeHandler以及numericScale的说明: numericScale只生效于 update 的sql. jdbcType和typeHandler如果不配合@TableName#autoResultMap = true一起使用,也只生效于 update 的sql. 对于typeHandler如果你的字段类型和set进去的类型为equals关系,则只需要让你的typeHandler让Mybatis加载到即可,不需要使用注解
@OrderBy 排序,作用域字段/属性/注解上 //指定排列顺序优先级低于 wrapper 条件查询 @OrderBy(asc = false) //主键字段名,设置主键--自增 @TableId(value = "empno",type = IdType.AUTO) private Integer empno;其他注解的使用API 代码自动生成 代码生成器（3.4.1+版本）AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。 MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖，需要手动添加相关依赖： 引入代码自动生成的依赖(非最新版本)---->> com.baomidou mybatis-plus-generator 3.4.1依赖分析 注意！如果您选择了非默认引擎，需要在 AutoGenerator 中 设置模板引擎。 官方教程 案例—>> 代码生成器代码 package com; import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException; import com.baomidou.mybatisplus.core.toolkit.StringPool; import com.baomidou.mybatisplus.core.toolkit.StringUtils; 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 java.util.ArrayList; import java.util.List; import java.util.Scanner; public class CodeGenerator { /** ** 读取控制台内容 * */ 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.isNotBlank(ipt)) { 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 + "/demo/src/main/java"); gc.setAuthor("codeM"); gc.setOpen(false); // gc.setSwagger2(true); 实体属性 Swagger2 注解 mpg.setGlobalConfig(gc); // 数据源配置 DataSourceConfig dsc = new DataSourceConfig(); dsc.setUrl("jdbc:mysql://localhost:3306/gavin?useUnicode=true&useSSL=false&characterEncoding=utf8"); // dsc.setSchemaName("public"); dsc.setDriverName("com.mysql.cj.jdbc.Driver"); dsc.setUsername("gavin"); dsc.setPassword("955945"); mpg.setDataSource(dsc); // 包配置D:\Program Data\idea2019Data\mybatiplus\demo PackageConfig pc = new PackageConfig(); pc.setModuleName(scanner("模块")); //设置java下的顶级目录 pc.setParent("com"); mpg.setPackageInfo(pc); // 自定义配置 InjectionConfig cfg = new InjectionConfig() { @Override public void initMap() { // to do nothing } }; // 如果模板引擎是 freemarker String templatePath = "/templates/mapper.xml.ftl"; // 如果模板引擎是 velocity // String templatePath = "/templates/mapper.xml.vm"; // 自定义输出配置 List focList = new ArrayList(); // 自定义配置会被优先输出 focList.add(new FileOutConfig(templatePath) { @Override public String outputFile(TableInfo tableInfo) { // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！ return projectPath + "/src/main/resources/mapper/" + pc.getModuleName() + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML; } }); /* cfg.setFileCreate(new IFileCreate() { @Override public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) { // 判断自定义文件夹是否需要创建 checkDir("调用默认方法创建的目录，自定义目录用"); if (fileType == FileType.MAPPER) { // 已经生成 mapper 文件判断存在，不想重新生成返回 false return !new File(filePath).exists(); } // 允许生成模板文件 return true; } }); */ cfg.setFileOutConfigList(focList); mpg.setCfg(cfg); // 配置模板 TemplateConfig templateConfig = new TemplateConfig(); // 配置自定义输出模板 //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别 // templateConfig.setEntity("templates/entity2.java"); // templateConfig.setService(); // templateConfig.setController(); templateConfig.setXml(null); mpg.setTemplate(templateConfig); // 策略配置 StrategyConfig strategy = new StrategyConfig(); strategy.setNaming(NamingStrategy.underline_to_camel); strategy.setColumnNaming(NamingStrategy.underline_to_camel); // 继承的父类 // strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!"); strategy.setEntityLombokModel(true); strategy.setRestControllerStyle(true); // 公共父类 // strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!"); // 写于父类中的公共字段 strategy.setSuperEntityColumns("id"); strategy.setInclude(scanner("表名，多个英文逗号分割").split(",")); strategy.setControllerMappingHyphenStyle(true); strategy.setTablePrefix(pc.getModuleName() + "_"); mpg.setStrategy(strategy); mpg.setTemplateEngine(new FreemarkerTemplateEngine()); mpg.execute(); } }目录结构  如果使用Thymeleaf,则需要自定义模板, 这就需要继承 com.baomidou.mybatisplus.generator.engine.AbstractTemplateEngine 自定义代码模板
//指定自定义模板路径, 位置：/resources/templates/entity2.java.ftl(或者是.vm)
//注意不要带上.ftl(或者是.vm), 会根据使用的模板引擎自动识别
TemplateConfig templateConfig = new TemplateConfig()
.setEntity("templates/entity2.java");
AutoGenerator mpg = new AutoGenerator();
//配置自定义模板
mpg.setTemplate(templateConfig);
//自定义属性注入
InjectionConfig injectionConfig = new InjectionConfig() {
//自定义属性注入:abc
//在.ftl(或者是.vm)模板中，通过${cfg.abc}获取属性
@Override
public void initMap() {
Map map = new HashMap();
map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
this.setMap(map);
}
};
AutoGenerator mpg = new AutoGenerator();
//配置自定义属性注入
mpg.setCfg(injectionConfig);
entity2.java.ftl
自定义属性注入abc=${cfg.abc}
entity2.java.vm
自定义属性注入abc=$!{cfg.abc}
#字段其他信息查询注入
代码生成器（3.5.1+版本）
文件位置配置–>> location.properties jdbc_url=jdbc:mysql://127.0.0.1:3306/gavin?useSSL=false&useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai jdbc_username=gavin jdbc_password=955945 location_path=zzy\\src\\main/\\java mapper_path=zzy\\src\\main\\resources\\mapper代码快速自动生成 package com; import com.baomidou.mybatisplus.generator.FastAutoGenerator; import com.baomidou.mybatisplus.generator.config.OutputFile; import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine; import org.apache.ibatis.io.Resources; import java.io.IOException; import java.io.InputStream; import java.util.Collections; import java.util.Properties; /** * @author Gavin */ public class FastAutoGeneratorTest { public static void main(String[] args) throws IOException { InputStream FTT = Resources.getResourceAsStream("config/location.properties"); Properties properties= new Properties(); properties.load(FTT); String url = properties.getProperty("jdbc_url"); String username = properties.getProperty("jdbc_username"); String password = properties.getProperty("jdbc_password"); String location_path = properties.getProperty("location_path"); String mapper_path = properties.getProperty("mapper_path"); FastAutoGenerator.create(url, username,password) .globalConfig(builder -> { builder.author("codeM") // 设置作者 .enableSwagger() // 开启 swagger 模式 .fileOverride() // 覆盖已生成文件 .outputDir(location_path); // 指定输出目录 }) //D:\Program Data\idea2019Data\mybatiplus\zzy\src\main\java\com .packageConfig(builder -> { builder.parent("com") // 设置父包名 .moduleName("gavin") // 设置父包模块名/ /zzy/src/main/resources/mapper .pathInfo(Collections.singletonMap(OutputFile.mapperXml, mapper_path)); // 设置mapperXml生成路径 }) .strategyConfig(builder -> { builder.addInclude("dept") // 设置表名----要生成实体 .addTablePrefix("t_", "c_"); // 设置过滤表前缀 }) .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板 .execute(); } }注意仅适用 3.5.1 以上版本，对历史版本坑会存在不兼容问题） 记录遇到的问题---->>路径问题 如图所示, 解决方法—把 / 改成 (要转义)
交互式生成代码—>> package com; import com.baomidou.mybatisplus.annotation.FieldFill; import com.baomidou.mybatisplus.generator.FastAutoGenerator; import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine; import com.baomidou.mybatisplus.generator.fill.Column; import org.apache.ibatis.io.Resources; import java.io.IOException; import java.io.InputStream; import java.util.Arrays; import java.util.Collections; import java.util.List; import java.util.Properties; public class CodeGenerator { public static void main(String[] args) throws IOException { InputStream FTT = Resources.getResourceAsStream("config/location.properties"); Properties properties = new Properties(); properties.load(FTT); String url = properties.getProperty("jdbc_url"); String username = properties.getProperty("jdbc_username"); String password = properties.getProperty("jdbc_password"); String location_path = properties.getProperty("location_path"); String mapper_path = properties.getProperty("mapper_path"); FastAutoGenerator.create(url, username,password) // 全局配置 .globalConfig((scanner, builder) -> {builder.author(scanner.apply("请输入作者名称？")).fileOverride().outputDir(location_path);}) // 包配置 .packageConfig((scanner, builder) -> builder.parent(scanner.apply("请输入包全限定名？"))) // 策略配置 .strategyConfig((scanner, builder) -> builder.addInclude(getTables(scanner.apply("请输入表名，多个英文逗号分隔？所有输入 all"))) .controllerBuilder().enableRestStyle().enableHyphenStyle() .entityBuilder().enableLombok().addTableFills( new Column("create_time", FieldFill.INSERT) ).build()) .templateEngine(new FreemarkerTemplateEngine()) /* 模板引擎配置，默认 Velocity 可选模板引擎 Beetl 或 Freemarker .templateEngine(new BeetlTemplateEngine()) .templateEngine(new FreemarkerTemplateEngine()) */ .execute(); } // 处理 all 情况 protected static List getTables(String tables) { return "all".equals(tables) ? Collections.emptyList() : Arrays.asList(tables.split(",")); } }数据库配置–> new DataSourceConfig. Builder("jdbc:mysql://127.0.0.1:3306/数据库","root","123456").build();全局配置 new GlobalConfig.Builder() .fileOverride()//覆盖已生成的文件 .outputDir("/codem/zzy")//输出目录 .author("codem")//作者 .enableKotlin()//kotlin模式.默认false .enableSwagger()// swagger 模式.默认 false .dateType(DateType.TIME_PACK)//时间策略 .commentDate("yyyy-MM-dd")//注释日期 .build();包配置 new PackageConfig.Builder() parent("com.gavin.mybatisplus.samples.generator")//父包名 .moduleName("sys")//模块名 .entity("po")//实体类包名 .service("service")//service包名 .serviceImpl("service.impl") .mapper("mapper") .mapperXml("mapper.xml") .controller("controller") .other("other") .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "D://"))//路径配置 .build();模板配置 new TemplateConfig.Builder() .disable(TemplateType.ENTITY) .entity("/templates/entity.java") .service("/templates/service.java") .serviceImpl("/templates/serviceImpl.java") .mapper("/templates/mapper.java") .mapperXml("/templates/mapper.xml") .controller("/templates/controller.java") .build();
Entity策略配置 new StrategyConfig.Builder() .entityBuilder() .superClass(BaseEntity.class) .disableSerialVersionUID() .enableChainModel() .enableLombok() .enableRemoveIsPrefix() .enableTableFieldAnnotation() .enableActiveRecord() .versionColumnName("version") .versionPropertyName("version") .logicDeleteColumnName("deleted") .logicDeletePropertyName("deleteFlag") .naming(NamingStrategy.no_change) .columnNaming(NamingStrategy.underline_to_camel) .addSuperEntityColumns("id", "created_by", "created_time", "updated_by", "updated_time") .addIgnoreColumns("age") .addTableFills(new Column("create_time", FieldFill.INSERT)) .addTableFills(new Property("updateTime", FieldFill.INSERT_UPDATE)) .idType(IdType.AUTO) .formatFileName("%sEntity") .build();Service策略配置 new StrategyConfig.Builder() .serviceBuilder() .superServiceClass(BaseService.class) .superServiceImplClass(BaseServiceImpl.class) .formatServiceFileName("%sService") .formatServiceImplFileName("%sServiceImp") .build();Controller策略配置 new StrategyConfig.Builder() .controllerBuilder() .superClass(BaseController.class) .enableHyphenStyle() .enableRestStyle() .formatFileName("%sAction") .build();Mapper策略配置 new StrategyConfig.Builder() .mapperBuilder() .superClass(BaseMapper.class) .enableMapperAnnotation() .enableBaseResultMap() .enableBaseColumnList() .cache(MyMapperCache.class) .formatMapperFileName("%sDao") .formatXmlFileName("%sXml") .build(); CURD Service CRUD 接口通用 Service CRUD 封装IService (opens new window)接口，进一步封装 CRUD 采用 get 查询单行 remove 删除 list 查询集合 page 分页 前缀命名方式区分 Mapper 层避免混淆 泛型 T 为任意实体对象 建议如果存在自定义通用 Service 方法的可能，请创建自己的 IBaseService 继承 Mybatis-Plus 提供的基类 对象 Wrapper 为 条件构造器 在自动生成代码的基础上去实现增删查改 package gavin; import org.mybatis.spring.annotation.MapperScan; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication @MapperScan("gavin/mapper")//mapper扫描 public class ZzyApplication { public static void main(String[] args) { SpringApplication.run(ZzyApplication.class, args); } } CURD方法save方法 // 插入一条记录（选择字段，策略插入） boolean save(T entity); // 插入（批量） boolean saveBatch(Collection entityList); // 插入（批量） boolean saveBatch(Collection entityList, int batchSize); package com.zzy; import com.baomidou.mybatisplus.core.toolkit.Wrappers; import gavin.ZzyApplication; import gavin.entity.Dept; import gavin.service.DeptService; import org.junit.jupiter.api.Test; import org.mybatis.spring.annotation.MapperScan; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import java.util.ArrayList; import java.util.List; @SpringBootTest(classes = ZzyApplication.class) class ZzyApplicationTests { @Autowired private DeptService deptService; @Test void contextLoads() { List list = deptService.list(); list.forEach(System.out::println); } // 带条件查询 @Test void contextLoads2() { //插入数据 deptService.save(new Dept(50,"Manager","YT")); //批量插入数据 List list= new ArrayList(2); list.add(new Dept(60,"Manager","YT")); list.add(new Dept(70,"Manager","YTT")); list.add(new Dept(80,"Manager","YTTT")); //批量提交,默认1000 deptService.saveBatch(list); //批量插入数据 List depts= new ArrayList(2); depts.add(new Dept(90,"Manager","YT")); depts.add(new Dept(100,"Manager","YTT")); depts.add(new Dept(110,"Manager","YTTT")); depts.add(new Dept(120,"Manager","YTTTT")); //批量提交,每次提交2个 deptService.saveBatch(depts,2); List list1 = deptService.list(); list1.forEach(System.out::println); } }SaveOrUpdate 1,该方法要求有TableId注解,如果没有TableId主键注解,则报错com.baomidou.mybatisplus.core.exceptions.MybatisPlusException: error: can not execute. because can not find column for id from entity! 2,根据是否有主键值来决定是执行更新还是存储,如果有则更新,否则就存储, 3,如果带有条件构造器,那么满足条件的执行,否则不执行; // TableId 注解 存在更新记录，否插入一条记录 boolean saveOrUpdate(T entity); // 根据updateWrapper尝试更新，否继续执行saveOrUpdate(T)方法 boolean saveOrUpdate(T entity, Wrapper updateWrapper); // 批量修改插入 boolean saveOrUpdateBatch(Collection entityList); // 批量修改插入 boolean saveOrUpdateBatch(Collection entityList, int batchSize);实践代码—>> @Test void contextLoads3() { //该方法要求有TableId注解, //根据是否有主键值来决定是执行更新还是存储, //如果有则更新,否则就存储, Dept dept = new Dept(180, "Manager", "黑龙江"); deptService.saveOrUpdate(dept); }原来数据—>> 结果—大于deptno>=100的都更新了 运行结果 实践代码–> @Test void contextLoads4() { Dept dept = new Dept(180, "Manager", "黑龙江"); deptService.removeById(dept); UpdateWrapper wrappers= new UpdateWrapper(); wrappers.ge("deptno",100); deptService.remove(wrappers); List list= new ArrayList(2); list.add(new Dept(300,"Clerk","QD"));//存在 list.add(new Dept(400,"Clerk","QQD"));//不存在 list.add(new Dept(500,"Clerk","QDD"));//不存在 deptService.removeBatchByIds(list,2) ; deptService.removeById(90);//可以直接根据主键删除 //可以根据map来删除 Mapmap = new HashMap(); map.put("deptno",70); deptService.removeByMap(map); }
跟上面remove类似,实践代码略 Get // 根据 ID 查询 T getById(Serializable id); // 根据 Wrapper，查询一条记录。结果集，如果是多个会抛出异常，随机取一条加上限制条件 wrapper.last("LIMIT 1") T getOne(Wrapper queryWrapper); // 根据 Wrapper，查询一条记录 T getOne(Wrapper queryWrapper, boolean throwEx); // 根据 Wrapper，查询一条记录 Map getMap(Wrapper queryWrapper); // 根据 Wrapper，查询一条记录 V getObj(Wrapper queryWrapper, Function |
MybatisPlus特点
mybatisplus是在mybatis的curd基础上及逆行增强,所以需要将mybatis中的SqlSessionFactory替换为调整 SqlSessionFactory 为 MyBatis-Plus 的 SqlSessionFactory 看一下xml中的配置—>>
查看源码–>>
接口实现类—ServiceImpl
mybatis与mybatis-plus基本配置对比
mapper接口----->>
@TableField 属性/字段注解(非主键)
MyBatis-Plus 支持 Velocity（默认）、Freemarker、Beetl，可以采用自定义模板引擎。
基本按照上面那个模板来就好, 这个模板的思路是---->>![[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-6i9OGYRy-1644313641190)(https://img-mid.csdnimg.cn/release/static/image/mid/ask/155522313446148.png "#left")]](https://img-blog.csdnimg.cn/538724c4b42744a1a4ec59bb42ab645a.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBAQ29kZU1hcnRhaW4=,size_20,color_FFFFFF,t_70,g_se,x_16)
目录结构 
注入配置
策略配置
执行后; 
带有条件构造器的部分代码
当没有大于100的纪录时,会将该值插入;
Remove
Update【本文地址】