com.jfinal.kit

Class Ret

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

com.jfinal.kit.Ret

All Implemented Interfaces:

Serializable, Cloneable, Map

public class Ret
extends HashMap

Ret 用于返回值封装，也用于服务端与客户端的 json 数据通信

 一、主要应用场景：
 1：业务层需要返回多个返回值，例如要返回业务状态以及数据
 2：renderJson(ret) 响应 json 数据给客户端
 
 二、两种工作模式：
 1：默认情况下即为新工作模式，当调用 ok()、fail()、setOk()、setFail() 方法之后
    Ret 生成的 json 数据的状态属性为：state:ok 以及 state:fail
 
 2：通过调用 Ret.setToOldWorkMode() 可以切换到旧工作模式，与新工作模式的不同在于
    Ret 生成的 json 数据的状态属性为：isOk:true/false 以及 isFail:true/false
 
 3：旧工作模式为了兼容 JFinal 3.2 之前的版本而保留，强烈建议使用新工作模式
    新工作模式非常有利于使用 json 数据格式的 API 类型项目
 
 三、实例
 1：服务端
    Ret ret = service.justDoIt(paras);
    renderJson(ret);
 
 2：javascript 客户端 ajax 回调函数通常这么用：
    success: function(ret) {
       if(ret.state == "ok") {
        ...
       }
       
       if (ret.state == "fail") {
        ...
       }
    }
  
 3：普通应用程序通常这么用：
   String json = HttpKit.readData(getRequest());
   Ret ret = FastJson.getJson().parse(json, Ret.class);
   if (ret.isOk()) {
        ...
   }
   
   if (ret.isFail()) {
        ...
   }
   
 

See Also:

Serialized Form

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Ret()

Method Summary

Modifier and Type	Method and Description
static Ret	by(Object key, Object value)
static Ret	create()
static Ret	create(Object key, Object value)
Ret	delete(Object key)
boolean	equals(Object ret)
static Ret	fail()
static Ret	fail(Object key, Object value)
<T> T	getAs(Object key)
Boolean	getBoolean(Object key)
Integer	getInt(Object key)
Long	getLong(Object key)
Number	getNumber(Object key)
String	getStr(Object key)
boolean	isFail()
boolean	isFalse(Object key) key 存在，并且 value 为 false，则返回 true
boolean	isNull(Object key) key 不存在，或者 key 存在但 value 为null
boolean	isOk()
boolean	isTrue(Object key) key 存在，并且 value 为 true，则返回 true
boolean	notNull(Object key) key 存在，并且 value 不为 null
static Ret	ok()
static Ret	ok(Object key, Object value)
Ret	set(Map map)
Ret	set(Object key, Object value)
Ret	set(Ret ret)
Ret	setFail()
Ret	setOk()
static void	setToOldWorkMode() 设置为旧工作模式，为了兼容 jfinal 3.2 之前的版本
String	toJson()

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

hashCode

Constructor Detail

Ret

public Ret()

Method Detail

setToOldWorkMode

public static void setToOldWorkMode()

设置为旧工作模式，为了兼容 jfinal 3.2 之前的版本

by

public static Ret by(Object key,
                     Object value)

create

public static Ret create(Object key,
                         Object value)

create

public static Ret create()

ok

public static Ret ok()

ok

public static Ret ok(Object key,
                     Object value)

fail

public static Ret fail()

fail

public static Ret fail(Object key,
                       Object value)

setOk

public Ret setOk()

setFail

public Ret setFail()

isOk

public boolean isOk()

isFail

public boolean isFail()

set

public Ret set(Object key,
               Object value)

set

public Ret set(Map map)

set

public Ret set(Ret ret)

delete

public Ret delete(Object key)

getAs

public <T> T getAs(Object key)

getStr

public String getStr(Object key)

getInt

public Integer getInt(Object key)

getLong

public Long getLong(Object key)

getNumber

public Number getNumber(Object key)

getBoolean

public Boolean getBoolean(Object key)

notNull

public boolean notNull(Object key)

key 存在，并且 value 不为 null

isNull

public boolean isNull(Object key)

key 不存在，或者 key 存在但 value 为null

isTrue

public boolean isTrue(Object key)

key 存在，并且 value 为 true，则返回 true

isFalse

public boolean isFalse(Object key)

key 存在，并且 value 为 false，则返回 true

toJson

public String toJson()

equals

public boolean equals(Object ret)

Specified by:

equals in interface Map

Overrides:

equals in class AbstractMap