BaseController (AJAXJS-Base 1.2.6 API)

java.lang.Object
- com.ajaxjs.framework.BaseController<T>

类型参数:

T - 实体类型，可以为 Map 或 Java Bean

所有已实现的接口:

IController, MvcConstant
```
public abstract class BaseController<T>
extends Object
implements IController, MvcConstant
```
通用控制器

作者:

sp42 frank@ajaxjs.com

字段概要

字段
限定符和类型字段和说明

static String SHOW_401
显示 HTTP 401 没有权限

static String SHOW_405
显示 HTTP 405 禁止操作
- 从接口继承的字段 com.ajaxjs.web.mvc.IController
  idRegexp, urlMappingTree
- 从接口继承的字段 com.ajaxjs.web.mvc.MvcConstant
  CATALOG_ID, CATALOGS, DOMAIN_CATALOG_ID, ID, ID_INFO, INFO, JSON_NOT_OK, JSON_OK, JSON_OK_EXTENSION, JSON_TYPE, JSP_PERFIX_WEBINF, KEYWORD, LIMIT, LIST, PAGE_RESULT, START, USER_ID, USER_ID_HEADER, USER_SESSION_ID

字段
限定符和类型	字段和说明
`static String`	`SHOW_401` 显示 HTTP 401 没有权限
`static String`	`SHOW_405` 显示 HTTP 405 禁止操作

构造器概要

构造器
构造器和说明

BaseController()

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

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`static String`	`admin(String jsp)` 后台用页面模板目录
`static String`	`autoOutput(Object entity, ModelAndView mv, String jspPath)` 自动根据客户端 HTTP 头传入的 Accept 字段决定是否输出 JSON 格式
`static String`	`autoOutput(Object entity, ModelAndView mv, String jspPath, java.util.function.Function<Boolean,Boolean> fn)` 自动根据客户端 HTTP 头传入的 Accept 字段决定是否输出 JSON 格式
`String`	`create(T bean)` 创建实体
`String`	`createUI(ModelAndView mv)` 新建记录的页面，必定是 MVC 而不是 JSON 的
`String`	`delete(Long id, T bean)` 根据 id 删除实体
`abstract IBaseService<T>`	`getService()` 服务对象
`static boolean`	`isJson()` 判断是否期望 JSON 的结果
`static String`	`jsonNoOk()`
`static String`	`jsonNoOk(String msg)` 输出 JSON No OK
`static String`	`jsonOk_Extension(Object... msg)`
`static String`	`jsonOk()` 、
`static String`	`jsonOk(String msg)` 输出 JSON OK
`static String`	`jsp(String jsp)` JSP 都保存在 /WEB-IMF/jsp/ 下面。
`String`	`output(ModelAndView mv, Object entityOrId)`
`String`	`output(ModelAndView mv, Object entityOrId, String jspPath)`
`String`	`output(ModelAndView mv, Object entityOrId, String jspPath, java.util.function.Consumer<T> onGetInfo)`
`static String`	`page(String jsp)` 普通页面模板目录
`void`	`prepareData(ModelAndView mv)` 可覆盖的模版方法，用于装备其他数据，如分类这些外联的表。
`static String`	`toJson(Object obj)` 把 Bean/Map/List 转换为 JSON
`static String`	`toJson(Object obj, boolean isAddPerfix, boolean isAddResult)` 将 Object 转换为 JSON 字符串
`static String`	`toJson(PageResult<?> pageResult)` 分页转为 JSON
`String`	`update(Long id, T bean)` 修改实体

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

从接口继承的方法 com.ajaxjs.web.mvc.IController
findTreeByPath, findTreeByPath, findTreeByPath, findTreeByPath, findTreeByPath, split2Queue2

- 字段详细资料
  - SHOW_405
```
public static final String SHOW_405
```
    显示 HTTP 405 禁止操作
  - SHOW_401
```
public static final String SHOW_401
```
    显示 HTTP 401 没有权限
- 构造器详细资料
  - BaseController
```
public BaseController()
```
- 方法详细资料
  - getService
```
public abstract IBaseService<T> getService()
```
    服务对象
    
    返回:
    
    服务对象
  - jsp
```
public static String jsp(String jsp)
```
    JSP 都保存在 /WEB-IMF/jsp/ 下面。再不断地分类
    
    参数:
    
    jsp - 模板位置
    
    返回:
    
    JSP 文件路径
  - page
```
public static String page(String jsp)
```
    普通页面模板目录
    
    参数:
    
    jsp - 模板位置
    
    返回:
    
    JSP 文件路径
  - admin
```
public static String admin(String jsp)
```
    后台用页面模板目录
    
    参数:
    
    jsp - 模板位置
    
    返回:
    
    JSP 文件路径
  - prepareData
```
public void prepareData(ModelAndView mv)
```
    可覆盖的模版方法，用于装备其他数据，如分类这些外联的表。
    
    参数:
    
    mv - Model 模型
  - createUI
```
public String createUI(ModelAndView mv)
```
    新建记录的页面，必定是 MVC 而不是 JSON 的
    
    参数:
    
    mv - 页面 Model 模型
    
    返回:
    
    JSP 文件标识，通常是如 news-edit
  - create
```
public String create(T bean)
```
    创建实体
    
    参数:
    
    bean - 实体
    
    返回:
    
    JSON 结果，包含新建实体之 id
  - update
```
public String update(Long id,
                     T bean)
```
    修改实体
    
    参数:
    
    id - 实体 id
    
    bean - 实体
    
    返回:
    
    JSON 响应
  - delete
```
public String delete(Long id,
                     T bean)
```
    根据 id 删除实体
    
    参数:
    
    id - 实体 id
    
    bean - 实体
    
    返回:
    
    JSON 响应
  - autoOutput
```
public static String autoOutput(Object entity,
                                ModelAndView mv,
                                String jspPath)
```
    自动根据客户端 HTTP 头传入的 Accept 字段决定是否输出 JSON 格式
    
    参数:
    
    entity - 实体，可以是单个实体或者列表、分页列表
    
    mv - Model 模型
    
    jspPath - JSP 模板路径
    
    返回:
    
    结果，可能是页面，也可能是 JSON
  - autoOutput
```
public static String autoOutput(Object entity,
                                ModelAndView mv,
                                String jspPath,
                                java.util.function.Function<Boolean,Boolean> fn)
```
    自动根据客户端 HTTP 头传入的 Accept 字段决定是否输出 JSON 格式
    
    参数:
    
    entity - 实体，可以是单个实体或者列表、分页列表
    
    mv - Model 模型
    
    jspPath - JSP 模板路径
    
    fn - 输入是否期望 JSON, 是否期望 JSON 的 lambda
    
    返回:
    
    结果，可能是页面，也可能是 JSON
  - output
```
public String output(ModelAndView mv,
                     Object entityOrId)
```
  - output
```
public String output(ModelAndView mv,
                     Object entityOrId,
                     String jspPath)
```
  - output
```
public String output(ModelAndView mv,
                     Object entityOrId,
                     String jspPath,
                     java.util.function.Consumer<T> onGetInfo)
```
  - isJson
```
public static boolean isJson()
```
    判断是否期望 JSON 的结果
    
    返回:
    
    true 表示为希望是 JSON
  - toJson
```
public static String toJson(Object obj)
```
    把 Bean/Map/List 转换为 JSON
    
    参数:
    
    obj - Bean/Map/List
    
    返回:
    
    JSON 结果
  - toJson
```
public static String toJson(Object obj,
                            boolean isAddPerfix,
                            boolean isAddResult)
```
    将 Object 转换为 JSON 字符串
    
    参数:
    
    obj - 普通对象
    
    isAddPerfix - 是否添加生成 json 的前缀 json::。有时候在页面上输出 json 作为 JS 代码的一部分，就要设为 false。
    
    isAddResult - JSON 是否包裹在 result 下面
    
    返回:
    
    JSON 字符串
  - toJson
```
public static String toJson(PageResult<?> pageResult)
```
    分页转为 JSON
    
    参数:
    
    pageResult -
    
    返回:
    
    JSON 字符串
  - jsonOk
```
public static String jsonOk(String msg)
```
    输出 JSON OK
    
    参数:
    
    msg - 输出信息
    
    返回:
    
    JSON 字符串
  - jsonOk
```
public static String jsonOk()
```
    、
    
    返回:
  - jsonOk_Extension
```
public static String jsonOk_Extension(Object... msg)
```
    参数:
    
    msg -
    
    返回:
  - jsonNoOk
```
public static String jsonNoOk(String msg)
```
    输出 JSON No OK
    
    参数:
    
    msg - 输出信息
    
    返回:
    
    JSON 字符串
  - jsonNoOk
```
public static String jsonNoOk()
```

类 BaseController<T>

字段概要

从接口继承的字段 com.ajaxjs.web.mvc.IController

从接口继承的字段 com.ajaxjs.web.mvc.MvcConstant

构造器概要

方法概要

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

从接口继承的方法 com.ajaxjs.web.mvc.IController

字段详细资料

SHOW_405

SHOW_401

构造器详细资料

BaseController

方法详细资料

getService

jsp

page

admin

prepareData

createUI

create

update

delete

autoOutput

autoOutput

output

output

output

isJson

toJson

toJson

toJson

jsonOk

jsonOk

jsonOk_Extension

jsonNoOk

jsonNoOk