Este é o segundo artigo da série de Tutoriais do Struts 2. Se você chegou aqui diretamente, recomendaria verificar também o post anterior. Tutorial para Iniciantes do Struts 2 No último tutorial, analisamos a arquitetura do Struts 2, seus componentes e construímos uma aplicação web simples do Struts 2 com configuração baseada em XML (struts.xml). Neste tutorial, veremos como podemos evitar completamente o arquivo de configuração do Struts usando anotações ou convenções de nomeação.
Conceito de Convenção do Struts 2
O Struts 2 utiliza duas metodologias para encontrar as classes de ação e classes de resultado. Precisamos usar a API struts2-convention-plugin para usar qualquer uma dessas metodologias. Se você tem uma aplicação web normal, pode baixar o arquivo jar e colocá-lo no diretório lib da aplicação web. Para projetos Maven, você pode simplesmente adicionar a dependência conforme abaixo.
<dependency>
<groupId>org.apache.struts</groupId>
<artifactId>struts2-convention-plugin</artifactId>
<version>2.3.15.1</version>
</dependency>
-
Varredura: Neste método, especificamos o pacote que precisa ser varrido em busca de classes de ação. A configuração precisa ser feita no web.xml para o filtro do Struts 2, como abaixo.
<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>O Struts 2 encontrará classes de ação seguindo os seguintes métodos.
- Qualquer classe anotada com @Action ou @Actions.
- Qualquer classe que implemente a interface Action ou estenda a classe ActionSupport.
- Qualquer classe cujo nome termine com Action e contenha o método execute(). Para essas classes, é usada a convenção de nomenclatura para determinar a ação e os resultados.
-
Convenção de Nomenclatura: O Struts 2 criará automaticamente uma ação para classes cujo nome termina com Action. O nome da ação é determinado removendo o sufixo Action e convertendo a primeira letra para minúscula. Portanto, se o nome da classe for HomeAction, então a ação será “home”. Se essas classes não estiverem anotadas com @Result para fornecer o resultado, as páginas de resultado são procuradas no diretório WEB-INF/content e o nome deve ser {action}-{return_string}.jsp. Portanto, se a classe de ação HomeAction estiver retornando “success”, a solicitação será encaminhada para a página WEB-INF/content/home-success.jsp. Usar apenas a convenção de nomenclatura pode ser muito confuso, e não podemos usar a mesma página JSP para outras classes de ação. Portanto, devemos tentar evitar isso e usar uma configuração baseada em anotações.
Agora estamos prontos para criar nossa aplicação Hello World no Struts 2 usando anotações e não teremos arquivo de configuração do Struts 2. Crie um projeto web dinâmico no Eclipse chamado Struts2AnnotationHelloWorld e converta-o para um projeto Maven. O projeto final se parece com a imagem abaixo. 
Configuração do Maven
Adicionamos as dependências struts2-core e struts2-convention-plugin no pom.xml, o código final do 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>
Configuração do Descritor de Implantação
<?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>
Observe o elemento init-param onde estamos fornecendo o pacote de classes de ação que será escaneado pelo Struts 2.
Páginas de Resultado
Temos três páginas de resultado em nossa aplicação. 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>
Agora vamos criar nossas classes de ação que iremos anotar para configurar ação e páginas de resultado.
Classes de Ação com Anotações
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 {
}
Observe que HomeAction é uma classe vazia com o único propósito de encaminhar a solicitação para a página 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";
}
//Bean Java para armazenar os parâmetros do formulário
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;
}
}
Observe o uso das anotações @Action, @Actions, @Result, @Namespace e @Namespaces, o uso é autoexplicativo. Agora, ao executarmos nossa aplicação, obtemos as seguintes páginas de resposta. 
Se você leu o último post onde desenvolvemos a mesma aplicação com a configuração struts.xml, você notará que é quase a mesma coisa. A única mudança é a maneira como conectamos nossas classes de ação da aplicação e páginas de resultado.