response模块
# 引用模块
import response;
# page
- 入参:
total
:long
- 入参:
values
:list
- 返回值:
Object
- 函数说明:构建分页结果
import response;
//返回: 共计10条,第一页的5条数据
return response.page(10,[1,2,3,4,5]);
# json
- 入参:
value
:Object
- 返回值:
ResponseEntity
- 函数说明:构建Json结果
import response;
//直接返回该json,不会被包装处理
return response.json({
success : true,
message : '执行成功'
});
# text
- 入参:
value
:String
文本内容 - 返回值:
ResponseEntity
- 函数说明:输出文本
import response;
//直接返回该text,不会被包装处理
return response.text('ok');
# redirect
- 入参:
url
:String
目标网址 - 返回值:
ResponseEntity
- 函数说明:重定向
import response;
//重定向到该地址,内部利用HttpServletResponse的sendRedirect方法
return response.redirect('/xxx/xx');
# download
- 入参:
value
:Object
- 入参:
filename
:文件名
- 返回值:
ResponseEntity
- 函数说明:下载文件
import response;
return response.download('文件内容','test.txt');
# image
- 入参:
value
:Object
- 入参:
mine
:String
- 返回值:
ResponseEntity
- 函数说明:主要用于输出图片
import response;
// 输出图片
return response.image(bytes,'image/png');
# addHeader
- 入参:
key
:string
- 入参:
value
:String
- 返回值:无返回值
- 函数说明:添加Response Header
import response;
response.addHeader('AccessToken','123');
# setHeader
- 入参:
key
:string
- 入参:
value
:String
- 返回值:无返回值
- 函数说明:设置Response Header
import response;
response.setHeader('AccessToken','123');
# addCookie
- 入参:
key
:string
- 入参:
value
:String
- 入参:
options
:Map
cookie参数,可选 - 返回值:无返回值
- 函数说明:添加Cookie
import response;
response.addCookie('cookieKey','cookieValue');
response.addCookie('cookieKey','cookieValue',{
path : '/',
httpOnly : true,
domain : 'ssssssss.org',
maxAge : 3600
});
# addCookies
- 入参:
cookies
:Map
cookie Map,必填 - 入参:
options
:Map
cookie参数,可选 - 返回值:无返回值
- 函数说明:批量添加Cookie
import response;
response.addCookies({
cookieKey1 : 'cookieValue1',
cookieKey2 : 'cookieValue2',
});
response.addCookies({
cookieKey1 : 'cookieValue1',
cookieKey2 : 'cookieValue2',
},{
path : '/',
httpOnly : true,
domain : 'ssssssss.org',
maxAge : 3600
});
# getOutputStream
返回值:
OutputStream
函数说明:获取
ServletOutputStream
提示
在调用
getOutputStream
后 返回值应为response.end()
告诉框架无需处理返回值。
# end
- 返回值:无返回值
- 函数说明:取消返回默认的json结构,通过其他方式的输出结果(如:调用outputstream输出)
上次更新: 2023-03-23 13:11:51