SpringMVC響應的HTTP狀態碼
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;
}
}
}