org.hswebframework.web.controller.file

类 FileController

java.lang.Object

org.hswebframework.web.controller.file.FileController

@RestController
 @RequestMapping(value="${hsweb.web.mappings.file:file}")
 @Authorize(permission="file",
           description="\u6587\u4ef6\u7ba1\u7406")
public class FileController
extends Object

文件操作控制器，提供文件上传下载等操作

从以下版本开始:

3.0

作者:

zhouhao

另请参阅:

FileService

构造器概要

构造器

构造器和说明
FileController()

方法概要

限定符和类型	方法和说明
void	downLoad(String idOrMd5, String name, javax.servlet.http.HttpServletResponse response, javax.servlet.http.HttpServletRequest request) 通过文件ID下载已经上传的文件,支持断点下载 如: http://host:port/file/download/aSk2a/file.zip 将下载 ID为aSk2a的文件.并命名为file.zip
void	downloadTxt(String name, String text, javax.servlet.http.HttpServletResponse response) 构建一个文本文件,并下载.支持GET,POST请求
void	downloadZip(String name, String dataStr, javax.servlet.http.HttpServletResponse response) 构建并下载zip文件.仅支持POST请求
void	restDownLoad(String id, String name, javax.servlet.http.HttpServletResponse response, javax.servlet.http.HttpServletRequest request) 使用restful风格,通过文件ID下载已经上传的文件,支持断点下载 如: http://host:port/file/download/aSk2a/file.zip 将下载 ID为aSk2a的文件.并命名为file.zip
void	setFileInfoService(FileInfoService fileInfoService)
void	setFileService(FileService fileService)
ResponseMessage<FileInfoEntity>	upload(org.springframework.web.multipart.MultipartFile file) 上传单个文件
ResponseMessage<List<FileInfoEntity>>	upload(org.springframework.web.multipart.MultipartFile[] files) 上传文件,支持多文件上传.获取到文件流后,调用FileService.saveFile(InputStream, String, String, String)进行文件保存 上传成功后,将返回资源信息如:[{"id":"fileId","name":"fileName","md5":"md5"}]
ResponseMessage<String>	uploadStatic(org.springframework.web.multipart.MultipartFile file)
ResponseMessage<FileInfoEntity>	uploadStatic(String md5)

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

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

构造器详细资料

FileController

public FileController()

方法详细资料

setFileService

@Autowired
public void setFileService(FileService fileService)

setFileInfoService

@Autowired
public void setFileInfoService(FileInfoService fileInfoService)

downloadZip

@RequestMapping(value="/download-zip/{name:.+}",
                method=POST)
 @Authorize(action="download",
           description="\u4e0b\u8f7d\u6587\u4ef6")
public void downloadZip(@PathVariable(value="name")
                                                                                                                                                                                        String name,
                                                                                                                                                                                        @RequestParam(value="data")
                                                                                                                                                                                        String dataStr,
                                                                                                                                                                                        javax.servlet.http.HttpServletResponse response)
                                                                                                                                                                                 throws IOException

构建并下载zip文件.仅支持POST请求

参数:

name - 文件名

dataStr - 数据,jsonArray. 格式:[{"name":"fileName","text":"fileText"}]

response - HttpServletResponse

抛出:

IOException - 写出zip文件错误

RuntimeException - 构建zip文件错误

downloadTxt

@RequestMapping(value="/download-text/{name:.+}",
                method={GET,POST})
 @Authorize(action="download",
           description="\u4e0b\u8f7d\u6587\u4ef6")
public void downloadTxt(@PathVariable(value="name")
                                                                                                                                                                                               String name,
                                                                                                                                                                                               @RequestParam(value="text")
                                                                                                                                                                                               String text,
                                                                                                                                                                                               javax.servlet.http.HttpServletResponse response)
                                                                                                                                                                                        throws IOException

构建一个文本文件,并下载.支持GET,POST请求

参数:

name - 文件名

text - 文本内容

response - HttpServletResponse

抛出:

IOException - 写出文本内容错误

restDownLoad

@RequestMapping(value="/download/{id}/{name:.+}",
                method=GET)
 @Authorize(action="download",
           description="\u4e0b\u8f7d\u6587\u4ef6")
public void restDownLoad(@PathVariable(value="id")
                                                                                                                                                                                         String id,
                                                                                                                                                                                         @PathVariable(value="name")
                                                                                                                                                                                         String name,
                                                                                                                                                                                         javax.servlet.http.HttpServletResponse response,
                                                                                                                                                                                         javax.servlet.http.HttpServletRequest request)
                                                                                                                                                                                  throws IOException

使用restful风格,通过文件ID下载已经上传的文件,支持断点下载 如: http://host:port/file/download/aSk2a/file.zip 将下载 ID为aSk2a的文件.并命名为file.zip

参数:

id - 文件ID

name - 文件名

response - HttpServletResponse

request - HttpServletRequest

抛出:

IOException - 读写文件错误

org.hswebframework.web.NotFoundException - 文件不存在

downLoad

@GetMapping(value="/download/{id}")
 @Authorize(action="download",
           description="\u4e0b\u8f7d\u6587\u4ef6")
public void downLoad(@PathVariable(value="id")
                                                                                                                                           String idOrMd5,
                                                                                                                                           @RequestParam(value="name",required=false)
                                                                                                                                           String name,
                                                                                                                                           javax.servlet.http.HttpServletResponse response,
                                                                                                                                           javax.servlet.http.HttpServletRequest request)
                                                                                                                                    throws IOException

通过文件ID下载已经上传的文件,支持断点下载 如: http://host:port/file/download/aSk2a/file.zip 将下载 ID为aSk2a的文件.并命名为file.zip

参数:

idOrMd5 - 要下载资源文件的id或者md5值

name - 自定义文件名，该文件名不能存在非法字符.如果此参数为空(null).将使用文件上传时的文件名

response - HttpServletResponse

request - HttpServletRequest

抛出:

IOException - 读写文件错误

org.hswebframework.web.NotFoundException - 文件不存在

upload

@PostMapping(value="/upload-multi")
 @Authorize(action="upload",
           description="\u4e0a\u4f20\u6587\u4ef6")
public ResponseMessage<List<FileInfoEntity>> upload(@RequestPart(value="files")
                                                                                                                                                                        org.springframework.web.multipart.MultipartFile[] files)

上传文件,支持多文件上传.获取到文件流后,调用FileService.saveFile(InputStream, String, String, String)进行文件保存 上传成功后,将返回资源信息如:[{"id":"fileId","name":"fileName","md5":"md5"}]

参数:

files - 上传的文件

返回:

文件上传结果.

upload

@PostMapping(value="/upload")
 @Authorize(action="upload",
           description="\u4e0a\u4f20\u6587\u4ef6")
public ResponseMessage<FileInfoEntity> upload(@RequestPart(value="file")
                                                                                                                                                            org.springframework.web.multipart.MultipartFile file)

上传单个文件

参数:

file - 上传文件

返回:

上传结果

uploadStatic

@PostMapping(value="/upload-static")
 @Authorize(action="static",
           description="\u4e0a\u4f20\u9759\u6001\u6587\u4ef6")
public ResponseMessage<String> uploadStatic(@RequestPart(value="file")
                                                                                                                                                                             org.springframework.web.multipart.MultipartFile file)
                                                                                                                                                                      throws IOException

抛出:

IOException

uploadStatic

@GetMapping(value="/md5/{md5}")
public ResponseMessage<FileInfoEntity> uploadStatic(@PathVariable
                                                                                    String md5)
                                                                             throws IOException

抛出:

IOException