Controller (YangMVC 2023.06.19 API)

java.lang.Object
- org.docshare.mvc.Controller

```
public class Controller
extends Object
```
所有控制器的父类

作者:

杨同峰

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`Controller.FreeMarker` 用来标志输出类型的特殊类
`static class`	`Controller.JSP` 用来标志输出类型的特殊类
`static class`	`Controller.Require`

字段概要

字段
限定符和类型	字段和说明
`javax.servlet.ServletContext`	`application` 同jsp中的application对象。
`javax.servlet.http.HttpServletRequest`	`request` 请求对象，同jsp中的request。
`javax.servlet.http.HttpServletResponse`	`response` 响应对象，同jsp中的response。
`javax.servlet.http.HttpSession`	`session` 会话对象。
`protected PrintWriter`	`writer` 输出对象，类似jsp中的out对象，但请优先使用output、outputJSON、downloadFile等函数。

构造器概要

构造器
构造器和说明

Controller()

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

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`Object`	`app(String key)` 获取application对象中存储的变量
`void`	`app(String key, Object val)`
`Double`	`appDouble(String key)` 获取application对象中存储的变量
`Integer`	`appInt(String key)` 获取application对象中存储的变量
`String`	`appStr(String key)` 获取application对象中存储的变量
`void`	`checkNull(String name, Object obj)` 检查obj是否为null，如果为null，则抛出NullParamException ，这个错误会最终在网页上显示。
`String`	`cookie(String key)` 获取cookie
`String`	`cookie(String key, Object value, int period_ms)` 设置cookie
`static void`	`disableGzip()` 设置关闭gzip功能，全部以text/plain形式发送内容默认为打开状态
`void`	`download(String path)` 输出下载内容。
`void`	`dump()`
`void`	`dumpParam()`
`static void`	`enableGzip()` 设置开启gzip功能，如果发现客户端可以支持gzip（监测Accept-Encoding)，则压缩发送。
`boolean`	`existFile(String path)` 是否存在某个文件
`Controller.FreeMarker`	`freemarker(String path)` 在控制器方法中 return freemarker()为输出freemarker的意思
`String`	`getClearQuery(String q)`
`String`	`getDefaultTemp()` 获取默认的模板
`String`	`getLang()` 获取当前请求所接受的语言种类
`Map<String,String[]>`	`getParamMap()`
`String`	`getPath()` 获取当前控制器对应的URL路径
`void`	`header(String name, String val)`
`boolean`	`isGet()` 返回当前请求是否为Get请求，
`boolean`	`isPost()` 返回当前请求是否为Post请求，
`boolean`	`isSingle()` 返回当前控制器是否是单例模式
`String`	`json(Object obj)`
`String`	`json(Object obj, boolean pretty)`
`void`	`jsonToParam()` 将json中的数据转入param，使得用户察觉不到什么异常。
`Controller.JSP`	`jsp()` 在控制器方法中，return jsp(); 即为输出jsp的意思。
`Controller.JSP`	`jsp(String path)` 在控制器方法中，return jsp(); 即为输出jsp的意思。
`void`	`jump(String url)` 跳转到新页面/重定向。
`LasyList`	`L(String tableName)` 获取LasyList对象
`String`	`method()` 获取HTTP请求的方法，GET/POST/PUT 等
`void`	`output(String s)` 输出字符串并关闭流
`boolean`	`outputBytes(byte[] ba)` 输出一个字节流
`void`	`outputJSON(Object obj)` 输出JSON字符串到网页
`void`	`outputJSON(Object obj, boolean pretty)`
`LasyList`	`page(LasyList list)` 自动处理分页问题，对应URL参数 page 为页码， pagesz为页面大小（默认为30)
`LasyList`	`page(LasyList list, int pagesize)` 自动处理分页问题，对应URL参数 page 为页码， pagesz为页面大小（默认为30)
`String`	`param(String p)` 获取URL参数或者Form提交的参数
`String`	`param(String name, String def)` 制定默认值并获取URL参数，如果参数不存在，则返回默认值。
`Integer`	`paramInt(String p)` 获取URL参数或者Form提交的参数,并自动转换为int，如果不是整数则会报错。
`Integer`	`paramInt(String p, int def)` 获取URL参数或者Form提交的参数,并自动转换为int，如果不是整数则会报错。
`String`	`paramJSON()` 当content-type 为application/json ,该函数获取传来的json字符串
`Model`	`paramToModel(Model m)` 根据名称匹配的原则，将与模型中参数名相同的参数的值放入模型中。
`<T> T`	`paramToObj(T obj)` 将参数中的值拷贝到对象的对应属性中如 height参数拷贝到obj的height属性中
`<T> T`	`paramToObj(T obj, String prefix)` 将参数中的值拷贝到对象的对应属性中如 height参数拷贝到obj的height属性中当prefix 为haha_的时候， haha_height会拷贝到obj的height属性中
`protected int`	`paramWithDefaultInt(String pname, int def)` 已过时。
`void`	`put(String name, Object obj)`
`void`	`put(String name, Object obj, Object... others)` 向request中放入数据，方便在jsp中使用getAttribute获取，或者使用EL表达式读取这个方法是MVC框架中使用频率非常高的一个方法。
`void`	`putListTable(String name, LasyList list)` 将列表以表格方式输出到name指定request变量中
`void`	`putModelItem(Model m)` 将model中的每个字段以单独的变量形式加入request中
`void`	`putParam(String key, Object val)` 追加参数，同样可以用param获取到最佳的参数
`void`	`removeApp(String key)`
`void`	`removeCookie(String key)` 删除cookie
`void`	`removeSession(String key)`
`void`	`render()` 使用模板目录中对应的文件进行渲染
`void`	`render(String view)` 渲染一个模板，模板为参数view指定，这个路径是相对于配置中的template目录的。
`void`	`renderForm(Model m)`
`void`	`renderForm(Model m, String template, String postTo)`
`void`	`renderFreeMarker(String path)` 使用FreeMarker进行数据显示
`String`	`reqBody()` 读取请求中的正文部分
`void`	`require(String session_key, Object value, String jump_url, String err)` 限制当前Controller类中的所有方法的访问权限。
`void`	`require(String session_key, String jump_url)` 限制当前类所有方法的访问权限，一般在构造函数中调用。
`void`	`runMethod(Method method)` 执行某个方法
`Object`	`sess(String key)` 获取Session中key制定变量的值
`void`	`sess(String key, Object val)` 设置Session中key变量的值为val
`Double`	`sessDouble(String key)` 获取double类型session变量
`Integer`	`sessInt(String key)` 获取int类型session变量
`String`	`sessStr(String key)` 获取String类型session变量
`void`	`setReq(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)` 由过滤器调用这个方法来传送 request和response对象
`void`	`setSingle(boolean single)` 设置当前控制器为单例模式，需要注意的是，只有不使用除了request、response、session之外的类变量的才可以使用单例。
`DBTool`	`T(String tableName)` 获取tool对象
`String`	`urlParam(String p)` 应对一些url乱码

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

- 字段详细资料
  - request
```
public javax.servlet.http.HttpServletRequest request
```
    请求对象，同jsp中的request。但请优先使用param等函数
  - response
```
public javax.servlet.http.HttpServletResponse response
```
    响应对象，同jsp中的response。但请优先使用output、outputJSON等函数
  - session
```
public javax.servlet.http.HttpSession session
```
    会话对象。同jsp中的session。但请优先使用sess函数
  - writer
```
protected PrintWriter writer
```
    输出对象，类似jsp中的out对象，但请优先使用output、outputJSON、downloadFile等函数。
  - application
```
public javax.servlet.ServletContext application
```
    同jsp中的application对象。
- 构造器详细资料
  - Controller
```
public Controller()
```
- 方法详细资料
  - jsp
```
public Controller.JSP jsp(String path)
```
    在控制器方法中，return jsp(); 即为输出jsp的意思。如果不想使用命名约定对应的jsp，可以指定path
    
    参数:
    
    path - jsp文件相对路径
    
    返回:
    
    JSP对象
  - jsp
```
public Controller.JSP jsp()
```
    在控制器方法中，return jsp(); 即为输出jsp的意思。输出的jsp为命名约定对应的jsp
    
    返回:
    
    JSP对象
  - freemarker
```
public Controller.FreeMarker freemarker(String path)
```
    在控制器方法中 return freemarker()为输出freemarker的意思
    
    参数:
    
    path - 模板文件路径
    
    返回:
    
    FreeMarker对象（会使用后处理器进行处理）
  - putParam
```
public void putParam(String key,
                     Object val)
```
    追加参数，同样可以用param获取到最佳的参数
    
    参数:
    
    key - 参数名
    
    val - 参数值
  - isGet
```
public boolean isGet()
```
    返回当前请求是否为Get请求，
    
    返回:
    
    当为Get请求时返回真，否则返回假。
  - isPost
```
public boolean isPost()
```
    返回当前请求是否为Post请求，
    
    返回:
    
    当为Post请求时返回真，否则返回假。
  - method
```
public String method()
```
    获取HTTP请求的方法，GET/POST/PUT 等
    
    返回:
    
    http请求类型
  - getPath
```
public String getPath()
```
    获取当前控制器对应的URL路径
    
    返回:
    
    控制器对应的URL路径
  - getDefaultTemp
```
public String getDefaultTemp()
```
    获取默认的模板
    
    返回:
    
    模板路径
  - page
```
public LasyList page(LasyList list)
```
    自动处理分页问题，对应URL参数 page 为页码， pagesz为页面大小（默认为30)
    
    参数:
    
    list - 原列表
    
    返回:
    
    返回所需的对象列表
  - getClearQuery
```
public String getClearQuery(String q)
```
  - page
```
public LasyList page(LasyList list,
                     int pagesize)
```
    自动处理分页问题，对应URL参数 page 为页码， pagesz为页面大小（默认为30)
    
    参数:
    
    list - 原列表
    
    pagesize - 每页的记录数
    
    返回:
    
    返回所需的对象列表
  - paramWithDefaultInt
```
@Deprecated
protected int paramWithDefaultInt(String pname,
                                               int def)
```
    已过时。
    
    获取整形参数 ,已过时，请使用paramInt(String pname,int def)
    
    参数:
    
    pname -
    
    def -
    
    返回:
    
    参数值
  - render
```
public void render()
```
    使用模板目录中对应的文件进行渲染
  - put
```
public void put(String name,
                Object obj,
                Object... others)
```
    向request中放入数据，方便在jsp中使用getAttribute获取，或者使用EL表达式读取
    这个方法是MVC框架中使用频率非常高的一个方法。用于将控制器中的数据传递给View。 Demo: put("n",12);
    JSP :　request.getAttribute("n") 会返回12, ${n}也会为12
    
    参数:
    
    name - 参数名
    
    obj - 参数值
    
    others - 其他要插入的参数， put("name","yang","height",170,"weight",60)
  - put
```
public void put(String name,
                Object obj)
```
  - putModelItem
```
public void putModelItem(Model m)
```
    将model中的每个字段以单独的变量形式加入request中
    
    参数:
    
    m - 模型
  - existFile
```
public boolean existFile(String path)
```
    是否存在某个文件
    
    参数:
    
    path - 文件路径
    
    返回:
    
    存在返回true，否则返回false
  - render
```
public void render(String view)
```
    渲染一个模板，模板为参数view指定，这个路径是相对于配置中的template目录的。
    
    参数:
    
    view - jsp文件位置
  - paramJSON
```
public String paramJSON()
```
    当content-type 为application/json ,该函数获取传来的json字符串
    
    返回:
    
    所有json字符串
  - setReq
```
public void setReq(javax.servlet.http.HttpServletRequest req,
                   javax.servlet.http.HttpServletResponse resp)
```
    由过滤器调用这个方法来传送 request和response对象
    
    参数:
    
    req - 请求
    
    resp - 响应
  - jsonToParam
```
public void jsonToParam()
```
    将json中的数据转入param，使得用户察觉不到什么异常。
  - sess
```
public Object sess(String key)
```
    获取Session中key制定变量的值
    
    参数:
    
    key - 关键字
    
    返回:
    
    sesion中存储的该键对应的内容，如果没有返回null
  - sess
```
public void sess(String key,
                 Object val)
```
    设置Session中key变量的值为val
    
    参数:
    
    key - 关键字
    
    val - 要设置为的值
  - sessInt
```
public Integer sessInt(String key)
```
    获取int类型session变量
    
    参数:
    
    key - session变量的名字
    
    返回:
    
    如果有，则返回，否则返回null
  - sessDouble
```
public Double sessDouble(String key)
```
    获取double类型session变量
    
    参数:
    
    key - session变量的名字
    
    返回:
    
    如果有，则返回，否则返回null
  - sessStr
```
public String sessStr(String key)
```
    获取String类型session变量
    
    参数:
    
    key - session变量的名字
    
    返回:
    
    如果有，则返回，否则返回null
  - removeSession
```
public void removeSession(String key)
```
  - app
```
public Object app(String key)
```
    获取application对象中存储的变量
    
    参数:
    
    key - 变量名
    
    返回:
    
    变量值，如果没有则返回null
  - appInt
```
public Integer appInt(String key)
```
    获取application对象中存储的变量
    
    参数:
    
    key - 变量名
    
    返回:
    
    变量值，如果没有则返回null
  - appDouble
```
public Double appDouble(String key)
```
    获取application对象中存储的变量
    
    参数:
    
    key - 变量名
    
    返回:
    
    变量值，如果没有则返回null
  - appStr
```
public String appStr(String key)
```
    获取application对象中存储的变量
    
    参数:
    
    key - 变量名
    
    返回:
    
    变量值，如果没有则返回null
  - app
```
public void app(String key,
                Object val)
```
  - removeApp
```
public void removeApp(String key)
```
  - cookie
```
public String cookie(String key)
```
    获取cookie
    
    参数:
    
    key - 关键字
    
    返回:
    
    value 要设置成的值
  - cookie
```
public String cookie(String key,
                     Object value,
                     int period_ms)
```
    设置cookie
    
    参数:
    
    key - 键
    
    value - 值
    
    period_ms - 超时时间（单位毫秒）
    
    返回:
    
    返回value
  - removeCookie
```
public void removeCookie(String key)
```
    删除cookie
    
    参数:
    
    key - 要删除的cookie的关键字
  - enableGzip
```
public static void enableGzip()
```
    设置开启gzip功能，如果发现客户端可以支持gzip（监测Accept-Encoding)，则压缩发送。默认为打开状态
  - disableGzip
```
public static void disableGzip()
```
    设置关闭gzip功能，全部以text/plain形式发送内容默认为打开状态
  - output
```
public void output(String s)
```
    输出字符串并关闭流
    
    参数:
    
    s - 字符串
  - outputBytes
```
public boolean outputBytes(byte[] ba)
```
    输出一个字节流
    
    参数:
    
    ba - 字符数组
    
    返回:
    
    是否成功
  - outputJSON
```
public void outputJSON(Object obj)
```
    输出JSON字符串到网页
    
    参数:
    
    obj - 要输出的对象名
  - outputJSON
```
public void outputJSON(Object obj,
                       boolean pretty)
```
  - putListTable
```
public void putListTable(String name,
                         LasyList list)
```
    将列表以表格方式输出到name指定request变量中
    
    参数:
    
    name - 最后的表格将会存入这个字段中
    
    list - 需要输出的列表
  - renderForm
```
public void renderForm(Model m)
```
  - renderForm
```
public void renderForm(Model m,
                       String template,
                       String postTo)
```
  - urlParam
```
public String urlParam(String p)
```
    应对一些url乱码
    
    参数:
    
    p - 参数名称
    
    返回:
    
    参数值，如果没有返回null
  - param
```
public String param(String p)
```
    获取URL参数或者Form提交的参数
    
    参数:
    
    p - 参数名
    
    返回:
    
    参数内容
  - param
```
public String param(String name,
                    String def)
```
    制定默认值并获取URL参数，如果参数不存在，则返回默认值。参数存在返回参数值。
    
    参数:
    
    name - 参数名称
    
    def - 默认值
    
    返回:
    
    如果参数不存在，则返回默认值。参数存在返回参数值。
  - paramInt
```
public Integer paramInt(String p)
```
    获取URL参数或者Form提交的参数,并自动转换为int，如果不是整数则会报错。
    
    参数:
    
    p - 参数名称
    
    返回:
    
    int类型的参数值
  - paramInt
```
public Integer paramInt(String p,
                        int def)
```
    获取URL参数或者Form提交的参数,并自动转换为int，如果不是整数则会报错。如果该参数不存在，则返回默认值
    
    参数:
    
    p - 参数名称
    
    def - 如果没有这个参数，返回的默认值
    
    返回:
    
    int类型的参数值（参数不存在返回def)
  - paramToModel
```
public Model paramToModel(Model m)
```
    根据名称匹配的原则，将与模型中参数名相同的参数的值放入模型中。并返回该模型
    是收集表单数据到模型中的神器，手机后就可以直接进行数据库操作了。
    
    参数:
    
    m - 模型
    
    返回:
    
    得到的m，和参数m是同一个对象
  - paramToObj
```
public <T> T paramToObj(T obj,
                        String prefix)
```
    将参数中的值拷贝到对象的对应属性中如 height参数拷贝到obj的height属性中当prefix 为haha_的时候， haha_height会拷贝到obj的height属性中
    
    类型参数:
    
    T - 转换为对象的类型
    
    参数:
    
    obj - 要赋值的对象
    
    prefix - 参数的前缀
    
    返回:
    
    赋值后的对象，将obj引用返回
  - dumpParam
```
public void dumpParam()
```
  - getParamMap
```
public Map<String,String[]> getParamMap()
```
  - paramToObj
```
public <T> T paramToObj(T obj)
```
    将参数中的值拷贝到对象的对应属性中如 height参数拷贝到obj的height属性中
    
    类型参数:
    
    T - 转换为对象的类型
    
    参数:
    
    obj - 要赋值的对象
    
    返回:
    
    赋值后的对象，将obj引用返回
  - checkNull
```
public void checkNull(String name,
                      Object obj)
               throws NullParamException
```
    检查obj是否为null，如果为null，则抛出NullParamException ，这个错误会最终在网页上显示。如果希望改变显示内容，可以提前捕获此异常并进行处理。
    
    参数:
    
    name - 参数名
    
    obj - 是否为空
    
    抛出:
    
    NullParamException - 缺少参数异常
  - jump
```
public void jump(String url)
```
    跳转到新页面/重定向。功能等同resposne.sendRedirect
    
    参数:
    
    url - 目标url
  - setSingle
```
public void setSingle(boolean single)
```
    设置当前控制器为单例模式，需要注意的是，只有不使用除了request、response、session之外的类变量的才可以使用单例。单例模式可以优化性能，但也请慎用，做好测试。如果是文件上传，则不应使用单例模式，因为会用到类变量。
    
    参数:
    
    single - 设置为true为单例，否则每次请求创建一个该控制器对象
  - isSingle
```
public boolean isSingle()
```
    返回当前控制器是否是单例模式
    
    返回:
    
    是否为单例
  - getLang
```
public String getLang()
```
    获取当前请求所接受的语言种类
    
    返回:
    
    获取当前支持的语言
  - require
```
public void require(String session_key,
                    Object value,
                    String jump_url,
                    String err)
```
    限制当前Controller类中的所有方法的访问权限。这个方法常用于权限判断如： session中存在uid字段，则说明已登录，如果没有，说明未登录，则跳转到登录页。如果value为空，要求session中存在某个key，如果value不为空，要求session中的值等于value
    
    参数:
    
    session_key - session的key
    
    value - 要求的值
    
    jump_url - 如果不符合条件跳转到的地址
    
    err - 如果jump_url 为空，则不跳转，显示一个错误信息
  - require
```
public void require(String session_key,
                    String jump_url)
```
    限制当前类所有方法的访问权限，一般在构造函数中调用。
    
    参数:
    
    session_key - session中需要存在的key，用来实现判断是否登录等功能
    
    jump_url - 如果session中不存在这样的key，就会直接跳转到该网址
  - download
```
public void download(String path)
```
    输出下载内容。浏览器端会出现下载提示框
    
    参数:
    
    path - 需要下载的文件的路径。
  - header
```
public void header(String name,
                   String val)
```
  - reqBody
```
public String reqBody()
```
    读取请求中的正文部分
    
    返回:
    
    成功返回正文内容，失败返回空字符串
  - renderFreeMarker
```
public void renderFreeMarker(String path)
```
    使用FreeMarker进行数据显示
    
    参数:
    
    path - 基于web.xml中配置的tpl_base值的相对路径
  - T
```
public DBTool T(String tableName)
```
    获取tool对象
    
    参数:
    
    tableName - 数据库表格名称
    
    返回:
    
    相应的DBTool对象（用以进行查询等操作）
  - L
```
public LasyList L(String tableName)
```
    获取LasyList对象
    
    参数:
    
    tableName - 数据库表格名称
    
    返回:
    
    返回所有行的LasyList对象（并没有真正进行查询），可以用 .eq .gt 等函数去约束。
  - runMethod
```
public void runMethod(Method method)
```
    执行某个方法
    
    参数:
    
    method - 要运行的函数
  - json
```
public String json(Object obj,
                   boolean pretty)
```
  - json
```
public String json(Object obj)
```
  - dump
```
public void dump()
```

类 Controller

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

request

response

session

writer

application

构造器详细资料

Controller

方法详细资料

jsp

jsp

freemarker

putParam

isGet

isPost

method

getPath

getDefaultTemp

page

getClearQuery

page

paramWithDefaultInt

render

put

put

putModelItem

existFile

render

paramJSON

setReq

jsonToParam

sess

sess

sessInt

sessDouble

sessStr

removeSession

app

appInt

appDouble

appStr

app

removeApp

cookie

cookie

removeCookie

enableGzip

disableGzip

output

outputBytes

outputJSON

outputJSON

putListTable

renderForm

renderForm

urlParam

param

param

paramInt

paramInt

paramToModel

paramToObj

dumpParam

getParamMap

paramToObj

checkNull

jump

setSingle

isSingle

getLang

require

require

download

header