2014-12-16

Spring MVC 4.1 No. 021 submitボタンによって分岐する

Spring Java

formの中にsubmitボタンが複数ある場合に、どのボタンが押されたかはリクエストに含まれるパラメータでわかります。具体的にはbutton1というname属性のボタンを押した時には、button1パラメータが送信されます。それを利用して、同じURLに対してパラメータの有無によって分岐することができます。

@RequestMappingのparams属性で、任意のパラメータが送信されている場合にそのメソッドが使用されます。

package com.example.spring.controller.c021;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
public class C021Controller {
    @RequestMapping("/c021/branchForm")
    public String branchForm() {
        return "c021/branchForm";
    }

    @RequestMapping(value = "/c021/branchRecv", params = "branch1", method = RequestMethod.POST)
    public String branch1() {
        return "c021/branch1";
    }

    @RequestMapping(value = "/c021/branchRecv", params = "branch2", method = RequestMethod.POST)
    public String branch2() {
        return "c021/branch2";
    }

    @RequestMapping(value = "/c021/branchRecv", params = "branch3", method = RequestMethod.POST)
    public String branch3() {
        return "c021/branch3";
    }

    @RequestMapping(value = "/c021/branchRecv", params = "branch4", method = RequestMethod.POST)
    public String branch4() {
        return "c021/branch4";
    }
}

submitが送信されるボタンを4つ用意して、それぞれname属性をbranch1〜branch4にしています。

<%@page contentType="text/html; charset=utf-8" %><%--
--%><!DOCTYPE html>
<html>
 <head>
  <meta charset="utf-8">
  <title>サンプル</title>
 </head>
 <body>
  <form action="branchRecv" method="post">
   <input type="submit" name="branch1" value="送信1">
   <input type="submit" name="branch2" value="送信2">
   <button name="branch3">送信3</button>
   <button name="branch4">送信4</button>
  </form>
 </body>
</html>

branch1〜4は中の確認用の文字列が異なるだけなので、branch1.jspだけ確認します。

<%@page contentType="text/html; charset=utf-8" %><%--
--%><!DOCTYPE html>
<html>
 <head>
  <meta charset="utf-8">
  <title>サンプル</title>
 </head>
 <body>
branch1
 </body>
</html>

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

package com.example.spring.controller.c021;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
public class C021Controller {
    @RequestMapping("/c021/branchForm")
    public String branchForm() {
        return "c021/branchForm";
    }

    @RequestMapping(value = "/c021/branchRecv", params = "branch1", method = RequestMethod.POST)
    public String branch1() {
        return "c021/branch1";
    }

    @RequestMapping(value = "/c021/branchRecv", params = "branch2", method = RequestMethod.POST)
    public String branch2() {
        return "c021/branch2";
    }

    @RequestMapping(value = "/c021/branchRecv", params = "branch3", method = RequestMethod.POST)
    public String branch3() {
        return "c021/branch3";
    }

    @RequestMapping(value = "/c021/branchRecv", params = "branch4", method = RequestMethod.POST)
    public String branch4() {
        return "c021/branch4";
    }
}

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

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

2014-12-15

Spring MVC 4.1 No. 020 Validatorのエラーの際に入力値を再表示させる

Spring Java

前回のソースを少し変更して、フォームの値の再表示をします。

まずはControllerです。

package com.example.spring.controller.c020;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
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("/c020")
public class C020Controller {
    @RequestMapping("/bookForm")
    public String bookForm(Model model) {
        model.addAttribute("c020Model", new C020Model());
        return "c020/bookForm";
    }

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

<form:input>タグを使ってpathにエラーメッセージと同じようにモデル名.フィールド名を指定することで、リクエストから自動的に値が割り当てられます。

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

bookRecv.jspとC020Modelは同様のため省略します。

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

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

2014-12-15

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

Spring Java

今回は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

2014-12-14

Spring MVC 4.1 No. 018 ValidatorでNotBlankのチェック

Spring Java

今回はBean ValidationのNotBlankです。

Bean Validationの標準ではなく、Hibernateの実装に含んでいるValidatorになります。これを使うと文字列の空文字のチェックができます。

最初にこれまでと同様の、ControllerとJSPを作成します。ControllerとJSPは先の例と同様のため、説明は省略します。

package com.example.spring.controller.c018;

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("/c018")
public class C018Controller {
    @RequestMapping("/bookForm")
    public String bookForm() {
        return "c018/bookForm";
    }

    @RequestMapping(value = "/bookRecv", method = RequestMethod.POST)
    public String bookRecv(@Validated @ModelAttribute C018Model c018Model,
            BindingResult errors) {
        if (errors.hasErrors()) {
            return "c018/bookForm";
        }
        return "c018/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="c018Model.name" /><br>
   価格: <input type="text" name="price" size="20"><form:errors path="c018Model.price" /><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>
c018Model.nameの値は <c:out value="${c018Model.name}" /><br>
c018Model.priceの値は <c:out value="${c018Model.price}" /><br>
 </body>
</html>

C018ModelのnameフィールドにValidationを設定します。

package com.example.spring.controller.c018;

import javax.validation.constraints.NotNull;

import org.hibernate.validator.constraints.NotBlank;

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

    // setter、getterは省略
}

メッセージは以下のようにします。

org.hibernate.validator.constraints.NotBlank.message = 入力は必須です

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

package com.example.spring.controller.c018;

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 C018ControllerTest {
    @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("/c018/bookForm")).andExpect(status().isOk())
                .andExpect(view().name("c018/bookForm"))
                .andExpect(model().hasNoErrors());
    }

    @Test
    public void bookRecvへのPOST_nameがblankでない() throws Exception {
        mockMvc.perform(
                post("/c018/bookRecv").param("name", "よくわかるSpring").param(
                        "price", "1000")).andExpect(status().isOk())
                .andExpect(view().name("c018/bookRecv"))
                .andExpect(model().hasNoErrors());
    }

    @Test
    public void bookRecvへのPOST_nameがblank() throws Exception {
        MvcResult mvcResult = mockMvc
                .perform(post("/c018/bookRecv").param("price", "1000"))
                .andExpect(status().isOk())
                .andExpect(view().name("c018/bookForm"))
                .andExpect(model().hasErrors())
                .andExpect(model().errorCount(1))
                .andExpect(model().attributeHasFieldErrors("c018Model", "name"))
                .andExpect(model().attributeExists("c018Model")).andReturn();

        // パラメータのチェック
        ModelAndView mav = mvcResult.getModelAndView();
        Map<String, Object> model = mav.getModel();
        Object c018ModelObject = model.get("c018Model");
        assertThat(c018ModelObject, is(notNullValue()));
        assertThat(c018ModelObject, is(instanceOf(C018Model.class)));
        C018Model c018Model = (C018Model) c018ModelObject;
        assertThat(c018Model.getName(), is(nullValue()));

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

        checkField(bindingResult, "name", "NotBlank");
    }

    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 にあります。タグ018が今回のサンプルです。

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

2014-12-14

Spring MVC 4.1 No. 017 Validatorで正規表現でのチェック

Spring Java

今回はBean Validationの正規表現です。

正規表現なので、色々なパターンのチェックができますが、今回は「ISBN + 数字10桁」のチェックをします。

最初にこれまでと同様の、ControllerとJSPを作成します。ContollerとJSPは先の例と同様のため、説明は省略します。

package com.example.spring.controller.c017;

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("/c017")
public class C017Controller {
    @RequestMapping("/bookForm")
    public String bookForm() {
        return "c017/bookForm";
    }

    @RequestMapping(value = "/bookRecv", method = RequestMethod.POST)
    public String bookRecv(@Validated @ModelAttribute C017Model c017Model,
            BindingResult errors) {
        if (errors.hasErrors()) {
            return "c017/bookForm";
        }
        return "c017/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="c017Model.name" /><br>
   価格: <input type="text" name="price" size="20"><form:errors path="c017Model.price" /><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>
c017Model.nameの値は <c:out value="${c017Model.name}" /><br>
c017Model.priceの値は <c:out value="${c017Model.price}" /><br>
 </body>
</html>

C017ModelのnameフィールドにValidationを設定します。

package com.example.spring.controller.c017;

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;

public class C017Model {
    @NotNull
    @Pattern(regexp = "ISBN[0-9]{10}", message = "{0}はISBNを入力してください")
    private String name;
    private Integer price;

    // setter、getterは省略
}

メッセージのデフォルトは、regexp属性の値を表示しますが、ユーザーにはやさしくないため、@Patternのmessage属性で直接指定しています。

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

package com.example.spring.controller.c017;

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.Map;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
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.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 C017ControllerTest {
    @Autowired
    private WebApplicationContext wac;

    private MockMvc mockMvc;

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

    @Test
    public void bookRecvへのPOST_nameがISBN1234567890() throws Exception {
        MvcResult mvcResult = mockMvc
                .perform(
                        post("/c017/bookRecv").param("name", "ISBN1234567890")
                                .param("price", "123"))
                .andExpect(status().isOk())
                .andExpect(view().name("c017/bookRecv"))
                .andExpect(model().hasNoErrors())
                .andExpect(model().errorCount(0))
                .andExpect(model().attributeExists("c017Model")).andReturn();

        // パラメータのチェック
        ModelAndView mav = mvcResult.getModelAndView();
        Map<String, Object> model = mav.getModel();
        Object c017ModelObject = model.get("c017Model");
        assertThat(c017ModelObject, is(notNullValue()));
        assertThat(c017ModelObject, is(instanceOf(C017Model.class)));
        C017Model c017Model = (C017Model) c017ModelObject;
        assertThat(c017Model.getName(), is("ISBN1234567890"));
        assertThat(c017Model.getPrice(), is(123));
    }

    @Test
    public void bookRecvへのPOST_nameがISBN123456789() throws Exception {
        MvcResult mvcResult = mockMvc
                .perform(
                        post("/c017/bookRecv").param("name", "ISBN123456789")
                                .param("price", "123"))
                .andExpect(status().isOk())
                .andExpect(view().name("c017/bookForm"))
                .andExpect(model().hasErrors())
                .andExpect(model().errorCount(1))
                .andExpect(model().attributeHasFieldErrors("c017Model", "name"))
                .andExpect(model().attributeExists("c017Model")).andReturn();

        // パラメータのチェック
        ModelAndView mav = mvcResult.getModelAndView();
        Map<String, Object> model = mav.getModel();
        Object c017ModelObject = model.get("c017Model");
        assertThat(c017ModelObject, is(notNullValue()));
        assertThat(c017ModelObject, is(instanceOf(C017Model.class)));
        C017Model c017Model = (C017Model) c017ModelObject;
        assertThat(c017Model.getName(), is("ISBN123456789"));
        assertThat(c017Model.getPrice(), is(123));
    }
}

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

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

2014-12-13

Spring MVC 4.1 No. 016 ValidatorでSizeのチェック

Spring Java

今回はBean ValidationのSizeです。

Sizeは文字列の長さの検査や、Collectionの長さの検査ができます。今回は文字列の長さの例を見ていきます。

最初にこれまでと同様の、ControllerとJSPを作成します。ControllerとJSPは先の例と同様のため、説明は省略します。

package com.example.spring.controller.c016;

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("/c016")
public class C016Controller {
    @RequestMapping("/bookForm")
    public String bookForm() {
        return "c016/bookForm";
    }

    @RequestMapping(value = "/bookRecv", method = RequestMethod.POST)
    public String bookRecv(@Validated @ModelAttribute C016Model c016Model,
            BindingResult errors) {
        if (errors.hasErrors()) {
            return "c016/bookForm";
        }
        return "c016/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="c016Model.name" /><br>
   価格: <input type="text" name="price" size="20"><form:errors path="c016Model.price" /><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>
c016Model.nameの値は <c:out value="${c016Model.name}" /><br>
c016Model.priceの値は <c:out value="${c016Model.price}" /><br>
 </body>
</html>

C016ModelのnameフィールドにValidationを設定します。以下の例だと10文字の入力だけが許可されます。

package com.example.spring.controller.c016;

import javax.validation.constraints.Max;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

public class C016Model {
    @NotNull
    @Size(min = 10, max = 10)
    private String name;
    @Max(100000)
    private Integer price;

    // setter、getterは省略
}

メッセージは以下のように記述します。

javax.validation.constraints.Size.message = ${min == max ? min += '文字で入力してください' : min += '〜' += max += '文字で入力してください'}

メッセージはELで分岐し、最大最小文字が同じ場合と、それ以外で変更しています。

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

package com.example.spring.controller.c016;

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 C016ControllerTest {
    @Autowired
    private WebApplicationContext wac;

    private MockMvc mockMvc;

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

    @Test
    public void bookRecvへのPOST_nameが10文字() throws Exception {
        MvcResult mvcResult = mockMvc
                .perform(
                        post("/c016/bookRecv").param("name", "1234567890")
                                .param("price", "123"))
                .andExpect(status().isOk())
                .andExpect(view().name("c016/bookRecv"))
                .andExpect(model().hasNoErrors())
                .andExpect(model().errorCount(0))
                .andExpect(model().attributeExists("c016Model")).andReturn();

        // パラメータのチェック
        ModelAndView mav = mvcResult.getModelAndView();
        Map<String, Object> model = mav.getModel();
        Object c016ModelObject = model.get("c016Model");
        assertThat(c016ModelObject, is(notNullValue()));
        assertThat(c016ModelObject, is(instanceOf(C016Model.class)));
        C016Model c016Model = (C016Model) c016ModelObject;
        assertThat(c016Model.getName(), is("1234567890"));
        assertThat(c016Model.getPrice(), is(123));
    }

    @Test
    public void bookRecvへのPOST_nameが9文字() throws Exception {
        MvcResult mvcResult = mockMvc
                .perform(
                        post("/c016/bookRecv").param("name", "123456789")
                                .param("price", "123"))
                .andExpect(status().isOk())
                .andExpect(view().name("c016/bookForm"))
                .andExpect(model().hasErrors())
                .andExpect(model().errorCount(1))
                .andExpect(model().attributeHasFieldErrors("c016Model", "name"))
                .andExpect(model().attributeExists("c016Model")).andReturn();

        // パラメータのチェック
        ModelAndView mav = mvcResult.getModelAndView();
        Map<String, Object> model = mav.getModel();
        Object c016ModelObject = model.get("c016Model");
        assertThat(c016ModelObject, is(notNullValue()));
        assertThat(c016ModelObject, is(instanceOf(C016Model.class)));
        C016Model c016Model = (C016Model) c016ModelObject;
        assertThat(c016Model.getName(), is("123456789"));
        assertThat(c016Model.getPrice(), is(123));

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

        checkSizeField(bindingResult, "name", 10, 10);
    }

    @Test
    public void bookRecvへのPOST_nameが11文字() throws Exception {
        MvcResult mvcResult = mockMvc
                .perform(
                        post("/c016/bookRecv").param("name", "12345678901")
                                .param("price", "123"))
                .andExpect(status().isOk())
                .andExpect(view().name("c016/bookForm"))
                .andExpect(model().hasErrors())
                .andExpect(model().errorCount(1))
                .andExpect(model().attributeHasFieldErrors("c016Model", "name"))
                .andExpect(model().attributeExists("c016Model")).andReturn();

        // パラメータのチェック
        ModelAndView mav = mvcResult.getModelAndView();
        Map<String, Object> model = mav.getModel();
        Object c016ModelObject = model.get("c016Model");
        assertThat(c016ModelObject, is(notNullValue()));
        assertThat(c016ModelObject, is(instanceOf(C016Model.class)));
        C016Model c016Model = (C016Model) c016ModelObject;
        assertThat(c016Model.getName(), is("12345678901"));
        assertThat(c016Model.getPrice(), is(123));

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

        checkSizeField(bindingResult, "name", 10, 10);
    }

    private void checkSizeField(BindingResult bindingResult, String fieldName,
            Integer min, Integer max) {
        // エラーのあるフィールドの取得
        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("Size"));

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

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

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

2014-12-13

Spring MVC 4.1 No. 015 ValidatorでDigitsのチェック

Spring Java

今回はBean ValidationのDigitsです。

Digitsは数値の具体的な最小、最大値ではなく、整数部の最大桁数、小数部の最大桁数を指定します。桁数以内であれば、小さくても大丈夫です。

最初にControllerとJSPを作成します。これまでと同様になります。

package com.example.spring.controller.c015;

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("/c015")
public class C015Controller {
    @RequestMapping("/bookForm")
    public String bookForm() {
        return "c015/bookForm";
    }

    @RequestMapping(value = "/bookRecv", method = RequestMethod.POST)
    public String bookRecv(@Validated @ModelAttribute C015Model c015Model,
            BindingResult errors) {
        if (errors.hasErrors()) {
            return "c015/bookForm";
        }
        return "c015/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="c015Model.name" /><br>
   価格: <input type="text" name="price" size="20"><form:errors path="c015Model.price" /><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>
c015Model.nameの値は <c:out value="${c015Model.name}" /><br>
c015Model.priceの値は <c:out value="${c015Model.price}" /><br>
 </body>
</html>

C015ModelのpriceフィールドにValidationを設定します。整数部3桁、小数部2桁とします。また、小数部があるため、Double型にしています。

package com.example.spring.controller.c015;

import javax.validation.constraints.Digits;
import javax.validation.constraints.NotNull;

public class C015Model {
    @NotNull
    private String name;
    @NotNull
    @Digits(integer = 3, fraction = 2)
    private Double price;

    // setter、getterは省略
}

メッセージは以下のように記述します。

javax.validation.constraints.Digits.message = {0}は整数{integer}桁、小数{fraction}桁以内で入力してください

テストにはcloseToメソッドを使用するため、pom.xmlに次の依存関係を追加します。

<dependency>
 <groupId>org.hamcrest</groupId>
 <artifactId>hamcrest-library</artifactId>
 <version>1.3</version>
</dependency>

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

package com.example.spring.controller.c015;

import static org.hamcrest.Matchers.*;
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 C015ControllerTest {
    @Autowired
    private WebApplicationContext wac;

    private MockMvc mockMvc;

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

    @Test
    public void bookRecvへのPOST_priceが123_45() throws Exception {
        MvcResult mvcResult = mockMvc
                .perform(
                        post("/c015/bookRecv").param("name", "よく分かるSpring")
                                .param("price", "123.45"))
                .andExpect(status().isOk())
                .andExpect(view().name("c015/bookRecv"))
                .andExpect(model().hasNoErrors())
                .andExpect(model().errorCount(0))
                .andExpect(model().attributeExists("c015Model")).andReturn();

        // パラメータのチェック
        ModelAndView mav = mvcResult.getModelAndView();
        Map<String, Object> model = mav.getModel();
        Object c015ModelObject = model.get("c015Model");
        assertThat(c015ModelObject, is(notNullValue()));
        assertThat(c015ModelObject, is(instanceOf(C015Model.class)));
        C015Model c015Model = (C015Model) c015ModelObject;
        assertThat(c015Model.getName(), is("よく分かるSpring"));
        assertThat(c015Model.getPrice(), is(123.45));
    }

    @Test
    public void bookRecvへのPOST_priceが1234() throws Exception {
        MvcResult mvcResult = mockMvc
                .perform(
                        post("/c015/bookRecv").param("name", "よく分かるSpring")
                                .param("price", "1234"))
                .andExpect(status().isOk())
                .andExpect(view().name("c015/bookForm"))
                .andExpect(model().hasErrors())
                .andExpect(model().errorCount(1))
                .andExpect(
                        model().attributeHasFieldErrors("c015Model", "price"))
                .andExpect(model().attributeExists("c015Model")).andReturn();

        // パラメータのチェック
        ModelAndView mav = mvcResult.getModelAndView();
        Map<String, Object> model = mav.getModel();
        Object c015ModelObject = model.get("c015Model");
        assertThat(c015ModelObject, is(notNullValue()));
        assertThat(c015ModelObject, is(instanceOf(C015Model.class)));
        C015Model c015Model = (C015Model) c015ModelObject;
        assertThat(c015Model.getName(), is("よく分かるSpring"));
        assertThat(c015Model.getPrice(), is(closeTo(1234, 0.001)));

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

        checkDigitsField(bindingResult, "price", 3, 2);
    }

    @Test
    public void bookRecvへのPOST_priceが1_234() throws Exception {
        MvcResult mvcResult = mockMvc
                .perform(
                        post("/c015/bookRecv").param("name", "よく分かるSpring")
                                .param("price", "1.234"))
                .andExpect(status().isOk())
                .andExpect(view().name("c015/bookForm"))
                .andExpect(model().hasErrors())
                .andExpect(model().errorCount(1))
                .andExpect(
                        model().attributeHasFieldErrors("c015Model", "price"))
                .andExpect(model().attributeExists("c015Model")).andReturn();

        // パラメータのチェック
        ModelAndView mav = mvcResult.getModelAndView();
        Map<String, Object> model = mav.getModel();
        Object c015ModelObject = model.get("c015Model");
        assertThat(c015ModelObject, is(notNullValue()));
        assertThat(c015ModelObject, is(instanceOf(C015Model.class)));
        C015Model c015Model = (C015Model) c015ModelObject;
        assertThat(c015Model.getName(), is("よく分かるSpring"));
        assertThat(c015Model.getPrice(), is(closeTo(1.234, 0.001)));

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

        checkDigitsField(bindingResult, "price", 3, 2);
    }

    private void checkDigitsField(BindingResult bindingResult,
            String fieldName, Integer integer, Integer fraction) {
        // エラーのあるフィールドの取得
        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("Digits"));

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

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

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

コンピュータクワガタ

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

Spring MVC 4.1 No. 021 submitボタンによって分岐する

Spring MVC 4.1 No. 020 Validatorのエラーの際に入力値を再表示させる

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

Spring MVC 4.1 No. 018 ValidatorでNotBlankのチェック

Spring MVC 4.1 No. 017 Validatorで正規表現でのチェック

Spring MVC 4.1 No. 016 ValidatorでSizeのチェック

Spring MVC 4.1 No. 015 ValidatorでDigitsのチェック