Crystal 分享一个极简 API 框架——Runcobo

ThxFly · 2020年09月24日 · 最后由 itomato 回复于 2020年10月20日 · 3286 次阅读

开发背景

Crystal 目前最火的有三个框架

Kemal: Sinatra on Crystal
Amber: Rails on Crystal
Lucky：Crystal 活跃程度最高的一门框架，开发思想为“更少的 bug”

我试用了以上三种，分享些个人的感受：

Kemal 用来做些小项目可以，但商用的话太难，毕竟 Sinatra 的底子给了它一个黑暗的未来；
Amber 用起来行云流水，模仿 Rails 的确很像，应该能吸引一票的 Rails 程序员。但除了 Laravel，其他语言模仿 Rails 的都哑火了，也许是因为 Rails 太过优秀，导致模仿者难以超越前作；
Lucky 更多是面向 Web 开发，这个框架提出的概念有些多。作为前后端分离的践行者，个人更想要一款面向 API 开发的微框架，去掉那些涉及网页开发的概念。

对以上框架不太满意，而这时公司又有 KPI 指标，于是乎我散失了几个周末不打机的美好时光，开发了以公司名字"云康宝"命名的Runcobo 框架.

如果你听过买过或用过云康宝体脂秤与共享秤，那你已自动成为本框架的终身 VIP 用户

第一段代码

require "runcobo"

class HelloWorld < BaseAction
  get "/hello_world"

  call do
    render_plain "Hello World"
  end
end

Runcobo.start

先引入库，然后定义一个 Action，在 Action 中声明接口路径，声明需要渲染”Hello World“，最后启动服务器。

乍一看没啥亮眼的，比不上 Sinatra 的三行情书短小精悍。

但故事才刚刚开始......

控制器

为了避免单个控制器代码过多，采用一个动作一个类的方式（赤裸裸抄袭前文提到的 Lucky 框架）
本着微框架的初心，路由不应该单独定义在一个文件里，故路由作为声明语句，写在对应的动作中
本着约定大于配置的准则，与最少惊讶原则，这里只约定了视图所在的目录"src/views/", 布局所在的目录"src/views/layouts/"
参数先声明，后使用，使用简单且类型安全
支持过滤器
支持多种响应格式，纯文本、HTML 与 JSON
渲染 json 视图采用 jbuilder，Rails 自带的 JSON 引擎，Runcobo 也将它带来了。

稍复杂的代码

class Books::Index < BaseAction
  get "/books"
  query NamedTuple(author: String)
  call do
    books = Book.where(author: params[:author])
    render_jbuilder "books/index"
  end
end

json.array! "books", books do |json, book|
  json.book_id      book.id
  json.author       book.author
  json.name         book.name
  json.published_at book.published_at
end

参数设计

作为一门编译语言搭建的 API 框架，理应参数类型安全。Runcobo 采用参数声明的方式来进行参数解析，从而保证类型安全。与 Kemal、Amber、Lucky 相比，自认为 Runcobo 的参数设计还是比较漂亮的。

URL 类型安全

url NamedTuple(a: String, b: Int32?, c: Bool)

查询参数类型安全

query NamedTuple(a: String, b: Int32?, c: Bool)

表单参数类型安全

form NamedTuple(a: String, b: Int32?, c: Bool)

JSON 参数类型安全

json NamedTuple(a: String, b: Int32?, c: Bool, d: NamedTuple(a: String, b: Int32), e: Array(Int32))

调用方式

params[:a] + params[:b].to_s + params[:d][:a]

如你所见，参数支持嵌套对象、嵌套数组、支持可空，使用上也与 Rails 的参数大致相同，最大的不同便是编译期便确定了参数的类型。Runcobo 采用了宏魔法，使得参数在控制器的展现形式为命名元祖的形式，声明采用命名元组，使用的也是命名元组。（注：命名元组是一种固定大小，不可变的，已知键名及其类型、已知值类型的键值对）