SpringBootとJSFを使用したコントローラー、サービス、DAOの例

投稿日: 2019-10-18 2022-10-16
タグ: Jakarta EE, JSF, Spring

1. 序章

JavaServer Facesは、サーバー側のコンポーネントベースのユーザーインターフェイスフレームワークです。もともとは、JakartaEEの一部として開発されました。このチュートリアルでは、JSFをSpring Bootアプリケーションに統合する方法を調査します。

例として、TO-DOリストを作成するための簡単なアプリケーションを実装します。

2. Mavenの依存関係

JSFテクノロジーを使用するには、pom.xmlを拡張する必要があります。

<dependency>
    <groupId>org.apache.tomcat.embed</groupId>
    <artifactId>tomcat-embed-jasper</artifactId>
</dependency>
<!--JSF-->
<dependency>
    <groupId>org.glassfish</groupId>
    <artifactId>javax.faces</artifactId>
    <version>2.3.7</version>
</dependency>

javax.faces アーティファクトには、JSFAPIと実装も含まれています。詳細については、こちらをご覧ください。

3. JSFサーブレットの設定

JSFフレームワークは、XHTMLファイルを使用して、ユーザーインターフェイスのコンテンツと構造を記述します。サーバー側は、XHTML記述からJSFファイルを生成します。

src / main /webappディレクトリのindex.xhtmlファイルに静的構造を作成することから始めましょう。

<f:view xmlns="http://www.w3c.org/1999/xhtml"
  xmlns:f="http://java.sun.com/jsf/core"
  xmlns:h="http://java.sun.com/jsf/html">
    <h:head>
        <meta charset="utf-8"/>
        <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"/>
        <title>TO-DO application</title>
    </h:head>
    <h:body>
        <div>
            <p>Welcome in the TO-DO application!</p>
            <p style="height:50px">
                This is a static message rendered from xhtml.
            </p>
        </div>
    </h:body>
</f:view>

コンテンツはで利用可能になります /index.jsf 。ただし、この段階でコンテンツにアクセスしようとすると、クライアント側でエラーメッセージが表示されます。

There was an unexpected error (type=Not Found, status=404).
No message available

バックエンドエラーメッセージは表示されません。それでも、リクエストを処理するためのJSFサーブレットと、リクエストをハンドラーと一致させるためのサーブレットマッピングが必要であることがわかります。

Spring Bootを使用しているため、アプリケーションクラスを簡単に拡張して、必要な構成を処理できます。

@SpringBootApplication
public class JsfApplication extends SpringBootServletInitializer {

    public static void main(String[] args) {
        SpringApplication.run(JsfApplication.class, args);
    }

    @Bean
    public ServletRegistrationBean servletRegistrationBean() {
        FacesServlet servlet = new FacesServlet();
        ServletRegistrationBean servletRegistrationBean = 
          new ServletRegistrationBean(servlet, "*.jsf");
        return servletRegistrationBean;
    }
}

これは素晴らしく、かなり合理的に見えますが、残念ながらまだ十分ではありません。開こうとすると /index.jsf ここで、別のエラーが発生します。

java.lang.IllegalStateException: Could not find backup for factory javax.faces.context.FacesContextFactory.

残念ながら、Java構成の横にweb.xmlが必要です。 src / webapp /WEB-INFで作成しましょう。

<servlet>
    <servlet-name>Faces Servlet</servlet-name>
    <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>Faces Servlet</servlet-name>
    <url-pattern>*.jsf</url-pattern>
</servlet-mapping>

これで、構成の準備が整いました。開ける /index.jsf ：

Welcome in the TO-DO application!

This is a static message rendered from xhtml.

ユーザーインターフェイスを作成する前に、アプリケーションのバックエンドを作成しましょう。

4. DAOパターンの実装

DAOはデータアクセスオブジェクトの略です。通常、DAOクラスは2つの概念を担当します。永続層の詳細をカプセル化し、単一のエンティティにCRUDインターフェイスを提供します。詳細な説明は、thisチュートリアルにあります。

DAOパターンを実装するために、最初に汎用インターフェースを定義します。

public interface Dao<T> {

    Optional<T> get(int id);
    Collection<T> getAll();
    int save(T t);
    void update(T t);
    void delete(T t);
}

それでは、このToDoアプリケーションで最初で唯一のドメインクラスを作成しましょう。

public class Todo {

    private int id;
    private String message;
    private int priority;

    // standard getters and setters

}

次のクラスは、ダオ。このパターンの美しさは、いつでもこのインターフェイスの新しい実装を提供できることです。

したがって、コードの残りの部分に触れることなく、永続性レイヤーを変更できます。

この例では、メモリ内ストレージクラスを使用します。

@Component
public class TodoDao implements Dao<Todo> {

    private List<Todo> todoList = new ArrayList<>();
    
    @Override
    public Optional<Todo> get(int id) {
        return Optional.ofNullable(todoList.get(id));
    }

    @Override
    public Collection<Todo> getAll() {
        return todoList.stream()
          .filter(Objects::nonNull)
          .collect(Collectors.collectingAndThen(Collectors.toList(), Collections::unmodifiableList));
    }

    @Override
    public int save(Todo todo) {
        todoList.add(todo);
        int index = todoList.size() - 1;
        todo.setId(index);
        return index;
    }

    @Override
    public void update(Todo todo) {
        todoList.set(todo.getId(), todo);
    }

    @Override
    public void delete(Todo todo) {
        todoList.set(todo.getId(), null);
    }
}

5. サービスレイヤー

DAOレイヤーの主な目標は、永続性メカニズムの詳細を処理することです。サービスレイヤーはその上にあり、ビジネス要件を処理します。

DAOインターフェイスがサービスから参照されることに注意してください。

@Scope(value = "session")
@Component(value = "todoService")
public class TodoService {

    @Autowired
    private Dao<Todo> todoDao;
    private Todo todo = new Todo();

    public void save() {
        todoDao.save(todo);
        todo = new Todo();
    }

    public Collection<Todo> getAllTodo() {
        return todoDao.getAll();
    }

    public int saveTodo(Todo todo) {
        validate(todo);
        return todoDao.save(todo);
    }

    private void validate(Todo todo) {
        // Details omitted
    }

    public Todo getTodo() {
        return todo;
    }
}

ここで、サービスは名前付きコンポーネントです。この名前を使用して、JSFコンテキストからBeanを参照します。

また、このクラスには、この単純なアプリケーションで満足できるセッションスコープがあります。

Springスコープの詳細については、thisチュートリアルを参照してください。 Springの組み込みスコープはJSFとはモデルが異なるため、カスタムスコープの定義を検討する価値があります。

これに関する詳細なガイダンスは、thisチュートリアルで入手できます。

6. コントローラー

JSPアプリケーションの場合と同様に、コントローラーは異なるビュー間のナビゲーションを処理します。

次に、ミニマルなコントローラーを実装します。オープニングページからやることリストページに移動します。

@Scope(value = "session")
@Component(value = "jsfController")
public class JsfController {

    public String loadTodoPage() {
        checkPermission();
        return "/todo.xhtml";
    }

    private void checkPermission() {
        // Details omitted
    }
}

ナビゲーションは返された名前に基づいています。したがって、 loadTodoPage は、次に実装するtodo.xhtmlページに移動します。

7. JSFとSpringBeansの接続

JSFコンテキストからコンポーネントを参照する方法を見てみましょう。まず、index.xthmlを拡張します。

<f:view 
  xmlns="http://www.w3c.org/1999/xhtml"
  xmlns:f="http://java.sun.com/jsf/core"
  xmlns:h="http://java.sun.com/jsf/html">
    <h:head>
       // same code as before
    </h:head>
    <h:body>
        <div>
           // same code as before
           <h:form>
             <h:commandButton value="Load To-do page!" action="#{jsfController.loadTodoPage}" />
           </h:form>
        </div>
    </h:body>
</f:view>

ここでは、フォーム要素内にcommandButtonを導入しました。すべてのUICommand要素（例： commandButton） UIForm要素内に配置する必要があります（例：形）。

この段階で、アプリケーションを開始して調べることができます /index.jsf ：

残念ながら、ボタンをクリックするとエラーが発生します。

There was an unexpected error (type=Internal Server Error, status=500).
javax.el.PropertyNotFoundException:
/index.xhtml @11,104 action="#{jsfController.loadTodoPage}":
Target Unreachable, identifier [jsfController] resolved to null

メッセージには、問題が明確に示されています。 jsfControllerはnullに解決されました。対応するコンポーネントが作成されていないか、少なくともJSFコンテキストからは見えません。

この状況では、後者が当てはまります。

Springコンテキストをwebapp/ WEB-INF /faces-config.xml内のJSFコンテキストに接続する必要があります。

<?xml version="1.0" encoding="UTF-8"?>
<faces-config xmlns="http://xmlns.jcp.org/xml/ns/javaee"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee/web-facesconfig_2_2.xsd"
  version="2.2">
    <application>
        <el-resolver>org.springframework.web.jsf.el.SpringBeanFacesELResolver</el-resolver>
    </application>
</faces-config>

コントローラが機能する準備ができたので、 todo.xhtml が必要になります！

8. JSFのサービスとのやり取り

todo.xhtmlページには2つの目的があります。まず、すべてのToDo要素が表示されます。

次に、リストに新しい要素を追加する機会を提供します。

そのため、UIコンポーネントは、以前に宣言されたサービスと直接対話します。

<f:view xmlns="http://www.w3c.org/1999/xhtml"
  xmlns:f="http://java.sun.com/jsf/core"
  xmlns:h="http://java.sun.com/jsf/html">
    <h:head>
        <meta charset="utf-8"/>
        <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"/>
        <title>TO-DO application</title>
    </h:head>
    <h:body>
        <div>
            <div>
                List of TO-DO items
            </div>
            <h:dataTable value="#{todoService.allTodo}" var="item">
                <h:column>
                    <f:facet name="header"> Message</f:facet>
                    #{item.message}
                </h:column>
                <h:column>
                    <f:facet name="header"> Priority</f:facet>
                    #{item.priority}
                </h:column>
            </h:dataTable>
        </div>
        <div>
            <div>
                Add new to-do item:
            </div>
            <h:form>
                <h:outputLabel for="message" value="Message: "/>
                <h:inputText id="message" value="#{todoService.todo.message}"/>
                <h:outputLabel for="priority" value="Priority: "/>
                <h:inputText id="priority" value="#{todoService.todo.priority}" converterMessage="Please enter digits only."/>
                <h:commandButton value="Save" action="#{todoService.save}"/>
            </h:form>
        </div>
    </h:body>
</f:view>

上記の2つの目的は、2つの別々のdiv要素で実装されます。

最初に、 dataTable 要素を使用して、todoService.AllTodoからのすべての値を表しました。

2番目のdivには、TodoService。のTodoオブジェクトの状態を変更できるフォームが含まれています。

inputText要素を使用してユーザー入力を受け入れます。2番目の入力は自動的にintに変換されます。とともに commandButton、 ユーザーは（今すぐメモリに）永続化できます Todo オブジェクトと todoService.save 。

9. 結論

JSFフレームワークはSpringフレームワークに統合できます。 Beanを管理するフレームワークを選択する必要があります。このチュートリアルでは、Springフレームワークを使用しました。

ただし、スコープモデルはJSFフレームワークとは少し異なります。したがって、Springコンテキストでカスタムスコープを定義することを検討してください。

いつものように、コードはGitHubでから入手できます。

getdocs

13036