Spring--工具类

妖狐艹你老母 2023-03-01 12:46 3阅读 0赞

原文网址：[Spring--工具类\_IT利刃出鞘的博客-CSDN博客\_springboot 工具类][Spring--_IT_-CSDN_springboot]

# Assert #

**简介**

> 包位置：org/springframework/util/Assert.java

**示例**

> Assert.notNull(obj, "不能为空")
> 
> 此时，若obj为null，则会抛出异常，异常的message为“不能为空”。

**用法大全**

> ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZlaXlpbmcwY2FuZ2xhbmc_size_16_color_FFFFFF_t_70][]
> 
> ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZlaXlpbmcwY2FuZ2xhbmc_size_16_color_FFFFFF_t_70 1][]

# AnnotationUtils #

**注解类**

>     package com.example.annotation;
>      
>     import org.springframework.core.annotation.AliasFor;
>      
>     import java.lang.annotation.*;
>      
>     @Retention(RetentionPolicy.RUNTIME)
>     @Target({ElementType.METHOD, ElementType.TYPE})
>     @Documented
>     @Inherited
>     public @interface MyAnnotation {
>         @AliasFor(attribute = "location")
>         String value() default "";
>         
>         @AliasFor(attribute = "value")
>         String location() default "";
>     }

**控制器**

>     package com.example.controller;
>     
>     import com.example.annotation.MyAnnotation;
>     import org.springframework.core.annotation.AnnotationUtils;
>     import org.springframework.web.bind.annotation.RequestMapping;
>     import org.springframework.web.bind.annotation.RestController;
>     
>     @RestController
>     @RequestMapping("/hello")
>     public class HelloController {
>         @MyAnnotation(location = "location(my)")
>         @RequestMapping("/test")
>         public String test() {
>             MyAnnotation myAnnotation = null;
>             try {
>                 myAnnotation = AnnotationUtils.getAnnotation(this.getClass().getMethod("test"), MyAnnotation.class);
>             } catch (NoSuchMethodException e) {
>                 e.printStackTrace();
>             }
>     
>             return "loation:" + myAnnotation.location();
>         }
>     }

**测试**

> postman访问：[http://localhost:8080/hello/test][http_localhost_8080_hello_test]
> 
> postman结果
> 
>     loation:location(my)

# AnnotatedElementUtils #

**其他网址**

> [SpringBoot深入理解 -- @AliasFor注解的作用][SpringBoot_ -- _AliasFor]

**说明**

> AnnotatedElementUtils与AnnotationUtils的不同之处在于：AnnotatedElementUtils可以通过父注解获得子注解上的值，而后者不能。

**代码**

> **注解**
> 
>     package com.example.annotation;
>     
>     import org.springframework.core.annotation.AliasFor;
>     
>     import java.lang.annotation.*;
>     
>     @Retention(RetentionPolicy.RUNTIME)
>     @Target({ElementType.METHOD, ElementType.TYPE})
>     @Documented
>     @Inherited
>     public @interface MyAnnotation {
>         @AliasFor(attribute = "location")
>         String value() default "";
>         
>         @AliasFor(attribute = "value")
>         String location() default "";
>     }
> 
>     package com.example.annotation;
>     
>     import org.springframework.core.annotation.AliasFor;
>      
>     import java.lang.annotation.*;
>      
>     @Retention(RetentionPolicy.RUNTIME)
>     @Target({ElementType.METHOD, ElementType.TYPE})
>     @Documented
>     @Inherited
>     @MyAnnotation
>     public @interface SubMyAnnotation {
>         @AliasFor(annotation = MyAnnotation.class)
>         String location() default "";
>     
>     //    这个不能写，只能有一个与父属性名同名的属性，否则报错
>     //    @AliasFor(annotation = MyAnnotation.class)
>     //    String value() default "";
>     }

> **控制器**
> 
>     package com.example.controller;
>     
>     import com.example.annotation.MyAnnotation;
>     import com.example.annotation.SubMyAnnotation;
>     import org.springframework.core.annotation.AnnotatedElementUtils;
>     import org.springframework.core.annotation.AnnotationUtils;
>     import org.springframework.web.bind.annotation.RequestMapping;
>     import org.springframework.web.bind.annotation.RestController;
>     
>     @RestController
>     @RequestMapping("/hello")
>     public class HelloController {
>         @SubMyAnnotation(location = "location(my)")
>         @RequestMapping("/test")
>         public String test() {
>             SubMyAnnotation subMyAnnotation = null;
>             MyAnnotation myAnnotation = null;
>             MyAnnotation myAnnotation1 = null;
>     
>             try {
>                 subMyAnnotation = AnnotationUtils.getAnnotation(this.getClass().getMethod("test"), SubMyAnnotation.class);
>                 myAnnotation = AnnotationUtils.getAnnotation(this.getClass().getMethod("test"), MyAnnotation.class);
>                 myAnnotation1 = AnnotatedElementUtils.getMergedAnnotation(this.getClass().getMethod("test"), MyAnnotation.class);
>             } catch (NoSuchMethodException e) {
>                 e.printStackTrace();
>             }
>     
>             return "loation(sub):" + subMyAnnotation.location() + "\n" +
>                     "location:" + myAnnotation.location() + "\n" +
>                     "location:" + myAnnotation1.location();
>         }
>     }

**测试**

> 前端访问：[http://localhost:8080/hello/test][http_localhost_8080_hello_test]
> 
> 结果
> 
>     loation(sub):location(my)
>     location:
>     location:location(my)

# MultiValueMap #

一个key对应多个value。

package com.example.demo;
    
    import org.junit.jupiter.api.Test;
    import org.junit.runner.RunWith;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    import org.springframework.util.LinkedMultiValueMap;
    import org.springframework.util.MultiValueMap;
    
    import java.util.List;
    import java.util.Set;
    
    @RunWith(SpringRunner.class)
    @SpringBootTest
    class DemoApplicationTests {
    
        @Test
        void test1() {
            MultiValueMap<String, String> multiValueMap = new LinkedMultiValueMap<>();
            multiValueMap.add("key1", "value1");
            multiValueMap.add("key1", "value2");
            multiValueMap.add("key2", "value2");
            Set<String> stringSet = multiValueMap.keySet();
            for (String key : stringSet) {
                List<String> values = multiValueMap.get(key);
                System.out.println(key + ": "+ values);
            }
        }
    }

执行结果

key1: [value1, value2]
    key2: [value2]

# ObjectUtils #

**判断**

<table> 
 <tbody> 
  <tr> 
   <td style="width:364px;"><strong>方法</strong></td> 
   <td style="width:395px;"><strong>作用</strong></td> 
  </tr> 
  <tr> 
   <td>static boolean isEmpty(Object obj)</td> 
   <td style="width:395px;">判断参数对象是否为空，判断标准为：<br> &nbsp;Optional: considered empty if Optional.empty()<br> &nbsp;Array: considered empty if its length is zero<br> &nbsp;CharSequence: considered empty if its length is zero<br> &nbsp;Collection: delegates to Collection.isEmpty()<br> &nbsp;Map: delegates to Map.isEmpty()</td> 
  </tr> 
  <tr> 
   <td>static boolean isEmpty(Object[] array)&nbsp;</td> 
   <td style="width:395px;">判断数组是否为空。</td> 
  </tr> 
  <tr> 
   <td>static boolean isArray(Object obj) &nbsp; &nbsp;</td> 
   <td style="width:395px;">判断参数对象是否是数组</td> 
  </tr> 
  <tr> 
   <td>static boolean containsElement(Object[] array, Object element)&nbsp;</td> 
   <td style="width:395px;">判断数组中是否包含指定元素</td> 
  </tr> 
 </tbody> 
</table>

**获取对象基本信息**

<table> 
 <tbody> 
  <tr> 
   <td style="width:326px;"><strong>方法</strong></td> 
   <td style="width:378px;"><strong>作用</strong></td> 
  </tr> 
  <tr> 
   <td style="width:326px;">static String nullSafeClassName(Object obj) &nbsp; &nbsp;&nbsp;</td> 
   <td style="width:378px;">获取对象的类名。参数为 null 时，返回"null"</td> 
  </tr> 
  <tr> 
   <td style="width:326px;">static String getIdentityHexString(Object obj)</td> 
   <td style="width:378px;">获取对象 HashCode（十六进制字符串）。参数为 null 时，返回 0&nbsp;</td> 
  </tr> 
  <tr> 
   <td style="width:326px;">static String identityToString(Object obj)&nbsp;</td> 
   <td style="width:378px;">获取对象的类名和 HashCode。 参数为 null 时，返回 ""&nbsp;</td> 
  </tr> 
  <tr> 
   <td style="width:326px;">static String getDisplayString(Object obj)&nbsp;</td> 
   <td style="width:378px;">相当于 toString()方法，但参数为 null 时，返回：""</td> 
  </tr> 
 </tbody> 
</table>

# StringUtils #

**其他网址**

> [Spring基础之的StringUtils类\_yinni11的博客-CSDN博客\_stringutils spring][Spring_StringUtils_yinni11_-CSDN_stringutils spring]  
> [Spring中的各种Utils之StringUtils\_Xiuming的博客-CSDN博客\_springboot stringutils][Spring_Utils_StringUtils_Xiuming_-CSDN_springboot stringutils]

所在包：org.springframework.util

**判断**

<table style="width:685px;"> 
 <tbody> 
  <tr> 
   <td style="width:364px;"><strong>方法</strong></td> 
   <td style="width:318px;"><strong>作用</strong></td> 
  </tr> 
  <tr> 
   <td style="width:364px;">boolean isEmpty(Object str)</td> 
   <td style="width:318px;">字符串是否为空或者空字符串：""</td> 
  </tr> 
  <tr> 
   <td style="width:364px;">boolean hasLength(CharSequence str)</td> 
   <td style="width:318px;">字符串是否为空，或者长度为0</td> 
  </tr> 
  <tr> 
   <td style="width:364px;">boolean hasText(String str)</td> 
   <td style="width:318px;">字符串是否有内容（不为空，且不全为空格）</td> 
  </tr> 
  <tr> 
   <td style="width:364px;">boolean containsWhitespace(String str)</td> 
   <td style="width:318px;">字符串是否包含空格</td> 
  </tr> 
 </tbody> 
</table>

**字符串头尾操作**

<table> 
 <tbody> 
  <tr> 
   <td style="width:419px;"><strong>方法</strong></td> 
   <td style="width:330px;"><strong>作用</strong></td> 
  </tr> 
  <tr> 
   <td style="width:419px;">String trimWhitespace(String str)</td> 
   <td style="width:330px;">去掉字符串前后的空格</td> 
  </tr> 
  <tr> 
   <td style="width:419px;">String trimAllWhitespace(String str)</td> 
   <td style="width:330px;">去掉字符串中所有的空格</td> 
  </tr> 
  <tr> 
   <td style="width:419px;">String trimLeadingWhitespace(String str)</td> 
   <td style="width:330px;">去掉字符串开头的空格</td> 
  </tr> 
  <tr> 
   <td style="width:419px;">String trimTrailingWhitespace(String str)</td> 
   <td style="width:330px;">去掉字符串结束的空格</td> 
  </tr> 
  <tr> 
   <td style="width:419px;">String trimLeadingCharacter(String str, char leadingCharacter)</td> 
   <td style="width:330px;">去掉字符串开头的指定字符；</td> 
  </tr> 
  <tr> 
   <td style="width:419px;">String trimTrailingCharacter(String str, char trailingCharacter)</td> 
   <td style="width:330px;">去掉字符串结尾的指定字符；</td> 
  </tr> 
  <tr> 
   <td style="width:419px;">boolean startsWithIgnoreCase(String str, String prefix)</td> 
   <td style="width:330px;">判断字符串是否以指定字符串开头，忽略大小写</td> 
  </tr> 
  <tr> 
   <td style="width:419px;">boolean endsWithIgnoreCase(String str, String suffix)</td> 
   <td style="width:330px;">判断字符串是否以指定字符串结尾，忽略大小写</td> 
  </tr> 
 </tbody> 
</table>

**字符串和子串的操作**

<table> 
 <tbody> 
  <tr> 
   <td style="width:440px;"><strong>方法</strong></td> 
   <td style="width:348px;"><strong>作用</strong></td> 
  </tr> 
  <tr> 
   <td style="width:440px;">boolean substringMatch(CharSequence str, int index, CharSequence substring)</td> 
   <td style="width:348px;">判断从指定索引开始，是否匹配子字符串</td> 
  </tr> 
  <tr> 
   <td style="width:440px;">int countOccurrencesOf(String str, String sub)</td> 
   <td style="width:348px;">判断子字符串在字符串中出现的次数</td> 
  </tr> 
  <tr> 
   <td style="width:440px;">String replace(String inString, String oldPattern, String newPattern)</td> 
   <td style="width:348px;">在字符串中使用子字符串替换</td> 
  </tr> 
  <tr> 
   <td style="width:440px;">String delete(String inString, String pattern)</td> 
   <td style="width:348px;">删除所有匹配的子字符串；</td> 
  </tr> 
  <tr> 
   <td style="width:440px;">String deleteAny(String inString, String charsToDelete)</td> 
   <td style="width:348px;">删除子字符串中任意出现的字符串</td> 
  </tr> 
  <tr> 
   <td style="width:440px;">String quote(String str)&nbsp;</td> 
   <td style="width:348px;">在字符串前后增加单引号,比较适合在日志时候使用；</td> 
  </tr> 
 </tbody> 
</table>

**字符串与数组**

<table> 
 <tbody> 
  <tr> 
   <td style="width:440px;"><strong>方法</strong></td> 
   <td style="width:352px;"><strong>作用</strong></td> 
  </tr> 
  <tr> 
   <td>String[] addStringToArray(String[] array, String str)</td> 
   <td style="width:352px;">把一个字符串添加到一个字符串数组中</td> 
  </tr> 
  <tr> 
   <td>String[] concatenateStringArrays(String[] array1, String[]array2)</td> 
   <td style="width:352px;">连接两个字符串数组</td> 
  </tr> 
  <tr> 
   <td>String[] mergeStringArrays(String[] array1, String[] array2)</td> 
   <td style="width:352px;">连接两个字符串数组，去掉重复元素</td> 
  </tr> 
  <tr> 
   <td>String[] sortStringArray(String[] array)</td> 
   <td style="width:352px;">字符串数组排序</td> 
  </tr> 
  <tr> 
   <td>String[] toStringArray(Collection&lt;String&gt; collection)</td> 
   <td style="width:352px;">把字符串集合变成字符串数组</td> 
  </tr> 
  <tr> 
   <td>String[] toStringArray(Enumeration&lt;String&gt; enumeration)</td> 
   <td style="width:352px;">把字符串枚举类型变成字符串数组</td> 
  </tr> 
  <tr> 
   <td>String[] trimArrayElements(String[] array)</td> 
   <td style="width:352px;">把字符串数组中所有字符串执行trim功能；</td> 
  </tr> 
  <tr> 
   <td>String[] removeDuplicateStrings(String[] array)</td> 
   <td style="width:352px;">去掉给定字符串数组中重复的元素，能保持原顺序；</td> 
  </tr> 
  <tr> 
   <td>String[] split(String toSplit, String delimiter)</td> 
   <td style="width:352px;">按照指定字符串分割字符串；</td> 
  </tr> 
  <tr> 
   <td>String[] tokenizeToStringArray(String str, String delimiters)</td> 
   <td style="width:352px;">对每一个元素执行trim操作，并去掉空字符串</td> 
  </tr> 
  <tr> 
   <td>String[] delimitedListToStringArray(String str, String delimiter)</td> 
   <td style="width:352px;">分割字符串，会把delimiter作为整体分隔符</td> 
  </tr> 
  <tr> 
   <td>Set&lt;String&gt; commaDelimitedListToSet(String str)</td> 
   <td style="width:352px;">使用逗号分割字符串，并放到set中去重</td> 
  </tr> 
  <tr> 
   <td>String arrayToDelimitedString(Object[] arr, String delim)</td> 
   <td style="width:352px;">数组使用指定字符串连接；</td> 
  </tr> 
 </tbody> 
</table>

**文件路径名称相关操作**

<table> 
 <tbody> 
  <tr> 
   <td style="width:389px;"><strong>方法</strong></td> 
   <td style="width:515px;"><strong>作用</strong></td> 
  </tr> 
  <tr> 
   <td style="width:389px;">String unqualify(String qualifiedName):</td> 
   <td style="width:515px;">得到以.分割的最后一个值，可以非常方便的获取类似类名或者文件后缀</td> 
  </tr> 
  <tr> 
   <td style="width:389px;">String unqualify(String qualifiedName, char separator):</td> 
   <td style="width:515px;">得到以给定字符分割的最后一个值，可以非常方便的获取类似文件名</td> 
  </tr> 
  <tr> 
   <td style="width:389px;">String capitalize(String str)</td> 
   <td style="width:515px;">首字母大写</td> 
  </tr> 
  <tr> 
   <td style="width:389px;">String uncapitalize(String str)</td> 
   <td style="width:515px;">取消首字母大写</td> 
  </tr> 
  <tr> 
   <td style="width:389px;">String getFilename(String path)</td> 
   <td style="width:515px;">获取文件名,就不需要再使用FilenameUtils</td> 
  </tr> 
  <tr> 
   <td style="width:389px;">String getFilenameExtension(String path)</td> 
   <td style="width:515px;">获取文件后缀名</td> 
  </tr> 
  <tr> 
   <td style="width:389px;">String stripFilenameExtension(String path)</td> 
   <td style="width:515px;">去掉文件路径后缀</td> 
  </tr> 
  <tr> 
   <td style="width:389px;">String applyRelativePath(String path, String relativePath)</td> 
   <td style="width:515px;">在一个路径（通常是绝对路径，需要以“/”结束）之后，添加相对于它为起点的相对路径文件名。</td> 
  </tr> 
  <tr> 
   <td style="width:389px;">String cleanPath(String path)</td> 
   <td style="width:515px;">清理文件路径,这个方法配合applyRelativePath就可以计算一些简单的相对路径了</td> 
  </tr> 
  <tr> 
   <td style="width:389px;">boolean pathEquals(String path1, String path2)</td> 
   <td style="width:515px;">判断两个文件路径是否相同，会先执行cleanPath之后再比较</td> 
  </tr> 
 </tbody> 
</table>

**本地化操作**

<table style="width:680px;"> 
 <tbody> 
  <tr> 
   <td style="width:440px;"><strong>方法</strong></td> 
   <td style="width:395px;"><strong>作用</strong></td> 
  </tr> 
  <tr> 
   <td>Locale parseLocaleString(String localeString):</td> 
   <td style="width:395px;">从本地化字符串中解析出本地化信息，相当于Locale.toString()的逆向方法</td> 
  </tr> 
  <tr> 
   <td>String toLanguageTag(Locale locale)</td> 
   <td style="width:395px;">把Locale转化成HTTP中Accept-Language能接受的本地化标准；</td> 
  </tr> 
 </tbody> 
</table>

**字符串和Properties**

<table style="width:673px;"> 
 <tbody> 
  <tr> 
   <td style="width:440px;"><strong>方法</strong></td> 
   <td style="width:343px;"><strong>作用</strong></td> 
  </tr> 
  <tr> 
   <td>Properties splitArrayElementsIntoProperties(String[] array, String delimiter):</td> 
   <td style="width:343px;">把字符串数组中的每一个字符串按照给定的分隔符装配到一个Properties中</td> 
  </tr> 
  <tr> 
   <td>Properties splitArrayElementsIntoProperties(String[] array, String delimiter, String charsToDelete)</td> 
   <td style="width:343px;">把字符串数组中的每一个字符串按照给定的分隔符装配到一个Properties中,并删除指定字符串，比如括号之类的；</td> 
  </tr> 
 </tbody> 
</table>

# CollectionUtils #

**判断**

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td style="width:440px;"><strong>方法</strong></td> 
   <td style="width:395px;"><strong>作用</strong></td> 
  </tr> 
  <tr> 
   <td>static boolean &nbsp;isEmpty (Collection&lt;?&gt; collection) &nbsp;</td> 
   <td>判断集合是否为空。</td> 
  </tr> 
  <tr> 
   <td>static boolean &nbsp;isEmpty(Map&lt;?,?&gt; map) &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;</td> 
   <td>判断Map是否为空</td> 
  </tr> 
  <tr> 
   <td>static boolean &nbsp;containsInstance (<br> &nbsp; &nbsp; Collection&lt;?&gt; collection,&nbsp;<br> &nbsp; &nbsp; Object element<br> )</td> 
   <td>判断集合中是否包含某个对象</td> 
  </tr> 
  <tr> 
   <td>static boolean &nbsp;contains (<br> &nbsp; &nbsp; Iterator&lt;?&gt; iterator,&nbsp;<br> &nbsp; &nbsp; Object element<br> )</td> 
   <td>通过迭代器判断某个对象是否在集合中。</td> 
  </tr> 
  <tr> 
   <td>static boolean &nbsp;containsAny (<br> &nbsp; &nbsp; Collection&lt;?&gt; source,&nbsp;<br> &nbsp; &nbsp; Collection&lt;?&gt; candidates<br> )</td> 
   <td>判断集合中是否包含某些对象中的任意一个。</td> 
  </tr> 
  <tr> 
   <td>static boolean &nbsp;hasUniqueObject (Collection&lt;?&gt; collection) &nbsp; &nbsp;</td> 
   <td>判断集合中的每个元素是否唯一。即集合中不存在重复元素。</td> 
  </tr> 
 </tbody> 
</table>

**向集合中添加**

<table style="width:634px;"> 
 <tbody> 
  <tr> 
   <td style="width:309px;"><strong>方法</strong></td> 
   <td style="width:324px;"><strong>作用</strong></td> 
  </tr> 
  <tr> 
   <td style="width:309px;">static &lt;E&gt; void mergeArrayIntoCollection (<br> &nbsp; &nbsp; Object array,&nbsp;<br> &nbsp; &nbsp; Collection&lt;E&gt; collection<br> )</td> 
   <td style="width:324px;">将数组中的元素都添加到集合中。</td> 
  </tr> 
  <tr> 
   <td style="width:309px;">static &lt;K,V&gt; void mergePropertiesIntoMap (<br> &nbsp; &nbsp; Properties props,&nbsp;<br> &nbsp; &nbsp; Map&lt;K,V&gt; map<br> )</td> 
   <td style="width:324px;">将 Properties 中的键值对都添加到 Map 中</td> 
  </tr> 
 </tbody> 
</table>

**在集合中查找**

<table style="width:556px;"> 
 <tbody> 
  <tr> 
   <td style="width:309px;"><strong>方法</strong></td> 
   <td style="width:324px;"><strong>作用</strong></td> 
  </tr> 
  <tr> 
   <td>static &lt;T&gt; T lastElement (List&lt;T&gt; list) &nbsp;</td> 
   <td style="width:328px;">返回 List 中最后一个元素。</td> 
  </tr> 
  <tr> 
   <td>static &lt;T&gt; T lastElement (Set&lt;T&gt; set) &nbsp; &nbsp;</td> 
   <td style="width:328px;">返回 Set 中最后一个元素。</td> 
  </tr> 
  <tr> 
   <td>static &lt;E&gt; E findFirstMatch (<br> &nbsp; &nbsp; Collection&lt;?&gt; source,&nbsp;<br> &nbsp; &nbsp; Collection&lt;E&gt; candidates<br> )</td> 
   <td style="width:328px;">返回 candidates 中第一个存在于 source 中的元素。</td> 
  </tr> 
  <tr> 
   <td>static &lt;T&gt; T findValueOfType (<br> &nbsp; &nbsp; Collection&lt;?&gt; collection,&nbsp;<br> &nbsp; &nbsp; Class&lt;T&gt; type<br> )</td> 
   <td style="width:328px;">返回集合中指定类型的元素。</td> 
  </tr> 
  <tr> 
   <td>static Object findValueOfType (<br> &nbsp; &nbsp; Collection&lt;?&gt; collection,&nbsp;<br> &nbsp; &nbsp; Class&lt;?&gt;[] types<br> )</td> 
   <td style="width:328px;">返回集合中指定类型的元素。如果第一种类型未找到，则查找第二种类型，以此类推。</td> 
  </tr> 
  <tr> 
   <td>static Class&lt;?&gt; findCommonElementType (Collection&lt;?&gt; collection) &nbsp;&nbsp;</td> 
   <td style="width:328px;">返回集合中元素的类型</td> 
  </tr> 
 </tbody> 
</table>

# BeanUtils #

## **简介** ##

**说明**

> 我们经常需要将不同的两个对象实例进行属性复制，比如将DO对象进行属性复制到DTO，这种转换最原始的方式就是手动编写大量的 get/set代码，很繁琐。为了解决这一痛点，就诞生了一些方便的类库，常用的有 Apache的 BeanUtils,Spring的 BeanUtils, Dozer,Orika等拷贝工具。
> 
> 由于Apache的BeanUtils的性能很差，强烈不建议使用。阿里巴巴Java开发规约插件上也明确指出：  
> “Ali-Check | 避免用Apache Beanutils进行属性的copy。”

**Spring的BeanUtils方法**

> <table> 
>  <tbody> 
>   <tr> 
>    <td style="width:347px;"><strong>方法</strong></td> 
>    <td style="width:414px;"><strong>说明</strong></td> 
>   </tr> 
>   <tr> 
>    <td style="width:347px;">BeanUtils.copyProperties(source, target);</td> 
>    <td style="width:414px;">source对应的对象成员赋值给target对应的对象成员</td> 
>   </tr> 
>   <tr> 
>    <td style="width:347px;">BeanUtils.copyProperties(source, target, "id", "time");</td> 
>    <td style="width:414px;">忽略拷贝某些字段。本处是忽略：id与time</td> 
>   </tr> 
>  </tbody> 
> </table>

**Spring的BeanUtils方法注意事项**

> 泛型只在编译期起作用，不能依靠泛型来做运行期的限制；

**浅拷贝和深拷贝**

> **浅拷贝**：对基本数据类型进行值传递，对引用数据类型进行引用传递般的拷贝，此为浅拷贝  
> **深拷贝**：对基本数据类型进行值传递，对引用数据类型，创建一个新的对象，并复制其内容，此为深拷贝。

**Spring的BeanUtils与Apache的BeanUtils区别**

> <table> 
>  <tbody> 
>   <tr> 
>    <td style="width:80px;"><strong>项</strong></td> 
>    <td style="width:301px;"><strong>Spring的BeanUtils</strong></td> 
>    <td style="width:466px;"><strong>Apache的BeanUtils</strong></td> 
>   </tr> 
>   <tr> 
>    <td style="width:80px;">性能</td> 
>    <td style="width:301px;"> <p>好。</p> <p>原因：对两个对象中相同名字的属性进行简单的get/set，仅检查属性的可访问性</p> </td> 
>    <td style="width:466px;"> <p>差。</p> <p>原因：有很多检验：类型的转换、对象所属类的可访问性等</p> <p>注意：本处类型转换是类似的类，多个String转为List&lt;String&gt;是不行的。</p> </td> 
>   </tr> 
>   <tr> 
>    <td style="width:80px;">使用方面</td> 
>    <td style="width:301px;"> <p>第一个参数是源，第二个参数是目标。</p> <p>无需捕获异常</p> </td> 
>    <td style="width:466px;"> <p>第一个参数是目标，第二个参数是源。</p> <p>必须捕获异常</p> </td> 
>   </tr> 
>   <tr> 
>    <td style="width:80px;">深/浅拷贝</td> 
>    <td style="width:301px;">浅拷贝</td> 
>    <td style="width:466px;">浅拷贝</td> 
>   </tr> 
>  </tbody> 
> </table>

> Apache的BeanUtils方法。（依赖：maven里直接搜“commons-beanutils”）
> 
> <table> 
>  <tbody> 
>   <tr> 
>    <td style="width:470px;"><strong>方法</strong></td> 
>    <td style="width:345px;"><strong>说明</strong></td> 
>   </tr> 
>   <tr> 
>    <td style="width:470px;">BeanUtils.copyProperties(Object target, Object source);</td> 
>    <td style="width:345px;">source对应的对象成员赋值给target对应的对象成员</td> 
>   </tr> 
>   <tr> 
>    <td style="width:470px;">BeanUtils.copyProperties(Object target, String name, Object source);</td> 
>    <td style="width:345px;">只拷贝某些字段。</td> 
>   </tr> 
>  </tbody> 
> </table>
> 
> Apache的BeanUtils支持的类型转换
> 
> java.lang.BigDecimal  
> java.lang.BigInteger  
> boolean and java.lang.Boolean  
> byte and java.lang.Byte  
> char and java.lang.Character  
> java.lang.Class  
> double and java.lang.Double  
> float and java.lang.Float  
> int and java.lang.Integer  
> long and java.lang.Long  
> short and java.lang.Short  
> java.lang.String  
> java.sql.Date  
> java.sql.Time  
> java.sql.Timestamp
> 
> java.util.Date是不被支持的，而它的子类java.sql.Date是被支持的。因此如果对象包含时间类型的属性，且希望被转换的时候，一定要使用java.sql.Date类型。否则在转换时会提示argument mistype异常。

## 实例 ##

entity

package com.example.entity;
    
    import lombok.Data;
    
    @Data
    public class Question {
        private Integer id;
        private Integer studentId;
        private String content;
        private Integer value;
    }

package com.example.entity;
    
    import lombok.Data;
    
    @Data
    public class Student {
        private Integer id;
        private String name;
        private Integer points;
    }

package com.example.vo;
    
    import lombok.Data;
    
    import java.io.Serializable;
    import java.util.List;
    
    @Data
    public class QuestionStudentVO implements Serializable {
        private Integer id;
        private String content;
        private Integer value;
        private Integer studentId;
    
        private List<String> name;
        private Integer points;
    }

测试类

package com.example;
    
    import com.example.entity.Question;
    import com.example.entity.Student;
    import com.example.vo.QuestionStudentVO;
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.BeanUtils;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    
    @RunWith(SpringRunner.class)
    @SpringBootTest
    public class DemoApplicationTests {
        @Test
        public void beanUtilTest(){
            Question question = new Question();
            question.setId(2);
    //        question.setStudentId(3);
            question.setContent("This is content");
            question.setValue(100);
    
            Student student = new Student();
            student.setId(3);
            student.setName("Tony Stark");
            student.setPoints(201);
    
            QuestionStudentVO questionStudentVO = new QuestionStudentVO();
    
            BeanUtils.copyProperties(question, questionStudentVO);
            BeanUtils.copyProperties(student, questionStudentVO);
            System.out.println(questionStudentVO);
        }
    }

执行结果

QuestionStudentVO(id=3, content=This is content, value=100, studentId=null, name=null, points=201)

# ClassPathResource #

**其他网址**

> [使用Spring的ClassPathResource加载资源文件\_太阳虽好，总要诸君亲自去晒，旁人却替你晒不来-CSDN博客][Spring_ClassPathResource_-CSDN]

**简介**

> ClassPathResource用于加载资源文件。

**用法**

> Resource res = new ClassPathResource("xxx");
> 
> 构造函数参数：路径名。可以是相对路径、绝对路径。比如："../../file1"。
> 
> 示例：
> 
> Resource res = new ClassPathResource("xxx"); //在当前目录和classpath中寻找"xxx"文件。classpath包含/src/main/resources目录

**Resource常用方法**

> <table style="width:500px;"> 
>  <tbody> 
>   <tr> 
>    <td style="width:181px;"><strong>方法</strong></td> 
>    <td style="width:318px;"><strong>作用</strong></td> 
>   </tr> 
>   <tr> 
>    <td style="width:181px;">public File getFile()</td> 
>    <td style="width:318px;">返回路径名对应的文件</td> 
>   </tr> 
>  </tbody> 
> </table>

**注意事项**

> 其他网址：[SpringBoot打包为JAR包后访问不到Resources下的文件问题 | Homxu][SpringBoot_JAR_Resources_ _ Homxu]
> 
> 在打包为JAR后，JAR是一个压缩包，不能直接获取文件对象，要改为用流进行读取和创建：
> 
>     classPathResource = new ClassPathResource("static/satellite.txt");
>     //打包成jar无法读取文件,要用流读取
>     //File file = classPathResource.getFile();
>     InputStream inputStream = classPathResource.getInputStream();

**辅助方法**

> ClassLoader loader = Thread.currentThread().getContextClassLoader();  
> System.out.println(loader.getResource("").getPath()); //获取的是classpath的根路径
> 
> System.out.println(this.getClass().getResource("").getPath()); //获取的是相对于当前类的相对路径  
> System.out.println(this.getClass().getResource("/").getPath()); //获取的是classpath的根路径

[Spring--_IT_-CSDN_springboot]: https://knife.blog.csdn.net/article/details/107587963
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZlaXlpbmcwY2FuZ2xhbmc_size_16_color_FFFFFF_t_70]: /images/20230208/5b4ea89255a644feb1a851913cb6d92a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZlaXlpbmcwY2FuZ2xhbmc_size_16_color_FFFFFF_t_70 1]: /images/20230208/46c6219a371144718492599e0071f713.png
[http_localhost_8080_hello_test]: http://localhost:8080/hello/test
[SpringBoot_ -- _AliasFor]: https://juejin.cn/post/6844904153966182407
[Spring_StringUtils_yinni11_-CSDN_stringutils spring]: https://blog.csdn.net/yinni11/article/details/79795483
[Spring_Utils_StringUtils_Xiuming_-CSDN_springboot stringutils]: https://blog.csdn.net/mrain2/article/details/81777821
[Spring_ClassPathResource_-CSDN]: https://blog.csdn.net/qq_37767455/article/details/100181904
[SpringBoot_JAR_Resources_ _ Homxu]: https://homxuwang.github.io/2019/12/26/SpringBoot%E6%89%93%E5%8C%85%E4%B8%BAJAR%E5%8C%85%E5%90%8E%E8%AE%BF%E9%97%AE%E4%B8%8D%E5%88%B0Resources%E4%B8%8B%E7%9A%84%E6%96%87%E4%BB%B6%E9%97%AE%E9%A2%98/