TypeScript入门
TypeScript简介
TypeScript 是一种由微软开发的自由和开源的编程语言。它是 JavaScript 的一个超集,而且本质上向这个语言添加了可选的静态类型和基于类的面向对象编程。
TypeScript 扩展了 JavaScript 的语法,所以任何现有的 JavaScript 程序可以不加改变的在 TypeScript 下工作。TypeScript 是为大型应用之开发而设计,而编译时它产生 JavaScript 以确保兼容性。
TypeScript与JavaScript对比
- JavaScript 代码可以在无需任何修改的情况下与 TypeScript 一同工作,同时可以使用编译器将 TypeScript 代码转换为 JavaScript
- TypeScript 通过类型注解提供编译时的静态类型检查。(变量类型判断, interface之类的)
- TypeScript 中的数据要求带有明确的类型,JavaScript不要求。
- TypeScript 为函数提供了缺省参数值。
TypeScript文件
在本地可以创建.ts文件,使用tsc name.ts命令编译当前的.ts文件,观察编译后的结果,比较ts和js文件
ts文件
function greet(person: string) {
return "Hello, " + person;
}
interface Person {
name: string;
age: number;
isStudent: boolean;
}
function greeter(person: Person) {
return `我叫${person.name},今年${person.age}岁,是否为学生:${person.isStudent}`;
}
function hanldeHello() {
var user = "Jane User";
console.log('greet(user)', greet(user))
var person = {
name: '张三',
age: 13,
isStudent: true
}
console.log('greeter(person)', greeter(person))
}
编译后的js文件
function greet(person) {
return "Hello, " + person;
}
function greeter(person) {
return "\u6211\u53EB" + person.name + ",\u4ECA\u5E74" + person.age + "\u5C81\uFF0C\u662F\u5426\u4E3A\u5B66\u751F\uFF1A" + person.isStudent;
}
function hanldeHello() {
var user = "Jane User";
console.log('greet(user)', greet(user));
var person = {
name: '张三',
age: 13,
isStudent: true
};
console.log('greeter(person)', greeter(person));
}
TypeScript项目生成
以react项目为例,正常使用脚手架创建项目时使用create-react-app projectName,只需要在后面加入--typescript即可。
create-react-app projectName --typescript
项目构建成功后,查看根目录,有【tsconfig.json】文件,即证明,当前ts项目构建成功。
目前大部分项目已经使用js进行开发,不是所有项目都可以使用重建项目命令完成,下面另一个指令,教大家怎么将已有的js项目替换为ts项目
npm install --save typescript @types/node @types/react @types/react-dom @types/jest
或者
yarn add typescript @types/node @types/react @types/react-dom @types/jest
使用上述指令会下载typescript包,将项目转变为ts项目,下载后,首次不会出现【tsconfig.json】文件,但不要着急,当运行项目时,他会有一个提示,告诉你即将生成【tsconfig.json】文件,项目启动后,可在根目录下发现【tsconfig.json】文件。或者使用tsc --init ,ps:记得要带‘--’否则是不起作用的哈
ps:更换js项目为ts项目的伙伴要注意啦,记得要将所有jsx文件->tsx文件,
js文件->ts文件哦~
tsconfig.json文件解析与编译配置
tsconfig.json的作用,主要有以下几点
- 用于标识 TypeScript 项目的根路径
- 用于配置 TypeScript 编译器
- 用于指定编译的文件
重要字段
- files - 设置要编译的文件的名称
- include - 设置需要进行编译的文件,支持路径模式匹配
- exclude - 设置无需进行编译的文件,支持路径模式匹配
- compilerOptions - 设置与编译流程相关的选项
- compileOnSave
注意事项
- tsconfig.json可以为空,那么所有默认的文件都会以默认配置选项编译
- 如果"files"和"include"都没有被指定,编译器默认包含当前目录和子目录下所有的TypeScript文件(.ts, .d.ts 和 .tsx),排除在"exclude"里指定的文件。
- 使用"include"引入的文件可以使用"exclude"属性过滤。 然而,通过 "files"属性明确指定的文件却总是会被包含在内,不管"exclude"如何设置,优先级为:
files > exclude > include - 任何被"files"或"include"指定的文件所引用的文件也会被包含进来。 A.ts引用了B.ts,因此B.ts不能被排除,除非引用它的A.ts在"exclude"列表中。
- 如不设定 files 和 include,ts 默认是 exclude 以外的所有的以 .ts 和 .tsx 结尾的文件。如果,同时设置 files 的优先级最高,exclude 次之,include 最低。
此次会重点说一下compilerOptions,编译相关的字段,TypeScript具有一个调整它的严格性的刻度盘,你可以将指针拔动到你想要的位置。严格程度取决于compilerOptions设置的严谨程度
- files : 表示编译需要编译的单个文件列表
"files": [
// 指定编译文件是src目录下的a.ts文件
"scr/a.ts"
]
- include: 表示编译需要编译的文件或目录
"include": [
// "scr" // 会编译src目录下的所有文件,包括子目录
// "scr/*" // 只会编译scr一级目录下的文件
"scr/*/*" // 只会编译scr二级目录下的文件
]
- exclude:表示编译器需要排除的文件或文件夹
"exclude": [
// 排除src目录下的lib文件夹下的文件不会编译
"src/lib"
"node_modules",
"build",
]
- compileOnSave:设置保存文件的时候自动编译(vscode暂不支持该功能,可以使用'Atom'编辑器或Visual Studio)
"compileOnSave": true
- compilerOptions:配置编译选项
以下为脚手架生成的项目tsconfig文件的默认配置(跳转到项目中具体解释)
{
"compilerOptions": {
"target": "es5",
"lib": [
"dom",
"dom.iterable",
"esnext"
],
"allowJs": true,
"skipLibCheck": true,
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"strict": true,
"forceConsistentCasingInFileNames": true,
"module": "esnext",
"moduleResolution": "node",
"resolveJsonModule": true,
"isolatedModules": true,
"noEmit": true,
"jsx": "react"
},
"include": [
"src"
]
}
由于编译的配置有很多,这里列一下他的常用配置,仅供参考
"compilerOptions": {
"incremental": true, // TS编译器在第一次编译之后会生成一个存储编译信息的文件,第二次编译会在第一次的基础上进行增量编译,可以提高编译的速度
"tsBuildInfoFile": "./buildFile", // 增量编译文件的存储位置
"diagnostics": true, // 打印诊断信息
"target": "ES5", // 目标语言的版本
"module": "CommonJS", // 生成代码的模板标准
"outFile": "./app.js", // 将多个相互依赖的文件生成一个文件,可以用在AMD模块中,即开启时应设置"module": "AMD",
"lib": ["DOM", "ES2015", "ScriptHost", "ES2019.Array"], // TS需要引用的库,即声明文件,es5 默认引用dom、es5、scripthost,如需要使用es的高级版本特性,通常都需要配置,如es8的数组新特性需要引入"ES2019.Array",
"allowJS": true, // 允许编译器编译JS,JSX文件
"checkJs": true, // 允许在JS文件中报错,通常与allowJS一起使用
"outDir": "./dist", // 指定输出目录
"rootDir": "./", // 指定输出文件目录(用于输出),用于控制输出目录结构
"declaration": true, // 生成声明文件,开启后会自动生成声明文件
"declarationDir": "./file", // 指定生成声明文件存放目录
"emitDeclarationOnly": true, // 只生成声明文件,而不会生成js文件
"sourceMap": true, // 生成目标文件的sourceMap文件
"inlineSourceMap": true, // 生成目标文件的inline SourceMap,inline SourceMap会包含在生成的js文件中
"declarationMap": true, // 为声明文件生成sourceMap
"typeRoots": [], // 声明文件目录,默认时node_modules/@types
"types": [], // 加载的声明文件包
"removeComments":true, // 删除注释
"noEmit": true, // 不输出文件,即编译后不会生成任何js文件
"noEmitOnError": true, // 发送错误时不输出任何文件
"noEmitHelpers": true, // 不生成helper函数,减小体积,需要额外安装,常配合importHelpers一起使用
"importHelpers": true, // 通过tslib引入helper函数,文件必须是模块
"downlevelIteration": true, // 降级遍历器实现,如果目标源是es3/5,那么遍历器会有降级的实现
"strict": true, // 开启所有严格的类型检查
"alwaysStrict": true, // 在代码中注入'use strict'
"noImplicitAny": true, // 不允许隐式的any类型
"strictNullChecks": true, // 不允许把null、undefined赋值给其他类型的变量
"strictFunctionTypes": true, // 不允许函数参数双向协变
"strictPropertyInitialization": true, // 类的实例属性必须初始化
"strictBindCallApply": true, // 严格的bind/call/apply检查
"noImplicitThis": true, // 不允许this有隐式的any类型
"noUnusedLocals": true, // 检查只声明、未使用的局部变量(只提示不报错)
"noUnusedParameters": true, // 检查未使用的函数参数(只提示不报错)
"noFallthroughCasesInSwitch": true, // 防止switch语句贯穿(即如果没有break语句后面不会执行)
"noImplicitReturns": true, //每个分支都会有返回值
"esModuleInterop": true, // 允许export=导出,由import from 导入
"allowUmdGlobalAccess": true, // 允许在模块中全局变量的方式访问umd模块
"moduleResolution": "node", // 模块解析策略,ts默认用node的解析策略,即相对的方式导入
"baseUrl": "./", // 解析非相对模块的基地址,默认是当前目录
"paths": { // 路径映射,相对于baseUrl
// 如使用jq时不想使用默认版本,而需要手动指定版本,可进行如下配置
"jquery": ["node_modules/jquery/dist/jquery.min.js"]
},
"rootDirs": ["src","out"], // 将多个目录放在一个虚拟目录下,用于运行时,即编译后引入文件的位置可能发生变化,这也设置可以虚拟src和out在同一个目录下,不用再去改变路径也不会报错
"listEmittedFiles": true, // 打印输出文件
"listFiles": true// 打印编译的文件(包括引用的声明文件)
}