Любой, кто много писал на Java, вероятно, написал методы, которые начинаются с условных выражений, которые проверяют либо предоставленные параметры, либо состояние объекта, с которым выполняются действия, прежде чем переходить к остальной части реализации метода. Это может добавить многословность методу и иногда, особенно если есть несколько проверок, может почти заглушить интересную бизнес-логику метода. Одним из способов уменьшить этот беспорядок является использование утверждений Java , но они по умолчанию отключены во время выполнения . На самом деле, по этой причине рекомендуется «не использовать утверждения для проверки аргументов в открытых методах» и вместо этого использовать соответствующие исключения времени выполнения . Guava предоставляет удобный класс Preconditions с эстетическими преимуществами утверждений, но он использует обычный механизм исключений Java и не отключается во время выполнения. В этом посте приводятся некоторые иллюстративные примеры класса предварительных условий Guava в действии.
В следующем листинге кода показаны надуманные примеры с использованием класса предварительных условий Guava . В этом примере демонстрируется использование статических методов в классе Preconditions для проверки параметра на нулевое значение, проверки размещения параметра в предоставленном массиве, проверки наличия действительного значения для параметра и проверки состояния объекта на метод, который вызывается, подходит для выполнения этого метода. Также обратите внимание, что я использовал статический импорт для класса Preconditions так что я могу вызывать его статические методы без необходимости ограничивать каждый вызов именем класса.
GuavaPreconditionsDemo.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
|
package dustin.examples;import static java.lang.System.err;import static com.google.common.base.Preconditions.*;/** * Simple demonstration of Guava's Preconditions support. * * @author Dustin */public class GuavaPreconditionsDemo{ private final boolean initialized = false; /** * Demonstrate Guava's Preconditions.checkNotNull methods. * * @param parameter Parameter that is checked for null-ness. */ public void testForNonNullArgument(final String parameter) { final String localParameter = checkNotNull(parameter, 'Provided parameter is unacceptably null.'); } public void testDivisorNotZero(final int divisor) { checkArgument(divisor != 0, 'Zero divisor not allowed.'); } public void testArrayElement(final String[] strArray, final int indexNumber) { final int index = checkElementIndex(indexNumber, strArray.length, 'String array index number'); } public void testArrayPosition(final String[] strArray, final int indexNumber) { final int index = checkPositionIndex(indexNumber, strArray.length, 'String array index number'); } public void testState() { checkState(this.initialized, 'Cannot perform action because not initialized.'); } public static void printHeader(final String newHeaderText) { err.println('\n=========================================================='); err.println('== ' + newHeaderText); err.println('=========================================================='); } /** * Main function for executing demonstrations of Guava's Preconditions. */ public static void main(final String[] arguments) { final GuavaPreconditionsDemo me = new GuavaPreconditionsDemo(); printHeader('Preconditions.checkNotNull'); try { me.testForNonNullArgument(null); } catch (NullPointerException npe) { npe.printStackTrace(); } printHeader('Preconditions.checkArgument'); try { me.testDivisorNotZero(0); } catch (IllegalArgumentException illArgEx) { illArgEx.printStackTrace(); } printHeader('Preconditions.checkElementIndex'); try { me.testArrayElement(new String[]{'Dustin', 'Java'}, 3); } catch (IndexOutOfBoundsException ioobEx) { ioobEx.printStackTrace(); } printHeader('Preconditions.checkPositionIndex'); try { me.testArrayPosition(new String[]{'Dustin', 'Java'}, 3); } catch (IndexOutOfBoundsException ioobEx) { ioobEx.printStackTrace(); } printHeader('Preconditions.checkState'); try { me.testState(); } catch (IllegalStateException illStateEx) { illStateEx.printStackTrace(); } }} |
В каждом из случаев, продемонстрированных в приведенном выше листинге кода, проверяются предварительные условия для параметров метода или состояния объекта, для которого вызывается метод, без использования условных операторов «с шумом». Использование статического импорта позволило очень кратко выразить условия, подлежащие проверке. Большая часть класса является функцией ‘main’, используемой в этом случае как ‘тестовый драйвер’. Я поместил вызовы в блок try-catch, чтобы убедиться, что все демонстрации выполнены. Результат выполнения вышеуказанного показан ниже.
Выход из выполнения над классом
|
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
39
|
============================================================ Preconditions.checkNotNull==========================================================java.lang.NullPointerException: Provided parameter is unacceptably null. at com.google.common.base.Preconditions.checkNotNull(Preconditions.java:204) at dustin.examples.GuavaPreconditionsDemo.testForNonNullArgument(GuavaPreconditionsDemo.java:22) at dustin.examples.GuavaPreconditionsDemo.main(GuavaPreconditionsDemo.java:62)============================================================ Preconditions.checkArgument==========================================================java.lang.IllegalArgumentException: Zero divisor not allowed. at com.google.common.base.Preconditions.checkArgument(Preconditions.java:88) at dustin.examples.GuavaPreconditionsDemo.testDivisorNotZero(GuavaPreconditionsDemo.java:27) at dustin.examples.GuavaPreconditionsDemo.main(GuavaPreconditionsDemo.java:72)============================================================ Preconditions.checkElementIndex==========================================================java.lang.IndexOutOfBoundsException: String array index number (3) must be less than size (2) at com.google.common.base.Preconditions.checkElementIndex(Preconditions.java:301) at dustin.examples.GuavaPreconditionsDemo.testArrayElement(GuavaPreconditionsDemo.java:32) at dustin.examples.GuavaPreconditionsDemo.main(GuavaPreconditionsDemo.java:82)============================================================ Preconditions.checkPositionIndex==========================================================java.lang.IndexOutOfBoundsException: String array index number (3) must not be greater than size (2) at com.google.common.base.Preconditions.checkPositionIndex(Preconditions.java:351) at dustin.examples.GuavaPreconditionsDemo.testArrayPosition(GuavaPreconditionsDemo.java:37) at dustin.examples.GuavaPreconditionsDemo.main(GuavaPreconditionsDemo.java:92)============================================================ Preconditions.checkState==========================================================java.lang.IllegalStateException: Cannot perform action because not initialized. at com.google.common.base.Preconditions.checkState(Preconditions.java:145) at dustin.examples.GuavaPreconditionsDemo.testState(GuavaPreconditionsDemo.java:42) at dustin.examples.GuavaPreconditionsDemo.main(GuavaPreconditionsDemo.java:102) |
Различные статические методы Preconditions генерируют различные типы исключений времени выполнения, когда указанное условие нарушается. Они генерируют исключения, которые, как правило, подходят для конкретного случая, который нарушается. Это означает, что в большинстве случаев результат статического вызова метода Preconditions такой же, как и тот, который можно было бы явно выдать для этого условия, но с гораздо меньшим количеством кода для проверки и выброса исключения. Я не показывал это в этом посте, но перегруженные версии этих статических методов также позволяют предоставлять строковые аргументы для заполнения заполнителей в шаблонной строке. Это полезно для размещения значений, связанных с ошибочным условием, в сообщении об исключении.
Вывод
Гуава облегчает кодирование и улучшает беглость и читаемость проверки контракта в методах. Он предлагает преимущества лаконичного синтаксиса утверждений в сочетании с преимуществами традиционного выброса исключений времени выполнения.
Ссылка: класс предварительных условий для гуавы от нашего партнера JCG Дастина Маркса в блоге Inspired by Actual Events .