S04L07 - 添加重定向和转发

html

重构 Java Web Applications：优化 Redirects 和 Forwards
目录

介绍
理解 Redirects 和 Forwards
重构 Controllers 以增强导航
通过移除未使用的 Imports 优化您的应用程序
修改 web.xml 以兼容 Java EE
在 Controllers 中处理多个 POST 请求
测试和验证应用程序更改
重构 Java Web 应用程序的最佳实践
结论

介绍
现代 Java Web Applications 在高效导航和优化性能方面表现出色。随着应用程序的发展，管理 Redirects、Forwards 和 Controller 逻辑的复杂性也在增加。本电子书深入探讨了重构 Java Web Applications 的基本实践，以增强 Redirects 和 Forwards，确保代码更清洁、性能更佳，并提供无缝的用户体验。
重构的重要性
重构在维护和提升代码库质量方面至关重要。通过系统地重组现有代码，开发人员可以消除冗余，提高可读性，并在不改变应用程序外部行为的情况下优化性能。
本电子书的目的
本指南提供了一种全面的方法来重构 Java Web Applications，重点是有效管理 Redirects 和 Forwards。通过详细的解释、代码片段和实际示例，您将获得增强应用程序导航和性能所需的知识。

理解 Redirects 和 Forwards
什么是 Redirects 和 Forwards？
在 Java Web Applications 中，Redirects 和 Forwards 是在不同资源或页面之间导航的机制。

Redirects (sendRedirect)：指示客户端向不同的 URL 发起新的请求。这会导致客户端发起一个新的 HTTP 请求。
Forwards (RequestDispatcher.forward)：在服务器内部将控制权转移到另一个资源，而客户端并不知情。这发生在同一个 HTTP 请求中。

何时使用 Redirects 和 Forwards



特性
Redirect
Forward




客户端感知
对客户端可见
对客户端不可见


HTTP 请求
创建一个新的请求
继续同一个请求


使用场景
Post/Redirect/Get 模式，修改 URL
服务器端导航，资源包含



图示：Redirect vs. Forward




		
		
			
			
Java
			
			Client Request --> Server (Redirect) --> Client Initiates New Request --> Server Response
Client Request --> Server (Forward) --------------> Server Internally Forwards to Resource --> Server Response
			
				
					
				
					1
2
				
						Client Request --> Server (Redirect) --> Client Initiates New Request --> Server Response
Client Request --> Server (Forward) --------------> Server Internally Forwards to Resource --> Server Response
					
				
			
		



重构 Controllers 以增强导航
当前挑战
该应用程序最初直接重定向到 member.jsp，绕过了 Controller 逻辑。这可能导致代码紧密耦合，并在管理导航路径时遇到困难。
目标
重构应用程序，通过 Controllers 处理所有导航，消除直接访问 JSP，提高可维护性。
逐步重构
1. 移除直接重定向到 JSP 页面
避免直接重定向到 JSP 页面。相反，使用 Controller 操作来管理导航。
重构前：




		
		
			
			
Java
			
			response.sendRedirect("member.jsp");
			
				
					
				
					1
				
						response.sendRedirect("member.jsp");
					
				
			
		


重构后：




		
		
			
			
Java
			
			request.getRequestDispatcher("member.jsp").forward(request, response);
			
				
					
				
					1
				
						request.getRequestDispatcher("member.jsp").forward(request, response);
					
				
			
		


2. 更新 SiteController.java
修改 SiteController 以处理操作并适当地转发请求。
重构后的 SiteController.java：




		
		
			
			
Java
			
			package org.studyeasy;

import javax.servlet.*;
import javax.servlet.http.*;
import java.io.IOException;

public class SiteController extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) 
            throws ServletException, IOException {
        String action = request.getParameter("action");
        switch (action) {
            case "login":
                request.getRequestDispatcher("login.jsp").forward(request, response);
                break;
            case "member.area":
                request.getRequestDispatcher("member.jsp").forward(request, response);
                break;
            default:
                request.getRequestDispatcher("index.jsp").forward(request, response);
                break;
        }
    }

    @Override
    protected void doPost(HttpServletRequest request, HttpServletResponse response) 
            throws ServletException, IOException {
        authenticate(request, response);
    }

    private void authenticate(HttpServletRequest request, HttpServletResponse response) 
            throws ServletException, IOException {
        String action = request.getParameter("action");
        switch (action) {
            case "authenticate":
                String username = request.getParameter("username");
                String password = request.getParameter("password");
                // Authentication logic here
                if (validateUser(username, password)) {
                    response.sendRedirect("member.area");
                } else {
                    request.setAttribute("error", "Invalid credentials.");
                    request.getRequestDispatcher("login.jsp").forward(request, response);
                }
                break;
            default:
                request.getRequestDispatcher("index.jsp").forward(request, response);
                break;
        }
    }

    private boolean validateUser(String username, String password) {
        // Implement user validation logic
        return "admin".equals(username) && "password".equals(password);
    }
}
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
				
						package org.studyeasy;
 
import javax.servlet.*;
import javax.servlet.http.*;
import java.io.IOException;
 
public class SiteController extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) 
            throws ServletException, IOException {
        String action = request.getParameter("action");
        switch (action) {
            case "login":
                request.getRequestDispatcher("login.jsp").forward(request, response);
                break;
            case "member.area":
                request.getRequestDispatcher("member.jsp").forward(request, response);
                break;
            default:
                request.getRequestDispatcher("index.jsp").forward(request, response);
                break;
        }
    }
 
    @Override
    protected void doPost(HttpServletRequest request, HttpServletResponse response) 
            throws ServletException, IOException {
        authenticate(request, response);
    }
 
    private void authenticate(HttpServletRequest request, HttpServletResponse response) 
            throws ServletException, IOException {
        String action = request.getParameter("action");
        switch (action) {
            case "authenticate":
                String username = request.getParameter("username");
                String password = request.getParameter("password");
                // Authentication logic here
                if (validateUser(username, password)) {
                    response.sendRedirect("member.area");
                } else {
                    request.setAttribute("error", "Invalid credentials.");
                    request.getRequestDispatcher("login.jsp").forward(request, response);
                }
                break;
            default:
                request.getRequestDispatcher("index.jsp").forward(request, response);
                break;
        }
    }
 
    private boolean validateUser(String username, String password) {
        // Implement user validation logic
        return "admin".equals(username) && "password".equals(password);
    }
}
					
				
			
		


关键更改：

在 doGet 和 authenticate 方法中引入了 switch-case 结构，以处理不同的操作。
确保所有导航通过 Controllers 管理，避免直接访问 JSP。

重构 Controllers 的好处

可维护性：集中的导航逻辑简化了更新和维护。
安全性：防止未经授权的直接访问 JSP 页面。
可扩展性：随着应用程序的增长，更容易管理额外的操作和导航路径。


通过移除未使用的 Imports 优化您的应用程序
干净代码的重要性
未使用的 imports 会使您的代码库混乱，导致混淆和潜在的性能问题。移除它们可以增强可读性，并稍微提高编译时间。
识别未使用的 Imports
检查您的 Java 类，以识别并消除未使用的 imports。
清理前：




		
		
			
			
Java
			
			import javax.servlet.*;
import javax.servlet.http.*;
import java.io.IOException;
import java.util.List; // Unused import

public class SiteController extends HttpServlet {
    // Class content
}
			
				
					
				
					1
2
3
4
5
6
7
8
				
						import javax.servlet.*;
import javax.servlet.http.*;
import java.io.IOException;
import java.util.List; // Unused import
 
public class SiteController extends HttpServlet {
    // Class content
}
					
				
			
		


清理后：




		
		
			
			
Java
			
			import javax.servlet.*;
import javax.servlet.http.*;
import java.io.IOException;

public class SiteController extends HttpServlet {
    // Class content
}
			
				
					
				
					1
2
3
4
5
6
7
				
						import javax.servlet.*;
import javax.servlet.http.*;
import java.io.IOException;
 
public class SiteController extends HttpServlet {
    // Class content
}
					
				
			
		


自动化清理
大多数集成开发环境 (IDEs) 如 Eclipse 或 IntelliJ IDEA 提供自动组织 imports 的功能：

Eclipse：Ctrl + Shift + O
IntelliJ IDEA：Ctrl + Alt + O

最佳实践

定期审查 Imports：在开发过程中养成清理 imports 的习惯。
使用 IDE 功能：利用 IDE 的功能有效管理 imports。
避免使用通配符 Imports：指定所需的类以防止不必要的 imports。


修改 web.xml 以兼容 Java EE
理解 web.xml
web.xml 是 Java Web Applications 的部署描述符。它定义了 servlets、servlet 映射以及应用程序运行所需的其他配置。
从 J2EE 迁移到 Java EE
该项目最初使用 J2EE，这可能针对特定的商业版本。迁移到 Java EE 确保了更好的兼容性和对最新功能的访问。
原始 web.xml：




		
		
			
			
Java
			
			&lt;web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" 
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee 
                             http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">
    &lt;!-- Configuration -->
&lt;/web-app>
			
				
					
				
					1
2
3
4
5
6
7
				
						&lt;web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" 
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee 
                             http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">
    &lt;!-- Configuration -->
&lt;/web-app>
					
				
			
		


修改后的 web.xml：




		
		
			
			
Java
			
			&lt;web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" 
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee 
                             http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
    &lt;!-- Updated Configuration -->
&lt;/web-app>
			
				
					
				
					1
2
3
4
5
6
7
				
						&lt;web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" 
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee 
                             http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
    &lt;!-- Updated Configuration -->
&lt;/web-app>
					
				
			
		


关键更改

命名空间更新：确保 XML 命名空间对应于 Java EE。
Schema 位置：将 schema 位置更新为所需的 Java EE 版本（例如，4.0）。
版本号：在 <web-app> 标签中反映正确的版本。

更新 web.xml 的好处

兼容性：与最新的 Java EE 标准保持一致。
访问新功能：启用使用较新的规范和功能。
避免弃用问题：防止因过时配置引起的潜在问题。


在 Controllers 中处理多个 POST 请求
挑战
在单个 doPost 方法中管理多个表单提交可能变得令人头疼，导致代码复杂且难以维护。
目标
重构 doPost 方法，使用结构化方法高效处理多个操作。
实现 Switch-Case 结构
原始 doPost 方法：




		
		
			
			
Java
			
			@Override
protected void doPost(HttpServletRequest request, HttpServletResponse response) 
        throws ServletException, IOException {
    // Single form handling logic
}
			
				
					
				
					1
2
3
4
5
				
						@Override
protected void doPost(HttpServletRequest request, HttpServletResponse response) 
        throws ServletException, IOException {
    // Single form handling logic
}
					
				
			
		


重构后的 doPost 方法：




		
		
			
			
Java
			
			@Override
protected void doPost(HttpServletRequest request, HttpServletResponse response) 
        throws ServletException, IOException {
    String action = request.getParameter("action");
    switch (action) {
        case "authenticate":
            authenticate(request, response);
            break;
        // Additional cases for other forms
        default:
            request.getRequestDispatcher("index.jsp").forward(request, response);
            break;
    }
}
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
				
						@Override
protected void doPost(HttpServletRequest request, HttpServletResponse response) 
        throws ServletException, IOException {
    String action = request.getParameter("action");
    switch (action) {
        case "authenticate":
            authenticate(request, response);
            break;
        // Additional cases for other forms
        default:
            request.getRequestDispatcher("index.jsp").forward(request, response);
            break;
    }
}
					
				
			
		


为表单添加标识符
为了区分提交的是哪个表单，添加一个隐藏输入字段来指定操作。
在 login.jsp 中的示例：




		
		
			
			
Java
			
			&lt;form action="site.controller" method="post"&gt;
    &lt;input type="hidden" name="action" value="authenticate"&gt;
    &lt;label for="username"&gt;Username:&lt;/label&gt;
    &lt;input type="text" id="username" name="username" required&gt;
    
    &lt;label for="password"&gt;Password:&lt;/label&gt;
    &lt;input type="password" id="password" name="password" required&gt;
    
    &lt;button type="submit"&gt;Login&lt;/button&gt;
&lt;/form&gt;
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
				
						&lt;form action="site.controller" method="post"&gt;
    &lt;input type="hidden" name="action" value="authenticate"&gt;
    &lt;label for="username"&gt;Username:&lt;/label&gt;
    &lt;input type="text" id="username" name="username" required&gt;
    
    &lt;label for="password"&gt;Password:&lt;/label&gt;
    &lt;input type="password" id="password" name="password" required&gt;
    
    &lt;button type="submit"&gt;Login&lt;/button&gt;
&lt;/form&gt;
					
				
			
		


详细解释

Action 参数：每个表单包含一个隐藏的 action 参数，以识别表单提交。
Switch-Case 处理：doPost 方法使用 switch-case 根据 action 路由请求。
模块化方法：每个案例将处理委托给特定的方法（例如 authenticate），增强代码组织。

带注释的代码片段




		
		
			
			
Java
			
			private void authenticate(HttpServletRequest request, HttpServletResponse response) 
        throws ServletException, IOException {
    // 从表单检索用户名和密码
    String username = request.getParameter("username");
    String password = request.getParameter("password");
    
    // 验证用户凭证
    if (validateUser(username, password)) {
        // 成功验证后重定向到成员区域
        response.sendRedirect("member.area");
    } else {
        // 设置错误消息并转发回登录页面
        request.setAttribute("error", "Invalid credentials.");
        request.getRequestDispatcher("login.jsp").forward(request, response);
    }
}
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
				
						private void authenticate(HttpServletRequest request, HttpServletResponse response) 
        throws ServletException, IOException {
    // 从表单检索用户名和密码
    String username = request.getParameter("username");
    String password = request.getParameter("password");
    
    // 验证用户凭证
    if (validateUser(username, password)) {
        // 成功验证后重定向到成员区域
        response.sendRedirect("member.area");
    } else {
        // 设置错误消息并转发回登录页面
        request.setAttribute("error", "Invalid credentials.");
        request.getRequestDispatcher("login.jsp").forward(request, response);
    }
}
					
				
			
		


这种方法的好处

可扩展性：通过引入额外的案例，轻松添加新的表单处理程序。
可读性：不同操作的逻辑清晰分离。
可维护性：简化调试和未来的增强。


测试和验证应用程序更改
彻底测试的重要性
重构可能引入意想不到的问题。严格的测试确保应用程序在重构后按预期运行。
测试步骤

单元测试

测试各个方法（例如 validateUser），以确保它们正常工作。


集成测试

验证应用程序的不同部分在更改后是否无缝互动。


手动测试

执行诸如登录和登出等用户流程，以观察行为。


自动化测试

实施自动化测试以持续验证功能。



验证清单



测试用例
预期结果




有效登录
成功重定向到成员区域


无效登录
在登录页面显示错误消息


直接访问 member.jsp
重定向到登录或拒绝访问


登出功能
成功登出并适当重定向


处理未知操作
无错误地转发到首页



示例测试场景

尝试使用有效凭证登录

输入：用户名：admin，密码：password
预期输出：重定向到 member.area 显示成员区域。


尝试使用无效凭证登录

输入：用户名：user，密码：wrongpassword
预期输出：停留在 login.jsp 并显示错误消息："Invalid credentials."


直接访问 member.jsp 

操作：在未经认证的情况下导航到 member.jsp。
预期输出：重定向到 login.jsp 或显示访问被拒绝的消息。


登出过程

操作：点击登出链接/按钮。
预期输出：成功登出并重定向到主页。



调试常见问题

重定向错误：确保 sendRedirect 和 getRequestDispatcher 中的 URL 是正确的。
会话管理：验证在登录和登出期间用户会话是否得到适当处理。
参数处理：确认表单参数命名和检索是否正确。


重构 Java Web 应用程序的最佳实践
1. 在重构前进行规划

了解当前结构：分析现有代码以识别需要改进的区域。
设定明确的目标：定义通过重构希望实现的目标，如性能提升或更好的代码组织。

2. 保持一致的命名规范

清晰性：使用描述性的名称为变量、方法和类，以增强可读性。
一致性：在整个项目中坚持使用单一的命名规范，以防止混淆。

3. 模块化代码

单一职责原则：确保每个类或方法具有单一、明确定义的目的。
可重用性：设计可以在应用程序不同部分重用的模块。

4. 移除死代码和未使用的 Imports

清洁度：消除永不执行的代码或未使用的 imports。
性能：减少不必要的代码可以略微提升应用程序性能并缩短构建时间。

5. 实施适当的错误处理

优雅失败：确保应用程序能优雅地处理错误而不会崩溃。
日志记录：实现日志记录机制，以高效地跟踪和调试问题。

6. 利用版本控制

备份：使用 Git 等版本控制系统跟踪更改并在必要时回滚。
协作：促进多个开发人员在同一项目上协作。

7. 编写文档和注释

清晰性：记录复杂逻辑，并在必要时提供注释。
维护性：良好记录的代码更易于未来的维护和更新。

8. 广泛测试

自动化测试：实施单元和集成测试以验证功能。
手动测试：执行手动测试以确保重构后用户体验保持顺畅。

9. 逐步迭代

小范围更改：进行渐进式更改，而不是大规模修改，以有效管理风险。
持续改进：定期审查和优化代码库以保持质量。


结论
重构 Java Web Applications 是维护干净、高效和可扩展代码库的关键实践。通过专注于优化 Redirects 和 Forwards、移除未使用的 Imports 以及增强 Controller 逻辑，开发人员可以显著提升应用程序的性能和可维护性。遵循最佳实践确保您的应用程序保持稳健，并能适应不断变化的需求。
关键要点

集中导航逻辑：利用 Controllers 管理所有 Redirects 和 Forwards，增强安全性和可维护性。
优化 Imports：定期清理未使用的 Imports，以保持代码清晰并优化性能。
更新配置文件：确保 web.xml 与最新的 Java EE 标准对齐，以利用新功能并保持兼容性。
结构化请求处理：在 Controllers 中实现 switch-case 结构，以高效管理多个 POST 请求。
彻底测试：通过全面的测试验证所有更改，以确保应用程序的稳定性。

通过实施这些策略，开发人员可以创建不仅功能齐全，而且高效且易于管理的 Java Web Applications。
注意：本文为 AI 生成。
特性	Redirect	Forward
客户端感知	对客户端可见	对客户端不可见
HTTP 请求	创建一个新的请求	继续同一个请求
使用场景	Post/Redirect/Get 模式，修改 URL	服务器端导航，资源包含
测试用例	预期结果
有效登录	成功重定向到成员区域
无效登录	在登录页面显示错误消息
直接访问 member.jsp	重定向到登录或拒绝访问
登出功能	成功登出并适当重定向
处理未知操作	无错误地转发到首页