T
- 响应数据的数据类型public class Response<T> extends Object implements Serializable
通用响应
该工具主要是用于对系统的的响应进行一个形式上的统一, 以便各个接口返回的响应的形式保持一致。在初步设计时主要是借助HttpStatus作为状态标识 (HttpStatus具体的响应值的信息可以参见 https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) 。
简单地说,当code的值为200时表示系统成功处理了用户的请求,当code的值为401时表示用户无权访问请求的资源, 当code的值为500时表示系统成功接收到了用户的请求,但是未能按照用户的意图进行业务处理。。。。。
在某些情况下,如果系统内置的响应码不符合已进行的业务的需求但是又需要统一响应格式时可以自定义响应码等信息
Modifier and Type | Class and Description |
---|---|
static class |
Response.Const
通用返回响应类的常用属性信息
|
Modifier and Type | Field and Description |
---|---|
protected int |
code
请求的响应吗,这里借用HttpStatus作为状态标识
具体的响应值的信息可以参见 https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
|
protected T |
data
响应数据,在基本基本信息无法满足时会出现此信息,一般情况下无此信息
|
protected Date |
date
响应时间
|
protected String |
id
请求ID,用于请求追踪 .无论调用接口成功与否,都会返回请求 ID,该序列号全局唯一且随机
|
protected String |
msg
响应提示信息,一般与响应码的状态对应,对响应结果进行简单地描述
|
Constructor and Description |
---|
Response()
默认的构造函数
|
Response(int code,
String msg)
构造函数
|
Response(int code,
String msg,
T data)
构造函数
|
Response(String id,
int code,
String msg,
T data,
Date date)
全参构造函数
|
Modifier and Type | Method and Description |
---|---|
static Response<Object> |
badParam()
生成一个默认的表示参数有误的响应对象(响应码400)
|
static Response<Object> |
badParam(String msg)
根据响应提示信息生成一个表示参数有误的响应对象(响应码400)
|
static <T> Response<T> |
badParam(String msg,
T data)
根据响应提示信息和响应数据生成一个表示参数有误的响应对象(响应码400)
|
Response<T> |
data(T data)
设置响应数据
|
boolean |
equals(Object obj) |
static Response<Object> |
error()
生成一个默认表示请求业务未完成的响应对象(500响应码)
|
static Response<Object> |
error(String msg)
根据响应提示信息生成一个表示服务器内部异常500时的返回信息
|
static <T> Response<T> |
error(String msg,
T data)
根据响应提示信息和响应数据生成表示服务器内部异常500时的返回信息
|
static <T> Response<T> |
error(T data)
根据响应数据生成表示服务器内部异常500时的返回信息
|
static <T> Response<T> |
errorData(T data)
生成一个默认表示请求业务未完成的响应对象(500响应码)
|
int |
getCode()
获取响应码
|
T |
getData()
获取响应数据
|
Date |
getDate()
获取响应的时间
|
String |
getId()
获取请求ID
|
String |
getMsg()
获取响应提示信息
|
int |
hashCode() |
Response<T> |
msg(String msg)
设置响应提示信息
|
static Response<Object> |
notAllow()
生成一个默认的表示资源不可用的响应对象(403响应码)
|
static Response<Object> |
notAllow(String msg)
根据响应提示信息生成表示资源不可用的响应对象(403响应码)
|
static Response<Object> |
notFoundt()
生成一个默认的表示资源不存在的响应对象(404响应码)
|
static <T> Response<T> |
of(int code,
String msg,
T data)
构建一个通用的响应对象
|
Response<T> |
setCode(int code)
设置响应码
|
Response<T> |
setData(T data)
设置响应数据
|
Response<T> |
setDate(Date date)
设置响应的时间
|
Response<T> |
setId(String id)
设置请求ID
|
Response<T> |
setMsg(String msg)
设置响应提示信息
|
static Response<Object> |
suc()
生成一个默认的一个表示成功的响应对象
|
static Response<Object> |
suc(String msg)
根据响应提示信息生成一个表示成功的响应对象
|
static <T> Response<T> |
suc(String msg,
T data)
根据响应提示信息和响应数据生成一个表示成功的响应对象
|
static <T> Response<T> |
suc(T data)
根据响应数据生成一个表示成功的响应对象
|
static <T> Response<T> |
sucData(T data)
根据响应提示信息生成一个表示成功的响应对象
|
String |
toString() |
static Response<Object> |
unAuth()
生成一个默认的表示资源未授权的响应对象(401响应码)
|
static Response<Object> |
unAuth(String msg)
根据响应提示信息生成一个表示资源未授权的响应对象(401响应码)
|
static <T> Response<T> |
unAuth(String msg,
T data)
根据响应提示信息和响应数据生成一个表示资源未授权的响应对象(401响应码)
|
protected String id
protected int code
protected String msg
protected T data
protected Date date
public Response()
public Response(String id, int code, String msg, T data, Date date)
id
- 请求ID,用于请求追踪 .无论调用接口成功与否,都会返回请求 ID,该序列号全局唯一且随机code
- 响应码msg
- 响应提示信息data
- 响应数据date
- 响应时间public Response(int code, String msg, T data)
code
- 响应码msg
- 响应提示信息data
- 响应数据public Response(int code, String msg)
code
- 响应码msg
- 响应提示信息public static <T> Response<T> of(int code, String msg, T data)
T
- 响应的数据信息的数据类型code
- 响应码msg
- 响应提示信息data
- 响应数据public static <T> Response<T> suc(T data)
T
- 响应的数据信息的数据类型data
- 请求成功时返回的响应的数据信息public static Response<Object> suc(String msg)
msg
- 响应提示信息public static <T> Response<T> sucData(T data)
T
- 响应数据的类型data
- 响应数据public static <T> Response<T> suc(String msg, T data)
T
- 响应数据的数据类型msg
- 响应提示信息data
- 响应数据public static Response<Object> badParam()
public static Response<Object> badParam(String msg)
msg
- 响应提示信息public static <T> Response<T> badParam(String msg, T data)
T
- 响应数据的数据类型msg
- 响应提示信息data
- 响应数据public static Response<Object> unAuth()
public static Response<Object> unAuth(String msg)
msg
- 响应提示信息public static <T> Response<T> unAuth(String msg, T data)
T
- 响应数据的类型msg
- 响应提示信息data
- 响应数据public static Response<Object> notAllow()
public static Response<Object> notAllow(String msg)
msg
- 响应提示信息public static Response<Object> notFoundt()
public static Response<Object> error()
public static <T> Response<T> errorData(T data)
T
- 响应数据的类型data
- 响应数据public static Response<Object> error(String msg)
msg
- 响应提示信息public static <T> Response<T> error(T data)
T
- 响应数据的数据类型data
- 响应数据public static <T> Response<T> error(String msg, T data)
T
- 响应数据的数据类型msg
- 响应提示信息data
- 响应数据public String getId()
public int getCode()
public String getMsg()
public T getData()
public Date getDate()
Copyright © 2021. All rights reserved.