springboot(6)——Mybatis逆向生成及通用Mapper
阿新 • • 發佈:2018-11-01
一、資料庫中user表
只有id和name兩個欄位
二、新增jar包、設定逆向工程的build配置,pom.xml檔案如下:
<?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.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>demo</name>
<description>Demo project for Spring Boot</description >
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.1.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<mybatis.version>1.3.1</mybatis.version>
<mapper.version>3.4.3</mapper.version>
<mybatis-generator.version>1.3.3</mybatis-generator.version>
<mybatis-tk.version>1.1.4</mybatis-tk.version>
<pagehelper.version>1.2.1</pagehelper.version>
</properties>
<dependencies>
<!-- SpringBoot - Web -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- SpringBoot - MyBatis -->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>${mybatis.version}</version>
</dependency>
<!-- SpringBoot - MyBatis 逆向工程 -->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>${mybatis-generator.version}</version>
</dependency>
<!-- MyBatis 通用 Mapper -->
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper-spring-boot-starter</artifactId>
<version>${mybatis-tk.version}</version>
</dependency>
<!-- Mysql -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<!-- MyBatis 逆向工程 外掛 -->
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>${mybatis-generator.version}</version>
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>${mysql.version}</version>
</dependency>
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper</artifactId>
<version>${mapper.version}</version>
</dependency>
</dependencies>
<configuration>
<!-- 允許移動生成的檔案 -->
<verbose>true</verbose>
<!-- 是否覆蓋 -->
<overwrite>true</overwrite>
<!-- 配置檔案 -->
<configurationFile>
${basedir}/generatorConfig.xml
</configurationFile>
</configuration>
</plugin>
</plugins>
</build>
</project>
三、在java程式碼新建utils目錄, 然後新建IBaseMapper
通用Mapper模板
package com.example.demo.utils;
import tk.mybatis.mapper.common.Mapper;
import tk.mybatis.mapper.common.MySqlMapper;
public interface IBaseMapper<T> extends Mapper<T>, MySqlMapper<T> {
}
另外, 在java程式碼新建entity目錄, 用於存放資料庫中表生成實體
在java程式碼新建mapper目錄, 用於存放XyzMapper
檔案
四、application.yml
應用配置
server:
port: 9222
spring:
datasource:
driver-class-name: com.mysql.jdbc.Driver
username: root
password:
url: jdbc:mysql://localhost:3306/xxx?characterEncoding=utf-8&useSSL=false
jackson:
default-property-inclusion: non_null
# 指定資料庫中表生成實體的路徑
mybatis:
type-aliases-package: com.example.demo.entity
mapper-locations: classpath:mapper/*.xml
# 對應utils目錄下的IBaseMapper模板Mapper
mapper:
mappers:
- com.example.demo.utils.IBaseMapper
not-empty: false
identity: MYSQL
五、專案根目錄下新建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>
<!-- 引入 application.yml -->
<properties resource="application.yml" />
<!-- MyBatis3Simple:不生成 Example相關類及方法 -->
<context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
<property name="beginningDelimiter" value="`" />
<property name="endingDelimiter" value="`" />
<!-- 指定生成 Mapper 的繼承模板 -->
<plugin type="tk.mybatis.mapper.generator.MapperPlugin">
<property name="mappers" value="com.example.demo.utils.IBaseMapper" />
</plugin>
<!-- 生成 JavaBean 物件重寫 toString方法 -->
<plugin type="org.mybatis.generator.plugins.ToStringPlugin" />
<!-- 生成 JavaBean 物件繼承 Serializable 類 -->
<plugin type="org.mybatis.generator.plugins.SerializablePlugin" />
<!-- 生成 JavaBean 物件重寫 equals 和 hashCode 方法 -->
<!-- <plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin" /> -->
<!-- jdbc 連線配置 -->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/xxx?characterEncoding=utf-8&useSSL=false"
userId="root"
password="">
</jdbcConnection>
<javaModelGenerator targetPackage="com.example.demo.entity"
targetProject="src/main/java" />
<sqlMapGenerator targetPackage="mapper"
targetProject="src/main/resources" />
<javaClientGenerator targetPackage="com.example.demo.mapper"
targetProject="src/main/java" type="XMLMAPPER" />
<!-- Mysql 配置 -->
<!-- <generatedKey column="id" sqlStatement="Mysql" identity="true" /> -->
<!-- Oracle 配置 -->
<!-- <generatedKey column="id" sqlStatement="select SEQ_{1}.nextval from dual" identity="false" type="pre"/> -->
<!-- tableName:資料庫表名,domainObjectName:生成檔名 ,schema:資料來源-->
<table tableName="user">
<generatedKey column="id" sqlStatement="Mysql" identity="true" />
</table>
</context>
</generatorConfiguration>
六、執行逆向工程
在utils
目錄下新建GeneratorMybatis.java
類, 執行main方法自動生成程式碼
package com.example.demo.utils;
import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
public class GeneratorMybatis {
public void generator() throws Exception{
List<String> warnings = new ArrayList<String>();
boolean overwrite = true;
//指定 逆向工程配置檔案
File configFile = new File("generatorConfig.xml");
ConfigurationParser cp = new ConfigurationParser(warnings);
Configuration config = cp.parseConfiguration(configFile);
DefaultShellCallback callback = new DefaultShellCallback(overwrite);
MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config,
callback, warnings);
myBatisGenerator.generate(null);
}
public static void main(String[] args) throws Exception {
try {
GeneratorMybatis generatorSqlmap = new GeneratorMybatis();
generatorSqlmap.generator();
} catch (Exception e) {
e.printStackTrace();
}
}
}
逆向生成前後專案對比
測試驗證
一、需在入口Application中配置自動掃描mapper包
//掃描 mybatis mapper 包路徑
@MapperScan(basePackages = "com.example.demo.mapper")
二、service目錄下新建IUserService
package com.example.demo.service;
import com.example.demo.entity.User;
public interface IUserService {
public void insertUser(User user);
}
三、新建impl
目錄然後新建UserServiceImpl
package com.example.demo.service.impl;
import com.example.demo.entity.User;
import com.example.demo.mapper.UserMapper;
import com.example.demo.service.IUserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
@Service
public class UserServiceImpl implements IUserService {
@Autowired
private UserMapper userMapper;
@Override
public void insertUser(User user) {
userMapper.insert(user);
}
}
三、新建測試類
選中UserServiceImpl
右鍵 -> go to
-> Test
-> Create New Test
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserServiceImplTest {
@Autowired
UserServiceImpl userService;
@Test
public void insertUser() {
User user = new User();
user.setName("ccc");
userService.insertUser(user);
}
}
右鍵insertUser
方法插入成功
THE END!
參考連結
MyBatis-Spring-Boot
SpringBoot 3.SpringBoot 整合 MyBatis 逆向工程以及 MyBatis 通用 Mapper