MyBatis Generator YML Maven 插件使用教程
1. 项目的目录结构及介绍
MyBatis Generator YML Maven 插件的目录结构如下:
mybatis-generator-yml-maven-plugin/
├── src/
│ └── main/
│ ├── java/
│ └── resources/
├── .gitignore
├── LICENSE
├── README-CN.md
├── README.md
├── SECURITY.md
├── pom.xml
目录结构介绍
src/main/java/
: 包含插件的主要Java源代码。src/main/resources/
: 包含插件的资源文件,如配置文件等。.gitignore
: Git忽略文件配置。LICENSE
: 项目的许可证文件。README-CN.md
: 中文README文件。README.md
: 英文README文件。SECURITY.md
: 安全相关文档。pom.xml
: Maven项目的配置文件。
2. 项目的启动文件介绍
项目的启动文件主要是Maven插件的配置文件 pom.xml
。该文件定义了插件的依赖、构建配置和插件的具体配置。
pom.xml 文件介绍
<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>mybatis-generator-yml-maven-plugin</artifactId>
<version>1.0.0</version>
<packaging>maven-plugin</packaging>
<dependencies>
<!-- 依赖项 -->
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.4.0</version>
<configuration>
<!-- 插件配置 -->
</configuration>
</plugin>
</plugins>
</build>
</project>
启动步骤
- 克隆项目仓库:
git clone https://github.com/javthon/mybatis-generator-yml-maven-plugin.git
- 进入项目目录:
cd mybatis-generator-yml-maven-plugin
- 使用Maven构建项目:
mvn clean install
- 运行插件:
mvn mybatis-generator:generate
3. 项目的配置文件介绍
项目的配置文件主要是 pom.xml
和 generatorConfig.xml
。
generatorConfig.xml 文件介绍
generatorConfig.xml
文件用于配置MyBatis Generator的生成规则和数据库连接信息。
<?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="context1">
<jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/mydatabase"
userId="root"
password="password">
</jdbcConnection>
<javaModelGenerator targetPackage="com.example.model" targetProject="src/main/java">
<property name="enableSubPackages" value="true"/>
</javaModelGenerator>
<sqlMapGenerator targetPackage="com.example.mapper" targetProject="src/main/resources">
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java