Java
Git
gradle
spring-boot
新人プログラマ応援

Spring Boot解説第13回(開発環境編:MyBatipse)

More than 3 years have passed since last update.

こんにちはこんばんは!

株式会社情創 技術開発局

だんだんと日没が遅くなりBBQをやれる時間が延びると喜んでいる@YAKINIKUです!

今回はMyBatipseについて解説していきます!


MyBatipseとは

前回紹介したMyBatis関連のファイルを編集時にコンテンツアシスト及び検証機能を提供してくれるEclipseプラグインです。


導入

導入方法は、第2回にて解説しているのでそちらをご参照ください。


機能説明


ハイパーリンク

MayBatipseで一番便利な機能です。

xmlファイルに


dao.xml

<mapper namespace="com.qiita.dao.testTbl.TestTblDao">

</mapper>

と記述することでjavaファイルとのハイパーリンクを作成できます。

これがどういったものかというとxmlステートメントIDとjavaメソッドを紐づけて

Ctrl+左クリックで遷移してくれるようになります。

xmlファイルを開いてみるとCtrlを押すことで

xmlステートメントIDがクリックできるようになっていて、

マッパー.png

押してみると下記のようにjavaメソッドの場所まで遷移してくれます。

java.png

この逆も可能でjavaメソッドをCtrl+クリックで選択するとメニューが出てきて

java2.png

このOpen select in XML mapper.を選択することでXMLステートメントまで遷移してくれます。

その他のハイパーリンク機能としては

include.png

includeのXMLステートメントIDをsqlと紐づけてくれるもの等があります。

このincludeは、同じxmlファイル内にあるsqlタグの中身を呼び出してくれるタグです。

同じ記述を何度もする場合に使用することで記述の省略ができます。


xmlエディター拡張機能

xmlの入力を補助してくれる機能です。

xmlファイルに記述する際にCtrl+Spaceを押すことで下記のように様々な入力を補助してくれます。


ID入力補助

mapperでjavaファイルと紐づけられている場合にid入力の際、メソッド名を選択できるようにしてくれます。

id.png


parameterType入力補助

呼出先のjavaファイルを予測しパスを入力してくれます。

type.png


refid入力補助

入力する際に、同xmlファイル内にあるsqlに設定されているIDを選択できるようにしてくれます。

a.png

今回は3つほど説明させていただきましたが、この他にもmapperのnamespace、XML configのname、valueの入力補助や、javaエディター拡張機能も備わっています。


xmlファイルのエラーチェック

ファイルを更新した時に、エラーチェックを実施してselect、sql、resultMapのID等の整合性を確認してくれます。

問題があった場合には、他のエラーと同じように表示してくれます。

検証.png

エラー.png


MyBatis Nature

デフォルトでは各ファイルを更新した時のみエラーチェックが実施されるのですが、このMyBatis Natureを設定しておくことで関連するファイルが更新された際に自動的にxmlファイルのエラーチェックも実施してくれるようになります。

設定方法は簡単でプロジェクトファイルを右クリックしてメニューを開き、構成からAdd MyBatis Natureを選択するだけです。

構成.png

オフにする場合は、同じ場所にRemove MyBatis Natureと表示されているのでそれを選択してください。


Mybatis Declaration

XMLファイルで記述したSQL文を見やすく表示してくれる機能です。

表示方法は第3回で解説しているのでそちらをご参照ください。

includeを多く使用するような書き方ですと、

aaaaaaaaaa.png

文字が多くなってしまい見辛くなってしまいます。

そんな時に、下記のように実際に出力されるSQL文を表示してくれます。

bbbb.png

細かい設定は必要なくXMLエディターで選択しているSQLが表示されます。

では今回はこの辺で終わりにします。

今日解説した以外にどんな機能があるのか気になる方はこちらをご参照ください。

※英語のページです。

最後まで読んでいただきありがとうございました。

それではみなさんまた会いましょう!