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

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
:atom
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"}

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

Структуры

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

Учитывая следующую структуру:

defmodule User do
  defstruct [:name]
end

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

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

Если задан неизвестный ключ, компилятор выдаст ошибку:

iex> %User{type: type} = %User{name: "meg"}
** (CompileError) iex: unknown key :type for struct User

Имя структуры можно извлечь, поместив переменную вместо имени модуля:

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

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

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

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?([head | _]) 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
:failed

Во многих случаях мы можем воспользоваться этим. В коде выше мы использовали 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, которые поддерживают шаблоны и защиты.

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
receive поддерживает шаблоны и защиты для сопоставления с принятыми сообщениями.
пользовательские защиты также могут быть определены с помощью defguard/1 и defguardp/1. Пользовательская защита может быть определена только на основе существующих защит.

Обратите внимание, что оператор сопоставления (=) не поддерживает защиты:

{:ok, binary} = File.read("some/file")

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

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

Например, модуль 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.13.4/patterns-and-guards.html

Настройки Шаблоны и условия