ResourceUtil (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.core.io.resource.ResourceUtil

public class ResourceUtil
extends Object

Resource资源工具类

Author:: Looly

Constructor Summary

Constructors
Constructor and Description

ResourceUtil()

Constructors
Constructor and Description
`ResourceUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static BufferedReader`	`getReader(String resource, Charset charset)` 从ClassPath资源中获取`BufferedReader`
`static URL`	`getResource(String resource)` 获得资源的URL 路径用/分隔，例如: config/a/db.config spring/xml/test.xml
`static URL`	`getResource(String resource, Class<?> baseClass)` 获得资源相对路径对应的URL
`static EnumerationIter<URL>`	`getResourceIter(String resource)` 获取指定路径下的资源Iterator 路径格式必须为目录格式,用/分隔，例如: config/a spring/xml
`static EnumerationIter<URL>`	`getResourceIter(String resource, ClassLoader classLoader)` 获取指定路径下的资源Iterator 路径格式必须为目录格式,用/分隔，例如: config/a spring/xml
`static Resource`	`getResourceObj(String path)` 获取`Resource` 资源对象如果提供路径为绝对路径或路径以file:开头，返回`FileResource`，否则返回`ClassPathResource`
`static List<URL>`	`getResources(String resource)` 获取指定路径下的资源列表路径格式必须为目录格式,用/分隔，例如: config/a spring/xml
`static List<URL>`	`getResources(String resource, Filter<URL> filter)` 获取指定路径下的资源列表路径格式必须为目录格式,用/分隔，例如: config/a spring/xml
`static InputStream`	`getStream(String resource)` 从ClassPath资源中获取`InputStream`
`static InputStream`	`getStreamSafe(String resource)` 从ClassPath资源中获取`InputStream`，当资源不存在时返回null
`static BufferedReader`	`getUtf8Reader(String resource)` 从ClassPath资源中获取`BufferedReader`
`static byte[]`	`readBytes(String resource)` 读取Classpath下的资源为byte[]
`static String`	`readStr(String resource, Charset charset)` 读取Classpath下的资源为字符串
`static String`	`readUtf8Str(String resource)` 读取Classpath下的资源为字符串，使用UTF-8编码

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

- Constructor Detail
  - ResourceUtil
```
public ResourceUtil()
```
- Method Detail
  - readUtf8Str
```
public static String readUtf8Str(String resource)
```
    读取Classpath下的资源为字符串，使用UTF-8编码
    
    Parameters:
    
    resource - 资源路径，使用相对ClassPath的路径
    
    Returns:
    
    资源内容
    
    Since:
    
    3.1.1
  - readStr
```
public static String readStr(String resource,
                             Charset charset)
```
    读取Classpath下的资源为字符串
    
    Parameters:
    
    resource - 可以是绝对路径，也可以是相对路径（相对ClassPath）
    
    charset - 编码
    
    Returns:
    
    资源内容
    
    Since:
    
    3.1.1
  - readBytes
```
public static byte[] readBytes(String resource)
```
    读取Classpath下的资源为byte[]
    
    Parameters:
    
    resource - 可以是绝对路径，也可以是相对路径（相对ClassPath）
    
    Returns:
    
    资源内容
    
    Since:
    
    4.5.19
  - getStream
```
public static InputStream getStream(String resource)
                             throws NoResourceException
```
    从ClassPath资源中获取InputStream
    
    Parameters:
    
    resource - ClassPath资源
    
    Returns:
    
    InputStream
    
    Throws:
    
    NoResourceException - 资源不存在异常
    
    Since:
    
    3.1.2
  - getStreamSafe
```
public static InputStream getStreamSafe(String resource)
```
    从ClassPath资源中获取InputStream，当资源不存在时返回null
    
    Parameters:
    
    resource - ClassPath资源
    
    Returns:
    
    InputStream
    
    Since:
    
    4.0.3
  - getUtf8Reader
```
public static BufferedReader getUtf8Reader(String resource)
```
    从ClassPath资源中获取BufferedReader
    
    Parameters:
    
    resource - ClassPath资源
    
    Returns:
    
    InputStream
    
    Since:
    
    5.3.6
  - getReader
```
public static BufferedReader getReader(String resource,
                                       Charset charset)
```
    从ClassPath资源中获取BufferedReader
    
    Parameters:
    
    resource - ClassPath资源
    
    charset - 编码
    
    Returns:
    
    InputStream
    
    Since:
    
    3.1.2
  - getResource
```
public static URL getResource(String resource)
                       throws IORuntimeException
```
    获得资源的URL
    路径用/分隔，例如:
```
 config/a/db.config
 spring/xml/test.xml
 
```
    Parameters:
    
    resource - 资源（相对Classpath的路径）
    
    Returns:
    
    资源URL
    
    Throws:
    
    IORuntimeException
  - getResources
```
public static List<URL> getResources(String resource)
```
    获取指定路径下的资源列表
    路径格式必须为目录格式,用/分隔，例如:
```
 config/a
 spring/xml
 
```
    Parameters:
    
    resource - 资源路径
    
    Returns:
    
    资源列表
  - getResources
```
public static List<URL> getResources(String resource,
                                     Filter<URL> filter)
```
    获取指定路径下的资源列表
    路径格式必须为目录格式,用/分隔，例如:
```
 config/a
 spring/xml
 
```
    Parameters:
    
    resource - 资源路径
    
    filter - 过滤器，用于过滤不需要的资源，null表示不过滤，保留所有元素
    
    Returns:
    
    资源列表
  - getResourceIter
```
public static EnumerationIter<URL> getResourceIter(String resource)
```
    获取指定路径下的资源Iterator
    路径格式必须为目录格式,用/分隔，例如:
```
 config/a
 spring/xml
 
```
    Parameters:
    
    resource - 资源路径
    
    Returns:
    
    资源列表
    
    Since:
    
    4.1.5
  - getResourceIter
```
public static EnumerationIter<URL> getResourceIter(String resource,
                                                   ClassLoader classLoader)
```
    获取指定路径下的资源Iterator
    路径格式必须为目录格式,用/分隔，例如:
```
 config/a
 spring/xml
 
```
    Parameters:
    
    resource - 资源路径
    
    classLoader - ClassLoader
    
    Returns:
    
    资源列表
    
    Since:
    
    4.1.5
  - getResource
```
public static URL getResource(String resource,
                              Class<?> baseClass)
```
    获得资源相对路径对应的URL
    
    Parameters:
    
    resource - 资源相对路径，null和""都表示classpath根路径
    
    baseClass - 基准Class，获得的相对路径相对于此Class所在路径，如果为null则相对ClassPath
    
    Returns:
    
    URL
  - getResourceObj
```
public static Resource getResourceObj(String path)
```
    获取Resource 资源对象
    如果提供路径为绝对路径或路径以file:开头，返回FileResource，否则返回ClassPathResource
    
    Parameters:
    
    path - 路径，可以是绝对路径，也可以是相对路径（相对ClassPath）
    
    Returns:
    
    Resource 资源对象
    
    Since:
    
    3.2.1

Class ResourceUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ResourceUtil

Method Detail

readUtf8Str

readStr

readBytes

getStream

getStreamSafe

getUtf8Reader

getReader

getResource

getResources

getResources

getResourceIter

getResourceIter

getResource

getResourceObj