From b88a97b98be9dcaa351060899045b66543ed7ef3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9D=8E=E8=8B=A5=E8=BE=B0?= Date: Tue, 14 Oct 2025 11:39:02 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=20TextBlockBuilder?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- TextBlockBuilder.md | 84 +++++++++++++++++++++++++++++++++++++-------- 1 file changed, 70 insertions(+), 14 deletions(-) diff --git a/TextBlockBuilder.md b/TextBlockBuilder.md index d9ada8c..17915c4 100644 --- a/TextBlockBuilder.md +++ b/TextBlockBuilder.md @@ -20,8 +20,7 @@ _blockBuilder = new TextBlockBuilder( new ColorBlock(Color.white, "重量"), new NumberValueBlock(1.23), new SizeBlock(20, "kg"))); - -// 结果:重量1.23kg +_blockBuilder.ToString(); // 结果:重量1.23kg ``` 格式包裹器`TextBlockBuilder`是所有`blocker`的基类,这个结构内部是一个字符串拼接池,包括它自身在内,所有的`blocker`都相当于一个文本拼接器,只是它自带一定的格式。 @@ -51,7 +50,7 @@ _blockBuilder = new TextBlockBuilder() "kg" } }; -// 结果: 重量1.23kg +_blockBuilder.ToString(); // 结果:重量1.23kg ``` 在面对复杂的富文本时,这样写可读性更强; @@ -144,19 +143,23 @@ public class MyBlock : TextBlockBuilder // 继承自TextBlockBuilder } ``` -## 工具集语法 +## 工具集语法(文本包裹器框架语法) 在使用包裹器创建格式时,大量的new语句可能会劝退一些比较保守的程序员。 所以这里也提供了可以隐藏这些new语句的方法,当然考虑到各位可能会对性能存疑,所以我特意基于对象池来实现各种获取操作,不管这对性能是否有所提升,都可以暂时堵住其他随意质疑你这么写的人的嘴巴。 > 起因是我向其他人推荐这个写法,就有人会有这个疑问,说在java中如果这么new对象,怕是要被老板约谈。 > 嘛,说的也没错,其实我也不喜欢这样去写,但设计之初没有太多选择,需要先建立一个基本的框架,否则这些进阶语法都免谈。 -> 我早之前也写了语法逆向,尝试将一个富文本转为blocker,不过这样性能消耗有点大。 +> 我早之前也写了语法逆向,尝试将一个富文本转为blocker,不过这样性能消耗有点大。 +> 这个框架语法现在也终于是抽空磨出来了。 直接展示示例: -`(Color(UnityEngine.Color.White, Value("重量"))+Value(1.23)+Size(20, Value("kg"))).BuildBlockByAgentOnce()` - -非常简短,对吧,不过这段代码前提是需要引用一些命名空间: +``` scharp +_blockBuilder = Pure(Color(Color.white, Label("重量")), Value(1.23), Size(20, Label("kg"))).BuildBlockByAgentOnce(); +_blockBuilder.ToString(); // 结果:重量1.23kg ``` + +相比之下非常简短,对吧,不过这段代码前提是需要引用一些命名空间: +``` scharp using static XericLibrary.Runtime.MacroLibrary.MacroMath; using static XericLibrary.Runtime.MacroLibrary.MacroMath.AlignBlock.Align; using static XericLibrary.Runtime.MacroLibrary.MacroMath.RichTextUnits; @@ -164,15 +167,68 @@ using static XericLibrary.Runtime.Type.SpatialAlgorithm.BlockUtilKit; using Color = UnityEngine.Color; ``` -> 代码中的加法作用是拼接两个block,你也可以将文本或者其他接口对象拼接起来。 +> 示例中的函数式最后的`BuildBlockByAgentOnce`作用是返回这个工具集的包裹器,并将构建框架放回池中释放。 +> 也可以使用`BuildBlockByAgent`获取,但它会返回一个object类型的TextBlockBuilder对象,但是会保留框架,也就是你可以重复使用这个框架去生成blockBuilder。 +> 除非你已经完全了解如何使用框架,否则无论如何,都建议使用`BuildBlockByAgentOnce`来构建, -函数式最后的`BuildBlockByAgentOnce`作用是返回这个工具集的包裹器,并将构建框架进行释放。 -也可以使用`BuildBlockByAgent`获取,但它会返回一个object类型的TextBlockBuilder对象,其次是会保留框架。 -这个"框架"的作用是定义包裹器的结构,并提供通过池获取的方法。 +### 框架语法说明: -由于框架返回的还是包裹器,所以剩余的语法与之前的内容一致,并且也可以在静态作用域声名。 +> 在框架上使用构建方法返回的文本包裹器,在内容上与直接使用new block的做法生成的内容几乎一致。 +> 但框架格式在细节处理上相比直接使用文本包裹器相比,可能会产生更多的嵌套块用于处理特殊语法,通常这不会影响最终的使用。 + +#### 嵌套框架语法 NestBlocker + +使用`NestBlocker`可以快速拼接多个嵌套块,下面是一个示例: + +``` csharp +// 1. 这是一个有多个无参数嵌套组合的包裹器对象 +private static TextBlockBuilder MyBlock1 = + new UBlock(new BBlock(new IDBlock("blockid", new NumberValueBlock(0)))); + +// 2. 这是一个适合快速入门的嵌套语法优化方式,将多个无参的包裹器对象放在了一起(参数集是必填的,但是这里没有人会用到参数集,所以使用默认值代替即可) +private static TextBlockBuilder MyBlock2 = + NestBlocker(default, ID("blockid", Value(0))).BuildBlockByAgentOnce(); + +// 3. 这是一个充分利用嵌套语法优化,将所有嵌套的块放在了一起,然后将参数单独提出来的用法 +private static TextBlockBuilder MyBlock2 = + NestBlocker(param).BuildBlockByAgentOnce(); + +// 这里的参数集是嵌套块中所有块都会共用的参数,所以这里仅需要声名块所必要的内容即可。 +private static TextBlockParam param = new TextBlockParam("") { ID = "blockid" }; +// 还有一种铜过检查字段值变化差异设置方法,也可以将id值设置到default值上。 +private static TextBlockParam param = TextBlockParam.Default.SetDifferenceByEmpty(new TextBlockParam(){ ID = "blockid" }); +// 除了相比上面的方法,运行开销会很高之外,其他表现基本一致。 +``` + +> 值得注意的是,如果需要获得默认值,构造参数中需要填入一个名称 +> 这个名称并不重要,所以我都是直接用空字符串代替,如果不填写则全部使用空值,在设置valueBlock时可能会导致行为不及预期等问题,注意辨别。 + +嵌套框架语法制作最多10个参数。 + +### 拼接框架语法 SpreadBlocker + +首先拼接语法存在一些限制,一般用于一串连续的包裹器框架,并包含字符串等其他类型成员的简化语法。 +还是用一个简单的示例来看一下: + +``` scharp +// 这里的 pure 方法的作用就是充当一个纯拼接器,并且由于它会返回一个包裹器框架类,而不是接口对象,所以可以调用 BuildBlockByAgentOnce 方法,直接返回我们需要的 TextBlockBuilder +_blockBuilder = Pure(Color(Color.white, Value("重量")), Value(1.23), Size(20, Value("kg"))).BuildBlockByAgentOnce(); + +// 这个示例为了展示字符串拼接的功能,所以移除了color块,可以看到包裹器框架可以直接与字符串拼接。 +_blockBuilder = ((BlockBuilderAgent)("重量" + Value(1.23) + Size(20, Label("kg")))).BuildBlockByAgentOnce(); + +// 基于拼接函数,可以将参数提出来,然后将这些需要包裹的子项写在对应的参数位置上即可 +_blockBuilder = SpreadBlocker(param, Label("重量"), Empty(), Label("kg")).BuildBlockByAgentOnce(); +private static TextBlockParam param => new("") { NumberValue = 1.23, TextSize = 20 }; +``` + +> IBlockAgentBase 接口是所有包裹器框架都会继承的接口,这里由于 valueblock 没有子项,或者说它不会处理子项,所以我们可以直接用 empty 方法返回一个空的包裹单元。 +> 实际上使用 default/null 代替 Empty() 也是可以的,区别是引用为空的框架成员不会被框架处理,而实际存在但内容为空的框架会被其他框架处理,知道最终的构建步骤中才会被文本包裹器忽略。 +> 总之这些方式最终的表现都是一样的,可以随意使用。 + +拼接框架函数最多支持10个参数,超出后也可以使用 `+` 链接两个框架函数。 ## 注意事项 -注意传入参数尽量不要为null,这样分辨不出来类型,在大多数包裹器上会产生报错。 +注意在与包裹器交互时,传入参数尽量不要为null,这样分辨不出来类型,在大多数包裹器上会产生报错。