spirng中的常用工具类

谁践踏了优雅 2023-06-17 03:57 6阅读 0赞

转载自：[https://www.cnblogs.com/jiangbei/p/8476088.html][https_www.cnblogs.com_jiangbei_p_8476088.html]

## 叙述 ##

很多时候，很多工具类其实spring中就已经提供，常用的工具类有：

## 列表 ##

**文件资源操作**  
     Spring 定义了一个 org.springframework.core.io.Resource 接口，Resource 接口是为了统一各种类型不同的资源而定义的，Spring 提供了若干 Resource 接口的实现类，这些实现类可以轻松地加载不同类型的底层资源，并提供了获取文件名、URL 地址以及资源内容的操作方法  
  
**访问文件资源**  
\* 通过 FileSystemResource 以文件系统绝对路径的方式进行访问；  
\* 通过 ClassPathResource 以类路径的方式进行访问；  
\* 通过 ServletContextResource 以相对于 Web 应用根目录的方式进行访问。

package com.baobaotao.io; 
    import java.io.IOException; 
    import java.io.InputStream; 
    import org.springframework.core.io.ClassPathResource; 
    import org.springframework.core.io.FileSystemResource; 
    import org.springframework.core.io.Resource; 
    public class FileSourceExample { 
    
    public static void main(String[] args) { 
    
    try { 
          String filePath = "D:/masterSpring/chapter23/webapp/WEB-INF/classes/conf/file1.txt"; 
          // ① 使用系统文件路径方式加载文件
          Resource res1 = new FileSystemResource(filePath); 
          // ② 使用类路径方式加载文件
          Resource res2 = new ClassPathResource("conf/file1.txt"); 
          InputStream ins1 = res1.getInputStream(); 
          InputStream ins2 = res2.getInputStream(); 
          System.out.println("res1:"+res1.getFilename()); 
          System.out.println("res2:"+res2.getFilename()); 
    } catch (IOException e) { 
            e.printStackTrace(); 
      } 
    
      } 
    }

在获取资源后，您就可以通过 Resource 接口定义的多个方法访问文件的数据和其它的信息

getFileName() 获取文件名，
    getFile() 获取资源对应的 File 对象，
    getInputStream() 直接获取文件的输入流。
    createRelative(String relativePath) 在资源相对地址上创建新的资源。

在 Web 应用中，您还可以通过 ServletContextResource 以相对于 Web 应用根目录的方式访问文件资源  
Spring 提供了一个 ResourceUtils 工具类，它支持“classpath:”和“file:”的地址前缀 ，它能够从指定的地址加载文件资源。

File clsFile = ResourceUtils.getFile("classpath:conf/file1.txt"); 
    System.out.println(clsFile.isFile()); 
    String httpFilePath = "file:D:/masterSpring/chapter23/src/conf/file1.txt"; 
    File httpFile = ResourceUtils.getFile(httpFilePath);

**文件操作**  
在使用各种 Resource 接口的实现类加载文件资源后，经常需要对文件资源进行读取、拷贝、转存等不同类型的操作。  
**FileCopyUtils**  
它提供了许多一步式的静态操作方法，能够将文件内容拷贝到一个目标 byte\[\]、String 甚至一个输出流或输出文件中。

package com.baobaotao.io; 
    import java.io.ByteArrayOutputStream; 
    import java.io.File; 
    import java.io.FileReader; 
    import java.io.OutputStream; 
    import org.springframework.core.io.ClassPathResource; 
    import org.springframework.core.io.Resource; 
    import org.springframework.util.FileCopyUtils; 
    public class FileCopyUtilsExample { 
    
    public static void main(String[] args) throws Throwable { 
    
        Resource res = new ClassPathResource("conf/file1.txt"); 
        // ① 将文件内容拷贝到一个 byte[] 中
        byte[] fileData = FileCopyUtils.copyToByteArray(res.getFile()); 
        // ② 将文件内容拷贝到一个 String 中
        String fileStr = FileCopyUtils.copyToString(new FileReader(res.getFile())); 
        // ③ 将文件内容拷贝到另一个目标文件
        FileCopyUtils.copy(res.getFile(), 
        new File(res.getFile().getParent()+ "/file2.txt")); 
        // ④ 将文件内容拷贝到一个输出流中
        OutputStream os = new ByteArrayOutputStream(); 
        FileCopyUtils.copy(res.getInputStream(), os); 
        } 
    
    } 
    
    static void copy(byte[] in, File out) 将 byte[] 拷贝到一个文件中
    static void copy(byte[] in, OutputStream out) 将 byte[] 拷贝到一个输出流中
    static int copy(File in, File out) 将文件拷贝到另一个文件中
    static int copy(InputStream in, OutputStream out) 将输入流拷贝到输出流中
    static int copy(Reader in, Writer out) 将 Reader 读取的内容拷贝到 Writer 指向目标输出中
    static void copy(String in, Writer out) 将字符串拷贝到一个 Writer 指向的目标中

**属性文件操作**  
Spring 提供的 PropertiesLoaderUtils 允许您直接通过基于类路径的文件 地址加载属性资源

package com.baobaotao.io; 
    import java.util.Properties; 
    import org.springframework.core.io.support.PropertiesLoaderUtils; 
    public class PropertiesLoaderUtilsExample { 
    
    public static void main(String[] args) throws Throwable { 
    
           // ① jdbc.properties 是位于类路径下的文件 
           Properties props = PropertiesLoaderUtils.loadAllProperties("jdbc.properties"); 
           System.out.println(props.getProperty("jdbc.driverClassName")); 
    
           } 
    }

**特殊编码的资源**  
当您使用 Resource 实现类加载文件资源时，它默认采用操作系统的编码格式。如果文件资源采用了特殊的编码格式（如 UTF-8），则在读取资源内容时必须事先通过 EncodedResource 指定编码格式，否则将会产生中文乱码的问题。

package com.baobaotao.io; 
    import org.springframework.core.io.ClassPathResource; 
    import org.springframework.core.io.Resource; 
    import org.springframework.core.io.support.EncodedResource; 
    import org.springframework.util.FileCopyUtils; 
    public class EncodedResourceExample { 
    
    public static void main(String[] args) throws Throwable { 
    
           Resource res = new ClassPathResource("conf/file1.txt"); 
           // ① 指定文件资源对应的编码格式（UTF-8）
           EncodedResource encRes = new EncodedResource(res,"UTF-8"); 
           // ② 这样才能正确读取文件的内容，而不会出现乱码
           String content = FileCopyUtils.copyToString(encRes.getReader()); 
           System.out.println(content); 
    
           } 
    
    }

访问 Spring 容器，获取容器中的 Bean，使用 WebApplicationContextUtils 工具类

ServletContext servletContext = request.getSession().getServletContext();
    WebApplicationContext wac = WebApplicationContextUtils. getWebApplicationContext(servletContext);

**工具类**

**内置的resouce类型**

1.  UrlResource
2.  ClassPathResource
3.  FileSystemResource
4.  ServletContextResource
5.  InputStreamResource
6.  ByteArrayResource
7.  EncodedResource 也就是Resource加上encoding, 可以认为是有编码的资源
8.  VfsResource(在jboss里经常用到, 相应还有 工具类 VfsUtils)
9.  org.springframework.util.xml.ResourceUtils 用于处理表达资源字符串前缀描述资源的工具. 如: "classpath:".   
    有 getURL, getFile, isFileURL, isJarURL, extractJarFileURL

**xml工具 **

1.  org.springframework.util.xml.AbstractStaxContentHandler
2.  org.springframework.util.xml.AbstractStaxXMLReader
3.  org.springframework.util.xml.AbstractXMLReader
4.  org.springframework.util.xml.AbstractXMLStreamReader
5.  org.springframework.util.xml.DomUtils
6.  org.springframework.util.xml.SimpleNamespaceContext
7.  org.springframework.util.xml.SimpleSaxErrorHandler
8.  org.springframework.util.xml.SimpleTransformErrorListener
9.  org.springframework.util.xml.StaxUtils
10. org.springframework.util.xml.TransformerUtils

**其它工具集**

1.  org.springframework.util.xml.AntPathMatcherant风格的处理
2.  org.springframework.util.xml.AntPathStringMatcher
3.  org.springframework.util.xml.Assert断言,在我们的参数判断时应该经常用
4.  org.springframework.util.xml.CachingMapDecorator
5.  org.springframework.util.xml.ClassUtils用于Class的处理
6.  org.springframework.util.xml.CollectionUtils用于处理集合的工具
7.  org.springframework.util.xml.CommonsLogWriter
8.  org.springframework.util.xml.CompositeIterator
9.  org.springframework.util.xml.ConcurrencyThrottleSupport
10. org.springframework.util.xml.CustomizableThreadCreator
11. org.springframework.util.xml.DefaultPropertiesPersister
12. org.springframework.util.xml.DigestUtils摘要处理, 这里有用于md5处理信息的
13. org.springframework.util.xml.FileCopyUtils文件的拷贝处理, 结合Resource的概念一起来处理, 真的是很方便
14. org.springframework.util.xml.FileSystemUtils
15. org.springframework.util.xml.LinkedCaseInsensitiveMap  
    key值不区分大小写的LinkedMap
16. org.springframework.util.xml.LinkedMultiValueMap一个key可以存放多个值的LinkedMap
17. org.springframework.util.xml.Log4jConfigurer一个log4j的启动加载指定配制文件的工具类
18. org.springframework.util.xml.NumberUtils处理数字的工具类, 有parseNumber 可以把字符串处理成我们指定的数字格式, 还支持format格式, convertNumberToTargetClass 可以实现Number类型的转化. 
19. org.springframework.util.xml.ObjectUtils有很多处理null object的方法. 如nullSafeHashCode, nullSafeEquals, isArray, containsElement, addObjectToArray, 等有用的方法
20. org.springframework.util.xml.PatternMatchUtilsspring里用于处理简单的匹配. 如 Spring's typical "xxx\*", "\*xxx" and "\*xxx\*" pattern styles
21. org.springframework.util.xml.PropertyPlaceholderHelper用于处理占位符的替换
22. org.springframework.util.xml.ReflectionUtils反映常用工具方法. 有 findField, setField, getField, findMethod, invokeMethod等有用的方法
23. org.springframework.util.xml.SerializationUtils用于java的序列化与反序列化. serialize与deserialize方法
24. org.springframework.util.xml.StopWatch一个很好的用于记录执行时间的工具类, 且可以用于任务分阶段的测试时间. 最后支持一个很好看的打印格式. 这个类应该经常用
25. org.springframework.util.xml.StringUtils
26. org.springframework.util.xml.SystemPropertyUtils
27. org.springframework.util.xml.TypeUtils用于类型相容的判断. isAssignable
28. org.springframework.util.xml.WeakReferenceMonitor弱引用的监控

**web相关的工具**

1.  1.  org.springframework.web.util.CookieGenerator
    2.  org.springframework.web.util.HtmlCharacterEntityDecoder
    3.  org.springframework.web.util.HtmlCharacterEntityReferences
    4.  org.springframework.web.util.HtmlUtils
    5.  org.springframework.web.util.HttpUrlTemplate  
        这个类用于用字符串模板构建url, 它会自动处理url里的汉字及其它相关的编码. 在读取别人提供的url资源时, 应该经常用   
        String url = "http://localhost/myapp/\{name\}/\{id\}"
    6.  org.springframework.web.util.JavaScriptUtils
    7.  org.springframework.web.util.Log4jConfigListener  
        用listener的方式来配制log4j在web环境下的初始化
    8.  org.springframework.web.util.UriTemplate
    9.  org.springframework.web.util.UriUtils处理uri里特殊字符的编码
    10. org.springframework.web.util.WebUtils
    11. org.springframework.web.util.

4.EncodedResource(Resource对象,"UTF-8") 编码资源(特殊的);  
5.WebApplicationContextUtils  
6.StringEscapeutils 编码解码

其他

1.  org.springframework.core.annotation.AnnotationUtils   处理注解
2.  org.springframework.core.io.support.PathMatchingResourcePatternResolver  用 于处理 ant 匹配风格(com/\*.jsp, com/\*\*/\*.jsp),找出所有的资源, 结合上面的resource的概念一起使用,对于遍历文件很有用. 具体请详细查看javadoc
3.  org.springframework.core.io.support.PropertiesLoaderUtils 加载Properties资源工具类,和Resource结合
4.  org.springframework.core.BridgeMethodResolver  桥接方法分析器.  关于桥接方法请参考: http://java.sun.com/docs/books/jls/third\_edition/html/expressions.html\#15.12.4.5
5.  org.springframework.core.GenericTypeResolver  范型分析器, 在用于对范型方法, 参数分析.
6.  org.springframework.core.NestedExceptionUtil

[https_www.cnblogs.com_jiangbei_p_8476088.html]: https://www.cnblogs.com/jiangbei/p/8476088.html