SpringBoot學習筆記（四）：SpringBoot整合Mybatis-Plus+程式碼生成
阿新 • • 發佈：2019-01-02
簡介
官網：http://baomidou.oschina.io/mybatis-plus-doc/
平時業務程式碼不復雜的時候我們寫什麼程式碼寫的最多，就是我們的SQL語句啊，配置那麼多的Mapper.xml，還要配置什麼resultMap這些東西，還要去管理paramtype。就會很容易出現錯誤，比如什麼String can not parse to Integer之類的錯誤。
Mybatis-Plus，有了這個框架，我們可以做什麼？不用寫一句SQL，全部在JAVA程式碼中查詢完畢，對於一些只做增刪改查的管理系統，可以說業務層都可以免掉了。
MP是什麼：是一個 Mybatis 的增強工具，在 Mybatis 的基礎上只做增強不做改變，為簡化開發、提高效率而生。
MP特性：無侵入，依賴少，損耗小，防SQL注入，通用CRUD，多種主鍵策略，程式碼生成，內建分頁外掛。。。
通用CRUD：整合BaseMapper就可以使用MP封裝的CRUD
多種主鍵策略：IdType.AUTO（自動），IdType.INPUT（使用者輸入），IdType.ID_WORKER（自動），IdType.UUID（自動）。配置方法，主鍵ID上加上註解：@TableId(value = “ID”, type = IdType.AUTO)，一般情況下推薦大家使用自動增長主鍵。
內建分頁外掛：Page內建分頁外掛。
程式碼生成：MP自帶程式碼生成工具，可以從Controller層直接生成到mapper層，包括實體類，讓我們只關心請求地址和業務處理。
整合Mybaits-Plus
在pom.xml中匯入相關jar包
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus</artifactId>
<version>2.1.4</version>
</dependency>
然後新建一個com.config用來儲存配置資訊類的包，新建一個配置Mybatis-Plus的類MybatisPlusConfig
具體內容如下，同學們不需要記住配置的具體內容是什麼，你大概能看懂是什麼意思就懂了。
在SpringBoot中使用配置檔案時，務必在類上加上Configuration的註解方便系統啟動時載入。
只需要複製即可
@Configuration
public class MybatisPlusConfig {
@Autowired
private DataSource dataSource;
@Autowired
private MybatisProperties properties;
@Autowired
private ResourceLoader resourceLoader = new DefaultResourceLoader();
@Autowired(required = false)
private Interceptor[] interceptors;
@Autowired(required = false)
private DatabaseIdProvider databaseIdProvider;
/**
* mybatis-plus分頁外掛
*/
@Bean
public PaginationInterceptor paginationInterceptor() {
PaginationInterceptor page = new PaginationInterceptor();
page.setDialectType("mysql");
return page;
}
/**
* 這裡全部使用mybatis-autoconfigure 已經自動載入的資源。不手動指定
* 配置檔案和mybatis-boot的配置檔案同步
* @return
*/
@Bean
public MybatisSqlSessionFactoryBean mybatisSqlSessionFactoryBean() {
MybatisSqlSessionFactoryBean mybatisPlus = new MybatisSqlSessionFactoryBean();
mybatisPlus.setDataSource(dataSource);
mybatisPlus.setVfs(SpringBootVFS.class);
if (StringUtils.hasText(this.properties.getConfigLocation())) {
mybatisPlus.setConfigLocation(this.resourceLoader.getResource(this.properties.getConfigLocation()));
}
mybatisPlus.setConfiguration(properties.getConfiguration());
if (!ObjectUtils.isEmpty(this.interceptors)) {
mybatisPlus.setPlugins(this.interceptors);
}
MybatisConfiguration mc = new MybatisConfiguration();
mc.setDefaultScriptingLanguage(MybatisXMLLanguageDriver.class);
mybatisPlus.setConfiguration(mc);
if (this.databaseIdProvider != null) {
mybatisPlus.setDatabaseIdProvider(this.databaseIdProvider);
}
if (StringUtils.hasLength(this.properties.getTypeAliasesPackage())) {
mybatisPlus.setTypeAliasesPackage(this.properties.getTypeAliasesPackage());
}
if (StringUtils.hasLength(this.properties.getTypeHandlersPackage())) {
mybatisPlus.setTypeHandlersPackage(this.properties.getTypeHandlersPackage());
}
if (!ObjectUtils.isEmpty(this.properties.resolveMapperLocations())) {
mybatisPlus.setMapperLocations(this.properties.resolveMapperLocations());
}
return mybatisPlus;
}
}
到這裡，Mybatis-Plus已經全部整合到系統裡面去了，然後我們就來改造我們之前的UserMapper，這裡也可以不是說改造，就是刪除掉裡面的內容然後繼承至Mybatis-Plus相關內容就可以了，程式碼如下：
@Mapper
public interface UserMapper extends BaseMapper<User> {
}
然後我們需要對實體類進行一個簡單的修飾，並且告訴MP該表的主鍵是什麼，然後主鍵的生成策略是什麼。
@TableName("user")
public class User {
@TableId(value = "id", type = IdType.AUTO)
private Integer id;
private String username;
。。。。。。
然後我們這裡來執行一下條件查詢，這裡我們要用到Mybatis-Plus中的包裝（Wrapper）去構建我們的條件查詢
下面舉幾個Wrapper語句的示例，
Wrapper<T> wrapper = new EntityWrapper<>(); 構建一個實體類的包裝工具
wrapper.eq("username", "LIAOXIANG"); 做條件判斷
wrapper.between("id", 0, 100); 做範圍判斷
wrapper.groupBy("username"); 分組
wrapper.isNotNull("username"); 不為空判斷
wrapper.orderBy("id", false); 排序，從小打大為true，反之false
。。。。。。。。。。
service中
//直接繼承了配置類的方法即可
userMapper.updateById(entity);
userMapper.insert(entity);
//分頁：
@RequestMapping("selectpage")
public Object seletpage(Integer pagenum,Integer pagesize){
Wrapper<User> Wrapper = new EntityWrapper<>();
RowBounds roeBounds = new RowBounds((pagenum-1)*pagesize,pagesize);
return userMapper.selectPage(rowBounds,Wrapper);
}
程式碼生成工具
匯入pom檔案
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.0</version>
</dependency>
具體程式碼如下：
MpGenerator.java
package mybatisDemo;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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.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;
public class MpGenerator {
/**
* <p>
* MySQL 生成演示
* </p>
*/
public static void main(String[] args) {
AutoGenerator mpg = new AutoGenerator();
// 全域性配置
GlobalConfig gc = new GlobalConfig();
gc.setOutputDir("F://mjxy");//生成到本地的目錄中
gc.setFileOverride(true);
gc.setActiveRecord(true);
gc.setEnableCache(false);// XML 二級快取
gc.setBaseResultMap(true);// XML ResultMap
gc.setBaseColumnList(false);// XML columList
gc.setAuthor("Liao");//程式碼中體現的作者
mpg.setGlobalConfig(gc);
// 資料來源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setDbType(DbType.MYSQL);//資料庫
dsc.setTypeConvert(new MySqlTypeConvert() {
// 自定義資料庫表字段型別轉換【可選】
@Override
public DbColumnType processTypeConvert(String fieldType) {
System.out.println("轉換型別：" + fieldType);
// 注意！！processTypeConvert 存在預設型別轉換，如果不是你要的效果請自定義返回、非如下直接返回。
return super.processTypeConvert(fieldType);
}
});
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUrl("jdbc:mysql://localhost:3306/springboot_mjxy?characterEncoding=utf8");
dsc.setUsername("root");
dsc.setPassword("admin");
mpg.setDataSource(dsc);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
// strategy.setCapitalMode(true);// 全域性大寫命名 ORACLE 注意
// strategy.setTablePrefix(new String[] { "tlog_", "tsys_" });// 此處可以修改為您的表字首
strategy.setNaming(NamingStrategy.underline_to_camel);// 表名生成策略
strategy.setInclude(new String[] { "user" }); // 需要生成的表
strategy.setRestControllerStyle(true);
// strategy.setExclude(new String[]{"test"}); // 排除生成的表
// 自定義實體父類
// strategy.setSuperEntityClass("com.baomidou.demo.TestEntity");
// 自定義實體，公共欄位
// strategy.setSuperEntityColumns(new String[] { "test_id", "age" });
// 自定義 mapper 父類
// strategy.setSuperMapperClass("com.baomidou.demo.TestMapper");
// 自定義 service 父類
// strategy.setSuperServiceClass("com.baomidou.demo.TestService");
// 自定義 service 實現類父類
// strategy.setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl");
// 自定義 controller 父類
// strategy.setSuperControllerClass("com.baomidou.demo.TestController");
// 【實體】是否生成欄位常量（預設 false）
// public static final String ID = "test_id";
strategy.setEntityColumnConstant(true);
// 【實體】是否為構建者模型（預設 false）
// public User setName(String name) {this.name = name; return this;}
strategy.setEntityBuilderModel(true);
mpg.setStrategy(strategy);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setParent("com.victory");
pc.setModuleName("team");//生成的資料夾外面的檔名，空的話就沒有這層目錄。
mpg.setPackageInfo(pc);
// 注入自定義配置，可以在 VM 中使用 cfg.abc 【可無】
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
Map<String, Object> map = new HashMap<String, Object>();
map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
this.setMap(map);
}
};
// 自定義 xxList.jsp 生成
// List<FileOutConfig> focList = new ArrayList<FileOutConfig>();
// focList.add(new FileOutConfig("/template/list.jsp.vm") {
// @Override
// public String outputFile(TableInfo tableInfo) {
// // 自定義輸入檔名稱
// return "D://my_" + tableInfo.getEntityName() + ".jsp";
// }
// });
// cfg.setFileOutConfigList(focList);
// mpg.setCfg(cfg);
// 調整 xml 生成目錄演示
// focList.add(new FileOutConfig("/templates/mapper.xml.vm") {
// @Override
// public String outputFile(TableInfo tableInfo) {
// return "/develop/code/xml/" + tableInfo.getEntityName() + ".xml";
// }
// });
// cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
// 關閉預設 xml 生成，調整生成 至 根目錄
TemplateConfig tc = new TemplateConfig();
tc.setXml(null);
mpg.setTemplate(tc);
// 自定義模板配置，可以 copy 原始碼 mybatis-plus/src/main/resources/templates 下面內容修改，
// 放置自己專案的 src/main/resources/templates 目錄下, 預設名稱一下可以不配置，也可以自定義模板名稱
// TemplateConfig tc = new TemplateConfig();
// tc.setController("...");
// tc.setEntity("...");
// tc.setMapper("...");
// tc.setXml("...");
// tc.setService("...");
// tc.setServiceImpl("...");
// 如上任何一個模組如果設定 空 OR Null 將不生成該模組。
// mpg.setTemplate(tc);
// 執行生成
mpg.execute();
// 列印注入設定【可無】
System.err.println(mpg.getCfg().getMap().get("abc"));
}
}