org.ssssssss.magicapi.modules

类 ResponseModule

java.lang.Object

org.ssssssss.magicapi.modules.ResponseModule

public class ResponseModule
extends Object

response模块

作者:

mxd

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	ResponseModule.NullValue

构造器概要

构造器

构造器和说明
ResponseModule(ResultProvider resultProvider)

方法概要

限定符和类型	方法和说明
ResponseModule	addCookie(javax.servlet.http.Cookie cookie) 添加cookie
ResponseModule	addCookie(String name, String value) 添加cookie
ResponseModule	addCookie(String name, String value, Map<String,Object> options) 添加cookie
ResponseModule	addCookies(Map<String,String> cookies) 批量添加cookie
ResponseModule	addCookies(Map<String,String> cookies, Map<String,Object> options) 批量添加cookie
ResponseModule	addHeader(String key, String value) 添加Header
static org.springframework.http.ResponseEntity<?>	download(Object value, String filename) 文件下载
ResponseModule.NullValue	end()
OutputStream	getOutputStream() 获取OutputStream
org.springframework.http.ResponseEntity	image(Object value, String mime) 展示图片
org.springframework.http.ResponseEntity<Object>	json(Object value) 自定义json结果
Object	page(long total, List<Map<String,Object>> values) 自行构建分页结果
ResponseModule	setHeader(String key, String value) 设置header

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

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

构造器详细资料

ResponseModule

public ResponseModule(ResultProvider resultProvider)

方法详细资料

download

@Comment(value="\u6587\u4ef6\u4e0b\u8f7d")
public static org.springframework.http.ResponseEntity<?> download(@Comment(name="value",value="\u6587\u4ef6\u5185\u5bb9\uff0c\u5982`byte[]`")
                                                                                                              Object value,
                                                                                                              @Comment(name="filename",value="\u6587\u4ef6\u540d")
                                                                                                              String filename)
                                                                                                       throws UnsupportedEncodingException

文件下载

参数:

value - 文件内容

filename - 文件名

抛出:

UnsupportedEncodingException

page

@Comment(value="\u8fd4\u56de\u81ea\u5b9a\u4e49\u5206\u9875\u7ed3\u679c")
public Object page(@Comment(name="total",value="\u603b\u6761\u6570")
                                                                                             long total,
                                                                                             @Comment(name="values",value="\u5f53\u524d\u7ed3\u679c\u96c6")
                                                                                             List<Map<String,Object>> values)

自行构建分页结果

参数:

total - 条数

values - 数据内容

json

@Comment(value="\u81ea\u5b9a\u4e49\u8fd4\u56dejson\u5185\u5bb9")
public org.springframework.http.ResponseEntity<Object> json(@Comment(name="value",value="\u8fd4\u56de\u5bf9\u8c61")
                                                                                                                              Object value)

自定义json结果

参数:

value - json内容

addHeader

@Comment(value="\u6dfb\u52a0response header")
public ResponseModule addHeader(@Comment(name="key",value="header\u540d")
                                                                               String key,
                                                                               @Comment(name="value",value="header\u503c")
                                                                               String value)

添加Header

setHeader

@Comment(value="\u8bbe\u7f6eresponse header")
public ResponseModule setHeader(@Comment(name="key",value="header\u540d")
                                                                               String key,
                                                                               @Comment(name="value",value="header\u503c")
                                                                               String value)

设置header

addCookie

@Comment(value="\u6dfb\u52a0Cookie")
public ResponseModule addCookie(@Comment(name="name",value="cookie\u540d")
                                                                      String name,
                                                                      @Comment(name="value",value="cookie\u503c")
                                                                      String value)

添加cookie

addCookies

@Comment(value="\u6279\u91cf\u6dfb\u52a0Cookie")
public ResponseModule addCookies(@Comment(name="cookies",value="Cookies")
                                                                                   Map<String,String> cookies,
                                                                                   @Comment(name="options",value="Cookie\u9009\u9879\uff0c\u5982`path`\u3001`httpOnly`\u3001`domain`\u3001`maxAge`")
                                                                                   Map<String,Object> options)

批量添加cookie

addCookies

@Comment(value="\u6279\u91cf\u6dfb\u52a0Cookie")
public ResponseModule addCookies(@Comment(name="cookies",value="Cookies")
                                                                                   Map<String,String> cookies)

批量添加cookie

getOutputStream

@Comment(value="\u83b7\u53d6OutputStream")
public OutputStream getOutputStream()
                                                                         throws IOException

获取OutputStream

抛出:

IOException

从以下版本开始:

1.2.3

addCookie

@Comment(value="\u6dfb\u52a0Cookie")
public ResponseModule addCookie(@Comment(name="name",value="Cookie\u540d")
                                                                      String name,
                                                                      @Comment(name="value",value="Cookie\u503c")
                                                                      String value,
                                                                      @Comment(name="options",value="Cookie\u9009\u9879\uff0c\u5982`path`\u3001`httpOnly`\u3001`domain`\u3001`maxAge`")
                                                                      Map<String,Object> options)

添加cookie

end

@Comment(value="\u7ec8\u6b62\u8f93\u51fa\uff0c\u6267\u884c\u6b64\u65b9\u6cd5\u540e\u4e0d\u4f1a\u5bf9\u7ed3\u679c\u8fdb\u884c\u4efb\u4f55\u8f93\u51fa\u53ca\u5904\u7406")
public ResponseModule.NullValue end()

addCookie

@Comment(value="\u6dfb\u52a0Cookie")
public ResponseModule addCookie(@Comment(name="cookie",value="Cookie\u5bf9\u8c61")
                                                                      javax.servlet.http.Cookie cookie)

添加cookie

image

@Comment(value="\u8f93\u51fa\u56fe\u7247")
public org.springframework.http.ResponseEntity image(@Comment(name="value",value="\u56fe\u7247\u5185\u5bb9\uff0c\u5982`byte[]`")
                                                                                                 Object value,
                                                                                                 @Comment(name="mime",value="\u56fe\u7247\u7c7b\u578b\uff0c\u5982`image/png`\u3001`image/jpeg`\u3001`image/gif`")
                                                                                                 String mime)

展示图片

参数:

value - 图片内容

mime - 图片类型，image/png,image/jpeg,image/gif