Add MutableBuilder Implementation · Pull Request !55984 · OpenHarmony/arkui_ace_engine

# 1. Add MutableBuilder implementation.
---
This Pr will bring MutableBuilder that can change the builder function at runtime unlike the WrappedBuilder.
DevEco compiler also need support (https://gitee.com/openharmony/developtools_ace_ets2bundle/pulls/5390)
There will be also interface PR for this feature.
---
**IssueNo**:[Bug]: Wrapped Builder cannot be changed to point to another builder
https://gitee.com/openharmony/arkui_ace_engine/issues/IBO0LC
**Description**:(提交描述)
**Sig**: SIG_ApplicationFramework
**Feature or Bugfix**:需求填Feature (需求填Feature,缺陷填Bugfix)
**Binary Source**:No(涉及则Yes)
**TDD**:评估不涉及 (Pass/Fail/评估不涉及)
**XTS**:Pass (Pass/Fail/评估不涉及)
**预测试**:(Pass/Fail/评估不涉及)

```TypeScript
// Application demonstrates NEW API that fixes the original issue
// NOTE: This PR does not bring DevEco support for this App. DevEco support is coming separately
class param {
  text: string = ""
}

@Builder
function textBuilder(p: param) {
  Text(p.text)
}

@Builder
function buttonBuilder(p: param) {
  Button(p.text)
}
let counter : number = 1;
@Entry
@ComponentV2
struct MyApp {
  @Local message: string = "init";

@Local switchingBuilder: MutableBuilder<[param]> = mutableBuilder(textBuilder)

build() {
    Column() {
      this.switchingBuilder.builder({ text: this.message })  
      Button("Click to change").onClick(() => {
        counter ++; // Increase this so that every button click changes the builder.
        if(counter % 2 === 0) {
          this.message += "B"
          this.switchingBuilder = mutableBuilder(buttonBuilder) // textBuilder--->buttonBuilder
        } else {
          this.message += "T"
          this.switchingBuilder = mutableBuilder(textBuilder) // buttonBuilder--->textBuilder
        }
      })
    }
  }
}
```
Generated .ts (DevEco compiler)

```ts
if (!("finalizeConstruction" in ViewPU.prototype)) {
    Reflect.set(ViewPU.prototype, "finalizeConstruction", () => { });
}
class param {
    text: string = "";
}
function textBuilder(p: param, parent = null) {
    const __p__ = p;
    (parent ? parent : this).observeComponentCreation2((elmtId, isInitialRender, p = __p__) => {
        Text.create(p.text);
    }, Text);
    Text.pop();
}
function buttonBuilder(p: param, parent = null) {
    const __p__ = p;
    (parent ? parent : this).observeComponentCreation2((elmtId, isInitialRender, p = __p__) => {
        Button.createWithLabel(p.text);
    }, Button);
    Button.pop();
}
let counter: number = 1;
class MyApp extends ViewV2 {
    constructor(parent, params, __localStorage, elmtId = -1, paramsLambda, extraInfo) {
        super(parent, elmtId, extraInfo);
        this.message = "init";
        this.switchingBuilder = mutableBuilder(textBuilder) 
        ;
        this.finalizeConstruction();
    }
    @Local
    message: string;

@Local
    switchingBuilder: MutableBuilder<[
        param
    ]>; 
    initialRender() {
        this.observeComponentCreation2((elmtId, isInitialRender) => {
            Column.create();
        }, Column);
        this.switchingBuilder._dispatchBuilder.bind(this)(()=>this.switchingBuilder, 
            makeBuilderParameterProxy("builder", { text: () => (this["__message"] ? this["__message"] : this["message"]) })) 
        
        this.observeComponentCreation2((elmtId, isInitialRender) => {
            Button.createWithLabel("Click to change");
            Button.onClick(() => {
                counter++; // Increase this so that every button click changes the builder.
                if (counter % 2 === 0) {
                    this.message += "B";
                    this.switchingBuilder = mutableBuilder(buttonBuilder); // textBuilder--->buttonBuilder
                }
                else {
                    this.message += "T";
                    this.switchingBuilder = mutableBuilder(textBuilder); // buttonBuilder--->textBuilder
                }
            });
        }, Button);
        Button.pop();
        Column.pop();
    }
    rerender() {
        this.updateDirtyElements();
    }
    static getEntryName(): string {
        return "MyApp";
    }
}
registerNamedRoute(() => new MyApp(undefined, {}), "", { bundleName: "com.example.myapplication", moduleName: "entry", pagePath: "pages/Index", pageFullPath: "entry/src/main/ets/pages/Index", integratedHsp: "false", moduleType: "followWithHap" });
```

### How to Test Before PR merged
To enable this feature for verification one needs to update BOTH 1. libace_compatible.z.so and 2. stateMgmt.abc
Also new compiler or manual .ts file change is needed.

### How to FIX
Developer will have new MutableBuilder interface.
```ts
OLD: @Local theBuilder: WrappedBuilder<[Param_]> = wrapBuilder(textBuilder)
NEW: @Local theBuilder: MutableBuilder<[Param_]> = mutableBuilder(textBuilder)
```

### DevEco change needed 
// Developer Uses MutableBuilder. 
Compiler need to generate code like this:
```ts
this.theBuilder._dispatchBuilder.bind(this)(()=>this.theBuilder, this.theBuilderParam)
```
// Developer uses WrappedBuilder // Old functionality
```ts
this.theBuilder.builder.bind(this)(this.theBuilderParam); 
```
**稳定性自检：**
| 自检项                                                       | 自检结果  |
| ------------------------------------------------------------ | -------- |
| 涉及跨进程调用的相关操作需要抛至主线程或加锁防止并发              |          |
| 成员变量进行赋值或创建需要排查并发                               |          |
| 谨慎在lambda表达式中使用引用捕获                                |          |
| 谨慎在未经拷贝的情况下使用外部传入的string、C字符串               |          |
| map\vector\list\set等stl模板类使用时需要排查并发                |          |
| 谨慎考虑加锁范围                                               |          |
| while循环谨慎考虑循环条件，避免死循环                            |          |
| 在IPC通信中谨慎使用同步通信方式                                 |          |
| 禁止传递this指针至其它模块或线程（特别是eventhandler任务）        |          |
| 禁止将外部传入的裸指针在内部直接构造智能指针                      |          |
| 禁止多个独立创建的智能指针管理同一地址                           |          |
| 禁止在析构函数中抛异步任务                                      |          |
| 禁止js对象在非js线程（例如在IPC线程）创建、使用或销毁             |          |
| 禁止在对外接口中未经判空直接使用外部传入的指针                    |          |
| 禁止接口返回局部变量引用                                        |          |
| 禁止在信号函数中加锁                                            |          |
| 禁止在关键流程（SA启动、应用启动等主流程）执行耗时的操作           |          |
| 禁止将同一个cpp编译在不同的so中                                 |          |
| 谨慎在lambda表达式中捕获FrameNode的强指针（RefPtr）避免循环引用导致内存泄漏       |          |
| 禁止在PostTask时捕获祼指针或引用，避免发生use-after-free导致crash       |          |

**安全编码自检：**
| 自检项                                                          | 自检结果 |
| -------------------------------------------------------------- | -------- |
| 裸指针避免通过隐式转换构造为sptr                                 |          |
| json对象在取值之前必须先判断类型，避免类型不匹配                   |          |
| 序列化时必须对传入的数组大小进行校验，避免出现超大数组              |          |
| 避免使用未明确位宽的整型，选择使用int8_t、uint8_t等类型            |          |
| 外部传入的路径要做规范化校验，对路径中的.、..、../等特殊字符严格校验 |          |
| 指针变量、表示资源描述符的变量、bool变量必须赋初值                  |          |
| readParcelable获取的对象使用前需要判空                            |          |
| 分配和释放内存的函数需要成对出现                                   |          |
| 申请内存后异常退出前需要及时进行内存释放                            |          |
| 内存申请前必须对内存大小进行合法性校验                              |          |
| 内存分配后必须判断是否成功                                         |          |
| 禁止使用realloc、alloca函数                                       |          |
| 禁止打印文件路径、口令等敏感信息，如有需要，使用private修饰          |          |
| 禁止打印内存地址                                                  |          |
| 整数之间运算时必须严格检查，确保不会出现溢出、反转、除0               |          |
| 禁止对有符号整数进行位操作符运算                                    |          |
| 禁止对指针进行逻辑或位运算                                         |          |
| 循环次数如果收外部数据控制，需要检验其合法性                         |          |
| 禁止使用内存操作类危险函数，需要使用安全函数                         |          |
| 谨慎使用不可重入函数                                               |          |
| 必须检查安全函数的返回值，并进行正确处理                             |          |
| 禁止仅通过TokenType类型判断绕过权限校验                             |          |

类型	指派人员	状态
审查	@ArkUI_StateMgmt 由 .gitee/CODEOWNERS 文件第 1634 行指派为审查者	进行中 (0/1人)
审查	李俊峰 LiuYongchang caocan ZhangYu jiangdayuan piggyguy_jdx shiyu_huang jinweiliu jyj_0306 yeyinglong 徐承桦 yanshuifeng yangfan229 Sunfei 何溯 lushi1202 lixingchi1 xiexiyun 周沺耳 firminly	进行中 (0/1人)
测试	openharmony_ci 已测试通过	已完成 (1/1人)

OpenHarmony/arkui_ace_engine关闭 .gitee-modal { width: 500px !important; }

搜索帮助

OpenHarmony/arkui_ace_engine
关闭