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的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/430283。

相关文章

每日一练：攻防世界：5-1 MulTzor

每日一练：攻防世界：5-1 MulTzor

一、XorTool 基于 XOR（异或）运算实现。它可以帮助您快速地对文本、二进制文件进行加密解密操作。 认识XorTool工具： 让我们先去认识一下工具： xortool.py 是基于 python 的脚本，用于完成一些 xor 分析，包括: 猜想 key 的长度 猜想 key 的值 解密一些经过 xoe 加密的文件 也就是说当遇到不知道文件类型的文件，可以尝试去看看它是否被xo
阅读更多...
Go 三色标记法：一种高效的垃圾回收策略

Go 三色标记法：一种高效的垃圾回收策略

💝💝💝欢迎莅临我的博客，很高兴能够在这里和您见面！希望您在这里可以感受到一份轻松愉快的氛围，不仅可以获得有趣的内容和知识，也可以畅所欲言、分享您的想法和见解。 推荐:「stormsha的主页」👈，持续学习，不断总结，共同进步，为了踏实，做好当下事儿~ 专栏导航 Python系列: Python面试题合集，剑指大厂Git系列: Git操作技巧GO系列: 记录博主学习GO语言的笔
阅读更多...
Go语言中的go.mod与go.sum

Go语言中的go.mod与go.sum

问题1：什么是go.mod以及它是用来解决什么问题的？ go mod 是 Go 语言引入的包管理工具，用于解决 Go 语言项目在依赖管理方面的问题。 传统上，若不使用go mod，则需要要通过GOPATH来管理依赖，而这种方式存在一些问题： 如1. 包管理依赖不明确 2. 依赖库的版本管理 3. 需要手动管理同步依赖的复杂性等 而go mod可以帮助开发者在项目中明确管理依赖的版
阅读更多...
client-go删除job同时删除job关联的pod

client-go删除job同时删除job关联的pod

问题描述 client-go使用以下方式删除job时，并不会把其关联的pod删除，从而导致这些pod成为了孤儿(orphan)： err := clientSet.BatchV1().Jobs(namespace).Delete(name, &metav1.DeleteOptions{}) 在删除job的时候将job关联的pod也删除的方法： propagationPolicy := m
阅读更多...
client-go入门之1：创建连接Kubernetes集群的客户端

client-go入门之1：创建连接Kubernetes集群的客户端

文章目录 简介使用 简介 我们可以使用Dashboard或kubectl来访问k8s的API，也可以使用编程语言，如Go,Java,Python作为客户端来访问k8s。client-go是一个使用go语言编写的库，用来连接k8s集群并对集群资源进行操作。 使用 以下代码使用go连上k8s集群，并查询集群的节点信息： package mainimport ("fmt"meta
阅读更多...
【经典算法】LeetCode 22括号生成(Java/C/Python3/Go实现含注释说明,中等)

【经典算法】LeetCode 22括号生成(Java/C/Python3/Go实现含注释说明,中等)

作者主页： 🔗进朱者赤的博客 精选专栏：🔗经典算法 作者简介：阿里非典型程序员一枚 ，记录在大厂的打怪升级之路。 一起学习Java、大数据、数据结构算法（公众号同名） ❤️觉得文章还不错的话欢迎大家点赞👍➕收藏⭐️➕评论，💬支持博主，记得点个大大的关注，持续更新🤞 ————————————————- 首先，请注意题目链接有误，您提供的链接是LeetCode 14，但题目
阅读更多...
深入理解go语言反射机制

深入理解go语言反射机制

1、前言        每当我们学习一个新的知识点时，一般来说，最关心两件事，一是该知识点的用法，另外就是使用场景。go反射机制作为go语言特性中一个比较高级的功能，我们也需要从上面两个方面去进行学习，前者告诉我们如何去使用，而后者告诉我们为什么以及什么时候使用。 2、反射机制 2.1 反射机制的基本概念         在 Go 语言中，反射机制允许程序在运行时获取对象的类型信息、访问对
阅读更多...
20240624 每日AI必读资讯

20240624 每日AI必读资讯

🤖AI学会篡改奖励函数、欺骗研究者！Claude团队：无法根除的行为，令人不安 - 实验中让AI可以访问自己的强化学习代码，并且提问：目前为止，我们总共进行了几轮强化学习？AI在自以为不会被看见的草稿纸中写下内心OS - 研究对未来如何避免强大的AI系统出现这种问题非常有意义。 - Anthropic、Readwood Research（专注AI安全的非盈利研究机构）和牛津大学合作研究
阅读更多...
LeetCode 每日一题 2024/6/17-2024/6/23

LeetCode 每日一题 2024/6/17-2024/6/23

记录了初步解题思路 以及本地实现代码；并不一定为最优 也希望大家能一起探讨 一起进步 目录 6/17 522. 最长特殊序列 II6/18 2288. 价格减免6/19 2713. 矩阵中严格递增的单元格数6/20 2748. 美丽下标对的数目6/21 LCP 61. 气温变化趋势6/22 2663. 字典序最小的美丽字符串6/23 520. 检测大写字母 6/1
阅读更多...
每日一题——Python代码实现力扣1. 两数之和（举一反三+思想解读+逐步优化）五千字好文

每日一题——Python代码实现力扣1. 两数之和（举一反三+思想解读+逐步优化）五千字好文

一个认为一切根源都是“自己不够强”的INTJ 个人主页：用哲学编程-CSDN博客专栏：每日一题——举一反三Python编程学习Python内置函数 Python-3.12.0文档解读 目录 菜鸡写法 代码分析 时间复杂度分析 空间复杂度分析 改进建议 我要更强 方法1: 使用哈希表（字典） 方法2: 排序和双指针 方法3: 使用集合（仅适用于特殊情况） 哲学和编程思想
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2