Это вторая статья в серии учебных пособий по Struts 2. Если вы попали сюда напрямую, я бы порекомендовал вам также ознакомиться с предыдущим постом. Руководство для новичков по Struts 2 В последнем уроке мы рассмотрели архитектуру Struts 2, его компоненты и создали простое веб-приложение Struts 2 с конфигурацией на основе XML (struts.xml). В этом уроке мы увидим, как можно полностью избежать файла конфигурации Struts, используя аннотации или соглашения по именованию.
Концепция Struts 2 Convention
Struts 2 использует две методологии для определения классов действий и классов результатов. Для использования любой из этих методологий нам нужно использовать API плагина struts2-convention-plugin. Если у вас обычное веб-приложение, вы можете скачать его файл JAR и поместить его в каталог lib вашего веб-приложения. Для проектов Maven вы можете просто добавить зависимость, как показано ниже.
<dependency>
<groupId>org.apache.struts</groupId>
<artifactId>struts2-convention-plugin</artifactId>
<version>2.3.15.1</version>
</dependency>
-
Сканирование: В этом методе мы указываем пакет, который нужно отсканировать на предмет классов действий. Конфигурация должна быть выполнена в файле web.xml для фильтра Struts 2, как показано ниже.
<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 будет находить классы действий с помощью следующих методов.
- Любой класс, аннотированный @Action или @Actions.
- Любой класс, реализующий интерфейс Action или расширяющий класс ActionSupport.
- Любой класс, имя которого заканчивается на Action и содержит метод execute(). Для этих классов используется соглашение об именовании для определения действия и результатов.
-
Соглашение по наименованию: Struts 2 автоматически создает действие для классов с именами, заканчивающимися на Action. Имя действия определяется путем удаления суффикса Action и преобразования первой буквы в строчную. Таким образом, если имя класса – HomeAction, то действие будет “home”. Если эти классы не аннотированы @Result для предоставления результата, то страницы результатов ищутся в каталоге WEB-INF/content, и имя должно быть {action}-{return_string}.jsp. Так что если действие класса HomeAction возвращает “success”, запрос будет перенаправлен на страницу WEB-INF/content/home-success.jsp. Использование только соглашения по наименованию может быть очень запутанным, и мы не можем использовать одну и ту же JSP-страницу для других классов действий. Поэтому мы должны стараться избегать этого и использовать конфигурацию на основе аннотаций.
Теперь мы готовы создать наше приложение Hello World Struts 2 с использованием аннотаций, и у нас не будет файла конфигурации Struts 2. Создайте динамический веб-проект в Eclipse с именем Struts2AnnotationHelloWorld и преобразуйте его в проект Maven. Конечный проект выглядит как на изображении ниже. 
Конфигурация Maven
Мы добавили зависимости struts2-core и struts2-convention-plugin в pom.xml, итоговый код 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>
Конфигурация дескриптора развертывания
<?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>
Обратите внимание на элемент init-param, где мы указываем пакет классов действий, которые будут отсканированы Struts 2.
Страницы результата
У нас есть три страницы результата в нашем приложении. 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>
Теперь давайте создадим наши классы действий, которые будем аннотировать для настройки действий и страниц результатов.
Классы действий с аннотациями
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 {
}
Обратите внимание, что HomeAction – это пустой класс, который служит только для перенаправления запроса на страницу 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 для хранения параметров формы
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;
}
}
Обратите внимание на использование аннотаций @Action, @Actions, @Result, @Namespace и @Namespaces, использование которых является очевидным. Теперь, когда мы запускаем наше приложение, мы получаем следующие страницы ответа. 
Если вы прочитали последний пост, где мы разработали то же приложение с конфигурацией struts.xml, вы заметите, что это практически то же самое. Единственное изменение – это способ связывания классов действий нашего приложения и страниц результатов.