jiangbo91@huawei.com

local_storage开发文档
Signed-off-by: Njiangbo <jiangbo91@huawei.com>
Change-Id: Ida21baf79df8a22765005143536fb1fa7d490128

zh-cn/application-dev/ui/ui-ts-local_storage.md

+# **LocalStorage**
 
+  说明：该功能从API version 9开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
 
+LocalStorage是应用程序中的存储单元，是为应用程序范围内的可变状态属性和非可变状态属性提供存储，可变状态属性和非可变状态属性是构建应用程序UI的特定部分。如一个Ability的UI。
 
+应用层：一个应用程序可以创建多个LocalStorage实例，应用程序的每一个Ability对应一个LocalStorage实例。
 
-# **LocalStorage**
+Ability：一个Ability中@Entry的所有子代@Component中，最多可以分配一个LocalStorage实例。另外Ability中的所有子组件都将继承对此存储对象的访问权。（一个应用程序可拥有多个Ability）
 
-LocalStorage和AppStorage类似，都是为应用程序范围内的可变状态属性和非可变状态属性提供存储，可变状态属性和非可变状态属性是构建应用程序UI的特定部分（如一个Ability的UI）。
+一个@Component最多可以访问一个LocalStorage实例，一个LocalStorage对象可以分配给多个@Component。
 
-### 特点：
+LocalStorage的生命周期跟随其关联的Ability。
 
-一个应用程序可以创建多个LocalStorage实例，应用程序的每一个Ability对应一个LocalStorage实例。
+## @LocalStorageLink装饰器
 
-在有@Entry的所有子代@Component中，最多可以分配一个LocalStorage实例。另外它的所有子组件都将继承对此存储对象的访问权。
+组件通过使用@LocalStorageLink(key)装饰的状态变量（key值为LocalStorage中的属性键值），与LocalStorage建立双向数据绑定，当创建包含@LocalStorageLink的状态变量的组件时，该状态变量的值将会使用LocalStorage中的值进行初始化。（如果LocalStorage中未定义初始值，将使用@LocalStorageLink定义的初始值）。在UI组件中对@LocalStorageLink的状态变量所做的更改将同步到LocalStorage中，并从LocalStorage同步到Ability下的组件中。
 
-一个@Component最多可以访问一个LocalStorage实例，一个LocalStorage对象可以分配给多个@Component。
+## @LocalStorageProp装饰器
 
-LocalStorage的生命周期一般是跟随其关联的Ability。
+组件通过使用LocalStorageProp(key)装饰的状态变量（key值为LocalStorage中的属性键值），与LocalStorage建立单向数据绑定，当创建包含@LocalStorageProp的状态变量的组件时，该状态变量的值将使用LocalStorage中的值进行初始化。LocalStorage中的属性值的更改会导致当前Ability下的所有UI组件进行状态更新。
 
-LocalStorage定义时没有给定默认值时，那么可以使用组件内@LocalStorageLink和@LocalStorageProp的默认值，如果定义时给定了默认值，那么不会再使用@LocalStorageLink和@LocalStorageProp的默认值。
+  注意：LocalStorage定义时没有给定默认值时，那么可以使用组件内@LocalStorageLink和@LocalStorageProp的默认值，如果定义时给定了默认值，那么不会再使用@LocalStorageLink和@LocalStorageProp的默认值。
 
-### LocalStorage接口：
+## LocalStorage接口：
 
-| 方法        | 参数                            | 返回值                                | 定义                                                         |
-| ----------- | ------------------------------- | ------------------------------------- | ------------------------------------------------------------ |
-| constructor | obj? : Object                   | N/A                                   | 创建一个新的LocalStorage对象。（可选）使用给定对象进行初始化。object.keys(obj)返回的所有对象属性及其值都将添加到LocalStorage. |
-| has         | key : String                    | boolean                               | 返回具有给定名称的属性的true存在于LocalStorage中。           |
-| get         | key : String                    | T or undefined                        | 获取具有给定名称的属性。(如果存在)                           |
-| set         | key : String , newValue : T     | boolean                               | 如果存在具有给定名称的属性，请设置其值并返回true。否则不要设置任何内容并返回false |
-| setOrCreate | key : String , newValue？ : T   | boolean                               | 如果存在具有给定名称的属性：更新其值并返回true。如果不存在具有给定名称的属性：在LocalStorage中创建具有给定默认值的新属性。默认值必须是T类型。不允许undefined or null 返回true。 |
-| link        | key ：String                    | ObservedPropertyAbstract \| undefined | 如果存在具有给定键的属性，返回对此属性的双向数据绑定。值更改将从using变量或者组件同步到LocalStorage，并从LocalStorage实例同步到任何变量或组件。如果不存在具有此键的属性，返回undefined，该函数具有其他可选属性，这些参数当前保留在框架内部使用的link/linkAndSet |
-| setAndLink  | key : String , defaultValue : T | ObservedPropertyAbstract              | 如果存在具有给定键的属性，请确定为Link定义的返回值。如果属性不存在，请使用给定的默认类型和值defaultValue创建属性（参考setOrCrtare）,并返回该属性的值（参考link）。默认值必须为T类型。 |
-| prop        | key：String                     | ObservedPropertyAbstract              | 如果存在具有给定键的属性，则返回对此属性的单向数据绑定，表示值更改将从LocalStorage同步到任何变量或组件。属性值为基本类型，该函数具有其他可选参数， |
-| setAndProp  | key：String，defaultValue : S   | ObservedPropertyAbstract              | 如果存在具有给定键的属性，返回此属性的单向数据绑定（参考prop）。如果该属性不存在，请使用给定的默认值创建一个defaultValue（参考setOrCreate）并返回一个prop（参考prop）。默认值为S |
-| delete      | key：String                     | boolean                               | 删除具有给定名称的属性并返回true，否则不执行任何操作并返回false |
-| keys        | none                            | IterableIterator<string>              | 返回所有属性键的迭代器，参考Map.keys()                       |
-| size        | none                            | number                                | 与Map.size()用法相同                                         |
-| clear       | none                            | boolean                               | 删除所有的属性，如果当前有状态变量依旧引用此属性，返回false  |
+### Constructor  
 
-### @LocalStorageLink装饰器
+创建一个新的LocalStorage对象，对对象进行初始化。
 
-组件通过使用@LocalStorageLink(key)装饰的状态变量（key值为LocalStorage中的属性键值），与LocalStorage建立双向数据绑定，当创建包含@LocalStorageLink的状态变量的组件时，该状态变量的值将会使用LocalStorage中的值进行初始化。（如果LocalStorage中未定义初始值，将使用@LocalStorageLink定义的初始值）。在UI组件中对@LocalStorageLink的状态变量所做的更改将同步到LocalStorage中，并从LocalStorage同步到Ability下的组件中。
+| 参数名 | 类型   | 返回值 | 必填 | 描述                                                         |
+| ------ | ------ | ------ | :--: | ------------------------------------------------------------ |
+| obj    | Object | N/A    |  否  | object.keys(obj)返回的所有对象属性及其值都将添加到LocalStorage。 |
 
-### @LocalStorageProp装饰器
+### Has
 
-组件通过使用LocalStorageProp(key)装饰的状态变量（key值为LocalStorage中的属性键值），与LocalStorage建立单向数据绑定，当创建包含@LocalStorageProp的状态变量的组件时，该状态变量的值将使用LocalStorage中的值进行初始化。LocalStorage中的属性值的更改会导致当前Ability下的所有UI组件进行状态更新。
+| 参数名 | 类型   | 返回值  | 必填 | 描述                           |
+| ------ | ------ | ------- | :--: | ------------------------------ |
+| key    | string | boolean |  是  | 判断对应属性的属性值是否存在。 |
+
+### Get
+
+| 参数名 | 类型   | 返回值         | 必填 | 描述                 |
+| ------ | ------ | -------------- | :--: | -------------------- |
+| key    | string | T or undefined |  是  | 获取对应key值的value |
+
+### Set
+
+| 参数名   | 类型   | 返回值  | 必填 | 描述                                                  |
+| -------- | ------ | ------- | :--: | ----------------------------------------------------- |
+| key      | string | boolean |  是  | 如果存在key值，设置value值并返回true。否则返回false。 |
+| newValue | T      | boolean |  是  | 如果存在key值，设置value值并返回true。否则返回false。 |
+
+### SetOrCreate
+
+| 参数名   | 类型   | 返回值  | 必填 | 描述                                                         |
+| -------- | ------ | ------- | :--: | ------------------------------------------------------------ |
+| key      | string | boolean |  是  | 如果已存在与给定键名字相同的属性，更新其值且返回true。       |
+| newValue | T      | boolean |  是  | 如果不存在具有给定名称的属性，在LocalStorage中创建具有给定默认值的新属性，默认值必须是T类型。不允许undefined or null 返回true。 |
+
+### Link
+
+| 参数名 | 类型   | 返回值 | 必填 | 描述                                                         |
+| ------ | ------ | ------ | :--: | ------------------------------------------------------------ |
+| key    | string | T      |  是  | 如果存在具有给定键的属性，返回到此属性的双向绑定，该双向绑定意味着变量或者组件对数据的更改将同步到LocalStorage，然后通过LocalStorage实例同步到任何变量或组件。如果不存在给定键的属性，返回undefined。 |
+
+### SetAndLink
+
+| 参数名       | 类型   | 返回值 | 必填 | 描述                                                         |
+| ------------ | ------ | ------ | :--: | ------------------------------------------------------------ |
+| key          | string | @Link  |  是  | 与Link接口类似，如果当前的key保存与LocalStorage，返回该key值对应的value值。如果该key值未被创建，则创建一个对应的defaultValue的Link返回。 |
+| defaultValue | T      | @Link  |  是  | 与Link接口类似，如果当前的key保存与LocalStorage，返回该key值对应的value值。如果该key值未被创建，则创建一个对应的defaultValue的Link返回。 |
+
+ 注：Link接口链接：https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/ui/ts-component-states-link.md
+
+### Prop
+
+| 参数名 | 类型   | 返回值 | 必填 | 描述                                                         |
+| ------ | ------ | ------ | :--: | ------------------------------------------------------------ |
+| key    | string | @Prop  |  是  | 如果存在具有给定键的属性，返回此属性的单向数据绑定。该单向绑定意味着只能通过LocalStorage将属性的更改同步到变量或组件。该方法返回的变量为不可变变量，适用于可变和不可变的状态变量。如果此键的属性不存在则返回undefined。 |
+
+### SetAndProp
+
+| 参数名       | 类型   | 返回值 | 必填 | 描述                                                         |
+| ------------ | ------ | ------ | :--: | ------------------------------------------------------------ |
+| key          | string | @Prop  |  是  | 与Prop接口类似，如果当前的key保存与LocalStorage，返回该key值对应的value值。如果该key值未被创建，则创建一个对应的defaultValue的Prop返回。 |
+| defaultValue | S      | @Prop  |  是  | 与Prop接口类似，如果当前的key保存与LocalStorage，返回该key值对应的value值。如果该key值未被创建，则创建一个对应的defaultValue的Prop返回。 |
+
+注：Prop接口链接：https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/ui/ts-component-states-prop.md
+
+### Delete
+
+| 参数名 | 类型   | 返回值  | 必填 | 描述                                                         |
+| ------ | ------ | ------- | :--: | ------------------------------------------------------------ |
+| key    | string | boolean |  是  | 删除key指定的键值对，如果存在且删除成功返回true，不存在或删除失败返回false。 |
+
+### Keys
+
+| 参数名 | 类型 | 返回值        | 必填 | 描述                         |
+| ------ | ---- | ------------- | :--: | ---------------------------- |
+| none   | none | array<string> |  是  | 返回包含所有键的字符串数组。 |
+
+### Size
+
+| 参数名 | 类型 | 返回值 | 必填 | 描述                   |
+| ------ | ---- | ------ | :--: | ---------------------- |
+| none   | none | number |  是  | 与Map.size()用法相同。 |
+
+### Clear
+
+| 参数名 | 类型 | 返回值  | 必填 | 描述                                                        |
+| ------ | ---- | ------- | :--: | ----------------------------------------------------------- |
+| none   | none | boolean |  是  | 删除所有的属性，如果当前有状态变量依旧引用此属性，返回false |
 
 ### 示例1（在一个Ability创建的LocalStorage）：
 
-```swift
+```javascript
 import Ability from '@ohos.appLication.Ability'
 export default class MainAbility extends Ability {    
   storage : LocalStorage    
@@ -60,7 +128,7 @@ export default class MainAbility extends Ability {
     console.log("[Demo MainAbility onDestroy]")  
   }    
   onWindowStageCreate(windowStage) {
-    windowStage.setUlContent(this.context,"pages/index",this.storage)    
+    windowStage.setUIContent(this.context,"pages/index",this.storage)    
   }    
   onWindowStageDestroy() {
     console.log("[Demo] MainAbility onWindoeStageDestroy")   
@@ -74,7 +142,7 @@ export default class MainAbility extends Ability {
 }
 ```
 
-获取页面：
+@Component组件获取数据：
 
 ```
 let storage = LocalStorage.GetShared()