Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/insei/gomapper
A simple structure-to-structure converter. It is an excellent choice for mapping Data Transfer Objects (DTOs) to domain models.
https://github.com/insei/gomapper
automapper dto dto-entity-mapper dto-mapper dto-pattern dtos go golang
Last synced: about 1 month ago
JSON representation
A simple structure-to-structure converter. It is an excellent choice for mapping Data Transfer Objects (DTOs) to domain models.
- Host: GitHub
- URL: https://github.com/insei/gomapper
- Owner: Insei
- License: apache-2.0
- Created: 2023-05-11T08:24:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-08T11:34:08.000Z (5 months ago)
- Last Synced: 2024-08-09T11:31:32.638Z (5 months ago)
- Topics: automapper, dto, dto-entity-mapper, dto-mapper, dto-pattern, dtos, go, golang
- Language: Go
- Homepage:
- Size: 45.9 KB
- Stars: 2
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://codecov.io/github/Insei/gomapper)
[](https://github.com/Insei/gomapper/actions/workflows/go.yml)
[](https://goreportcard.com/report/github.com/insei/gomapper)
[](https://godoc.org/github.com/insei/gomapper)
# GoMapper
GoMapper is a library for struct to struct mapping.
There are two use cases: Manual and Auto.
* `Manual` mode allows you to specify a function to convert one structure to another.
* `Auto` mode uses matching field names for automatic conversion;
it is important that not only the field names match, but also their types.
This mode also supports structures in structure fields and automatically works by matching field names.
It's based on [fmap](https://github.com/insei/fmap) switch case and reflect based library.
Both modes are route based. In which the reflect.Type of the source structure and the type of the destination structure
are specified. If such a route was not found, gomapper will return an error.
Also `gomapper` support slices, you don't need to specify types of slices for mapping.
## Installation
```bash
go get github.com/insei/gomapper@latest
```
## Examples
You can found a lot of examples in tests.
Manual route.
```go
package main
import (
"fmt"
"github.com/insei/gomapper"
)
type Source struct {
Name string
Age uint8
}
type Dest struct {
NameCustom string
Age uint8
}
func main() {
err := gomapper.AddRoute[Source, Dest](func(source Source, dest *Dest) error {
dest.NameCustom = source.Name
dest.Age = source.Age
return nil
})
if err != nil {
panic(err)
}
s := Source{
Name: "DefaultName",
Age: 16,
}
dest, err := gomapper.MapTo[Dest](s)
// or gomapper.MapTo[Dest](&s)
// or d := Dest{}
// gomapper.Map(&s, &d)
if err != nil {
panic(err)
}
fmt.Print(dest)
}
```
Auto Route.
```go
package main
import (
"fmt"
"github.com/insei/gomapper"
)
type Source struct {
Name string
Age uint8
}
type Dest struct {
NameCustom string
Age uint8
}
func main() {
err := gomapper.AutoRoute[Source, Dest]()
if err != nil {
panic(err)
}
s := Source{
Name: "DefaultName",
Age: 16,
}
dest, err := gomapper.MapTo[Dest](s)
// or gomapper.MapTo[Dest](&s)
// or dest := Dest{}
// gomapper.Map(&s, &dest)
if err != nil {
panic(err)
}
fmt.Print(dest)
}
```
Map structs into slices.
```go
package main
import (
"fmt"
"github.com/insei/gomapper"
)
type Source struct {
Name string
Age uint8
}
type Dest struct {
NameCustom string
Age uint8
}
func main() {
err := gomapper.AutoRoute[Source, Dest]() // or manual
if err != nil {
panic(err)
}
s := Source{
Name: "DefaultName",
Age: 16,
}
sSlice := []Source{ s }
sDest, err := gomapper.MapTo[[]Dest](sSlice)
// or sDest := []Dest{}
// sDest, err := gomapper.MapTo(sSlice, &sDest)
if err != nil {
panic(err)
}
fmt.Print(sDest)
}
```