Flow(一)—— JavaScript静态类型检查器

目录

  • Flow概述
  • Flow VS. TypeScript
  • Flow安装
  • Flow使用
      1. 在文件开头要使用注释
      1. 在代码中使用类型注解
      1. 在package.json中添加,
      1. 初始化flow
      1. 执行flow命令进行检查
      1. 关闭flow命令
  • Flow编译
      1. 官网提供flow-remove-types
      • npm环境
      • yarn环境
      1. Babel
  • Flow开发工具插件
    • VSCode —— Flow Language Support(Flow 官方提供的)
    • 其他的编辑器可以登录网站搜索
  • Flow语法使用

Flow概述

w3cschool-flow官方参考文档

FlowJavaScript的静态类型检查器,是通过静态类型推断实现类型检查的。是2014年由FaceBook推出的一款工具,使用它就可以弥补JavaScript弱类型带来的一些弊端。可以说它为JavaScript提供了更完善的类型系统。在ReactVue的项目中,都看到Flow的使用。

JavaScript本身是动态类型检查的语言,代码在执行的过程中检查类型是否正确,C#Java都是静态类型检查,在代码编译的时候检查类型是否正确。使用flow就可以让JavaScript有像C#Java一样的开发体验。

通过在代码中添加注解的方式,标记每个变量或者参数是什么类型的,然后Flow根据这些注解就可以检查代码异常,从而实现在开发阶段类型异常的检查。

  • 参数的冒号称为类型注解,在发布的时候会通过Babel将注解消除,所以生产环境不会产生影响。
  • 不要求所有的变量和参数都加注解,不加的为any类型。
function sum (a: number, b: number) {
    return n * n
}

sum(100, 50)
sum('100', 50) // 可以检测异常

Flow VS. TypeScript

FlowTypeScript都是静态类型检查器,TypeScript的功能更加强大,但他们都是JavaScript的超集,基于JavaScript,最终都要编译成JS运行。一般大型项目都需要静态类型检查来确保代码的可维护性和可读性,Vue2.0的源码引入了flowflow可以让代码在最小改动的情况下使用动态类型检查,而在Vue3.0中已经使用TypeScript开发了。

Flow安装

npm flow-bin

npm init -y

npm i flow-bin --dev

可以在node_modules.bin目录中看到flow,我们可以在命令行中执行flow,作用就是项目中检查代码中类型异常。

image

Flow使用

1. 在文件开头要使用注释

@flow的标记,这样flow才会检查这个文件。

2. 在代码中使用类型注解

image

PS: 这里看到VSCode中会有js的语法校验,需要手动关闭

设置 -> javascript valida -> 关闭JavaScript验证

2. 在package.json中添加,

"scripts": {
    "flow": "flow"
}

如果是yarn直接运行yarn flow即可,也可以不设置scripts直接npx flow运行

3. 初始化flow

运行下面的语句,会再同级目录下生成一个.flowconfig的配置文件

npm run flow init

# > TypeScript@1.0.0 flow E:\professer\TypeScript
# > flow "init"

4. 执行flow命令进行检查

npm run flow

# > TypeScript@1.0.0 flow E:\professer\TypeScript
# > flow

# Launching Flow server for E:\professer\TypeScript
# Spawned flow server (pid=5816)
# Logs will go to C:\Users\AppData\Local\Temp\flow\EzCzBprofesserzBlagouzBTypeScript.log
# Monitor logs will go to C:\Users\AppData\Local\Temp\flow\EzCzBprofesserzBlagouzBTypeScript.monitor_logNo errors!

5. 关闭flow命令

npm run flow stop

# > TypeScript@1.0.0 flow E:\professer\TypeScript
# > flow "stop"

# Trying to connect to server for `E:\professer\TypeScript`
# Told server for `E:\professer\TypeScript` to die. Waiting for confirmation...
# Successfully killed server for `E:\professer\TypeScript`

Flow编译

因为flow的类型注解不是javascript的标准语法,所以不能直接运行。我们需要将代码转换成浏览器可以执行的原始的JavaScript语言运行。所以我们可以在完成编码过后,移除掉我们添加的注解。

1. 官网提供flow-remove-types

npm flow-remove-types

npm环境

  1. 安装
npm i flow-remove-types --dev
  1. package.json中修改配置
# 把src目录下的编译之后转到dist目录下
"scripts": {
    "flow": "flow",
    "flowRemove": "flow-remove-types src/ -d dist/"
}
  1. 运行
npm run flowRemove

可以看到在dist目录下有了编译之后的js文件

yarn环境

  1. 安装
yarn add flow-remove-types
  1. 运行
# 第一个是指定目录,-d 之后是输出目录
yarn flow-remove-types src -d dist/

2. Babel

1) 安装

yarn环境

# @babel/cli我们可以直接使用babel命令完成编译
# @babel/perset-flow包含了我们转换flow类型检查的插件
yarn add @babel/core @babel/cli @babel/perset-flow

npm环境

npm i @babel/core @babel/cli @babel/perset-flow --dev

2) 添加配置文件

同级目录添加.babelrc文件,添加配置

{
  "presets": ["@babel/preset-flow"]
}

3) 使用

yarn环境

yarn babel src -d dist

npm环境

package.json中添加

"scripts": {
    "babel": "babel src/ -d dist/"
}

运行babel

npm run babel

Flow开发工具插件

异常不在终端显示,开发工具中直接显示。

VSCode —— Flow Language Support(Flow 官方提供的)

image

可以在代码中直接看到并修改

image

其他的编辑器可以登录网站搜索

flow-editors

Flow语法使用

Flow(二)—— 语法使用

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

推荐阅读更多精彩内容