sprintbool 重定向，自定义ResponseEntity 重定向例子

怼烎@ 2022-11-02 11:35 198阅读 0赞

# 1、了解重定向 #

参考我另外一个博客：[https://blog.csdn.net/zzhongcy/article/details/22413681][https_blog.csdn.net_zzhongcy_article_details_22413681]

**3\*\*(重定向类)：为了完成指定的动作，必须接受进一步处理**  
    300——请求的资源可在多处得到  
    **301——本网页被永久性转移到另一个URL**  
    302——请求的网页被转移到一个新的地址，但客户访问仍继续通过原始URL地址，重定向，新的URL会在response中的Location中返回，浏览器将会使用新的URL发出新的Request。  
    303——建议客户访问其他URL或访问方式  
    304——自从上次请求后，请求的网页未修改过，服务器返回此响应时，不会返回网页内容，代表上次的文档已经被缓存了，还可以继续使用  
    305——请求的资源必须从服务器指定的地址得到  
    306——前一版本HTTP中使用的代码，现行版本中不再使用  
    307——申明请求的资源临时性删除

# 2、SpringBoot的redirect 和 forward #

Web UI项目中, 很多 Spring controller 视图函数直接返回 html 页面, 还有一些视图函数是要重定向或转发到其他的 url 上.

## 2.1 redirect 和 forward的区别: ##

重定向 redirect: 完整的重定向包含两次request-response过程, 第一次是访问原始url, 第二次是服务器通知客户端访问重定向后的url. 重定向完成后, 浏览器的地址是重定向后的url, 而不是原始的url.  
    重定向的使用场景: 因为重定向会修改浏览器地址, 所以 form 提交应该使用重定向, 以免用户刷新页面导致form重复提交.

转发 forward: 完整的转发仅包含一次 request-response 过程, 用户发出request后, 服务器端视图函数先处理自己的逻辑, 然后在服务器端有调用另一个视图函数, 最后将response返回给浏览器.

##    2.2 转发 forward ##

==============================  
在Spring MVC 中, 构建forward 目标有两种方式:  
1. 以字符串的形式构建目标url, url 需要加上 forward: 前缀  
2. 使用 ModelAndView 对象来设置转发的forward目标, viewName 可以省略 forward: 前缀, viewName 应该是目标url, 而不是目标视图的函数名.  
传参方式:  
1. 以字符串的形式构建目标url, 可以使用 query variable的格式拼url  
2. 使用 ModelAndView 对象来增加 attribute Object, 其结果也是在拼接url.   
取参的方式: 可以使用 @RequestParam 来取参.

##    2.3 重定向 redirect ##

==============================

### redirect 目标有多种构建方式 ###

1. 使用 redirect: 前缀url方式构建目标url

public String updateOrAddProject() {
       return "redirect:http://www.baidu.com?参数名="+参数值;
    }

2. 使用 RedirectView 类型指定目标, 推荐使用这个,

@Controller
    @RequestMapping("/")
    public class RedirectController {
         
        @GetMapping("/redirectWithRedirectView")
        public RedirectView redirectWithUsingRedirectView(RedirectAttributes attributes) {
            attributes.addFlashAttribute("flashAttribute", "redirectWithRedirectView");
            attributes.addAttribute("attribute", "redirectWithRedirectView");
            return new RedirectView("redirectedUrl");
        }
    }

3. 使用 ModelAndView 类型指定目标, ModelAndView 视图名默认是forward, 所以对于redirect, 需要加上 redirect: 前缀

注明：**可以指定tAttribute**

@PostMapping("/redirectPostToPost")
    public ModelAndView redirectPostToPost(HttpServletRequest request) {
        request.setAttribute(View.RESPONSE_STATUS_ATTRIBUTE, HttpStatus.TEMPORARY_REDIRECT);
        return new ModelAndView("redirect:http://www.baidu.com");
    }
    
    
    
    @GetMapping("/redirectedUrl")
    public ModelAndView redirection(
      ModelMap model, 
      @ModelAttribute("flashAttribute") Object flashAttribute) 
     {
         model.addAttribute("redirectionAttribute", flashAttribute);
         return new ModelAndView("http://www.baidu.com", model);
     }

4.使用HttpServletResponse 的sendRedirect方法直接redirect，方便跳转外网，并可以携带参数，返回302状态

public void testRed(HttpServletResponse response) throws Exception{
        response.sendRedirect("https://www.baidu.com");
    }

5.使用ResponseEntity返回

@GetMapping("/redirectedUrl")
    public ResponseEntity redirection(HttpServletRequest request,
                                     HttpServletResponse response) 
     {
         HttpHeaders headers = new HttpHeaders();
         headers.setLocation(new URI(""https://www.baidu.com""));
         ResponseEntity redirectEntity = new ResponseEntity(null, headers, HttpStatus.TEMPORARY_REDIRECT);
         return redirectEntity;
     }

**返回其它状态：**

浏览器对相应的状态码的响应(这里只给出了几个3开头的)是：   
302 作为HTTP1.0的标准,以前叫做Moved Temporarily ,现在叫Found. 现在使用只是为了兼容性的处理,response.sendRedirect()的默认Location重定向用的是302.   
但是HTTP 1.1 有303 和307作为详细的补充,其实是对302的细化   
303：对于POST请求，它表示请求已经被处理，客户端可以接着使用GET方法去请求Location里的URI。   
**307：对于POST请求，表示请求还没有被处理，客户端应该向Location里的URI重新发起POST请求。 **  
  
浏览器对302的响应，默认情况下，使用HTTP协议的GET方法提交请求，最初请求的内容（比如 POST 参数）也就丢失了。   
所以response.sendRedirect()是不能让浏览器来以post方法提交请求的。   
  
你想在servlet中用post传参数，在浏览器支持HTTP1.1的情况下可以设置状态码为307：

**如果想返回其它状态如307，可以设置status**

public void testRed(HttpServletResponse response) throws Exception{
        response.setStatus(307);  
        response.setHeader("Location", "OtherServlet");  
    }

### 传参和取参方式: ###

1. 传参: 以字符串的形式构建目标url, 可以使用 query variable的格式拼url. 取参: @RequestParam()来fetch  
2. 传参: redirectAttributes.addAttribute() 加的attr. 取参: @RequestParam()来fetch  
3. 传参: redirectAttributes.addFlashAttribute() 加的attr. 取参: @ModelAttribute()来fetch

### Flash attribute的特点: ###

1. addFlashAttribute() 可以是任意类型的数据(不局限在String等基本类型), addAttribute()只能加基本类型的参数.  
2. addFlashAttribute() 加的 attr, 不会出现在url 地址栏上.  
3. addFlashAttribute() 加的 attr, 一旦fetch后, 就会自动清空, 非常适合 form 提交后 feedback Message.

# 4、例子 #

@Controller
    @RequestMapping("/")
    public class DemoController {
    
        /*
         * forward 示例: 以字符串的形式构建目标url, url 需要加上 forward: 前缀
         * */
        @RequestMapping("/forwardTest1")
        public String forwardTest1() {
            return "forward:/forwardTarget?param1=v1&param2=v2";
        }
    
    
        /*
         * forward 示例: 使用 ModelAndView() 设置转发的目标url
         * */
        @RequestMapping("/forwardTest2")
        public ModelAndView forwardTest2() {
            ModelAndView mav=new ModelAndView("/forwardTarget"); // 绝对路径OK
            //ModelAndView mav=new ModelAndView("forwardTarget"); // 相对路径也OK
            mav.addObject("param1", "value1");
            mav.addObject("param2", "value2");
            return mav ;
        }
    
        @RequestMapping("/forwardTarget")
        public String forwardTargetView(Model model, @RequestParam("param1") String param1,
                @RequestParam("param2") String param2) {
            model.addAttribute("param1", param1);
            model.addAttribute("param2", param2);
            return "forwardTarget";
        }
    
    
        /*
         * redirect 目标有三种构建方式
         * 1. 使用 redirect: 前缀url方式构建目标url
         * 2. 使用 RedirectView 类型指定目标
         * 3. 使用 ModelAndView 类型指定目标, ModelAndView 视图名默认是forward, 所以对于redirect, 需要加上 redirect: 前缀
         * */
        @RequestMapping("/noParamRedirect")
        public RedirectView noParamTest() {
            RedirectView redirectTarget = new RedirectView();
            redirectTarget.setContextRelative(true);
            redirectTarget.setUrl("noParamTarget");
            return redirectTarget;
        }
    
        @RequestMapping("/noParamTarget")
        public String redirectTarget() {
            return "noParamTarget";
        }
    
        @RequestMapping("/withParamRedirect")
        public RedirectView withParamRedirect(RedirectAttributes redirectAttributes) {
            RedirectView redirectTarget = new RedirectView();
            redirectTarget.setContextRelative(true);
            redirectTarget.setUrl("withParamTarget");
    
            redirectAttributes.addAttribute("param1", "value1");
            redirectAttributes.addAttribute("param2", "value2");
            return redirectTarget;
        }
    
        @RequestMapping("/withParamTarget")
        public String withParamTarget(Model model, @RequestParam("param1") String param1,
                @RequestParam("param2") String param2) {
            model.addAttribute("param1", param1);
            model.addAttribute("param2", param2);
            return "withParamTarget";
        }
    
        @RequestMapping("/withFlashRedirect")
        public RedirectView withFlashTest(RedirectAttributes redirectAttributes) {
            RedirectView redirectTarget = new RedirectView();
            redirectTarget.setContextRelative(true);
            redirectTarget.setUrl("withFlashTarget");
    
            redirectAttributes.addAttribute("param", "value");
            redirectAttributes.addFlashAttribute("flashParam", "flashValue");
            return redirectTarget;
        }
    
    
        /*
         * redirectAttributes.addAttribute加的attr, 使用 @RequestParam()来fetch
         * redirectAttributes.addFlashAttribute()加的attr, 使用 @ModelAttribute()来fetch
         * */
        @RequestMapping("/withFlashTarget")
        public String withFlashTarget(Model model, @RequestParam("param") String param,
                @ModelAttribute("flashParam") String flashParam) {
            model.addAttribute("param", param);
            model.addAttribute("flashParam", flashParam);
            return "withFlashTarget";
        }
    
    
    
        @GetMapping("/input")
        public String input() {
            return "input";
        }
    
        /*
         * form 提交后, 如果form数据有问题, 使用redirectAttributes.addFlashAttribute()加上 flash message.
         * addFlashAttribute()可以是任意类型的数据(不局限在String等基本类型)
         * addFlashAttribute() 加的 attr, 不会出现在url 地址栏上.
         * addFlashAttribute() 加的 attr, 一旦fetch后, 就会自动清空, 非常适合 form 提交后 feedback Message.
         * */
        @PostMapping("/submit")
        public RedirectView submit(RedirectAttributes redirectAttributes) {
            boolean passed = false;
            if (passed==false) {
                RedirectView redirectTarget = new RedirectView();
                redirectTarget.setContextRelative(true);
                redirectTarget.setUrl("input");
                redirectAttributes.addFlashAttribute("errorMessage", "some error information here");
                return redirectTarget;
            }else {
                RedirectView redirectTarget = new RedirectView();
                redirectTarget.setContextRelative(true);
                redirectTarget.setUrl("inputOK");
                return redirectTarget;
            }
        }
    }

# 5. 自定义ResponseEntity例子 #

## 5.1例子 ##

ResponseEntity.ok() 和 ResponseEntity.BodyBuilder()  
返回200(HttpStatus.SC\_OK)

@RequestMapping("/check")
    public ResponseEntity<String> check() {
        BodyBuilder builder = (BodyBuilder) ResponseEntity.ok();
        builder.allow(HttpMethod.GET);
        builder.contentType(MediaType.TEXT_HTML);
        builder.eTag("W/MyeTag\"");
        return builder.body("Hello World!");
    }

ResponseEntity.status()  
使用HttpStatus返回需要的HttpCode

@RequestMapping("/handle")
    public ResponseEntity<String> handle() {
       return ResponseEntity.status(HttpStatus.SC_CREATED).body("Created Success");
    }

ResponseEntity.created()  
返回201（HttpStatus.SC\_CREATED)

@RequestMapping("/handle")
    public ResponseEntity<Void> handle() {
        URI location = null;
        try {
        location = new URI("http://www.concretepage.com/");
        } catch (URISyntaxException e) {
        e.printStackTrace();
        }
        return ResponseEntity.created(location).build();
    }

ResponseEntity.accepted()  
返回202（HttpStatus.SC\_ACCEPTED)

@RequestMapping("/handle")
    public ResponseEntity<String> handle() {
         return ResponseEntity.accepted().body("Hello World!");
    }

ResponseEntity.noContent()  
返回204（HttpStatus.SC\_NO\_CONTENT)

@RequestMapping("/handle")
    public ResponseEntity<Void> handle() {
        return ResponseEntity.noContent().build();
    }

ResponseEntity.badRequest()  
返回400（HttpStatus.SC\_BAD\_REQUEST)

@RequestMapping("/handle")
    public ResponseEntity<String> handle() {
       return ResponseEntity.badRequest().body("Bad Request");
    }

ResponseEntity.notFound()  
返回404（HttpStatus.SC\_NOT\_FOUND)

@RequestMapping("/handle")
    public ResponseEntity<Void> handle() {
        return ResponseEntity.notFound().build();
    }

##    5.2 常见的http状态码 ##

100 客户端可以继续  
101 指示服务器正根据 Upgrade 头切换协议  
200请求正常成功  
201指示请求成功并在服务器上创建了一个新资源  
202指示已接受请求进行处理但处理尚未完成  
203指示客户端呈现的元信息并不源自服务器  
204指示请求成功但没有返回新信息  
205指示代理应该 重置导致请求被发送的文档视图  
206指示服务器已完成对资源的部分 GET 请求  
300请求的资源对应于表示形式集合中的某种表示形式，每种表示形式都有自己的特定位置  
301指示已经将资源永久地移动到了某个新位置，并且将来的引用应将新 URI 用于其请求  
302指示已经将资源暂时地移动到了另一个位置，但将来的引用仍应使用原来的 URI 访问该资源。 保留此定义是为了向后兼容。SC\_FOUND 现在是首选定义  
303指示可在另一个 URI 之下找到该请求的响应  
304指示条件 GET 操作发现资源可用但不可修改  
305指示必须 通过 Location 字段给定的代理访问请求资源  
307指示请求的资源暂时驻留在另一个 URI 之下。临时 URI 应该 通过响应中的 Location 字段提供  
400指示客户端发送的请求在语法上不正确  
401指示请求需要进行 HTTP 验证  
402保留此代码以备将来使用  
403指示服务器理解请求但拒绝完成它  
404指示请求的资源不可用  
405指示 Request-Line 中指定的方法不支持 Request-URI 标识的资源  
406指示请求标识的资源只能生成响应实体，根据请求中发送的 accept 头，这些响应实体具有不可接受的内容特征  
407指示客户端必须 首先通过代理验证其自身  
408指示客户端没有在服务器准备等待的时间内生成请求  
409指示由于与当前资源状态冲突请求无法完成  
410指示资源在服务器上不再可用并且不知道转发地址。应该 认为此条件是永久性的  
411指示在没有定义 Content-Length 的情况下无法处理请求  
412指示在服务器上测试一个或多个请求头字段中给出的前提时，该前提被求值为 false  
413指示因为请求实体大于服务器愿意或能够处理的实体，所以服务器拒绝处理请求  
414指示因为 Request-URI 的长度大于服务器愿意解释的 Request-URI 长度，所以服务器拒绝为请求提供服务  
415指示因为请求实体的格式不受请求方法的请求资源支持，所以服务器拒绝为请求提供服务  
416指示服务器无法服务于请求的字节范围  
417指示服务器无法服务于请求的字节范围  
500指示 HTTP 服务器内存在错误使服务器无法完成请求  
501指示 HTTP 服务器不支持完成请求所需的功能  
502指示 HTTP 服务器在充当代理或网关时从它参考的服务器接收到一个无效响应  
503指示 HTTP 服务器暂时过载，并且无法处理请求  
504指示服务器在充当网关或代理时没有从上游服务器接收到及时的响应  
505 指示服务器不支持或拒绝支持请求消息中使用的 HTTP 协议版本

# 6. 总结 #

`HttpServletResponse#sendRedirec`的方式更加灵活，可以在后端接收一次http请求生命周期中的任何一个阶段来使用，比如有以下几种常见的场景

*  某个接口要求登录时，在拦截器层针对所有未登录的请求，重定向到登录页面
 *  全局异常处理中，如果出现服务器异常，重定向到定制的500页面
 *  不支持的请求，重定向到404页面

# 参考： #

[https://www.cnblogs.com/harrychinese/p/SpringBoot\_redirect\_and\_forward.html][https_www.cnblogs.com_harrychinese_p_SpringBoot_redirect_and_forward.html]

[https://juejin.cn/post/6844903505841356813][https_juejin.cn_post_6844903505841356813]

[https_blog.csdn.net_zzhongcy_article_details_22413681]: https://blog.csdn.net/zzhongcy/article/details/22413681
[https_www.cnblogs.com_harrychinese_p_SpringBoot_redirect_and_forward.html]: https://www.cnblogs.com/harrychinese/p/SpringBoot_redirect_and_forward.html
[https_juejin.cn_post_6844903505841356813]: https://juejin.cn/post/6844903505841356813