Статьи

Класс струн гуавы

Январь 8, 2019

В посте Проверка наличия строки с пустым или пустым или пустым пространством в Java я продемонстрировал общие подходы в экосистеме Java (стандарт Java, Guava , Apache Commons Lang и Groovy ) для проверки того, является ли строка пустым или пустым пространством. только аналогично тому, что C # поддерживает с методом String.IsNullOrWhiteSpace . Одним из подходов, которые я продемонстрировал, был подход, основанный на Guava, который использовал класс Strings и его статический метод isNullOrEmpty (String) . В этой статье я расскажу о других полезных функциях для работы со строками, которые предоставляются шестью «статическими служебными методами Guava, относящимися к String», которые связаны в класс Strings .

Использовать класс Strings в Guava просто благодаря его хорошо названным методам. В следующем списке перечислены методы (все статические) класса Strings с кратким описанием того, что каждый из них делает рядом с именем метода (эти описания заимствованы или адаптированы из документации Javadoc ).

  • Strings.isNullOrEmpty (String)
    • ‘Возвращает true, если заданная строка пуста или пуста.’
  • emptyToNull (String)
    • ‘Возвращает данную строку, если она не пуста; иначе ноль.
  • nullToEmpty (String)
    • ‘Возвращает данную строку, если она не равна нулю; в противном случае пустая строка.
  • padStart (String, Int, символ)
    • При необходимости добавьте к предоставленной строке достаточное количество символов, чтобы сделать строку указанной длины.
  • padEnd (String, Int, символ)
    • При необходимости добавьте к предоставленной строке достаточное количество символов, чтобы сделать строку указанной длины.
  • повтора (String, Int)
    • ‘Возвращает строку, состоящую из определенного числа объединенных копий входной строки.’

isNullOrEmpty

Метод Strings.isEmptyOrNull (String) в Guava позволяет легко создавать простые и легко читаемые условные операторы, которые проверяют String на ноль или пустоту перед тем, как воздействовать на указанную String . Как упоминалось ранее, я кратко рассмотрел этот метод ранее . Другая демонстрация кода этого метода показана далее.

Пример кода с использованием Strings.isNullOrEmpty (String)

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
/**
 * Print to standard output a string message indicating whether the provided
 * String is null or empty or not null or empty. This method uses Guava's
 * Strings.isNullOrEmpty(String) method.
 *
 * @param string String to be tested for null or empty.
 */
private static void printStringStatusNullOrEmpty(final String string)
{
   out.println(  'String '' + string + '' '
               + (Strings.isNullOrEmpty(string) ? 'IS' : 'is NOT')
               + ' null or empty.');
}
 
/**
 * Demonstrate Guava Strings.isNullOrEmpty(String) method on some example
 * Strings.
 */
public static void demoIsNullOrEmpty()
{
   printHeader('Strings.isNullOrEmpty(String)');
   printStringStatusNullOrEmpty('Dustin');
   printStringStatusNullOrEmpty(null);
   printStringStatusNullOrEmpty('');
}

Результат выполнения вышеуказанного кода содержится в следующем снимке экрана. Это показывает, что true возвращается, когда пустой или пустой String (”) передается Strings.isNullOrEmpty(String) .

nullToEmpty и emptyToNull

Есть много раз, когда кто-то может захотеть рассматривать пустую строку как пустую строку или хочет представить пустое значение, когда существует пустая строка. В таких случаях, когда требуется преобразование между нулевой и пустой строкой, следующие фрагменты кода демонстрируют использование Strings.nullToEmpty (String) и Strings.emptyToNull (String) .

nullToEmpty и emptyToNull

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
/**
 * Print to standard output a simple message indicating the provided original
 * String and the provided result/output String.
 *
 * @param originalString Original String.
 * @param resultString Output or result String created by operation.
 * @param operation The operation that acted upon the originalString to create
 *    the resultString.
 */
private static void printOriginalAndResultStrings(
   final String originalString, final String resultString, final String operation)
{
   out.println('Passing '' + originalString + '' to ' + operation + ' produces '' + resultString + ''');
}
 
/** Demonstrate Guava Strings.emptyToNull() method on example Strings. */
public static void demoEmptyToNull()
{
   final String operation = 'Strings.emptyToNull(String)';
   printHeader(operation);
   printOriginalAndResultStrings('Dustin', Strings.emptyToNull('Dustin'), operation);
   printOriginalAndResultStrings(null, Strings.emptyToNull(null), operation);
   printOriginalAndResultStrings('', Strings.emptyToNull(''), operation);
}
 
/** Demonstrate Guava Strings.nullToEmpty() method on example Strings. */
public static void demoNullToEmpty()
{
   final String operation = 'Strings.nullToEmpty(String)';
   printHeader(operation);
   printOriginalAndResultStrings('Dustin', Strings.nullToEmpty('Dustin'), operation);
   printOriginalAndResultStrings(null, Strings.nullToEmpty(null), operation);
   printOriginalAndResultStrings('', Strings.nullToEmpty(''), operation);
}

Результат выполнения приведенного выше кода (показанный на следующем снимке экрана) доказывает, что эти методы работают так, как мы ожидали: преобразование пустой строки в пустую или преобразование пустой строки в нулевую.

padStart и padEnd

Другой распространенной практикой при работе со строками в Java (или любом другом языке) является заполнение строки определенной длины указанным символом. Guava легко поддерживает это с помощью методов Strings.padStart (String, int, char) и Strings.padEnd (String, int, char) , которые продемонстрированы в следующем листинге кода.

padStart и padEnd

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
/**
 * Demonstrate Guava Strings.padStart(String,int,char) method on example
 * Strings.
 */
public static void demoPadStart()
{
   final String operation = 'Strings.padStart(String,int,char)';
   printHeader(operation);
   printOriginalAndResultStrings('Dustin', Strings.padStart('Dustin', 10, '_'), operation);
   /**
    *  Do NOT call Strings.padStart(String,int,char) on a null String:
    *  Exception in thread 'main' java.lang.NullPointerException
    *         at com.google.common.base.Preconditions.checkNotNull(Preconditions.java:187)
    *         at com.google.common.base.Strings.padStart(Strings.java:97)
    */
   //printOriginalAndResultStrings(null, Strings.padStart(null, 10, '_'), operation);
 
   printOriginalAndResultStrings('', Strings.padStart('', 10, '_'), operation);     
}
 
/**
 * Demonstrate Guava Strings.padEnd(String,int,char) method on example
 * Strings.
 */
public static void demoPadEnd()
{
   final String operation = 'Strings.padEnd(String,int,char)';
   printHeader(operation);
   printOriginalAndResultStrings('Dustin', Strings.padEnd('Dustin', 10, '_'), operation);
   /**
    * Do NOT call Strings.padEnd(String,int,char) on a null String:
    *    Exception in thread 'main' java.lang.NullPointerException
    *         at com.google.common.base.Preconditions.checkNotNull(Preconditions.java:187)
    *         at com.google.common.base.Strings.padEnd(Strings.java:129)
    */
   //printOriginalAndResultStrings(null, Strings.padEnd(null, 10, '_'), operation);
   printOriginalAndResultStrings('', Strings.padEnd('', 10, '_'), operation);      
}

При выполнении вышеуказанный код дополняет предоставленные строки символами подчеркивания либо до, либо после предоставленной строки в зависимости от того, какой метод был вызван. В обоих случаях длина строки была указана как десять. Этот вывод показан на следующем снимке экрана.

повторение

Последний метод манипуляции, поддерживаемый классом Guava Strings — это возможность легко повторять данную строку указанное количество раз. Это продемонстрировано в следующем листинге кода и соответствующем снимке экрана с выводом этого кода. В этом примере предоставленная строка повторяется три раза.

повторение

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
/** Demonstrate Guava Strings.repeat(String,int) method on example Strings. */
public static void demoRepeat()
{
   final String operation = 'Strings.repeat(String,int)';
   printHeader(operation);
   printOriginalAndResultStrings('Dustin', Strings.repeat('Dustin', 3), operation);
   /**
    * Do NOT call Strings.repeat(String,int) on a null String:
    *    Exception in thread 'main' java.lang.NullPointerException
    *         at com.google.common.base.Preconditions.checkNotNull(Preconditions.java:187)
    *         at com.google.common.base.Strings.repeat(Strings.java:153)
    */
   //printOriginalAndResultStrings(null, Strings.repeat(null, 3), operation);
   printOriginalAndResultStrings('', Strings.repeat('', 3), operation);
}

Завершение

Приведенные выше примеры просты, потому что класс Strings Guava прост в использовании. Полный класс, содержащий демонстрационный код, показанный ранее, теперь включен в список.

GuavaStrings.java

001
002
003
004
005
006
007
008
009
010
011
012
013
014
015
016
017
018
019
020
021
022
023
024
025
026
027
028
029
030
031
032
033
034
035
036
037
038
039
040
041
042
043
044
045
046
047
048
049
050
051
052
053
054
055
056
057
058
059
060
061
062
063
064
065
066
067
068
069
070
071
072
073
074
075
076
077
078
079
080
081
082
083
084
085
086
087
088
089
090
091
092
093
094
095
096
097
098
099
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
package dustin.examples;
 
import com.google.common.base.Strings;
import static java.lang.System.out;
 
/**
 * Simple demonstration of Guava's Strings class.
 *
 * @author Dustin
 */
public class GuavaStrings
{
   /**
    * Print to standard output a string message indicating whether the provided
    * String is null or empty or not null or empty. This method uses Guava's
    * Strings.isNullOrEmpty(String) method.
    *
    * @param string String to be tested for null or empty.
    */
   private static void printStringStatusNullOrEmpty(final String string)
   {
      out.println(  'String '' + string + '' '
                  + (Strings.isNullOrEmpty(string) ? 'IS' : 'is NOT')
                  + ' null or empty.');
   }
 
   /**
    * Demonstrate Guava Strings.isNullOrEmpty(String) method on some example
    * Strings.
    */
   public static void demoIsNullOrEmpty()
   {
      printHeader('Strings.isNullOrEmpty(String)');
      printStringStatusNullOrEmpty('Dustin');
      printStringStatusNullOrEmpty(null);
      printStringStatusNullOrEmpty('');
   }
 
   /**
    * Print to standard output a simple message indicating the provided original
    * String and the provided result/output String.
    *
    * @param originalString Original String.
    * @param resultString Output or result String created by operation.
    * @param operation The operation that acted upon the originalString to create
    *    the resultString.
    */
   private static void printOriginalAndResultStrings(
      final String originalString, final String resultString, final String operation)
   {
      out.println('Passing '' + originalString + '' to ' + operation + ' produces '' + resultString + ''');
   }
 
   /** Demonstrate Guava Strings.emptyToNull() method on example Strings. */
   public static void demoEmptyToNull()
   {
      final String operation = 'Strings.emptyToNull(String)';
      printHeader(operation);
      printOriginalAndResultStrings('Dustin', Strings.emptyToNull('Dustin'), operation);
      printOriginalAndResultStrings(null, Strings.emptyToNull(null), operation);
      printOriginalAndResultStrings('', Strings.emptyToNull(''), operation);
   }
 
   /** Demonstrate Guava Strings.nullToEmpty() method on example Strings. */
   public static void demoNullToEmpty()
   {
      final String operation = 'Strings.nullToEmpty(String)';
      printHeader(operation);
      printOriginalAndResultStrings('Dustin', Strings.nullToEmpty('Dustin'), operation);
      printOriginalAndResultStrings(null, Strings.nullToEmpty(null), operation);
      printOriginalAndResultStrings('', Strings.nullToEmpty(''), operation);
   }
 
   /**
    * Demonstrate Guava Strings.padStart(String,int,char) method on example
    * Strings.
    */
   public static void demoPadStart()
   {
      final String operation = 'Strings.padStart(String,int,char)';
      printHeader(operation);
      printOriginalAndResultStrings('Dustin', Strings.padStart('Dustin', 10, '_'), operation);
      /**
       * Do NOT call Strings.padStart(String,int,char) on a null String:
       * Exception in thread 'main' java.lang.NullPointerException
       *    at com.google.common.base.Preconditions.checkNotNull(Preconditions.java:187)
       *    at com.google.common.base.Strings.padStart(Strings.java:97)
       */
      //printOriginalAndResultStrings(null, Strings.padStart(null, 10, '_'), operation);
      printOriginalAndResultStrings('', Strings.padStart('', 10, '_'), operation);     
   }
 
   /**
    * Demonstrate Guava Strings.padEnd(String,int,char) method on example
    * Strings.
    */
   public static void demoPadEnd()
   {
      final String operation = 'Strings.padEnd(String,int,char)';
      printHeader(operation);
      printOriginalAndResultStrings('Dustin', Strings.padEnd('Dustin', 10, '_'), operation);
      /**
       * Do NOT call Strings.padEnd(String,int,char) on a null String:
       *    Exception in thread 'main' java.lang.NullPointerException
       *       at com.google.common.base.Preconditions.checkNotNull(Preconditions.java:187)
       *       at com.google.common.base.Strings.padEnd(Strings.java:129)
       */
      //printOriginalAndResultStrings(null, Strings.padEnd(null, 10, '_'), operation);
      printOriginalAndResultStrings('', Strings.padEnd('', 10, '_'), operation);      
   }
 
   /** Demonstrate Guava Strings.repeat(String,int) method on example Strings. */
   public static void demoRepeat()
   {
      final String operation = 'Strings.repeat(String,int)';
      printHeader(operation);
      printOriginalAndResultStrings('Dustin', Strings.repeat('Dustin', 3), operation);
      /**
       * Do NOT call Strings.repeat(String,int) on a null String:
       *    Exception in thread 'main' java.lang.NullPointerException
       *       at com.google.common.base.Preconditions.checkNotNull(Preconditions.java:187)
       *       at com.google.common.base.Strings.repeat(Strings.java:153)
       */
      //printOriginalAndResultStrings(null, Strings.repeat(null, 3), operation);
      printOriginalAndResultStrings('', Strings.repeat('', 3), operation);
   }
 
   /**
    * Print a separation header to standard output.
    *
    * @param headerText Text to be placed in separation header.
    */
   public static void printHeader(final String headerText)
   {
      out.println('\n=========================================================');
      out.println('= ' + headerText);
      out.println('=========================================================');
   }
 
   /**
    * Main function for demonstrating Guava's Strings class.
    *
    * @param arguments Command-line arguments: none anticipated.
    */
   public static void main(final String[] arguments)
   {
      demoIsNullOrEmpty();
      demoEmptyToNull();
      demoNullToEmpty();
      demoPadStart();
      demoPadEnd();
      demoRepeat();
   }
}

Методы для заполнения и для повторения строк не должны быть любезны, чтобы нулевые строки были переданы им. Действительно, передача нулевого значения этим трем методам приводит к созданию исключения NullPointerException . Интересно, что это больше примеров того, как Guava использует класс Preconditions в своем собственном коде.

Вывод

Многие библиотеки и фреймворки Java предоставляют функциональность манипулирования StringUtil классов с такими именами, как StringUtil . Класс Strings Guava — один из таких примеров, и предоставляемые им методы могут упростить и сделать Java-манипуляции со строками более лаконичными. Действительно, поскольку я использую методы Guava’s Strings , я чувствую, что я использую некоторые из качеств Groovy в GDK String .

Ссылка: класс струн Гуавы от нашего партнера JCG Дастина Маркса в блоге Inspired by Actual Events .

41
Share: