Bean Validationとの連携

Bean Validationによるカラムの値の検証する方法を説明します。

ライブラリの追加

Bean Validationを利用する際には、ライブリを追加します。 Mavenを利用している場合は、pom.xmlに以下を追加します。

本ライブラリは、Bean Validation1.0/1.1/2.0 及び、Jakarta Bean Validaiton 3.0/3.1 に対応しており、その参照実装である Hibernate Validator を追加します。

Hibernate Validator は対応するBean Validaitonのバージョンが決まっているため、対応したライブラリのバージョンを追加する必要があります。

• ただし、TomcatやGlassFishなどのWebコンテナ上で使用するのであれば、EL式のライブラリはそれらに組み込まれているため必要ありません。

• また、本ライブラリの機能を利用して、JEXL に切り替えるのであれば、式言語の追加は必要ありません。

Bean ValidationとHibernate Validatorの対応バージョン

Bean Validation	Hibernate Validator	備考
ver.1.0 (JSR-303)	ver.4.x	Java8以上で利用可能です。
ver.1.1 (JSR-349)	ver.5.x	Java8以上で利用可能です。
ver.2.0 (JSR-380)	ver.6.x	Java8以上で利用可能です。
ver.3.0/3.1	ver.8.x	Super Csv Annotation 2.4+ から対応しています。 Hibernate Validator v8.xから、Java11以上 が必須になります。 Bean Validaitonから、Jakarta Bean Validationに名称が変更されパッケージも変更されています。

Bean Validation 1.0(JSR-303)を利用する場合は、Hibernate Validator4.x系を利用します。 Bean Validation 1.0では、メッセージ中でEL式は利用できませんが、本ライブラリの機能を使用すれば、JEXL が利用できます。

pom.xmlの依存関係の追加（Bean Validation1.0を利用する場合）

<!-- Bean Validation 1.0 -->
<dependency>
<groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>1.0.0.GA</version>
</dependency>
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>4.3.2.Final</version>
</dependency>

Bean Validation 1.1(JSR-349)を利用する場合は、Hibernate Validator5.x系を利用します。 さらに、メッセージ中にJava EEのEL式が利用可能となっているため、その実装であるライブリを追加します。

pom.xmlの依存関係の追加（Bean Validation1.1を利用する場合）

<!-- Bean Validation 1.1 -->
<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>1.1.0.Final</version>
</dependency>
<dependency>
<groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>5.3.3.Final</version>
</dependency>

<!-- EL式のライブラリが必要であれば追加します -->
<dependency>
    <groupId>org.glassfish</groupId>
    <artifactId>javax.el</artifactId>
    <version>3.0.1-b08</version>
</dependency>

Bean Validation 2.0(JSR-380)を利用する場合は、Hibernate Validator6.x系を利用します。 さらに、メッセージ中にJava EEのEL式が利用可能となっているため、その実装であるライブリを追加します。

pom.xmlの依存関係の追加（Bean Validation2.0を利用する場合）

<!-- Bean Validation 2.0 -->
<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>2.0.1.Final</version>
</dependency>
<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.2.3.Final</version>
</dependency>

<!-- EL式のライブラリが必要であれば追加します -->
<dependency>
    <groupId>org.glassfish</groupId>
    <artifactId>javax.el</artifactId>
    <version>3.0.1-b12</version>
</dependency>

Jakarta Bean Validation 3.0/3.1を利用する場合は、Hibernate Validator8.x系を利用します。 さらに、メッセージ中にJakarta EEのEL式が利用可能となっているため、その実装であるライブリを追加します。

pom.xmlの依存関係の追加（Jakarta Bean Validation3.1を利用する場合）

<!-- Jakarta Bean Validation 3.1 -->
<dependency>
    <groupId>jakarta.validation</groupId>
    <artifactId>jakarta.validation-api</artifactId>
    <version>3.1.0</version>
</dependency>
<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>8.0.2.Final</version>
</dependency>

<!-- EL式のライブラリが必要であれば追加します -->
<dependency>
    <groupId>org.glassfish.expressly</groupId>
    <artifactId>expressly</artifactId>
    <version>5.0.0</version>
</dependency>

Bean Validationの利用方法

アノテーション @CsvBean(validatosr=CsvBeanValidator.class) を指定します。

• Bean Validation 1.0/1.1/2.0の場合は、 CsvBeanValidator を指定します。

• Jakarta Bean Validation 3.0/3.1の場合は、 JakartaCsvBeanValidator を指定します。

CsvBeanValidator / JakartaCsvBeanValidator は、Bean Validation と、本ライブラリの CsvValidator をブリッジするクラスです。

独自のメッセージソースは、クラスパスのルートに HibernateValidation.properties を配置しておけば自動的に読み込まれます。

import com.github.mygreen.supercsv.annotation.CsvBean;
import com.github.mygreen.supercsv.annotation.CsvColumn;
import com.github.mygreen.supercsv.validation.beanvalidation.CsvBeanValidator;

import javax.validation.constraints.AssertTrue;
import javax.validation.constraints.DecimalMax;
import javax.validation.constraints.Pattern;

import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.NotEmpty;
import org.hibernate.validator.constraints.Range;

// Bean Validationの指定方法
@CsvBean(validators=CsvBeanValidator.class)
// @CsvBean(validators=JakartaCsvBeanValidator.class)   // Jakarta Bean Validation の場合
private static class TestCsv {

    @CsvColumn(number=1)
    @NotEmpty
    private String id;

    @CsvColumn(number=2)
    @Length(max=10)
    @Pattern(regexp="[\\p{Alnum}]+", message="半角英数字で設定してください。")
    private String name;

    @CsvColumn(number=3)
    @Range(min=0, max=100)
    private Integer age;

    @CsvColumn(number=4)
    boolean used;

    // 相関チェック
    @AssertTrue(message="{name}が設定されている際には、{age}は必須です。")
    boolean isValidAgeRequired() {
        if(name != null && !name.isEmpty()) {
            return age != null;
        }

        return false;
    }

    // setter/gettterは省略
}

Bean Validation による値の検証でエラーがある場合は、例外 SuperCsvBindingException としてスローされます。

• 例外クラスは、 CsvExceptionConverter メッセージに変換します。

• CsvExceptionConverter は、CsvAnnotationBeanReader/CsvAnnotationBeanWriter に組み込まれているため、 メソッド #getErrorMessages() で取得できます。

  • 詳細は、値の検証時のエラーメッセージ を参照してください。

import java.nio.charset.Charset;
import java.nio.file.Files;
import java.io.File;
import java.util.ArrayList;
import java.util.List;

import org.supercsv.prefs.CsvPreference;
import org.supercsv.exception.SuperCsvException;

import com.github.mygreen.supercsv.io.CsvAnnotationBeanReader;
import com.github.mygreen.supercsv.validation.CsvExceptionConverter;


public class Sample {

    public void sampleRead() {

        CsvAnnotationBeanReader<SampleCsv> csvReader;
        try {
            csvReader = new CsvAnnotationBeanReader<>(
                SampleCsv.class,
                Files.newBufferedReader(new File("sample.csv").toPath(), Charset.forName("Windows-31j")),
                CsvPreference.STANDARD_PREFERENCE);

            // ファイルの読み込み
            List<SampleCsv> list = csvReader.readAll();

        } catch(SuperCsvException e) {

            // 変換されたエラーメッセージの取得
            List<String> messages = csvReader.getErrorMessages();

        } finally {
            if(csvReader != null) {
                csvReader.close();
            }
        }
    }

}

Bean Validationのカスタマイズ

本ライブラリ用のメッセージソースや JEXL に切り替える場合、 Bean Validationのインスタンスを変更する必要があります。

その場合は、@CsvBean(validators=CsvBeanValidator.class) で指定するのではなく、 メソッド CsvAnnotationBeanReader#addValidators(...) 、CsvAnnotationBeanWriter#addValidators(...) で直接追加します。

import com.github.mygreen.supercsv.builder.BeanMapping;
import com.github.mygreen.supercsv.builder.BeanMappingFactory;
import com.github.mygreen.supercsv.localization.MessageInterpolator;
import com.github.mygreen.supercsv.localization.MessageResolver;
import com.github.mygreen.supercsv.localization.ResourceBundleMessageResolver;
import com.github.mygreen.supercsv.validation.beanvalidation.CsvBeanValidator;

import java.nio.charset.Charset;
import java.nio.file.Files;
import java.io.File;

import org.supercsv.prefs.CsvPreference;

public class Sample {

    // Beanの定義（validatorsの指定は行わない）
    @CsvBean
    public static class SampleCsv {
        // 省略
    }

    public void sampleBeanValidationCustom() {

        // CsvReaderの作成
        CsvAnnotationBeanReader<SampleCsv> csvReader = new CsvAnnotationBeanReader<>(
                SampleCsv.class,
                Files.newBufferedReader(new File("sample.csv").toPath(), Charset.forName("Windows-31j")),
                CsvPreference.STANDARD_PREFERENCE);

        // BeanValidator用のValidatorの作成
        final ValidatorFactory validatorFactory = Validation.byDefaultProvider().configure()
            // メッセージ処理クラスを本ライブラリのものに入れ替えてインスタンスを生成する
            .messageInterpolator(new MessageInterpolatorAdapter(
                new ResourceBundleMessageResolver(),
                new MessageInterpolator()))
            .buildValidatorFactory();

        final Validator beanValidator = validatorFactory.usingContext()
            .getValidator();

        // Validatorの追加
        csvReader.addValidators(new CsvBeanValidator(beanValidator));
        // Jakarta Bean Validation の場合は、JakartaCsvBeanValidator を使用します。
        // csvReader.addValidators(new JakartaCsvBeanValidator(beanValidator));
    }

}

メッセージ中の変数として、既存の変数に加えて、CSV用の次の変数が登録されており利用可能です。

メッセージ中で利用可能な変数

変数名	説明
lineNumber	CSVの実ファイル上の行番号。 カラムの値に改行が含まれている場合を考慮した実際の行番号なります。 1から始まります。
rowNumber	CSVの論理上の行番号です。 1から始まります。
columnNumber	CSVの列番号です。 1から始まります。
label	@CsvColumn(label="<見出し>") 出指定したカラムの見出し名です。 label属性を指定していない場合は、フィールド名になります。
validatedValue	不正となった値です。
printer	各クラスの TextFormatter のインスタンスです。 ${printer.print(validatedValue)} で、オブジェクトをフォーマットするのに利用します。

Bean ValidationとSpring Frameworkとの連携

Spring Frameworkと連携することで、コードがシンプルになります。 また、独自のフィールド用のValidator内にSpringBeanをインジェクション可能です。

XMLによるコンテナの設定

XMLによる設定方法を説明します。

コンテナの定義の基本は次のようになります。

• アノテーションによるDIの有効化を行います。

• コンポーネントスキャン対象のパッケージの指定を行います。

• com.github.mygreen.supercsv.builder.SpringBeanFactory をSpringBeanとして登録します。

• Springの MessageSource で、本ライブラリのエラーメッセージ com.github.mygreen.supercsv.localization.SuperCsvMessages を読み込んでおきます。 * 独自のエラーメッセージがあれば、追加で定義します。

  • com.github.mygreen.supercsv.localization.SpringMessageResolver に、MessageSource を渡します。

• CsvBeanValidator に、Springの LocalValidatorFactoryBean で作成したBeanValidationのValidtorのインスタンスを渡します。

<?xml version="1.0" encoding="UTF-8"?>
<!-- XMLによるコンテナの定義 -->
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd
    ">

    <!-- アノテーションによるDIの有効化の定義 -->
    <context:annotation-config />

    <!-- コンポーネントスキャン対象のパッケージの指定 -->
    <context:component-scan base-package="sample.spring" />

    <!-- Springのコンテナを経由するCSV用のBeanFactoryの定義 -->
    <bean id="springBeanFacatory" class="com.github.mygreen.supercsv.builder.SpringBeanFactory" />

    <!-- Spring標準のメッセージソースの定義 -->
    <bean id="messageSource" class="org.springframework.context.support.ResourceBundleMessageSource">
        <property name="basenames">
            <list>
                <value>com.github.mygreen.supercsv.localization.SuperCsvMessages</value>
                <value>TestMessages</value>
            </list>
        </property>
    </bean>

    <!-- Super CSV Annotation 用のMessgeResolverの定義 -->
    <bean id="springMessageResolver" class="com.github.mygreen.supercsv.localization.SpringMessageResolver">
        <property name="messageSource" ref="messageSource" />
    </bean>

    <!-- Bean Validation用のCsvValidatorの定義 -->
    <bean id="csvBeanValidator" class="com.github.mygreen.supercsv.validation.beanvalidation.CsvBeanValidator">
        <constructor-arg>
            <bean class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
                <property name="messageInterpolator">
                    <bean class="com.github.mygreen.supercsv.validation.beanvalidation.MessageInterpolatorAdapter">
                        <constructor-arg ref="springMessageResolver" />
                        <constructor-arg><bean class="com.github.mygreen.supercsv.localization.MessageInterpolator" /></constructor-arg>
                    </bean>
                </property>
            </bean>
        </constructor-arg>
    </bean>

    <!-- Jakarta Bean Validation 用のCsvValidatorの定義 -->
    <bean id="jakartaCsvBeanValidator" class="com.github.mygreen.supercsv.validation.beanvalidation.JakartaCsvBeanValidator">
        <constructor-arg>
            <bean class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
                <property name="messageInterpolator">
                    <bean class="com.github.mygreen.supercsv.validation.beanvalidation.JakartaMessageInterpolatorAdapter">
                        <constructor-arg ref="springMessageResolver" />
                        <constructor-arg><bean class="com.github.mygreen.supercsv.localization.MessageInterpolator" /></constructor-arg>
                    </bean>
                </property>
            </bean>
        </constructor-arg>
    </bean>

</beans>

JavaConfigによるコンテナの設定

Spring Framework3.0から追加された、JavaソースによるSpringBean定義の方法を説明します。

JavaConfigによる設定を使用する場合は、Spring Frameworkのバージョンをできるだけ最新のものを使用してください。 特に、機能が豊富なバージョン4.0以上の使用を推奨します。

import javax.validation.Validator;

import org.springframework.context.MessageSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Description;
import org.springframework.context.support.ResourceBundleMessageSource;
import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;

import com.github.mygreen.supercsv.builder.SpringBeanFactory;
import com.github.mygreen.supercsv.localization.MessageInterpolator;
import com.github.mygreen.supercsv.localization.SpringMessageResolver;
import com.github.mygreen.supercsv.validation.beanvalidation.CsvBeanValidator;
import com.github.mygreen.supercsv.validation.beanvalidation.MessageInterpolatorAdapter;


// Javaによるコンテナの定義
@Configuration
@ComponentScan(basePackages="sample.spring")
public class SuperCsvConfig {

    @Bean
    @Description("Springのコンテナを経由するCSV用のBeanFactoryの定義")
    public SpringBeanFactory springBeanFactory() {
        return new SpringBeanFactory();
    }

    @Bean
    @Description("Spring標準のメッセージソースの定義")
    public MessageSource messageSource() {
        ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
        messageSource.addBasenames("com.github.mygreen.supercsv.localization.SuperCsvMessages", "TestMessages");
        return messageSource;
    }

    @Bean
    @Description("本ライブラリのSpring用のMessgeResolverの定義")
    public SpringMessageResolver springMessageResolver() {
        return new SpringMessageResolver(messageSource());
    }

    @Bean
    @Description("CSV用のCsvValidaotrの定義")
    public CsvBeanValidator csvBeanValidator() {

        LocalValidatorFactoryBean validator = new LocalValidatorFactoryBean();
        // メッセージなどをカスタマイズ
        validator.setMessageInterpolator(new MessageInterpolatorAdapter(
                springMessageResolver(), new MessageInterpolator()));

        // ValidarorのインスタンスをSpring経由で作成したものを利用する
        CsvBeanValidator csvBeanValidator = new CsvBeanValidator(validator);
        return csvBeanValidator;
    }

    @Bean
    @Description("CSV用のCsvValidaotrの定義 - Jakarta Bean Validationの場合")
    public JakartaCsvBeanValidator jakartaCsvBeanValidator() {

        LocalValidatorFactoryBean validator = new LocalValidatorFactoryBean();
        // メッセージなどをカスタマイズ
        validator.setMessageInterpolator(new JakartaMessageInterpolatorAdapter(
                springMessageResolver(), new MessageInterpolator()));

        // ValidarorのインスタンスをSpring経由で作成したものを利用する
        JakartaCsvBeanValidator csvBeanValidator = new JakartaCsvBeanValidator(validator);
        return csvBeanValidator;
    }

}

独自のConstraintValidatorの作成

Bean Validationの独自のアノテーションを作成する際には、通常の方法と同じです。

• メタアノテーション @Constraint を付与します。

  • 属性 validatedBy に、 ConsraintValidator の実装クラスを指定します。

• 複数指定可能できるように、内部クラス List を定義しておきます。

  • Bean Validation 1.1の段階では、Java8から追加された @Repeatable は対応していませんが、 従来の定義方法と揃えておくことで、@Repeatable を使ってJava8のスタイルで使用できます。

  • ただし、今後リリース予定のBeanValidator2.0から @Repeatable 対応するため、定義しておいても問題はありません。

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.validation.Constraint;
import javax.validation.Payload;

//BeanValidationの制約のアノテーション
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(UserMailPattern.List.class) // 対応していないので、定義しなくても良い。
@Constraint(validatedBy=UserMailPatternValidator.class)
public @interface UserMailPattern {

    // 共通の属性の定義
    Class<?>[] groups() default {};
    String message() default "{sample.spring.UserMailPattern.message}";
    Class<? extends Payload>[] payload() default {};

    // 複数のアノテーションを指定する場合の定義
    @Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @interface List {
        UserMailPattern[] value();
    }

}

ConstraintValidator の実装中で、SpringBeanのインジェクションを行いたい場合は、アノテーション @Resource/@Autowired など使います。

ConstraintValidator 自身は、SpringBeanとして登録する必要はありません。

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

import org.springframework.beans.factory.annotation.Autowired;


// ConstraintValidatorの実装
public class UserMailPatternValidator implements ConstraintValidator<UserMailPattern, String> {

    // SpringBeanをインジェクションします。
    @Autowired
    private UserService userService;

    @Override
    public void initialize(final UserMailPattern constraintAnnotation) {

    }

    @Override
    public boolean isValid(final String value, final ConstraintValidatorContext context) {

        // nullの場合は対象外
        if(value == null) {
            return true;
        }

        return userService.isMailPattern(value);
    }

}

CsvBeanの定義

CSVのBeanの定義では、@CsvBean(validator=CsvBeanValidator.class) で、CsvBeanValidatorを指定します。

import com.github.mygreen.supercsv.annotation.CsvBean;
import com.github.mygreen.supercsv.annotation.CsvColumn;
import com.github.mygreen.supercsv.validation.beanvalidation.CsvBeanValidator;


@CsvBean(header=true, validator=CsvBeanValidator.class)
public class UserCsv {

    @CsvColumn(number=1, label="メールアドレス")
    @UserMailPattern   // 独自のBeanValidator用のアノテーションの指定
    private String mail;

    // setter/getterは省略

}

値の検証方法

• BeanMappingFactory#getConfiguration() 取得できる、システム設定に、SpringBeanFactoryを設定します。

• CsvExceptionConverter#setMessageResolver(...) に、SpringBeanとして定義した SpringMessageResolver を設定します。

  • さらに、 CsvAnnotationBeanReader#setExceptionConverter(...) に、作成した CsvExceptionConverter を渡します。

import com.github.mygreen.supercsv.builder.BeanMapping;
import com.github.mygreen.supercsv.builder.BeanMappingFactory;
import com.github.mygreen.supercsv.io.CsvAnnotationBeanReader;

import java.nio.charset.Charset;
import java.nio.file.Files;
import java.io.File;
import java.util.ArrayList;
import java.util.List;

import org.supercsv.prefs.CsvPreference;
import org.supercsv.exception.SuperCsvException;

@Service
public class CsvService {

    @Autowired
    private SpringBeanFactory beanFactory;

    @Autowired
    private SpringMessageResolver messageResolver;

    public void sampleSpring() {

        // BeanMappingの作成 - SpringBeanFactoryを設定する
        BeanMappingFactory beanMappingFactory = new BeanMappingFactory();
        beanMappingFactory.getConfiguration().setBeanFactory(beanFactory);

        // BeanMappingの作成
        BeanMapping<UserCsv> beanMapping = mappingFactory.create(UserCsv.class);

        CsvAnnotationBeanReader<UserCsv> csvReader;
        try {
            csvReader = new CsvAnnotationBeanReader<>(
                    beanMapping,
                    Files.newBufferedReader(new File("user.csv").toPath(), Charset.forName("Windows-31j")),
                    CsvPreference.STANDARD_PREFERENCE);

            // CsvExceptionConverterの作成 - SpringMessageResolverを設定する
            CsvExceptionConverter exceptionConverter = new CsvExceptionConverter();
            exceptionConverter.setMessageResolver(messageResolver);

            // CsvExceptionConverterを設定する
            svReader.setExceptionConverter(exceptionConverter);

            // ファイルの読み込み
            List<SampleCsv> list = csvReader.readAll();

        } catch(SuperCsvException e) {

            // 変換されたエラーメッセージの取得
            List<String> messages = csvReader.getErrorMessages();

        } finally {
            if(csvReader != null) {
                csvReader.close();
            }
        }
    }

}