Ví dụ Hello World trong Struts 2 sử dụng Annotation, không cần file struts.xml

Reading Time: 5 minutes

Đây là bài viết thứ hai trong loạt hướng dẫn về. Ở bài trước, chúng ta đã tìm hiểu về kiến trúc Struts 2, các thành phần chính của nó và đã xây dựng một ứng dụng web đơn giản sử dụng Struts 2 với cấu hình dựa trên XML (struts.xml).

Trong bài viết này, chúng ta sẽ tìm hiểu cách loại bỏ hoàn toàn file cấu hình Struts bằng cách sử dụng annotations hoặc quy ước đặt tên.

Khái niệm Convention trong Struts 2

Struts 2 sử dụng hai phương pháp để xác định các lớp action và result. Để sử dụng bất kỳ phương pháp nào trong số này, chúng ta cần sử dụng thư viện struts2-convention-plugin.

Nếu bạn đang xây dựng một ứng dụng web thông thường, bạn có thể tải file jar của plugin này và đặt vào thư mục lib của ứng dụng. Còn với các dự án maven, bạn chỉ cần thêm phần dependency như sau:

<dependency>
	<groupId>org.apache.struts</groupId>
	<artifactId>struts2-convention-plugin</artifactId>
	<version>2.3.15.1</version>
</dependency>

1. Scanning:

Với phương pháp này, chúng ta chỉ định package cần được quét để tìm các lớp action. Việc cấu hình cần được thực hiện trong file web.xml cho Struts 2 filter, như ví dụ dưới đây:

<filter>
	<filter-name>struts2</filter-name>
	<filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class>
	<init-param>
		<param-name>actionPackages</param-name>
		<param-value>com.journaldev.struts2.actions</param-value>
	</init-param>
</filter>

Struts 2 sẽ tìm các lớp action bằng các cách sau:

• Bất kỳ lớp nào được chú thích bằng @Action hoặc @Action .
• Bất kỳ lớp nào cài đặt interface Action hoặc kế thừa lớp ActionSupport.
• Bất kỳ lớp nào có tên kết thúc bằng “Action” và có chứa phương thức execute(). Với các lớp này naming convention sẽ được sử dụng để xác định action và result.

2. Quy ước đặt tên:

Struts 2 sẽ tự động tạo action cho những lớp có tên kết thúc bằng “Action”. Tên action được xác định bằng cách bỏ hậu tố “Action” và viết thường chữ cái đầu tiên.

Ví dụ: nếu tên lớp là HomeAction, thì tên action tương ứng sẽ là “home”.

Nếu các lớp này không được chú thích bằng @Result để chỉ định trang kết quả, thì Struts 2 sẽ tìm các trang kết quả trong thư mục WEB-INF/content, và tên file JSP phải có dạng: {action}-{return_string}.jsp.

Ví dụ: nếu lớp HomeAction trả về chuỗi “success” thì request sẽ được chuyển hướng đến trang: WEB-INF/content/home-success.jsp

Tuy nhiên, việc chỉ sử dụng quy ước đặt tên có thể gây nhầm lẫn, và không thể dùng chung một trang JSP cho nhiều action khác nhau. Do đó, bạn nên tránh phụ thuộc vào cách này và nên sử dụng cấu hình dựa trên annotation để rõ ràng và dễ quản lý hơn.

Giờ đây, chúng ta đã sẵn sàng để tạo ứng dụng Hello World với Struts 2 sử dụng annotation và sẽ không cần dùng file cấu hình Struts 2.

Hãy tạo một Dynamic Web Project trong Eclipse với tên Struts2AnnotationHelloWorld, sau đó chuyển thành Maven project.

Dự án sau khi hoàn tất sẽ có cấu trúc như hình dưới đây.

Cấu hình Maven

Chúng ta đã thêm các dependency struts2-core và struts2-convention-plugin vào file pom.xml. Dưới đây là nội dung hoàn chỉnh của file pom.xml:

<project xmlns="<https://maven.apache.org/POM/4.0.0>" xmlns:xsi="<https://www.w3.org/2001/XMLSchema-instance>"
	xsi:schemaLocation="<https://maven.apache.org/POM/4.0.0> <https://maven.apache.org/xsd/maven-4.0.0.xsd>">
	<modelVersion>4.0.0</modelVersion>
	<groupId>Struts2AnnotationHelloWorld</groupId>
	<artifactId>Struts2AnnotationHelloWorld</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>war</packaging>

	<dependencies>
		<dependency>
			<groupId>org.apache.struts</groupId>
			<artifactId>struts2-core</artifactId>
			<version>2.3.15.1</version>
		</dependency>
		<dependency>
			<groupId>org.apache.struts</groupId>
			<artifactId>struts2-convention-plugin</artifactId>
			<version>2.3.15.1</version>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<artifactId>maven-compiler-plugin</artifactId>
				<version>3.1</version>
				<configuration>
					<source>1.6</source>
					<target>1.6</target>
				</configuration>
			</plugin>
			<plugin>
				<artifactId>maven-war-plugin</artifactId>
				<version>2.3</version>
				<configuration>
					<warSourceDirectory>WebContent</warSourceDirectory>
					<failOnMissingWebXml>false</failOnMissingWebXml>
				</configuration>
			</plugin>
		</plugins>
		<finalName>${project.artifactId}</finalName>
	</build>
</project>

Cấu hình Deployment Descriptor

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="<https://www.w3.org/2001/XMLSchema-instance>"
	xmlns="<https://java.sun.com/xml/ns/javaee>"
	xsi:schemaLocation="<https://java.sun.com/xml/ns/javaee> <https://java.sun.com/xml/ns/javaee/web-app_3_0.xsd>"
	id="WebApp_ID" version="3.0">
	<display-name>Struts2AnnotationHelloWorld</display-name>

	<filter>
		<filter-name>struts2</filter-name>
		<filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class>
		<init-param>
			<param-name>actionPackages</param-name>
			<param-value>com.journaldev.struts2.actions</param-value>
		</init-param>
	</filter>

	<filter-mapping>
		<filter-name>struts2</filter-name>
		<url-pattern>/*</url-pattern>
	</filter-mapping>

</web-app>

Lưu ý phần tử init-param, nơi chúng ta chỉ định package chứa các lớp action để Struts 2 quét và tự động phát hiện.

Các trang kết quả

Ứng dụng của chúng ta có ba trang kết quả, bao gồm:

• login.jsp

<%@ page language="java" contentType="text/html; charset=US-ASCII"
    pageEncoding="US-ASCII"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "<https://www.w3.org/TR/html4/loose.dtd>">
<%-- Using Struts2 Tags in JSP --%>
<%@ taglib uri="/struts-tags" prefix="s"%>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Login Page</title>
</head>
<body>
<h3>Welcome User, please login below</h3>
<s:form action="login">
	<s:textfield name="name" label="User Name"></s:textfield>
	<s:textfield name="pwd" label="Password" type="password"></s:textfield>
	<s:submit value="Login"></s:submit>
</s:form>
</body>
</html>

error.jsp

<%@ page language="java" contentType="text/html; charset=US-ASCII"
    pageEncoding="US-ASCII"%>
<%@ taglib uri="/struts-tags" prefix="s"%>
    
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "<https://www.w3.org/TR/html4/loose.dtd>">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Error Page</title>
</head>
<body>
<h4>User Name or Password is wrong</h4>
<s:include value="login.jsp"></s:include>
</body>
</html>

welcome.jsp

<%@ page language="java" contentType="text/html; charset=US-ASCII"
    pageEncoding="US-ASCII"%>
<%@ taglib uri="/struts-tags" prefix="s"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "<https://www.w3.org/TR/html4/loose.dtd>">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Welcome Page</title>
</head>
<body>
<h3>Welcome <s:property value="name"></s:property></h3>
</body>
</html>

Bây giờ, hãy tạo các lớp Action và sử dụng annotation để cấu hình action cùng với các trang kết quả.

Các lớp Action sử dụng Annotation

package com.journaldev.struts2.actions;

import org.apache.struts2.convention.annotation.Action;
import org.apache.struts2.convention.annotation.Actions;
import org.apache.struts2.convention.annotation.Namespace;
import org.apache.struts2.convention.annotation.Namespaces;
import org.apache.struts2.convention.annotation.Result;

import com.opensymphony.xwork2.ActionSupport;

/**
 * An empty class for default Action implementation for:
 * 
 *  <action name="home">
 *		<result>/login.jsp</result>
 *	</action>
 * HomeAction class will be automatically mapped for home.action
 * Default page is login.jsp which will be served to client
 * @author pankaj
 *
 */

@Namespaces(value={@Namespace("/User"),@Namespace("/")})
@Result(location="/login.jsp")
@Actions(value={@Action(""),@Action("home")})
public class HomeAction extends ActionSupport {
}

Lưu ý rằng lớp HomeAction là một lớp rỗng, với mục đích duy nhất là chuyển tiếp request đến trang login.jsp.

package com.journaldev.struts2.actions;

import org.apache.struts2.convention.annotation.Action;
import org.apache.struts2.convention.annotation.Namespace;
import org.apache.struts2.convention.annotation.Namespaces;
import org.apache.struts2.convention.annotation.Result;

/**
 * Notice the @Action annotation where action and result pages are declared
 * Also notice that we don't need to implement Action interface or extend ActionSupport
 * class, only we need is an execute() method with same signature
 * @author pankaj
 *
 */
@Action(value = "login", results = {
		@Result(name = "SUCCESS", location = "/welcome.jsp"),
		@Result(name = "ERROR", location = "/error.jsp") })
@Namespaces(value={@Namespace("/User"),@Namespace("/")})
public class LoginAction {

	public String execute() throws Exception {
		if("pankaj".equals(getName()) && "admin".equals(getPwd()))
		return "SUCCESS";
		else return "ERROR";
	}
	
	//Java Bean to hold the form parameters
	private String name;
	private String pwd;
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public String getPwd() {
		return pwd;
	}
	public void setPwd(String pwd) {
		this.pwd = pwd;
	}
}

Lưu ý việc sử dụng các annotation như @Action, @Actions, @Result, @Namespace và @Namespaces , cách sử dụng của chúng khá rõ ràng và dễ hiểu.

Giờ đây, khi chúng ta chạy ứng dụng, các trang phản hồi sau sẽ được hiển thị.

Nếu bạn đã đọc bài viết trước, nơi chúng ta xây dựng cùng một ứng dụng nhưng sử dụng cấu hình với struts.xml, bạn sẽ nhận thấy rằng mọi thứ gần như giống nhau.

Điểm khác biệt duy nhất là cách chúng ta liên kết các lớp action và các trang kết quả trong ứng dụng.