echo web 框架绑定 FormFile

Question

我正在为接受表单数据的 post 端点使用 Echo 框架。我使用 Struct 作为绑定模型来提取表单数据。我的绑定模型和上传处理程序代码如下所示。

 type FormModel struct {
    ID string                `form:"ID"`
    FirstName string                `form:"FirstName"`
    File      *multipart.FileHeader `form:"myFileName"`
}

func (cs *handler) uploadForm(c echo.Context) error {
s := new(FormModel)
if err := c.Bind(s); err != nil {
    return nil
}

fileHandler, err := c.FormFile("myFileName")

我能够通过绑定获取 ID 和 FirstName 等表单值。但是我无法在绑定期间获取文件。我必须使用 fileHandler, err := c.FormFile("myFileName") 来获取文件。有没有办法在绑定模型中获取文件信息？

Answer 1

Echo默认不支持绑定multipart.Form.File数据，需要重新绑定实现接口

为echo Bind封装了一层额外的bind FormFile。如果一个结构指针类型的属性类型是*multipart.FileHeader或[]*multipart.FileHeader，这个属性将使用反射设置为FormFile的值。

我大概实现了这个功能。没有用过echo，也没有测试过，但是思路是对的

最后更新：添加示例并修复要构建的代码。感谢@vicTROLLA 指出 typeMultipartFileHeader 类型定义错误。

package main

import (
    "bytes"
    "fmt"
    "github.com/labstack/echo"
    "io/ioutil"
    "mime/multipart"
    "net/http"
    "reflect"
    "strings"
    "time"
)

var (
    typeMultipartFileHeader      = reflect.TypeOf((*multipart.FileHeader)(nil))
    typeMultipartSliceFileHeader = reflect.TypeOf(([]*multipart.FileHeader)(nil))
)

type File struct {
    File  *multipart.FileHeader   `form:"file"`
    Files []*multipart.FileHeader `form:"files"`
}

func main() {
    app := echo.New()
    // warp bind suppet bind FormFile
    app.Binder = NewBindFile(app.Binder)
    app.Any("/file", func(ctx echo.Context) error {
        var file File
        err := ctx.Bind(&file)
        if err != nil {
            return err
        }

        readfile := func(file *multipart.FileHeader) {
            f, err := file.Open()
            if err != nil {
                fmt.Printf("open %s error: %s\n", file.Filename, err.Error())
                return
            }
            body, err := ioutil.ReadAll(f)
            fmt.Printf("read file %s error: %v body: %s\n", file.Filename, err, body)
        }

        readfile(file.File)
        for _, file := range file.Files {
            readfile(file)
        }
        return err
    })

    go func() {
        time.Sleep(200 * time.Millisecond)
        buf := bytes.NewBuffer(nil)
        w := multipart.NewWriter(buf)
        part, _ := w.CreateFormFile("file", "file")
        part.Write([]byte("this one file"))
        part, _ = w.CreateFormFile("files", "files")
        part.Write([]byte("fils part 1"))
        part, _ = w.CreateFormFile("files", "files")
        part.Write([]byte("fils part 2"))
        part, _ = w.CreateFormFile("files", "files")
        part.Write([]byte("fils part 3"))
        part, _ = w.CreateFormFile("files", "files")
        part.Write([]byte("fils part 4"))
        w.Close()
        http.Post("http://localhost:1323/file", w.FormDataContentType(), buf)
    }()

    app.Start(":1323")
}

type BindFunc func(interface{}, echo.Context) error

func (fn BindFunc) Bind(i interface{}, ctx echo.Context) error {
    return fn(i, ctx)
}

func NewBindFile(b echo.Binder) echo.Binder {
    return BindFunc(func(i interface{}, ctx echo.Context) error {
        err := b.Bind(i, ctx)
        if err == nil {
            ctype := ctx.Request().Header.Get(echo.HeaderContentType)
            // if bind form
            if strings.HasPrefix(ctype, echo.MIMEApplicationForm) || strings.HasPrefix(ctype, echo.MIMEMultipartForm) {
                // get form files
                var form *multipart.Form
                form, err = ctx.MultipartForm()
                if err == nil {
                    err = EchoBindFile(i, ctx, form.File)
                }
            }
        }
        return err
    })
}

func EchoBindFile(i interface{}, ctx echo.Context, files map[string][]*multipart.FileHeader) error {
    iValue := reflect.Indirect(reflect.ValueOf(i))
    // check bind type is struct pointer
    if iValue.Kind() != reflect.Struct {
        return fmt.Errorf("BindFile input not is struct pointer, indirect type is %s", iValue.Type().String())
    }

    iType := iValue.Type()
    for i := 0; i < iType.NumField(); i++ {
        fType := iType.Field(i)
        // check canset field
        fValue := iValue.Field(i)
        if !fValue.CanSet() {
            continue
        }
        // revc type must *multipart.FileHeader or []*multipart.FileHeader
        switch fType.Type {
        case typeMultipartFileHeader:
            file := getFiles(files, fType.Name, fType.Tag.Get("form"))
            if len(file) > 0 {
                fValue.Set(reflect.ValueOf(file[0]))
            }
        case typeMultipartSliceFileHeader:
            file := getFiles(files, fType.Name, fType.Tag.Get("form"))
            if len(file) > 0 {
                fValue.Set(reflect.ValueOf(file))
            }
        }
    }
    return nil
}

func getFiles(files map[string][]*multipart.FileHeader, names ...string) []*multipart.FileHeader {
    for _, name := range names {
        file, ok := files[name]
        if ok {
            return file
        }
    }
    return nil
}

echo web 框架绑定 FormFile

Echo web framework binding FormFile

go

go-echo