Package cn.dev33.satoken.util

Class SaResult

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,Object>

cn.dev33.satoken.util.SaResult

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class SaResult
extends LinkedHashMap<String,Object>
implements Serializable

对请求接口返回 Json 格式数据的简易封装。

所有预留字段：
code = 状态码
msg = 描述信息
data = 携带对象

Since:

1.22.0

Author:

click33

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CODE_ERROR
static final int	CODE_NOT_LOGIN
static final int	CODE_NOT_PERMISSION
static final int	CODE_SUCCESS

Constructor Summary

Constructors

Constructor	Description
SaResult()	构建
SaResult(int code, String msg, Object data)	构建
SaResult(Map<String,?> map)	根据 Map 快速构建

Method Summary

Modifier and Type	Method	Description
static SaResult	code(int code)
static SaResult	data(Object data)
static SaResult	empty()
static SaResult	error()
static SaResult	error(String msg)
static SaResult	get(int code, String msg, Object data)
<T> T	get(String key, Class<T> cs)	获取一个值 根据自定义key
Integer	getCode()	获取code
Object	getData()	获取data
String	getMsg()	获取msg
static SaResult	notLogin()
static SaResult	notPermission()
static SaResult	ok()
static SaResult	ok(String msg)
SaResult	removeDefaultFields()	移除默认属性（code、msg、data）, 连缀风格
SaResult	removeNonDefaultFields()	移除非默认属性（code、msg、data）, 连缀风格
SaResult	set(String key, Object data)	写入一个值 自定义key, 连缀风格
SaResult	setCode(int code)	给code赋值，连缀风格
SaResult	setData(Object data)	给data赋值，连缀风格
SaResult	setJsonString(String jsonString)	写入一个 json 字符串, 连缀风格
SaResult	setMap(Map<String,?> map)	写入一个Map, 连缀风格
SaResult	setMsg(String msg)	给msg赋值，连缀风格
String	toString()

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Field Details

CODE_SUCCESS

public static final int CODE_SUCCESS

See Also:

• Constant Field Values

CODE_ERROR

public static final int CODE_ERROR

See Also:

• Constant Field Values

CODE_NOT_PERMISSION

public static final int CODE_NOT_PERMISSION

See Also:

• Constant Field Values

CODE_NOT_LOGIN

public static final int CODE_NOT_LOGIN

See Also:

• Constant Field Values

Constructor Details

SaResult

public SaResult()

构建

SaResult

public SaResult(int code,
 String msg,
 Object data)

构建

Parameters:

code - 状态码

msg - 信息

data - 数据

SaResult

public SaResult(Map<String,?> map)

根据 Map 快速构建

Parameters:

map - /

Method Details

getCode

public Integer getCode()

获取code

Returns:

code

getMsg

public String getMsg()

获取msg

Returns:

msg

getData

public Object getData()

获取data

Returns:

data

setCode

public SaResult setCode(int code)

给code赋值，连缀风格

Parameters:

code - code

Returns:

对象自身

setMsg

public SaResult setMsg(String msg)

给msg赋值，连缀风格

Parameters:

msg - msg

Returns:

对象自身

setData

public SaResult setData(Object data)

给data赋值，连缀风格

Parameters:

data - data

Returns:

对象自身

set

public SaResult set(String key,
 Object data)

写入一个值 自定义key, 连缀风格

Parameters:

key - key

data - data

Returns:

对象自身

get

public <T> T get(String key,
 Class<T> cs)

获取一个值 根据自定义key

Type Parameters:

T - 要转换为的类型

Parameters:

key - key

cs - 要转换为的类型

Returns:

值

setMap

public SaResult setMap(Map<String,?> map)

写入一个Map, 连缀风格

Parameters:

map - map

Returns:

对象自身

setJsonString

public SaResult setJsonString(String jsonString)

写入一个 json 字符串, 连缀风格

Parameters:

jsonString - json 字符串

Returns:

对象自身

removeDefaultFields

public SaResult removeDefaultFields()

移除默认属性（code、msg、data）, 连缀风格

Returns:

对象自身

removeNonDefaultFields

public SaResult removeNonDefaultFields()

移除非默认属性（code、msg、data）, 连缀风格

Returns:

对象自身

ok

public static SaResult ok()

ok

public static SaResult ok(String msg)

code

public static SaResult code(int code)

data

public static SaResult data(Object data)

error

public static SaResult error()

error

public static SaResult error(String msg)

notLogin

public static SaResult notLogin()

notPermission

public static SaResult notPermission()

get

public static SaResult get(int code,
 String msg,
 Object data)

empty

public static SaResult empty()

toString

public String toString()

Overrides:

toString in class AbstractMap<String,Object>