Spring MVC 4.1 No. 019 Validatorでロジックを介した検証

今回はBean Validationのの複数のフィールドを対象とした検証です。

Bean Validationはその名前の通り、JavaBeansのテストの仕組みです。そのため、フィールドだけでなくgetterに対してテストをすることができます。（より詳しくは JSR 303 Bean Validationで遊んでみるよ！）

最初にこれまでと同様の、ControllerとJSPを作成します。これまでとの違いは、定価のフィールドを追加するのと、validPriceのエラーを表示する部分になります。

package com.example.spring.controller.c019;

import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
@RequestMapping("/c019")
public class C019Controller {
    @RequestMapping("/bookForm")
    public String bookForm() {
        return "c019/bookForm";
    }

    @RequestMapping(value = "/bookRecv", method = RequestMethod.POST)
    public String bookRecv(@Validated @ModelAttribute C019Model c019Model,
            BindingResult errors) {
        if (errors.hasErrors()) {
            return "c019/bookForm";
        }
        return "c019/bookRecv";
    }
}

<%@page contentType="text/html; charset=utf-8" %><%--
--%><!DOCTYPE html>
<html>
 <head>
  <meta charset="utf-8">
  <title>サンプル</title>
 </head>
 <body>
  <form action="bookRecv" method="post">
   書名: <input type="text" name="name" size="20"><form:errors path="c019Model.name" /><br>
   価格: <input type="text" name="price" size="20"><form:errors path="c019Model.price" /><form:errors path="c019Model.validPrice" /><br>
   定価: <input type="text" name="listPrice" size="20"><form:errors path="c019Model.listPrice" /><br>
   <input type="submit" value="送信">
  </form>
 </body>
</html>

<%@page contentType="text/html; charset=utf-8" %><%--
--%><!DOCTYPE html>
<html>
 <head>
  <meta charset="utf-8">
  <title>サンプル</title>
 </head>
 <body>
c019Model.nameの値は <c:out value="${c019Model.name}" /><br>
c019Model.priceの値は <c:out value="${c019Model.price}" /><br>
c019Model.listPriceの値は <c:out value="${c019Model.listPrice}" /><br>
 </body>
</html>

今回はgetter（isですが）を使ってロジックを介したテストを確認します。今までのBookクラスに定価フィールド（listPrice）を追加し、価格は定価よりも安くないといけないというテストを追加します。

package com.example.spring.controller.c019;

import javax.validation.constraints.AssertTrue;
import javax.validation.constraints.NotNull;

import org.hibernate.validator.constraints.NotBlank;

public class C019Model {
    @NotBlank
    private String name;
    @NotNull
    private Integer price;
    @NotNull
    private Integer listPrice;

    @AssertTrue(message = "{valid.price}")
    public boolean isValidPrice() {
        if (price == null || listPrice == null) {
            return true;
        }
        return listPrice >= price;
    }

    // setter、getterは省略
}

isValidPrice()メソッドで、定価と価格のチェックをしています。いずれも@NotNullをつけているのでnullの場合には検証はOKとしています。

メッセージは置き換え文字列としているためvalid.priceを以下のように定義しています。

valid.price=価格は定価より安い値段にしてください。

確認用のテストケースは次のとおりです。

package com.example.spring.controller.c019;

import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
import static org.springframework.test.web.servlet.setup.MockMvcBuilders.*;

import java.util.List;
import java.util.Map;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.support.DefaultMessageSourceResolvable;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.servlet.ModelAndView;

@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration
@ContextConfiguration(locations = { "file:src/main/webapp/WEB-INF/spring/spring-context.xml" })
public class C019ControllerTest {
    @Autowired
    private WebApplicationContext wac;

    private MockMvc mockMvc;

    @Before
    public void setup() {
        mockMvc = webAppContextSetup(wac).build();
    }

    @Test
    public void bookFormへのGET() throws Exception {
        mockMvc.perform(get("/c019/bookForm")).andExpect(status().isOk())
                .andExpect(view().name("c019/bookForm"))
                .andExpect(model().hasNoErrors());
    }

    @Test
    public void bookRecvへのPOST_定価が価格より高い() throws Exception {
        mockMvc.perform(
                post("/c019/bookRecv").param("name", "よくわかるSpring")
                        .param("price", "1000").param("listPrice", "1100"))
                .andExpect(status().isOk())
                .andExpect(view().name("c019/bookRecv"))
                .andExpect(model().hasNoErrors());
    }

    @Test
    public void bookRecvへのPOST_価格が定価より高い() throws Exception {
        MvcResult mvcResult = mockMvc
                .perform(
                        post("/c019/bookRecv").param("name", "よく分かるSpring")
                                .param("price", "1000")
                                .param("listPrice", "900"))
                .andExpect(status().isOk())
                .andExpect(view().name("c019/bookForm"))
                .andExpect(model().hasErrors())
                .andExpect(model().errorCount(1))
                .andExpect(
                        model().attributeHasFieldErrors("c019Model",
                                "validPrice"))
                .andExpect(model().attributeExists("c019Model")).andReturn();

        // パラメータのチェック
        ModelAndView mav = mvcResult.getModelAndView();
        Map<String, Object> model = mav.getModel();
        Object c019ModelObject = model.get("c019Model");
        assertThat(c019ModelObject, is(notNullValue()));
        assertThat(c019ModelObject, is(instanceOf(C019Model.class)));
        C019Model c019Model = (C019Model) c019ModelObject;
        assertThat(c019Model.getName(), is("よく分かるSpring"));
        assertThat(c019Model.getPrice(), is(1000));
        assertThat(c019Model.getListPrice(), is(900));

        // エラーメッセージのチェック
        Object object = mav.getModel().get(
                "org.springframework.validation.BindingResult.c019Model");
        assertThat(object, is(not(nullValue())));
        assertThat(object, is(instanceOf(BindingResult.class)));
        BindingResult bindingResult = (BindingResult) object;

        checkField(bindingResult, "validPrice", "AssertTrue");
    }

    private void checkField(BindingResult bindingResult, String fieldName,
            String errorCode) {
        // エラーのあるフィールドの取得
        List<FieldError> list = bindingResult.getFieldErrors(fieldName);
        assertThat(list, is(not(nullValue())));
        assertThat(list.size(), is(1));

        // 詳細なエラーチェック
        FieldError fieldError = list.get(0);
        assertThat(fieldError.getCode(), is(errorCode));

        // エラーメッセージのパラメータ
        Object[] args = fieldError.getArguments();
        assertThat(args.length, is(1));
        assertThat(args[0],
                is(instanceOf(DefaultMessageSourceResolvable.class)));
        DefaultMessageSourceResolvable dmr = (DefaultMessageSourceResolvable) args[0];
        assertThat(dmr.getCode(), is(fieldName));
    }
}

ソースは https://github.com/kuwalab/spring-mvc41 にあります。タグ019が今回のサンプルです。

まとめ http://kuwalab.hatenablog.jp/entry/spring
最初 http://kuwalab.hatenablog.jp/entry/spring_mvc41/001
前回 http://kuwalab.hatenablog.jp/entry/spring_mvc41/018
次回 http://kuwalab.hatenablog.jp/entry/spring_mvc41/020

コンピュータクワガタ

かっぱのかっぱによるコンピュータ関連のサイトです

Spring MVC 4.1 No. 019 Validatorでロジックを介した検証