Go 每日一库之 bubbletea

2023-11-28 21:20
文章标签 go 每日 一库 bubbletea

本文主要是介绍Go 每日一库之 bubbletea，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

简介

bubbletea是一个简单、小巧、可以非常方便地用来编写 TUI（terminal User Interface，控制台界面程序）程序的框架。内置简单的事件处理机制，可以对外部事件做出响应，如键盘按键。一起来看下吧。先看看bubbletea能做出什么效果：

感谢kiyonlin推荐。

快速使用

本文代码使用 Go Modules。

创建目录并初始化：

$ mkdir bubbletea && cd bubbletea
$ go mod init github.com/darjun/go-daily-lib/bubbletea

安装bubbletea库：

$ go get -u github.com/charmbracelet/bubbletea

bubbletea程序都需要有一个实现bubbletea.Model接口的类型：

type Model interface {Init() CmdUpdate(Msg) (Model, Cmd)View() string
}

  • Init()方法在程序启动时会立刻调用，它会做一些初始化工作，并返回一个Cmd告诉bubbletea要执行什么命令；

  • Update()方法用来响应外部事件，返回一个修改后的模型，和想要bubbletea执行的命令；

  • View()方法用于返回在控制台上显示的文本字符串。

下面我们来实现一个 Todo List。首先定义模型：

type model struct {todos    []stringcursor   intselected map[int]struct{}
}

  • todos：所有待完成事项；

  • cursor：界面上光标位置；

  • selected：已完成标识。

不需要任何初始化工作，实现一个空的Init()方法，并返回nil：

import (tea "github.com/charmbracelet/bubbletea"
)
func (m model) Init() tea.Cmd {return nil
}

我们需要响应按键事件，实现Update()方法。按键事件发生时会以相应的tea.Msg为参数调用Update()方法。通过对参数tea.Msg进行类型断言，我们可以对不同的事件进行对应的处理：

func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {switch msg := msg.(type) {case tea.KeyMsg:switch msg.String() {case "ctrl+c", "q":return m, tea.Quitcase "up", "k":if m.cursor > 0 {m.cursor--}case "down", "j":if m.cursor < len(m.todos)-1 {m.cursor++}case "enter", " ":_, ok := m.selected[m.cursor]if ok {delete(m.selected, m.cursor)} else {m.selected[m.cursor] = struct{}{}}}}return m, nil
}

约定：

  • ctrl+c或q：退出程序；

  • up或k：向上移动光标；

  • down或j：向下移动光标；

  • enter或：切换光标处事项的完成状态。

处理ctrl+c或q按键时，返回一个特殊的tea.Quit，通知bubbletea需要退出程序。

最后实现View()方法，这个方法返回的字符串就是最终显示在控制台上的文本。我们可以按照自己想要的形式，根据模型数据拼装：

func (m model) View() string {s := "todo list:\n\n"for i, choice := range m.todos {cursor := " "if m.cursor == i {cursor = ">"}checked := " "if _, ok := m.selected[i]; ok {checked = "x"}s += fmt.Sprintf("%s [%s] %s\n", cursor, checked, choice)}s += "\nPress q to quit.\n"return s
}

光标所在位置用>标识，已完成的事项增加x标识。

模型类型定义好了之后，需要创建一个该模型的对象；

var initModel = model{todos:    []string{"cleanning", "wash clothes", "write a blog"},selected: make(map[int]struct{}),
}

为了让程序工作，我们还要创建一个bubbletea的应用对象，通过bubbletea.NewProgram()完成，然后调用这个对象的Start()方法开始执行：

func main() {cmd := tea.NewProgram(initModel)if err := cmd.Start(); err != nil {fmt.Println("start failed:", err)os.Exit(1)}
}

运行：

GitHub Trending

一个简单的 Todo 应用看起来好像没什么意思。接下来，我们一起编写一个拉取 GitHub Trending 仓库并显示在控制台的程序。

Github Trending 的界面如下：

可以选择语言（Spoken Language，本地语言）、语言（Language，编程语言）和时间范围（Today，This week，This month）。由于 GitHub 没有提供 trending 的官方 API，我们只能爬取网页自己来分析。好在 Go 有一个强大的分析工具goquery，提供了堪比 jQuery 的强大功能。我之前也写过一篇文章介绍它——Go 每日一库之 goquery。

打开 Chrome 控制台，点击 Elements 页签，查看每个条目的结构：

基础版本

定义模型：

type model struct {repos []*Repoerr   error
}

其中repos字段表示拉取到的 Trending 仓库列表，结构体Repo如下，字段含义都有注释，很清晰了：

type Repo struct {Name    string   // 仓库名Author  string   // 作者名Link    string   // 链接Desc    string   // 描述Lang    string   // 语言Stars   int      // 星数Forks   int      // fork 数Add     int      // 周期内新增BuiltBy []string // 贡献值 avatar img 链接
}

err字段表示拉取失败设置的错误值。为了让程序启动时，就去执行网络请求拉取 Trending 的列表，我们让模型的Init()方法返回一个tea.Cmd类型的值：

func (m model) Init() tea.Cmd {return fetchTrending
}func fetchTrending() tea.Msg {repos, err := getTrending("", "daily")if err != nil {return errMsg{err}}return repos
}

tea.Cmd类型为：

// src/github.com/charmbracelet/bubbletea/tea.go
type Cmd func() Msg

tea.Cmd底层是一个函数类型，函数无参数，并且返回一个tea.Msg对象。

fetchTrending()函数拉取 GitHub 的今日 Trending 列表，如果遇到错误，则返回error值。这里我们暂时忽略getTrending()函数的实现，这个与我们要说的重点关系不大，感兴趣的童鞋可以去我的 GitHub 仓库查看详细代码。

程序启动时如果需要做一些操作，通常就会在Init()方法中返回一个tea.Cmd。tea后台会执行这个函数，最终将返回的tea.Msg传给模型的Update()方法。

func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {switch msg := msg.(type) {case tea.KeyMsg:switch msg.String() {case "q", "ctrl+c", "esc":return m, tea.Quitdefault:return m, nil}case errMsg:m.err = msgreturn m, nilcase []*Repo:m.repos = msgreturn m, nildefault:return m, nil}
}

Update()方法也比较简单，首先还是需要监听按键事件，我们约定按下 q 或 ctrl+c 或 esc 退出程序。具体按键对应的字符串表示可以查看文档或源码bubbletea/key.go文件。接收到errMsg类型的消息，表示网络请求失败了，记录错误值。接收到[]*Repo类型的消息，表示正确返回的 Trending 仓库列表，记录下来。在View()函数中，我们显示正在拉取，拉取失败和正确拉取等信息：

func (m model) View() string {var s stringif m.err != nil {s = fmt.Sprintf("Fetch trending failed: %v", m.err)} else if len(m.repos) > 0 {for _, repo := range m.repos {s += repoText(repo)}s += "--------------------------------------"} else {s = " Fetching GitHub trending ..."}s += "\n\n"s += "Press q or ctrl + c or esc to exit..."return s + "\n"
}

逻辑很清晰，如果err字段不为nil表示失败，否则有仓库数据，显示仓库信息。否则正在拉取中。最后显示一条提示信息，告诉客户怎么退出程序。

每个仓库项的显示逻辑如下，分为 3 列，基础信息、描述和链接：

func repoText(repo *Repo) string {s := "--------------------------------------\n"s += fmt.Sprintf(`Repo:  %s | Language:  %s | Stars:  %d | Forks:  %d | Stars today:  %d
`, repo.Name, repo.Lang, repo.Stars, repo.Forks, repo.Add)s += fmt.Sprintf("Desc:  %s\n", repo.Desc)s += fmt.Sprintf("Link:  %s\n", repo.Link)return s
}

运行（多文件运行不能用go run main.go）：

获取失败（国内 GitHub 不稳定，多试几次总会遇到????）：

获取成功：

让界面更美观

黑白色我们已经看了太多太多了，能不能让字体呈现不同的颜色呢？当然可以。bubbletea可以利用lipgloss库给文本添加各种颜色，我们定义了 4 种颜色，颜色的 RBG 值是我在http://tool.chinaz.com/tools/pagecolor.aspx挑的：

var (cyan  = lipgloss.NewStyle().Foreground(lipgloss.Color("#00FFFF"))green = lipgloss.NewStyle().Foreground(lipgloss.Color("#32CD32"))gray  = lipgloss.NewStyle().Foreground(lipgloss.Color("#696969"))gold  = lipgloss.NewStyle().Foreground(lipgloss.Color("#B8860B"))
)

想要将文本变为什么颜色，只需要调用对应颜色对象的Render()方法将文本传入即可。例如我们想让提示变为暗灰色，中间文字使用暗黄色，修改View()方法：

func (m model) View() string {var s stringif m.err != nil {s = gold.Render(fmt.Sprintf("fetch trending failed: %v", m.err))} else if len(m.repos) > 0 {for _, repo := range m.repos {s += repoText(repo)}s += cyan.Render("--------------------------------------")} else {s = gold.Render(" Fetching GitHub trending ...")}s += "\n\n"s += gray.Render("Press q or ctrl + c or esc to exit...")return s + "\n"
}

然后仓库的基本信息我们用青色（cyan），描述用绿色，链接用暗灰色：

func repoText(repo *Repo) string {s := cyan.Render("--------------------------------------") + "\n"s += fmt.Sprintf(`Repo:  %s | Language:  %s | Stars:  %s | Forks:  %s | Stars today:  %s
`, cyan.Render(repo.Name), cyan.Render(repo.Lang), cyan.Render(strconv.Itoa(repo.Stars)),cyan.Render(strconv.Itoa(repo.Forks)), cyan.Render(strconv.Itoa(repo.Add)))s += fmt.Sprintf("Desc:  %s\n", green.Render(repo.Desc))s += fmt.Sprintf("Link:  %s\n", gray.Render(repo.Link))return s
}

再次运行：

成功：

嗯，现在好看多了。

我没有偷懒

有时候网络很慢，加上一个请求正在处理的提示能让我们更放心（程序还在跑，没偷懒）。bubbletea的兄弟仓库bubbles提供了一个叫做spinner的组件，它只是显示一些字符，一直在变化，给我们造成一种任务正在处理中的感觉。spinner在github.com/charmbracelet/bubbles/spinner包中，需要先引入。然后在模型中增加spinner.Model字段：

type model struct {repos   []*Repoerr     errorspinner spinner.Model
}

创建模型时，同时需要初始化spinner.Model对象，我们指定spinner的文本颜色为紫色：

var purple = lipgloss.NewStyle().Foreground(lipgloss.Color("#800080"))func newModel() model {sp := spinner.NewModel()sp.Style = purplereturn model{spinner: sp,}
}

spinner通过Tick来触发其改变状态，所以需要在Init()方法中返回触发Tick的Cmd。但是又需要返回fetchTrending。bubbletea提供了Batch可以将两个Cmd合并在一起返回：

func (m model) Init() tea.Cmd {return tea.Batch(spinner.Tick,fetchTrending,)
}

然后Update()方法中我们需要更新spinner。Init()方法返回的spinner.Tick会产生spinner.TickMsg，我们对其做处理：

case spinner.TickMsg:var cmd tea.Cmdm.spinner, cmd = m.spinner.Update(msg)return m, cmd

spinner.Update(msg)返回一个tea.Cmd对象驱动下一次Tick。

最后在View()方法中，我们将spinner显示出来。调用其View()方法返回当前状态的字符串，拼在我们想要显示的位置：

func (m model) View() string {var s stringif m.err != nil {s = gold.Render(fmt.Sprintf("fetch trending failed: %v", m.err))} else if len(m.repos) > 0 {for _, repo := range m.repos {s += repoText(repo)}s += cyan.Render("--------------------------------------")} else {// 这里s = m.spinner.View() + gold.Render(" Fetching GitHub trending ...")}s += "\n\n"s += gray.Render("Press q or ctrl + c or esc to exit...")return s + "\n"
}

运行：

分页

由于一次返回了很多 GitHub 仓库，我们想对其进行分页显示，每页显示 5 条，可以按pageup和pagedown翻页。首先在模型中增加两个字段，当前页和总页数：

const (CountPerPage = 5
)type model struct {// ...curPage   inttotalPage int
}

拉取到仓库时，计算总页数：

case []*Repo:m.repos = msgm.totalPage = (len(msg) + CountPerPage - 1) / CountPerPagereturn m, nil

另外需要监听翻页按键：

case "pgdown":if m.curPage < m.totalPage-1 {m.curPage++}return m, nil
case "pgup":if m.curPage > 0 {m.curPage--}return m, nil

在View()方法中，我们根据当前页计算需要显示哪些仓库：

start, end := m.curPage*CountPerPage, (m.curPage+1)*CountPerPage
if end > len(m.repos) {end = len(m.repos)
}for _, repo := range m.repos[start:end] {s += repoText(repo)
}
s += cyan.Render("--------------------------------------")

最后，如果总页数大于 1，给出翻页按键的提示：

if m.totalPage > 1 {s += gray.Render("Pagedown to next page, pageup to prev page.")s += "\n"
}

运行：

很棒，我们只显示了 5 页。试试翻页吧：

总结

bubbletea提供了一个 TUI 程序运行的基本框架。我们要显示什么，显示的样式，要对哪些事件进行处理都由我们自己指定。bubbletea仓库的examples文件夹中有多个示例程序，对编写 TUI 程序感兴趣的童鞋千万不能错过。另外它的兄弟仓库bubbles中也提供了不少组件。

大家如果发现好玩、好用的 Go 语言库，欢迎到 Go 每日一库 GitHub 上提交 issue????

参考

  1. bubbletea GitHub：https://github.com/charmbracelet/bubbletea

  2. bubble GitHub：https://github.com/charmbracelet/bubbles

  3. Go 每日一库 GitHub：https://github.com/darjun/go-daily-lib

  4. issue：https://github.com/darjun/go-daily-lib/issues/22

我

我的博客：https://darjun.github.io

欢迎关注我的微信公众号【GoUpUp】，共同学习，一起进步~

这篇关于Go 每日一库之 bubbletea的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！

原文地址:https://blog.csdn.net/darjun/article/details/117970918
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.chinasem.cn/article/430283。

相关文章

go中的时间处理过程

go中的时间处理过程

《go中的时间处理过程》：本文主要介绍go中的时间处理过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1 获取当前时间2 获取当前时间戳3 获取当前时间的字符串格式4 相互转化4.1 时间戳转时间字符串 (int64 > string)4.2 时间字符串转时间
阅读更多...
Go语言中make和new的区别及说明

Go语言中make和new的区别及说明

《Go语言中make和new的区别及说明》：本文主要介绍Go语言中make和new的区别及说明,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1 概述2 new 函数2.1 功能2.2 语法2.3 初始化案例3 make 函数3.1 功能3.2 语法3.3 初始化
阅读更多...
Go语言中nil判断的注意事项(最新推荐)

Go语言中nil判断的注意事项(最新推荐)

《Go语言中nil判断的注意事项(最新推荐)》本文给大家介绍Go语言中nil判断的注意事项,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录1.接口变量的特殊行为2.nil的合法类型3.nil值的实用行为4.自定义类型与nil5.反射判断nil6.函数返回的
阅读更多...
Go语言数据库编程GORM 的基本使用详解

Go语言数据库编程GORM 的基本使用详解

《Go语言数据库编程GORM的基本使用详解》GORM是Go语言流行的ORM框架,封装database/sql,支持自动迁移、关联、事务等,提供CRUD、条件查询、钩子函数、日志等功能,简化数据库操作... 目录一、安装与初始化1. 安装 GORM 及数据库驱动2. 建立数据库连接二、定义模型结构体三、自动迁
阅读更多...
Go语言代码格式化的技巧分享

Go语言代码格式化的技巧分享

《Go语言代码格式化的技巧分享》在Go语言的开发过程中,代码格式化是一个看似细微却至关重要的环节,良好的代码格式化不仅能提升代码的可读性,还能促进团队协作,减少因代码风格差异引发的问题,Go在代码格式... 目录一、Go 语言代码格式化的重要性二、Go 语言代码格式化工具：gofmt 与 go fmt（一）
阅读更多...
Go学习记录之runtime包深入解析

Go学习记录之runtime包深入解析

《Go学习记录之runtime包深入解析》Go语言runtime包管理运行时环境,涵盖goroutine调度、内存分配、垃圾回收、类型信息等核心功能,：本文主要介绍Go学习记录之runtime包的... 目录前言：一、runtime包内容学习1、作用：① Goroutine和并发控制：② 垃圾回收：③ 栈和
阅读更多...
Go语言中泄漏缓冲区的问题解决

Go语言中泄漏缓冲区的问题解决

《Go语言中泄漏缓冲区的问题解决》缓冲区是一种常见的数据结构,常被用于在不同的并发单元之间传递数据,然而,若缓冲区使用不当,就可能引发泄漏缓冲区问题,本文就来介绍一下问题的解决,感兴趣的可以了解一下... 目录引言泄漏缓冲区的基本概念代码示例：泄漏缓冲区的产生项目场景：Web 服务器中的请求缓冲场景描述代码
阅读更多...
Go语言如何判断两张图片的相似度

Go语言如何判断两张图片的相似度

《Go语言如何判断两张图片的相似度》这篇文章主要为大家详细介绍了Go语言如何中实现判断两张图片的相似度的两种方法,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 在介绍技术细节前，我们先来看看图片对比在哪些场景下可以用得到：图片去重：自动删除重复图片，为存储空间"瘦身"。想象你是一个
阅读更多...
Go语言中Recover机制的使用

Go语言中Recover机制的使用

《Go语言中Recover机制的使用》Go语言的recover机制通过defer函数捕获panic,实现异常恢复与程序稳定性,具有一定的参考价值,感兴趣的可以了解一下... 目录引言Recover 的基本概念基本代码示例简单的 Recover 示例嵌套函数中的 Recover项目场景中的应用Web 服务器中
阅读更多...
Go语言中使用JWT进行身份验证的几种方式

Go语言中使用JWT进行身份验证的几种方式

《Go语言中使用JWT进行身份验证的几种方式》本文主要介绍了Go语言中使用JWT进行身份验证的几种方式,包括dgrijalva/jwt-go、golang-jwt/jwt、lestrrat-go/jw... 目录简介1. github.com/dgrijalva/jwt-go安装：使用示例：解释：2. gi
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2