Giới thiệu về Apache Struts 1

Mặc dù Apache Struts version 1.x đã không còn được hỗ trợ từ rất lâu rồi nhưng mình vẫn quyết định sẽ viết một bài về Struts 1. Đó là bởi vì, có thể một số bạn, khi làm việc với những khách hàng mà hệ thống của họ đã có từ rất lâu rồi và họ đang sử dụng Struts 1, sẽ có nhu cầu tìm hiểu xem Struts 1 là gì, cách hoạt động của nó ra sao để hiểu về hệ thống khách hàng. Trong bài viết này, mình sẽ giới thiệu với các bạn một số điểm cơ bản của Struts 1 và làm một ví dụ nhỏ để xem cách hoạt động của Struts 1 là như thế nào các bạn nhé!

Điều đầu tiên các bạn cần biết về Apache Struts là … nó là một open-source framework sử dụng Java Servlet API giúp các bạn hiện thực các ứng dụng Java web theo mô hình MVC (Model-View-Controller). Nó cung cấp cho chúng ta tất cả các thành phần cần thiết để xây dựng một web application bao gồm các web form components, validator, đa ngôn ngữ, error handling.

Version cuối cùng nhất của Apache Struts 1 là 1.3.10 và các bạn có thể sử dụng Java 8 để chạy các ứng dụng Apache Struts 1.

Để làm ví dụ, mình sẽ tạo mới một Jakarta EE sử dụng Maven trong Eclipse như sau:

Nội dung của tập tin pom.xml của mình như sau:

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.huongdanjava.struts</groupId>
  <artifactId>struts1-example</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>war</packaging>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
  </properties>

  <dependencies>

    <dependency>
      <groupId>org.apache.struts</groupId>
      <artifactId>struts-core</artifactId>
      <version>1.3.10</version>
    </dependency>
    <dependency>
      <groupId>org.apache.struts</groupId>
      <artifactId>struts-taglib</artifactId>
      <version>1.3.10</version>
    </dependency>

    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>3.1.0</version>
      <scope>provided</scope>
    </dependency>

    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.13.2</version>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-war-plugin</artifactId>
        <version>3.3.2</version>
      </plugin>

      <plugin>
        <groupId>org.eclipse.jetty</groupId>
        <artifactId>jetty-maven-plugin</artifactId>
        <version>9.4.50.v20221201</version>
      </plugin>
    </plugins>
  </build>
</project>

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

<groupId>com.huongdanjava.struts</groupId>

<artifactId>struts1-example</artifactId>

<version>0.0.1-SNAPSHOT</version>

<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

<maven.compiler.source>1.8</maven.compiler.source>

<maven.compiler.target>1.8</maven.compiler.target>

</properties>

<groupId>org.apache.struts</groupId>

<artifactId>struts-core</artifactId>

</dependency>

<groupId>org.apache.struts</groupId>

<artifactId>struts-taglib</artifactId>

</dependency>

<groupId>javax.servlet</groupId>

<artifactId>javax.servlet-api</artifactId>

<scope>provided</scope>

</dependency>

<groupId>junit</groupId>

<artifactId>junit</artifactId>

</dependency>

</dependencies>

<build>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-war-plugin</artifactId>

</plugin>

<groupId>org.eclipse.jetty</groupId>

<artifactId>jetty-maven-plugin</artifactId>

</plugin>

</plugins>

</build>

</project>

Ngoài Apache Struts 1 dependencies, mình còn khai báo sử dụng Java Servlet API để làm việc với Java Servlet.

Mình cũng sử dụng Jetty server plugin phiên bản 9.x để chạy ứng dụng Java web sử dụng Java version 8!

Tương tự như các Java web framework khác như DispatcherServlet của Spring MVC, Apache Struts 1 cũng định nghĩa một class Java Servlet tên là ActionServlet extends từ class HttpServlet của Java EE để làm front controller handle tất cả các request tới ứng dụng.

Chúng ta cần khai báo ActionServlet này trong tập tin web.xml của project để đăng ký nó với Server runtime.

Ví dụ, mình khai báo như sau:

<!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>
  <display-name>Struts 1 Example</display-name>

  <servlet>
    <servlet-name>action</servlet-name>
    <servlet-class>
      org.apache.struts.action.ActionServlet
    </servlet-class>
    <load-on-startup>1</load-on-startup>
  </servlet>

  <servlet-mapping>
    <servlet-name>action</servlet-name>
    <url-pattern>*.do</url-pattern>
  </servlet-mapping>
</web-app>

<!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>

<display-name>Struts 1 Example</display-name>

<servlet-name>action</servlet-name>

<servlet-class>

org.apache.struts.action.ActionServlet

</servlet-class>

<load-on-startup>1</load-on-startup>

</servlet>

<servlet-mapping>

<servlet-name>action</servlet-name>

<url-pattern>*.do</url-pattern>

</servlet-mapping>

</web-app>

Ở đây, mình đang cấu hình để tất cả các request URL kết thúc với extension là .do sẽ được handle bởi ActionServlet của Apache Struts 1. Đây là extension được suggest bởi Apache Struts 1 các bạn nhé!

Để class ActionServlet handle request từ người dùng, chúng ta cần định nghĩa cho class ActionServlet này biết controller nào sẽ handle request nào để khi nhận được request của người dùng, nó sẽ forward request cho controller đó cho đúng.

Các bạn có thể định nghĩa các thông tin này trong tập tin struts-config.xml ở thư mục src/main/webapp/WEB-INF:

sau đó thì cấu hình để ActionServlet sử dụng tập tin này như sau trong tập tin web.xml:

<!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>
  <display-name>Struts 1 Example</display-name>

  <servlet>
    <servlet-name>action</servlet-name>
    <servlet-class>
      org.apache.struts.action.ActionServlet
    </servlet-class>
    <init-param>
      <param-name>config</param-name>
      <param-value>
        /WEB-INF/struts-config.xml
      </param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>

  <servlet-mapping>
    <servlet-name>action</servlet-name>
    <url-pattern>*.do</url-pattern>
  </servlet-mapping>
</web-app>

<!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>

<display-name>Struts 1 Example</display-name>

<servlet-name>action</servlet-name>

<servlet-class>

org.apache.struts.action.ActionServlet

</servlet-class>

<init-param>

<param-name>config</param-name>

<param-value>

/WEB-INF/struts-config.xml

</param-value>

</init-param>

<load-on-startup>1</load-on-startup>

</servlet>

<servlet-mapping>

<servlet-name>action</servlet-name>

<url-pattern>*.do</url-pattern>

</servlet-mapping>

</web-app>

Trước khi mình nói về nội dung của tập tin struts-config.xml, mình cần nói một số điều với các bạn trước:

Thứ nhất là, trong Apache Struts 1 thì các bạn định nghĩa controller bằng cách tạo mới một class extend class Action của nó.

Ví dụ mình định nghĩa một class HelloWorldAction như sau:

package com.huongdanjava.struts;

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;

public class HelloWorldAction extends Action {

  @Override
  public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request,
      HttpServletResponse response) throws Exception {
    return super.execute(mapping, form, request, response);
  }

}

package com.huongdanjava.struts;

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;

public class HelloWorldAction extends Action {

@Override

public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request,

HttpServletResponse response) throws Exception {

return super.execute(mapping, form, request, response);

}

Các bạn cần hiện thực phương thức execute() của class Action để thêm code xử lý business logic trước khi forward request tới trang hiển thị kết quả. Trong tập tin struts-config.xml, chúng ta sẽ định nghĩa request nào do controller HelloWorldAction này đảm nhận.

Thứ hai là, trong Apache Struts 1 thì class ActionForm đóng vai trò là Model trong mô hình MVC. Nó là một JavaBean class được đi kèm với một Action chứa thông tin dùng để hiển thị ở View đó các bạn!

Trong phương thức execute() trên, các bạn có thể định nghĩa một class HelloWorldForm để định nghĩa một message “Hello World from Huong Dan Java” như sau:

package com.huongdanjava.struts;

import org.apache.struts.action.ActionForm;

public class HelloWorldForm extends ActionForm {

  private static final long serialVersionUID = 1L;

  private String message;

  public String getMessage() {
    return message;
  }

  public void setMessage(String message) {
    this.message = message;
  }

}

package com.huongdanjava.struts;

import org.apache.struts.action.ActionForm;

public class HelloWorldForm extends ActionForm {

private static final long serialVersionUID = 1L;

private String message;

public String getMessage() {

return message;

}

public void setMessage(String message) {

this.message = message;

}

Dùng class HelloWorldForm này để set message “Hello World from Huong Dan Java” trong class HelloWorldAction như sau:

package com.huongdanjava.struts;

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;

public class HelloWorldAction extends Action {

  @Override
  public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request,
      HttpServletResponse response) throws Exception {

    HelloWorldForm helloWorldForm = (HelloWorldForm) form;
    helloWorldForm.setMessage("Hello World from Huong Dan Java");

    return super.execute(mapping, form, request, response);
  }

}

package com.huongdanjava.struts;

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;

public class HelloWorldAction extends Action {

@Override

public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request,

HttpServletResponse response) throws Exception {

HelloWorldForm helloWorldForm = (HelloWorldForm) form;

helloWorldForm.setMessage("Hello World from Huong Dan Java");

return super.execute(mapping, form, request, response);

}

Sau khi đã set data vào Model xong, các bạn cần select View để trả kết quả về cho user. Chúng ta sẽ định nghĩa View này trong tập tin struts-config.xml các bạn nhé!

Nội dung của tập tin struts-config.xml, mình định nghĩa như sau:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE struts-config PUBLIC 
"-//Apache Software Foundation//DTD Struts Configuration 1.3//EN" 
"http://jakarta.apache.org/struts/dtds/struts-config_1_3.dtd">

<struts-config>

  <form-beans>
    <form-bean name="helloWorldForm" type="com.huongdanjava.struts.HelloWorldForm" />
  </form-beans>

  <action-mappings>
    <action path="/helloworld" type="com.huongdanjava.struts.HelloWorldAction"
      name="helloWorldForm">
      <forward name="success" path="/helloworld.jsp" />
    </action>
  </action-mappings>

</struts-config>

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE struts-config PUBLIC

"-//Apache Software Foundation//DTD Struts Configuration 1.3//EN"

"http://jakarta.apache.org/struts/dtds/struts-config_1_3.dtd">

<struts-config>

<form-beans>

<form-bean name="helloWorldForm" type="com.huongdanjava.struts.HelloWorldForm" />

</form-beans>

<action-mappings>

<action path="/helloworld" type="com.huongdanjava.struts.HelloWorldAction"

name="helloWorldForm">

</action>

</action-mappings>

</struts-config>

Các thông tin cấu hình của Apache Struts 1 được nằm trong thẻ <struts-config>. Các bạn sử dụng thẻ <action-mapping> để mapping request và controller handle request đó. Như các bạn thấy ở trên, mình đang định nghĩa một action với path là “/helloworld” được handle bởi controller có type là HelloWorldAction. Thuộc tính name là tên của ActionForm được định nghĩa với request này. Bên trong thẻ <action>, mình còn định nghĩa thêm thẻ <forward> với tên là “success” để chỉ định sau khi xử lý thành công thì View “/helloworld.jsp” sẽ được trả về.

Các ActionForm các bạn định nghĩa trong thẻ <form-beans> như mình làm ở trên các bạn nhé!

Tập tin View helloworld.jsp có nội dung như sau:

<%@taglib uri="http://struts.apache.org/tags-bean" prefix="bean" %>
<html>

<head>
    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
    <title>Hello World</title>
</head>

<body>
    <bean:write name="helloWorldForm" property="message" />
</body>

</html>

<%@taglib uri="http://struts.apache.org/tags-bean" prefix="bean" %>

<html>

<head>

<title>Hello World</title>

</head>

<body>

<bean:write name="helloWorldForm" property="message" />

</body>

</html>

Mình đang sử dụng taglib <bean> của Apache Struts 1 để hiển thị nội dung của property message của Model HelloWorldForm. Tuỳ nhu cầu và nội dung website mà các bạn có thể sử dụng các taglib khác Apache Struts 1. Chi tiết các taglib mà Apache Struts 1 hỗ trợ, các bạn có thể tìm thấy ở đây.

Giờ thì các bạn có thể sử dụng class ActionMapping để chọn View sẽ trả về cho user như sau:

package com.huongdanjava.struts;

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;

public class HelloWorldAction extends Action {

  @Override
  public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request,
      HttpServletResponse response) throws Exception {

    HelloWorldForm helloWorldForm = (HelloWorldForm) form;
    helloWorldForm.setMessage("Hello World from Huong Dan Java");

    return mapping.findForward("success");
  }

}

package com.huongdanjava.struts;

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;

public class HelloWorldAction extends Action {

@Override

public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request,

HttpServletResponse response) throws Exception {

HelloWorldForm helloWorldForm = (HelloWorldForm) form;

helloWorldForm.setMessage("Hello World from Huong Dan Java");

return mapping.findForward("success");

}

Đến đây thì các bạn có thể chạy ứng dụng với Maven Jetty plugin và đi đến địa chỉ http://localhost:8080/helloworld.do, các bạn sẽ thấy kết quả như sau:

Tất cả các request kết thúc với extension là .do sẽ được Apache Struts 1 handle và trả về kết quả như các bạn thấy!

Khanh Nguyen

Share this post

Giới thiệu về Apache Struts 1

Add Comment Hủy