JSFの認証ログインログアウトデータベースの例
認証メカニズムにより、ユーザーはユーザー名とパスワードを検証することで、アプリケーションへの安全なアクセスを確保することができます。私たちは、ログインにはJSFビュー、DAOオブジェクト、HttpSessionによるセッション管理、JSFマネージドビーン、そしてMySQLデータベースを使用します。それでは、JSFアプリケーションでJSFログインログアウト認証メカニズムを作成する方法について詳しく見ていきましょう。ステップ1：MySQLデータベースにUsersテーブルを作成します。
CREATE TABLE Users(
uid int(20) NOT NULL AUTO_INCREMENT,
uname VARCHAR(60) NOT NULL,
password VARCHAR(60) NOT NULL,
PRIMARY KEY(uid));
ここでは、uidを主キーとしたユーザーテーブルを作成し、ユーザー名とパスワードフィールドにはnull制約があります。ステップ2：テーブルUsersにデータを挿入します。
INSERT INTO Users VALUES(1,'adam','adam');
プロジェクトに関連するコードに進む前に、下の画像はEclipseでのプロジェクト構造を示しています。動的なウェブプロジェクトを作成し、それをMavenに変換してプロジェクトスタブを作成し、さまざまなコンポーネントを追加し続けてください。ステップ3：JSFのログインページであるlogin.xhtmlを作成してください。
<?xml version='1.0' encoding='UTF-8' ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="https://www.w3.org/1999/xhtml"
xmlns:h="https://java.sun.com/jsf/html">
<h:head>
<title>login</title>
</h:head>
<h:body>
<h:form>
<h3>JSF Login Logout</h3>
<h:outputText value="Username" />
<h:inputText id="username" value="#{login.user}"></h:inputText>
<h:message for="username"></h:message>
<br></br><br></br>
<h:outputText value="Password" />
<h:inputSecret id="password" value="#{login.pwd}"></h:inputSecret>
<h:message for="password"></h:message>
<br></br><br></br>
<h:commandButton action="#{login.validateUsernamePassword}"
value="Login"></h:commandButton>
</h:form>
</h:body>
</html>
ここでは、ユーザ名とパスワードのフィールドがあるJSFのログインビューページを作成し、ログインマネージドビーンを通じてこれらのフィールドの値を設定しています。ログインボタンのクリック時にvalidateUsernamePasswordメソッドを呼び出してユーザ名とパスワードを検証します。ステップ4：次のように管理されたビーンLogin.javaを作成します。
package com.scdev.jsf.beans;
import java.io.Serializable;
import javax.faces.application.FacesMessage;
import javax.faces.bean.ManagedBean;
import javax.faces.bean.SessionScoped;
import javax.faces.context.FacesContext;
import javax.servlet.http.HttpSession;
import com.scdev.jsf.dao.LoginDAO;
import com.scdev.jsf.util.SessionUtils;
@ManagedBean
@SessionScoped
public class Login implements Serializable {
private static final long serialVersionUID = 1094801825228386363L;
private String pwd;
private String msg;
private String user;
public String getPwd() {
return pwd;
}
public void setPwd(String pwd) {
this.pwd = pwd;
}
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
public String getUser() {
return user;
}
public void setUser(String user) {
this.user = user;
}
//validate login
public String validateUsernamePassword() {
boolean valid = LoginDAO.validate(user, pwd);
if (valid) {
HttpSession session = SessionUtils.getSession();
session.setAttribute("username", user);
return "admin";
} else {
FacesContext.getCurrentInstance().addMessage(
null,
new FacesMessage(FacesMessage.SEVERITY_WARN,
"Incorrect Username and Passowrd",
"Please enter correct username and Password"));
return "login";
}
}
//logout event, invalidate session
public String logout() {
HttpSession session = SessionUtils.getSession();
session.invalidate();
return "login";
}
}
「user」と「pwd」という3つの文字列変数を宣言し、ユーザー名、パスワード、エラーメッセージフィールドの値を保持するためのゲッターとセッターメソッドを提供します。また、validateUsernamePassword()というメソッドを作成し、LoginDAOクラスを呼び出してデータベースからユーザー名とパスワードを取得し、フロントエンドで渡された値と比較してユーザー名とパスワードを検証します。ユーザー名とパスワードが一致しない場合は、「ユーザー名またはパスワードが間違っています」というエラーメッセージが表示されます。さらに、logout()メソッドを作成し、HTTPSessionを無効化することでログアウトを実行します。ステップ5：以下のようにLoginDAOのJavaクラスを作成します。データベース操作のコードは実際のプロジェクトで使用するために最適化されていません。JSFアプリケーションで認証を学ぶため、できるだけ速く書きました。
package com.scdev.jsf.dao;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import com.scdev.jsf.util.DataConnect;
public class LoginDAO {
public static boolean validate(String user, String password) {
Connection con = null;
PreparedStatement ps = null;
try {
con = DataConnect.getConnection();
ps = con.prepareStatement("Select uname, password from Users where uname = ? and password = ?");
ps.setString(1, user);
ps.setString(2, password);
ResultSet rs = ps.executeQuery();
if (rs.next()) {
//result found, means valid inputs
return true;
}
} catch (SQLException ex) {
System.out.println("Login error -->" + ex.getMessage());
return false;
} finally {
DataConnect.close(con);
}
return false;
}
}
バリデート()メソッドでは、最初にDataConnectクラスのgetConnectionメソッドを呼び出してデータベースへの接続を確立します。PreparedStatementを使用して、ユーザーが入力した値を使用してデータベースからデータを取得するクエリを構築します。結果セットでデータを取得できれば、入力は有効であるためtrueを返し、そうでなければfalseを返します。ステップ6：以下のようにDataConnect.javaクラスを作成します。
package com.scdev.jsf.util;
import java.sql.Connection;
import java.sql.DriverManager;
public class DataConnect {
public static Connection getConnection() {
try {
Class.forName("com.mysql.jdbc.Driver");
Connection con = DriverManager.getConnection(
"jdbc:mysql://localhost:3306/cardb", "scdev", "scdev123");
return con;
} catch (Exception ex) {
System.out.println("Database.getConnection() Error -->"
+ ex.getMessage());
return null;
}
}
public static void close(Connection con) {
try {
con.close();
} catch (Exception ex) {
}
}
}
以下の文章を日本語で表現すると、「JDBCドライバーをClass.forNameメソッドを使ってロードし、url、ユーザー名、パスワードを引数としてDriverManager.getConnectionメソッドを使用してデータベースに接続します。第7ステップ: SessionUtils.javaを作成して、セッションに関連するユーザー情報を取得・管理します。」
package com.scdev.jsf.beans;
import javax.faces.context.FacesContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
public class SessionUtils {
public static HttpSession getSession() {
return (HttpSession) FacesContext.getCurrentInstance()
.getExternalContext().getSession(false);
}
public static HttpServletRequest getRequest() {
return (HttpServletRequest) FacesContext.getCurrentInstance()
.getExternalContext().getRequest();
}
public static String getUserName() {
HttpSession session = (HttpSession) FacesContext.getCurrentInstance()
.getExternalContext().getSession(false);
return session.getAttribute("username").toString();
}
public static String getUserId() {
HttpSession session = getSession();
if (session != null)
return (String) session.getAttribute("userid");
else
return null;
}
}
ユーザーがgetUserIdメソッドを通じてログインするたびに、各ユーザーにセッションが取得され、セッションIDが特定のユーザーIDに関連付けられます。ステップ8: 認証フィルタークラスを以下のように作成します。
package com.scdev.jsf.filter;
import java.io.IOException;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
@WebFilter(filterName = "AuthFilter", urlPatterns = { "*.xhtml" })
public class AuthorizationFilter implements Filter {
public AuthorizationFilter() {
}
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest request, ServletResponse response,
FilterChain chain) throws IOException, ServletException {
try {
HttpServletRequest reqt = (HttpServletRequest) request;
HttpServletResponse resp = (HttpServletResponse) response;
HttpSession ses = reqt.getSession(false);
String reqURI = reqt.getRequestURI();
if (reqURI.indexOf("/login.xhtml") >= 0
|| (ses != null && ses.getAttribute("username") != null)
|| reqURI.indexOf("/public/") >= 0
|| reqURI.contains("javax.faces.resource"))
chain.doFilter(request, response);
else
resp.sendRedirect(reqt.getContextPath() + "/faces/login.xhtml");
} catch (Exception e) {
System.out.println(e.getMessage());
}
}
@Override
public void destroy() {
}
}
私たちは、destroyメソッドとdoFilterメソッドをオーバーライドして、標準のフィルタークラスを実装します。doFilterメソッドでは、ユーザーがログインせずに他のページにアクセスしようとした場合、ログインページにリダイレクトします。ステップ9：admin.xhtmlを以下のように作成します。
<?xml version='1.0' encoding='UTF-8' ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="https://www.w3.org/1999/xhtml"
xmlns:h="https://java.sun.com/jsf/html">
<h:head>
<title>Facelet Title</title>
</h:head>
<h:body>
<h:form>
<p>Welcome #{login.user}</p>
<h:commandLink action="#{login.logout}" value="Logout"></h:commandLink>
</h:form>
</h:body>
</html>
ユーザーがログインに成功すると、このページが表示されます。ログアウト機能は、Login.javaクラスのlogoutメソッドを呼び出すことで実装されています。ステップ10：faces-config.xmlファイルを以下のように作成します。
<?xml version='1.0' encoding='UTF-8'?>
<faces-config version="2.2" xmlns="https://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://xmlns.jcp.org/xml/ns/javaee
https://xmlns.jcp.org/xml/ns/javaee/web-facesconfig_2_2.xsd">
<navigation-rule>
<from-view-id>/login.xhtml</from-view-id>
<navigation-case>
<from-outcome>admin</from-outcome>
<to-view-id>/admin.xhtml</to-view-id>
</navigation-case>
</navigation-rule>
</faces-config>
上記で指定されたすべての手順が完了したら、アプリケーションを実行し、以下の出力をブラウザで確認してください。ログインページ、認証エラーページ、ログイン成功ページ、ログイン状態でadmin.xhtmlにアクセスする場合は、ログアウトリンクをクリックしてセッションを無効にします。その後、admin.xhtmlページにアクセスしようとすると、ログインページにリダイレクトされます。下記のリンクからプロジェクトをダウンロードして試してみてください。
JSF認証ログインログアウトプロジェクトをダウンロードしてください。
