gqs

README

Go Query Scanner

go-query-scanner is a lightweight, pure Go scanner implemented without external dependencies. This package is designed to facilitate the transformation of query string requests into Go struct formats. It was developed as a solution to challenges encountered while i using the gorilla schema package for similar conversions. Although the schema structures were correctly defined when using gorilla schema, persistent errors indicated that the schema was invalid. These issues motivated the creation of go-query-scanner as a reliable alternative.

• Go Query Scanner
  • Installation
  • Example Usage
• Testing
  • Bugs
  • Contributing
  • License

Installation

$ go get github.com/restuwahyu13/go-query-scanner

Example Usage

  package main

  import (
    "fmt"
	"net/url"

   gqs "github.com/restuwahyu13/go-query-scanner"
  )

type TestStructx struct {
	Field1 string         `query:"field1"`
	Field2 int            `query:"field2"`
	Field3 bool           `query:"field3"`
	Field4 map[string]any `query:"field4"`
	Field5 float64        `query:"field5"`
	Field6 float32        `query:"field6"`
	Field7 int32          `query:"field7"`
	Field8 int64          `query:"field8"`
}

func main() {
	//  http://localhost:3000/api/users/?field1=value1&field2=123&field3=true&field4={"key1":"value1","key2":"value2"}&field5=123.456&field6=123.456&field7=123&field8=123

	server := http.ServeMux{}

	server.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
		query := r.URL.Query()
		dest := new(TestStruct)

		w.Header().Set("Content-Type", "application/json")

		if err := gqs.QueryScan(query.Encode(), dest); err != nil {
			w.WriteHeader(http.StatusBadRequest)
			w.Write([]byte("invalid query"))
			return
		}

		if err := json.NewEncoder(w).Encode(dest); err != nil {
			w.WriteHeader(http.StatusInternalServerError)
			w.Write([]byte("internal server error"))
			return
		}

		return
	})

	http.ListenAndServe(":3000", &server)

	// main.TestStruct{
	// 	Field1:"value1",
	// 	Field2:123,
	// 	Field3:true,
	// 	Field4:map[string]interface {}{"key1":"value1", "key2":"value2"},
	// 	Field5:123.456,
	// 	Field6:123.456,
	// 	Field7:123,
	// 	Field8:123
	// }
}

Testing

• Testing Via Local

   go test --race -v --failfast | make test
  

Bechmark

• Testing Via Local

   go test --race -v --failfast -bench=. -benchmem | make btest
  

    goos: linux
    goarch: amd64
    pkg: restuwahyu13/go-query-scanner
    cpu: AMD Ryzen 3 3200G with Radeon Vega Graphics
    BenchmarkQueryToStruct
    BenchmarkQueryToStruct-4                           35204             34304 ns/op           11471 B/op        112 allocs/op
    BenchmarkQueryToStructLargePayload
    BenchmarkQueryToStructLargePayload-4                1831            588038 ns/op           64871 B/op        610 allocs/op
    BenchmarkQueryToStructWithComplexJSON
    BenchmarkQueryToStructWithComplexJSON-4            35511             37386 ns/op           11955 B/op        109 allocs/op
    PASS
    ok      restuwahyu13/go-query-scanner    4.380s
  

Bugs

For information on bugs related to package libraries, please visit here

Contributing

Want to make Go Query Scanner more perfect ? Let's contribute and follow the contribution guide.

License

• MIT License

BACK TO TOP

Documentation

Index

• func QueryScan(query string, dest interface{}) error

Functions

func QueryScan

func QueryScan(query string, dest interface{}) error