Golang时间间隔格式化插件库durafmt的使用

durafmt是一个小型Go库，用于将time.Duration字符串(和类型)格式化为人类可读的格式。

安装

go get github.com/hako/durafmt

为什么需要durafmt

如果你在Go中使用过time.Duration，可能会遇到这样的输出：

53m28.587093086s // :)

上面的输出看起来很容易阅读，但如果你的持续时间是这样的：

354h22m3.24s // :S

这种情况下，durafmt就能派上用场了。

使用示例

durafmt.ParseString()

package main

import (
	"fmt"
	"github.com/hako/durafmt"
)

func main() {
	duration, err := durafmt.ParseString("354h22m3.24s")
	if err != nil {
		fmt.Println(err)
	}
	fmt.Println(duration) // 2 weeks 18 hours 22 minutes 3 seconds
	// duration.String() // String representation. "2 weeks 18 hours 22 minutes 3 seconds"
}

durafmt.ParseStringShort()

durafmt.ParseStringShort()是durafmt.ParseString()的简化版本，只返回持续时间字符串的第一部分。

package main

import (
	"fmt"
	"github.com/hako/durafmt"
)

func main() {
	duration, err := durafmt.ParseStringShort("354h22m3.24s")
	if err != nil {
		fmt.Println(err)
	}
	fmt.Println(duration) // 2 weeks
	// duration.String() // String short representation. "2 weeks"
}

durafmt.Parse()

package main

import (
	"fmt"
	"time"
	"github.com/hako/durafmt"
)

func main() {
	timeduration := (354 * time.Hour) + (22 * time.Minute) + (3 * time.Second)
	duration := durafmt.Parse(timeduration).String()
	fmt.Println(duration) // 2 weeks 18 hours 22 minutes 3 seconds
}

LimitFirstN()

类似于durafmt.ParseStringShort()，但可以限制返回持续时间字符串的前N部分。

package main

import (
	"fmt"
	"time"
	"github.com/hako/durafmt"
)

func main() {
	timeduration := (354 * time.Hour) + (22 * time.Minute) + (3 * time.Second)
	duration := durafmt.Parse(timeduration).LimitFirstN(2) // limit first two parts.
	fmt.Println(duration) // 2 weeks 18 hours
}

自定义单位

使用durafmt.Units{}和durafmt.Durafmt.Format(units)可以用自定义单位字符串化持续时间。

package main

import (
	"fmt"
	"time"
	"github.com/hako/durafmt"
)

func main() {
	timeduration := (354 * time.Hour) + (22 * time.Minute) + (1 * time.Second) + (100*time.Microsecond)
	duration := durafmt.Parse(timeduration)
	// 使用葡萄牙语单位
	units, err := durafmt.DefaultUnitsCoder.Decode("ano,semana,dia,hora,minuto,segundo,milissegundo,microssegundo")
	if err != nil {
		panic(err)
	}
	fmt.Println(duration.Format(units)) // 2 semanas 18 horas 22 minutos 1 segundo 100 microssegundos

    // 自定义复数形式(singular:plural)
	units, err = durafmt.DefaultUnitsCoder.Decode("ano,semana:SEMANAS,dia,hora,minuto,segundo,milissegundo,microssegundo")
	if err != nil {
		panic(err)
	}
	fmt.Println(duration.Format(units)) // 2 SEMANAS 18 horas 22 minutos 1 segundo 100 microssegundos
}

贡献

欢迎贡献！Fork这个仓库，添加你的更改并提交PR。

如果你想修复bug、添加功能或提供反馈，可以在issues部分进行。

durafmt使用golangci-lint进行测试，你可以使用go test运行测试。

在贡献时，建议运行go test; go vet; golint或golangci-lint。

许可证

MIT