上一節咱們學習了mybatis-plus
的ActiveRecord(活動記錄)
,這一節咱們來學習一下mybatis-plus
的代碼生成器
。java
Mybatis-Plus 的代碼生成器爲咱們提供了大量的自定義設置,生成的代碼徹底可以知足各種型的需求,能夠快速的生成代碼,簡化開發,提升開發效率。mysql
Mybatis-Plus 的代碼生成器 和 Mybatis MBG 代碼生成器的對比:git
Mybatis-Plus 代碼生成器 | Mybatis MBG |
---|---|
Mybatis-Plus 的代碼生成器都是基於 java 代碼來生成 | MBG 基於 xml 文件進行代碼生成 |
Mybatis-Plus 的代碼生成器可生成: 實體類(能夠選擇是否支持 AR) 、 Mapper 接口 、 Mapper 映射文件 、 Service 層 、 Controller 層 |
MyBatis 的代碼生成器可生成: 實體類 、 Mapper 接口 、 Mapper 映射文件 |
話很少說,下面咱們來開始咱們的代碼生成器的學習之旅。github
首先按照快速開始——Spring集成Mybatis-Plus
一節的操做,新建一個mp05
的 Module
,能夠將mp02
中的resources
文件夾中內容所有複製過來,由於這些配置文件都是同樣的。web
在開始mp05
的實戰以前,咱們須要修改下父工程的pom文件,由於MP 的代碼生成器默認使用的是 Apache 的 Velocity
模板,須要加入 Apache Velocity
的依賴。固然也能夠更換爲別的模板技術,例如freemarker
,此處不作過多的介紹,你們感興趣的能夠本身嘗試。另外還須要引入 mybatis-plus-generator
的依賴,這時由於 MyBatis-Plus 從 3.0.3 以後移除了代碼生成器與模板引擎的默認依賴,須要手動添加相關依賴。除此以外還須要引入spring-webmvc
的依賴,由於咱們在用代碼生成器生成的 controller
層的時候,SpringMVC
的註解會提示報錯,固然,你也能夠在生成完代碼以後再根據須要引入SpringMVC
的依賴也能夠,這樣並不會影響代碼生成器的使用。spring
咱們須要修改的 pom.xml
文件位置以下圖所示:sql
貼上pom.xml修改部分的代碼方便複製粘貼:數據庫
<!-- 下面的依賴針對於 mp05 模塊-->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>${spring.version}</version>
</dependency>
<!--注意: MyBatis-Plus 從 3.0.3 以後移除了代碼生成器與模板引擎的默認依賴,須要手動添加相關依賴: -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>${mybatis.plus.version}</version>
</dependency>
<!--模板引擎
MP 的代碼生成器默認使用的是 Apache 的 Velocity 模板,固然也能夠更換爲別的模板
技術,例如 freemarker。此處不作過多的介紹。
須要加入 Apache Velocity 的依賴-->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>${velocity.version}</version>
</dependency>
<!--加入 slf4j ,查看日誌輸出信息-->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>${slf4j.version}</version>
</dependency>
複製代碼
修改後完整的 pom.xml
文件以下:apache
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.demo.mybatis-plus</groupId>
<artifactId>mybatis-plus-in-action</artifactId>
<packaging>pom</packaging>
<version>1.0-SNAPSHOT</version>
<modules>
<module>mp01</module>
<module>mp02</module>
<module>mp03</module>
<module>mp04</module>
<module>mp05</module>
<module>mp06</module>
<module>mp07</module>
<module>mp08</module>
</modules>
<!-- 統一管理項目依賴版本 -->
<properties>
<mybatis.plus.version>3.2.0</mybatis.plus.version>
<!--<mybatis.plus.version>2.3</mybatis.plus.version>-->
<junit.version>4.12</junit.version>
<log4j.version>1.2.17</log4j.version>
<druid.version>1.1.20</druid.version>
<mysql.version>5.1.48</mysql.version>
<spring.version>5.2.0.RELEASE</spring.version>
<lombok.version>1.18.10</lombok.version>
<slf4j.version>1.7.28</slf4j.version>
<velocity.version>2.1</velocity.version>
</properties>
<dependencies>
<!-- mp 依賴
mybatis-plus 會自動維護mybatis 以及 mybatis-spring相關的依賴
Mybatis 及 Mybatis-Spring 依賴請勿加入項目配置,以避免引發版本衝突!!!Mybatis-Plus 會自動幫你維護!
-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus</artifactId>
<version>${mybatis.plus.version}</version>
</dependency>
<!--junit -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit.version}</version>
</dependency>
<!-- log4j -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>${log4j.version}</version>
</dependency>
<!-- druid -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>${druid.version}</version>
</dependency>
<!-- mysql -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>${mysql.version}</version>
</dependency>
<!-- spring -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-orm</artifactId>
<version>${spring.version}</version>
</dependency>
<!--lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${lombok.version}</version>
<scope>provided</scope>
</dependency>
<!-- 下面的依賴針對於 mp05 模塊-->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>${spring.version}</version>
</dependency>
<!--注意: MyBatis-Plus 從 3.0.3 以後移除了代碼生成器與模板引擎的默認依賴,須要手動添加相關依賴: -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>${mybatis.plus.version}</version>
</dependency>
<!--模板引擎
MP 的代碼生成器默認使用的是 Apache 的 Velocity 模板,固然也能夠更換爲別的模板
技術,例如 freemarker。此處不作過多的介紹。
須要加入 Apache Velocity 的依賴-->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>${velocity.version}</version>
</dependency>
<!--加入 slf4j ,查看日誌輸出信息-->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>${slf4j.version}</version>
</dependency>
</dependencies>
<!-- 設置JDK編譯版本 -->
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
</plugins>
</build>
</project>
複製代碼
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>mybatis-plus-in-action</artifactId>
<groupId>com.demo.mybatis-plus</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>mp05</artifactId>
<dependencies>
<!-- mp 依賴
mybatis-plus 會自動維護mybatis 以及 mybatis-spring相關的依賴
Mybatis 及 Mybatis-Spring 依賴請勿加入項目配置,以避免引發版本衝突!!!Mybatis-Plus 會自動幫你維護!
-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus</artifactId>
<version>${mybatis.plus.version}</version>
</dependency>
<!--junit -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit.version}</version>
</dependency>
<!-- log4j -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>${log4j.version}</version>
</dependency>
<!-- druid -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>${druid.version}</version>
</dependency>
<!-- mysql -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>${mysql.version}</version>
</dependency>
<!-- spring -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-orm</artifactId>
<version>${spring.version}</version>
</dependency>
<!--lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${lombok.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>${spring.version}</version>
</dependency>
<!--注意: MyBatis-Plus 從 3.0.3 以後移除了代碼生成器與模板引擎的默認依賴,須要手動添加相關依賴: -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>${mybatis.plus.version}</version>
</dependency>
<!--模板引擎
MP 的代碼生成器默認使用的是 Apache 的 Velocity 模板,固然也能夠更換爲別的模板
技術,例如 freemarker。此處不作過多的介紹。
須要加入 Apache Velocity 的依賴-->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>${velocity.version}</version>
</dependency>
<!--加入 slf4j ,查看日誌輸出信息-->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>${slf4j.version}</version>
</dependency>
</dependencies>
</project>
複製代碼
咱們在 mp05\src\test\java\com\mp\test\
路徑下新建一個測試類 TestMp.java
api
TestMp.java
的代碼以下:
public class TestMp {
private ApplicationContext ioc = new
ClassPathXmlApplicationContext("applicationContext.xml");
/**
* 代碼生成器 示例代碼
*/
@Test
public void testGenerator() {
// 一、全局配置
com.baomidou.mybatisplus.generator.config.GlobalConfig config = new com.baomidou.mybatisplus.generator.config.GlobalConfig();
config.setActiveRecord(true) // 是否支持AR模式
.setAuthor("jianshu") // 做者
.setOutputDir("E:\\myCode\\mybatis-plus-in-action\\mp05\\src\\main\\java") // 生成路徑
.setFileOverride(true) // 文件覆蓋
.setIdType(IdType.AUTO) // 主鍵策略
.setServiceName("%sService") //設置生成的service接口名首字母是否爲I,默認是以I開頭
.setBaseColumnList(true) // 基本列
.setBaseResultMap(true); // 返回結果map
// 二、數據源配置
DataSourceConfig dataSourceConfig = new DataSourceConfig();
dataSourceConfig.setDbType(DbType.MYSQL) // 設置數據庫類型
.setDriverName("com.mysql.jdbc.Driver")
.setUrl("jdbc:mysql://172.19.8.51:3306/wmcTradeOrderDevTemp?allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8")
.setUsername("root")
.setPassword("root");
// 三、策略配置
StrategyConfig stConfig = new StrategyConfig();
stConfig.setCapitalMode(true) // 全局大寫命名
// .setColumnNaming(NamingStrategy.underline_to_camel) //表名 字段名 是否使用下滑線命名
.setNaming(NamingStrategy.underline_to_camel) // 數據庫表映射到實體的命名策略
.setInclude("tbl_employee") //生成的表
.setTablePrefix("tbl_"); // 表前綴
// 四、包名策略配置
PackageConfig pkConfig = new PackageConfig();
pkConfig.setParent("com.mp")
.setController("controller")
.setEntity("beans")
.setMapper("mapper")
.setService("service")
.setXml("mapper");
// 五、整合配置
AutoGenerator ag = new
AutoGenerator().setGlobalConfig(config)
.setDataSource(dataSourceConfig)
.setStrategy(stConfig)
.setPackageInfo(pkConfig);
// 六、執行
ag.execute();
}
}
複製代碼
執行 testGenerator()
方法後,刷新一下項目,咱們能夠看到會自動生成 beans
、mapper
、service
、controller
的代碼。
注意
:關於表及字段命名策略選擇:在 Mybatis-Plus 中,咱們建議數據庫表名 和 表字段名採用駝峯命名方式, 若是採用下劃線命名方式 請開啓全局下劃線開關,若是表名字段名命名方式不一致請使用對應的註解指定,咱們建議最好保持一致。這麼作的緣由是爲了不在對應實體類時產生的性能損耗,這樣字段不用作映射就能直接和實體類對應。固然若是項目裏不用考慮這點性能損耗,那麼你採用下滑線也是沒問題的,只須要在生成代碼時配置 ColumnNaming屬性就能夠。
完成上面的操做後,mp05的代碼結構以下所示:
至此,基於 mybatis-plus
的代碼生成器——逆行工程
演示就完成了,下面咱們就能夠進入到下一節插件擴展
的學習了。
相關示例完整代碼:mybatis-plus-in-action