# go-yaml

**Repository Path**: myProte/go-yaml

## Basic Information

- **Project Name**: go-yaml
- **Description**: 基于gopkg.in/yaml.v3包的封装，可提取到结构体。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2024-08-06
- **Last Updated**: 2024-08-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# go-yaml

#### 介绍
[gopkg.in/yaml.v3](https://pkg.go.dev/gopkg.in/yaml.v3#section-readme) 已经是个非常好用的包，但是在实际开发中总有类型转换带来的麻烦，`go-yaml`只是在它的基础上，简单的一层封装，作为某些类型的定义转换。

#### go module
```
go get gitee.com/wuuder/go-yaml
```


#### yaml文件
默认情况下会读取当前项目目录下的`./configs/app.yaml`文件

#### 初始化
```go
// 默认读取./configs/app.yaml文件
yml := New()

// 自定义yaml文件路径
yml := New(FilePath("./conf/app.yaml"))

// 自定义yaml文件,读取./configs/xxx.yaml文件
yml := New(Name("xxx.yaml"))

// 自定义yaml文件地址,读取./conf/app.yaml文件
yml := New(Dir("./conf"))
```
#### 获取结构体实例
app.yaml:
```yaml
user:
  name: wunder
  age: 18
  obj:
    a: 1
    b: b

```
main.go
```go
// 默认是查询第一层的键作为数据体
type User struct {
    Name string
    Age  int `json:"age"`
}

func getUser()  {
    var u User           // 映射结构体
    err := yml.G(&u)    // 查找一个user结构体
    if err != nil {
        fmt.Println(err)
    }
    fmt.Println(u)
}


// 查询其它的键的数据体
type Obj struct {
    A int
    B string `json:"a"`
}

func getUser()  {
    var o Obj                    
    err := yml.G(&o, "user")   // 指定属于哪一个上层键
    if err != nil {
        fmt.Println(err)
    }
    fmt.Println(u)
}
```

#### 获取指定参数值
```go
// G函数实现
func getName(){
    var name string
    err := New().G(&name, "user", "name")
    if err != nil {
        fmt.Println(err)
    }
    fmt.Println(name)
}


// Value函数
func getValue() {
    i, err := yml.Value("user", "name") // 获取user->name的值，返回是一个interface{}类型
    if err != nil {
        fmt.Println(err)
    }
    fmt.Println(i.(string))             // 可以转换成指定的类型
}
```
#### github地址
[https://github.com/Liangxiaowu/go-yaml](https://github.com/Liangxiaowu/go-yaml)