Spring 重定向教程 · ZetCode 中文系列教程

# Spring 重定向教程 > 原文： [http://zetcode.com/spring/redirect/](http://zetcode.com/spring/redirect/) Spring 重定向教程展示了如何在 Spring Web 應用中重定向請求。 Spring 是用于創建企業應用的流行 Java 應用框架。 ## 重定向視圖名稱中的特殊`redirect:`前綴將重定向到其他 URL。最終效果與控制器已返回`RedirectView`的效果相同。重定向應用于發布/重定向/獲取（PRG）場景； PGR 是一種 Web 開發設計模式，可防止重復提交表單。默認情況下，發送狀態代碼 302。如果要更改，可以使用`@ResponseStatus`注解處理器方法的返回類型。 `RedirectAttributes`是`Model`接口的一種特殊化，控制器可以用來選擇重定向方案的屬性。 ## 重定向與轉發基本上可以通過三種方式處理請求：a）由 Spring 在控制器動作中解決，b）轉發至其他控制器動作，c）重定向至客戶端以獲取另一個 URL。向前： * 由 Spring 內部執行 * 瀏覽器完全不知道轉發，因此其原始 URL 保持不變 * 瀏覽器重新加載結果頁面會重復原始請求，并帶有原始 URL * 請求中發送的數據可用于轉發的操作重定向： * 是一個兩步過程 * Spring 指示瀏覽器獲取另一個 URL，該 URL 與原始 URL 不同 * 瀏覽器重新加載第二個 URL 不會重復原始請求，而是獲取第二個 URL * 在原始請求范圍內發送的數據不適用于第二個請求 ## Spring 重定向示例提交表單后，以下應用使用重定向到其他 URL。它使用`redirect:`前綴執行重定向。 ```java pom.xml src ├───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` ```java <?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` ```java <?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` ```java package com.zetcode.config; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer; @Configuration public 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 應用的前端控制器。 ```java @Override protected Class<?>[] getServletConfigClasses() { return new Class[]{WebConfig.class}; } ``` `getServletConfigClasses()`返回 Web 配置類。 `com/zetcode/config/WebConfig.java` ```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` ```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` ```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; @Controller public 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`提供請求路徑和處理器方法之間的映射。 ```java @GetMapping("/addUser") public String sendForm(User user) { return "addUser"; } ``` 該映射將表單發送給用戶。 ```java @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` ```java <!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` ```java <!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`屬性。 ```java $ mvn jetty:run ``` 我們運行服務器并找到`localhost:8080/addUser`。在本教程中，我們在 Spring 控制器中執行了重定向。您可能也對這些相關教程感興趣： [Spring 轉發教程](/spring/forward/)， [Java 教程](/lang/java/)或列出[所有 Spring 教程](/all/#spring)。