Org.apache.struts.action.ActionMapping
Для запроса контроллер находит соответствующие ему ActionForm-
и Action-классы. Первым создается ActionForm, если такой объект еще не создавался и не находится ни в одной из областей видимости (сессия, запрос). Далее поля объекта ActionForm заполняются данными, которые пришли с запросом, т.е. для каждого параметра, содержащегося в запросе, вызывается соответствующий set-метод. Например, если в запросе есть параметр login=goch, то
в ActionForm будет вызван метод setLogin() с передачей значения параметра. В Struts существует возможность заполнения структуры объектов. Пусть
в ActionForm с помощью методов setCompany() и getCompany() передается объект класса Company, полем которого является коллекция объектов типа Employee, для каждого из которых определено поле типа Address.
Тогда для заполнения поля адреса одного из работников достаточно присутствия параметра company.employees[n].address.phone, что приведет
к последовательному вызову следующих методов:
getCompany().getEmployees().getItem(n).getAddress().setPhone().
Заполнив форму данными, сервлет-контроллер Struts направляет HTTP-запрос к соответствующему запрашиваемому URL-наследнику класса Action.
Создается только один экземпляр Action для всех пользователей, поэтому глобальные переменные должны быть синхронизированы либо ограничены
в использовании, передавая в метод execute()заполненный объект ActionForm и ActionMapping. Класс Action отвечает за вызов Model
и перенаправление к необходимому элементу View в зависимости от результата действия.
Модель инкапсулирует бизнес-логику приложения. Управление обычно передается обратно через контроллер соответствующему представлению, этот вызов соответствует запросу JSP-страницы. Перенаправление осуществляется путем обращения к набору соответствий (mappings) между бизнес-моделью и представлением. Предложенная схема обеспечивает слабое связывание (Low Coupling) между представлением и бизнес-моделью, что делает разработку и поддержку приложения значительно проще.
JSP-страница представления состоит, как правило, из статического HTML-кода, а также из динамического содержания, основанного на инициализации
в запросе специальных тегов действий (action tags). Среда Struts включает большой и разнообразный набор стандартных тегов действий, назначение которых описано в спецификации Struts. Кроме того, существует стандартное средство для определения своих собственных тегов.
Простое приложение
Приведенный в главе «Java Server Pages» пример распределенного приложения входа в систему с проверкой логина и пароля можно легко переписать с использованием технологии Struts. Следует обратить внимание на то, что использование технологии Struts упрощает организацию приложения, поэтому диаграмма классов будет выглядеть проще.
Рис. 1. Диаграмма взаимодествия классов и JSP в Struts-приложении.
/* пример # 1: Action класс : LoginAction.java */
package by.bsu.famcs.jspservlet;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.struts.action.Action;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import org.apache.struts.action.ActionMessage;
import org.apache.struts.action.ActionMessages;
public class LoginAction extends Action {
public ActionForward execute(ActionMapping mapping,
ActionForm form, HttpServletRequest request, HttpServletResponse response)
throws IOException, ServletException {
ActionMessages errors = new ActionMessages();
LoginForm actionForm = (LoginForm)form;
String login = actionForm.getLogin();
String password = actionForm.getPassword();
if (login != null && password != null) {
if (LoginLogic.checkLogin(login, password)) {
return mapping.findForward("success");
} else {
errors.add(ActionMessages.GLOBAL_MESSAGE,
new ActionMessage("error.login.incorrectLoginOrPassword"));
saveErrors(request, errors);
}
}
//загрузка формы для логина
return mapping.findForward("loginAgain");
}
}
КлассLoginForm, объект которого представляет форму, соответствующую странице ввода логина и пароля, выглядит следующим образом:/* пример # 2: класс хранения информации, передаваемой из login.jsp : LoginForm.java */package by.bsu.famcs.jspservlet;
import javax.servlet.http.HttpServletRequest;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionMapping;
public class LoginForm extends ActionForm {
private String login;
private String password;
//очищение полей формы
public void reset(ActionMapping mapping,
HttpServletRequest request) {
super.reset(mapping, request);
this.password = null;
}
public String getLogin() {
return login;
}
public String getPassword() {
return password;
}
public void setLogin(String login) {
this.login = login;
}
public void setPassword(String password) {
this.password = password;
}
}Класс LoginLogic, представляющий бизнес-логику, не был изменен. Его необходимо перенести в соответствующую папку данного проекта Struts. Класс ConfigurationManager изменился в сторону уменьшения атрибутов, так как часть информации хранится теперь в struts-config.xml./*пример # 3: служебный класс, извлекающий из файла config.properties
информацию о драйвере и расположении БД : ConfigurationManager.java */
package by.bsu.famcs.jspservlet.manager;
import java.util.ResourceBundle;
public class ConfigurationManager {
private static ConfigurationManager instance;
private ResourceBundle resourceBundle;
private static final String BUNDLE_NAME = "config";
public static final String DATABASE_DRIVER_NAME = "DATABASE_DRIVER_NAME";
public static final String DATABASE_URL = "DATABASE_URL";
public static ConfigurationManager getInstance() {
if (instance == null) {
instance = new ConfigurationManager();
instance.resourceBundle =
ResourceBundle.getBundle(BUNDLE_NAME);
}
return instance;
}
public String getProperty(String key) {
return (String)resourceBundle.getObject(key);
}
}
Далее приведено содержимое файла config.properties:
###############################
## Application configuration ##
###############################
DATABASE_DRIVER_NAME=com.mysql.jdbc.Driver
DATABASE_URL=jdbc:mysql://localhost:3306/db1?user=
root&password=pass
JSP-страницы были изменены следующим образом:<%--пример # 4: стартовая страница в оформлении Struts :index.jsp --%><%@ page language="java" contentType="text/html; charset=ISO-8859-1" pageEncoding="ISO-8859-1"%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
Transitional//EN">
<html><head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Index JSP</title>
</head>
<body>
<a href="login.do">Controller</a>
</body></html>
<%--пример # 5: страница запроса логина и пароля :login.jsp --%><%@ page language="java" contentType="text/html;
charset=ISO-8859-1" pageEncoding="ISO-8859-1"%>
<%-- Подключение библиотек тегов Struts--%>
<%@ taglib uri="/WEB-INF/struts-bean.tld" prefix="bean" %>
<%@ taglib uri="/WEB-INF/struts-html.tld" prefix="html" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
Transitional//EN">
<html:html locale="true">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<%-- вывод сообщения из .properties проекта --%>
<title><bean:message key="jsp.login.title"/></title>
<%-- генерируется тег <base> с атрибутом href, в котором будет URL
текущего application. При этом все относительные ссылки на странице
ответа отсчитываются от этого значения
--%>
<html:base />
</head>
<body>
<h3><bean:message key="jsp.login.header"/></h3>
<hr/><%-- форма для логина --%>
<html:form action="/login" method="POST">
<bean:message key="jsp.login.field.login"/>:<br>
<%-- текстовое поле для имени пользователя --%>
<html:text property="login"/><br>
<bean:message key="jsp.login.field.password"/>:<br>
<%-- текстовое поле для пароля пользователя --%>
<html:password property="password"
redisplay="false"/><br>
<html:submit><bean:message
key="jsp.Login.button.submit"/> </html:submit>
</html:form>
<%-- пользовательский тег для отображения ошибок списком, открывающие/закрывающие значения которого берутся из файла ресурсов --%>
<html:errors/>
<hr/>
</body>
</html:html>Следует обратить внимание на пользовательские теги вида
<bean:message key="jsp.login.header"/>,
которые выводят текст, предварительно размещенный в специальном файле
ApplicationResources.properties. В этом файле хранятся все статические текстовые данные, которые извлекаются по ключу, указанному в свойстве пользовательского тега key. Например, в LoginAction при создании объектов ошибок в их конструкторе был указан ключ, по которому в этом файле берется текст ошибки:
errors.add(ActionMessages.GLOBAL_MESSAGE,
new ActionMessage("error.login.incorrectLoginOrPassword"));
Для данного приложения файл ресурсов может быть создан в виде:# пример # 6: файл ресурсов : ApplicationResources.properties # header и footer, которые будут использоваться для # обрамления ошибок, выдаваемых тегом <errors/>.errors.header=<ul>
errors.footer=</ul>
errors.prefix=<li>
errors.suffix=</li>
# разметка для элемента списка ошибок из <errors/>,
# который указывает, что логин или пароль неверны.
error.login.incorrectLoginOrPassword=<li>incorrect login or password</li>
# текстовая информация на login.jsp
jsp.login.title=Login
jsp.login.header=Login
jsp.login.field.login=Login
jsp.login.field.password=Password
jsp.login.button.submit=Enter
# текстовая информация на main.jsp
jsp.main.title=Welcome
jsp.main.header=Welcome
jsp.main.hello=Hello
# текстовая информация на error.jsp
jsp.error.title=Error
jsp.error.header=Error
jsp.error.returnToLogin=Return to login pageИмя и месторасположение этого файла настраиваются в struts-config.xml, который является основным конфигурационным файлом для приложения, построенного на основе Struts.пример # 7: конфигурация action, forward, resource и т.д. : struts-config.xml<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE struts-config PUBLIC "-//Apache
Software Foundation//DTD Struts Configuration 1.2//EN"
"http://jakarta.apache.org/struts/dtds/struts-config_1_2.dtd">
<struts-config>
<data-sources>
<!--источники данных к БД. Как правило, это организация пула соединений. Пример приведен в конце раздела-->
</data-sources>
<!-- ========== Form Bean Definitions -->
<form-beans>
<form-bean name="loginForm"
type="by.bsu.famcs.jspservlet.LoginForm" />
</form-beans>
<!-- ============== Global Exception Definitions (если есть)-->
<global-exceptions>
</global-exceptions>
<!-- ============== Global Forward Definitions(если есть) -->
<global-forwards>
</global-forwards>
<!-- =============== Action Mapping Definitions -->
<action-mappings>
<!-- Action для процесса логина -->
<action name="loginForm"
path="/login"
scope="request"<!—- Задается область видимости формы. Часто необходимо, чтобы форма лежала в сессии, а не в запросе. -->
type="by.bsu.famcs.jspservlet.LoginAction"
validate="false">
<!-- форварды на JSP, доступные из данного action -->
<forward name="againlogin" path="/WEB-INF/jsp/login.jsp" />
<forward name="success" path="/WEB-INF/jsp/main.jsp" />
</action>
</action-mappings>
<!-- =================== Message Resources Definitions -->
<!-- имя файла ресурсов .properties, в котором будет храниться вся статическая текстовая информация для приложения. Путь берется относительно папки classes. -->
<message-resources parameter=
"resources.ApplicationResources"/>
</struts-config>
В теге <action> при помощи параметра path со значением /loginсвязываются страница JSP и класс ActionForm, ей соответствующий. Это значение указывается в login.jsp в теге FORM ACTION. Далее прописывается путьк сервлету, в который и будет передана вся информация, извлеченная из запроса.
В теге <forward> размещаются имена, в частности success и login, ассоциированные с путями вызова страниц /jsp/login.jsp и /jsp /main.jsp соответственно.Указанные имена передаются в метод findForward() класса ActionMapping в качестве параметра при различных вариантах завершения работы сервлета.Файл web.xml в проекте также обязательно присутствует и должен указывать на месторасположение главного сервлета ActionServlet и файла struts-config.xml, а также указывать servlet-mapping для контроллера.пример # 8: конфигурационный файл приложения : web.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app id="WebApp">
<display-name>Study</display-name>
<!-- настройка стандартного контроллера Struts – сервлета ActionServlet -->
<servlet>
<servlet-name>action</servlet-name>
<servlet-class>
org.apache.struts.action.ActionServlet</servlet-class>
<!-- месторасположение основного настроечного файла Struts – struts-config.xml -->
<init-param>
<param-name>config</param-name>
<param-value>WEB-INF/struts-config.xml</param-value>
</init-param>
<init-param>
<param-name>debug</param-name>
<param-value>2</param-value>
</init-param>
<init-param>
<param-name>detail</param-name>
<param-value>2</param-value>
</init-param>
<init-param>
<param-name>validate</param-name>
<param-value>true</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<!-- соответствие (mapping) для стратсовского контроллера, указывающее, что контроллер будет вызываться, если адрес заканчивается на .do -->
<servlet-mapping>
<servlet-name>action</servlet-name>
<url-pattern>*.do</url-pattern>
</servlet-mapping>
<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
</welcome-file-list>
<!-- подключение стандартных struts-ских библиотек пользовательских тегов (библиотек может быть больше для поздних версий) -->
<taglib>
<taglib-uri>/WEB-INF/struts-bean.tld</taglib-uri>
<taglib-location>/WEB-INF/struts-bean.tld</taglib-location>
</taglib>
<taglib>
<taglib-uri>/WEB-INF/struts-html.tld</taglib-uri>
<taglib-location>/WEB-INF/struts-html.tld</taglib-location>
</taglib>
<taglib>
<taglib-uri>/WEB-INF/struts-logic.tld</taglib-uri>
<taglib-location>/WEB-INF/struts-logic.tld</taglib-location>
</taglib>
</web-app>
Чтобы получить пул соединений, в приложении следует заполнить datasource в struts-config.xml, следующим образом:
пример # 9: организация пула соединений : data-sources <data-sources><data-source type="org.apache.commons.dbcp.BasicDataSource">
<set-property
property="driverClassName"
value="com.mysql.jdbc.Driver" />
<set-property
property="url"
value="jdbc:mysql://localhost/имя_бд" />
<set-property
property="username"
value="root" />
<set-property
property="password"
value="pass" />
<set-property
property="maxActive"
value="10" />
<set-property
property="maxWait"
value="5000" />
<set-property
property="defaultAutoCommit"
value="false" />
<set-property
property="defaultReadOnly"
value="false" />
</data-source>
</data-sources>
Получить данный пул из класса, реализующего org.apache.struts.action.Action, можно с помощью метода
getDataSource(HttpServletRequest request)).
<%@ page errorPage="error.jsp" %>
<%@ taglib uri="/WEB-INF/struts-bean.tld" prefix="bean" %>
<%@ taglib uri="/WEB-INF/struts-html.tld" prefix="html" %>
<html:html locale="true">
<head>
<title><bean:message key="jsp.main.title"/></title>
<html:base/>
</head>
<body>
<h3><bean:message key="jsp.main.header"/></h3>
<hr/>
<bean:message key="jsp.main.hello"/>,
<bean:write name="loginForm" property="login"/>
<hr/>
<a href="login.do"><bean:message
key="jsp.error.returnToLogin"/></a>
<html:errors/>
</body>
</html:html>
Страница ошибок, к которой осуществляется переход в случае возникновения исключений, модернизирована следующим образом:<%--пример # 11: страница, вызываемая при ошибке : error.jsp --%><%@ page isErrorPage="true" %>
<%@ taglib uri="/WEB-INF/struts-bean.tld" prefix="bean" %>
<%@ taglib uri="/WEB-INF/struts-html.tld" prefix="html" %>
<html:html locale="true">
<head>
<title><bean:message key="jsp.error.title"/></title>
<html:base/>
</head>
<body>
<h3><bean:message key="jsp.error.header"/></h3>
<hr>
<%=(exception != null)? exception.toString() :
"unknown error"%>
<hr>
<a href="login.do"><bean:message key="jsp.error.returnToLogin"/></a>
</body>
</html:html>
Кроме того, чтобы использовать технологию Struts, необходимо подключить struts.jar с Java-кодом движка и библиотеки пользовательских тегов: struts-bean.tldstruts-html.tld
struts-logic.tld
Чтобы запустить проект, следует вызвать из браузера:http://localhost:8080/StrutsProjectНаследники Action
Существуют альтернативы классу Action, наследуемые от Action и облегчающие задачу разработчика.Класс Action объявляеет только метод execute() и ранее использовалсяв виде ответа на одно действие пользователя, что увеличивало количество классов приложения и усложняло его поддержку.Класс DispatchAction позволяет объединить несколько методов работы
с одним модулем в одном классе и вызывать их в зависимости от значения
параметра запроса. Например, для работы с модулем User класс UserDispatchAction мог бы содержать методы save(), delete(), list() и другие.Параметр, значение которого будет использовано для вызова метода, описывается в struts-config.xml в описании action.
<action path="/ModuleAction"
type="com.struts.ModuleDispatchAction"
parameter="method"
...</action>В коде JSP теперь требуется расставить линки с параметром method, значение которого должно соответствовать методу, вызываемому в подклассе. Например:<a href="ModuleAction.do?method=edit&id=1>Edit</a>
<a href="ModuleAction.do?method=view&id=1>View</a>Далее осталось реализовать методы в ModuleDispatchAction. Если параметр не содержит значения, то вызовется метод unspecified() данного класса. Так же можно реализовать метод cancelled(), который будет вызываться при использовании кнопки <html:cancel/>.import org.apache.struts.actions.DispatchAction;
public class ModuleDispatchAction extends DispatchAction{
public ActionForward edit(ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response)
throws IOException,
ServletException {
// код для обработки
}
public ActionForward view(...)
throws IOException, ServletException {
// код для обработки
}
...
public ActionForward unspecified(...)
throws IOException, ServletException {
mapping.findForward("methodNotFound");
}
public ActionForward cancelled(ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response)
throws IOException, ServletException {
mapping.findForward("cancelPage");
}
}
КлассLookupDispatchActionявляется наследником от DispatchAction. В отличие от предыдущего класса, который в основном используется через использование линков на View, данный класс применяется если форма должна иметь несколько различных кнопок для выполнения запроса на сервер.Пусть на странице JSP с помощью тега <html:submit/> расположены кнопки, свойство property которых указывает на название параметра, отправляемого на сервер со значением тега <bean:message/>после нажатия на эту кнопку.
<html:form action="ModuleAction.do">
...
<html:submit property="method">
<bean:message key="submit.button.print" />
</html:submit>
<html:submit property="method">
<bean:message key="button.save" />
</html:submit>
</html:form>Затем так же, как и для класса DispatchAction, должен быть задан параметр, который содержит вызываемый метод.
<action path="/ModuleAction"
type="com. struts.ModuleLookupDispatchAction"
parameter="method"
...</action>Реализуем методы аналогично DispatchAction классу, но также реализуем метод getKeyMethodMap(), который организует mappingмежду ключом названия кнопки и методом.
import org.apache.struts.actions.LookupDispatchAction;
...
public class ModuleLookupDispatchAction
extends LookupDispatchAction {
private staticMap m = new HashMap();
static {
m.put("myapp.submit.button.print","print");
m.put("myapp.submit.button.save","save");
}
protected Map getKeyMethodMap(){
return m;
}
public ActionForward print(...)
throws IOException, ServletException {
...
}
public ActionForward save(...)
throws IOException, ServletException {
...
}...}Класс MappingDispatchAction также является наследником DispatchAction класса, где вызываемый метод определяется не по значению параметра, а по запрашиваемому URL-адресу маппинг которого хранится в struts-config.xml.Для одного класса MappingDispatchAction может существовать несколько возможных элементов <action>:<action path="/userUpdate"
type="com.struts.UserMappingDispatchAction"
parameter="update"
...
<action path="/userAdd"
type="com.struts.UserMappingDispatchAction"
parameter="create"
...Значение атрибута parameter содержит название метода, который должен отреагировать на данный запрос.И, как в предыдущих случаях, осталось реализовать необходимые методы.import org.apache.struts.actions.MappingDispatchAction;
...
public class UserMappingDispatchAction
extends MappingDispatchAction{
public ActionForward update(ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response)
throws IOException, ServletException {
...
}
public ActionForward create(...)
throws IOException, ServletException {
...
}
...
public ActionForward unspecified(...)
throws IOException, ServletException {
mapping.findForward("methodNotFound");
}
}
Библиотеки тегов Struts
Struts Bean Tags
- cookie
Получает значение для указанного cookie.
<p>Display the properties of our current session ID cookie (if there is one):</p>
<bean:cookie id="sess" name="JSESSIONID" value="JSESSIONID-IS-UNDEFINED"/>
- define
Создает переменную доступную по значению id в одной из областей видимости согласно атрибуту toScope (по умолчанию page scope) и назначает ей значение атрибута value, либо Java bean по ключу из атрибута name или его свойство по aтрибуту property.
<bean:define id="test1_boolean" name="test1"
property="booleanProperty" toScope=”session”/>
<bean:define id="test1_double" name="test1"
property="doubleProperty"/>
<bean:define id="test1_float" name="test1"
property="floatProperty"/>
<bean:define id="test1_int" name="test1"
property="intProperty"/>
<bean:define id="test1_long" name="test1"
property="longProperty"/>
<bean:define id="test1_short" name="test1"
property="shortProperty"/>
<bean:define id="test1_string" name="test1"
property="stringProperty"/>
<bean:define id="test1_value" value="ABCDE"/>
- header
Получает значение соответствующего заголовка запроса.
Display the values of the headers included in this request.<br><br>
<%
java.util.Enumeration names =
((HttpServletRequest) request).getHeaderNames();
%>
<table border="1">
<tr>
<th>Header Name</th>
<th>Header Value</th>
</tr>
<%
while (names.hasMoreElements()) {
String name = (String) names.nextElement();
%>
<bean:header id="head" name="<%= name %>"/>
<tr>
<td><%= name %></td>
<td><%= head %></td>
</tr>
<%
}
%>
- include
Включает в ответ данные с указанного источника. Данные хранятся в области видимости page под значением атрибута id.
<bean:include id="index" page="/index.jsp"/>
- message
Получает локализированное сообщение для указанного ключа из файла ресурсов.
- page
Получает значение из контекста страницы.
- parameter
Получает значение указанного параметра из запроса.
<bean:parameter id="param1" name="param1"/>
- resource
Получает значение указанного ресурса Web-приложения.
<bean:resource id="webxml" name="/WEB-INF/web.xml"/>
- size
Получает ссылку на массив или коллекцию и создает новый объект типа java.lang.Integer со значением, равным размеру массива или коллекции.
<bean:size id="dataSize" collection="<%= data %>"/>
- struts
Получает значение указанного внутреннего конфигурационного объекта Struts.
- write
Показывает значение указанного атрибута указанного бина.
Struts Html Tags
- button, cancel, checkbox, file, form, frame, hidden, image, img, link, multibox, password, radio, reset, submit, text, textarea
Представляют стандартные html-элементы.
- errors
Отображает множество подготовленных сообщений об ошибках.