mybatisplus自動生成

一，pom依賴

 <!-- MP 核心庫 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus</artifactId>
            <version>3.2.0</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.2.0</version>
        </dependency>
    &lt;!-- 模板引擎 --&gt;
    &lt;dependency&gt;
        &lt;groupId&gt;org.apache.velocity&lt;/groupId&gt;
        &lt;artifactId&gt;velocity-engine-core&lt;/artifactId&gt;
        &lt;version&gt;2.1&lt;/version&gt;
    &lt;/dependency&gt;</code></pre></div><p><b>二，<a href="https://link.zhihu.com/?target=http%3A//mybatisplusconfig.java/" class=" wrap external" target="_blank" rel="nofollow noreferrer" data-za-detail-view-id="1043">mybatisplusConfig.java</a></b></p><div class="highlight"><pre><code class="language-text">@Configuration

@MapperScan("com.qiao.itmc.mapper")
 public class MybatisPlusConfig {
 /*
 * 分頁插件，自動識別數據庫類型
 * 多租戶，請參考官網【插件擴展】
 /
 @Bean
 public PaginationInterceptor paginationInterceptor() {
 return new PaginationInterceptor();
 }
 @Bean("sqlSessionFactory")
 @Primary
 public SqlSessionFactory sqlSessionFactory(@Autowired @Qualifier("dataSource") DataSource dataSource) throws Exception {
 MybatisSqlSessionFactoryBean sqlSessionFactoryBean = new MybatisSqlSessionFactoryBean();
 sqlSessionFactoryBean.setDataSource(dataSource);
 sqlSessionFactoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/*.xml"));
 return sqlSessionFactoryBean.getObject();
 }
 }

注：sqlSessionFactory必須配置，不然找不到baseMapper中的方法。

三，CodeGenerator.java

注：自動生成Mapper,service,controller的類，其中用到的模板放在最后

package com.qiao.itmc.config;

import java.util.*;
import com.baomidou.mybatisplus.annotation.DbType;
 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;
public class CodeGenerator {
 // 演示例子，執行 main 方法控制台輸入模塊表名回車自動生成對應項目目錄中
/**
 * <p>
 * 讀取控制台內容
 * </p>
 */
public static String scanner(String tip) {
    Scanner scanner = new Scanner(system.in - 這個網站可出售。 - 最佳的System 來源和相關信息。);
    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 引擎，默認 Veloctiy
    //mpg.setTemplateEngine(new FreemarkerTemplateEngine());

    // 全局配置
    GlobalConfig gc = new GlobalConfig();
    gc.setOutputDir("E://workspace/itmc/src/main/java");    //生成文件的輸出目錄
    gc.setAuthor("qiao");                    //作者
    gc.setFileOverride(true);                //是否覆蓋已有文件 默認值：false
    gc.setOpen(false);                        //是否打開輸出目錄 默認值:true

// gc.setSwagger2(true); //開啟 swagger2 模式 默認false
 gc.setBaseColumnList(true); //開啟 baseColumnList 默認false
 gc.setBaseResultMap(true); //開啟 BaseResultMap 默認false
 //gc.setEntityName("%sQuery"); //實體命名方式 默認值：null 例如：%sEntity 生成 UserEntity
 gc.setMapperName("%sMapper"); //com.qiao.itmc.com 命名方式 默認值：null 例如：%sDao 生成 UserDao
 gc.setXmlName("%sMapper"); //Mapper xml 命名方式 默認值：null 例如：%sDao 生成 UserDao.xml
 gc.setServiceName("%sService"); //service 命名方式 默認值：null 例如：%sBusiness 生成 UserBusiness
 gc.setServiceImplName("%sServiceImpl"); //service impl 命名方式 默認值：null 例如：%sBusinessImpl 生成 UserBusinessImpl
 gc.setControllerName("%sController"); //controller 命名方式 默認值：null 例如：%sAction 生成 UserAction
 mpg.setGlobalConfig(gc);
    // 數據源配置
    DataSourceConfig dsc = new DataSourceConfig();
    dsc.setDbType(DbType.MYSQL);        //數據庫類型 該類內置了常用的數據庫類型【必須】
    dsc.setUrl("jdbc:mysql://127.0.0.1:3306/qingcheng?useUnicode=true&characterEncoding=UTF-8&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC");
    // dsc.setSchemaName("public");
    dsc.setDriverName("com.mysql.cj.jdbc.Driver");
    dsc.setUsername("root");
    dsc.setPassword("******");
    mpg.setDataSource(dsc);

    // 包配置
    PackageConfig pc = new PackageConfig();

// pc.setModuleName(scanner("模塊名"));
 pc.setParent("com.qiao.itmc");
 mpg.setPackageInfo(pc);
    // 自定義配置
    InjectionConfig cfg = new InjectionConfig() {
        @Override
        public void initMap() {        //注入自定義 Map 對象
            Map<String, Object> map = new HashMap<String, Object>();
            map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
            this.setMap(map);
            // to do nothing
        }
    };

    List<FileOutConfig> focList = new ArrayList<>();
    // 調整 controller 生成目錄演示
    focList.add(new FileOutConfig("/templates/controller.java.vm") {
        @Override
        public String outputFile(TableInfo tableInfo) {
            //輸出的位置
            return "E://workspace/itmc/src/main/java/com/qiao/itmc/controller/" + tableInfo.getEntityName() + "Controller.java";
        }
    });
    // 調整 service 生成目錄演示
    focList.add(new FileOutConfig("/templates/serviceImpl.java.vm") {
        @Override
        public String outputFile(TableInfo tableInfo) {
            //輸出的位置
            return "E://workspace/itmc/src/main/java/com/qiao/itmc/service/impl/" + tableInfo.getEntityName() + "ServiceImpl.java";
        }
    });
        /*focList.add(new FileOutConfig("/template/list.jsp.vm") {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定義輸入文件名稱
                return "E://workspace/itmc/src/main/webapp/jsp/"
                       + tableInfo.getEntityName() + ".jsp";
            }
        });*/
    cfg.setFileOutConfigList(focList);
    mpg.setCfg(cfg);


    // 策略配置 數據庫表配置，通過該配置，可指定需要生成哪些表或者排除哪些表
    StrategyConfig strategy = new StrategyConfig();
    strategy.setNaming(NamingStrategy.underline_to_camel);    //表名生成策略
    //  strategy.setColumnNaming(NamingStrategy.underline_to_camel);//數據庫表字段映射到實體的命名策略, 未指定按照 naming 執行

// strategy.setCapitalMode(true); // 全局大寫命名 ORACLE 注意
 // strategy.setTablePrefix("prefix"); //表前綴
 strategy.setSuperEntityClass("com.qiao.itmc.entity.BaseEntity"); //自定義繼承的Entity類全稱，帶包名
 //strategy.setEntityLombokModel(true); //【實體】是否為lombok模型（默認 false
 strategy.setRestControllerStyle(true); //生成 @RestController 控制器
 strategy.setSuperControllerClass("com.qiao.itmc.Jar.BaseController"); //自定義繼承的Controller類全稱，帶包名
 strategy.setInclude(scanner("表名")); //需要包含的表名，允許正則表達式（與exclude二選一配置）
 // strategy.setInclude(new String[] { "user" }); // 需要生成的表可以多張表
 // strategy.setExclude(new String[]{"test"}); // 排除生成的表
 strategy.setControllerMappingHyphenStyle(true); //駝峰轉連字符
 strategy.setTablePrefix(pc.getModuleName() + "_"); //是否生成實體時，生成字段注解
 mpg.setStrategy(strategy);
    // 配置模板
    TemplateConfig templateConfig = new TemplateConfig();
    // 配置自定義輸出模板
    //指定自定義模板路徑，注意不要帶上.ftl/.vm, 會根據使用的模板引擎自動識別
    // 如上任何一個模塊如果設置 空 OR Null 將不生成該模塊。
    // templateConfig.setEntity("templates/entity2.java");
    // templateConfig.setService();
    // templateConfig.setController();
    //templateConfig.setXml(null);
    mpg.setTemplate(templateConfig);
    mpg.execute();
}

}

四，上面用到的自定義模板

1， controller.java.vm

這個類是生成controller的模板，放在resources下的templates目錄下。

package ${package.Controller};

import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
 import ${package.Service}.${table.serviceName};
 import ${package.Entity}.${entity};
 import com.qiao.itmc.util.AjaxResult;
 import com.qiao.itmc.Jar.PageParam;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
 import java.util.List;
@RestController
 @RequestMapping("/${table.entityPath}")
 public class ${entity}Controller {
 @Autowired
 public ${table.serviceName} ${table.entityPath}Service;
/**
 * 保存和修改公用的
 * @param ${table.entityPath}  傳遞的實體
 * @return Ajaxresult轉換結果
 */
@RequestMapping(value="/save${entity}")
public AjaxResult save${entity}(${entity} ${table.entityPath}){
    try {
        if(${table.entityPath}.getId()!=null){
                ${table.entityPath}Service.updateById(${table.entityPath});
        }else{
                ${table.entityPath}Service.save(${table.entityPath});
        }
        return AjaxResult.me();
    } catch (Exception e) {
        e.printStackTrace();
        return AjaxResult.me(false,"保存對象失敗！"+e.getMessage());
    }
}

/**
* 刪除對象信息
* @param id
* @return
*/
@RequestMapping(value="delete/{id}")
public AjaxResult delete${entity}(@PathVariable("id") Long id){
    try {
            ${table.entityPath}Service.removeById(id);
        return AjaxResult.me();
    } catch (Exception e) {
        e.printStackTrace();
        return AjaxResult.me(false,"刪除對象失敗！"+e.getMessage());
    }
}

//獲取用戶
@RequestMapping(value = "find/{id}")
public ${entity} get${entity}(@PathVariable("id")Long id)
{
    return ${table.entityPath}Service.getById(id);
}


/**
* 查看所有的員工信息
* @return
*/
@RequestMapping(value = "/list${entity}")
public List<${entity}> list${entity}(){

    return ${table.entityPath}Service.list();
}

/**
* 分頁查詢數據
*
* @param query 查詢對象
* @return PageList 分頁對象
*/
@RequestMapping(value = "/pageList${entity}")
public Page<${entity}> json${entity}(@RequestBody ${entity} query)
{
    Page<${entity}> page = new Page(query.getPage(),query.getRows());
    return  (Page<${entity}>) ${table.entityPath}Service.page(page);
}

}

2，serviceImpl.java.vm

Service模板，因為繼承了自己的baseService,所以需要寫，生成默認service不需要寫。

package ${package.Service}.impl;

import com.qiao.itmc.Jar.BaseServiceImpl;
 import ${package.Entity}.${entity};
 import ${package.Mapper}.${table.mapperName};
 import ${package.Service}.${table.serviceName};
 import org.springframework.stereotype.Service;
/**

     
     
    
    
            
 
             
<p>
 
             
服務實現類
 
             
</p>
 
             
 
             
@author qiao
 
             
@since 2019-12-08
 */
 @Service
 public class ${entity}ServiceImpl extends BaseServiceImpl<${entity}Mapper, ${entity}> implements ${entity}Service {
 
            
}

五，用到的類

1，BaseEntity.java

基礎實體類，留給實體類繼承

@Setter@Getter

public class BaseEntity implements Serializable {

private transient  Integer page;

private transient  Integer rows;

}

2，BaseService.java,

基礎service,繼承mybatisplus的ServiceImpl類，baseService中可以寫一些自己的service層通用方法

import com.baomidou.mybatisplus.core.mapper.BaseMapper;

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;

/**

     
     
    
    
            
 
             
此處可以寫通用的Service
 
             
@param <M>
 
             
@param <T>
 */
 public class BaseServiceImpl<M extends BaseMapper<T>, T> extends ServiceImpl<M, T> {
 
            
}

————————————————

原文地址： https://zhuanlan.zhihu.com/p/97037541