MyBatisコード生成ツール
MyBatisを使用する過程で、エンティティクラスと単一テーブルのCRUDコードを作成する必要があることがよくあります。テーブルが少ない場合は問題ないかもしれませんが、テーブルが多すぎると非常に面倒になります。幸い、公式のMyBatisコードジェネレーター（MyBatis Generator）は、この問題の解決に役立ちます。MyBatisGenerator（MBG）は、データベーステーブルを介してエンティティクラス、単一テーブルのCRUDコード、およびmapper.xmlファイルを直接生成できます。MyBatisジェネレーターの使い方を見てみましょう。
MyBatisジェネレーターを使用する
1.依存関係を追加します
MBGの使用は、主に次の2つの依存関係に基づいています。1つはmybatisのSpring Boot依存関係であり、MyBatisGeneratorの依存関係です。MyBatisコードジェネレーターを使用したいだけなら、mybatis-spring-boot-starterに頼ることさえできません。
<!--SpringBoot整合MyBatis-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.0</version>
</dependency>
<!-- MyBatis 生成器 -->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.4.0</version>
</dependency>
<!--Mysql数据库驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
2.依存関係を追加した後、関連する構成を実行する必要があります
application.ymlでデータソースとMyBatismapper.xmlファイルパスを構成します
#数据库连接
spring.datasource.url=jdbc:mysql://192.168.91.128:3306/mytest?useUnicode=true&characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
#指定本地mapper.xml文件的存放位置
mybatis.mapper-locations=classpath:dao/*.xml
3. @MapperScanアノテーションをスタートアップクラスに追加し、スキャンパスを指定します
パスは、マッパーインターフェイスが含まれている限り長くすることができます。範囲が小さいほど、効率が高くなります。
@MapperScan("com.example.demo2")
public class Demo2Application {
public static void main(String[] args) {
SpringApplication.run(Demo2Application.class, args);
}
}
4. Mybatisは上記で構成されているので、コードジェネレーターのxml構成ファイルをresourcesディレクトリに書き込むことができます。
以下は私が書いたコードジェネレータxmlファイルです
名前は次のとおりです。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:标识
targetRuntime: MyBatis3Simple 只会生成基本的CRUD操作
-->
<context id="DB2Tables" targetRuntime="MyBatis3Simple">
<!--commentGenerator：注释生成策略-->
<commentGenerator>
<!--suppressAllComments:是否阻止注释生成-->
<property name="suppressAllComments" value="true"/>
<!--suppressDate:是否阻止时间戳生成-->
<property name="suppressDate" value="true"/>
</commentGenerator>
<!--jdbcConnection：数据库的链接属性-->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/mytest?useUnicode=true&characterEncoding=utf8"
userId="root"
password="root">
<!--解决mysql驱动升级到8.0后不生成指定数据库代码的问题-->
<property name="nullCatalogMeansCurrent" value="true" />
</jdbcConnection>
<!--javaTypeResolver：java类型转换策略-->
<javaTypeResolver >
<!-- forceBigDecimals
false:如果数据库中的字段类型为numeric或者decimal，在代码生成的时候根据数据库中设定的长度自动选择java类型进行转换
true:直接使用java.math.BigDecimal类型-->
<property name="forceBigDecimals" value="false" />
</javaTypeResolver>
<!--domain生成策略；targetPackage：生成到哪个包下面，targetProject：生成到哪个项目目录下面-->
<javaModelGenerator targetPackage="com.example.childdemo.model" targetProject="src/main/java">
<!--<property name="enableSubPackages" value="true" />-->
<!--表示是否修剪字符串（去掉空格-->
<property name="trimStrings" value="true" />
</javaModelGenerator>
<!--sqlMapGenerator：映射文件生成策略
targetPackage:生成到哪个包下面，targetProject：生成到哪个项目目录下面
-->
<sqlMapGenerator targetPackage="com.example.childdemo.mapper" targetProject="src/main/resources">
<property name="enableSubPackages" value="true" />
</sqlMapGenerator>
<!--mapper接口生成策略
type:ANNOTATEDMAPPER:注解的形式
XMLMAPPER：xml映射的形式-->
<javaClientGenerator type="ANNOTATEDMAPPER" targetPackage="com.example.childdemo.mapper" targetProject="src/main/java">
<property name="enableSubPackages" value="true" />
</javaClientGenerator>
<!--指定要生成代码的表
domainObjectName：设置表对应的domain实体类生成的名称
-->
<table tableName="productdir" domainObjectName="ProductDir"></table>
</context>
</generatorConfiguration>`
5.コードジェネレーター
を実行するコーディングファイルと構成ファイルを使用してコードジェネレーターを実行しましょう
構成ファイルを記述した後、コードを生成するクラスを記述し、mainメソッドを直接実行してすべてのコードを生成できます。コードは次のとおりです。
public class Generator {
public static void main(String[] args) throws Exception {
//MBG 执行过程中的警告信息
List<String> warnings = new ArrayList<String>();
//当生成的代码重复时，覆盖原代码
boolean overwrite = true;
//读取我们的 MBG 配置文件
InputStream is = Generator.class.getResourceAsStream("/generatorConfig.xml");
ConfigurationParser cp = new ConfigurationParser(warnings);
Configuration config = cp.parseConfiguration(is);
is.close();
DefaultShellCallback callback = new DefaultShellCallback(overwrite);
//创建 MBG
MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
//执行生成代码
myBatisGenerator.generate(null);
//输出警告信息
for (String warning : warnings) {
System.out.println(warning);
}
}
}
mainメソッドを実行すると、対応するエンティティクラスとマッパーインターフェイスを生成するのに役立ちます
Mavenプラグイン実行コードジェネレーター
上記のメソッドに加えて、Mavenプラグインを介してコードジェネレーターを実行することもできます
Mavenプラグインを使用する場合は、mybatis-generator-core依存関係を導入する必要はありません。Mavenプラグインmybatis-generator-maven-pluginを導入するだけで済みます。次のプラグインをpomファイルに追加します。
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.2</version>
<configuration>
<!-- 输出详细信息 -->
<verbose>true</verbose>
<!-- 覆盖生成文件 -->
<overwrite>true</overwrite>
<!-- 定义配置文件 -->
<configurationFile>${
basedir}/src/main/resources/generator-configuration.xml</configurationFile>
</configuration>
<executions>
<execution>
<id>MyBatis Generate</id>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.38</version>
</dependency>
</dependencies>
</plugin>
プラグインを構成した後、次のコマンドを使用して実行します。
mvn mybatis-generator:generate
注：プラグインのバージョンは、接続されているデータベースのバージョンに対応している必要があります。対応していない場合、エラーが報告されます。
次のように、コンパイラのmavenオプションで直接実行することもできます。
実行後、次のように対応するコードを取得できます
