UFileUtil (JustToolc-码云(gitee.com))

java.lang.Object
- com.lc.utils.UFileUtil

```
public class UFileUtil
extends Object
```
文件工具类

Since:

0.1

Author:

LC

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLASS_EXT` Class文件扩展名
`static String`	`JAR_FILE_EXT` Jar文件扩展名
`static String`	`JAR_PATH_EXT` 在Jar中的路径jar的扩展名形式
`static String`	`PATH_FILE_PRE` 当Path为文件形式时, path会加入一个表示文件的前缀

Constructor Summary

Constructors
Constructor and Description

UFileUtil()

Constructors
Constructor and Description
`UFileUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static File`	`file(String path)` 创建File对象，自动识别相对或绝对路径，相对路径将自动从ClassPath下寻找
`static String`	`getAbsolutePath(String path)` 获取绝对路径，相对于ClassPath的目录如果给定就是绝对路径，则返回原路径，原路径把所有\替换为/ 兼容Spring风格的路径表示，例如：classpath:config/example.setting也会被识别后转换
`static String`	`getAbsolutePath(String path, Class<?> baseClass)` 获取绝对路径此方法不会判定给定路径是否有效（文件或目录存在）
`static boolean`	`isAbsolutePath(String path)` 给定路径已经是绝对路径此方法并没有针对路径做标准化，建议先执行`normalize(String)`方法标准化路径后判断
`static boolean`	`isWindows()` 是否为Windows环境
`static File`	`mkParentDirs(File file)` 创建所给文件或目录的父目录
`static String`	`normalize(String path)` 修复路径如果原路径尾部有分隔符，则保留为标准分隔符（/），否则不保留 1.
`static String`	`readableFileSize(long size)` 可读的文件大小参考 http://stackoverflow.com/questions/3263892/format-file-size-as-mb-gb-etc
`static byte[]`	`readBytes(File file)` 读取文件所有数据文件的长度不能超过Integer.MAX_VALUE
`static String`	`readString(File file, Charset charset)` 读取文件内容
`static File`	`touch(File file)` 创建文件及其父目录，如果这个文件存在，直接返回这个文件此方法不对File对象类型做判断，如果File不存在，无法判断其类型
`static File`	`writeBytes(byte[] data, File dest)` 写数据到文件中
`static File`	`writeBytes(byte[] data, File dest, int off, int len, boolean isAppend)` 写入数据到文件
`static File`	`writeString(String content, File file, Charset charset)` 将String写入文件，覆盖模式

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

- Field Detail
  - CLASS_EXT
```
public static final String CLASS_EXT
```
    Class文件扩展名
    
    See Also:
    
    Constant Field Values
  - JAR_FILE_EXT
```
public static final String JAR_FILE_EXT
```
    Jar文件扩展名
    
    See Also:
    
    Constant Field Values
  - JAR_PATH_EXT
```
public static final String JAR_PATH_EXT
```
    在Jar中的路径jar的扩展名形式
    
    See Also:
    
    Constant Field Values
  - PATH_FILE_PRE
```
public static final String PATH_FILE_PRE
```
    当Path为文件形式时, path会加入一个表示文件的前缀
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UFileUtil
```
public UFileUtil()
```
- Method Detail
  - isWindows
```
public static boolean isWindows()
```
    是否为Windows环境
    
    Returns:
    
    是否为Windows环境
  - file
```
public static File file(String path)
```
    创建File对象，自动识别相对或绝对路径，相对路径将自动从ClassPath下寻找
    
    Parameters:
    
    path - 文件路径
    
    Returns:
    
    File
  - getAbsolutePath
```
public static String getAbsolutePath(String path)
```
    获取绝对路径，相对于ClassPath的目录
    如果给定就是绝对路径，则返回原路径，原路径把所有\替换为/
    兼容Spring风格的路径表示，例如：classpath:config/example.setting也会被识别后转换
    
    Parameters:
    
    path - 相对路径
    
    Returns:
    
    绝对路径
  - getAbsolutePath
```
public static String getAbsolutePath(String path,
                                     Class<?> baseClass)
```
    获取绝对路径
    此方法不会判定给定路径是否有效（文件或目录存在）
    
    Parameters:
    
    path - 相对路径
    
    baseClass - 相对路径所相对的类
    
    Returns:
    
    绝对路径
  - isAbsolutePath
```
public static boolean isAbsolutePath(String path)
```
    给定路径已经是绝对路径
    此方法并没有针对路径做标准化，建议先执行normalize(String)方法标准化路径后判断
    
    Parameters:
    
    path - 需要检查的Path
    
    Returns:
    
    是否已经是绝对路径
  - normalize
```
public static String normalize(String path)
```
    修复路径
    如果原路径尾部有分隔符，则保留为标准分隔符（/），否则不保留
    1. 1. 统一用 /
    2. 2. 多个 / 转换为一个 /
    3. 3. 去除两边空格
    4. 4. .. 和 . 转换为绝对路径，当..多于已有路径时，直接返回根路径
    栗子：
```
 "/foo//" =》 "/foo/"
 "/foo/./" =》 "/foo/"
 "/foo/../bar" =》 "/bar"
 "/foo/../bar/" =》 "/bar/"
 "/foo/../bar/../baz" =》 "/baz"
 "/../" =》 "/"
 "foo/bar/.." =》 "foo"
 "foo/../bar" =》 "bar"
 "foo/../../bar" =》 "bar"
 "//server/foo/../bar" =》 "/server/bar"
 "//server/../bar" =》 "/bar"
 "C:\\foo\\..\\bar" =》 "C:/bar"
 "C:\\..\\bar" =》 "C:/bar"
 "~/foo/../bar/" =》 "~/bar/"
 "~/../bar" =》 "bar"
 
```
    Parameters:
    
    path - 原路径
    
    Returns:
    
    修复后的路径
  - readString
```
public static String readString(File file,
                                Charset charset)
                         throws IORuntimeException
```
    读取文件内容
    
    Parameters:
    
    file - 文件
    
    charset - 字符集
    
    Returns:
    
    内容
    
    Throws:
    
    IORuntimeException - IO异常
  - writeString
```
public static File writeString(String content,
                               File file,
                               Charset charset)
                        throws IORuntimeException
```
    将String写入文件，覆盖模式
    
    Parameters:
    
    content - 写入的内容
    
    file - 文件
    
    charset - 字符集
    
    Returns:
    
    被写入的文件
    
    Throws:
    
    IORuntimeException - IO异常
  - touch
```
public static File touch(File file)
                  throws IORuntimeException
```
    创建文件及其父目录，如果这个文件存在，直接返回这个文件
    此方法不对File对象类型做判断，如果File不存在，无法判断其类型
    
    Parameters:
    
    file - 文件对象
    
    Returns:
    
    文件，若路径为null，返回null
    
    Throws:
    
    IORuntimeException - IO异常
  - mkParentDirs
```
public static File mkParentDirs(File file)
```
    创建所给文件或目录的父目录
    
    Parameters:
    
    file - 文件或目录
    
    Returns:
    
    父目录
  - readableFileSize
```
public static String readableFileSize(long size)
```
    可读的文件大小
    参考 http://stackoverflow.com/questions/3263892/format-file-size-as-mb-gb-etc
    
    Parameters:
    
    size - Long类型大小
    
    Returns:
    
    大小
  - readBytes
```
public static byte[] readBytes(File file)
                        throws IORuntimeException
```
    读取文件所有数据
    文件的长度不能超过Integer.MAX_VALUE
    
    Parameters:
    
    file - 文件
    
    Returns:
    
    字节码
    
    Throws:
    
    IORuntimeException - IO异常
  - writeBytes
```
public static File writeBytes(byte[] data,
                              File dest)
                       throws IORuntimeException
```
    写数据到文件中
    
    Parameters:
    
    dest - 目标文件
    
    data - 数据
    
    Returns:
    
    目标文件
    
    Throws:
    
    IORuntimeException - IO异常
  - writeBytes
```
public static File writeBytes(byte[] data,
                              File dest,
                              int off,
                              int len,
                              boolean isAppend)
                       throws IORuntimeException
```
    写入数据到文件
    
    Parameters:
    
    data - 数据
    
    dest - 目标文件
    
    off - 数据开始位置
    
    len - 数据长度
    
    isAppend - 是否追加模式
    
    Returns:
    
    目标文件
    
    Throws:
    
    IORuntimeException - IO异常

Class UFileUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_EXT

JAR_FILE_EXT

JAR_PATH_EXT

PATH_FILE_PRE

Constructor Detail

UFileUtil

Method Detail

isWindows

file

getAbsolutePath

getAbsolutePath

isAbsolutePath

normalize

readString

writeString

touch

mkParentDirs

readableFileSize

readBytes

writeBytes

writeBytes