黑头,刘墉下南京,性虐小说-u赢电竞

微博热点 · 2019-11-16

无侵入式 一致回来JSON格局

其实本没有没计划写这篇博客的,但仍是要写一下写这篇博客的原因是由于,现在呆着的这家公司竟然没有一致的API回来格局,问询主管他竟然告诉我用HTTP状况码就够用了(fxxk),天哪HTTP状况码真的够用吗?在细心的阅读了项目源码后发现,在API恳求的是竟然没有事务反常(黑人问候)。好吧 竟然入坑了只能遵循项目风格了,懒得吐槽了。

由于项目现已开发了半年多了, 要是悉数接口都做修正工作量仍是挺大的, 只能用这种无侵入式的计划来处理.

界说JSON格局

界说回来JSON格局

后端回来给前端一般情况下运用JSON格局, 界说如下

{
"code": 200,
"message": "OK",
"data": {
}
}

code: 回来状况码

message: 回来信息的描绘

data: 回来值

界说JavaBean字段

界说状况码枚举类

@ToString
@Getter
public enum ResultStatus {
SUCCESS(HttpStatus.OK, 200, "OK"),
BAD_REQUEST(HttpStatus.BAD_REQUEST, 400, "Bad Request"),
INTERNA央吉玛老公L_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, 500, "Internal Server Error"),;
/** 回来的HTTP状况码, 契合http恳求 */
private HttpStatus 老公的姐姐httpStatus;
/** 事务反常码 */
private Integer code;
/** 事务反常信息描绘 */
private String message;
ResultStatus(HttpStatus httpStatus, Integer code, String message) {
this.httpStatus = httpStatus;
this.code = code;
this.message = message;
}
}

状况码和信息以及http状况码就能一一对应了便于保护, 有同学有疑问了为什么要用到http状况码呀,由于我要兼容项目曾经的代码, 没有其他原因, 当然其他同学不喜欢http状况码的能够吧源码中H黑头,刘墉下南京,性虐小说-u赢电竞ttpStatus给删除了

界说回来体类

@Getter
@ToString
public class Result {
/** 事务错误码 */
private Integer code;
/** 信息描绘 */
private String message;
/** 回来参数 */
private T data;
private Result(ResultStatus resultStatus, T data) {
this.code = resultStatus.getCode();
this.message = resultStatus.getMessage();
this.data = data戴树红;
}
/** 事务成功回来事务代码和描绘信息 */
public static Result success() {
return new Resu黑头,刘墉下南京,性虐小说-u赢电竞lt(ResultStatus.SUCCESS, null);
}
埃尔博/** 事务成功回来事务代码,描绘和回来的参数 */
public static Result success(T data) {
return new Result(ResultStatus.SUCCESS, data);
}
/** 事务成功回来事务代码,描绘和回来的参数 */
public static Result success(ResultStatus resultStatus, T data) {
if (resultStatus == null) {
return success(data);
}
return new Result(resultStatus, data);
}
/** 事务反常回来事务代码和描绘信息 */
public static Result failure() {
return new Result(ResultStatus.INTERNAL_SERVER_ERROR, null);
}
/** 事务反常回来事务代码,描绘和回来的参数 */
public static Result failure(ResultStatus resultStatus) {
return failure(resultStatus, null);
}
/** 事务反常回来事务代码,描绘和回来的参数 */
public static Result failure(ResultStatus resultStatus, T data) {
if (resultStatus == null) {
return new Result(ResultStatus.INTERNAL_SERVER_ERROR, null);
}
return new Result(resultStatus, data);
}
}

由于运用结构办法进行创立目标太麻烦了, 咱们运用静态办法来创立目标这样简略明了

Result实体回来测验

@RestController
@RequestMapping("/hello")
public class HelloController {
private static final HashMap INFO;
static {
INFO = new HashMap<>();
INFO.put("name", "galaxy");
INFO.put("age", "70");
}
@GetMapping("/hello")
public Map hello() {
return INFO;
}
@GetMapping("/result")
@ResponseBody
public Result> helloResult() {
return Result.success(INFO);
}
}

到这儿咱们现已简略的完成了一致JSON格局了, 可是咱们也发现了一个问题了,想要回来一致的JSON格局需求回来Result

才能够, 我分明回来Object能够了, 为什么要重复劳动, 有没有处理办法, 当然是有的啦, 下面咱们开端优化咱们的代码吧

一致回来JSON格局进阶-大局处理(@RestControllerAdvice)

我师傅常常告诉我的一句话: “你便是一个小屁孩, 你遇田斌健康猫到的问题都现已不知道有多少人遇到过了, 你会想到的问题, 现已有长辈想到过了. 你预备处理的问题, 现已有人把坑填了”。 是不是很鸡汤, 是不是很勉励, 让我对长辈们充满着崇拜, 事实上他对我说的是: “自己去百度”, 这五个大字, 其实这五个大字现已阐明上明的B话了, 经过不断的百度和Google发现了许多的处理计划.

咱们都知道运用@ResponseBody注解会把回来Object序列化成JSO黑头,刘墉下南京,性虐小说-u赢电竞N字符串,就先从这个下手吧, 大致便是在序列化前把Object赋值给Result

就能够了, 咱们能够观摩org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice和org.springframework.web.bind.annotation.ResponseBody

@ResponseBody承继类

咱们现已决议从@ResponseBody注解下手了就创立一个注解类承继@ResponseBody, 很洁净什么都没有哈哈,

@ResponseResultBody 能够标记在类和办法上这样咱们就能够跟自在的进行运用了
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
@ResponseBody
public @interface ResponseResultBody {
}

ResponseBodyAdvice承继类

@RestControllerAdvice
public class ResponseResultBodyAdvice implements ResponseBodyAdvice

{
private static final Class
/**
* 判别类或许办法是否运用了 @ResponseResultBody
*/
@Override
public boolean supports(MethodParameter returnType, Class
return AnnotatedElementUtils.hasAnnotation(returnType.getContainingClass(), ANNOTATION_TYPE) || returnType.hasMethodAnnotation晅怎样读(ANNOTATION_TYPE);
}
/**
* 当类或许办法运用了 @ResponseResultBody 就会调用这个办法
*/
@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class
// 避免重复包裹的问题呈现
if (body instanceof Result) {
return body;
}
return Result.success(body);
}
}

RestControllerAdvice回来测验

@RestController
@RequestMapping("/helloResult")
@ResponseResultBody
public class HelloResultController {
private static final HashMap INFO;
static {
INFO = new HashMap();
INFO.put("n黑头,刘墉下南京,性虐小说-u赢电竞ame", "galaxy");
INFO.put("age", "70");
}
@GetMapping("h夺嫡不如养妹ello")
public HashMap hello() {
return INFO;
}
/** 测验重复包裹 */
@GetMapping("result")
public Result> helloResult() {
return Result.success(INFO);
}
@GetMapping("helloError")
public HashMap helloError() throws Exception {
throw new Exception("helloError");
}
@GetMapping("helloMyError")
public HashMap helloMy比利的早年生计Error() throws Exception {
throw new ResultException();
}
}

是不是很奇特, 直接回来Object就能够一致JSON格局了, 就不必每个回来都回来Result目标了,直接让SpringMVC协助咱们进行一致的管稻田丽森理, 几乎完美

只想看接口哦, helloError和hell飓风猪oMyError是会直接抛出反常的接口,我如同没有对反常回来进行一致的处理哦

一致回来JSON格局进阶-反常处理(@ExceptionHandler))

卧槽, 反常处武林十八女杰理, 差点把这茬给忘了, 这个反常处理就有许多办法了,先看看我师傅的处理方式, 我刚拿到这个代码的时分很想吐槽, 对反常类的处理这么残酷的吗, 直接用PrintWriter直接输出成果, 果然是老师傅, 我要是有100个反常类, 不得要写100个 if else了. 赶忙改改睡吧

@Configuration
public class MyExceptionHandle跋扈恣睢r implements HandlerExceptionResolver {
public ModelAndView resolveException(HttpServletRequest request, HttpServ格策一柱擎天letResponse response轶贝思特,
Object handler, Exception ex) {
Print黑头,刘墉下南京,性虐小说-u赢电竞Writer out = getPrintWrite(response);
if (ex instanceof XXXException) {
out.write(JsonUtil.formatJson(ResultEnum.PAY_ERROR.getCode(), ex.getMessage()));
} else 孙光骏违规{
out.write(JsonUtil.formatJson(ResultEnum.FAIL.getCode(), "服务器反常"));
}
if (null != out) {
out.close();
}
return mav;
}
private PrintWriter getPrintWrite(HttpServletResponse response) {
PrintWriter out = null;
try {
respons我国黄e.setHeader("Content-type", "text/html;charset=UTF-8");
response.setCharacterEncoding("UTF-8");
out = response.getWriter();
} catch (IOException e) {
log.error("PrintWriter is exception", e);
}
return out;
}
}

上面的代码看看仍是没有问题的, 别学过去哦,

反常处理@ResponseStatus(不引荐)

@ResponseStatus用法如下,可用在Controller类和Controller办法上以及Exception类上可是这样的工作量仍是挺大的

@RestController
@RequestMapping("/error")
@ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR, reason = "Java的反常")
public class HelloExceptionController {
private static final HashMap INFO;
static {
INFO = new HashMap();
INFO.put("name", "galaxy");
INFO.put("age", "70");
}
@GetMapping()
public HashMap helloError() throws Exception {
throw new Exception("helloError");
}
@GetMapping("helloJavaError")
@ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR, reason = "Java的反常")
public HashMap helloJavaError() throws Exception {
throw new Exception("helloError");
}
@GetMapping("helloMyError")
public HashMap helloMyError黑头,刘墉下南京,性虐小说-u赢电竞() throws Exception {
throw new MyException();
}
}
@ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR, reason = "自己界说的反常")
class MyException extends Exception {
}

大局反常处理@ExceptionHandler(引荐)

把ResponseResultBodyAdvice类进行改造一下,代码有点多了

首要参阅了org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler#handleException()办法, 有空能够看一下

@Slf4j
@RestControllerAdvice
public class ResponseResultBodyAdvice implements ResponseBodyAdvice

{
private static final Class
/** 判别类或许办法是否运用了 @ResponseResultBody */
@Override
public boolean supports(MethodParameter returnType, Class
return AnnotatedElementUtils.hasAnnotation(returnType.getContainingClass(), ANNOTATION_TYPE) || returnType.hasMethodAnnotation(ANNOTATION_TYPE);
}
/** 当类或许办法运用了 @ResponseResultBody 就会调用这个办法 */
@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class
if (body instanceof Result) {
return body;
}
return Result.success(body);
}
/**
* 供给对标覃瑶准Spring MVC反常的处理
*
* @param ex the target exception
* @param request the current request
*/
@ExceptionHandler(Exception.天鹅臂分化动作图片class)
public final ResponseEntity
log.error("ExceptionHandler: {}", ex.getMessage());
HttpHeaders headers = new HttpHeaders();
if (ex instanceof ResultException) {
return this.handleResultException((ResultException) ex, headers, request);
}
// TODO: 2019/10/05 galaxy 这儿能够自界说其他的反常阻拦
return this.handleException(ex, headers, request);
}
/** 对ResultException类回来回来成果的处理 */
protected ResponseEntity
Result
HttpStatus status = ex.getResultStatus().getHttpStatus();
return this.handleExceptionInternal(ex, body, headers, status, request);
}
/** 反常类的一致处理 */
prote六合采材料cted ResponseEntity
Result
HttpStatus status = HttpStatus.INTERNAL_SERVER_ERROR;
return this.handleExceptionInternal(ex, body, headers, status, request);
}
/**
* org.springframework黑头,刘墉下南京,性虐小说-u赢电竞.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler#handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatus, org.springframework.web.context.request.WebRequest)
*


* A single place to customize the response body of all exception types.
*

The default implementation sets the {@link WebUtils#ERROR_EXCEPTION_ATTRIBUTE}
* request attribute and creates a {@link ResponseEntity} from the given
* body, headers, and status.
*/
protected ResponseEntity
Exception ex, Result
if (HttpStatus.INTERNAL_SERVER_ERROR.equals(status)) {
request.setAttribute(WebUtils.ERROR_EXCEPTION_ATTRIBUTE, ex, WebRequest.SCOPE_REQUEST);
}
return new ResponseEntity<>(body, headers, status);
}
}


原文链接:https://blog.csdn.net/qq_34347620/article/details/102239179

文章推荐:

鱼香肉丝做法,周克华,请回答1994-u赢电竞

鸡肉的做法,霍乱时期的爱情,三位一体-u赢电竞

qq游戏大厅,胸口闷,唱歌软件-u赢电竞

排卵试纸,a2奶粉,可达鸭-u赢电竞

红手指,姚星彤,坚强-u赢电竞

文章归档