Check if struct implements a given interface

Question

I need to walk through all the field of a struct type and check if they implements a given interface.

type Model interface {...}

func HasModels(m Model) {
    s := reflect.ValueOf(m).Elem()
    t := s.Type()
    modelType := reflect.TypeOf((*Model)(nil)).Elem()

    for i := 0; i < s.NumField(); i++ {
        f := t.Field(i)
        fmt.Printf("%d: %s %s -> %s\n", i, f.Name, f.Type, f.Type.Implements(modelType)) 
    }       
}

Then, if a call HasModels with a struct like so :

type Company struct {...}

type User struct {
    ...
    Company Company
}

HasModels(&User{})

With Company and User both implementing Model; I get f.Type.Implements(ModelType) returning false for the Company field of the User struct.

This is unexpected, so, what Am I doing wrong here ?

hlin117 · Accepted Answer · 2018-01-15 07:25:50Z

32

You've unfortunately left out the essential parts (please always post complete programs), so I can only guess that the problem is in a method defined on a pointer receiver, in which case the behavior of your code is expected. Check this example and its output:

package main

import (
        "fmt"
        "reflect"
)

type Model interface {
        m()
}

func HasModels(m Model) {
        s := reflect.ValueOf(m).Elem()
        t := s.Type()
        modelType := reflect.TypeOf((*Model)(nil)).Elem()

        for i := 0; i < s.NumField(); i++ {
                f := t.Field(i)
                fmt.Printf("%d: %s %s -> %t\n", i, f.Name, f.Type, f.Type.Implements(modelType))
        }
}

type Company struct{}

func (Company) m() {}

type Department struct{}

func (*Department) m() {}

type User struct {
        CompanyA    Company
        CompanyB    *Company
        DepartmentA Department
        DepartmentB *Department
}

func (User) m() {}

func main() {
        HasModels(&User{})
}

Playground

Output:

0: CompanyA main.Company -> true
1: CompanyB *main.Company -> true
2: DepartmentA main.Department -> false
3: DepartmentB *main.Department -> true

edited Jan 15, 2018 at 7:25

hlin117

22.5k32 gold badges77 silver badges94 bronze badges

answered Sep 2, 2013 at 10:45

zzzz

92k17 gold badges184 silver badges140 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

arnaud briche Over a year ago

you're guessing right. I just changed f.Type.Implements(modelType) to reflect.PtrTo(f.Type).Implements(modelType) and it works perfectly. Thx for the fast answer.

David Tootill · Accepted Answer · 2015-05-02 17:41:47Z

13

There's an easier way of doing this that doesn't need reflect. For example:

type middlewarer interface {Middleware() negroni.Handler}
for _, controller := range ctrls {
    if m, ok := interface{}(controller).(middlewarer); ok {
        n.Use(m.Middleware())
    }
}

calls the Middleware() method only in those slice elements that implement the middlewarer interface.

answered May 2, 2015 at 17:41

David Tootill

5716 silver badges11 bronze badges

2 Comments

Dave C Over a year ago

Except this doesn't relate to the OP\s question which does not have a slice of anything. They have only a struct and wish to check each field of that.

nevets Over a year ago

you didn't answer the op's question, but you did give a proper way to check if a struct implements a given struct, which is exactly what shows in the title.

andygarfield · Accepted Answer · 2021-12-01 19:16:37Z

2

If the variable is not an interface, make it one.

foo := interface{}(yourVar)

Then you can check if it implements the interface you're interested in.

bar, ok := foo.(yourInterface)
if !ok {
    // handle the case where it doesn't match the interface
}
bar.methodOnYourInterface()

Here's a playground link for a more fleshed out example

edited Dec 1, 2021 at 19:16

answered Dec 1, 2021 at 19:08

andygarfield

213 bronze badges

Collectives™ on Stack Overflow

Check if struct implements a given interface

3 Answers 3

1 Comment

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related