FileUtil (tiny-码云(gitee.com))

java.lang.Object
- org.tinygroup.commons.tools.FileUtil

```
public class FileUtil
extends Object
```
操作文件的工具类

Author:

renhui

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FileUtil.FileNameAndExtension

Nested Classes
Modifier and Type	Class and Description
`static class`	`FileUtil.FileNameAndExtension`

Constructor Summary

Constructors
Constructor and Description

FileUtil()

Constructors
Constructor and Description
`FileUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`delete(File file)`
`static String`	`getAbsolutePathBasedOn(String basedir, String path)` 如果指定路径已经是绝对路径，则规格化后直接返回之，否则取得基于指定basedir的规格化路径。
`static String`	`getExtension(String fileName)` 取得文件路径的后缀。未指定文件名 - 返回`null`。文件名没有后缀 - 返回`null`。
`static String`	`getExtension(String fileName, boolean toLowerCase)` 取得文件路径的后缀。未指定文件名 - 返回`null`。文件名没有后缀 - 返回`null`。
`static String`	`getExtension(String fileName, String nullExt)` 取得文件路径的后缀。未指定文件名 - 返回`null`。文件名没有后缀 - 返回指定字符串`nullExt`。
`static String`	`getExtension(String fileName, String nullExt, boolean toLowerCase)` 取得文件路径的后缀。未指定文件名 - 返回`null`。文件名没有后缀 - 返回指定字符串`nullExt`。
`static FileUtil.FileNameAndExtension`	`getFileNameAndExtension(String path)` 取得指定路径的名称和后缀。
`static FileUtil.FileNameAndExtension`	`getFileNameAndExtension(String path, boolean extensionToLowerCase)` 取得指定路径的名称和后缀。
`static String`	`getRelativePath(String basedir, String path)` 取得相对于指定根目录的相对路径。
`static String`	`getSystemDependentAbsolutePathBasedOn(String basedir, String path)` 取得和系统相关的绝对路径。
`static String`	`normalizeAbsolutePath(String path)` 规格化绝对路径。
`static String`	`normalizeAbsolutePath(String path, boolean removeTrailingSlash)` 规格化绝对路径。
`static String`	`normalizeExtension(String ext)` 规格化文件名后缀。除去两边空白。转成小写。除去开头的“`.`”。对空白的后缀，返回`null`。
`static String`	`normalizePath(String path)` 规格化路径。规则如下：路径为空，则返回`""`。将所有backslash("\\")转化成slash("/")。去除重复的"/"或"\\"。去除"."，如果发现".."，则向上朔一级目录。空绝对路径返回"/"，空相对路径返回""。保留路径末尾的"/"（如果有的话，除了空路径）。对于绝对路径，如果".."上朔的路径超过了根目录，则看作非法路径，抛出异常。
`static String`	`normalizePath(String path, boolean removeTrailingSlash)` 规格化路径。规则如下：路径为空，则返回`""`。将所有backslash("\\")转化成slash("/")。去除重复的"/"或"\\"。去除"."，如果发现".."，则向上朔一级目录。空绝对路径返回"/"，空相对路径返回""。保留路径末尾的"/"（如果有的话，除了空路径和强制指定`removeTrailingSlash==true`）。对于绝对路径，如果".."上朔的路径超过了根目录，则看作非法路径，抛出异常。
`static String`	`normalizeRelativePath(String path)` 规格化相对路径。
`static String`	`normalizeRelativePath(String path, boolean removeTrailingSlash)` 规格化相对路径。
`static String`	`readFileContent(File file, String encoding)`
`static String`	`readStreamContent(InputStream stream, String encoding)`
`static String`	`resolve(String url, String relativePath)` 根据指定url和相对路径，计算出相对路径所对应的完整url。类似于`URI.resolve()` 方法，然后后者不能正确处理jar类型的URL。

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

- Constructor Detail
  - FileUtil
```
public FileUtil()
```
- Method Detail
  - readFileContent
```
public static String readFileContent(File file,
                                     String encoding)
                              throws Exception
```
    Throws:
    
    Exception
  - readStreamContent
```
public static String readStreamContent(InputStream stream,
                                       String encoding)
                                throws Exception
```
    Throws:
    
    Exception
  - normalizeAbsolutePath
```
public static String normalizeAbsolutePath(String path)
                                    throws IllegalPathException
```
    规格化绝对路径。
    该方法返回以“/”开始的绝对路径。转换规则如下：
    1. 路径为空，则返回""。
    2. 将所有backslash("\\")转化成slash("/")。
    3. 去除重复的"/"或"\\"。
    4. 去除"."，如果发现".."，则向上朔一级目录。
    5. 保留路径末尾的"/"（如果有的话，除了空路径）。
    6. 对于绝对路径，如果".."上朔的路径超过了根目录，则看作非法路径，抛出异常。
    Parameters:
    
    path - 要规格化的路径
    
    Returns:
    
    规格化后的路径
    
    Throws:
    
    IllegalPathException - 如果路径非法
  - normalizeAbsolutePath
```
public static String normalizeAbsolutePath(String path,
                                           boolean removeTrailingSlash)
                                    throws IllegalPathException
```
    规格化绝对路径。
    该方法返回以“/”开始的绝对路径。转换规则如下：
    1. 路径为空，则返回""。
    2. 将所有backslash("\\")转化成slash("/")。
    3. 去除重复的"/"或"\\"。
    4. 去除"."，如果发现".."，则向上朔一级目录。
    5. 保留路径末尾的"/"（如果有的话，除了空路径和强制指定removeTrailingSlash==true）。
    6. 对于绝对路径，如果".."上朔的路径超过了根目录，则看作非法路径，抛出异常。
    Parameters:
    
    path - 要规格化的路径
    
    removeTrailingSlash - 是否强制移除末尾的"/"
    
    Returns:
    
    规格化后的路径
    
    Throws:
    
    IllegalPathException - 如果路径非法
  - normalizeRelativePath
```
public static String normalizeRelativePath(String path)
                                    throws IllegalPathException
```
    规格化相对路径。
    该方法返回不以“/”开始的相对路径。转换规则如下：
    1. 路径为空，则返回""。
    2. 将所有backslash("\\")转化成slash("/")。
    3. 去除重复的"/"或"\\"。
    4. 去除"."，如果发现".."，则向上朔一级目录。
    5. 空相对路径返回""。
    6. 保留路径末尾的"/"（如果有的话，除了空路径）。
    Parameters:
    
    path - 要规格化的路径
    
    Returns:
    
    规格化后的路径
    
    Throws:
    
    IllegalPathException - 如果路径非法
  - normalizeRelativePath
```
public static String normalizeRelativePath(String path,
                                           boolean removeTrailingSlash)
                                    throws IllegalPathException
```
    规格化相对路径。
    该方法返回不以“/”开始的相对路径。转换规则如下：
    1. 路径为空，则返回""。
    2. 将所有backslash("\\")转化成slash("/")。
    3. 去除重复的"/"或"\\"。
    4. 去除"."，如果发现".."，则向上朔一级目录。
    5. 空相对路径返回""。
    6. 保留路径末尾的"/"（如果有的话，除了空路径和强制指定removeTrailingSlash==true）。
    Parameters:
    
    path - 要规格化的路径
    
    removeTrailingSlash - 是否强制移除末尾的"/"
    
    Returns:
    
    规格化后的路径
    
    Throws:
    
    IllegalPathException - 如果路径非法
  - normalizePath
```
public static String normalizePath(String path)
                            throws IllegalPathException
```
    规格化路径。规则如下：
    1. 路径为空，则返回""。
    2. 将所有backslash("\\")转化成slash("/")。
    3. 去除重复的"/"或"\\"。
    4. 去除"."，如果发现".."，则向上朔一级目录。
    5. 空绝对路径返回"/"，空相对路径返回""。
    6. 保留路径末尾的"/"（如果有的话，除了空路径）。
    7. 对于绝对路径，如果".."上朔的路径超过了根目录，则看作非法路径，抛出异常。
    Parameters:
    
    path - 要规格化的路径
    
    Returns:
    
    规格化后的路径
    
    Throws:
    
    IllegalPathException - 如果路径非法
  - normalizePath
```
public static String normalizePath(String path,
                                   boolean removeTrailingSlash)
                            throws IllegalPathException
```
    规格化路径。规则如下：
    1. 路径为空，则返回""。
    2. 将所有backslash("\\")转化成slash("/")。
    3. 去除重复的"/"或"\\"。
    4. 去除"."，如果发现".."，则向上朔一级目录。
    5. 空绝对路径返回"/"，空相对路径返回""。
    6. 保留路径末尾的"/"（如果有的话，除了空路径和强制指定removeTrailingSlash==true）。
    7. 对于绝对路径，如果".."上朔的路径超过了根目录，则看作非法路径，抛出异常。
    Parameters:
    
    path - 要规格化的路径
    
    removeTrailingSlash - 是否强制移除末尾的"/"
    
    Returns:
    
    规格化后的路径
    
    Throws:
    
    IllegalPathException - 如果路径非法
  - getAbsolutePathBasedOn
```
public static String getAbsolutePathBasedOn(String basedir,
                                            String path)
                                     throws IllegalPathException
```
    如果指定路径已经是绝对路径，则规格化后直接返回之，否则取得基于指定basedir的规格化路径。
    
    Parameters:
    
    basedir - 根目录，如果path为相对路径，表示基于此目录
    
    path - 要检查的路径
    
    Returns:
    
    规格化的绝对路径
    
    Throws:
    
    IllegalPathException - 如果路径非法
  - getSystemDependentAbsolutePathBasedOn
```
public static String getSystemDependentAbsolutePathBasedOn(String basedir,
                                                           String path)
```
    取得和系统相关的绝对路径。
    
    Throws:
    
    IllegalPathException - 如果basedir不是绝对路径
  - getRelativePath
```
public static String getRelativePath(String basedir,
                                     String path)
                              throws IllegalPathException
```
    取得相对于指定根目录的相对路径。
    
    Parameters:
    
    basedir - 根目录
    
    path - 要计算的路径
    
    Returns:
    
    如果path和basedir是兼容的，则返回相对于 basedir的相对路径，否则返回path本身。
    
    Throws:
    
    IllegalPathException - 如果路径非法
  - getExtension
```
public static String getExtension(String fileName)
```
    取得文件路径的后缀。
    - 未指定文件名 - 返回null。
    - 文件名没有后缀 - 返回null。
  - getExtension
```
public static String getExtension(String fileName,
                                  boolean toLowerCase)
```
    取得文件路径的后缀。
    - 未指定文件名 - 返回null。
    - 文件名没有后缀 - 返回null。
  - getExtension
```
public static String getExtension(String fileName,
                                  String nullExt)
```
    取得文件路径的后缀。
    - 未指定文件名 - 返回null。
    - 文件名没有后缀 - 返回指定字符串nullExt。
  - getExtension
```
public static String getExtension(String fileName,
                                  String nullExt,
                                  boolean toLowerCase)
```
    取得文件路径的后缀。
    - 未指定文件名 - 返回null。
    - 文件名没有后缀 - 返回指定字符串nullExt。
  - getFileNameAndExtension
```
public static FileUtil.FileNameAndExtension getFileNameAndExtension(String path)
```
    取得指定路径的名称和后缀。
    
    Parameters:
    
    path - 路径
    
    Returns:
    
    路径和后缀
  - getFileNameAndExtension
```
public static FileUtil.FileNameAndExtension getFileNameAndExtension(String path,
                                                                    boolean extensionToLowerCase)
```
    取得指定路径的名称和后缀。
    
    Parameters:
    
    path - 路径
    
    Returns:
    
    路径和后缀
  - normalizeExtension
```
public static String normalizeExtension(String ext)
```
    规格化文件名后缀。
    - 除去两边空白。
    - 转成小写。
    - 除去开头的“.”。
    - 对空白的后缀，返回null。
  - resolve
```
public static String resolve(String url,
                             String relativePath)
```
    根据指定url和相对路径，计算出相对路径所对应的完整url。类似于URI.resolve() 方法，然后后者不能正确处理jar类型的URL。
  - delete
```
public static void delete(File file)
```

Class FileUtil

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileUtil

Method Detail

readFileContent

readStreamContent

normalizeAbsolutePath

normalizeAbsolutePath

normalizeRelativePath

normalizeRelativePath

normalizePath

normalizePath

getAbsolutePathBasedOn

getSystemDependentAbsolutePathBasedOn

getRelativePath

getExtension

getExtension

getExtension

getExtension

getFileNameAndExtension

getFileNameAndExtension

normalizeExtension

resolve

delete