BullよりElk

洋服と食をこよなく愛するWebプログラマ。

Hibernate Enversで履歴管理

エンティティが登録、更新、削除された履歴を管理します。

Hibernate Enversは、履歴管理テーブル全体を管理するエンティティ(デフォルトでRevinfo)をいて、自動採番されるid(プロパティ名はrev)と履歴を永続化した日時(プロパティ名はrevtstmp)の2プロパティを持っています。
エンティティ(後述のClient)の登録、更新、削除された履歴を管理するエンティティ(後述のClientHistory。デフォルトのクラス名はClientAud)が履歴管理するプロパティに加えて、Revinfoのid(デフォルトのプロパティ名はrev)とどのようなイベントが行われたかのフィールド(デフォルトのプロパティ名はrevtype)を持っています。ちなみにrevは、Revisionの略です。

環境

やること

hibernate-enverを依存関係に追加する
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-envers</artifactId>
</dependency>
@Auditedをエンティティクラス(またはエンティティの特定のフィールド)に付与する

今回は、Clientエンティティを使って説明します。

Client.java

@Entity
@Audited
public class Client implements Serializable {
	@Id
	@GeneratedValue(strategy = GenerationType.IDENTITY)
	@Getter
	private Integer id;

	@Getter
	@Setter
	private String name;

	@Embedded
	@Getter
	@Setter
	private Address address;
}

Address.java

@Embeddable
@Getter
@Setter
@Audited
public class Address implements Serializable {

	private int postalCode;

	private String address1;

	private String address2;
}

ここでClientエンティティの履歴を管理したいのでクラスに対して@Auditedを付与します。

Clientエンティティの履歴を管理するエンティティは、デフォルトでClientAudとなります。Audは、Auditの略ですがわかりずらいのでClientHistoryにします。また、ClientHistoryのプロパティ名も、それぞれrevをauditId、revtypeをauditTypeに変更します。application.propertiesに次のように書けば変更できます。

spring.jpa.properties.org.hibernate.envers.audit_table_suffix=_history
spring.jpa.properties.org.hibernate.envers.revision_field_name=audit_id
spring.jpa.properties.org.hibernate.envers.revision_type_field_name=audit_type
テーブルを準備する

Flywayを使うので、sqlファイルに次のように書きます。
これで、Clientと対になるclientテーブル、ClientHistoryと対になるclient_historyテーブル、履歴管理テーブル全体の管理をするrevinfoが作られます。

create table client (
 id integer not null auto_increment,
 name varchar(255),
 postal_code integer not null,
 address1 varchar(255),
 address2 varchar(255),
 primary key (id)
)
 engine=InnoDB;

create table client_history (
 id integer not null,
 name varchar(255),
 postal_code integer,
 address1 varchar(255),
 address2 varchar(255),
 audit_id integer not null,
 audit_type tinyint,
 primary key (id, audit_id)
) engine=InnoDB;

create table revinfo (
 rev integer not null auto_increment,
 revtstmp bigint,
 primary key (rev)
)
engine=InnoDB;

alter table client_history add constraint FK_client_history_revinfo foreign key (audit_id) references revinfo (rev);

できたテーブルがこれです。

https://d2l930y2yx77uc.cloudfront.net/production/uploads/images/6744813/picture_pc_e03a99bea17d7c41c2c71ac4ad27b504.jpg

登録、更新、削除やってみる

それぞれ、Hibernateが生成したSQLです。

登録
Hibernate: insert into client (address1, address2, postal_code, name) values (?, ?, ?, ?)
Hibernate: insert into revinfo (revtstmp) values (?)
Hibernate: insert into client_history (audit_type, address1, address2, postal_code, name, id, audit_id) values (?, ?, ?, ?, ?, ?, ?)

作られたデータ

"client" : {
    "id": 1,
    "name": "hey,inc",
    "postalCode": 1500011,
    "address1": "東京都",
    "address2": "渋谷区東3丁目16番3号 エフ・ニッセイ恵比寿ビル4階"
}

"clientHistory": {
    "id": 1,
    "name": "hey,inc",
    "postalCode": 1500011,
    "address1": "東京都",
    "address2": "渋谷区東3丁目16番3号 エフ・ニッセイ恵比寿ビル4階",
    "audit_id": 1,
    "audit_type": 0
}

"revinfo": {
    "rev": 1,
    "revtstmp": 1528214457258
}
更新
Hibernate: update client set address1=?, address2=?, postal_code=?, name=? where id=?
Hibernate: insert into revinfo (revtstmp) values (?)
Hibernate: insert into client_history (audit_type, address1, address2, postal_code, name, id, audit_id) values (?, ?, ?, ?, ?, ?, ?)

作られたデータ

"client" : {
   "id": 1,
   "name": "Coiney,inc",
   "postalCode": 1500011,
   "address1": "東京都",
   "address2": "渋谷区東3丁目16番3号 エフ・ニッセイ恵比寿ビル4階"
}

"clientHistory": {
   "id": 1,
   "name": "Coiney,inc",
   "postalCode": 1500011,
   "address1": "東京都",
   "address2": "渋谷区東3丁目16番3号 エフ・ニッセイ恵比寿ビル4階",
   "audit_id": 2,
   "audit_type": 1
}

"revinfo": {
   "rev": 2,
   "revtstmp": 1528214465266
}
削除
Hibernate: delete from client where id=?
Hibernate: insert into revinfo (revtstmp) values (?)
Hibernate: insert into client_history (audit_type, address1, address2, postal_code, name, id, audit_id) values (?, ?, ?, ?, ?, ?, ?)

作られたデータ

"clientHistory": {
   "id": 1,
   "name": null,
   "postalCode": null,
   "address1": null,
   "address2": null,
   "audit_id": 3,
   "audit_type": 2
}
"revinfo": {
   "rev": 3,
   "revtstmp": 1528214465681
}

ここでauditTypeの0、1、2は何ですか?という疑問が残ってるかと思いますが、それぞれ次の通りです。
0 → 登録
1 → 更新
2 → 削除
イベントにあったタイプが与えられます。

Hibernate Enversで履歴管理が楽になりました。現場からは以上でした。

私のPC事情

会社変わる時とかに、前の会社のPCでのブックマークとかアプリ移行できないときのためにメモ。

Chrome拡張機能

その他

Portailleとmitakeと

いろいろと落ち着いて最近はよいことだらけで、楽しい毎日を送ってます♪今日は、久々にテックじゃないこと書こうと思います。

今日は、Portailleとmitakeの展示会&ポップアップショップに遊びに行ってきました!私の靴と帽子をお世話になってるブランドさんたちです。

Portailleは、代官山で展示会でした。

今回は、バッグや小物なども作られていて、とても楽しみにして向かいました。
着いてまず飛び込んで来たのが今回からの新しいレザーで新しい型の靴。このレザー伸ばすと色が少し変わるんですよ?
いつも、大渕夫妻がレザーとか靴の説明を丁寧にしてくださって毎回感動しています。そして、作り手の声を直できけるのはすごくよい経験です。

次にバッグ。案の定すごくかわいい。特に小さい方のバッグがとても好き!しかし、スペイン行くかもで金銭的にきついし、行きつけのお店で3つほど入れてるとのことで今回は断念。


原宿ラフォーレに移動して、mitakeのポップアップショップ行きました。
デザイナーの三岳さんがいらっしゃいました。ETHOSENSにいらっしったので、ユニセックスっぽい方かと思っていたら、ワーク系の方でちょっとびっくりしました。
そして、以前書いたブログの記事を読んでくださってて、2度びっくりでした。
色々と三岳さんとお話できて、どんな方かふんわりわかって、ますますmitakeの帽子が好きになりました!そして、また買っちゃいましたねw
大好きなビッグベレー。
f:id:b1a9id:20180310223700j:plain

直接被り方教えてもらえたけど、自分ので問題なかったw
オールシーズンいける生地なので、ヘビロテしようと思います。

これからもPortailleとmitakeには、お世話になるだろうな。

JUnit5試したみた #3(ParameterizedTest)

前回に引き続き、JUnit5について書きます。2018年1月15日に5.0.3がリリースされましたね。今回は、ParameterizedTestについてです。
元のソースコードGitHubにおいてあります。
github.com

ParameterizedTest

ParameterizedTestは、指定した引数を用いて、複数回テストを実行することができます。同じテストだけど、引数だけが違うというときに使えます!
引数のタイプを指定できるアノテーションは、以下の6つです。
@ValueSource、@EnumSource、@MethodSource、@CsvSource、@CsvFileSource、@ArgumentSource
詳しくは、後ほど説明します。

@ValueSource

@ValueSourceは、最もシンプルに引数のタイプを指定できます。
@ValueSourceで指定できる型は、String、int、long、doubleの配列です。配列の前から順番にテストします。
以下がStringの配列を指定したときの例です。int、long、doubleのときも同様です。

テスト対象クラス

テストクラス


実行結果

f:id:b1a9id:20180118101714p:plain

@EnumSource

@EnumSourceで指定できる属性は、value、names、modeがあります。配列の前から順番にテストします。

属性 説明
value Enumのタイプを指定する。
names Valueで指定したEnumのタイプの特定の値をStringの配列で指定する(正規表現も使用可能)。これらの値をテストでどういう扱いにするかをmodeで指定する。
mode EnumSource.Modeのどれか(EXCLUDE, INCLUDE, MATCH_ALL, MATCH_ANY)を指定する。

EnumSource.Modeの説明

説明
EXCLUDE namesで指定した値を除外して抽出する。
INCLUDE namesで指定した値のみ抽出する。namesのデフォルトはこれです。
MATCH_ALL namesで正規表現を指定した場合にすべてに当てはまる値のみ抽出する。
MATCH_ANY namesで正規表現を指定した場合にどれかに当てはまる値のみ抽出する。

なお、namesを未指定でMATCH_ALLまたはMATCH_ANYを指定した場合は、すべての値を抽出します。

テスト対象のEnum

テストクラス


@CsvSource

@CsvSourceで指定できる型は、カンマ区切り文字列の配列です。配列の前から順番にテストします。
説明があまりうまくできていない気がするのでサンプルみてみましょうw
ちなみに指定の仕方は、JUnit 5 User Guideに詳しく書いてあるのでこちらを参照していただければと思います。

テストクラス


実行結果

f:id:b1a9id:20180118145219p:plain

@CsvFileSource

@CsvSourceとほぼ同様ですが、こちらは、ファイルから読み込むことができます。

テスト対象CSV

テストクラス


実行結果

f:id:b1a9id:20180118150155p:plain

解説

ちなみに、@CsvFileSourceは、ファイルの文字コード、改行文字、区切り文字を指定できるようです。(区切り文字は、@CsvSourceでも指定できます。)
区切り文字に「・」を指定して実行してみましたが、表示するメッセージはcsv用になっていました。まあ、アノテーションにもCsvとついていますし、区切り文字は指定しない方がいいかもしれませんね。

@MethodSource

@MethodSourceは、自分で実装した指定したい型のSteramまたはIterableまたはIteratorまたは配列を返すメソッドをStringの配列で指定します。

メソッドの引数が1つのときの、テストクラス

methodSourceIntStreamメソッドの実行結果

f:id:b1a9id:20180118152736p:plain

methodSourceStreamメソッドの実行結果

f:id:b1a9id:20180118152802p:plain

メソッドの引数が2つのときの、テストクラス

実行結果

f:id:b1a9id:20180118153322p:plain

解説

メソッドで複数の引数を指定したい場合は、ArgumentインターフェースのCollectionかStreamを返す必要があります。

@ArgumentsSource

上で紹介したものは全てArgumentsProviderインターフェースを実装したクラスを呼んでいます。
f:id:b1a9id:20180118155745p:plain
つまり、再利用可能なArgumentsProviderを実装して、値を自由に指定しようということです。

テストクラス

実行結果

f:id:b1a9id:20180118162125p:plain

おまけ(表示するメッセージをカスタマイズする)

@ParameterizedTestのname属性を指定することで、表示するメッセージをカスタマイズできます。

サンプルコード

実行結果

f:id:b1a9id:20180118163135p:plain

解説

次のプレースホルダが使えます。

プレースホルダ 説明
{index} 現在の呼び出し回数
{arguments} メソッドの引数のリスト(カンマ区切りで表示される)
{0}, {1},... 個々の引数

以上です。次はDynamicTestとか紹介できたらいいかなと思います。

JUnit5試したみた #2 (RepeatedTest)

前回に引き続き、JUnit5について書きます。今回は、RepeatedTestについてです。

RepeatedTest

指定した回数@RepeatedTestを付与したテストメソッドを実行してくれます。具体的に言うと、@RepeatedTestのvalue属性に実行したい回数を指定します。

サンプルコード

実行結果

f:id:b1a9id:20171230113258p:plain

解説

BeforeEachは、各テストの各繰り返し回数ごとに実行される

以下の結果から見出しのことが言えます。

表示名がカスタマイズできる

RepeatedTestでは、先に説明したことに加えて、繰り返し回数ごとに表示名(displayName)をカスタマイズすることができます。デフォルトの表示名は、RepeatedTest.SHORT_DISPLAY_NAMEである、「repetition [現在の実行回数] of [実行すべき回数]」です。
静的なテキストと動的なプレースホルダーから成り立つメッセージを、@RepeatedTestのname属性に指定します。
用意されているプレースホルダーは、次の3つになります。

{displayName} @RepeatedTestメソッドのdisplayName
{currentRepetition} 現在の実行回数
{totalRepetitions} 実行すべき回数

繰り返し回数ごとに表示名を変更しているテストが、customDisplayName()メソッドとcustomDisplayNameLongPattern()メソッドになります。
後者のテストでは、name属性にRepeatedTest.LONG_DISPLAY_NAMEを指定しています。実際に表示されるメッセージは、「Details... :: repetition [現在の実行回数] of [実行すべき回数]」です。

ここで、現在の実行回数や実行すべき回数ってどう取得すればいいの?って疑問がでてくると思います。
RepetitionInfoインターフェースをインジェクトすることで解決できます。
これは、getCurrentRepetition()メソッドとgetTotalRepetitions()メソッドを持ったインターフェースで、@RepeatedTest、@BeforeEach、@AfterEachが付与されたメソッドにのみインジェクトすることができます。
@RepeatedTestが付与されたメソッドが存在しないクラスで、@BeforeEachまたは@AfterEachが付与されたメソッドにRepetitionInfoをインジェクトしようとすると、ParameterResolutionExceptionがスローされます。
customDisplayName()メソッドを見てもらえば、使い方がわかると思います。

次回は、ParameterizedTestについて書きます。

JUnit5試したみた #1

JUnit5が9/10にリリースされました。リリースからちょっと時間が経ってしましましたが、JUnit5について書きたいと思います。

What' new JUnit5?

大きな違いと言えば、3つの異なるサブプロジェクトから構成されていることです。以前のバージョンまでは、1プロジェクトで構成されていました。
つまり、こういうことです。
JUnit 5 = JUnit Platform + JUnit Jupiter + JUnit VintageJUnit 5 User Guide より)

各プロジェクトの役割について簡単に説明します。

JUnit Platform

JVM上でテストフレームワークを動かすための基盤を提供します。

JUnit Jupiter

プラットフォーム上でJupiterベースのテストを動かすためのテストエンジンを提供します。

JUnit Vintage

プラットフォーム上でJUnit3やJUnit4ベースのテストを動かすためのテストエンジンを提供します。

JUnit5の導入

pom.xmlにこれらを追加してください。なお、JUnit5を動かすためには、Java8以上である必要があります。

それぞれの説明は JUnit 5 User Guide に書いてあります。

pom.xml

一般的なテスト

サンプルコードです。

StandardTest.java

アノテーションの説明

テストを書く上で、よく使うアノテーションについて説明します。

@DisplayName

テストクラスやメソッドにつけることができるアノテーションです。
テストランナーやテストレポートが引数で指定した値を表示してくれます。文字列、空白、絵文字などを使うことができます。

@BeforeAll

JUnit4でいうところの@BeforeClassです。
全ての@Test, @RepeatedTest, @ParameterizedTest, and @TestFactory テスト実行前に1度だけ実行されます。

@BeforeEach

JUnit4でいうところの@Beforeです。
@Test, @RepeatedTest, @ParameterizedTest, and @TestFactory 各テスト実行前に実行されます。

@Disabled

JUnit4でいうところの@Ignoreです。
これをつけたテストクラス及びメソッドは実行されません。

実行結果

IntelliJ IDEAで実行しています。

@DisplayNameの表示

@DisplayNameで指定した値が表示されていることがわかります。今まではコメントとしてどういったテストか書いていたのでありがたいです。
f:id:b1a9id:20171226114300p:plain

結果出力

@BeforeAllがクラス内で1度だけ、@BeforeEachが各テスト前に実行されていることがわかります。

executed before all test just once.
executed before each test.
This is test1.

This is Disabled test.
executed before each test.
This is test3.

基本的なアサーションの紹介

サンプルコードです。
基本的にはJavaDocを読めば理解できると思います。

StandardAssertionTest.java

Assertions#assertAll

第1引数で指定している値は、テスト失敗時にメッセージに含みたい値になります。
DependentAssertions#nameAssertionsの失敗例です。

org.opentest4j.MultipleFailuresError: This is name test. (1 failure)
	expected: <Ryo> but was: <Ryosuke>

Assertions#fail

AssertionFailedErrorを投げて必ずテストを失敗させる。値を返す前に例外を投げる。AssertJのassertThatThrowByを使ってたら使い道なさそう...


Assumption

Assumption#assumeTrueとかの結果がTrueだったら、それ以降に書いた検証を実行します。厳密には、TestAbortedExceptionを投げてテストを中断させています。
AssumptionAssertions#invalidTestでAssumption#assumeFalseの第2引数に渡した「() -> "This is invalid."」は、テストが中断したときにメッセージに含みたい値になります。

org.opentest4j.TestAbortedException: Assumption failed: This is invalid.

実行結果

AssumptionAssertionsクラスで中断されたテストは結果に出力されていないことがわかると思います。中断されたことは、ログに出力されます。
f:id:b1a9id:20171226154151p:plain

今回は、JUnit5の導入的なところ触れてみました。次回は実用的なテストを書こうと思います。
ちなみに使用したサンプルコードはこちらにあります。
github.com