Spring 重定向教程

Spring 重定向教程展示了如何在 Spring Web 应用中重定向请求。

Spring 是用于创建企业应用的流行 Java 应用框架。

重定向

视图名称中的特殊redirect:前缀将重定向到其他 URL。 最终效果与控制器已返回RedirectView的效果相同。 重定向应用于发布/重定向/获取（PRG）场景； PGR 是一种 Web 开发设计模式，可防止重复提交表单。 默认情况下，发送状态代码 302。 如果要更改，可以使用@ResponseStatus注释处理程序方法的返回类型。

RedirectAttributes是 Model 接口的一种特殊化，控制器可以用来选择重定向方案的属性。

重定向与转发

基本上可以通过三种方式处理请求：a）由 Spring 在控制器动作中解决，b）转发至其他控制器动作，c）重定向至客户端以获取另一个 URL。

向前：

重定向：

Spring Redirect 示例

提交表单后，以下应用使用重定向到其他 URL。 它使用redirect:前缀执行重定向。

pom.xmlsrc├───main│   ├───java│   │   └───com│   │       └───zetcode│   │           ├───bean│   │           │       User.java│   │           ├───config│   │           │       MyWebInitializer.java│   │           │       WebConfig.java│   │           └───controller│   │                   MyController.java│   └───resources│       │   logback.xml│       ││       └───templates│               addUser.html│               showUserAdded.html└───test    └───java

这是项目结构。

pom.xml

<?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.zetcode</groupId>    <artifactId>springredirectex</artifactId>    <version>1.0-SNAPSHOT</version>    <packaging>war</packaging>    <properties>        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>        <maven.compiler.source>11</maven.compiler.source>        <maven.compiler.target>11</maven.compiler.target>        <spring-version>5.1.3.RELEASE</spring-version>    </properties>    <dependencies>        <dependency>            <groupId>ch.qos.logback</groupId>            <artifactId>logback-classic</artifactId>            <version>1.2.3</version>        </dependency>        <dependency>            <groupId>javax.servlet</groupId>            <artifactId>javax.servlet-api</artifactId>            <version>4.0.1</version>            <scope>provided</scope>        </dependency>        <dependency>            <groupId>org.springframework</groupId>            <artifactId>spring-webmvc</artifactId>            <version>5.1.3.RELEASE</version>        </dependency>        <dependency>            <groupId>org.thymeleaf</groupId>            <artifactId>thymeleaf-spring5</artifactId>            <version>3.0.11.RELEASE</version>        </dependency>        <dependency>            <groupId>org.thymeleaf</groupId>            <artifactId>thymeleaf</artifactId>            <version>3.0.11.RELEASE</version>        </dependency>    </dependencies>    <build>        <plugins>            <plugin>                <groupId>org.apache.maven.plugins</groupId>                <artifactId>maven-war-plugin</artifactId>                <version>3.2.2</version>            </plugin>            <plugin>                <groupId>org.eclipse.jetty</groupId>                <artifactId>jetty-maven-plugin</artifactId>                <version>9.4.14.v20181114</version>            </plugin>        </plugins>    </build></project>

在pom.xml中，我们具有必要的依赖性。

resources/logback.xml

<?xml version="1.0" encoding="UTF-8"?><configuration>    <logger name="org.springframework" level="ERROR"/>    <logger name="com.zetcode" level="INFO"/>    <appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">        <encoder>            <Pattern>%d{HH:mm:ss.SSS} %blue(%-5level) %magenta(%logger{36}) - %msg %n            </Pattern>        </encoder>    </appender>    <root>        <level value="INFO" />        <appender-ref ref="consoleAppender" />    </root></configuration>

logback.xml是 Logback 日志库的配置文件。

com/zetcode/config/MyWebInitializer.java

package com.zetcode.config;import org.springframework.context.annotation.Configuration;import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;@Configurationpublic class MyWebInitializer extends        AbstractAnnotationConfigDispatcherServletInitializer {    @Override    protected Class<?>[] getRootConfigClasses() {        return null;    }    @Override    protected Class<?>[] getServletConfigClasses() {        return new Class[]{WebConfig.class};    }    @Override    protected String[] getServletMappings() {        return new String[]{"/"};    }}

MyWebInitializer注册 Spring DispatcherServlet，它是 Spring Web 应用的前端控制器。

@Overrideprotected Class<?>[] getServletConfigClasses() {    return new Class[]{WebConfig.class};}

getServletConfigClasses()返回 Web 配置类。

com/zetcode/config/WebConfig.java

package com.zetcode.config;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.context.ApplicationContext;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.ComponentScan;import org.springframework.context.annotation.Configuration;import org.springframework.web.servlet.ViewResolver;import org.springframework.web.servlet.config.annotation.EnableWebMvc;import org.springframework.web.servlet.config.annotation.ViewResolverRegistry;import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;import org.thymeleaf.spring5.SpringTemplateEngine;import org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver;import org.thymeleaf.spring5.view.ThymeleafViewResolver;@Configuration@EnableWebMvc@ComponentScan(basePackages = {"com.zetcode"})public class WebConfig implements WebMvcConfigurer {    @Autowired    private ApplicationContext applicationContext;    @Bean    public SpringResourceTemplateResolver templateResolver() {        var templateResolver = new SpringResourceTemplateResolver();        templateResolver.setApplicationContext(applicationContext);        templateResolver.setPrefix("classpath:/templates/");        templateResolver.setSuffix(".html");        return templateResolver;    }    @Bean    public SpringTemplateEngine templateEngine() {        var templateEngine = new SpringTemplateEngine();        templateEngine.setTemplateResolver(templateResolver());        templateEngine.setEnableSpringELCompiler(true);        return templateEngine;    }    @Bean    public ViewResolver viewResolver() {        var resolver = new ThymeleafViewResolver();        var registry = new ViewResolverRegistry(null, applicationContext);        resolver.setTemplateEngine(templateEngine());        registry.viewResolver(resolver);        return resolver;    }}

WebConfig配置 Thymeleaf 模板引擎。 我们将模板文件的位置设置为 classpath 上的templates目录。 （resources在类路径上。）

com/zetcode/bean/User.java

package com.zetcode.bean;public class User {    private String name;    private String occupation;    public String getName() {        return name;    }    public void setName(String name) {        this.name = name;    }    public String getOccupation() {        return occupation;    }    public void setOccupation(String occupation) {        this.occupation = occupation;    }    @Override    public String toString() {        final StringBuilder sb = new StringBuilder("User{");        sb.append("name='").append(name).append('\'');        sb.append(", occupation='").append(occupation).append('\'');        sb.append('}');        return sb.toString();    }}

这是User bean。 它填充有来自表单的数据。

com/zetcode/controller/MyController.java

package com.zetcode.controller;import com.zetcode.bean.User;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.PostMapping;import org.springframework.web.servlet.mvc.support.RedirectAttributes;@Controllerpublic class MyController {    private static final Logger logger = LoggerFactory.getLogger(MyController.class);    @GetMapping("/addUser")    public String sendForm(User user) {        return "addUser";    }    @PostMapping("/addUser")    public String processForm(User user, RedirectAttributes redirectAttrs) {        logger.info("User {} has been saved", user.getName());        redirectAttrs.addAttribute("name", user.getName());        return "redirect:userAdded";    }    @GetMapping("/userAdded")    public String userAdded() {        return "showUserAdded";    }}

MyController提供请求路径和处理程序方法之间的映射。

@GetMapping("/addUser")public String sendForm(User user) {    return "addUser";}

该映射将表单发送给用户。

@PostMapping("/addUser")public String processForm(User user, RedirectAttributes redirectAttrs) {    logger.info("User {} has been saved", user.getName());    redirectAttrs.addAttribute("name", user.getName());    return "redirect:userAdded";}

此映射处理表单。 新用户被“保存”并执行重定向。 用户名通过addAttribute()添加到重定向属性中。

resources/templates/addUser.html

<!DOCTYPE HTML><html xmlns:th="http://www.thymeleaf.org"><head>    <title>Add user</title>    <meta charset="UTF-8">    <meta name="viewport" content="width=device-width, initial-scale=1"></head><body><h1>Add User</h1><form action="#" th:action="@{/addUser}" th:object="${user}" method="post">    <p>        Name: <input type="text" th:field="*{name}">    </p>    <p>        Occupation: <input type="text" th:field="*{occupation}">    </p>    <p>        <input type="submit" value="Submit"/> <input type="reset" value="Reset">    </p></form></body></html>

addUser.html模板向用户提供表格。 输入的字段将自动插入到User's属性中。

resources/templates/showUserAdded.html

<!DOCTYPE HTML><html xmlns:th="http://www.thymeleaf.org"><head>    <title>User saved</title>    <meta charset="UTF-8">    <meta name="viewport" content="width=device-width, initial-scale=1"></head><body><h2>User has been saved</h2><p th:text="'Name: ' + ${#request.getParameter('name')}"></p><a href="/addUser">Add another user</a></body></html>

提交表单后，此模板向用户显示一条消息。 它使用${#request.getParameter('name')}读取 redirect 属性。

$ mvn jetty:run

我们运行服务器并找到localhost:8080/addUser。

在本教程中，我们在 Spring 控制器中执行了重定向。