springboot mybatis-plus 自动生成代码 generatorConfig

野性酷女 2021-11-16 13:18 371阅读 0赞

[https://gitee.com/baomidou/mybatis-plus-samples/tree/master/mybatis-plus-sample-generator][https_gitee.com_baomidou_mybatis-plus-samples_tree_master_mybatis-plus-sample-generator] 官方例子

方式一、

1.pom.xml

<dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus</artifactId>
                <version>3.0-beta</version>
            </dependency>

<plugin>
         <groupId>org.mybatis.generator</groupId>
         <artifactId>mybatis-generator-maven-plugin</artifactId>
         <version>1.3.7</version>//版本需要自己对应自己的mysql版本，我的 8.0.15 -- cmd执行：mysql -uroot -p123456
         <configuration>
             <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
             <verbose>true</verbose>
             <overwrite>true</overwrite>
         </configuration>
     </plugin>

2.新建generatorConfig.xml

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE generatorConfiguration
            PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
            "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
    
    <generatorConfiguration>
    
        <properties resource="application.yml" />
        
        <classPathEntry location="C:\Users\hfyx0\.m2\repository\mysql\mysql-connector-java\5.1.46\mysql-connector-java-5.1.46.jar" />
    
        <context id="Tables" targetRuntime="MyBatis3">
    
            
            <commentGenerator>
                
                <property name="suppressDate" value="true"/>
                
                <property name="suppressAllComments" value="true"/>
            </commentGenerator>
    
            
            <jdbcConnection
                    driverClass="com.mysql.jdbc.Driver"
                    connectionURL="jdbc:mysql://localhost:3306/kry"
                    userId="root"
                    password="123456">
            </jdbcConnection>
    
            
            
            <javaTypeResolver>
                
                <property name="forceBigDecimals" value="false" />
            </javaTypeResolver>
    
            
            <javaModelGenerator targetPackage="com.example.springbootmybatisgeneratortest.pojo" targetProject="src/main/java">
                
                <property name="trimStrings" value="true" />
                
                <property name="enableSubPackages" value="false" />
            </javaModelGenerator>
    
            
            <sqlMapGenerator targetPackage="mapper"  targetProject="src/main/resources">
                
                <property name="enableSubPackages" value="false" />
            </sqlMapGenerator>
    
            
            <javaClientGenerator targetPackage="com.example.springbootmybatisgeneratortest.mapper" targetProject="src/main/java" type="XMLMAPPER">
                
                <property name="enableSubPackages" value="false" />
            </javaClientGenerator>
    
            
            
    
            <table schema="kry" tableName="sys_user"
                   domainObjectName="SysUser" enableCountByExample="true"
                   enableDeleteByExample="true" enableSelectByExample="true"
                   enableUpdateByExample="true">
            </table>
    
          
        </context>
    </generatorConfiguration>

3.执行

方式一：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM0MzM4MTYy_size_16_color_FFFFFF_t_70][]

方式二：

mybatis-generator:generate -e

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM0MzM4MTYy_size_16_color_FFFFFF_t_70 1][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM0MzM4MTYy_size_16_color_FFFFFF_t_70 2][]

4.成功之后代码：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM0MzM4MTYy_size_16_color_FFFFFF_t_70 3][]

方式二、

pom.xml

maven方式1
     <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus</artifactId>
        <version>3.0-beta</version>
    </dependency>
    
    maven方式2
    注意：mybatis-plus-boot-starter中移除了自动生成代码功能，需要手动添加mybatis-plus-generator，
    但是在3.3.2版本中没有freemaker，需要再加freemarker
     <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.3.2</version>
            </dependency>
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.3.2</version>
            </dependency>
            <dependency>
                <groupId>org.freemarker</groupId>
                <artifactId>freemarker</artifactId>
                <version>2.3.28</version>
                <scope>compile</scope>
            </dependency>

package com.kry.xr.util;
    
    import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
    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 MybatisPlusGeneratorUtil {
            /*  <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus</artifactId>
                <version>3.0-beta</version>
            </dependency>*/
    
            // 全局配置
            private final static String OUTPUT_DIR = "/src/main/java";// 生成文件的输出目录
            private final static String AUTHOR = "kry";// 开发人员
    
            private final static String PARENT = "com.kry";// 父包名。如果为空，将下面子包名必须写全部， 否则就只需写子包名
            private final static String MODULE_NAME = "xr";// 父包模块名
    
            /**
             * <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 + "！");
            }
            /**
             * RUN THIS
             */
            public static void main(String[] args) {
                // 代码生成器
                AutoGenerator mpg = new AutoGenerator();
                // 全局配置
                GlobalConfig gc = new GlobalConfig();
                String projectPath = System.getProperty("user.dir");
                gc.setOutputDir(projectPath + OUTPUT_DIR);
                gc.setAuthor(AUTHOR);
                gc.setOpen(false);
                gc.setBaseResultMap(true);
                gc.setBaseColumnList(true);
                mpg.setGlobalConfig(gc);
                // 数据源配置
                DataSourceConfig dsc = new DataSourceConfig();
                dsc.setUrl("jdbc:mysql://localhost:3306/blog?useUnicode=true&useSSL=false&characterEncoding=utf8");
                // dsc.setSchemaName("public");
                dsc.setDriverName("com.mysql.jdbc.Driver");// JDK7
                //dsc.setDriverName("com.mysql.cj.jdbc.Driver");// JDK8
                dsc.setUsername("root");
                dsc.setPassword("root");
                mpg.setDataSource(dsc);
    
                // 包配置
                PackageConfig pc = new PackageConfig();
                //        pc.setModuleName(scanner("模块名"));
                pc.setModuleName(MODULE_NAME);
                pc.setParent(PARENT);
                mpg.setPackageInfo(pc);
    
                // 自定义配置
                InjectionConfig cfg = new InjectionConfig() {
                    @Override
                    public void initMap() {
                        // to do nothing
                    }
                };
                //自定义模板，生成自己想要的各种方法(如果没有就使用mybatis-plus自带的模板)
                List<FileOutConfig> focList = new ArrayList<>();
                focList.add(new FileOutConfig("/templates/mapper.xml.ftl") {
                    @Override
                    public String outputFile(TableInfo tableInfo) {
                        // 自定义输入文件名称
                        return projectPath + OUTPUT_DIR + "/" + PARENT.replaceAll("\\.", "/") + "/"
                                + MODULE_NAME + "/mapper/" + tableInfo.getEntityName() + "Mapper.xml" ;
                    }
                });
                cfg.setFileOutConfigList(focList);
                mpg.setCfg(cfg);
                mpg.setTemplate(new TemplateConfig().setXml(null));
                // 策略配置
                StrategyConfig strategy = new StrategyConfig();
                strategy.setNaming(NamingStrategy.underline_to_camel);
                strategy.setColumnNaming(NamingStrategy.underline_to_camel);
                //strategy.setSuperEntityClass("com.kry.xr.BaseEntity");
                strategy.setEntityLombokModel(true);//【实体】是否为lombok模型
                // strategy.setSuperControllerClass("com.kry.xr.BaseController");
                strategy.setSuperServiceClass("com.kry.xr.base.BaseService");
                strategy.setSuperServiceImplClass("com.kry.xr.base.service.BaseServiceimpl");
                strategy.setSuperMapperClass("com.kry.xr.base.IBaseMapper");
                //继承的类,生成类文建 public interface PressMapper extends BaseMapper<Press> {}
                strategy.setSuperMapperClass("com.baomidou.mybatisplus.core.mapper.BaseMapper");
                //strategy.setInclude(scanner("表名"));
                strategy.setInclude("t_user","t_press");
                strategy.setInclude("t_user");
                strategy.setSuperEntityColumns("id");
                strategy.setControllerMappingHyphenStyle(true);
                //生成类名去除表前缀
                strategy.setTablePrefix( "t_");
                mpg.setStrategy(strategy);
                // 选择 freemarker 引擎需要指定如下加，注意 pom 依赖必须有！
                mpg.setTemplateEngine(new FreemarkerTemplateEngine());
                mpg.execute();
                System.out.println("生成成功！");
            }
    
    }

自定义ftl模板

mapper.xml.ftl

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
    <mapper namespace="${package.Mapper}.${table.mapperName}">
    
    <#if enableCache>
        
        <cache type="org.mybatis.caches.ehcache.LoggingEhcache"/>
    
    </#if>
    <#if baseResultMap>
        
        <resultMap id="BaseResultMap" type="${package.Entity}.${entity}">
    <#list table.fields as field>
    <#if field.keyFlag><#--生成主键排在第一位-->
            <id column="${field.name}" property="${field.propertyName}" />
    </#if>
    </#list>
    <#list table.commonFields as field><#--生成公共字段 -->
        <result column="${field.name}" property="${field.propertyName}" />
    </#list>
    <#list table.fields as field>
    <#if !field.keyFlag><#--生成普通字段 -->
            <result column="${field.name}" property="${field.propertyName}" />
    </#if>
    </#list>
        </resultMap>
    
    </#if>
    <#if baseColumnList>
        
        <sql id="Base_Column_List">
    <#list table.commonFields as field>
            ${field.name},
    </#list>
            ${table.fieldNames}
        </sql>
    
    </#if>
    
    <#if baseColumnList>
        
        <select id="selectList" parameterType="string" resultMap="BaseResultMap">
           select
            <#list table.commonFields as field>
                ${field.name},
            </#list>
                ${table.fieldNames}
            from  ${table.name}
            <where>
                <#list table.fields as field>
                    <if test="${field.propertyName} != null">
                        and ${field.name} = ${r"#{"}${field.propertyName}${r"}"}
                    </if>
                </#list>
            </where>
    
        </select>
    </#if>
    
    <#if baseColumnList>
        
        <insert id="insert" parameterType="${package.Entity}.${entity}">
            insert into  ${table.name}
                ( ${table.fieldNames})
            values
               (
                <#list table.fields as field>
                    ${r"#{"}${field.propertyName}${r"}"}
                </#list>
                )
        </insert>
    </#if>
    
        <update id="update" parameterType="${package.Entity}.${entity}">
            update  ${table.name}
            <set>
                <#list table.fields as field>
                    <if test="${field.propertyName} != null">
                        ${field.name} = ${r"#{"}${field.propertyName}${r"}"},
                    </if>
                </#list>
            </set>
            <where>
                <#list table.commonFields as field>
                    <#if field.keyFlag><#--主键id位-->
                        ${field.name}=${r"#{"}${field.propertyName}${r"}"}
                    </#if>
                </#list>
            </where>
        </update>
    
    
        <delete id="deleteById" parameterType="${package.Entity}.${entity}">
            delete from ${table.name}
            <where>
                <#list table.commonFields as field>
                    <#if field.keyFlag><#--主键id位-->
                    and ${field.name}=${r"#{"}${field.propertyName}${r"}"}
                    </#if>
                </#list>
                <#list table.fields as field>
                <if test="${field.propertyName} != null">
                    and ${field.name} = ${r"#{"}${field.propertyName}${r"}"}
                </if>
                </#list>
            </where>
    
        </delete>
    </mapper>

controller.java.ftl

package ${package.Controller};
    
    
    import org.springframework.web.bind.annotation.*;
    import org.springframework.beans.factory.annotation.Autowired;
    import com.kry.xr.service.${table.serviceName};
    import com.kry.xr.entity.${entity};
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiOperation;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
    import java.util.List;
    <#if restControllerStyle>
     import org.springframework.web.bind.annotation.RestController;
    <#else>
     import org.springframework.stereotype.Controller;
    </#if>
    <#if superControllerClassPackage??>
     import ${superControllerClassPackage};
    </#if>
    
    /**
    * <p>
     * ${table.comment!} 前端控制器
     * </p>
    *
    * @author ${author}
    * @since ${date}
    * @version v1.0
    */
    <#if restControllerStyle>
     @Api(tags = {"${table.comment!}"})
     @RestController
    <#else>
     @Controller
    </#if>
    @RequestMapping("<#if package.ModuleName??>/${package.ModuleName}</#if>/<#if controllerMappingHyphenStyle??>${controllerMappingHyphen}<#else>${table.entityPath}</#if>")
    <#if kotlin>
    class ${table.controllerName}<#if superControllerClass??> : ${superControllerClass}()</#if>
    <#else>
    <#if superControllerClass??>
     public class ${table.controllerName} extends ${superControllerClass} {
    <#else>
     public class ${table.controllerName} {
    </#if>
    private Logger logger = LoggerFactory.getLogger(getClass());
    @Autowired
    private ${table.serviceName} ${(table.serviceName?substring(1))?uncap_first};
    
    /**
    * 查询分页数据
    */
    @ApiOperation(value = "查询分页数据")
    @RequestMapping(value = "/list")
    public String findListByPage(@RequestParam(name = "pageNum", defaultValue = "1") int pageNum,@RequestParam(name = "pageSize", defaultValue = "20") int pageSize){
     return null;
     }
    
    
     /**
     * 根据id查询
     * @author ${author}
     * @since ${date}
     */
     @ApiOperation(value = "根据id查询数据")
     @RequestMapping(value = "/getById")
     public String getById(@RequestParam("pkid") String pkid){
     return null;
     }
    
     /**
     * 新增
     * @author ${author}
     * @since ${date}
     */
     @ApiOperation(value = "新增数据")
     @RequestMapping(value = "/insert", method = RequestMethod.POST)
     public String insert(@RequestBody ${entity} ${entity?uncap_first}){
     return null;
     }
    
     /**
     * 删除
     * @author ${author}
     * @since ${date}
     */
     @ApiOperation(value = "删除数据")
     @RequestMapping(value = "/del")
     public String delete(@RequestParam("ids") List<String> ids){
       return null;
       }
    
      /**
      * 修改
      * @author ${author}
      * @since ${date}
      */
      @ApiOperation(value = "更新数据")
      @RequestMapping(value = "/update", method = RequestMethod.POST)
      public String update(@RequestBody ${entity} ${entity?uncap_first}){
      return null;
      }
    
      }
       </#if>

[https_gitee.com_baomidou_mybatis-plus-samples_tree_master_mybatis-plus-sample-generator]: https://gitee.com/baomidou/mybatis-plus-samples/tree/master/mybatis-plus-sample-generator
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM0MzM4MTYy_size_16_color_FFFFFF_t_70]: /images/20211116/d11abdf904d444fc983d6053ee1072ad.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM0MzM4MTYy_size_16_color_FFFFFF_t_70 1]: /images/20211116/7bf5729fadfe4b728f096eb081a60047.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM0MzM4MTYy_size_16_color_FFFFFF_t_70 2]: /images/20211116/0ba6d72163e54f30acc91ca4adbc2fe1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM0MzM4MTYy_size_16_color_FFFFFF_t_70 3]: /images/20211116/1de6c2b7927943749d83f65137540713.png