springboot整合mybatis-plus，实现逆向工程生成代码，并实现分页

记录一下springboot整合mybatis-plus的主要步骤 

1、创建一个springboot应用，加入web、lombok等必要的选项 

2、添加依赖

添加mysql、mybatis-plus、数据源等必要的依赖

    org.springframework.boot
    spring-boot-starter-web




    mysql
    mysql-connector-java



    com.alibaba
    druid-spring-boot-starter
    1.1.20



    com.baomidou
    mybatis-plus-boot-starter
    3.3.2



    com.baomidou
    mybatis-plus-generator
    3.3.2



    org.freemarker
    freemarker

3、数据库配置

spring:
  #数据库配置
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/test?characterEncoding=utf8&allowMultiQueries=true&useSSL=false&serverTimezone=UTC
    username: root
    password: root
    # 使用druid数据源
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.jdbc.Driver

4、创建代码生成器

里面的部分内容需要根据实际情况修改

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.isNotEmpty(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "！");
    }

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();
        //手动设置moduleName，项目子模块名称
        //TODO，项目模块，如果有模块名称，则需要修改
        String projectModuleName = "";

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/" + projectModuleName + "/src/main/java");
        gc.setAuthor("ssang");
        gc.setOpen(false);
        // service 命名方式
        gc.setServiceName("%sService");
        // service impl 命名方式
        gc.setServiceImplName("%sServiceImpl");
        // 自定义文件命名，注意 %s 会自动填充表实体属性！
        gc.setMapperName("%sMapper");
        gc.setXmlName("%sMapper");
        gc.setFileOverride(true);
        gc.setActiveRecord(true);
        // XML 二级缓存
        gc.setEnableCache(false);
        // XML ResultMap
        gc.setBaseResultMap(true);
        // XML columList
        gc.setBaseColumnList(false);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://127.0.0.1:3306/root?characterEncoding=utf8&allowMultiQueries=true&useSSL=false&serverTimezone=UTC");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        mpg.setDataSource(dsc);

        // 包配置（java类）
        PackageConfig pc = new PackageConfig();
        //TODO，用来给mapper的xml文件、controller、entity、mapper和service创建分类的包，没有则设置为null
        //例如：输入test，则test/mapper/*.xml,test/controller/*Controller.java,test/entity/*.java,以此例推
        //pc.setModuleName(scanner("xml模块名"));
        pc.setModuleName(null);
        //TODO，根据实际包名修改
        pc.setParent("com.test.base");
        pc.setEntity("entity");
        pc.setService("service");
        pc.setServiceImpl("service.impl");
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        //xml文件
        // 如果模板引擎是 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 的名称会跟着发生变化！！
                String moduleName = pc.getModuleName()==null?"":pc.getModuleName();
                return projectPath + "/" + projectModuleName + "/src/main/resources/mapper/" + moduleName
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录");
                return false;
            }
        });
        */
        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("cn.com.bluemoon.demo.entity");
        //【实体】是否为lombok模型（默认 false）
        //strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父类
        //strategy.setSuperControllerClass("cn.com.bluemoon.demo.controller");
        // 写于父类中的公共字段
        //strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
}

5、启动类添加mapper扫描路径

@SpringBootApplication
@MapperScan("com.ang.mybatisplus.base.mapper")
public class MybatisPlusApplication {
    public static void main(String[] args) {
        SpringApplication.run(MybatisPlusApplication.class, args);
    }
}

6、创建测试数据库，并进行逆向工程

7、创建测试接口，页面直接访问

@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    UserService userService;
    @RequestMapping("/list")
    public List list(){
        QueryWrapper wrapper = new QueryWrapper();
        wrapper.eq("id",1);
        List list = userService.list();
        return list;
    }
}

8、创建配置类，实现分页

@Configuration
@MapperScan("com.test.mapper")
public class MybatisPlusConfig {
    // 旧版
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        // 设置请求的页面大于最大页后操作， true调回到首页，false 继续请求  默认false
        // paginationInterceptor.setOverflow(false);
        // 设置最大单页限制数量，默认 500 条，-1 不受限制
        // paginationInterceptor.setLimit(500);
        // 开启 count 的 join 优化,只针对部分 left join
        paginationInterceptor.setCountSqlParser(new JsqlParserCountOptimize(true));
        return paginationInterceptor;
    }

    // 最新版
//    @Bean
//    public MybatisPlusInterceptor mybatisPlusInterceptor() {
//        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
//        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
//        return interceptor;
//    }
}

9、创建测试接口

//适合复杂查询，需要写service
@RequestMapping("/selectPage1")
public Object selectPage1(){
    //Page()参数：当前索引、显示数量、是否需要查询总数，默认为true，如果不需要查询count
    //需要手动改为false，如Page page = new Page(1,3,false)
    Page page = new Page(1,3);
    IPage iPage = tStudentService.getStudentPage(page);
    List result = iPage.getRecords();
    return result;
}

//适合单表操作，不需要写service
@RequestMapping("/selectPage2")
public Object selectPage2(){
    Page page = new Page(1,3);
    QueryWrapper wrapper = new QueryWrapper<>();
    wrapper.like("name","小");
    IPage iPage = studentMapper.selectPage(page,wrapper);
    List result = iPage.getRecords();
    return result;
}