Mybatis Generator逆向工程の使用詳細教程

16886 ワード

一、MyBatis Generator概要
MyBatis Generator（MBG）はMyBatisとiBATISのコードジェネレータです。これはすべてのバージョンのMyBatisと2.2.0以降のiBATISバージョンのコードを生成します。データベーステーブルを審査し、テーブルにアクセスするための手段を生成します。これは、データベーステーブルと対話するためのオブジェクトとプロファイルの設定の初期のトラブルを低減します。MBGシークは、簡単なCRUD（作成、検索、更新、削除）のほとんどのデータベース操作に大きな影響を与えます。まだお問い合わせまたは保存プロセスのためにSQLとオブジェクトコードを手動で作成する必要があります。MyBatis Generatorは生成されます。
テーブル構造にマッチするJava POJO。これは以下を含むかもしれません

マッチテーブルのメインキーのクラス（メインキーがあれば）

マッチテーブルの非プライマリキーフィールドのクラス（BLOBフィールドを除く）

は、テーブルのBLOBフィールドのクラス（テーブルがBLOBフィールドを有する場合）

を含む。

は、動的選択、更新、削除を有効にするためのクラス

を有する。
これらのクラスの間には適切な継承関係がある。ジェネレータは、例えば、異なるタイプのPOJO階層構造を生成するように構成されています。
MyBatis/iBATIS対応SQL Map XMLファイルです。MBGは構成中の各テーブルの簡単なCRUD関数のためにSQLを生成する。生成されたSQL文には、

insert挿入

udate by primary key キーを押して

を更新します。

udate by example（using a dynamic where clause）条件更新（動的where子文を使用）

delete by primary key キーを押して

を削除します。

delete by example(using a dynamic where clause) 条件によって削除（動的where子文を使用）

select by primary key キーを押して

を照会する。

select by example(using a dynamic where clause) 条件によって問い合わせる（動的where子文を使う）

count by example 条件別の検索記録総数

表の構造によって、これらの語句には異なる変体があります。例えば、表にメインキーがないと、MBGはメインキー機能によって更新を生成しません。
上記のオブジェクトのJavaクライアントクラスを適切に使用します。Javaクライアントクラスの生成は任意である。MBGはMyBatis 3.xのために以下のタイプのJavaクライアントを生成する。
MyBatis 3.xマッパーの基礎構造に適したマッパーインターフェース
MBGは、iBATIS 2.xのために、以下のタイプのJavaクライアントを生成する。

Springフレームに適合したDAO

は、APIのDAOをiBATIS SQLのみを使用してマッピングする。これらのDAOは、構造関数またはsetter注入によってSql MapClientを提供する2つのタイプを生成することができる。

iBATIS DAOフレームに適合したDAO（iBATISのオプション部分は、現在はこのフレームの使用を推奨していません。Springフレームを使用することをお勧めします。）

MyBatisジェネレータは、反復開発環境で良好に動作するように設計され、AntタスクまたはMavenプラグインとして連続的な環境構築に含めることができます。MBGを反復して実行する際に注意する必要がある重要な事項は以下を含む。
新しく作成したXMLファイルと同名の既存ファイルがあると、MBGは自動的にXMLファイルをマージします。MBGは、あなたが生成したXMLファイルのカスタム変更を上書きしません。繰り返し実行できます。XMLに対するカスタム変更がなくなる心配はありません。MBGは、以前の動作で生成された任意のXML要素を置換します。
MBGはJavaファイルを統合しません。既存のファイルを上書きしたり、別の固有の名前を使って新たに生成されたファイルを保存したりできます。生成されたJavaファイルを変更し、MBGを反復的に実行する場合は、手動で変更をマージする必要があります。Eclipseプラグインとして動作すると、MBGはJavaファイルを自動的に統合することができる。
二、MyBatis Generator使用
1、MBGの配置ファイルを新規作成するgeneratoConfig.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>
 
 <!--      -->
 <properties resource="generator.properties"></properties>
 <!--        jdbc  jar    -->
 <!--<classPathEntry location="${jdbc.driverLocation}"/>-->
 
 <context id="default" targetRuntime="MyBatis3">
 
 <!-- optional，    class ，       ，false    ,true    -->
 <commentGenerator>
  <property name="suppressDate" value="false"/>
  <property name="suppressAllComments" value="false"/>
 </commentGenerator>
 
 <!--jdbc       -->
 <jdbcConnection
  driverClass="${jdbc.driverClass}"
  connectionURL="${jdbc.connectionURL}"
  userId="${jdbc.userId}"
  password="${jdbc.password}">
 </jdbcConnection>
 
 
 <!--
    false， JDBC DECIMAL   NUMERIC       Integer，
    true  JDBC DECIMAL   NUMERIC      java.math.BigDecimal
 -->
 <!--    ，     ，       java         -->
 <javaTypeResolver>
  <property name="forceBigDecimals" value="false"/>
 </javaTypeResolver>
 
 
 <!-- Model     ,        key  ，        Example 
  targetPackage      model       
  targetProject             |          
 -->
 <javaModelGenerator targetPackage="com.test.model"
    targetProject=".\src\main\java">
  <!--       ， targetPackage.schemaName.tableName -->
  <property name="enableSubPackages" value="false"/>
  <!--    model        true  ，false   -->
  <property name="constructorBased" value="false"/>
  <!--     CHAR         trim   -->
  <property name="trimStrings" value="true"/>
  <!--    Model              Model      setter  ，       -->
  <property name="immutable" value="false"/>
 </javaModelGenerator>
 
 <!--Mapper                          SqlMapper   -->
 <sqlMapGenerator targetPackage="com.test.mapper"
    targetProject=".\src\main\java">
  <property name="enableSubPackages" value="false"/>
 </sqlMapGenerator>
 
 <!--      ，         Model   XML        
  type="ANNOTATEDMAPPER",  Java Model       Mapper  
  type="MIXEDMAPPER",       Java Model     Mapper  
  type="XMLMAPPER",  SQLMapper XML      Mapper  
 -->
 <javaClientGenerator targetPackage="com.test.mapper"
    targetProject=".\src\main\java" type="XMLMAPPER">
  <property name="enableSubPackages" value="true"/>
 </javaClientGenerator>
 
 <!--           -->
 <table tableName="t_userinfo" domainObjectName="UserInfo"
  enableCountByExample="false" enableUpdateByExample="false"
  enableDeleteByExample="false" enableSelectByExample="false"
  selectByExampleQueryId="false">
 </table>
 </context>
</generatorConfiguration>

2、ゲナート.propertiesファイルを新規作成する


jdbc.driverLocation=C:\\mysql-connector-java-5.1.43.jar
jdbc.driverClass=com.mysql.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/mybatis
jdbc.userId=root
jdbc.password=tiger

3、配置はmybatis generator操作を実行します。ここには2つの方式があります。
第1の方式：
maven項目を使えばJava起動類を省略して、mavenプラグインと配置ファイルpom.xmlを使えばいいです。プラグインはmaven-generatorを起動して、pom.xmlにmaven-generatorプラグインを追加します。


<plugins>
 <!--myBatis      -->
 <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>${project.basedir}/src/main/resources/generatorConfig.xml</configurationFile>
 </configuration>
 <dependencies>
  <dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <version>5.1.35</version>
  </dependency>
 </dependencies>
 </plugin>
</plugins>

mybatis-generator:generateをクリックしてmybatis generatorを実行できます。

第2の方式：
1、もしmavenプロジェクトではないなら、このmybatis-generator-coree-1.3.2.jarを追加して、main方法を編纂してmybatis逆向工事を指して、私は依存に下に貼り付けました。


<!-- https://mvnrepository.com/artifact/org.mybatis.generator/mybatis-generator-core -->
<dependency>
 <groupId>org.mybatis.generator</groupId>
 <artifactId>mybatis-generator-core</artifactId>
 <version>1.3.2</version>
</dependency>

2、generatoorConfig.xmlファイルを修正し、コメントの当該構成を解除する。


<classPathEntry location="${jdbc.driverLocation}"/>

3、そしてテストクラスの実行を編纂する


/**
 *     maven        
 */
public class MybatisGeneratorTest {
 public static void main(String[] args) throws InterruptedException, SQLException, IOException, InvalidConfigurationException, XMLParserException {
 List<String> warnings = new ArrayList<String>();
 //   java      
 boolean overwrite = true;
 //          
 //File configFile = new File("E:\\project\\mybatis-generator\\src\\main\\resources\\generatorConfig.xml");
 InputStream resourceAsStream = MybatisGeneratorTest.class.getClassLoader().getResourceAsStream("generatorConfig.xml");
 ConfigurationParser cp = new ConfigurationParser(warnings);
 Configuration config = cp.parseConfiguration(resourceAsStream);
 DefaultShellCallback callback = new DefaultShellCallback(overwrite);
 MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config,callback, warnings);
 myBatisGenerator.generate(null);
 }
}

この二つの方法を紹介してから、データ表を調べます。

生成されたエンティティクラスを表示します。

TIP：本体類がラクダの命名仕様に準拠したい場合、データベーステーブルのフィールド名の設計には「_」が必要であることが分かります。を選択します
生成したファイル情報を表示します。

TIP 1：必ずラベルにデータベースドライバを追加し、他のところで無効を追加してください。添加しないと駆動エラーが発生します。このプラグインにデータベース依存を追加しないとを使ってデータベース駆動位置を指定できます。
TIP 2：mybatis generatorプラグインを使用して実行する場合は[ERROR]Failed to execute goal org.mybatis.generator:mybatis-geners-mavent-plugin:1.3.2:generate(default-cli)on project mybaties-geners:propertiners

あなたのの構成は大丈夫ですが、generator.propertiesが見つけられません。構成を調べて、コメントを落とします。

この設定は、generatoorConfig.xmlでgenerator.propertiesファイルのデフォルトパスを読み込むように変更されます。
TIP 3:Mybatis Generator逆工程はデフォルトでは生成された*.javaファイルを上書きしません。カバー生成された*.javaファイルを設定してもいいです。リバースエンジニアリングプラグインmybatis-generator-maven-pluginにこの設定trueを追加すると、生成された*.javaファイルを上書きします。

Mybatis Generatorはあなたのmapper.xmlファイルを上書きしません。MBGはmapper.xmlにマージされて、カスタマイズされた存在と一緒に追加されますが、MBGを修正して初めてデフォルトで生成されたSQL（MBGが生成したCRUD）を変更したら、MBGは自分で生成したCRUDを元に戻します。あなたがカスタマイズしたものは変わりません。。。図のように、彼はあなたのカスタムSQLを動かすことはできません。Mybatisリバースプロジェクトが自分で生成したSQLだけをカバーします。MBGが自動的にSQL文の注釈を生成する前提があります。

最も一般的な用例では、MyBatis Generator（MBG）はXMLプロファイルによって駆動される。プロファイルをMBGに伝える

どうやってデータベース

に接続しますか？

は、どのようなオブジェクトを生成し、

をどのように生成しますか？

は、どのテーブルを使用してオブジェクトを生成するべきですか？
公式MBGプロファイル詳細住所：http://mybatis.org/generator/configreference/xmlconfig.html
MBG付きの中国語プロファイル詳細解：https://www.jianshu.com/p/e09d2370b796
もっと多いMybatis逆向工事の使用参考：http://www.mybatis.org/generator/index.html
締め括りをつける
ここで、Mybatis Generatorの逆プロジェクトに関する詳細な教程の記事を紹介します。Mybatis Generatorの逆プロジェクト内容については、以前の文章を検索してください。または次の関連記事を引き続きご覧ください。これからもよろしくお願いします。