MyBatisでO/Rマッピング

前置き

MyBatisは他のO/Rマッピングフレームワークとは違って、SQLとオブジェクトをマッピングする。
SQLをXMLファイルで別途定義できるので、実装が分担しやすく管理が容易になる。
以前のCRUD図作成アプリも、 この特性を利用して動作している。

今回は、手順が多い。が、ほとんどが事前準備で、実際はMapperインタフェースと、それに紐づけるXMLファイルがメイン。
本来であれば、Spring FrameworkなどのDIフレームワークと組み合わせて使用するのが一般的。
DIすると、SQLにMapperインタフェースを直接紐づけることができ、かなり便利になる。

今回実装するのは、以前のSQLを、 TableViewで表示するだけの簡単なプログラムで、SELECT文のみ使用する。
もう少し実務寄りな実装は、MyBatis公式で 確認すると良い。という元も子もない事を言っちゃう。

ポイント

• MariaDBでCREATE TABLE時にCHARSETを指定する
• @Mapperを付与したマッパーインタフェースを実装する
• 取得ボタンはデータクラスのListで結果を取得する
• 集計ボタンはMapのListで結果を取得する
• 集計ボタンはSeq列を表示しない
• NULLからデータのマッピングはできないので代替値を取得する
• SqlSessionはCloseするまでトランザクションが終了しない

実装

pom.xmlにMyBatisと、JDBC(今回は、Maria DB)を追加する。

pom.xml
<dependency> <groupId>org.mariadb.jdbc</groupId> <artifactId>mariadb-java-client</artifactId> <version>2.6.2</version> </dependency> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.5.5</version> </dependency>

mybatis-config.xmlを作成し、接続情報とマッピング情報を定義する。

mybatis-config.xml
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration> <environments default="sample_id"> <environment id="sample_id"> <transactionManager type="JDBC"/> <dataSource type="POOLED"> <property name="driver" value="org.mariadb.jdbc.Driver"/> <property name="url" value="jdbc:mariadb://localhost/test"/> <property name="username" value="root"/> <property name="password" value="password/> </dataSource> </environment> </environments> <mappers> <mapper resource="jp/ne/yonem/ProductMapper.xml"/> </mappers> </configuration>

FXDemo.fxml
<?xml version="1.0" encoding="UTF-8"?> <?import javafx.geometry.Insets?> <?import javafx.scene.control.Button?> <?import javafx.scene.control.TableColumn?> <?import javafx.scene.control.TableView?> <?import javafx.scene.layout.BorderPane?> <?import javafx.scene.layout.FlowPane?> <?import javafx.scene.text.Font?> <BorderPane maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="500.0" prefWidth="800.0" xmlns="http://javafx.com/javafx/11.0.1" xmlns:fx="http://javafx.com/fxml/1" fx:controller="jp.ne.yonem.FXDemo"> <center> <TableView fx:id="tblProduct" prefHeight="200.0" prefWidth="200.0" BorderPane.alignment="CENTER"> <columns> <TableColumn fx:id="colSeq" editable="false" prefWidth="75.0" text="Seq" /> <TableColumn fx:id="colCategory" editable="false" prefWidth="75.0" text="Category" /> <TableColumn fx:id="colName" editable="false" prefWidth="75.0" text="Name" /> <TableColumn fx:id="colPrice" prefWidth="75.0" text="Price" /> </columns> </TableView> </center> <top> <FlowPane hgap="20.0" BorderPane.alignment="CENTER"> <children> <Button mnemonicParsing="false" onAction="#onSelect" text="取得"> <font> <Font size="17.0" /> </font> </Button> <Button mnemonicParsing="false" onAction="#onAggregate" text="集計"> <font> <Font size="17.0" /> </font> </Button> </children> <BorderPane.margin> <Insets bottom="20.0" left="20.0" right="20.0" top="20.0" /> </BorderPane.margin> </FlowPane> </top> </BorderPane>

FXDemo.kt
package jp.ne.yonem import javafx.application.Application import javafx.collections.FXCollections import javafx.fxml.FXML import javafx.fxml.FXMLLoader import javafx.fxml.Initializable import javafx.scene.Scene import javafx.scene.control.TableColumn import javafx.scene.control.TableView import javafx.scene.control.cell.PropertyValueFactory import javafx.scene.layout.BorderPane import javafx.stage.Stage import org.apache.ibatis.annotations.Mapper import org.apache.ibatis.io.Resources import org.apache.ibatis.session.SqlSessionFactoryBuilder import java.math.BigDecimal import java.net.URL import java.util.* class FXDemo : Application(), Initializable { @FXML lateinit var tblProduct: TableView<Product> @FXML lateinit var colSeq: TableColumn<Product, Int> @FXML lateinit var colCategory: TableColumn<Product, String> @FXML lateinit var colName: TableColumn<Product, String> @FXML lateinit var colPrice: TableColumn<Product, BigDecimal> data class Product( var seq: Int, var category: String, var name: String, var price: BigDecimal ) override fun start(stage: Stage) { stage.scene = Scene(FXMLLoader.load<BorderPane>(javaClass.getResource("FXDemo.fxml"))) stage.title = "FXDemo" stage.show() } override fun initialize(location: URL?, resources: ResourceBundle?) { colSeq.cellValueFactory = PropertyValueFactory<Product, Int>("seq") colCategory.cellValueFactory = PropertyValueFactory<Product, String>("category") colName.cellValueFactory = PropertyValueFactory<Product, String>("name") colPrice.cellValueFactory = PropertyValueFactory<Product, BigDecimal>("price") } @FXML private fun onSelect() { colSeq.isVisible = true Resources.getResourceAsStream("mybatis-config.xml").use { val factory = SqlSessionFactoryBuilder().build(it) val session = factory.openSession() session.use { val mapper = session.getMapper(ProductMapper::class.java) val outcome: List<Product> = mapper.select() tblProduct.items = FXCollections.observableArrayList(outcome) } } } @FXML private fun onAggregate() { colSeq.isVisible = false Resources.getResourceAsStream("mybatis-config.xml").use { val factory = SqlSessionFactoryBuilder().build(it) val session = factory.openSession() session.use { val mapper = session.getMapper(ProductMapper::class.java) val outcome: List<HashMap<String, Any>> = mapper.subtotal() val list = outcome.map { map -> Product(0, map["category"] as String, map["name"] as String, map["price"] as BigDecimal) }.toList() tblProduct.items = FXCollections.observableArrayList(list) } } } @Mapper interface ProductMapper { fun select(): List<Product> fun subtotal(): List<HashMap<String, Any>> } companion object { @JvmStatic fun main(args: Array<String>) { launch(FXDemo::class.java, *args) } } }

mybatis-config.xml
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="jp.ne.yonem.FXDemo$ProductMapper"> <select id="select" resultType="jp.ne.yonem.FXDemo$Product"> SELECT * FROM PRODUCT; </select> <select id="subtotal" resultType="hashmap"> SELECT CASE WHEN name IS NULL THEN CASE WHEN category IS NULL THEN '合計' ELSE concat(category, ' 小計') END ELSE category END category , coalesce(name, '') name , sum(price) price FROM PRODUCT GROUP BY category , name WITH ROLLUP; </select> </mapper>

データ準備
DROP TABLE IF EXISTS PRODUCT; CREATE TABLE PRODUCT( seq INT , category VARCHAR (40) CHARSET utf8 , name VARCHAR (40) CHARSET utf8 , price DECIMAL , PRIMARY KEY (seq) ); INSERT INTO PRODUCT VALUES (1, 'A', 'Product01', 690) , (2, 'A', 'Product02', 980) , (3, 'A', 'Product03', 220) , (4, 'B', 'Product04', 780) , (5, 'B', 'Product05', 860) , (6, 'B', 'Product06', 780) , (7, 'C', 'Product07', 870) , (8, 'C', 'Product08', 340) , (9, 'C', 'Product09', 380) , (10, 'C', 'Product10', 460);

構成

実行結果

取得ボタン押下


集計ボタン押下