簡介
Mybatis-Plus（簡稱MP）是一個 Mybatis 的增強工具，在 Mybatis 的基礎上只做增強不做改變，為簡化開發、提高效率而生。
特性
無侵入：Mybatis-Plus 在 Mybatis 的基礎上進行擴展，只做增強不做改變，引入 Mybatis-Plus 不會對您現有的 Mybatis 構架產生任何影響，而且 MP 支持所有 Mybatis 原生的特性 依賴少：僅僅依賴 Mybatis 以及 Mybatis-Spring 損耗小：啟動即會自動注入基本CURD，性能基本無損耗，直接面向對象操作 預防Sql注入：內置Sql注入剝離器，有效預防Sql注入攻擊 通用CRUD操作：內置通用 Mapper、通用 Service，僅僅通過少量配置即可實現單表大部分 CRUD 操作，更有強大的條件構造器，滿足各類使用需求 多種主鍵策略：支持多達4種主鍵策略（內含分布式唯一ID生成器），可自由配置，完美解決主鍵問題 支持ActiveRecord：支持 ActiveRecord 形式調用，實體類只需繼承 Model 類即可實現基本 CRUD 操作 支持代碼生成：采用代碼或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 層代碼，支持模板引擎，更有超多自定義配置等您來使用（P.S. 比 Mybatis 官方的 Generator 更加強大！） 支持自定義全局通用操作：支持全局通用方法注入（ Write once, use anywhere ） 支持關鍵詞自動轉義：支持數據庫關鍵詞（order、key……）自動轉義，還可自定義關鍵詞 內置分頁插件：基於Mybatis物理分頁，開發者無需關心具體操作，配置好插件之后，寫分頁等同於普通List查詢 內置性能分析插件：可輸出Sql語句以及其執行時間，建議開發測試時啟用該功能，能有效解決慢查詢 內置全局攔截插件：提供全表 delete 、 update 操作智能分析阻斷，預防誤操作
集成
Mybatis-Plus 的集成非常簡單，對於 Spring，我們僅僅需要把 Mybatis 自帶的MybatisSqlSessionFactoryBean替換為 MP 自帶的即可。
使用：
1.pom.xml依賴：
<!--Mybatis-plus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatisplus-spring-boot-starter</artifactId>
<version>1.0.5</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus</artifactId>
<version>2.3</version>
</dependency>
如果要自動生成代碼，那么還要加入模板引擎：
Velocity引擎：
<!-- Code generator test sample-->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity</artifactId>
<version>1.7</version>
</dependency>
或者Freemarker引擎：
<!-- https://mvnrepository.com/artifact/org.freemarker/freemarker --> <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> <version>2.3.28</version> </dependency>
這兩個引擎隨便選擇一個就可以，在自動生成代碼的時候選擇配置即可。
Mybatis及Mybatis-Spring依賴請勿加入項目配置，以免引起版本沖突！！！Mybatis-Plus會自動幫你維護！
2.自動生成代碼：
import com.baomidou.mybatisplus.enums.FieldFill; 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.PackageConfig; import com.baomidou.mybatisplus.generator.config.StrategyConfig; import com.baomidou.mybatisplus.generator.config.TemplateConfig; import com.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert; import com.baomidou.mybatisplus.generator.config.po.TableFill; import com.baomidou.mybatisplus.generator.config.po.TableInfo; import com.baomidou.mybatisplus.generator.config.rules.DbColumnType; import com.baomidou.mybatisplus.generator.config.rules.DbType; import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy; import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine; import java.util.ArrayList; import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Map; import org.junit.Test; /** * Created by qhong on 2018/7/25 17:40 **/ public class MysqlGenerator extends GeneratorTest { @Test public void generateCode() { //0 Velocity引擎 1 Freemarker引擎 int result=1; // 自定義需要填充的字段 List<TableFill> tableFillList = new ArrayList<>(); tableFillList.add(new TableFill("ASDD_SS", FieldFill.INSERT_UPDATE)); // 代碼生成器 AutoGenerator mpg = new AutoGenerator().setGlobalConfig( // 全局配置 new GlobalConfig() .setOutputDir("src\\main\\java")//輸出目錄 .setFileOverride(true)// 是否覆蓋文件 .setActiveRecord(true)// 開啟 activeRecord 模式 .setEnableCache(false)// XML 二級緩存 .setBaseResultMap(true)// XML ResultMap .setBaseColumnList(true)// XML columList //.setKotlin(true) 是否生成 kotlin 代碼 .setAuthor("qhong") // 自定義文件命名，注意 %s 會自動填充表實體屬性！ // .setMapperName("%sDao") // .setXmlName("%sDao") // .setServiceName("MP%sService") // .setServiceImplName("%sServiceDiy") // .setControllerName("%sAction") ).setDataSource( // 數據源配置 new DataSourceConfig() .setDbType(DbType.MYSQL)// 數據庫類型 .setTypeConvert(new MySqlTypeConvert() { // 自定義數據庫表字段類型轉換【可選】 @Override public DbColumnType processTypeConvert(String fieldType) { System.out.println("轉換類型：" + fieldType); // if ( fieldType.toLowerCase().contains( "tinyint" ) ) { // return DbColumnType.BOOLEAN; // } return super.processTypeConvert(fieldType); } }) .setDriverName("com.mysql.jdbc.Driver") .setUsername("root") .setPassword("hongda$123456") .setUrl("jdbc:mysql://127.0.0.1:3306/test1?characterEncoding=utf8") ).setStrategy( // 策略配置 new StrategyConfig() // .setCapitalMode(true)// 全局大寫命名 // .setDbColumnUnderline(true)//全局下划線命名 .setTablePrefix(new String[]{"bmd_", "mp_"})// 此處可以修改為您的表前綴 .setNaming(NamingStrategy.underline_to_camel)// 表名生成策略 // .setInclude(new String[] { "user" }) // 需要生成的表 // .setExclude(new String[]{"test"}) // 排除生成的表 .setExclude(new String[]{"sc"}) // 自定義實體父類 // .setSuperEntityClass("com.baomidou.demo.TestEntity") // 自定義實體，公共字段 .setSuperEntityColumns(new String[]{"test_id"}) .setTableFillList(tableFillList) // 自定義 mapper 父類 // .setSuperMapperClass("com.baomidou.demo.TestMapper") // 自定義 service 父類 // .setSuperServiceClass("com.baomidou.demo.TestService") // 自定義 service 實現類父類 // .setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl") // 自定義 controller 父類 // .setSuperControllerClass("com.baomidou.demo.TestController") // 【實體】是否生成字段常量（默認 false） // public static final String ID = "test_id"; // .setEntityColumnConstant(true) // 【實體】是否為構建者模型（默認 false） // public User setName(String name) {this.name = name; return this;} // .setEntityBuilderModel(true) // 【實體】是否為lombok模型（默認 false）<a href="https://projectlombok.org/">document</a> // .setEntityLombokModel(true) // Boolean類型字段是否移除is前綴處理 // .setEntityBooleanColumnRemoveIsPrefix(true) // .setRestControllerStyle(true) // .setControllerMappingHyphenStyle(true) ).setPackageInfo( // 包配置 new PackageConfig() .setModuleName(null) .setParent("com.qhong.modules")// 自定義包路徑 .setController("controller")// 這里是控制器包名，默認 web ).setCfg( // 注入自定義配置，可以在 VM 中使用 cfg.abc 設置的值 new InjectionConfig() { @Override public void initMap() { Map<String, Object> map = new HashMap<>(); map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp"); this.setMap(map); } }.setFileOutConfigList(Collections.<FileOutConfig>singletonList(new FileOutConfig( "/templates/mapper.xml" + ((1 == result) ? ".ftl" : ".vm")) { // 自定義輸出文件目錄 @Override public String outputFile(TableInfo tableInfo) { return "src/main/resources/mapper/" + tableInfo.getEntityName() + ".xml"; } })) ).setTemplate( // 關閉默認 xml 生成，調整生成 至 根目錄 new TemplateConfig().setXml(null) // 自定義模板配置，模板可以參考源碼 /mybatis-plus/src/main/resources/template 使用 copy // 至您項目 src/main/resources/template 目錄下，模板名稱也可自定義如下配置： // .setController("..."); // .setEntity("..."); // .setMapper("..."); // .setXml("..."); // .setService("..."); // .setServiceImpl("..."); ); // 執行生成 if (1 == result) { mpg.setTemplateEngine(new FreemarkerTemplateEngine()); } mpg.execute(); // 打印注入設置，這里演示模板里面怎么獲取注入內容【可無】 System.err.println(mpg.getCfg().getMap().get("abc")); } }
3.配置：
MybatisPlusConfig：
import com.baomidou.mybatisplus.incrementer.H2KeyGenerator; import com.baomidou.mybatisplus.incrementer.IKeyGenerator; import com.baomidou.mybatisplus.mapper.ISqlInjector; import com.baomidou.mybatisplus.mapper.LogicSqlInjector; import com.baomidou.mybatisplus.mapper.MetaObjectHandler; import com.baomidou.mybatisplus.plugins.PaginationInterceptor; import com.baomidou.mybatisplus.plugins.PerformanceInterceptor; import com.qhong.filter.MyMetaObjectHandler; import org.mybatis.spring.annotation.MapperScan; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Profile; import org.springframework.transaction.annotation.EnableTransactionManagement; /** * Created by qhong on 2018/7/25 16:43 **/ @EnableTransactionManagement @Configuration @MapperScan("com.qhong.modules.mapper*") public class MybatisPlusConfig { /** * mybatis-plus SQL執行效率插件【生產環境可以關閉】 */ @Bean @Profile({"dev","test"})// 設置 dev test 環境開啟 public PerformanceInterceptor performanceInterceptor() { return new PerformanceInterceptor(); } /** * mybatis-plus分頁插件<br> * 文檔：http://mp.baomidou.com<br> */ @Bean public PaginationInterceptor paginationInterceptor() { return new PaginationInterceptor(); } @Bean public MetaObjectHandler metaObjectHandler(){ return new MyMetaObjectHandler(); } /** * 注入主鍵生成器 */ @Bean public IKeyGenerator keyGenerator(){ return new H2KeyGenerator(); } /** * 注入sql注入器 */ @Bean public ISqlInjector sqlInjector(){ return new LogicSqlInjector(); } }
application.properties:
#mybatis-plus # 如果是放在src/main/java目錄下 classpath:/com/yourpackage/*/mapper/*.xml # 如果是放在resource目錄 classpath:/mapper/*.xml mybatis-plus.mapper-locations=classpath:/mapper/*.xml #實體掃描，多個package用逗號或者分號分隔 mybatis-plus.typeAliasesPackage=com.qhong.modules.entity #主鍵類型 0:"數據庫ID自增", 1:"用戶輸入ID",2:"全局唯一ID (數字類型唯一ID)", 3:"全局唯一ID UUID"; mybatis-plus.global-config.id-type=2 #字段策略 0:"忽略判斷",1:"非 NULL 判斷"),2:"非空判斷" mybatis-plus.global-config.field-strategy=2 #駝峰下划線轉換 mybatis-plus.global-config.db-column-underline=true #mp2.3+ 全局表前綴 mp_ #mybatis-plus.global-config.table-prefix=mp_ # Sequence序列接口實現類配置,如果不配置，自動獲取數據庫類型 mybatis-plus.global-config.key-generator=com.baomidou.mybatisplus.incrementer.OracleKeyGenerator #邏輯刪除配置（下面3個配置） mybatis-plus.global-config.logic-delete-value=1 mybatis-plus.global-config.logic-not-delete-value=0 mybatis-plus.global-config.sql-injector=com.baomidou.mybatisplus.mapper.LogicSqlInjector #自定義填充策略接口實現 mybatis-plus.global-config.meta-object-handler=com.qhong.filter.MyMetaObjectHandler #配置返回數據庫(column下划線命名&&返回java實體是駝峰命名)，自動匹配無需as（沒開啟這個，SQL需要寫as： select user_id as userId） mybatis-plus.configuration.map-underscore-to-camel-case=true mybatis-plus.configuration.cache-enabled=false #配置JdbcTypeForNull, oracle數據庫必須配置 mybatis-plus.configuration.jdbc-type-for-null=null
4.代碼：
基本就使用第一步自動生成代碼即可，注意數據庫表和字段如果不是很規范，要自己手動設置TableField
@TableField(value="userSex") private String userSex; @TableField(value="nickName") private String nickName;
如果我自己不配置，那么抓取sql會發現，字段變成user_Sex,nick_Name,當然這是因為我大部分都是由下划線的，所以設置成駝峰下划線轉換的，但是有個別不規范的要注意。
參考：
http://baomidou.oschina.io/mybatis-plus-doc/#/spring-boot
https://blog.csdn.net/helloPurple/article/details/78715508