FileUtils (ymate-platform-v2-码云(gitee.com))

java.lang.Object
- net.ymate.platform.commons.util.FileUtils

```
public class FileUtils
extends Object
```
文件处理工具类

Author:

刘镇 (suninformation@163.com) on 2010-4-23 上午01:14:10

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FILE_CLASS`
`static String`	`FILE_PREFIX_FILE`
`static String`	`FILE_PREFIX_FTP`
`static String`	`FILE_PREFIX_HTTP`
`static String`	`FILE_PREFIX_HTTPS`
`static String`	`FILE_PREFIX_JAR`
`static String`	`FILE_PREFIX_ZIP`
`static String`	`FILE_SUFFIX_CLASS`
`static String`	`FILE_SUFFIX_JSON`
`static String`	`FILE_SUFFIX_PROPERTIES`
`static String`	`FILE_SUFFIX_XML`
`static String`	`POINT_CHAR`
`static String`	`PROTOCOL_FILE`
`static String`	`PROTOCOL_FTP`
`static String`	`PROTOCOL_HTTP`
`static String`	`PROTOCOL_HTTPS`
`static String`	`PROTOCOL_JAR`
`static String`	`PROTOCOL_VFS_FILE`
`static String`	`PROTOCOL_WS_JAR`
`static String`	`PROTOCOL_ZIP`
`static String`	`SEPARATOR_CHAR`

Constructor Summary

Constructors
Constructor and Description

FileUtils()

Constructors
Constructor and Description
`FileUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`createEmptyFile(File newFile)` 在指定路径中创建空文件(同时生成其父级目录)
`static boolean`	`createFileIfNotExists(File newFile, InputStream inputStream)` 在指定路径中创建文件(同时生成其父级目录)若内容流不为空则写入内容
`static String`	`getExtName(String fileName)`
`static String`	`getHash(File targetFile)` 获取文件MD5签名值
`static InputStream`	`loadFileAsStream(String... filePaths)` 按数组顺序查加载文件并返回文件输入流
`static File`	`toFile(URL url)`
`static URL`	`toURL(String filePath)`
`static File`	`toZip(String prefix, File... files)`
`static boolean`	`unpackJarFile(String prefixPath, File targetFile)` 从JAR包中提取/META-INF/{prefixPath}目录下的资源文件并复制到{targetFile}指定的目录中
`static boolean`	`unpackJarFile(String prefixPath, File targetFile, Class<?> callingClass)` 从JAR包中提取/META-INF/{prefixPath}目录下的资源文件并复制到{targetFile}指定的目录中
`static void`	`writeDirTo(File sources, File targetDir)` 复制目录(递归)
`static void`	`writeTo(File src, File dest)` 复制文件

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SEPARATOR_CHAR
```
public static final String SEPARATOR_CHAR
```
    See Also:
    
    Constant Field Values
  - POINT_CHAR
```
public static final String POINT_CHAR
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_JAR
```
public static final String PROTOCOL_JAR
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_WS_JAR
```
public static final String PROTOCOL_WS_JAR
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_ZIP
```
public static final String PROTOCOL_ZIP
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_FILE
```
public static final String PROTOCOL_FILE
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_HTTP
```
public static final String PROTOCOL_HTTP
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_HTTPS
```
public static final String PROTOCOL_HTTPS
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_FTP
```
public static final String PROTOCOL_FTP
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_VFS_FILE
```
public static final String PROTOCOL_VFS_FILE
```
    See Also:
    
    Constant Field Values
  - FILE_PREFIX_JAR
```
public static final String FILE_PREFIX_JAR
```
    See Also:
    
    Constant Field Values
  - FILE_PREFIX_ZIP
```
public static final String FILE_PREFIX_ZIP
```
    See Also:
    
    Constant Field Values
  - FILE_PREFIX_HTTP
```
public static final String FILE_PREFIX_HTTP
```
    See Also:
    
    Constant Field Values
  - FILE_PREFIX_HTTPS
```
public static final String FILE_PREFIX_HTTPS
```
    See Also:
    
    Constant Field Values
  - FILE_PREFIX_FTP
```
public static final String FILE_PREFIX_FTP
```
    See Also:
    
    Constant Field Values
  - FILE_PREFIX_FILE
```
public static final String FILE_PREFIX_FILE
```
    See Also:
    
    Constant Field Values
  - FILE_CLASS
```
public static final String FILE_CLASS
```
    See Also:
    
    Constant Field Values
  - FILE_SUFFIX_CLASS
```
public static final String FILE_SUFFIX_CLASS
```
    See Also:
    
    Constant Field Values
  - FILE_SUFFIX_XML
```
public static final String FILE_SUFFIX_XML
```
    See Also:
    
    Constant Field Values
  - FILE_SUFFIX_PROPERTIES
```
public static final String FILE_SUFFIX_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - FILE_SUFFIX_JSON
```
public static final String FILE_SUFFIX_JSON
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FileUtils
```
public FileUtils()
```
- Method Detail
  - getExtName
```
public static String getExtName(String fileName)
```
    Parameters:
    
    fileName - 原始文件名称
    
    Returns:
    
    提取文件扩展名称，若不存在扩展名则返回原始文件名称
  - getHash
```
public static String getHash(File targetFile)
                      throws IOException
```
    获取文件MD5签名值
    
    Parameters:
    
    targetFile - 目标文件对象
    
    Returns:
    
    返回MD5值
    
    Throws:
    
    IOException - 可能产生的异常
  - toFile
```
public static File toFile(URL url)
```
    Parameters:
    
    url - 目标URL地址
    
    Returns:
    
    将URL地址转换成File对象
  - toURL
```
public static URL toURL(String filePath)
```
    Parameters:
    
    filePath - 目标文件路径
    
    Returns:
    
    将文件路径转换成URL对象, 返回值可能为NULL, 若想将jar包中文件，必须使用URL.toString()方法生成filePath参数—即以"jar:"开头
  - toZip
```
public static File toZip(String prefix,
                         File... files)
                  throws IOException
```
    Parameters:
    
    prefix - 临时文件名前缀, 若为空则由系统随机生成8位长度字符串
    
    files - 文件集合
    
    Returns:
    
    将文件集合压缩成单个ZIP文件
    
    Throws:
    
    IOException - 可能产生的异常
  - writeTo
```
public static void writeTo(File src,
                           File dest)
                    throws IOException
```
    复制文件
    
    Parameters:
    
    src - 原文件
    
    dest - 目标文件
    
    Throws:
    
    IOException - 可能产生的异常
  - unpackJarFile
```
public static boolean unpackJarFile(String prefixPath,
                                    File targetFile)
                             throws IOException
```
    从JAR包中提取/META-INF/{prefixPath}目录下的资源文件并复制到{targetFile}指定的目录中
    
    Parameters:
    
    prefixPath - 资源文件目录名称
    
    targetFile - 目标文件目录
    
    Returns:
    
    是否有文件被提取
    
    Throws:
    
    IOException - 可能生产的任何异常
  - unpackJarFile
```
public static boolean unpackJarFile(String prefixPath,
                                    File targetFile,
                                    Class<?> callingClass)
                             throws IOException
```
    从JAR包中提取/META-INF/{prefixPath}目录下的资源文件并复制到{targetFile}指定的目录中
    
    Parameters:
    
    callingClass - 调用类
    
    prefixPath - 资源文件目录名称
    
    targetFile - 目标文件目录
    
    Returns:
    
    是否有文件被提取
    
    Throws:
    
    IOException - 可能生产的任何异常
  - writeDirTo
```
public static void writeDirTo(File sources,
                              File targetDir)
                       throws IOException
```
    复制目录(递归)
    
    Parameters:
    
    sources - 源目录
    
    targetDir - 目标目录
    
    Throws:
    
    IOException - 可能产生的异常
  - createEmptyFile
```
public static boolean createEmptyFile(File newFile)
                               throws IOException
```
    在指定路径中创建空文件(同时生成其父级目录)
    
    Parameters:
    
    newFile - 新文件
    
    Returns:
    
    若文件创建成功或已存在则返回true, 若存在且为目录则返回false
    
    Throws:
    
    IOException - 可能产生的异常
    
    Since:
    
    2.1.0
  - createFileIfNotExists
```
public static boolean createFileIfNotExists(File newFile,
                                            InputStream inputStream)
                                     throws IOException
```
    在指定路径中创建文件(同时生成其父级目录)若内容流不为空则写入内容
    
    Parameters:
    
    newFile - 新文件
    
    inputStream - 新文件内容流
    
    Returns:
    
    若文件创建成功或已存在则返回true, 若存在且为目录则返回false
    
    Throws:
    
    IOException - 可能产生的异常
    
    Since:
    
    2.1.0
  - loadFileAsStream
```
public static InputStream loadFileAsStream(String... filePaths)
```
    按数组顺序查加载文件并返回文件输入流
    
    Parameters:
    
    filePaths - 文件列表
    
    Returns:
    
    返回文件输入流
    
    Since:
    
    2.1.0

Class FileUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SEPARATOR_CHAR

POINT_CHAR

PROTOCOL_JAR

PROTOCOL_WS_JAR

PROTOCOL_ZIP

PROTOCOL_FILE

PROTOCOL_HTTP

PROTOCOL_HTTPS

PROTOCOL_FTP

PROTOCOL_VFS_FILE

FILE_PREFIX_JAR

FILE_PREFIX_ZIP

FILE_PREFIX_HTTP

FILE_PREFIX_HTTPS

FILE_PREFIX_FTP

FILE_PREFIX_FILE

FILE_CLASS

FILE_SUFFIX_CLASS

FILE_SUFFIX_XML

FILE_SUFFIX_PROPERTIES

FILE_SUFFIX_JSON

Constructor Detail

FileUtils

Method Detail

getExtName

getHash

toFile

toURL

toZip

writeTo

unpackJarFile

unpackJarFile

writeDirTo

createEmptyFile

createFileIfNotExists

loadFileAsStream