[Golang] apifaker 开发记

最近在准备毕业设计,虽然为 Android 项目,但还是需要一些后端支持,所以我就想能不能有一种方便的方式开发后端 api 的方式。

在之前 Rails 开发中,养成的了“急躁”的好习惯,转到 Go 后,明显感觉思维的转变,Go 的思维方式相对 Rails 来说,更注重正交性,清晰度,KISS。

所以开发之前,我明确了这个项目的定位:

  1. 能快速开启一个符合 Restful 原则的 api 服务器。
  2. 实现 http.Helper 接口,能组合别的路由,保证扩展性。
  3. 用 json 文件,不用数据库,降低复杂度,能回写到文件,保证数据一致性。
  4. 能实现简单的数据验证。

然后,决定了主要的 struct ApiFaker 的主要成员变量及其对外接口:

type ApiFaker struct {
     // 匿名组合,使用 Engine 的路由
    *gin.Engine

     // json api 文件目录
    ApiDir string

    // 内部路由
    Routers []*Router

    // 外部路由
    TrueMux http.Handler

    // 内部路由的前缀
    Prefix string
}

// 创建新的 ApiFaker
func NewWithApiDir(dir string) (*ApiFaker, error)

// 设置 ApiFaker 前缀并组合其外部路由
func (af *ApiFaker) MountTo(path string, handler http.Handler)

// 将运行事的数据回写到 json 文件中
func (af *ApiFaker) SaveToFile()

// 实现 http.Handler 接口
func (af *ApiFaker) ServeHTTP(rw http.ResponseWriter, req *http.Request)

这一步,非常重要,因为它关系到整个项目的走向,正所谓,选择比努力重要。然而,大部分项目都不能在一开始就确定所有变量和方法,然后不再改变,所以我们的设计标准就是KISS,从最核心的功能出发,逐步迭代。

接下来要设计的就是 Router 及其包含的最复杂的 Model:

  1. 一个 Rouer 应该包含一个资源,可等同于数据库中的 table, 及其一系列 restful 的 path。
  2. 资源对应的就是 Model,它应该:
    1. 记录资源的每一个 table 的 column
    2. 基本的 CRUD
    3. 由于还要回写到 json 文件,所以应该有一个标示记录数据是否改变
    4. 需要对应 json 文件的结构,和运行时数据的容器
type Router struct {
    Model  *Model
    Routes []Route
    filePath string
}
type Model struct {
    Name string
    Seeds   []map[string]interface{}
    Columns []*Column                
    Set *gset.SetThreadSafe
    dataChanged bool
    sync.Mutex
}

这里用到的我之前的实现的一个集合 gset

到这里,我们已经设计好项目的边界,和主要的数据结构,当然还有一些细节没有设计,比如,RouteColmun 还有运行时的数据管理。 然而只要方向确定,内部不断迭代,一定能到达一个稳定的水平。

由于我 Go 开发经验和设计能力有限,还请高手可以指点。

源码:github.com/Focinfi/apifaker

服务器设计文章:许式伟:服务端开发那些事儿

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容