2020-11-13

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

---

前言

使用Spring经常会遇到使用错误码, 很多情况我们会自定义，但是其实Spring内部已经提供了一套完整的错误码机制，那就是ResponseEntity + HttpStatus。以下几种场景都可以适用：

1. 正常返回
2. 异常返回
3. Exception中使用

一、使用方法

1. 第一种 正常返回

   @GetMapping("/sucess")
    public ResponseEntity<String> success() {
        return ResponseEntity.ok("This is a test");
    }   

或

    @GetMapping("/sucess")
    @ResponseBody
    public String success() {
        return "This is a test";
    }

测试结果：

	HTTP/1.1 200 "" 37ms
	
	connection: keep-alive
	content-length: 2
	content-type: text/plain;charset=UTF-8
	date: Fri, 13 Nov 2020 08:46:47 GMT
	keep-alive: timeout=60
	
	This is a test

2. 第二种 异常返回

  @ResponseStatus(HttpStatus.FORBIDDEN)
  @GetMapping("/test")
  @ResponseBody
  public String test() {
      return "没有权限";
  }

或

  @GetMapping("/test")
  public ResponseEntity<String> test() {
     return ResponseEntity.status(HttpStatus.FORBIDDEN).body("没有权限");
  }

测试结果

 HTTP/1.1 403 "" 39ms

connection: keep-alive
content-length: 9
content-type: text/plain;charset=UTF-8
date: Fri, 13 Nov 2020 08:55:23 GMT
keep-alive: timeout=60

没有权限

3. 第三种 Exception中使用

	@ResponseStatus(code = HttpStatus.FORBIDDEN, reason = "权限请求异常")
	public class AuthException extends Exception {
		
	}
	
	@GetMapping("/test")
	@ResponseBody
	public String test(String user) throws AuthException {
	    if (user == null) {
	        throw new AuthException();
	    }
	    return "请求页面成功";
	}
	

测试结果

HTTP/1.1 403 "" 38ms

connection: keep-alive
content-type: application/json
date: Fri, 13 Nov 2020 09:21:48 GMT
keep-alive: timeout=60
transfer-encoding: chunked

{"status":403,"message":"权限请求异常","path":"/test/test","error":"Forbidden","timestamp":"2020-11-13T09:21:48.254+00:00","trace":"com.study.http.status.AuthException\r\n\tat com.study.http.status.TestController.test(TestController.java:44)\r\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\r\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)\r\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)\r\n\tat java.lang.reflect.Method.invoke(Method.java:498)\r\n\tat org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:197)\r\n\tat org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:141)\r\n\tat org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:106)\r\n\tat org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:893)\r\n\tat org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:807)\r\n\tat org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87)\r\n\tat org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1061)\r\n\tat org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:961)\r\n\tat org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006)\r\n\tat org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:898)\r\n\tat javax.servlet.http.HttpServlet.service(HttpServlet.java:626)\r\n\tat org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:883)\r\n\tat javax.servlet.http.HttpServlet.service(HttpServlet.java:733)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:231)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\r\n\tat org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:53)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\r\n\tat org.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:100)\r\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\r\n\tat org.springframework.web.filter.FormContentFilter.doFilterInternal(FormContentFilter.java:93)\r\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\r\n\tat org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:201)\r\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\r\n\tat org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:202)\r\n\tat org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:97)\r\n\tat org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:542)\r\n\tat org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:143)\r\n\tat org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:92)\r\n\tat org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:78)\r\n\tat org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:343)\r\n\tat org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:374)\r\n\tat org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:65)\r\n\tat org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:868)\r\n\tat org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1590)\r\n\tat org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)\r\n\tat java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)\r\n\tat java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)\r\n\tat org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)\r\n\tat java.lang.Thread.run(Thread.java:748)\r\n"}

总结

Spring ReponseEntity + HttpStatus 使用还是非常方便和简洁的，个人也非常喜欢。但是如果在项目中使用，建议可以自己封装一层再使用。