mybatis-generator-maven-plugin是mybatis 官方發布的maven插件,能夠自動生成代碼,在項目開發前期設計完數據庫庫后,需要大量編寫實體類,使用maven插件省時省力,快速高效,來看看怎么自動生成代碼.
碼云參考代碼下載地址:下載
在實驗過多個idea第三方插件后嘗試無果,最終還是選擇官方maven插件,成功插入數據.mabatis官方文檔地址能不能打開看緣分,來看看詳細的使用教程吧.
1. 在pom文件中引入pom插件,引入dependency和plugin
<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.6.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.springboot</groupId>
<artifactId>blog</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>blog</name>
<description>Spring Boot blog</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<!--mysql數據庫驅動-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<!--mybatis-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.2</version>
</dependency>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.4.0</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.4.0</version>
<executions>
<execution>
<id>Generate MyBatis Artifacts</id>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.19</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
2. 編寫配置文件generatorConfig.xml
在resources目錄下新建配置文件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>
<context id="testTables" targetRuntime="MyBatis3Simple">
<commentGenerator>
<!-- 是否去除自動生成的注釋 true：是 ： false:否 -->
<property name="suppressAllComments" value="true" />
</commentGenerator>
<!--數據庫連接的信息：驅動類、連接地址、用戶名、密碼 -->
<jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
connectionURL="jdbc:mysql://127.0.0.1/springboot?serverTimezone=UTC&nullCatalogMeansCurrent=true" userId="root"
password="root">
</jdbcConnection>
<!-- 默認false，把JDBC DECIMAL 和 NUMERIC 類型解析為 Integer，為 true時把JDBC DECIMAL 和
NUMERIC 類型解析為java.math.BigDecimal -->
<javaTypeResolver>
<property name="forceBigDecimals" value="false" />
</javaTypeResolver>
<!-- targetProject:生成PO類的位置 -->
<javaModelGenerator targetPackage="com.springboot.blog.entity"
targetProject="./src/main/java">
<!-- enableSubPackages:是否讓schema作為包的后綴 -->
<property name="enableSubPackages" value="false" />
<!-- 從數據庫返回的值被清理前后的空格 -->
<property name="trimStrings" value="true" />
</javaModelGenerator>
<!-- targetProject:mapper映射文件生成的位置xml -->
<sqlMapGenerator targetPackage="mapping"
targetProject="./src/main/resources">
<!-- enableSubPackages:是否讓schema作為包的后綴 -->
<property name="enableSubPackages" value="false" />
</sqlMapGenerator>
<!-- targetPackage：mapper接口生成的位置 -->
<javaClientGenerator type="XMLMAPPER"
targetPackage="com.springboot.blog.mapper"
targetProject="./src/main/java">
<!-- enableSubPackages:是否讓schema作為包的后綴 -->
<property name="enableSubPackages" value="false" />
</javaClientGenerator>
<!-- 指定數據庫表 -->
<table schema="springboot" tableName="article"></table>
<table schema="springboot" tableName="article_tag"></table>
<table schema="springboot" tableName="blogroll"></table>
<table schema="springboot" tableName="category"></table>
<table schema="springboot" tableName="comment"></table>
<table schema="springboot" tableName="nav"></table>
<table schema="springboot" tableName="tag"></table>
<!-- 有些表的字段需要指定java類型
<table schema="" tableName="">
<columnOverride column="" javaType="" />
</table> -->
</context>
</generatorConfiguration>
3. 執行maven命令生成代碼
執行mvn -Dmybatis.generator.overwrite=true mybatis-generator:generate生成代碼,或者直接點擊生成代碼
image.png
4. 執行成功結果
等待執行成功后,會生成相應的文件,包括實體,mapper以及xml配置,
image.png
5.測試生成的代碼是否可用.
以文章為例,我們再數據庫中手動插入一條測試數據.
然后找到mapper/ArticleMapper 在類上添加@Mapper注解,自動生成的代碼不帶注解.
image.png
6.編寫測試articleservice以及impl實現類是否可用.
public interface ArticleService {
int deleteByPrimaryKey(Integer id);
int insert(Article record);
Article selectByPrimaryKey(Integer id);
List<Article> selectAll();
int updateByPrimaryKey(Article record);
}
@Service
public class ArticleServiceImpl implements ArticleService {
@Resource//@Autowired或者使用
private ArticleMapper mapper;
@Override
public int deleteByPrimaryKey(Integer id) {
return 0;
}
@Override
public int insert(Article record) {
return 0;
}
@Override
public Article selectByPrimaryKey(Integer id) {
return mapper.selectByPrimaryKey(id);
}
@Override
public List<Article> selectAll() {
return null;
}
@Override
public int updateByPrimaryKey(Article record) {
return 0;
}
}
7.編寫測試articlecontroller.
@RestController
@RequestMapping("article")
public class ArticleController {
@Autowired
private ArticleService service;
/**
* 通過主鍵查詢單條數據
*
* @param id 主鍵
* @return 單條數據
*/
@GetMapping("selectOne")
public Article selectOne(Integer id) {
return this.service.selectByPrimaryKey(id);
}
}
image.png
請求地址:http://127.0.0.1:8080/article/selectOne?id=1
image.png
請求成功.
