SpringMVC响应的HTTP状态码和返回状态码设置

SpringMVC响应的HTTP状态码

• SpringMVC 定义的状态码
• 常用到的状态码
• • 2XX
  • • 200 OK
    • 204
    • 206
  • 3XX
  • • 301
    • 302
  • 4XX
  • • 400
    • 401
    • 403
  • 5XX
  • • 500
    • 503

SpringMVC 定义的状态码

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by FernFlower decompiler)
//

package org.springframework.http;

import org.springframework.lang.Nullable;

public enum HttpStatus {
    CONTINUE(100, "Continue"),
    SWITCHING_PROTOCOLS(101, "Switching Protocols"),
    PROCESSING(102, "Processing"),
    CHECKPOINT(103, "Checkpoint"),
    OK(200, "OK"),
    CREATED(201, "Created"),
    ACCEPTED(202, "Accepted"),
    NON_AUTHORITATIVE_INFORMATION(203, "Non-Authoritative Information"),
    NO_CONTENT(204, "No Content"),
    RESET_CONTENT(205, "Reset Content"),
    PARTIAL_CONTENT(206, "Partial Content"),
    MULTI_STATUS(207, "Multi-Status"),
    ALREADY_REPORTED(208, "Already Reported"),
    IM_USED(226, "IM Used"),
    MULTIPLE_CHOICES(300, "Multiple Choices"),
    MOVED_PERMANENTLY(301, "Moved Permanently"),
    FOUND(302, "Found"),
    /** @deprecated */
    @Deprecated
    MOVED_TEMPORARILY(302, "Moved Temporarily"),
    SEE_OTHER(303, "See Other"),
    NOT_MODIFIED(304, "Not Modified"),
    /** @deprecated */
    @Deprecated
    USE_PROXY(305, "Use Proxy"),
    TEMPORARY_REDIRECT(307, "Temporary Redirect"),
    PERMANENT_REDIRECT(308, "Permanent Redirect"),
    BAD_REQUEST(400, "Bad Request"),
    UNAUTHORIZED(401, "Unauthorized"),
    PAYMENT_REQUIRED(402, "Payment Required"),
    FORBIDDEN(403, "Forbidden"),
    NOT_FOUND(404, "Not Found"),
    METHOD_NOT_ALLOWED(405, "Method Not Allowed"),
    NOT_ACCEPTABLE(406, "Not Acceptable"),
    PROXY_AUTHENTICATION_REQUIRED(407, "Proxy Authentication Required"),
    REQUEST_TIMEOUT(408, "Request Timeout"),
    CONFLICT(409, "Conflict"),
    GONE(410, "Gone"),
    LENGTH_REQUIRED(411, "Length Required"),
    PRECONDITION_FAILED(412, "Precondition Failed"),
    PAYLOAD_TOO_LARGE(413, "Payload Too Large"),
    /** @deprecated */
    @Deprecated
    REQUEST_ENTITY_TOO_LARGE(413, "Request Entity Too Large"),
    URI_TOO_LONG(414, "URI Too Long"),
    /** @deprecated */
    @Deprecated
    REQUEST_URI_TOO_LONG(414, "Request-URI Too Long"),
    UNSUPPORTED_MEDIA_TYPE(415, "Unsupported Media Type"),
    REQUESTED_RANGE_NOT_SATISFIABLE(416, "Requested range not satisfiable"),
    EXPECTATION_FAILED(417, "Expectation Failed"),
    I_AM_A_TEAPOT(418, "I'm a teapot"),
    /** @deprecated */
    @Deprecated
    INSUFFICIENT_SPACE_ON_RESOURCE(419, "Insufficient Space On Resource"),
    /** @deprecated */
    @Deprecated
    METHOD_FAILURE(420, "Method Failure"),
    /** @deprecated */
    @Deprecated
    DESTINATION_LOCKED(421, "Destination Locked"),
    UNPROCESSABLE_ENTITY(422, "Unprocessable Entity"),
    LOCKED(423, "Locked"),
    FAILED_DEPENDENCY(424, "Failed Dependency"),
    UPGRADE_REQUIRED(426, "Upgrade Required"),
    PRECONDITION_REQUIRED(428, "Precondition Required"),
    TOO_MANY_REQUESTS(429, "Too Many Requests"),
    REQUEST_HEADER_FIELDS_TOO_LARGE(431, "Request Header Fields Too Large"),
    UNAVAILABLE_FOR_LEGAL_REASONS(451, "Unavailable For Legal Reasons"),
    INTERNAL_SERVER_ERROR(500, "Internal Server Error"),
    NOT_IMPLEMENTED(501, "Not Implemented"),
    BAD_GATEWAY(502, "Bad Gateway"),
    SERVICE_UNAVAILABLE(503, "Service Unavailable"),
    GATEWAY_TIMEOUT(504, "Gateway Timeout"),
    HTTP_VERSION_NOT_SUPPORTED(505, "HTTP Version not supported"),
    VARIANT_ALSO_NEGOTIATES(506, "Variant Also Negotiates"),
    INSUFFICIENT_STORAGE(507, "Insufficient Storage"),
    LOOP_DETECTED(508, "Loop Detected"),
    BANDWIDTH_LIMIT_EXCEEDED(509, "Bandwidth Limit Exceeded"),
    NOT_EXTENDED(510, "Not Extended"),
    NETWORK_AUTHENTICATION_REQUIRED(511, "Network Authentication Required");

    private final int value;
    private final String reasonPhrase;

    private HttpStatus(int value, String reasonPhrase) {
        this.value = value;
        this.reasonPhrase = reasonPhrase;
    }

    public int value() {
        return this.value;
    }

    public String getReasonPhrase() {
        return this.reasonPhrase;
    }

    public boolean is1xxInformational() {
        return HttpStatus.Series.INFORMATIONAL.equals(this.series());
    }

    public boolean is2xxSuccessful() {
        return HttpStatus.Series.SUCCESSFUL.equals(this.series());
    }

    public boolean is3xxRedirection() {
        return HttpStatus.Series.REDIRECTION.equals(this.series());
    }

    public boolean is4xxClientError() {
        return HttpStatus.Series.CLIENT_ERROR.equals(this.series());
    }

    public boolean is5xxServerError() {
        return HttpStatus.Series.SERVER_ERROR.equals(this.series());
    }

    public boolean isError() {
        return this.is4xxClientError() || this.is5xxServerError();
    }

    public HttpStatus.Series series() {
        return HttpStatus.Series.valueOf(this);
    }

    public String toString() {
        return Integer.toString(this.value);
    }

    public static HttpStatus valueOf(int statusCode) {
        HttpStatus status = resolve(statusCode);
        if (status == null) {
            throw new IllegalArgumentException("No matching constant for [" + statusCode + "]");
        } else {
            return status;
        }
    }

    @Nullable
    public static HttpStatus resolve(int statusCode) {
        HttpStatus[] var1 = values();
        int var2 = var1.length;

        for(int var3 = 0; var3 < var2; ++var3) {
            HttpStatus status = var1[var3];
            if (status.value == statusCode) {
                return status;
            }
        }

        return null;
    }

    public static enum Series {
        INFORMATIONAL(1),
        SUCCESSFUL(2),
        REDIRECTION(3),
        CLIENT_ERROR(4),
        SERVER_ERROR(5);

        private final int value;

        private Series(int value) {
            this.value = value;
        }

        public int value() {
            return this.value;
        }

        public static HttpStatus.Series valueOf(int status) {
            int seriesCode = status / 100;
            HttpStatus.Series[] var2 = values();
            int var3 = var2.length;

            for(int var4 = 0; var4 < var3; ++var4) {
                HttpStatus.Series series = var2[var4];
                if (series.value == seriesCode) {
                    return series;
                }
            }

            throw new IllegalArgumentException("No matching constant for [" + status + "]");
        }

        public static HttpStatus.Series valueOf(HttpStatus status) {
            return valueOf(status.value);
        }
    }
}

常用到的状态码

2XX

200 OK

这个不需要过多的说明，请求成功，并正常返回。

204

该状态码表示没有内容，响应体payload为空

	@RequestMapping("/204test")
    @ResponseStatus(value=HttpStatus.NO_CONTENT)
    public void ping(HttpServletResponse response) throws Exception {
        System.out.println("20444");
    }

206

	@RequestMapping("/206test")
    @ResponseStatus(value=HttpStatus.PARTIAL_CONTENT)
    public void ping(HttpServletResponse response) throws Exception {
        System.out.println("20444");
    }

该状态码应用于断电续传，表示该响应只是全部内容的一部分。

3XX

3XX一般表示重定向

301

重定向,SpringMVC一般会用下面的方式优雅重定向，前后端分离不太常用。

	@RequestMapping(value = "/", method = RequestMethod.GET)
    public String redirect(){
        return "redirectPermanent:/home";
    }

302
SpringMVC 返回这个表示，接口和资源有相同的URI，比如你Web模板页面 /user/data页面，controller里又有一个/user/data 接口。就会返回302。

这个状态码下要么改接口的路径，要么改文件路径。代价小的从优。

4XX
400
SpringMVC 这个一般是请求表单参数名和服务端接收的表单的类型对应不上，
比如：服务端要的是Date类型，但是前端传的是字符串，倒置服务端无法理解请求语义；本来要返回json，但是忘了加@ResponseBody；ajax请求的链接后边忘了加参数。

401
SpringMVC 集成SpringSeacurity，如果有资源是当前用户未授权的，那么就会返回401

403
SpringMVC 集成SpringSeacurity，如果有资源当前用户没有访问权限，那么就会返回403。

5XX
500
这个是后台程序有bug，导致无法正常返回。

503
这个问题很古老了，其实是Tomcat中需要部署的是war包，而不是jar包。因为没有在war包找到路径对应的服务，所以报503。

 

转自：https://blog.csdn.net/a907691592/article/details/118147708

 

使用Spring MVC返回Http状态码

如何正确的处理Session超时问题，之前在项目中判断session超时或者未登录时，是直接返回jsp页面。这样的方式只能对请求不是ajax请求生效，如果是ajax请求则无法正确的跳转。

经过与前端同学沟通后，确定返回http状态码401来确认需要跳转登录。

首先，当session超时时，shiro会跳转到login方法中，在login方法中判断是否是ajax请求，如果不是则返回页面，如果是则返回状态码401.

最开始时，想用response.setStatus方法来填写状态码，并且在请求方法上加上了@Responsebody的注解，发现返回的始终是200状态码。

后来把注解去掉，并且使用restful中的ResponseEntity类来返回状态码。也就是返回的是一个ResponseEntity对象。

    @RequestMapping("${adminPath}/login/sessionTimeout")
    public ResponseEntity sessionTimeout() throws IOException {
        return new ResponseEntity(HttpStatus.UNAUTHORIZED);
    }

这样返回给前端的响应头中状态码就是401了。

 

SpringMvc返回http状态码及响应内容HttpServletResponse

场景

在项目中有时需要对接口返回时响应不同的http状态码，如权限校验返回401，禁止访问403等。

实现代码

 public String test(HttpServletRequest request, HttpServletResponse response,Long uid) throws Exception {
            // 返回403错误
            response.setStatus(HttpStatus.FORBIDDEN.value());
            // 返回类型,json格式
            response.setContentType(MediaType.APPLICATION_JSON_VALUE);
            // 返回值编码 ，utf-8,不设置可能出现乱码
            response.setCharacterEncoding(Consts.UTF_8.toString());
            response.getWriter().write("错误描述");
            return null;
        }
    }
}