编译期类型检查 in ClojureScript

简介: 话说"动态类型一时爽,代码重构火葬场",虽然有很多不同的意见(请参考),但我们看到势头强劲的TypeScript和Flow.js,也能感知到静态类型在某程度上能帮助我们写出更健壮的代码(当然要基于充分的单元测试上啦)。

前言

 话说"动态类型一时爽,代码重构火葬场",虽然有很多不同的意见(请参考),但我们看到势头强劲的TypeScript和Flow.js,也能感知到静态类型在某程度上能帮助我们写出更健壮的代码(当然要基于充分的单元测试上啦)。
 ClojureScript与JavaScript一样采取动态类型,但由于需要通过Google Closure Compiler编译后才能运行,因此我们可以如同JS那样借助GCC的注解来引入编译时类型检查,达到同样静态类型的效果。

配置项目设置

GCC的编译时类型检查仅当optimizationssimpleadvanced时有效。我们以:cljsbuild下的dev配置为例

:cljsbuild 
  {:builds
   [{:id "dev"
     :main type-check.core
     :output-to "resouces/public/js/type_check.js"
     :optimizations :simple
     :source-map "resources/public/js/type_check.js.map"
     :closure-warnings            ;; 设置GCC编译时类型检查
       {:check-types :warning     ;; 务必设置为warning
        :undefined-names :off     ;; 屏蔽goog库的异常信息
        :externs-validation :off  ;; 屏蔽goog库的异常信息
        :missing-properties :off  ;; 屏蔽goog库的异常信息
        }}]}

请注意,:check-types必须设置为:warning,若设置为:error时,就会报Math.imul引发的JSC_DUP_VAR_DECLARATION_TYPE_MISMATCH异常,导致项目其他代码均不能被编译。希望大神指点迷津~~

注解语法

首先GCC用到的注解语法仅为JSDoc的子集,所以直接看GCC的注解即可,而ClojureScript一般就用如下几个

@private {Type}
标识私有成员,且该成员的数据类型

@type {Type}
标识成员的数据类型

@param {Type} varname Description
标识函数的型参的数据类型,参数名和描述

@return {Type} Description
标识函数返回值的数据类型和描述

@throws {Type}
标识函数可能抛出异常类型

接下来就是重点了,我们写了这么多还不就是想引入数据的类型描述吗?那关键就是上述代码中Type到底应该怎么写了!
1.标量类型number,string,boolean,null,undefined
注意
一、标量类型默认表示变量或参数的实际值为不可为null(non-nullable)。若要标识为可为null(nullable),那么只需前置一个问号?即可(?number,?string
2.对象类型Object,Function,Number,String,Boolean,Date和其他Cljs或自定义的对象类型。
注意
一、对于非全限定的对象类型,会自动展开为当前命名空间的类型(如当前命名空间为my-proj.core,那么MyArray会展开为my-proj.core/MyArray
二、对象类型默认表示变量或参数的实际值可为null(nullable)。若要标识为不可为null(non-nullable),那么只需前置一个感叹号!即可(如!Object,!Date等)
3.组合类型,如(number|string),即是实际值可为数字也可为字符串。
4.集合/字典,Array<Type>表示为数组类型且其元素类型可以继续递归下去,Object<Type>表示为对象类型且键类型为Type,Object<Type1,Type2表示为对象类型且键类型为Type1而值类型为Type2
5.函数类型
function(Type1,Type2),表示函数含数据类型为Type1和Type2两个形参。
function(Type1,Type2):Type3,表示函数含数据类型为Type1和Type2两个形参,且返回值类型为Type3。
function(...Type),表示函数含数据类型为Type的可变形参,注意可变形参必须作为最后一个形参出现。
function(Type=),表示函数含可选的数据类型为Type的形参,注意可选形参后不能声明必填的形参。
注意注意!

  1. 形参和逗号间千万不要留空格,否则编译时会报警告的哦!
  2. Type为function()时不能在声明返回值类型,否则编译时辉报警告!
@param {function(*,function(*):number)} 是不允许的
@param {function(*,function(*))}        只能这样写啦

6.什么类型都可以,*

实例

1.封装chrome.runtime.onMessage玩玩

(defn on-msg
  "@param {function(*,window.MessageSend,function(*))} handler
   @return {null}"
  [handler]
  (let [this (.. js/chrome -runtime -onMessage)]
    (.addListener this
                  (fn [a b c]
                    (handler a b c)
                    true))))

注意:window.MessageSend既不是GCC内置的类型也不是我们自定义类型,而是外部定义的数据类型,因此我们需要添加externs文件让GCC识别。
因此得到的配置如下

:cljsbuild
  {:builds
   [{:id "dev"
     :main type-check.core
     :output-to "resouces/public/js/type_check.js"
     :optimizations :simple
     :source-map "resources/public/js/type_check.js.map"
     :externs ["externs/chrome.js" "externs/chrome_extensions.js"]
     :closure-warnings            ;; 设置GCC编译时类型检查
       {:check-types :warning     ;; 务必设置为warning
        :undefined-names :off     ;; 屏蔽goog库的异常信息
        :externs-validation :off  ;; 屏蔽goog库的异常信息
        :missing-properties :off  ;; 屏蔽goog库的异常信息
        }}]}

总结

如官网所讲,这部分的内容仍在发展阶段,所以还有很多不完善的地方。不过也不影响我们现在就开始使用,因此良好的代码注释从来都需要的!
尊重原创,转载请注明来自:http://www.cnblogs.com/fsjohnhuang/p/7625414.html ^_^肥仔John

参考

https://clojurescript.org/reference/compile-time-type-checking
https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler
https://github.com/google/closure-compiler/wiki/Types-in-the-Closure-Type-System
https://github.com/google/closure-compiler/wiki/Warnings

目录
相关文章
|
Dubbo Java 应用服务中间件
从源码全面解析 dubbo 服务端服务调用的来龙去脉
从源码全面解析 dubbo 服务端服务调用的来龙去脉
|
存储 Linux 应用服务中间件
基于CentOS 7.6的Docker新手教学
采用本地虚拟机+阿里云镜像加速器
1394 5
基于CentOS 7.6的Docker新手教学
|
5月前
|
数据采集 数据可视化 大数据
Python入门修炼:开启你在大数据世界的第一个脚本
Python入门修炼:开启你在大数据世界的第一个脚本
135 6
|
7月前
|
人工智能 关系型数据库 分布式数据库
PolarDB 开源基础教程系列 7.4 应用实践之 AI大模型外脑
PolarDB向量数据库插件通过实现通义大模型AI的外脑,解决了通用大模型无法触达私有知识库和产生幻觉的问题。该插件允许用户将新发现的知识和未训练的私有知识分段并转换为向量,存储在向量数据库中,并创建索引以加速相似搜索。当用户提问时,系统将问题向量化并与数据库中的向量进行匹配,找到最相似的内容发送给大模型,从而提高回答的准确性和相关性。此外,PolarDB支持多种编程语言接口,如Python,使数据库具备内置AI能力,极大提升了数据处理和分析的效率。
301 4
|
8月前
|
数据采集 缓存 API
python爬取Boss直聘,分析北京招聘市场
本文介绍了如何使用Python爬虫技术从Boss直聘平台上获取深圳地区的招聘数据,并进行数据分析,以帮助求职者更好地了解市场动态和职位需求。
|
9月前
|
SQL 人工智能 自然语言处理
PolarDB-PG AI最佳实践 1:基础能力实践
Polar_AI 是 PolarDB 数据库的 AI 扩展,集成了先进的人工智能模型和算法,使数据库能够执行机器学习和自然语言处理任务。它支持 PostgreSQL 及 Oracle 兼容版本,通过标准 SQL 轻松调用 AI 模型,具备简单易用、灵活可定制、无缝数据融合、数据安全和高性能等优势。用户可以通过 SQL 快速实现文本转向量、情感分类等功能,并能自定义扩展 AI 模型。
|
11月前
|
运维 网络协议 安全
HCIP-Datacom H12-821 题库 (34)
HCIP-Datacom H12-821 题库 (34)
113 0
 HCIP-Datacom H12-821 题库 (34)
|
机器学习/深度学习 存储 计算机视觉
基于YOLOv8深度学习的脑肿瘤智能检测系统【python源码+Pyqt5界面+数据集+训练代码】深度学习实战、目标检测、智慧医疗(1)
基于YOLOv8深度学习的脑肿瘤智能检测系统【python源码+Pyqt5界面+数据集+训练代码】深度学习实战、目标检测、智慧医疗
|
Java API Maven
如何定位、解决maven依赖冲突问题
如何定位、解决maven依赖冲突问题
600 0
如何定位、解决maven依赖冲突问题
|
域名解析 缓存 网络协议
阿里云DNS常见问题之新购域名阿里云DNS无法解析如何解决
阿里云DNS(Domain Name System)服务是一个高可用和可扩展的云端DNS服务,用于将域名转换为IP地址,从而让用户能够通过域名访问云端资源。以下是一些关于阿里云DNS服务的常见问题合集: