ins.framework.web

类 ApiResponse<T>

java.lang.Object

ins.framework.web.ApiResponse<T>

类型参数:

T - 数据类型

所有已实现的接口:

Serializable

public class ApiResponse<T>
extends Object
implements Serializable

用于返回响应信息的工具类.

成功示例如下：

 public ApiResponse<EchoVo> echoObjectByObject(@RequestBody EchoVo echo) {
        EchoVo vo = echoService.echoObjectByObject(echo);
        return ApiResponse.ok(vo);
 }
 
 public ApiResponse<String> updateMain(@RequestBody DemoRobotMainVo vo) {
        demoRobotService.updateMain(vo);
        return ApiResponse.ok();
 }
 
 

失败示例如下：

 public ApiResponse<String> handleFileUpload(@RequestParam("file") MultipartFile file, HttpServletResponse response) {
        try {
                BufferedImage image = ImageIO.read(newFile);
                if (image != null && image.getWidth() > 0L) {
                        isLegal = true;
                }
        } catch (IOException e) {
                log.warn("{}", e.getMessage(), e);
                return new ApiResponse<>(ApiResponse.FAIL, e.getMessage(), "");
        }
 
        return ApiResponse.ok();
 }
 
 

作者:

zhouxianli

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
static int	BUSY
static String	BUSY_TEXT
static int	FAIL
static String	FAIL_TEXT
static int	SUCCESS
static String	SUCCESS_TEXT

构造器概要

构造器

构造器和说明
ApiResponse() 默认构造方法，构造一个成功的响应
ApiResponse(long status, String message, T data) 通过参数构造响应对象
ApiResponse(T data) 通过参数构造响应对象

方法概要

限定符和类型	方法和说明
static <T> ApiResponse<T>	fail(String message) 返回执行失败的响应
static <T> ApiResponse<T>	fail(String message, T data) 返回执行失败的响应
T	getData() 获取数据
String	getMessage() 获取消息
long	getStatus() 获取状态码
String	getStatusText() 已过时。
Date	getTimestamp() 获取时间戳
static <M> ApiResponse<M>	ok() 返回执行成功的响应
static <T> ApiResponse<T>	ok(T data) 返回执行成功的响应
void	setData(T data) 设置数据
void	setMessage(String message) 设置消息
void	setStatus(long status) 设置状态码
void	setStatusText(String message) 已过时。
void	setTimestamp(Date timestamp) 设置时间戳

从类继承的方法 java.lang.Object

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

字段详细资料

SUCCESS

public static final int SUCCESS

另请参阅:

常量字段值

FAIL

public static final int FAIL

另请参阅:

常量字段值

BUSY

public static final int BUSY

另请参阅:

常量字段值

SUCCESS_TEXT

public static final String SUCCESS_TEXT

另请参阅:

常量字段值

FAIL_TEXT

public static final String FAIL_TEXT

另请参阅:

常量字段值

BUSY_TEXT

public static final String BUSY_TEXT

另请参阅:

常量字段值

构造器详细资料

ApiResponse

public ApiResponse()

默认构造方法，构造一个成功的响应

ApiResponse

public ApiResponse(long status,
                   String message,
                   T data)

通过参数构造响应对象

参数:

status - 状态码

message - 消息

data - 数据

ApiResponse

public ApiResponse(T data)

通过参数构造响应对象

参数:

data - 数据

方法详细资料

getStatus

public long getStatus()

获取状态码

返回:

状态码

setStatus

public void setStatus(long status)

设置状态码

参数:

status - 状态码

getStatusText

public String getStatusText()

已过时。

获取消息

返回:

消息

另请参阅:

getMessage()

setStatusText

public void setStatusText(String message)

已过时。

设置消息

参数:

message - message

另请参阅:

setMessage(String)

getMessage

public String getMessage()

获取消息

返回:

消息

setMessage

public void setMessage(String message)

设置消息

参数:

message - message

getTimestamp

public Date getTimestamp()

获取时间戳

返回:

时间戳

setTimestamp

public void setTimestamp(Date timestamp)

设置时间戳

参数:

timestamp - 时间戳

getData

public T getData()

获取数据

返回:

数据

setData

public void setData(T data)

设置数据

参数:

data - 数据

ok

public static <M> ApiResponse<M> ok()

返回执行成功的响应

类型参数:

M - 类型

返回:

执行成功的响应

ok

public static <T> ApiResponse<T> ok(T data)

返回执行成功的响应

类型参数:

T - 类型

参数:

data - 返回数据

返回:

执行成功的响应

fail

public static <T> ApiResponse<T> fail(String message)

返回执行失败的响应

类型参数:

T - 类型

参数:

message - 消息

返回:

执行失败的响应

fail

public static <T> ApiResponse<T> fail(String message,
                                      T data)

返回执行失败的响应

类型参数:

T - 类型

参数:

message - 消息

data - 数据

返回:

执行失败的响应