7. Каталог: список, массив и словарь

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

Контрольная точка: examples/07-catalog. Книга о SQL — учебная карточка для второго элемента каталога, а не обещание готового второго издания в магазине shanraq.org.

Набираете сами: подготовьте отдельную папку с вашим go.mod, новыми main.go и catalog.go, перенесите title.go и title_test.go из главы 6 и добавьте catalog_test.go из контрольной точки. Названия продолжают проходить прежнюю проверку.

Образ: ряд карточек и окно

Разложите три карточки в ряд. Теперь прикройте ряд листом бумаги с прямоугольным окном: видны только две карточки. Передвинуть границу окна и переписать карточку — разные действия. Если два окна открывают одну карточку, исправление на ней будет видно через оба.

Такой образ помогает разобраться со срезом: он описывает участок базового массива. Копия среза сама по себе не создаёт независимые копии элементов. А вот копирование массива копирует его элементы. Для независимого набора элементов среза мы явно выделим новое хранилище и скопируем туда данные.

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

А map представьте отдельным набором карточек «ключ — название». Этот набор помогает найти название по ключу, но не обещает порядок витрины. Для порядка у нас остаётся собственный список ключей.

Три задачи — три отдельных опыта

Перед соединением каталога проверим каждый контейнер отдельно. Нужны типы, for, range, функции и проверка названия. На этом этапе не требуется знать структуры или указатели: они появятся в следующей главе. В готовой папке есть три независимые программы в labs; основной пример магазина пока не меняйте.

Массив: известное количество элементов

Индекс — позиция элемента, отсчитываемая от нуля. В массиве длины 3 допустимы индексы 0, 1 и 2. len массива возвращает число элементов, а не последний индекс. [3]string — тип, [3]string{"PDF", "EPUB", "HTML"} — значение этого типа, записанное составным литералом.

package main

import "fmt"

func main() {
    formats := [3]string{"PDF", "EPUB", "HTML"}
    other := formats
    other[0] = "TXT"
    fmt.Println(len(formats), formats[0], other[0])
    for index, format := range formats {
        fmt.Println(index, format)
    }
}

go run ./labs/01-arrays

3 PDF TXT
0 PDF
1 EPUB
2 HTML

Присваивание other := formats копирует все три строковых элемента. Замена other[0] не заменяет formats[0]. range для массива даёт индекс и значение, в отличие от строки, где первый результат обозначал байтовое смещение. Мы не увеличивали длину массива: [3]string и [4]string остаются разными типами.

Опыт с отказом. В копии программы попробуйте обратиться к постоянному индексу formats[3]: компилятор отклонит выход за границу. Если индекс приходит из переменной во время исполнения, недопустимое значение приведёт к панике. Проверка должна ограничивать индекс условием 0 <= index && index < len(formats). Верните рабочий вариант перед продолжением.

Срез: длина, ёмкость и общий массив

[]string — тип среза. Срез описывает участок базового массива: начало, текущую длину и доступную ёмкость. Присваивание среза копирует это описание, а не создаёт новый массив. Два среза могут обращаться к тем же элементам. Это существенно отличается от только что проверенного присваивания массива строк.

make([]string, length, capacity) создаёт срез с заданными длиной и ёмкостью. Когда третий аргумент опущен, ёмкость равна длине. Длина определяет доступные индексы сейчас; ёмкость — возможность расширения в этом массиве. Ёмкость 3 при длине 0 не разрешает запись в элемент [0].

append возвращает описание увеличенного среза: сохраните его. При достаточной ёмкости используется прежний массив, при недостаточной создаётся другой. Поэтому append не гарантирует независимой копии. copy копирует элементы в уже существующий срез-приёмник; количество ограничено длинами обоих срезов и возвращается как результат.

package main

import "fmt"

func main() {
    titles := []string{"Go", "SQL"}
    same := titles
    same[0] = "Web"
    fmt.Println(titles[0])
    independent := make([]string, len(titles))
    copied := copy(independent, titles)
    independent[0] = "Other"
    fmt.Println(copied, titles[0], independent[0])
    empty := make([]string, 0, 3)
    fmt.Println(len(empty), cap(empty), copy(empty, titles))
    empty = append(empty, "Go")
    fmt.Println(len(empty), empty[0])
    base := [3]string{"Go", "SQL", "Web"}
    part := base[:1]
    grown := append(part, "New")
    fmt.Println(base[1], len(part), len(grown))
}

go run ./labs/02-slices

Web
2 Web Other
0 3 0
1 Go
New 1 2

Разберите результат по действиям:

1. same[0] = "Web" меняет общий элемент; через titles[0] видим Web.
2. Для independent выделено новое хранилище, скопированы два элемента; замена его строки не меняет titles.
3. Приёмник empty имеет ёмкость 3, но длину 0: copy переносит ноль элементов.
4. После сохранённого append длина равна 1, и индекс 0 доступен.
5. base[:1] видит один элемент, но может расширяться в прежнем массиве. append(part, "New") заменяет base[1]. Длина старого part остаётся 1, а возвращённого grown равна 2.

Двоеточие в base[low:high] задаёт диапазон с включённой левой и исключённой правой границей. Пропущенный low означает 0, пропущенный high — текущую длину. Здесь используем диапазон внутри текущей длины. Возможность расширения среза до ёмкости требует отдельного контроля границ; она не разрешает обычный доступ [index] за длиной.

var titles []string даёт nil-срез: его длина и ёмкость равны нулю. В него можно добавлять через titles = append(titles, "Go"). Пустой созданный срез тоже может иметь длину ноль, но не быть nil. Ни nil-срез, ни пустой срез не содержат элемента с индексом 0.

Самостоятельно. Измените получатель копии на make([]string, 0, len(titles)). Предскажите copy: вернётся 0, потому что длина равна нулю. Не выполняйте следующую запись [0] у пустого среза; исправьте длину приёмника. Это проверка смысла len, а не повод ловить панику вместо правильного создания среза.

Словарь: наличие ключа важнее позиции

map[string]int связывает строковый ключ с целым значением. Запись quantities["go"] = 2 создаёт или заменяет значение этого ключа. Запрос отсутствующего ключа возвращает нулевое значение типа элемента — здесь 0. Чтобы отличить отсутствие от действительно записанного нуля, используем два результата: value, exists := quantities["go"].

В словаре нет «первого» элемента витрины. Порядок обхода не гарантирован. Ключ должен поддерживать сравнение на равенство: строка подходит, срез — нет. Один ключ связан с одним текущим значением; повторное присваивание тому же ключу не создаёт вторую строку.

package main

import "fmt"

func main() {
    var uninitialized map[string]int
    fmt.Println(uninitialized["go"])
    quantities := make(map[string]int)
    quantities["go"] = 0
    value, exists := quantities["go"]
    missing, found := quantities["sql"]
    fmt.Println(value, exists, missing, found)
    quantities["go"] = 2
    same := quantities
    same["go"] = 3
    fmt.Println(quantities["go"])
    delete(quantities, "go")
    _, exists = quantities["go"]
    fmt.Println(exists, len(quantities))
    quantities["sql"] = 1
    clear(quantities)
    fmt.Println(len(quantities), quantities == nil)
}

go run ./labs/03-maps

0
0 true 0 false
3
false 0
0 false

Из nil-map можно читать, но записывать в неё нельзя: программа запаникует. make(map[string]int) создаёт рабочий словарь. Копирование значения map, как same := quantities, сохраняет доступ к общим записям, поэтому изменение через same видно через quantities.

delete(quantities, "go") удаляет один ключ. Если его нет, ничего не происходит. clear(quantities) удаляет все записи, но не превращает созданную map в nil; в неё по-прежнему можно записывать. Обе функции встроены в язык и не требуют импорта. Значений для присваивания они не возвращают.

Проверка перед каталогом. Не глядя в код, объясните, почему две прочитанные величины могут равняться 0, но один признак присутствия истинен, а другой ложен. Затем выберите контейнер для трёх задач: фиксированные три формата; меняющийся упорядоченный список ID; поиск названия по ID. Ответ: массив, срез, map. Это выбор для нашего опыта, не обязательная архитектура любого магазина.

Сразу целиком

Файл main.go:

package main

import "fmt"

func main() {
    formats := [3]string{"PDF", "EPUB", "HTML"}
    fmt.Println("Форматы:", formats)

    ids := []string{"go-shop"}
    ids = append(ids, "sql-notes")
    titles := map[string]string{
        "go-shop":   "Go: от первой строки до интернет-магазина",
        "sql-notes": "Заметки о SQL",
    }
    ordered, ok := catalogTitles(ids, titles)
    if !ok {
        fmt.Println("Каталог неполон")
        return
    }
    for index, title := range ordered {
        fmt.Println(index+1, title)
    }
    _, found := titles["missing"]
    fmt.Println("Неизвестная книга найдена:", found)
}

Файл catalog.go:

package main

// catalogTitles сохраняет порядок ids и отказывает при неполных данных.
func catalogTitles(ids []string, titles map[string]string) ([]string, bool) {
    ordered := make([]string, 0, len(ids))
    for _, id := range ids {
        title, ok := titles[id]
        if !ok {
            return nil, false
        }
        title, ok = normalizeTitle(title)
        if !ok {
            return nil, false
        }
        ordered = append(ordered, title)
    }
    return ordered, true
}

Запустите go run .:

Форматы: [PDF EPUB HTML]
1 Go: от первой строки до интернет-магазина
2 Заметки о SQL
Неизвестная книга найдена: false

Первая книга в списке — наша книга. Словарь помогает получить название по идентификатору, а список задаёт последовательность показа.

Массив: длина входит в тип

[3]string означает массив из трёх строк. Число стоит между квадратными скобками и является частью типа: [2]string и [3]string — разные типы.

Мы сразу записали три значения: PDF, EPUB, HTML. К первому обращаются по индексу 0, к последнему — по 2. Индекса 3 у этого массива нет.

Массив выбран для демонстрации фиксированного набора. Это не утверждение, что вся архитектура магазина навсегда обязана хранить форматы в массиве. Когда у разных книг будет разный набор файлов, понадобится другая модель.

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

Срез: видимая часть массива

[]string означает срез строк. Числа между скобками нет. Начальный срез ids содержит один идентификатор. Вызов append(ids, "sql-notes") возвращает срез с добавленным элементом, и мы сохраняем этот результат обратно в ids.

Почему возвращённое значение важно? В срезе есть информация о начале данных, длине и доступной ёмкости. Добавление меняет длину, а иногда требует другого массива. Если не сохранить результат append, у вас не будет правильного описания расширенного среза.

len отвечает, сколько элементов сейчас видно. cap — сколько элементов доступно от начала этого среза до конца доступной ему области массива. Для среза, начинающегося в середине массива, это не обязательно размер всего исходного массива.

make([]string, 0, len(ids)) создаёт срез с нулевой длиной и заранее достаточной ёмкостью для нашего результата. Длина ноль означает, что обращаться к ordered[0] пока нельзя. Сначала нужно добавить элемент.

Общее хранилище: важная граница образа

Срез удобно представлять окном в массив. Но два окна могут показывать одни и те же ячейки. Выражение part := ids[:1] не обещает независимую копию первого элемента.

Здесь левая граница пропущена и равна нулю, правая не включается: виден только элемент с индексом 0. Если присвоить part[0] новое значение, оно будет видно через ids[0].

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

Копирование списка строк достаточно для независимой замены его строковых элементов. Для среза структур с вложенными map или другими срезами вопрос независимости придётся рассматривать глубже.

Не запоминайте конкретный коэффициент роста cap после append: наш код не должен зависеть от стратегии выделения памяти. Проверять нужно наличие элементов и требуемую независимость данных.

Словарь: ключ вместо позиции

В map[string]string первый тип относится к ключу, второй — к значению. Ключ go-shop связывается с названием книги.

Операция title, ok := titles[id] возвращает значение и признак присутствия ключа. Для неизвестного ключа строка будет пустой, а ok — ложным. Если ключ существует и хранит пустую строку, ok будет истинным. Поэтому функция сначала проверяет наличие ключа, затем вызывает normalizeTitle из главы 6: проверяются UTF-8, краевые пробелы, длина и однострочность. В результат попадает подготовленное название. Полезное правило не должно исчезать при переходе от одной книги к нескольким.

Нулевое значение map — nil. Из неё можно читать, получая отсутствие ключа. Записывать в nil map нельзя: нужен созданный словарь, например через make(map[string]string) или литерал, как в нашем примере. Это связано с начальным значением, а не со словом var: запись var titles = make(map[string]string) создаёт рабочий словарь.

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

Почему витрина не обходит map

Порядок обхода map не определён. Даже если несколько запусков случайно дали удобную последовательность, полагаться на неё нельзя.

Поэтому мы обходим ids. Для каждого идентификатора получаем соответствующее название. Если данных не хватает, возвращаем nil, false и не показываем частично собранный результат как полноценный каталог.

Два отдельных контейнера требуют согласованности. Можно добавить идентификатор и забыть название. В этой главе мы намеренно делаем такой риск видимым; следующая объединит поля книги в структуру и сократит число мест, которые нужно менять вместе.

Словарь полезен для поиска по ключу, но образ «мгновенного гардероба» не означает нулевого времени или гарантированной одинаковой стоимости любой операции. Производительность измеряют на задаче и данных, а не выводят из метафоры.

Проверяем поведение

catalog_test.go проверяет заданный порядок, отсутствующий ключ, пустое название и пустой каталог. Запустите go test ./....

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

Читаем коллекции по символам

В многострочном составном литерале после последнего элемента тоже стоит запятая. Она нужна для такой записи с переносом перед закрывающей скобкой. Не переносите правило на список аргументов в одну строку бездумно: здесь мы объясняем конкретный многострочный пример.

range ordered даёт индекс и значение элемента среза. Выражение index+1 только меняет печатаемый номер: индекс самого среза по-прежнему начинается с нуля. Формат %v в сообщении теста показывает значение в обычном представлении.

Восстановите по памяти. Нарисуйте словарь как карточки «ключ — название» и отдельно список ключей для витрины. Проведите путь от первого элемента списка к его названию. Если хочется взять «первую запись map», вернитесь к правилу порядка обхода.

Разминка

Предскажите. Сколько элементов видит срез после make([]string, 0, 10)?

Заполните. Как сохранить результат добавления: ids = ___(ids, "new-book")?

Почините. copy вернул ноль, хотя у приёмника ёмкость десять. Какое второе свойство приёмника нужно проверить?

Задание

Обязательное. Добавьте третью карточку с идентификатором go-tests и названием Тесты на Go. Она должна появиться третьей. Затем удалите только её название из map: программа должна вывести Каталог неполон, а не первые две карточки как будто всё получилось.

На своих данных. Поменяйте порядок идентификаторов. Убедитесь, что меняется порядок витрины, а пары в словаре переписывать не нужно.

По желанию. Создайте срез из двух строк, получите part := original[:1], поменяйте part[0]. Повторите с отдельным приёмником и copy. Сравните результаты.

Ответы

У среза длина ноль: ёмкость не даёт права обратиться к ещё не существующему элементу. Для добавления используется append. copy учитывает длину приёмника, поэтому её тоже надо проверить.

В обязательной задаче изменяются два места: добавление идентификатора и запись в словаре. Структура объединит поля одной книги; для полного каталога структур всё равно понадобятся список и правило поиска. В следующей контрольной точке начнём с одной такой структуры.

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