gingerhot (B1nj0y)

在 Hugo 中使用 GitFx

gingerhot — Thu, 06 Jan 2022 13:47:06 +0800

文章原文：https://gitx.io/post/hugo-with-gitfx-zh_cn/

GitFx 是我写的一个可以运行多种语言的代码片段的工具。同时提供了 ActionServerless 这个 action 方便在 GitHub 的 workflow 里运行 GitFx。之所以把它命名为 ActionServerless 这样的“热词”，除了蹭热度之外，你的确可以把用它实现的程序看作是一个 async 的 Serverless 应用。

使用 GitFx/ActionServerless 可以方便快速地为开发、测试创建一个静态资源的 API 服务。而且只需要把代码推到 GitHub 上就可以使用了。

我曾经想在博客中嵌入代码，同时通过一些服务去运行该代码，然后再把结果展示到文章里。可以使用 Docker 创建类似的功能，可以达到类似 Go playground 的那种效果。但是这对于个人博客不但有服务器开销，还会有安全问题。我们现在很多技术博客都是运行在 GitHub pages 上，所以用 GitFx 就方便多了：

使用 GitFx 运行代码，把运行的输出存到一个路径
对于 Hugo 的使用者，我们提供了一个 shortcode 插件可以很方便地把插入代码、展示运行结果变成一行代码

这样你就可以轻松地写技术博客了。下面我们通过一个 Hello world 的示例看下如何使用。

Hello world 示例

在 GitHub action 中运行 GitFx

在本例我们把代码放到根目录下的 'app' 目录中。我们创建一个名为 hello.py 的源文件，写上一行简单的 print("Hello world!") 再加上一行用注释定义的存储输出的文件路径（具体写法可见下文的代码或参考 GitFx 的文档）。

然后我们需要创建一个 GitHub action workflow，其中和 GitFx 有关的部分配置如下：

...
- uses: gitx-io/ActionServerless@master
  with:
    filepath: './app'
...

完整的配置可参考这里。

在 Hugo 博客中展示代码和结果

我们提供了一个 Hugo shortcode 的插件 hugo-gitfx 来展示 hello.py 和它的运行结果。你只需要在文章需要插入代码的地方写上：

{{< gitfx "app/hello.py" >}}

然后就会有下面这样的效果：

如果你也恰好使用 Hugo 架设博客，也可以试一下哦！

TabHub：一个为持续学习者准备的浏览器插件

gingerhot — Fri, 30 Jul 2021 17:58:27 +0800

TabHub 是一个 Chrome/Edge 浏览器的扩展应用。可以用它定制你在打开新的标签页时默认显示的内容。可以是你喜欢的一幅图片，或者一门语言的单词卡片，可以是你喜欢的 RSS 源，也可以是一个你常用的网页。通过我们额外提供的编辑工具，你可以定制一切。

距离在谷歌扩展程序商店上架这个插件已经过去两年多了，一直感觉功能不是特别完善。但是对于爱鼓捣的程序员们，这个工具目前达到可用。发出来供有需要的同学把玩：）

比如用它看 Hacker News 感觉还不错：

记单词也行：

读 Ruby weekly：

已知缺点：图片等资源放在 GitHub 上，国内不翻墙会有影响

更多介绍看这里：https://tabhub.github.io/README_zh.html

命令行工具：在浏览器预览 Markdown 文档

gingerhot — Tue, 12 Jun 2018 18:30:40 +0800

先贴下 GitHub 地址：https://github.com/beijingrb/mdopen

简介

mdopen 是一个命令行工具，用来在浏览器中预览 Markdown 文档。如果你习惯使用 Markdown 编辑器编辑文档，那你可能不大需要这个工具。

该命令行更适合那些喜欢用 vim 等在终端窗口写 Markdown 文档的人。比如在项目下写 README 的时候。

其实之前有想写个这样的工具自用，后来发现已经有人用 Go 写了一个，预览页面使用 GitHub 的风格。用起来很好用，于是就想着移植到 Ruby，这样对于那些没有安装 Go 环境的 Rubyists 也能用啦。

安装

gem install mdopen

用法

mdopen <markdown_file_path>

如果没有给参数，或者给定的文件不存在，则会读取当前目录下的 README 或者 README.md 文件。如果你在项目目录下想预览 README 文档，直接运行 mdopen 即可。

使用 Ruby FFI 调用 Go 函数：十倍效率提升

gingerhot — Fri, 19 Jan 2018 16:28:26 +0800

注：本文根据几篇网文和 GitHub 资源综合编译，链接在文末给出。

本文主要介绍：

如何使用 Go 编写和生成共享库（shared library）
然后如何使用 Ruby FFI 对这些共享库进行调用

环境要求

Ruby 环境，本文使用 2.3.4p301
Golang 版本最低 1.5 或以上，本文使用 go1.9.2 darwin/amd64

什么是共享库

共享库和静态库都属于库文件，可以理解为编译好的程序，但是自己没有执行入口，供其它程序调用来执行。

可参考：http://tldp.org/HOWTO/Program-Library-HOWTO/shared-libraries.html

先比较一下 fibonacci 计算的执行速度

作为类型语言的 Go 对于 Ruby 的优势更多的在 CPU 密集计算方面，所以我们先来比较一下 Ruby 和 Go 实现的 fibonacci 函数的效率。为了简化比较的考虑，我们采用同样的算法。

# fib.ruby
def fib(n)
  return n if n <= 1
  fib(n - 1) + fib(n - 2)
end

puts fib(40)

// fib.go
package main

import "fmt"

func fib(n uint) uint {
    if n <= 1 {
        return n
    }
    return fib(n-1) + fib(n-2)
}

func main() {
    fmt.Println(fib(40))
}

Ruby 的用时：

$ time ruby fib.rb
102334155

real    0m14.027s
user    0m13.827s
sys 0m0.067s

直接运行 go run 执行的用时：

$ time go run fib.go
102334155

real    0m1.691s
user    0m0.957s
sys 0m0.362s

可以看到 Go 编译 + 运行的时间也要 10 倍于 Ruby 的速度。下面是直接执行 Go 二进制程序的速度（直接执行使用 go build fib.go 编译生成的 fib 二进制文件，相比 go run 省去了编译时间）：

$ time ./fib
102334155

real    0m0.753s
user    0m0.741s
sys 0m0.007s

差不多是 Ruby 程序的 18 倍。可以看到执行效率的差距还是很大的。

使用 Go 编写和生成共享库

使用 Go 编写共享库和写普通的 Go 程序差别不大，主要是在代码里 import 一个名为 "C" 的伪包，然后在执行 go build 编译的时候加上 -buildmode=c-shared 参数。这样在编译的时候会自动调用 Cgo 进行相应的操作。有关 Cgo 的一些细节，可以阅读 C? Go? Cgo!。

我们先来写一下作为共享库的 fibonacci 函数：

// fib_lib.go
package main

import "C"

//export fib
func fib(n uint) uint {
    if n <= 1 {
        return n
    }
    return fib(n-1) + fib(n-2)
}

func main() {}

注：可调用的函数是通过添加注释 //export fib 来实现的，因此这行注释是必须的。

然后我们来编译生成共享库，因为我是在 macOS 上执行，macOS 和 Linux 生成的命令略有不同，分别是：

# macOS
go build -buildmode=c-shared -ldflags -s -o fib.dylib fib_lib.go

# Linux
go build -buildmode=c-shared -o fib.so fib_lib.go

从 Ruby 调用 Go 函数

我们使用 FFI 这个 gem 提供的接口来从 Ruby 调用外部函数。有关 Foreign Function Interface 和 FFI Gem 可以点击相应链接了解。我们先来安装 FFI Gem：

gem install ffi

然后我们使用 Ruby FFI 来调用我们用 Go 编写的 fib 函数：

# go-fib.rb
require "ffi"

module Fib
  extend FFI::Library
  # 下面是我在 macOS 上运行的写法，如果在 Linux 上调用的文件为 "fib.so"
  ffi_lib "fib.dylib"
  attach_function :fib, [:uint], :uint
end

puts Fib.fib(40)

这里需要关注的是 attach_function 这个函数的参数，分别是要从外部引用的 函数的名称, 该函数的参数类型的数组 以及 该函数的返回值类型。这个可以和我们写的 Go 的函数对应起来：

func fib(n uint) uint
:fib, [:uint], :uint

Ruby 的类型和外部函数的类型对照可以参考 FFI Gem 的 wiki。

运行比较

接下来我们比较一下 Ruby 原生的 fibonacci 和通过 FFI 调用 Go 共享库的运行效率：

$ time ruby fib.rb
102334155

real    0m13.673s
user    0m13.600s
sys 0m0.042s

$ time ruby go_lib.rb
102334155

real    0m0.883s
user    0m0.843s
sys 0m0.032s

可以看出差距也在 15 倍左右。

参考资源

本文主要翻译自 1，同时参考了 2，3。

勉为编译，不妥之处还请多多指教。

如何使用 Rails 集成开发 Go API

gingerhot — Fri, 29 Sep 2017 11:40:27 +0800

go-on-rails 是一个 Rails 的 generator，已经发布为 gem，用来在 Rails 项目中集成或是开发 Golang 应用。

项目地址：https://github.com/railstack/go-on-rails。

本文不会讲述详细的使用方法，所以先把现有的几个示例教程放一下：

简单示例仿照 Rails guides 里那个入门的 demo，演示如何使用 go-on-rails 创建和生成一个简单 blog 的 Go API。
高级教程如何创建一个 Golang 项目，并和 rails_admin, devise, cancancan 等集成，为 Go 项目快速增加一个管理后台。同时该项目演示了如何使用 Rails 5.1 新发布的 webpacker 工具，并利用 React 制作独立的前端界面在 Rails 中调用 Go 接口。
如何从 Go API 读取 Rails session 讲解如何在一个 go-on-rails 生成的 Go 接口中读取 Rails 的 session 做用户验证

go-on-rails 做些什么

使用 Rails 创建 model，然后 go-on-rails 根据 model 的定义生成相应 Go 的数据结构以及一些基本的 CRUD 方法、添加 validation，同时也生成了分页等方法
对以上生成的这些方法生成 godoc 文档
根据 Rails 的数据库配置，生成数据库连接配置
一些命令行工具帮助自动化常见任务，比如安装默认依赖、format 生成的文件、查看 godoc 文档等

为什么使用 go-on-rails

这个工具的目标用户首先是 Rails 开发者，想进行 Golang 的学习或者是想在 Rails 项目中集成 Go API。也就是要对 Rails 熟悉，否则可能很多人不会为了尝试这个工具来学习 Rails 的。

接下来主要说一下为什么会有这个 gem，或者说使用 Rails 开发 Go 项目真的有什么优势吗？

配置管理。比如通过在 Rails 中对数据库进行配置，生成的 Go 项目会根据 Rails 的配置生成相应环境数据库的连接配置。同样，其它的配置也可以利用 Rails 的配置来共享使用。
利用 Rails 丰富的工具链，比如用 rails db:seed 写入测试数据，利用 rails console 对数据进行测试等，以及数据库管理部分的 rails db:* 等操作。
方便对数据库进行各种 migrations 的管理，不用手写 schema，延续了 Rails 程序员开发过程中对数据库的操作习惯。
model 的定义同样会方便 Rails 开发者的习惯，go-on-rails 会对 association 和 validation 中的大部分生成操作函数。
Rails 5.1 中 webpacker 的发布，更突显了 Rails 在做“Web 集成开发环境”方面的新能力。更多前后端分离系统的出现，使在 Rails 中集成 Go API 的重复工作量大大降低，只需要修改一下调用的链接可能就完成了一次系统改造。另外，使用 webpacker 可以很方便的制作前端页面来调用 Go API。关于如何使用可以看这里的教程。
对于某些中小规模的系统，通过在 Rails 中集成 Go API 可以改善一些接口的性能，而不需要对系统架构进行重构。

go-on-rails 目前还在开发过程中，欢迎各种参与和 pr。

【UPDATE】本项目无意间获得了 matz 的转推加持：https://twitter.com/yukihiro_matz/status/1031768139858501632