# goconf

**Repository Path**: fifsky/goconf

## Basic Information

- **Project Name**: goconf
- **Description**: 基于json的灵活golang配置库
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://github.com/fifsky/goconf
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-07-16
- **Last Updated**: 2020-12-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
<img
    src="logo.png"
    width="240" height="78" border="0" alt="GJSON">
<br>
<a href="https://travis-ci.org/fifsky/goconf"><img src="https://travis-ci.org/fifsky/goconf.svg" alt="Build Status"></a>
<a href="https://codecov.io/gh/fifsky/goconf"><img src="https://codecov.io/gh/fifsky/goconf/branch/master/graph/badge.svg" alt="codecov"></a>
<a href="https://goreportcard.com/report/github.com/fifsky/goconf"><img src="https://goreportcard.com/badge/github.com/fifsky/goconf" alt="Go Report Card
"></a>
<a href="https://godoc.org/github.com/fifsky/goconf"><img src="https://godoc.org/github.com/fifsky/goconf?status.svg" alt="GoDoc"></a>
<a href="https://opensource.org/licenses/mit-license.php" rel="nofollow"><img src="https://badges.frapsoft.com/os/mit/mit.svg?v=103"></a>
</p>

<p align="center">Gjson-based configuration file for golang</a></p>

GoConf is a Go package that quickly retrieves JSON configuration files based on [GJSON](https://github.com/tidwall/gjson/)

Getting Started
===============

## Installing

To start using GoConf, install Go and run `go get`:

```sh
$ go get -u github.com/fifsky/goconf
```

This will retrieve the library.


## Load multiple configs

You only need to declare the Tag `conf:"filename"` on the struct

```
type log struct {
    LogName string `json:"log_name"`
    LogPath string `json:"log_path"`
}

type db struct {
    Name string `json:"name"`
    Host string `json:"host"`
    Port string `json:"port"`
}

type config struct {
    Log log `conf:"log"`
    DB  db  `conf:"db"`
}

conf, err := NewConfig("./testdata/")
if err != nil {
    fmt.Fatal(err)
}

app := &config{}
err = conf.Load(app)

fmt.Printf("%#v",app)
```


## Get config a value

Config file: testdata/dev.json

```
{
  "name": {"first": "Tom", "last": "Anderson"},
  "age":37,
  "children": ["Sara","Alex","Jack"],
  "fav.movie": "Deer Hunter",
  "friends": [
    {"first": "Dale", "last": "Murphy", "age": 44},
    {"first": "Roger", "last": "Craig", "age": 68},
    {"first": "Jane", "last": "Murphy", "age": 47}
  ]
}
```


```go
package main

import "github.com/fifsky/goconf"

func main() {
    conf, _ := goconf.NewConfig("./testdata/")
    ret, _ := conf.Get("dev.name.last")

    println(ret.String())
}
```

This will print:

```
Anderson
```

You can also use the Must function to simplify this

```go
package main

import "github.com/fifsky/goconf"

func main() {
    conf, _ := goconf.NewConfig("./testdata/")
    println(conf.MustGet("dev.name.last").String())
}
```


> first key `dev` is filename

## Path Syntax
For more Path Syntax, see the [GJSON document](https://github.com/tidwall/gjson/blob/master/README.md#path-syntax)

## Default value
If you use the Must function to access a non-existent configuration file or keys, GoConf returns zero value, which is consistent with gjson.result

```go
conf.MustGet("dev.notfound").String() //value is empty string
conf.MustGet("dev2.not").Int() //value is 0 int
```

## Unmarshal to Struct
```go
type Database struct {
	Driver string `json:"driver"`
	Host   string `json:"host"`
	Port   int    `json:"port"`
}

type ConfigDemo struct {
	Database Database `json:"database"`
}

conf, _ := goconf.NewConfig("./testdata/")
app := &ConfigDemo{}
err = conf.Unmarshal("json5", app)
if err != nil {
    fmt.Println(err)
}
fmt.Println(app)
//&{{mysql localhost 3306}}
```

`Unmarshal` also supports Xpath

```go
database := &Database{}
conf.Unmarshl("json5.database",database)
```


## Contact
Xudong Cai [@fifsky](https://fifsky.com/)

## License

GoConf source code is available under the MIT [License](/LICENSE).