Шаблоны и условия

Elixir предоставляет сопоставление с шаблонами, которое позволяет нам проверять структуру или извлекать значения из структур данных. Шаблоны часто дополняются условиями, которые предоставляют разработчикам возможность выполнять более сложные проверки, хотя и ограниченные.

Эта страница описывает семантику шаблонов и условий, где они разрешены, и как их расширить.

Шаблоны

Шаблоны в Elixir состоят из переменных, литералов и синтаксиса, специфичного для структур данных. Одним из наиболее используемых конструкций для сопоставления с шаблонами является оператор сопоставления (=):

iex> x = 1
1
iex> 1 = x
1

В приведенном выше примере x начинается без значения и получает значение 1. Затем мы сравниваем значение x с литералом 1, что успешно, так как они оба являются 1.

Сопоставление x со значением 2 вызовет ошибку:

iex> 2 = x
** (MatchError) no match of right hand side value: 1

Шаблоны не двусторонние. Если у вас есть переменная y, которой никогда не было присвоено значение (часто называется несвязанной переменной), и вы пишете 1 = y, будет выброшена ошибка:

iex> 1 = y
** (CompileError) iex:2: undefined function y/0

Другими словами, шаблоны разрешены только в левой части =. Правая часть = следует стандартным семантикам вычислений языка.

Теперь давайте рассмотрим правила сопоставления с шаблонами для каждой конструкции и каждого типа данных.

Переменные

Переменные в шаблонах всегда присваиваются значениям:

iex> x = 1
1
iex> x = 2
2
iex> x
2

Другими словами, Elixir поддерживает повторное присвоение. Если вы не хотите, чтобы значение переменной менялось, вы можете использовать оператор привязки (^):

iex> x = 1
1
iex> ^x = 2
** (MatchError) no match of right hand side value: 2

Если одна и та же переменная появляется дважды в одном шаблоне, то они должны быть связаны с одним и тем же значением:

iex> {x, x} = {1, 1}
{1, 1}
iex> {x, x} = {1, 2}
** (MatchError) no match of right hand side value: {1, 2}

Переменная с подчеркиванием (_) имеет специальное значение, так как она никогда не может быть связана ни с каким значением. Она особенно полезна, когда вы не заботитесь о определённом значении в шаблоне:

iex> {_, integer} = {:not_important, 1}
{:not_important, 1}
iex> integer
1
iex> _
** (CompileError) iex:3: invalid use of _

Литералы (числа и атомы)

Атомы и числа (целые и вещественные) могут появляться в шаблонах и всегда представляются как есть. Например, атом будет соответствовать только атому, если они совпадают:

iex> :atom = :atom
:atotm
iex> :atom = :another_atom
** (MatchError) no match of right hand side value: :another_atom

Аналогичное правило применяется к числам. Наконец, обратите внимание, что числа в шаблонах выполняют строгое сравнение. Другими словами, целые числа не соответствуют вещественным числам:

iex> 1 = 1.0
** (MatchError) no match of right hand side value: 1.0

Кортежи

Кортежи могут появляться в шаблонах, используя синтаксис фигурных скобок ({}). Кортеж в шаблоне будет соответствовать только кортежам той же размерности, где каждый отдельный элемент кортежа также должен соответствовать:

iex> {:ok, integer} = {:ok, 13}
{:ok, 13}

# won't match due to different size
iex> {:ok, integer} = {:ok, 11, 13}
** (MatchError) no match of right hand side value: {:ok, 11, 13}

# won't match due to mismatch on first element
iex> {:ok, binary} = {:error, :enoent}
** (MatchError) no match of right hand side value: {:error, :enoent}

Списки

Списки могут появляться в шаблонах, используя синтаксис квадратных скобок ([]). Список в шаблоне будет соответствовать только спискам той же размерности, где каждый отдельный элемент списка также должен соответствовать:

iex> [:ok, integer] = [:ok, 13]
[:ok, 13]

# won't match due to different size
iex> [:ok, integer] = [:ok, 11, 13]
** (MatchError) no match of right hand side value: [:ok, 11, 13]

# won't match due to mismatch on first element
iex> [:ok, binary] = [:error, :enoent]
** (MatchError) no match of right hand side value: [:error, :enoent]

В отличие от кортежей, списки также позволяют сопоставление с непустыми списками, используя обозначение [head | tail], которое соответствует head и tail списка:

iex> [head | tail] = [1, 2, 3]
[1, 2, 3]
iex> head
1
iex> tail
[2, 3]

Несколько элементов могут предшествовать конструкции | tail:

iex> [first, second | tail] = [1, 2, 3]
[1, 2, 3]
iex> tail
[3]

Обратите внимание, что [head | tail] не соответствует пустым спискам:

iex> [head | tail] = []
** (MatchError) no match of right hand side value: []

Поскольку списки символов представлены как список целых чисел, можно также выполнять сопоставления с префиксом на списках символов, используя оператор конкатенации списков (++):

iex> 'hello ' ++ world = 'hello world'
'hello world'
iex> world
'world'

Что эквивалентно сопоставлению с [?h, ?e, ?l, ?l, ?o, ?\s | world]. Сопоставления с суффиксом (hello ++ ' world') не являются допустимыми шаблонами.

Карты

Карты могут появляться в шаблонах, используя символ процента, за которым следуют фигурные скобки (%{}). В отличие от списков и кортежей, карты выполняют подмножественное сопоставление. Это означает, что шаблон карты будет соответствовать любой другой карте, которая содержит по крайней мере все ключи в шаблоне.

Вот пример, где все ключи совпадают:

iex> %{name: name} = %{name: "meg"}
%{name: "meg"}
iex> name
"meg"

Вот пример, когда совпадает подмножество ключей:

iex> %{name: name} = %{name: "meg", age: 23}
%{age: 23, name: "meg"}
iex> name
"meg"

Если ключ в шаблоне недоступен в карте, они не будут соответствовать:

iex> %{name: name, age: age} = %{name: "meg"}
** (MatchError) no match of right hand side value: %{name: "meg"}

Обратите внимание, что пустая карта будет соответствовать всем картам, что является отличием от кортежей и списков, где пустой кортеж или пустой список будут соответствовать только пустым кортежам и пустым спискам соответственно:

iex> %{} = %{name: "meg"}
%{name: "meg"}

Наконец, обратите внимание, что ключи карты в шаблонах должны всегда быть литералами или ранее связанными переменными, сопоставленными с оператором привязки.

Бинарные данные

Бинарные данные могут появляться в шаблонах, используя синтаксис двойного знака меньше/больше (<<>>). Бинарные данные в шаблоне могут соответствовать нескольким сегментам одновременно, каждый из которых имеет разный тип, размер и единицу:

iex> <<val::unit(8)-size(2)-integer>> = <<123, 56>>
"{8"
iex> val
31544

См. документацию по <<>> для полного определения сопоставления с шаблонами для бинарных данных.

Наконец, помните, что строки в Elixir — это бинарные данные, закодированные в UTF-8. Это означает, что, аналогично спискам символов, сопоставления с префиксом на строках также возможны с помощью оператора конкатенации бинарных данных (<>):

iex> "hello " <> world = "hello world"
"hello world"
iex> world
"world"

Сопоставления с суффиксом (hello <> " world") не являются допустимыми шаблонами.

Условия

Условия — это способ расширить сопоставление с шаблонами с помощью более сложных проверок. Они разрешены в предопределенных конструкциях, где разрешено сопоставление с шаблонами, таких как определения функций, ветви case и другие.

Не все выражения разрешены в условиях, а только несколько. Это осознанное решение. Таким образом, Elixir (и Erlang) могут гарантировать, что ничего плохого не произойдёт во время выполнения условий и не произойдёт никаких мутаций где-либо. Это также позволяет компилятору эффективно оптимизировать код, связанный с условиями.

Список разрешённых функций и операторов

Вы можете найти встроенный список условий в модуле Kernel. Вот обзор:

операторы сравнения (==, !=, ===, !==, <, <=, >, >=)
строго булевы операторы (and, or, not). Обратите внимание, что операторы &&, ||, и ! не разрешены, так как они не строго булевы — это означает, что они не требуют, чтобы аргументы были булевыми
арифметические унарные операторы (+, -)
арифметические бинарные операторы +, -, *, /)
операторы in и not in (если правая часть — это список или диапазон)
функции «проверки типа» (is_list/1, is_number/1 и подобные)
функции, работающие со встроенными типами данных (abs/1, hd/1, map_size/1 и другие)

Модуль Bitwise также включает несколько битовых операций Erlang в качестве условий.

Макросы, построенные из любого сочетания вышеперечисленных условий, также являются допустимыми условиями — например, Integer.is_even/1. Для получения дополнительной информации см. раздел «Определение пользовательских выражений условий» ниже.

Зачем нужны условия

Давайте рассмотрим пример условия, используемого в предложении функции:

def empty_map?(map) when map_size(map) == 0, do: true
def empty_map?(map) when is_map(map), do: false

Условия начинаются с оператора when, за которым следует выражение условия. Предложение будет выполнено только в том случае, если выражение условия вернёт значение true. Несколько булевых условий могут быть объединены с помощью операторов and и or.

Написать функцию empty_map?/1 только с помощью сопоставления с шаблонами не представляется возможным (поскольку сопоставление с шаблоном для %{} соответствовало бы любой карте, а не только пустым).

Ошибочные условия

Предложение функции будет выполнено только в том случае, если выражение условия оценивается как true. Если возвращается любое другое значение, предложение функции будет пропущено. В частности, условия не имеют понятия «истинно» или «ложно».

Например, рассмотрим функцию, которая проверяет, что первый элемент списка не nil:

def not_nil_head?([head | _]) when head, do: true
def not_nil_head?(_), do: false

not_nil_head?(["some_value", "another_value"])
#=> false

Несмотря на то, что первый элемент списка не nil, первое предложение для not_nil_head?/1 терпит неудачу, потому что выражение не оценивается как true, а как "some_value", тем самым активируя второе предложение, которое возвращает false. Чтобы условие работало правильно, необходимо убедиться, что условие оценивается как true, как показано ниже:

def not_nil_head?(term) when head != nil, do: true
def not_nil_head?(_), do: false

not_nil_head?(["some_value", "another_value"])
#=> true

Ошибки в условиях

В условиях, когда функции обычно вызывают исключения, они вместо этого вызывают неудачу условия.

Например, функция tuple_size/1 работает только с кортежами. Если мы используем её с чем-то другим, будет выброшено исключение ошибки аргумента:

iex> tuple_size("hello")
** (ArgumentError) argument error

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

iex> case "hello" do
...>   something when tuple_size(something) == 2 ->
...>     :worked
...>   _anything_else ->
...>     :failed
...> end
:worked

Во многих случаях это можно использовать с пользой. В приведенном выше коде мы использовали tuple_size/1 для проверки того, что данное значение является кортежем и проверки его размера (вместо использования is_tuple(something) and tuple_size(something) == 2).

Однако, если в вашем условии несколько условий, таких как проверка кортежей или карт, лучше сначала вызвать функции проверки типа, такие как is_tuple/1, перед tuple_size/1, иначе всё условие потерпит неудачу, если кортеж не задан. В качестве альтернативы, ваше предложение функции может использовать несколько условий, как показано в следующем разделе.

Несколько условий в одном предложении

Существует дополнительный способ упрощения цепочки выражений or в условиях: Elixir поддерживает запись «множественных условий» в одном и том же предложении. Следующий код:

def is_number_or_nil(term) when is_integer(term) or is_float(term) or is_nil(term),
  do: :maybe_number
def is_number_or_nil(_other),
  do: :something_else

может быть альтернативно записан как:

def is_number_or_nil(term)
    when is_integer(term)
    when is_float(term)
    when is_nil(term) do
  :maybe_number
end

def is_number_or_nil(_other) do
  :something_else
end

Если каждое выражение условия всегда возвращает логическое значение, то оба формата эквивалентны. Однако следует помнить, что если какой-либо вызов функции в условии вызывает исключение, то всё условие терпит неудачу. Чтобы проиллюстрировать это, следующая функция не обнаружит пустые кортежи:

defmodule Check do
  # If given a tuple, map_size/1 will raise, and tuple_size/1 will not be evaluated
  def empty?(val) when map_size(val) == 0 or tuple_size(val) == 0, do: true
  def empty?(_val), do: false
end

Check.empty?(%{})
#=> true

Check.empty?({})
#=> false # true was expected!

Это можно исправить, гарантируя, что исключение не возникает, либо с помощью проверок типов, таких как is_map(val) and map_size(val) == 0, либо с использованием множественных условий, так что если исключение вызывает неудачу одного условия, то следующее условие оценивается.

defmodule Check do
  # If given a tuple, map_size/1 will raise, and the second guard will be evaluated
  def empty?(val)
      when map_size(val) == 0
      when tuple_size(val) == 0,
      do: true

  def empty?(_val), do: false
end

Check.empty?(%{})
#=> true

Check.empty?({})
#=> true

Где можно использовать шаблоны и условия

В примерах выше мы использовали оператор совпадения (=) и правила функций, чтобы продемонстрировать шаблоны и условия соответственно. Вот список встроенных конструкций в Elixir, которые поддерживают шаблоны и условия.

оператор совпадения (=) (исключительно не поддерживает условия):
```
{:ok, binary} = File.read("some/file")
```

match?/2:

match?({:ok, value} when value > 0, {:ok, 13})

правила функций:

def type(term) when is_integer(term), do: :integer
def type(term) when is_float(term), do: :float

case выражения:

case x do
  1 -> :one
  2 -> :two
  n when is_integer(n) and n > 2 -> :larger_than_two
end

анонимные функции (fn/1):

larger_than_two? = fn
  n when is_integer(n) and n > 2 -> true
  n when is_integer(n) -> false
end

for и with поддерживают шаблоны и условия слева от <-:
```
for x when x >= 0 <- [1, -2, 3, -4], do: x
```
with также поддерживает ключевое слово else, которое поддерживает сопоставление шаблонов и условия.
try поддерживает шаблоны и условия в catch и else
пользовательские условия также можно определить с помощью defguard/1 и defguardp/1. Пользовательское условие может быть определено только на основе существующих условий.

Пользовательские шаблоны и выражения условий

Только указанные в этой странице конструкции разрешены в шаблонах и условиях. Однако мы можем использовать макросы для написания пользовательских шаблонов и условий, которые могут упростить наши программы или сделать их более специфичными для конкретной предметной области. В конечном итоге важно, чтобы выходные данные макросов сводились к сочетанию конструкций выше.

Например, модуль Record в Elixir предоставляет набор макросов для использования в шаблонах и условиях, которые позволяют кортежам иметь именованные поля во время компиляции.

Для определения собственных условий Elixir даже предоставляет удобства в defguard и defguardp. Давайте рассмотрим быстрый пример: мы хотим проверить, является ли аргумент чётным или нечётным целым числом. С помощью сопоставления шаблонов это невозможно, потому что существует бесконечное количество целых чисел, и поэтому мы не можем сопоставить шаблон с каждым из них. Поэтому мы должны использовать условия. Мы сосредоточимся только на проверке чётных чисел, так как проверка нечётных практически идентична.

Такое условие будет выглядеть так:

def my_function(number) when is_integer(number) and rem(number, 2) == 0 do
  # do stuff
end

Было бы повторяющимся писать каждый раз, когда нам нужна эта проверка. Вместо этого вы можете использовать defguard/1 и defguardp/1 для создания макросов условий. Вот пример:

defmodule MyInteger do
  defguard is_even(term) when is_integer(term) and rem(term, 2) == 0
end

и затем:

import MyInteger, only: [is_even: 1]

def my_function(number) when is_even(number) do
  # do stuff
end

Хотя возможно создавать пользовательские условия с помощью макросов, рекомендуется определять их с помощью defguard/1 и defguardp/1, которые выполняют дополнительные проверки на этапе компиляции.

© 2012 Plataformatec
Licensed under the Apache License, Version 2.0.
https://hexdocs.pm/elixir/1.10.4/patterns-and-guards.html