FileHelper (diboot-components-file 1.0.2 API)

java.lang.Object
- com.diboot.components.file.FileHelper

```
public class FileHelper
extends Object
```
文件操作辅助类

作者:

Mazc@dibo.ltd

字段概要

字段
限定符和类型	字段和说明
`static String`	`DANGER_FILE_SUFFIX` file验证
`private static String`	`DEFAULT_CONTEXT_TYPE` 默认contextType
`static String`	`EXCEL_SUFFIX` excel格式
`private static Map<String,String>`	`EXT_CONTENT_TYPE_MAP` 文件扩展名-ContentType的对应关系
`static String`	`FILE_STORAGE_DIRECTORY` 文件存储路径参数名
`private static String`	`fileStorageDirectory` 文件和图片的后台存储路径
`private static org.slf4j.Logger`	`logger`
`private static String`	`PATH_AUDIO`
`private static String`	`PATH_FILE` 文件存储路径
`private static String`	`PATH_IMG`
`static String`	`VALID_IMAGE_SUFFIX` image验证

构造器概要

构造器
构造器和说明

FileHelper()

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

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static boolean`	`deleteFile(String fileStoragePath)` 删除文件
`static void`	`downloadLocalFile(String path, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` 根据文件路径与请求信息下载文件
`static boolean`	`downloadRemoteFile(String fileUrl, String targetFilePath)` HTTP下载文件
`static boolean`	`downloadRemoteFileViaHttps(String fileUrl, String targetFilePath)` HTTP下载文件
`static String`	`generateThumbnail(String imgUrl, int width, int height)` 压缩图片
`static String`	`getAudioStoragePath(String category, String name)` 获取录音文件的存储路径
`static String`	`getContextType(String fileName)` 设置ContentType
`static String`	`getFileExtByName(String fileName)` 根据名称取得后缀
`static String`	`getFileName(String fileURL)` 根据文件URL解析出其文件名
`static String`	`getFileStorageDirectory()` 文件的存储路径
`static String`	`getFileStoragePath(String fileName)` 获取文件的存储路径
`static String`	`getFullFilePath(String filePath)` 获取文件的全路径
`static String`	`getImageStoragePath(String imageName)` 得到图片存储的全路径
`static String`	`getSystemTempDir()` 获取系统临时目录
`static boolean`	`isExcel(String fileName)` 是否是图片类型
`static boolean`	`isImage(String ext)` 是否是图片类型
`static boolean`	`isValidFileExt(String ext)` 是否为合法的文件类型
`static boolean`	`makeDirectory(String dirPath)` 创建文件夹
`static String`	`saveFile(File file, String fileName, boolean reserve)` 上传文件
`static String`	`saveFile(org.springframework.web.multipart.MultipartFile file, String fileName)` 上传文件
`static String`	`saveFile2TempDir(org.springframework.web.multipart.MultipartFile file, String fileName)` 将文件保存到系统临时目录
`static String`	`saveImage(File file, String imgName, boolean reserve)` 保存图片
`static String`	`saveImage(org.springframework.web.multipart.MultipartFile file, String imgName)` 保存图片

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

字段详细资料
- logger
```
private static final org.slf4j.Logger logger
```
- VALID_IMAGE_SUFFIX
```
public static final String VALID_IMAGE_SUFFIX
```
  image验证
  
  另请参阅:
  
  常量字段值
- DANGER_FILE_SUFFIX
```
public static final String DANGER_FILE_SUFFIX
```
  file验证
  
  另请参阅:
  
  常量字段值
- EXCEL_SUFFIX
```
public static final String EXCEL_SUFFIX
```
  excel格式
  
  另请参阅:
  
  常量字段值
- FILE_STORAGE_DIRECTORY
```
public static final String FILE_STORAGE_DIRECTORY
```
  文件存储路径参数名
  
  另请参阅:
  
  常量字段值
- PATH_FILE
```
private static final String PATH_FILE
```
  文件存储路径
  
  另请参阅:
  
  常量字段值
- PATH_IMG
```
private static final String PATH_IMG
```
  另请参阅:
  
  常量字段值
- PATH_AUDIO
```
private static final String PATH_AUDIO
```
  另请参阅:
  
  常量字段值
- DEFAULT_CONTEXT_TYPE
```
private static final String DEFAULT_CONTEXT_TYPE
```
  默认contextType
  
  另请参阅:
  
  常量字段值
- EXT_CONTENT_TYPE_MAP
```
private static Map<String,String> EXT_CONTENT_TYPE_MAP
```
  文件扩展名-ContentType的对应关系
- fileStorageDirectory
```
private static String fileStorageDirectory
```
  文件和图片的后台存储路径

构造器详细资料
- FileHelper
```
public FileHelper()
```

方法详细资料

isValidFileExt
```
public static boolean isValidFileExt(String ext)
```
是否为合法的文件类型

参数:

ext -

返回:

isImage

public static boolean isImage(String ext)

是否是图片类型

参数:: ext -
返回:

isExcel

public static boolean isExcel(String fileName)

是否是图片类型

参数:: fileName -
返回:

getSystemTempDir
```
public static String getSystemTempDir()
```
获取系统临时目录

返回:

saveFile2TempDir

public static String saveFile2TempDir(org.springframework.web.multipart.MultipartFile file,
                                      String fileName)

将文件保存到系统临时目录

参数:: file -; fileName -
返回:

saveImage

public static String saveImage(org.springframework.web.multipart.MultipartFile file,
                               String imgName)

保存图片

参数:: file - 上传文件; imgName - 图片名称

saveImage

public static String saveImage(File file,
                               String imgName,
                               boolean reserve)

保存图片

参数:: file - 上传文件; imgName - 图片名称; reserve - 是否保留原图片
返回:

saveFile

public static String saveFile(org.springframework.web.multipart.MultipartFile file,
                              String fileName)

上传文件

参数:: file - 上传文件; fileName - 文件名
返回:

saveFile

public static String saveFile(File file,
                              String fileName,
                              boolean reserve)

上传文件

参数:: file - 上传文件; fileName - 文件名; reserve - 保留原文件
返回:

getFileExtByName

public static String getFileExtByName(String fileName)

根据名称取得后缀

参数:: fileName -
返回:

getImageStoragePath
```
public static String getImageStoragePath(String imageName)
```
得到图片存储的全路径

参数:

imageName -

返回:

getFileStoragePath
```
public static String getFileStoragePath(String fileName)
```
获取文件的存储路径

参数:

fileName -

返回:

getAudioStoragePath

public static String getAudioStoragePath(String category,
                                         String name)

获取录音文件的存储路径

参数:: category -
返回:

getFullFilePath

public static String getFullFilePath(String filePath)

获取文件的全路径

返回:

getFileName
```
public static String getFileName(String fileURL)
```
根据文件URL解析出其文件名

参数:

fileURL -

返回:

getFileStorageDirectory

public static String getFileStorageDirectory()

文件的存储路径

返回:

makeDirectory

public static boolean makeDirectory(String dirPath)

创建文件夹

参数:: dirPath -
返回:

generateThumbnail

public static String generateThumbnail(String imgUrl,
                                       int width,
                                       int height)

压缩图片

参数:: imgUrl -
返回:

downloadRemoteFile

public static boolean downloadRemoteFile(String fileUrl,
                                         String targetFilePath)

HTTP下载文件

参数:: fileUrl -; targetFilePath -
返回:

downloadLocalFile

public static void downloadLocalFile(String path,
                                     javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)
                              throws Exception

根据文件路径与请求信息下载文件

参数:: path -; request -; response -
抛出:: Exception

downloadRemoteFileViaHttps

public static boolean downloadRemoteFileViaHttps(String fileUrl,
                                                 String targetFilePath)

HTTP下载文件

参数:: fileUrl -; targetFilePath -
返回:

deleteFile

public static boolean deleteFile(String fileStoragePath)

删除文件

参数:: fileStoragePath -

getContextType

public static String getContextType(String fileName)

设置ContentType

参数:: fileName -
返回:

类 FileHelper

字段概要

构造器概要

方法概要

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

字段详细资料

logger

VALID_IMAGE_SUFFIX

DANGER_FILE_SUFFIX

EXCEL_SUFFIX

FILE_STORAGE_DIRECTORY

PATH_FILE

PATH_IMG

PATH_AUDIO

DEFAULT_CONTEXT_TYPE

EXT_CONTENT_TYPE_MAP

fileStorageDirectory

构造器详细资料

FileHelper

方法详细资料

isValidFileExt

isImage

isExcel

getSystemTempDir

saveFile2TempDir

saveImage

saveImage

saveFile

saveFile

getFileExtByName

getImageStoragePath

getFileStoragePath

getAudioStoragePath

getFullFilePath

getFileName

getFileStorageDirectory

makeDirectory

generateThumbnail

downloadRemoteFile

downloadLocalFile

downloadRemoteFileViaHttps

deleteFile

getContextType