1# ArkTS语法适配背景
2
3ArkTS在保持TypeScript(简称TS)基本语法风格的基础上,进一步通过规范强化静态检查和分析,使得在程序开发期能检测更多错误,提升程序稳定性,并实现更好的运行性能。本文将进一步解释为什么建议将TS代码适配为ArkTS代码。
4
5## 程序稳定性
6
7动态类型语言,例如JavaScript(简称JS),可以使得开发者非常快速地编写代码,但是同时,它也使得程序容易在运行时产生非预期的错误。例如在代码中,如果开发者没有检查一个值是否为`undefined`,那么程序有可能在运行时崩溃,给开发者造成不便。如果能在代码开发阶段检查此类问题是更有好处的。TS通过标注类型帮助开发者检查错误,许多错误在编译时可以被编译器检测出来,不用等到程序运行时。但是,即使是TS也有局限性,它不强制要求对变量进行类型标注,导致很多编译时检查无法开展。ArkTS尝试克服这些缺点,它强制使用静态类型,旨在通过更严格的类型检查以减少运行时错误。
8
9下面这个例子展示了ArkTS通过强制严格的类型检查来提高代码稳定性和正确性。
10
11
12**显式初始化类的属性**
13
14ArkTS要求类的所有属性在声明时或者在构造函数中显式地初始化,这和TS中的`strictPropertyInitialization`检查一致。以下的代码片段是非严格模式下的TS代码。
15
16```typescript
17class Person {
18  name: string // undefined
19
20  setName(n: string): void {
21    this.name = n
22  }
23
24  getName(): string {
25  // 开发者使用"string"作为返回类型,这隐藏了name可能为"undefined"的事实。
26  // 更合适的做法是将返回类型标注为"string | undefined",以告诉开发者这个API所有可能的返回值的类型。
27    return this.name
28  }
29}
30
31let buddy = new Person()
32// 假设代码中没有对name的赋值,例如没有调用"buddy.setName('John')"
33buddy.getName().length; // 运行时异常:name is undefined
34```
35
36由于ArkTS要求属性显式初始化,代码应该像下面这样写。
37
38```typescript
39class Person {
40  name: string = ''
41
42  setName(n: string): void {
43    this.name = n
44  }
45
46  // 类型为"string",不可能为"null"或者"undefined"
47  getName(): string {
48    return this.name
49  }
50}
51
52let buddy = new Person()
53// 假设代码中没有对name的赋值,例如没有调用"buddy.setName('John')"
54buddy.getName().length; // 0, 没有运行时异常
55```
56
57如果`name`可以是`undefined`,那么它的类型应该在代码中被精确地标注。
58
59```typescript
60class Person {
61    name?: string // 可能为undefined
62
63    setName(n: string): void {
64        this.name = n
65    }
66
67    // 编译时错误:name可能为"undefined",所以不能将这个API的返回类型标注为"string"
68    getNameWrong(): string {
69        return this.name
70    }
71
72    getName(): string | undefined { // 返回类型匹配name的类型
73        return this.name
74    }
75}
76
77let buddy = new Person()
78// 假设代码中没有对name的赋值,例如没有调用"buddy.setName('John')"
79
80// 编译时错误:编译器认为下一行代码有可能访问"undefined"的属性,报错
81buddy.getName().length;  // 编译失败
82
83buddy.getName()?.length; // 编译成功,没有运行时错误
84```
85
86## 程序性能
87
88为了保证程序的正确性,动态类型语言不得不在运行时检查对象的类型。例如,JS不允许访问`undefined`的属性。但是检查一个值是否为`undefined`的唯一的办法是在运行时进行一次类型检查。所有的JS引擎都会做如下的事:如果一个值不是`undefined`,那么可以访问其属性,否则抛出异常。现代JS引擎可以很好地对这类操作进行优化,但是总有一些运行时的检查是无法被消除的,这就使得程序变慢了。由于TS总是先被编译成JS,所以在TS代码中,也会面临相同的问题。ArkTS解决了这个问题。由于使能了静态类型检查,ArkTS代码将会被编译成方舟字节码文件,而不是JS代码。因此,ArkTS运行速度更快,更容易被进一步地优化。
89
90
91**Null Safety**
92
93```typescript
94function notify(who: string, what: string) {
95  console.log(`Dear ${who}, a message for you: ${what}`)
96}
97
98notify('Jack', 'You look great today')
99```
100
101在大多数情况下,函数`notify`会接受两个`string`类型的变量作为输入,产生一个新的字符串。但是,如果将一些特殊值作为输入,例如`notify(null, undefined)`,情况会怎么样呢?
102程序仍会正常运行,输出预期值:`Dear null, a message for you: undefined`。一切看起来正常,但是请注意,为了保证该场景下程序的正确性,引擎总是在运行时进行类型检查,执行类似以下的伪代码。
103
104```typescript
105function __internal_tostring(s: any): string {
106  if (typeof s === 'string')
107    return s
108  if (s === undefined)
109    return 'undefined'
110  if (s === null)
111    return 'null'
112  // ...
113}
114```
115
116现在想象一下,如果函数`notify`是某些复杂的负载场景中的一部分,而不仅仅是打印日志,那么在运行时执行像`__internal_tostring`的类型检查将会是一个性能问题。
117
118如果可以保证在运行时,只有`string`类型的值(不会是其他值,例如`null`或者`undefined`)可以被传入函数`notify`呢?在这种情况下,因为可以确保没有其他边界情况,像`__internal_tostring`的检查就是多余的了。对于这个场景,这样的机制叫做“null-safety”,也就是说,保证`null`不是一个合法的`string`类型变量的值。如果ArkTS有了这个特性,类型不符合的代码将无法编译。
119
120```typescript
121function notify(who: string, what: string) {
122  console.log(`Dear ${who}, a message for you: ${what}`)
123}
124
125notify('Jack', 'You look great today')
126notify(null, undefined) // 编译时错误
127```
128
129TS通过打开编译选项`strictNullChecks`来实现此特性。但是TS是被编译成JS的,而JS没有这个特性,因此严格`null`检查只在编译时起作用。从程序稳定性和性能角度考虑,ArkTS将“null-safety”视为一个重要的特性。这就是为什么ArkTS强制进行严格`null`检查,在ArkTS中,上面的代码总是编译报错。作为交换,这样的代码可以给ArkTS引擎带来更多的信息和有关值的类型保证,这有助于更好地优化性能。
130
131
132## .ets代码兼容性
133
134在API version 10之前,ArkTS(.ets文件)完全采用了标准TS的语法。从API version 10 Release起,ArkTS的语法规则基于上述设计考虑进行了明确定义,同时,SDK增加了在编译流程中对.ets文件的ArkTS语法检查,通过编译告警或编译失败提示开发者适配新的ArkTS语法。
135
136根据工程的compatibleSdkVersion,具体策略如下:
137
138  - compatibleSdkVersion >= 10 为标准模式。在该模式下,对.ets文件,违反ArkTS语法规则的代码会导致工程编译失败,需要完全适配ArkTS语法后方可编译成功。
139  - compatibleSdkVersion < 10 为兼容模式。在该模式下,对.ets文件,以warning形式提示违反ArkTS语法规则的所有代码。尽管违反ArkTS语法规则的工程在兼容模式下仍可编译成功,但是需要完全适配ArkTS语法后方可在标准模式下编译成功。
140
141## 支持与TS/JS的交互
142
143ArkTS支持与TS/JS的高效互操作,在当前版本上,ArkTS运行时兼容动态类型对象语义。在与TS/JS交互的场景下,将TS/JS的数据和对象在ArkTS中当作ArkTS的数据和对象使用时,可能会绕过ArkTS的静态编译检查,造成非预期的行为或引入额外的开销。
144
145```typescript
146// lib.ts
147export class C {
148  v: string
149}
150
151export let c = new C()
152
153// app.ets
154import { C, c } from './lib'
155
156function foo(c: C) {
157  c.v.length
158}
159
160foo(c)  //  运行时异常:v is undefined
161```
162
163## 方舟运行时兼容TS/JS
164
165在API version 11上,OpenHarmony SDK中的TypeScript版本为4.9.5,target字段为es2017。在应用中,开发者可以使用ECMA2017+的语法进行TS/JS开发。
166
167**应用环境限制**
168
1691. 强制使用严格模式(use strict)
1702. 禁止使用`eval()`
1713. 禁止使用`with() {}`
1724. 禁止以字符串为代码创建函数
173
174**与标准TS/JS的差异**
175
176标准TS/JS中,JSON的数字格式,小数点后必须跟着数字,如`2.e3`这类科学计数法不被允许,报出`SyntaxError`。在方舟运行时中,允许使用这类科学计数法。
177