Как реализовать интерфейс в Go?

Question

[danforth]

Всем привет!

Изучаю Go, добрался до интерфейсов, застрял на этом упражнении.

Задача такая: есть тип IPAddr основанный на базовом типе массив байт []byte. В этом типе будет хранится IP адрес.
Нужно реализовать интерфейс fmt.Stringer у которого есть один метод String() string. По финалу, IP должен выводится через точку, вот так: 8.8.8.8, у меня же в консоли (и в песочнице чуть ниже) все высыпает вот так [8 8 8 8]

Вот мой код (песочница):

package main

import "fmt"

type IPAddr [4]byte

// TODO: Add a "String() string" method to IPAddr.
func (i *IPAddr) String() string {
	return fmt.Sprintf("%d.%d.%d.%d", i[0], i[1], i[2], i[3])
}

func main() {
	hosts := map[string]IPAddr{
		"loopback":  {127, 0, 0, 1},
		"googleDNS": {8, 8, 8, 8},
	}
	for name, ip := range hosts {
		fmt.Printf("%v: %v\n", name, ip)
	}
}

Как же все таки реализовать интерфейс fmt.Stringer? Очевидно же, что у меня выводится просто %v, а не результат работы метода String()

Answer 1

[evnuh]

Вы реализовали интерфейс для типа "указатель на IPAddr", а распечатываете тип "IPAddr".

С этим возникает сложность из-за двойных стандартнов, принятых в Go, хотя и логичных. Запомните навсегда:

Pointer type can access the methods of its associated value type, but not vice versa. That is, a *Dog value can utilize the Speak method defined on Dog, but as we saw earlier, a Cat value cannot access the Speak method defined on *Cat.

То есть в вашем случае всё бы работало и при правильном совпадении типов И при неправильной, противоположной вашему коду ситуации - если бы вы реализовали интерфейс для самого типа, а пытались распечатать указатель на него.

Объясняется это просто - если метод реализован для указателя, он, скорее всего, может что-то менять в объекте по этому указателю, поэтому передавая объект по значению, а не по указателю - он бы менял не в самом объекте, а в его копии, которая бы делалась при передачи по значению. Это явно не то, чего ожидал писатель метода.
В обратном же случае, если метод определён для типа по значению, а не по указателю, очевидно что метод ничего в самом значении не меняет (если бы попытался, то менял бы опять же в копии значения). А раз он там ничего не меняет, можно смело передать наш объект под ссылкой.

Тут объясняется всё подробно: https://github.com/golang/go/wiki/MethodSets

Comments

[danforth]

Какой строчкой происходит реализация интерфейса? Допустим в PHP и ООП, это class A implements B, здесь в Go это происходит не явно? После этого, ответьте, пожалуйста, если я создаю метод для типа, а в качестве типа указываю указатель на него, получается, что значения не копируются, а обращение идет на прямую (как бы к объекту)? Вот вырезка из Go Play: There are two reasons to use a pointer receiver.
The first is so that the method can modify the value that its receiver points to.
The second is to avoid copying the value on each method call. This can be more efficient if the receiver is a large struct, for example.

[evnuh]

danforth: изменил ответ, прочитайте, если что-то непонятно, могу дополнить. Да, в Golang реализация интерфейсов НЕявная. То есть тип может считаться реализующим интерфейс, когда реализовал ВСЕ его методы. Более того, этот же тип будет автоматом реализовывать все интерфейсы, являющиеся подмножествами текущего.

[danforth]

evnuh: Спасибо большое за ответы и разъяснения, но ... все равно не совсем понятно, почему так происходит. Прочитал это jordanorelli.com/post/32665860244/how-to-use-inter... и на stackoverflow нашел почти аналогичный вопрос, но все равно чувствую, что в следующий раз наступлю на эти грабли.

Допустим, если открыть песочницу из моего вопроса и посмотреть на строку 18, там где идет вывод ключа и значения. Что дальше происходит? Мы имеем два разных значения, но у них одинаковый тип — IPAddr. Если я хочу взять значения лежащие в каком-то определенном IPAddr, то я могу обратиться к (утрировано) ячейке памяти, где лежит этот самый определенный IPAddr и прочесть все его i[0], i[1], i[2] ... etc. Мне не нужно копировать эти значения (зачем копировать, если я просто хочу их прочесть), но и менять я их не собираюсь, я просто хочу прочесть из определенного объекта, от которого я вызываю метод, вот так.... IPAddr.String()... и вот, собственно, какая беда: идеалогически все срабатывает как я и хочу - https://play.golang.org/p/6aQ2CAKLTi

А вот почему с интерфейсом такое не прокатывает, все равно не доходит.

[evnuh]

danforth: копирование будет в любом случае. Если вы вызываете с указателем, то скопируется только указатель, который будет указывать на ту же область памяти что и оригинальный указатель и вы сможете её поменять. Иначе же скопируется вся структура. Так передаются аргументы (ресивер метода - тоже аргумент).

Далее. Вы действительно привели хороший пример с методами на структуре. Вот я его визуализировал: https://play.golang.org/p/fl8hzKYXUQ
Получается, что в обе стороны работает для методов на структуре, а для функций интерфейса - только в одну. Почему так?
Мне самому пришлось открывать Effective Go уже в какой раз (в нём есть ответы на все вопросы).
Вот прямо ваш случай там и описан: https://golang.org/doc/effective_go.html#pointers_...
Ответ в слове Addressable.
`The rule about pointers vs. values for receivers is that value methods can be invoked on pointers and values, but pointer methods can only be invoked on pointers.`
...
`There is a handy exception, though. When the value is addressable, the language takes care of the common case of invoking a pointer method on a value by inserting the address operator automatically. In our example, the variable b is addressable, so we can call its Write method with just b.Write. The compiler will rewrite that to (&b).Write for us.`

Как я понимаю - структура - адресуемый тип, интерфейс - нет. (взял отсюда https://golang.org/ref/spec#Address_operators)

[evnuh]

danforth: нашёл ссылку на страницу объясняющую именно наш кейс, добавил в конец ответа

[danforth]

evnuh: правильно ли я понял, что в моей задаче, где-то внутри пакета fmt метод использует не &IPAddr, а просто IPAddr, отсюда и выходит, что доступ к методу IPAddr.String() отсутствует, ведь метод создан для указателя IPAddr? Тогда вопрос, почему в вашем комментарии выше написано: `The compiler will rewrite that to (&b).Write for us.`? Или в контексте интерфейса, все-же, `compliler will not rewrite`? Ещё почитаю сегодня статьи на эту тему. Реально не понятна практическая сторона вопроса: зачем?! Запутать у них отлично получилось.

[evnuh]

danforth: прочитайте последнюю ссылку в моём ответе. Компилер будет рерайтить только в случае, если переменная ADDRESSABLE. То есть, например, стурктура, слайс и т.д. Если переменная типа interface, а он не addressable, поэтому компилер не рерайтит на (&b).
fmt, очевидно, ничего не знает про ваши типы, а все передаваемые ему аргументы типа Stringer, то есть - интерфейсы. Это как раз тот момент, когда ваша переменная из адресуемого типа IPAddr превращается в неадресуемый interface Stringer.

[danforth]

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