Glassfish Jersey MVC Validation

2023-09-252023
73.3% (267.8/365)
September
82.9% (24.8/30)
Week 39
12.6% (0.8/7)
Day 25 Mon
88.7% (21.2/24)

訪問者

total: 9398
today: 4
yesterday: 1
now: 10

↑

更新

MenuBar

はじめに
環境設定
JAX-RS Resource
エラーページ
実行結果
検証エラーを共通化したければ ExceptionMapper を使う

はじめに †

Jersey MVC は、Bean Validation と組み合わせることができる
Bean Validation については前に調べた

↑

環境設定 †

pom.xml に jersey-mvc-bean-validation への依存を定義

<!-- Jersey MVC Bean Validator -->
<dependency>
  <groupId>org.glassfish.jersey.ext</groupId>
  <artifactId>jersey-mvc-bean-validation</artifactId>
  <version>${jersey-mvc}</version>
</dependency>

ApplicationConfig? で、MvcBeanValidationFeature? を登録

https://github.com/kagyuu/JerseyMVCExam/blob/master/src/main/java/com/mycompany/jerseymvcexam/ApplicationConfig.java

package com.mycompany.jerseymvcexam;

import org.glassfish.jersey.server.ResourceConfig;
import org.glassfish.jersey.server.mvc.beanvalidation.MvcBeanValidationFeature;
import org.glassfish.jersey.server.mvc.mustache.MustacheMvcFeature;

@javax.ws.rs.ApplicationPath("webresources")
public class ApplicationConfig extends ResourceConfig {
    
    public ApplicationConfig() {
        this
        .packages(ApplicationConfig.class.getPackage().getName())
        .register(MvcBeanValidationFeature.class)
        //.property(MustacheMvcFeature.TEMPLATE_BASE_PATH, "/Users/atsushi/templates")
        //.property(MustacheMvcFeature.ENCODING, "UTF-8")
        .register(MustacheMvcFeature.class);
    }    
}

↑

JAX-RS Resource †

https://github.com/kagyuu/JerseyMVCExam/blob/master/src/main/java/com/mycompany/jerseymvcexam/BoardResource2.java

package com.mycompany.jerseymvcexam;

import javax.ejb.EJB;
import javax.validation.Valid;
import javax.ws.rs.BeanParam;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import org.glassfish.jersey.server.mvc.ErrorTemplate;
import org.glassfish.jersey.server.mvc.Template;

@Path("board2")
public class BoardResource2 {
    
    @EJB
    private BoardEJB board;

    @GET
    @Path("init")
    @Produces(MediaType.TEXT_HTML)
    @Template(name = "/board")
    public BoardBean init() {
        
        BoardBean res = new BoardBean();
        res.setName("");
        res.setComment("");
        res.setArticles(board.getCurrentMessage());
        return res;
    }

    @POST
    @Path("submit")
    @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
    @Produces(MediaType.TEXT_HTML)
    @Template(name = "/board")
    @ErrorTemplate(name = "/board_error")
    public BoardBean submitMessage(@Valid @BeanParam ContributeBean contribute) {
        
        String name = contribute.getName();
        String comment = contribute.getComment();
        
        board.addMessage(name, comment);
        
        BoardBean res = new BoardBean();
        res.setName(name);
        res.setComment(comment);
        res.setArticles(board.getCurrentMessage());
        return res;
    }
}

https://github.com/kagyuu/JerseyMVCExam/blob/master/src/main/java/com/mycompany/jerseymvcexam/ContributeBean.java

package com.mycompany.jerseymvcexam;

import javax.validation.constraints.Size;
import javax.ws.rs.FormParam;
import lombok.Data;

@Data
public class ContributeBean {
    
    @FormParam("name")
    @Size(min = 1, max = 255)
    private String name;
    
    @FormParam("comment")
    @Size(min = 1, max = 255)
    private String comment;
}

検証エラーページは、@ErrorTemplate? アノテーションで指定する
```
@ErrorTemplate(name = "/board_error")
```

引数に Bean Validate を指定する

public BoardBean submitMessage(@Valid @BeanParam ContributeBean contribute)

引数は Bean でなくても良いけど、

public BoardBean submitMessage(
   @FormParam("name")
   @Size(min = 1, max = 255)
   String name,
   @FormParam("comment")
   @Size(min = 1, max = 255)
   String comment ) {

とか、さすがに嫌だろう。それに、検証エラー箇所がわかりにくくなる(後述)

↑

エラーページ †

https://github.com/kagyuu/JerseyMVCExam/blob/master/src/main/webapp/board_error.mustache

<!DOCTYPE html output>
<html>
<head>
    <title>Board</title>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <style>
    ul.error { list-style-type: square; color: red }
    </style>
</head>
<body>
    <ul class="error">
    {{#.}}
    <li>
        CLASS: {{.}} <br> 
        PATH: {{path}} <br>
        MESSAGE: {{message}} <br>
        INVALID VALUE: "{{invalidValue}}"
    </li>
    {{/.}}
    </ul>    
    <form method="POST" action="submit">
        名前 : <input type="text" name="name" value="{{name}}"/>
        コメント : <input type="text" name="comment" size="80"/>
        <input type="submit"/>
    </form>
</body>
</html>

エラー時には、org.glassfish.jersey.server.validation.ValidationError? の配列が渡される
- https://jersey.java.net/apidocs/2.9/jersey/org/glassfish/jersey/server/validation/ValidationError.html
エラー箇所は PATH で渡されて、arg0.フィールド名となる
- BoardResource2.submitMessage.arg0.comment
- BoardResource2.submitMessage.arg0.name
もし JAX-RS 側が
```
public BoardBean submitMessage(
   @FormParam("name")
   @Size(min = 1, max = 255)
   String name,
   @FormParam("comment")
   @Size(min = 1, max = 255)
   String comment ) {
```
となっていたら、PATH がわかりにくくなる (原因箇所が JAX-RS 側の第何引数かしかわからない) ので、引数は Bean にまとめた方がいい。PATH は次のようになる
- BoardResource2.submitMessage.arg0 (投稿者欄 name)
- BoardResource2.submitMessage.arg1 (コメント欄 comment)

↑

実行結果 †

投稿者欄、コメント欄を空白のまま [送信] ボタンを押すと、Bean Validation の検証エラーが表示される

↑

検証エラーを共通化したければ ExceptionMapper? を使う †

@Provider
@Priority(Priorities.USER)
public class ConstraintViolationExceptionMapper implements ExceptionMapper<ConstraintViolationException> {
  @Override
  public Response toResponse(final ConstraintViolationException exception) {
    return Response.status(Status.BAD_REQUEST)
             .entity(new Viewable("/error", exception))
             .build();
  }
}

https://docs.oracle.com/javaee/6/api/javax/validation/ConstraintViolationException.html
Viewable は @Template の実装。(実は、@Template を指定すると、new Viewable("{テンプレート}, 返り値Bean) が実行されていた)
ApplicationConfing? への登録が必要

Java#Glassfish

}}