Что лучше возвращить в Golang структуру или указатель на эту структуру?

В Go выбор между возвратом структуры и указателя на структуру зависит от нескольких факторов, таких как объем данных, стоимость копирования, необходимость изменения структуры и семантика кода. Рассмотрим плюсы и минусы каждого подхода:

Возврат структуры:

Плюсы:

1. Безопасность от изменений: Возвращая структуру, вы создаете копию данных. Это полезно, если не хотите, чтобы вызывающий код мог изменить исходные данные.
2. Меньше риска утечек памяти: Поскольку структуры хранятся на стеке (если они не слишком большие), после завершения работы функции память под них будет освобождена.
3. Простота: При работе с небольшими структурами это наиболее понятный и эффективный вариант, поскольку Go часто работает с маленькими объектами быстрее, чем с указателями.

Минусы:

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

Возврат указателя на структуру:

Плюсы:

1. Отсутствие копирования больших структур: Возврат указателя избегает копирования данных, особенно полезно для структур с большим объемом данных.
2. Изменяемость данных: Возвращая указатель, вы позволяете вызывающему коду изменять структуру, что важно, если структура должна быть модифицируема.
3. Передача по ссылке: Указатели передаются по ссылке, что экономит память и вычислительные ресурсы при работе с большими структурами.

Минусы:

1. Управление памятью: Указатели могут оставаться в памяти, если они сохраняются после использования, что может привести к увеличению использования памяти и утечкам, если неправильно работать с объектами.
2. Потенциальные проблемы с изменениями: Возврат указателя делает структуру доступной для изменений в других частях программы, что может привести к трудноуловимым ошибкам, если вы не ожидаете, что структура будет изменена.

Когда что использовать?

1. Возвращайте структуру:
   • Если структура небольшая (например, несколько полей примитивных типов).
   • Если вы не хотите, чтобы вызывающий код мог изменять состояние структуры.
   • Если копирование структуры дешевле и проще, чем работа с указателями.
2. Возвращайте указатель на структуру:
   • Если структура большая и копирование её будет дорогим.
   • Если структура должна быть изменяема после возврата.
   • Если вы хотите передавать структуру между функциями без копирования данных.

Пример:

• Если ваша структура выглядит так:
  
  Go

  type SmallStruct struct { A int B string }

  1 2 3 4 5

  type SmallStruct struct {     A int     B string }

  Вполне логично возвращать копию структуры, так как она небольшая и копирование будет дешёвым:
  
  Go

  func getSmallStruct() SmallStruct { return SmallStruct{A: 1, B: "text"} }

  1 2 3 4

  func getSmallStruct() SmallStruct {     return SmallStruct{A: 1, B: "text"} }

  Если структура большая:
  
  Go

  type LargeStruct struct { Data [1000]int Info string }

  1 2 3 4 5

  type LargeStruct struct {     Data [1000]int     Info string }

  Здесь разумнее вернуть указатель, чтобы избежать копирования:
  
  Go

  func getLargeStruct() *LargeStruct { return &LargeStruct{Info: "important data"} }

  1 2 3 4

  func getLargeStruct() *LargeStruct {     return &LargeStruct{Info: "important data"} }

   

Вывод:

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