JsonResponse (mg-fw 1.0.2 API)

java.lang.Object
- com.mg.framework.utils.JsonResponse

public class JsonResponse
extends Object

构造器概要

构造器
构造器和说明

JsonResponse()

构造器
构造器和说明
`JsonResponse()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static String`	`entityToJson(Object obj)` 将实体类对象转换为json格式字符串.
`static String`	`entityToJsonFull(Object obj, String filterPropertyNames)` 完整的输出json对象，所有对象只要引用到了都将重复出现。
`static String`	`entityToJsonFullSimple(Object obj, String filterPropertyNames)` 完整的输出json对象，所有对象只要引用到了都将重复出现。
`static String`	`entityToJsonSimple(Object obj)` 将实体类对象转换为json格式字符串（不再将驼峰转换为下划线）.
`static String`	`error(int code, String message)`
`static String`	`error(int code, String message, Object obj)`
`static String`	`success()`
`static String`	`success(Object obj)`
`static String`	`success(Object obj, boolean isRefDetect, String[] filterPropNames, boolean isCamelToUnderline)` 逻辑上表示成功，组合成需要返回的JSON字符串
`static String`	`success(Object obj, String[] filterPropNames)`
`static String`	`successMessage(String message)` 如果后台只是想让前台弹出一个成功的提示框,没有别的数据给前台，可以直接使用此函数前台会有拦截器拦截具有successText字符串的相应
`static String`	`successMessage(String message, Object data)`
`static String`	`successMessage(String message, Object data, String[] filterPropNames)`
`static String`	`successWithDate(Object obj, String dateFormat)` 转json 自定义日期类型的转化
`static String`	`toJson(Object obj, boolean isRefDetect, String[] filterPropNames, boolean isCamelToUnderline)`
`static String`	`toJson(Object obj, String[] filterPropNames)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - JsonResponse
```
public JsonResponse()
```
- 方法详细资料
  - entityToJson
```
public static String entityToJson(Object obj)
```
    将实体类对象转换为json格式字符串. 考虑到延迟加载的问题，这里对没有延迟加载的属性不做转换，直接跳过。对循环引用，这里采用fastjson缺省的方式，即一个对象只出现一次，避免死循环。
    
    参数:
    
    obj - entity实体对象
    
    返回:
    
    JSON格式字符串
  - entityToJsonFull
```
public static String entityToJsonFull(Object obj,
                                      String filterPropertyNames)
```
    完整的输出json对象，所有对象只要引用到了都将重复出现。为了避免死循环导致的栈溢出，需要将循环引用的属性作过滤。
    
    参数:
    
    obj - 需要转换的对象
    
    filterPropertyNames - 需要过滤的属性名。以"类名.属性名"的格式出现，也可以单独制定属性名，则表示所有类的这个属性名都被过滤这里的属性名为属性开始的名字。多个过滤条件以分号分割： a)ModelEntity.belong，ModelEntity类的以belong开始的属性都不出现在json字串中 b)belong, 所有obj及其关联属性对象中，只要有belong 开始的属性，都不出现在json字串中 c)ModelEntity.belong;createDate，ModelEntity类的以belong开始的属性，或者以createDate开始的属性，都不出现在json字串中
    
    返回:
    
    JSON格式字符串
  - entityToJsonSimple
```
public static String entityToJsonSimple(Object obj)
```
    将实体类对象转换为json格式字符串（不再将驼峰转换为下划线）.
    考虑到延迟加载的问题，这里对没有延迟加载的属性不做转换，直接跳过。对循环引用，这里采用fastjson缺省的方式，即一个对象只出现一次，避免死循环。
    
    参数:
    
    obj - entity实体对象
    
    返回:
    
    JSON格式字符串
  - entityToJsonFullSimple
```
public static String entityToJsonFullSimple(Object obj,
                                            String filterPropertyNames)
```
    完整的输出json对象，所有对象只要引用到了都将重复出现。为了避免死循环导致的栈溢出，需要将循环引用的属性作过滤。（不再将驼峰转换为下划线）
    
    参数:
    
    obj - 需要转换的对象
    
    filterPropertyNames - 需要过滤的属性名。以"类名.属性名"的格式出现，也可以单独制定属性名，则表示所有类的这个属性名都被过滤这里的属性名为属性开始的名字。多个过滤条件以分号分割： a)ModelEntity.belong，ModelEntity类的以belong开始的属性都不出现在json字串中 b)belong, 所有obj及其关联属性对象中，只要有belong 开始的属性，都不出现在json字串中 c)ModelEntity.belong;createDate，ModelEntity类的以belong开始的属性，或者以createDate开始的属性，都不出现在json字串中
    
    返回:
    
    JSON格式字符串
  - error
```
public static String error(int code,
                           String message)
```
  - error
```
public static String error(int code,
                           String message,
                           Object obj)
```
  - success
```
public static String success(Object obj,
                             boolean isRefDetect,
                             String[] filterPropNames,
                             boolean isCamelToUnderline)
```
    逻辑上表示成功，组合成需要返回的JSON字符串
    
    参数:
    
    obj - 对象
    
    isRefDetect - 是否 DisableCircularReferenceDetect。设置为false则不会带有ref[0]这样的属性值输出，但会有循环引用的风险，需要设置过滤属性名
    
    filterPropNames - 过滤属性名的数组
    
    isCamelToUnderline - 是否需要将驼峰命名法转换为下划线命名法
    
    返回:
    
    JSON字符串
  - successWithDate
```
public static String successWithDate(Object obj,
                                     String dateFormat)
```
    转json 自定义日期类型的转化
    
    参数:
    
    obj -
    
    dateFormat -
    
    返回:
  - success
```
public static String success()
```
  - success
```
public static String success(Object obj)
```
  - success
```
public static String success(Object obj,
                             String[] filterPropNames)
```
  - toJson
```
public static String toJson(Object obj,
                            String[] filterPropNames)
```
  - toJson
```
public static String toJson(Object obj,
                            boolean isRefDetect,
                            String[] filterPropNames,
                            boolean isCamelToUnderline)
```
  - successMessage
```
public static String successMessage(String message)
```
    如果后台只是想让前台弹出一个成功的提示框,没有别的数据给前台，可以直接使用此函数前台会有拦截器拦截具有successText字符串的相应
    
    参数:
    
    message - 信息提示框的内容
    
    返回:
  - successMessage
```
public static String successMessage(String message,
                                    Object data)
```
  - successMessage
```
public static String successMessage(String message,
                                    Object data,
                                    String[] filterPropNames)
```

类 JsonResponse

构造器概要

方法概要

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

构造器详细资料

JsonResponse

方法详细资料

entityToJson

entityToJsonFull

entityToJsonSimple

entityToJsonFullSimple

error

error

success

successWithDate

success

success

success

toJson

toJson

successMessage

successMessage

successMessage