com.jfinal.kit

类 CPI

java.lang.Object

com.jfinal.kit.CPI

public class CPI
extends Object

用于定制个性化 Ret

 例子：
   CPI.setRetState("success", true, false);
   将 Ret 的状态字段名由 "state" 改为 "success"，将状态值 "ok" 改为 true、"fail" 改为 false

   CPI.setRetState("code", 200, 500);
   将 Ret 的状态字段名由 "state" 改为 "code"，将状态值 "ok" 改为 200、"fail" 改为 500

   CPI.setRetMsgName("message")
   将 Ret 的消息字段名由 "msg" 改为 "message"
 

构造器概要

构造器

构造器和说明
CPI()

方法概要

限定符和类型	方法和说明
static String	getRetDataName()
static boolean	getRetDataWithOkState()
static String	getRetMsgName()
static Func.F21<Boolean,Object,Boolean>	getRetOkFailHandler()
static Object	getRetStateFailValue()
static String	getRetStateName()
static Object	getRetStateOkValue()
static Func.F30<Ret,String,Object>	getRetStateWatcher()
static void	setRetDataName(String dataName) 配置 Ret 的 data 名，默认值为："data" 例子： CPI.setRetDataName("body") 将 Ret 的数据字段名由 "data" 改为 "body"
static void	setRetDataWithOkState(boolean dataWithOkState) 配置 Ret 的 data 方法伴随 ok 状态，默认值为：true 例子： CPI.setRetDataWithOkState(false) 将 Ret 的 data 方法伴随 ok 状态，改为不伴随 ok 状态
static void	setRetMsgName(String msgName) 配置 Ret 的消息名，默认值为："msg" 例子： CPI.setRetMsgName("message") 将 Ret 的消息字段名由 "msg" 改为 "message"
static void	setRetOkFailHandler(Func.F21<Boolean,Object,Boolean> okFailHandler) 配置 Ret.isOk()、Ret.isFail() 在前两个 if 判断都没有 return 之后的处理回调 用于支持多于两个状态的情况，也即在 ok、fail 两个状态之外还引入了其它状态 例子： CPI.setRetOkFailHandler((isOkMethod, value) -> { if (isOkMethod == Boolean.TRUE) { return false; } else { return true; } });
static void	setRetState(String stateName, Object stateOkValue, Object stateFailValue) 配置 Ret 的状态名、成功状态值、失败状态值，默认值分别为："state"、"ok"、"fail" 例子： CPI.setRetState("success", true, false); 将 Ret 的状态字段名由 "state" 改为 "success"，将状态值 "ok" 改为 true、"fail" 改为 false CPI.setRetState("code", 200, 500); 将 Ret 的状态字段名由 "state" 改为 "code"，将状态值 "ok" 改为 200、"fail" 改为 500
static void	setRetStateWatcher(Func.F30<Ret,String,Object> stateWatcher) 配置 state 监听 例子： CPI.setRetStateWatcher((ret, state, value) -> { ret.set("success", "ok".equals(value)); }); 监听 state，当值为 "ok" 时，额外放入 "success" 值为 true，否则为 false， 在前后端分离项目中，有些前端框架需要该返回值："success" : true/false

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

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

构造器详细资料

CPI

public CPI()

方法详细资料

setRetState

public static void setRetState(String stateName,
                               Object stateOkValue,
                               Object stateFailValue)

配置 Ret 的状态名、成功状态值、失败状态值，默认值分别为："state"、"ok"、"fail"

 例子：
   CPI.setRetState("success", true, false);
   将 Ret 的状态字段名由 "state" 改为 "success"，将状态值 "ok" 改为 true、"fail" 改为 false

   CPI.setRetState("code", 200, 500);
   将 Ret 的状态字段名由 "state" 改为 "code"，将状态值 "ok" 改为 200、"fail" 改为 500
 

setRetMsgName

public static void setRetMsgName(String msgName)

配置 Ret 的消息名，默认值为："msg"

 例子：
   CPI.setRetMsgName("message")
   将 Ret 的消息字段名由 "msg" 改为 "message"
 

setRetDataName

public static void setRetDataName(String dataName)

配置 Ret 的 data 名，默认值为："data"

 例子：
   CPI.setRetDataName("body")
   将 Ret 的数据字段名由 "data" 改为 "body"
 

setRetDataWithOkState

public static void setRetDataWithOkState(boolean dataWithOkState)

配置 Ret 的 data 方法伴随 ok 状态，默认值为：true

 例子：
   CPI.setRetDataWithOkState(false)
   将 Ret 的 data 方法伴随 ok 状态，改为不伴随 ok 状态
 

setRetStateWatcher

public static void setRetStateWatcher(Func.F30<Ret,String,Object> stateWatcher)

配置 state 监听

 例子：
   CPI.setRetStateWatcher((ret, state, value) -> {
     ret.set("success", "ok".equals(value));
   });
   监听 state，当值为 "ok" 时，额外放入 "success" 值为 true，否则为 false，
   在前后端分离项目中，有些前端框架需要该返回值："success" : true/false
 

setRetOkFailHandler

public static void setRetOkFailHandler(Func.F21<Boolean,Object,Boolean> okFailHandler)

配置 Ret.isOk()、Ret.isFail() 在前两个 if 判断都没有 return 之后的处理回调 用于支持多于两个状态的情况，也即在 ok、fail 两个状态之外还引入了其它状态

 例子：
   CPI.setRetOkFailHandler((isOkMethod, value) -> {
     if (isOkMethod == Boolean.TRUE) {
        return false;
     } else {
        return true;
     }
   });
 

getRetStateName

public static String getRetStateName()

getRetStateOkValue

public static Object getRetStateOkValue()

getRetStateFailValue

public static Object getRetStateFailValue()

getRetMsgName

public static String getRetMsgName()

getRetDataName

public static String getRetDataName()

getRetDataWithOkState

public static boolean getRetDataWithOkState()

getRetStateWatcher

public static Func.F30<Ret,String,Object> getRetStateWatcher()

getRetOkFailHandler

public static Func.F21<Boolean,Object,Boolean> getRetOkFailHandler()