mybatis plus条件查询，分页查询，模糊查询，多表连接查询，完美融合mybatis.xml
接手一个新项目，里面使用的是Spring Cloud + mybatis plus，由于我一直使用的是Hibernate 或者 mybatis，所以为了提高开发效率，专门花了一天时间钻研mybatis plus
我自己新启了一个Spring Boot项目，集成了Mybatis Plus 与 mysql，关于框架方面，自动生成controller、service等可以自己在网上找资料，下面展示下我的一些使用记录。
1、mysql的日期时间类型，在mybatis plus自动生成时，字段在entity里会变成LocalDateTime类型（2021-03-31T16:02:20），这个是线程安全的，由于考虑到前端不好传递此类型，我选择在controller做处理：
@RequestMapping("/insertGood")
public boolean insertGood(String name, int sort, String createDate, String updateDate, BigDecimal price){
Good good = new Good();
good.setName(name);
good.setSort(sort);
good.setCreateDate(LocalDateTime.parse(createDate));//String与LocalDateTime转换
good.setUpdateDate(LocalDateTime.parse(updateDate));
good.setPrice(price);
boolean istrue = goodService.save(good);
return istrue;
}
2、QueryWrapper 条件构造器，多条件查询时可以这样使用：
@RequestMapping("/getGoodByParams")
public Good getGoodByParams(Good good){
QueryWrapper queryWrapper = new QueryWrapper();
queryWrapper.setEntity(good);
QueryWrapper<Good> queryWrapper1 = new QueryWrapper<>(good);
Good good1 = goodService.getOne(queryWrapper1);
return good1;
}
3、关于分页查询需要添加一个配置类，使用@Configuration注解，具体可以看下其他资料，这里我模糊查询与分页都放在了一起。
@RequestMapping("/getGoodByParamsPage")
public IPage<Good> getGoodByParamsPage(Good good){
QueryWrapper queryWrapper = new QueryWrapper();//条件构造器，不能直接赋值对象
//如QueryWrapper<Good> warpper = new QueryWrapper<>(good);会导致模糊查询失效
queryWrapper.setEntity(new Good());
queryWrapper.like(null != good.getName(),"name",good.getName()); //（条件，字段，字段值）；默认两边都有%
IPage<Good> page = new Page<>(1,5);//参数一是当前页，参数二是每页个数
//page = goodService.page(page,queryWrapper);
page = good.selectPage(page,queryWrapper);
return page;
}
4、多表关联查询，有两个方法，第一个方法类似于JPA形式，第二个方法是使用XML，看各自习惯和爱好选择。
Mapper.java文件
// import 省略 public interface QuestionMapper extends BaseMapper<Question> { /** * * @param page 翻页对象，可以作为 xml 参数直接使用，传递参数 Page 即自动分页 * @return */ @Select("SELECT t_question.*,t_student.`name` FROM t_question,t_student WHERE t_question.student_id=t_student.id") List<QuestionStudentVO> getQuestionStudent(Pagination page); }
Service文件
// import 省略 public interface QuestionService extends IService<Question> { Page<QuestionStudentVO> getQuestionStudent(Page<QuestionStudentVO> page); }
ServiceImpl文件
// 省略 import @Service public class QuestionServiceImpl extends ServiceImpl<QuestionMapper, Question> implements QuestionService { @Override public Page<QuestionStudentVO> getQuestionStudent(Page<QuestionStudentVO> page) { return page.setRecords(this.baseMapper.getQuestionStudent(page)); } }
看完上面这三段简单的代码，mybatis基础还可以的朋友应该都明白了，就像使用jpa一样，自己写接口，在Mapper类上配注解自己写表关联Sql。
我个人还是比较喜欢xml形式，下面贴一些关键的地方
1、配置文件，mybatis-plus只需要配置实体类的映射路径即可，因为一般单表业务，它是用不到xml的，不依赖xml映射。
#mybatis-plus # 如果是放在src/main/java目录下 classpath:/com/yourpackage/*/mapper/*Mapper.xml # 如果是放在resource目录 classpath:/mapper/*Mapper.xml #mybatis-plus.mapper-locations=classpath:mybatis/*.xml #实体扫描，多个package用逗号或者分号分隔 mybatis-plus.type-aliases-package=com.example.anear.mybatisplus.entity
2、配置mybatis的xml映射，mybatis的xml映射可以与mybatis-plus的实体映射完美契合在一起，当简单业务可以直接使用mybatis plus的CRUD(它封装的业务方法)，
当CRUD提供的方法不满足业务需求时，可以自己写Service接口，写Mapper，在XML文件里写SQL，等于在使用一般的Mybatis
mybatis: mapper-locations: classpath:mybatis/*.xml
注意点：
1、XML文件一定要使用Mybatis Plus自动生成原始的文件，不然自己手写的SQL会找不到，这个问题我找了两小时。
2、Mapper上不要加@Mapper注解，在启动类上加@MapperScan注解扫描Mapper类。
3、ServiceImpl实现类上加注解@Service（"接口类名称"）
4、如果手写的SQL与CRUD提供的方法名一致，以手写的SQL为准。
个人体验mybatis plus比generator还要强大，不仅支持自动生成，还满足分页、模糊查询等一系列有点复杂的操作，回想一下使用generator的时候，一般都是使用自己新建的sql，极力避免修改它自身生成的sql，因为庞大的项目规范要统一，这下mybatis plus把sql全部封装到底层，xml只给你留下写自己复杂业务的sql，是不是更清晰明了了。
最后贴一下Mybatis plus 自动生成的代码
package com.example.anear.util; import java.io.File; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; import com.baomidou.mybatisplus.annotation.DbType; import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.core.toolkit.StringPool; import com.baomidou.mybatisplus.generator.AutoGenerator; import com.baomidou.mybatisplus.generator.InjectionConfig; import com.baomidou.mybatisplus.generator.config.DataSourceConfig; import com.baomidou.mybatisplus.generator.config.FileOutConfig; import com.baomidou.mybatisplus.generator.config.GlobalConfig; import com.baomidou.mybatisplus.generator.config.IFileCreate; import com.baomidou.mybatisplus.generator.config.PackageConfig; import com.baomidou.mybatisplus.generator.config.StrategyConfig; import com.baomidou.mybatisplus.generator.config.TemplateConfig; import com.baomidou.mybatisplus.generator.config.builder.ConfigBuilder; import com.baomidou.mybatisplus.generator.config.po.TableInfo; import com.baomidou.mybatisplus.generator.config.rules.FileType; import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy; import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine; //演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中 public class MybatisPlusGenerator { // /** // * <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(); //整合配置 全局配置+数据源配置+策略配置+包名策略配置 // 选择 freemarker 引擎，默认 Velocity 需要在配置文件引入依赖 mpg.setTemplateEngine(new FreemarkerTemplateEngine()); // 1全局配置 GlobalConfig gc = new GlobalConfig(); gc.setAuthor("zcf"); String projectPath = System.getProperty("user.dir"); gc.setOutputDir(projectPath + "/src/main/java"); gc.setFileOverride(false);// 是否覆盖同名文件，默认是false gc.setIdType(IdType.AUTO);// 主键策略 gc.setActiveRecord(true);// 不需要ActiveRecord特性的请改为false gc.setEnableCache(false);// XML 二级缓存 gc.setBaseResultMap(true);// XML ResultMap 生成基本的resultmap gc.setBaseColumnList(false);// XML columList 生成基本的sql片段 /* 自定义文件命名，注意 %s 会自动填充表实体属性！ */ gc.setMapperName("%sMapper"); gc.setXmlName("%sMapper"); gc.setServiceName("%sService"); gc.setServiceImplName("%sServiceImpl"); gc.setControllerName("%sController"); mpg.setGlobalConfig(gc); // 2数据源配置 DataSourceConfig dsc = new DataSourceConfig(); dsc.setDbType(DbType.MYSQL); dsc.setDriverName("com.mysql.cj.jdbc.Driver"); dsc.setUsername("root"); dsc.setPassword("123456"); dsc.setUrl("jdbc:mysql://localhost:3306/anear?serverTimezone=Hongkong&useUnicode=true&characterEncoding=utf8"); mpg.setDataSource(dsc); // 3策略配置globalConfiguration中 StrategyConfig strategy = new StrategyConfig(); strategy.setEntityLombokModel(true);//实体类以lombok注解氏生产 strategy.setRestControllerStyle(true);//controller以restFule风格 // strategy.setCapitalMode(true);// 全局大写命名 ORACLE 注意 //strategy.setTablePrefix(new String[]{"test_"});// 此处可以修改为您的表前缀 strategy.setNaming(NamingStrategy.underline_to_camel);// 表名生成策略 此处可以更换为underline_to_camel 下滑线转驼峰 strategy.setInclude(new String[]{"good"}); // 需要生成的表 // strategy.setExclude(new String[]{"test"}); // 排除生成的表 // 自定义实体父类 // strategy.setSuperEntityClass("com.baomidou.demo.TestEntity"); // 自定义实体，公共字段 // strategy.setSuperEntityColumns(new String[] { "test_id", "age" }); // 自定义 mapper 父类 // strategy.setSuperMapperClass("com.baomidou.demo.TestMapper"); // 自定义 service 父类 // strategy.setSuperServiceClass("com.baomidou.demo.TestService"); // 自定义 service 实现类父类 // strategy.setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl"); // 自定义 controller 父类 // strategy.setSuperControllerClass("com.baomidou.demo.TestController"); // 【实体】是否生成字段常量（默认 false） // public static final String ID = "test_id"; // strategy.setEntityColumnConstant(true); // 【实体】是否为构建者模型（默认 false） // public User setName(String name) {this.name = name; return this;} // strategy.setEntityBuilderModel(true); mpg.setStrategy(strategy); // 4包配置 修改包生成的名称 //pkConfig.setParent("com.imooc") // .setMapper("dao")//dao // .setService("service")//servcie // .setController("controller")//controller // .setEntity("entity") // .setXml("resource");//mapper.xml PackageConfig pc = new PackageConfig(); pc.setParent("com.example.anear.mybatisplus"); pc.setEntity("entity"); pc.setMapper("mapper"); pc.setController("controller"); mpg.setPackageInfo(pc); // 注入自定义配置，可以在 VM 中使用 cfg.abc 【可无】 InjectionConfig cfg = new InjectionConfig() { @Override public void initMap() { Map<String, Object> map = new HashMap<String, Object>(); map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp"); this.setMap(map); } }; // 自定义 xxList.jsp 生成 List<FileOutConfig> focList = new ArrayList<>(); /*focList.add(new FileOutConfig("/template/list.jsp.vm") { @Override public String outputFile(TableInfo tableInfo) { // 自定义输入文件名称 return "D://workspace/study/springboot_mybatisplus_lombok/src/main/webapp/" + tableInfo.getEntityName() + ".jsp"; } }); cfg.setFileOutConfigList(focList); mpg.setCfg(cfg);*/ // 调整 xml 生成目录演示 focList.add(new FileOutConfig("/templates/mapper.xml.ftl") { @Override public String outputFile(TableInfo tableInfo) { return "src/main/resources/mybatis/" + tableInfo.getEntityName()+"Mapper" + ".xml"; } }); cfg.setFileOutConfigList(focList); mpg.setCfg(cfg); // 关闭默认 xml 生成，调整生成 至 根目录 TemplateConfig tc = new TemplateConfig(); tc.setXml(null); mpg.setTemplate(tc); // 自定义模板配置，可以 copy 源码 mybatis-plus/src/main/resources/templates 下面内容修改， // 放置自己项目的 src/main/resources/templates 目录下, 默认名称一下可以不配置，也可以自定义模板名称 // TemplateConfig tc = new TemplateConfig(); // tc.setController("..."); // tc.setEntity("..."); // tc.setMapper("..."); // tc.setXml("..."); // tc.setService("..."); // tc.setServiceImpl("..."); // 如上任何一个模块如果设置 空 OR Null 将不生成该模块。 // mpg.setTemplate(tc); // 执行生成 mpg.execute(); // 打印注入设置【可无】 // System.err.println(mpg.getCfg().getMap().get("abc")); } }
