ResponseStatus的简单实用方法

分手后的思念是犯贱 2022-12-13 07:51 200阅读 0赞

## 插播个号外 ##

[mybatis分析系列文章（偏源码）][mybatis]

[springboot系列文章（偏源码）][springboot]

[mybatis面试系列文章][mybatis 1]

> 以上文章都是纯原创，非转发，非抄袭！！！

## 1：自定义错误信息 ##

可以通过`@ResponseStatus`注解和`自定义异常`来配合使用返回自定义响应状态码和自定义错误信息给客户端。

### 1.1：自定义异常类 ###

@ResponseStatus(value = HttpStatus.FORBIDDEN, reason = "用户名和密码不匹配")
    public class UsernameNotMatchPasswordException extends RuntimeException { 
    }

### 1.2：定义测试controller ###

@Controller
    @RequestMapping("/responsestatus")
    public class ResponseStatusController { 
    
    	@RequestMapping("/testResponseStatusExceptionResolver")
    	public String testResponseStatusExceptionResolver(@RequestParam("i") int i){ 
    		System.out.println("testResponseStatusExceptionResolver come in...");
    		if (i==13){ 
    			throw new UsernameNotMatchPasswordException();
    		}
    		System.out.println("testResponseStatusExceptionResolver....");
    		return "success";
    	}
    }

### 1.3：测试 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center]

## 2：用在方法上 ##

### 2.1：代码 ###

@Controller
    @RequestMapping("/responsestatus")
    public class ResponseStatusController { 
    	@ResponseStatus(reason = "这是在方法上通过@ResponseStatus注解定义的信息", value = HttpStatus.NOT_FOUND)
    	@RequestMapping("/testResponseStatusExceptionResolverOnMethod")
    	public String testResponseStatusExceptionResolverOnMethod(@RequestParam("i") int i){ 
    		return "success";
    	}
    }

这样配置后所有的请求都会按照`@ResponseStatus(reason = "这是在方法上通过@ResponseStatus注解定义的信息", value = HttpStatus.NOT_FOUND)`的配置来返回信息，不知道有什么场景，哪位同学如果知道的话，`跪求告知`。

### 2.2：测试 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center 1]

[mybatis]: https://blog.csdn.net/wang0907/article/details/118675622
[springboot]: https://blog.csdn.net/wang0907/article/details/117402329
[mybatis 1]: https://blog.csdn.net/wang0907/article/details/120155331
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/64b70ad077914634951c0c66358c36dd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/f7c0809658934ca794a79b8f586e178f.png