雪花分形,一次从前到后的尝试

2017-03-07 jude 更多博文 » 博客 » GitHub »

原文链接 http://judes.me/tech/2017/03/07/snow_flake_app.html
注:以下为加速网络访问所做的原文缓存,经过重新格式化,可能存在格式方面的问题,或偶有遗漏信息,请以原文为准。


缘起

很久之前,我写下一篇介绍“雪花分形”写作理论的文章。我觉得可以做一个让人方便地用上这个理论写作的工具,甚至一度幻想着可以靠它提供的服务来赚点钱。

选型

我打算先做一个原型。原型的话,网页最容易做。在技术选型时原本可以抓起身边的 Bootstrap 和 jQuery 撸起袖子就是干的,但我不想依靠思维惯性写代码,这样很没意思。

刚好听说 vue 出 2.0 ,要不试着用一用?将来也好说自己用过 vue 2.0 嘛 =w= 于是,开始一边看着文档,一边敲代码,开启了踩坑之旅。

顺带说一句,在工作中,这样的选型思路非常危险哦,除非是玩票项目且完全不在乎成败,又想任性一把

踩坑

  • 模块化

雪花分形有十一个步骤,大体分为两条线:剧情和人物。随着步骤的进展,剧情和人物都在之前步骤的基础上逐渐清晰丰满。

因此可以用两大类组件来展示这些步骤。

刚开始用字符串拼接的形式写组件 templatehtml ,拼接了十几行,相当痛苦。

我觉得 vue 文档里的一个坑就是在介绍组件时没同时展示一种很方便的模板语法。文档中一个例子:

Vue.component('my-component', {
  template: '<div>A custom component!</div>'
  // 这里的 template 很简单,如果 template 是一大堆的 html ,写起来很累,读起来也很累
})

我用字符串拼接的形式写了两个组件的 html 之后,太难受,终于忍不住要找点别的写法。虽然 es6 的语法能解决问题,但最理想的是 vue 原生支持的语法。找了一会儿还真找到了:

<!--把模板用 `type` 是 `text/x-template` 的 script 标签包着 -->
<script type="text/x-template" id="component-id">
  <div>A custom component!</div>
</script>

<script>
  Vue.component('my-component', {
    template: '#component-id'
  })
</script>
  • 驼峰与烤串

在书写组合词时,不同语言有各自约定俗成的习惯,因此有不同的写法,如“组件ID”这个词,在 html/css 中,会写成 component-id (kebab-case/烤串形),在 javascript 中,会写成 componentId (camelCase/驼峰形),在 ruby 中,会写成 component_id (snake_case/蛇形)。原本这些只是约定,就算不遵守也不会出问题,但在使用 vue 时,不遵守就会出问题。比如把“组件ID”这个词一律写成 componentId ,程序不会正常运行,但也不报错。这是个大坑。

避开这个坑的要点是,时刻注意代码身处的语境,在 html/css 语境中用 kebab-case ,在 javascript 语境中就用 camelCase 。举文档中的例子说明语境问题:

<script>
Vue.component('child', {
  // myMessage 在 JavaScript 中,所以用 camelCase
  props: ['myMessage'],
  template: '<span>{{ myMessage }}</span>'
}) 
</script>

<div>
  <input v-model="parentMsg">
  <br>
  <!-- my-message 在 HTML 中,用 kebab-case  -->
  <!-- parentMsg 在 JavaScript 中,用 camelCase  -->
  <child :my-message="parentMsg"></child>
</div>

事件绑定、触发也是类似的写法,但是有一个例外:

<div id="app">
  <!-- select-item 在 HTML 中,用 kebab-case  -->
  <!-- alertItem 在 HTML 中,用 camelCase  -->
  <list :list="list" @select-item="alertItem"></list>
</div>

<script type="text/x-template" id="list">
  <ul>
      <!-- 例外!! select-item 在 JavaScript 中,但在 $emit 时,要跟在上面声明时的保持一样  -->
    <li
      v-for="(item, index) in list"
      @click="$emit('select-item', item)"
    >{{ item }}</li>
  </ul>
</script>

<script>
  Vue.component('list', {
    props: ['list'],
    template: '#list'
  })
  new Vue({
    el: '#app',
    data: {
      list: [1,2,3,4]
    },
    methods: {
      // alertItem 在 HTML 中,用 camelCase
      alertItem: function(item){
        window.alert(item);
      }
    }
  })
</script>

使用 vue 时,要经常切换语境,所以很容易搞错。我在写这个应用时,偷了个懒,既不用驼峰,也不用烤串,更不用蛇形,组合词一律小写,比如: togglemenu 。工作中千万别这样写。

加个后台吧

前台页面很快就写好。用到不少 vue 的功能,挺有满足感的。果然编程知识还是动手学得快。

满足感很快就退却,忽然想到一个问题,这东西没后台,用户一关闭页面,写下的内容不就什么都没有了吗?缺少保存功能,明显违背了做这个应用的初衷啊。这个功能必须有。

我有阿里云主机资源,也会 Rails ,但要做这个保存功能,就得做一整套的用户系统:注册、验证、登录、保持会话、注销、忘记密码、重置密码等等。一套功能做下来工作量不少;如果只是个原型的话,可不可以直接调用现成的服务呢?

记得有个叫“后台即服务”(BaaS)的概念,基于这个概念的产品,有 google 的 Firebase ,国内也有个 leancloud 。

能不能用呢?出于好奇,我注册了个 leancloud 账号,看到它还真有用户系统,而且开发版应用每天有几千次免费的接口调用次数,够用了。

凭借 leancloud 我很快写好了用户注册、登录、保存、退出的功能。不得不说,在原型开发时借助“后台即服务”真会大大提高效率。

贴个成品网址: snow flake

后记

在快写好这个应用时,不小心把 leancloud 应用的 key/secrect 上传到 github 了。在此之前自己还很有信心不会出这种差错,而把 key/secrect 跟主程序放到一起呢。事实证明,程序员的信心真是不靠谱啊~