springboot-mybatisplus的使用笔记

mybatisPlus的使用可以参考：https://www.cnblogs.com/miaoying/p/12625920.html

以下是我本地配置的自动生成关键代码

/**
 * mybatis中自動生成器
 * 支持自定义模板（需要配置）
 * 支持自定义生成的代码位置（需要配置）
 */
public class CodeGenerator {

    /***************************第一部分：设置静态变量配置***********************************/
    /**
     * （1）代码生成位置（根路径，也可以理解为多模块的根目录）
     * 解释：根据你现在package位置，获取根package全路径
     */
    public static final String PARENT_NAME = "com.example.testmybatisplus";

    /**
     * （2）代码生成的模块（模块名称，可以理解为模块的名称）
     * 解释：如果你项目有多个模块，那么哪个模块需要自动生成代码的，就写上那个模块的名称（如果没有多个模块，这里可以为空）
     */
    public static final String MODULAR_NAME = "";

    /**
     * (3)基本路径
     * 解释：一般来说都是“src/main/java/”（这里可以按照默认就行，不用改）
     */
    public static final String SRC_MAIN_JAVA = "src/main/java/";

    /**
     * （4）作者
     * 解释：这里写上你们的大名就行，主要是生成注释的时候会加上去
     */
    public static final String AUTHOR = "xcf";

    /**
     * （5）是否是 rest 接口
     *  解释：这里设置是否生成的controller是rest的接口（主要是加上了@RestController注解）
     */
    private static final boolean REST_CONTROLLER_STYLE = true;

    /**
     * (6)连接信息
     * 解释：这里根据自己实际数据库内容更改就行了
     */
    public static final String JDBC_MYSQL_URL = "jdbc:mysql://192.168.1.104:3306/test?" +
            "useUnicode=true&useSSL=false&characterEncoding=utf8";

    /**
     * （6.1）驱动包
     */
    public static final String JDBC_DRIVER_NAME = "com.mysql.cj.jdbc.Driver";

    /**
     * （6.2）数据库账号
     */
    public static final String JDBC_USERNAME = "xiecanfeng";

    /**
     * (6.3)数据库密码
     */
    public static final String JDBC_PASSWORD = "xiecanfeng!123";


    /***************************第二部分：采用监控控制台来动态输入方法***********************************/

    /**（不用更改，copy即可）
     * <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 + "！");
    }


    /***************************第三部分：采用main方法执行***********************************/

    /**
     * 自动生成main代码，这个方法需要组装多个模块，具体模块可以看autoGenerator方法内容
     * @param args
     */
    public static void main(String[] args) {
        String moduleName = scanner("模块名");
        String tableName = scanner("表名，多个英文逗号分割");
        autoGenerator(moduleName, tableName);
    }

    /***************************第四部分：定义自动生成方法。配置需要的参数***********************************/

    /**
     * 自动生成方法
     * @param moduleName 模块名称
     * @param tableName 表名称（多个英文逗号分割）
     */
    public static void autoGenerator(String moduleName, String tableName) {
        new AutoGenerator()//1.新建代码生成器对象
                .setGlobalConfig(getGlobalConfig())//2.设置全局配置
                .setDataSource(getDataSourceConfig())//3.数据源配置
                .setPackageInfo(getPackageConfig(moduleName))//4.包配置
                .setStrategy(getStrategyConfig(tableName, moduleName))//5.策略配置
//                .setCfg(getInjectionConfig(moduleName))//6.自定义配置(如果想在resource目录下的mapper中生成xml映射文件的话，这里可以放开注释)
                .setTemplate(getTemplateConfig())//7.配置模板
                .execute();
    }

    /**
     * 2.设置全局配置
     * @return
     */
    private static GlobalConfig getGlobalConfig() {
        String projectPath = System.getProperty("user.dir");
        String filePath = projectPath + "/" + MODULAR_NAME + SRC_MAIN_JAVA;
        if (PlatformUtil.isWindows()) {
            filePath = filePath.replaceAll("/+|\\\\+", "\\\\");
        } else {
            filePath = filePath.replaceAll("/+|\\\\+", "/");
        }
        return new GlobalConfig()
                .setOutputDir(filePath)
                .setDateType(DateType.ONLY_DATE)
                .setIdType(IdType.UUID)
                .setAuthor(AUTHOR)
                .setBaseColumnList(true)
                .setSwagger2(true)
                .setEnableCache(false)
                .setBaseResultMap(true)
                .setServiceName("%sService")  // 设置Service接口生成名称,这样生成接口前面就不会有 I
                .setOpen(false);
    }

    /**
     * 3.数据源配置
     * @return
     */
    private static DataSourceConfig getDataSourceConfig() {
        return new DataSourceConfig()
                .setUrl(JDBC_MYSQL_URL)
                .setDriverName(JDBC_DRIVER_NAME)
                .setUsername(JDBC_USERNAME)
                .setPassword(JDBC_PASSWORD);
    }

    /**
     * 4.包配置
     * @param moduleName
     * @return
     */
    private static PackageConfig getPackageConfig(String moduleName) {
        return new PackageConfig()
                .setModuleName(moduleName)
                .setParent(PARENT_NAME)
                .setService("service")
                .setServiceImpl("service.impl")
                .setController("controller")
                .setEntity("entity");
    }

    /**
     * 5.策略配置
     * @param tableName
     * @param moduleName
     * @return
     */
    private static StrategyConfig getStrategyConfig(String tableName, String moduleName) {
        return new StrategyConfig()
                .setNaming(NamingStrategy.underline_to_camel)
                .setColumnNaming(NamingStrategy.underline_to_camel)
                .setInclude(tableName.split(","))
                .setRestControllerStyle(REST_CONTROLLER_STYLE)
                .setEntityBuilderModel(true)
                .setControllerMappingHyphenStyle(true)
                .entityTableFieldAnnotationEnable(true)
                .setTablePrefix(moduleName + "_");
    }

    /**
     * 6.自定义配置
     * @param moduleName
     * @return
     */
    private static InjectionConfig getInjectionConfig(final String moduleName) {
        return new InjectionConfig() {
            @Override
            public void initMap() {
                Map map = new HashMap();
                map.put("dateTime", getDateTime());
                setMap(map);
                final String projectPath = System.getProperty("user.dir");
                List<FileOutConfig> fileOutConfigList = new ArrayList<FileOutConfig>();
                // 自定义配置会被优先输出
                fileOutConfigList.add(new FileOutConfig("/templates/mapper.xml.vm") {
                    @Override
                    public String outputFile(TableInfo tableInfo) {
                        // 自定义输出文件名，如果entity设置了前后缀，此次注意xml的名称也会跟着发生变化
                        return projectPath + "/src/main/resources/mapper/" +
                                moduleName + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
                    }
                });
                setFileOutConfigList(fileOutConfigList);
            }
        };
    }
    private static String getDateTime() {
        LocalDateTime localDate = LocalDateTime.now();
        DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
        return localDate.format(formatter);
    }

    /**
     * 7.配置模板
     * @return
     */
    private static TemplateConfig getTemplateConfig() {
        return new TemplateConfig()
                .setController("/codeGenerator/controller.java.vm")
                .setService("/codeGenerator/service.java.vm")
                .setServiceImpl("/codeGenerator/serviceImpl.java.vm")
                .setEntity("/codeGenerator/entity.java.vm")
                .setMapper("/codeGenerator/mapper.java.vm")
                .setXml("/codeGenerator/mapper.xml.vm");
    }

}

官网地址：代码生成器