类 ApiResultResponseAdvice

java.lang.Object

io.github.lishangbu.orange.web.response.ApiResultResponseAdvice

所有已实现的接口:

org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice<Object>

@RestControllerAdvice(basePackages="io.github.lishangbu.orange")
public class ApiResultResponseAdvice
extends Object
implements org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice<Object>

API响应结果包装增强器，统一封装所有 Controller 返回值为 ApiResult

支持自动包装普通对象、字符串类型和已包装的 ApiResult 类型 字符串类型特殊处理，保证响应内容为标准 JSON 格式 适用于 io.github.lishangbu.orange 包下所有 RestController

从以下版本开始:

2023/5/1

作者:

lishangbu

构造器概要

构造器

构造器	说明
ApiResultResponseAdvice()

方法概要

修饰符和类型	方法	说明
Object	beforeBodyWrite(Object body, org.springframework.core.MethodParameter returnType, org.springframework.http.MediaType selectedContentType, Class<? extends org.springframework.http.converter.HttpMessageConverter<?>> selectedConverterType, org.springframework.http.server.ServerHttpRequest request, org.springframework.http.server.ServerHttpResponse response)	响应体写出前的统一包装处理
boolean	supports(org.springframework.core.MethodParameter returnType, Class<? extends org.springframework.http.converter.HttpMessageConverter<?>> converterType)	判断是否需要处理响应体

从类继承的方法 Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice

determineWriteHints

构造器详细资料

ApiResultResponseAdvice

public ApiResultResponseAdvice()

方法详细资料

supports

public boolean supports(org.springframework.core.MethodParameter returnType,
 Class<? extends org.springframework.http.converter.HttpMessageConverter<?>> converterType)

判断是否需要处理响应体

所有类型均支持包装

指定者:

supports 在接口中 org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice<Object>

参数:

returnType - 方法返回类型参数

converterType - 消息转换器类型

返回:

总是返回 true，表示所有响应均处理

beforeBodyWrite

public Object beforeBodyWrite(Object body,
 org.springframework.core.MethodParameter returnType,
 org.springframework.http.MediaType selectedContentType,
 Class<? extends org.springframework.http.converter.HttpMessageConverter<?>> selectedConverterType,
 org.springframework.http.server.ServerHttpRequest request,
 org.springframework.http.server.ServerHttpResponse response)

响应体写出前的统一包装处理

将原始响应体包装为 ApiResult，字符串类型特殊处理为 JSON 字符串

指定者:

beforeBodyWrite 在接口中 org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice<Object>

参数:

body - 原始响应体

returnType - 方法返回类型参数

selectedContentType - 响应内容类型

selectedConverterType - 消息转换器类型

request - 当前请求对象

response - 当前响应对象

返回:

包装后的响应体