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"));
    }

}