Compare commits

...

10 Commits

Author SHA1 Message Date
4c4298d413 EP Asynchrony 2025-07-25 14:31:16 +08:00
27fe1d4ac1 提案修改 2025-07-24 09:34:45 +08:00
2dc9812678 BS 0.2.0 Visual基础提案被添加 2025-07-21 14:46:46 +08:00
ninemine
5813504624 BS 0.1.0 完成第一个版本 2025-06-29 17:42:49 +08:00
ninemine
a387e8742a BS 0.0.1 构型退化 2025-06-20 14:09:40 +08:00
ninemine
d8b7cdfa5a BS 0.0.1 [Runtime]/Generics/ 2025-06-12 14:51:02 +08:00
7e3cecd8a4 BS 0.0.1 [Runtime]/Config 2025-06-12 12:41:54 +08:00
04f012dc12 BS 0.0.1 [Runtime]/Config 2025-06-12 01:08:53 +08:00
ninemine
a7cf31f676 BS 0.0.1 2025-06-11 16:43:57 +08:00
8c59fe61e5 Save 2025-06-10 12:16:50 +08:00
12 changed files with 702 additions and 0 deletions

View File

@@ -0,0 +1,17 @@
[返回](../RootEnv-README.md)
# /Convention
本位置用于放置代码内的静态配置文件, 如必要的环境资源或编译指示等
---
# 目录结构
- [[Runtime]*]([Runtime]/Runtime-README.md)
核心内容, 目标运行时将需要这些内容
- [[Static]]([Static]/Static-README.md)
作用于目标生成前, 将作为静态的辅助部分协助开发, 但最终不参与生成

View File

@@ -0,0 +1,107 @@
[返回](./Runtime-README.md)
# /Convention/Runtime/Architecture
---
核心架构模块,提供依赖注入、事件系统和时间线管理功能
## 接口定义
系统定义了以下核心接口来规范架构设计:
### ISignal
信号接口,用于事件系统的消息传递
### IModel
模型接口,定义数据模型的序列化和反序列化能力:
- `Save()` 保存数据到字符串
- `Load(string data)` 从字符串加载数据
### IConvertable<T>
转换接口,提供类型转换能力:
- `ConvertTo()` 转换为目标类型
### IConvertModel<T>
组合接口,同时继承 `IModel``IConvertable<T>`
## 核心类型
### SingletonModel<T>
泛型单例模型,提供类型安全的单例管理:
- 支持依赖注入和实例替换
- 提供隐式转换操作符
- 集成模型序列化功能
### DependenceModel
依赖模型,管理多个条件的组合验证:
- 支持多个 `IConvertModel<bool>` 的依赖关系
- 提供枚举接口遍历所有依赖
- 所有依赖条件均满足时返回true
## 注册系统
### 对象注册
- `Register(Type slot, object target, Action completer, params Type[] dependences)`
- `Register<T>(T target, Action completer, params Type[] dependences)`
提供基于类型的依赖注入容器:
- 支持依赖关系管理
- 支持注册完成回调
- 自动解析依赖顺序
### 注册查询
- `Contains(Type type)` / `Contains<T>()`
- `Get(Type type)` / `Get<T>()`
## 事件系统
### 消息监听
- `AddListener<Signal>(Type slot, Action<Signal> listener)`
- `SendMessage(Type slot, ISignal signal)`
- `SendMessage<Signal>(Signal signal)`
提供类型安全的事件分发机制:
- 支持按类型注册监听器
- 支持泛型消息类型
- 自动管理监听器生命周期
### Listening类
监听器管理类,提供:
- `StopListening()` 停止监听
## 时间线系统
### 时间线管理
- `CreateTimeline()` 创建新的时间线
- `AddStep(int timelineId, Func<bool> predicate, params Action[] actions)` 添加步骤
- `UpdateTimeline()` 更新所有时间线
- `ResetTimelineContext(int timelineId)` 重置时间线上下文
提供基于条件的任务调度:
- 支持多条时间线并行执行
- 基于谓词的条件触发
- 支持动态添加执行步骤
## 类型格式化
### 类型序列化
- `FormatType(Type type)` 格式化类型为字符串
- `LoadFromFormat(string data)` 从字符串加载类型
- `LoadFromFormat(string data, out Exception exception)` 安全加载类型
使用格式:`Assembly::FullTypeName`
## 内部管理
### 系统重置
- `InternalReset()` 重置所有内部状态
清理以下组件:
- 注册历史
- 未完成的目标
- 完成器回调
- 依赖关系
- 子对象容器
- 事件监听器
- 时间线队列

View File

@@ -0,0 +1,36 @@
[返回](./Runtime-README.md)
# /Convention/Runtime/Asynchrony
异步表达式系统,允许对象字段进行延迟初始化和访问,实现将有序调用转换为无序调用的方法
---
## 核心组件
### Asynchronous 基类
异步对象的基类,提供字段级别的异步访问能力。
### AsynchronyExpression 异步表达式
封装单个字段的异步访问逻辑。
**参数:**
- `field`: 字段信息
- `value`: 初始值(默认为未初始化状态)
- `time_wait`: 等待间隔默认0.1秒)
- `timeout`: 超时时间默认0秒表示无超时
- `callback`: 初始化回调函数
**方法:**
- `get_value()`: 异步获取字段值
- `set_value()`: 设置字段值
- `set_uninitialized()`: 重置为未初始化状态
### AsyncContextDetector 上下文检测器
检测当前运行环境是否为异步上下文。
**静态方法:**
- `is_in_async_context()`: 检查是否在异步上下文中
- `get_current_loop()`: 获取当前事件循环
- `ensure_async_context_safe()`: 确保操作在异步上下文中安全

View File

@@ -0,0 +1,49 @@
[返回](./Runtime-README.md)
# /Convention/Runtime/Config
---
包含了关于静态的配置信息等内容, 并且引入全体标准库内容
## Import All
检查并尝试引入所有依赖库
## 静态配置
若不存在相应配置, 则需要定义
- `CURRENT_COM_NAME` 公司/组织名称
- `CURRENT_APP_NAME` 应用名称
## PlatformIndicator包含的内容
- `IsRelease` Debug/Release状态
- `IsPlatform<Name>` 平台判断
- `IsPlatformX64`平台架构判断
- 编译器/解释器判断 如`IsMSVC`
- `ApplicationPath` 获取当前应用程序目录
- `StreamingAssetsPath` 获取StreamingAssets目录
- `PersistentPath` 获取持久化目录
- `PlatformInfomation` 平台相关的发布信息
## 多个静态类 <Type>Indicator
包含对应类型常用的工具函数
## 静态类 DescriptiveIndicator
包含一个`描述`字符串, 可选一个`值`对象
## 其他基础内容
用于对齐不同语言间基本实现的颗粒度, 如以下内容
- 类型转换
- 字符串操作
- Construct/Destruct 重构造/析构
- 命令行解析
- 简单的反射内容
- 元类型
- 等等...

View File

@@ -0,0 +1,111 @@
[返回](./Runtime-README.md)
# /Convention/Runtime/EasySave
---
完整的序列化和数据持久化系统,提供易用的数据存储和读取功能
## 核心特性
### 支持的数据格式
- **EasySave - JSON** 支持多态的json格式
- **Binary** 紧凑的二进制格式
## EasySave主类
### 基本保存操作
#### 泛型保存
- `Save<T>(string key, T value)` 保存到默认文件
- `Save<T>(string key, T value, string filePath)` 保存到指定文件
- `Save<T>(string key, T value, EasySaveSettings settings)` 使用自定义设置
#### 原始数据保存
- `SaveRaw(byte[] bytes)` / `SaveRaw(string str)` 保存原始数据
- `AppendRaw(byte[] bytes)` / `AppendRaw(string str)` 追加原始数据
### 基本加载操作
#### 泛型加载
- `Load<T>(string key)` 从默认文件加载
- `Load<T>(string key, string filePath)` 从指定文件加载
- `Load<T>(string key, T defaultValue)` 带默认值的安全加载
#### 原始数据加载
- `LoadRawBytes()` / `LoadRawString()` 加载原始数据
- `LoadString(string key, string defaultValue)` 加载字符串
#### 加载到现有对象
- `LoadInto<T>(string key, T obj)` 将数据加载到现有对象
- `LoadInto(string key, string filePath, object obj)` 从指定文件加载到对象
### 序列化操作
#### 内存序列化
- `Serialize<T>(T value, EasySaveSettings settings = null)` 序列化为字节数组
- `Deserialize<T>(byte[] bytes, EasySaveSettings settings = null)` 从字节数组反序列化
- `DeserializeInto<T>(byte[] bytes, T obj)` 反序列化到现有对象
### 加密和压缩
#### 加密操作
- `EncryptBytes(byte[] bytes, string password = null)` 加密字节数组
- `DecryptBytes(byte[] bytes, string password = null)` 解密字节数组
- `EncryptString(string str, string password = null)` 加密字符串
- `DecryptString(string str, string password = null)` 解密字符串
#### 压缩操作
- `CompressBytes(byte[] bytes)` 压缩字节数组
- `DecompressBytes(byte[] bytes)` 解压字节数组
- `CompressString(string str)` 压缩字符串
- `DecompressString(string str)` 解压字符串
### 备份系统
#### 备份操作
- `CreateBackup()` / `CreateBackup(string filePath)` 创建备份
- `RestoreBackup(string filePath)` 恢复备份
#### 时间戳
- `GetTimestamp()` / `GetTimestamp(string filePath)` 获取文件时间戳
### 缓存系统
#### 缓存操作
- `StoreCachedFile()` / `StoreCachedFile(string filePath)` 存储缓存文件
- `CacheFile()` / `CacheFile(string filePath)` 缓存文件
## EasySaveSettings配置
### 枚举类型定义
#### 存储位置
```csharp
public enum Location { File, InternalMS, Cache }
```
#### 目录类型
```csharp
public enum Directory { PersistentDataPath, DataPath }
```
#### 加密类型
```csharp
public enum EncryptionType { None, AES }
```
#### 压缩类型
```csharp
public enum CompressionType { None, Gzip }
```
#### 数据格式
```csharp
public enum Format { JSON }
```
#### 引用模式
```csharp
public enum ReferenceMode { ByRef, ByValue, ByRefAndValue }
```

View File

@@ -0,0 +1,88 @@
[返回](./Runtime-README.md)
# /Convention/Runtime/File
---
文件操作工具模块,提供跨平台的文件和目录操作功能
## ToolFile类
### 构造与基本信息
- `ToolFile(string path)` 从路径创建文件对象
- `ToString()` / `GetFullPath()` 获取完整路径
- `GetName(bool is_ignore_extension = false)` 获取文件名
- `GetExtension()` 获取文件扩展名
### 路径操作
- `ToolFile operator |(ToolFile left, string rightPath)` 路径连接操作符
- `Open(string path)` 打开指定路径
- `Open(FileMode mode)` 以指定模式打开文件
- `Close()` 关闭文件流
- `BackToParentDir()` 回到父目录
- `GetParentDir()` 获取父目录
### 存在性检查
- `Exists()` 检查文件或目录是否存在
- `implicit operator bool` 隐式布尔转换等同于Exists()
### 类型判断
- `IsDir()` 是否为目录
- `IsFile()` 是否为文件
- `IsFileEmpty()` 文件是否为空
### 文件加载
支持多种格式的文件读取:
#### JSON操作
- `LoadAsRawJson<T>()` 原始JSON反序列化
- `LoadAsJson<T>(string key = "data")` 使用EasySave加载JSON
#### 文本操作
- `LoadAsText()` 加载为文本字符串
#### 二进制操作
- `LoadAsBinary()` 加载为字节数组
### 文件保存
支持多种格式的文件写入:
#### JSON保存
- `SaveAsRawJson<T>(T data)` 原始JSON序列化保存
- `SaveAsJson<T>(T data, string key)` 使用EasySave保存JSON
#### 二进制保存
- `SaveAsBinary(byte[] data)` 保存字节数组
- `SaveDataAsBinary(string path, byte[] outdata, FileStream Stream = null)` 静态二进制保存
### 文件操作
- `Create()` 创建文件或目录
- `Rename(string newPath)` 重命名
- `Move(string path)` 移动文件
- `Copy(string path, out ToolFile copyTo)` 复制文件
- `Delete()` / `Remove()` 删除文件或目录
- `Refresh()` 刷新文件信息
### 路径管理
- `MustExistsPath()` 确保路径存在(自动创建)
- `TryCreateParentPath()` 尝试创建父路径
### 目录操作
- `DirIter()` 遍历目录获取字符串列表
- `DirToolFileIter()` 遍历目录获取ToolFile列表
- `DirCount()` 获取目录内项目数量
- `DirClear()` 清空目录内容
- `MakeFileInside(string source, bool isDeleteSource = false)` 在目录内创建文件
### 文件对话框(平台相关)
- `SelectMultipleFiles(string filter, string title)` 多文件选择对话框
- `SelectFile(string filter, string title)` 单文件选择对话框
- `SaveFile(string filter, string title)` 保存文件对话框
- `SelectFolder(string description)` 文件夹选择对话框
### 文件浏览
- `BrowseFile(params string[] extensions)` 浏览指定扩展名的文件
- `BrowseToolFile(params string[] extensions)` 浏览并返回ToolFile对象
### 时间戳
- `GetTimestamp()` 获取文件时间戳

View File

@@ -0,0 +1,88 @@
[返回](./Runtime-README.md)
# /Convention/Runtime/GlobalConfig
---
全局配置管理模块,提供配置文件操作、日志系统和项目级配置管理
## GlobalConfig类
### 构造与初始化
- `GlobalConfig(string dataDir, bool isTryCreateDataDir = false, bool isLoad = true)`
- `GlobalConfig(ToolFile dataDir, bool isTryCreateDataDir = false, bool isLoad = true)`
#### 初始化流程
1. 设置数据目录,确保目录存在
2. 检查配置文件,不存在则生成空配置
3. 可选自动加载现有配置
### 静态配置
- `ConstConfigFile` 配置文件名(默认"config.json"
- `InitExtensionEnv()` 初始化扩展环境
- `GenerateEmptyConfigJson(ToolFile file)` 生成空配置JSON
### 文件管理
- `GetConfigFile()` / `ConfigFile` 获取配置文件对象
- `GetFile(string path, bool isMustExist = false)` 获取数据目录下的文件
- `CreateFile(string path)` 创建文件
- `EraseFile(string path)` 清空文件内容
- `RemoveFile(string path)` 删除文件
### 配置数据操作
能够被`foreach`/`for`使用迭代器历遍配置内容的键值对
#### 数据访问
- `operator[](string key)` 索引器访问配置项
- `Contains(string key)` 检查键是否存在
- `Remove(string key)` 删除配置项
- `DataSize()` 获取配置项数量
#### 持久化
- `SaveProperties()` 保存配置到文件
- `LoadProperties()` 从文件加载配置
配置文件格式:
```json
{
"properties": {
"key1": "value1",
"key2": "value2"
}
}
```
### 日志系统
- `GetLogFile()` / `LogFile` 获取日志文件对象
- `DefaultLogger` 默认日志输出器(可自定义)
#### 日志方法
- `Log(string messageType, string message, Action<string> logger)`
- `Log(string messageType, string message)` 使用默认日志器
- `LogPropertyNotFound(string message, Action<string> logger, object @default = null)`
- `LogPropertyNotFound(string message, object @default = null)`
- `LogMessageOfPleaseCompleteConfiguration()` 记录配置提示信息
#### 日志格式
```
[time] MessageType : Message
```
自动调整消息类型的对齐宽度
### 配置查找
- `FindItem(string key, object @default = null)` 查找配置项,支持默认值
## ProjectConfig类
继承自 `GlobalConfig`,专门用于项目级配置管理
### 静态配置
- `ProjectConfigFileFocus` 项目配置目录焦点(默认"Assets/"
- `InitExtensionEnv()` 初始化项目扩展环境
- `SetProjectConfigFileFocus(string path)` 设置项目配置焦点目录
- `GetProjectConfigFileFocus()` 获取项目配置焦点目录
### 构造
- `ProjectConfig(bool isLoad = true)` 使用默认项目目录构造

View File

@@ -0,0 +1,7 @@
[返回](./Runtime-README.md)
# /Convention/Runtime/Plugins
---
插件系统模块,提供扩展机制和平台特定功能

View File

@@ -0,0 +1,39 @@
[返回](../Source-README.md)
# /Convention/Runtime
本位置用于放置允许直接暴露的接口代码与汇总代码
---
# 目录结构
- [Config*](Config.md)
检查并尝试引入所有依赖库, 定义PlatformIndicator与一些基础内容
- [Architecture*](Architecture.md)
核心架构模块,包含依赖注入、事件系统和架构抽象
- [File*](File.md)
文件操作工具模块,提供跨平台的文件和目录操作
- [GlobalConfig*](GlobalConfig.md)
全局配置管理模块,提供配置文件操作和日志系统
- [Web*](Web.md)
网络工具模块,提供网络服务相关功能
- [Plugins](Plugins.md)
插件系统模块,提供扩展机制和平台特定功能
- [EasySave*](EasySave.md)
适用于多态的数据持久化系统,提供易用的数据存储功能

121
Convention/[Runtime]/Web.md Normal file
View File

@@ -0,0 +1,121 @@
[返回](./Runtime-README.md)
# /Convention/Runtime/Web
---
网络工具模块提供HTTP客户端和URL操作功能
## ToolURL类
### 构造与基本信息
- `ToolURL(string url)` 从URL字符串创建对象
- `ToString()` / `GetFullURL()` / `FullURL` 获取完整URL
- `implicit operator string` 隐式字符串转换
### URL属性解析
- `GetFilename()` 获取URL中的文件名
- `GetExtension()` 获取文件扩展名
- `ExtensionIs(params string[] extensions)` 检查扩展名是否匹配
### URL验证
- `IsValid` 属性检查URL是否有效
- `ValidateURL()` 验证URL格式
- `implicit operator bool` 隐式布尔转换等同于IsValid
支持HTTP和HTTPS协议的绝对URL
### HTTP方法
#### GET请求
- `GetAsync(Action<HttpResponseMessage> callback)` 异步GET
- `Get(Action<HttpResponseMessage> callback)` 同步GET
#### POST请求
- `PostAsync(Action<HttpResponseMessage> callback, Dictionary<string, string> formData = null)` 异步POST
- `Post(Action<HttpResponseMessage> callback, Dictionary<string, string> formData = null)` 同步POST
支持表单数据提交
### 内容加载
#### 文本加载
- `LoadAsTextAsync()` 异步加载为文本
- `LoadAsText()` 同步加载为文本
#### 二进制加载
- `LoadAsBinaryAsync()` 异步加载为字节数组
- `LoadAsBinary()` 同步加载为字节数组
#### JSON加载
- `LoadAsJson<T>()` 同步加载并反序列化JSON
- `LoadAsJsonAsync<T>()` 异步加载并反序列化JSON
### 文件保存
- `Save(string localPath = null)` 自动选择格式保存到本地
- `SaveAsText(string localPath = null)` 保存为文本文件
- `SaveAsJson(string localPath = null)` 保存为JSON文件
- `SaveAsBinary(string localPath = null)` 保存为二进制文件
### 文件类型判断
- `IsText` 是否为文本文件txt, html, htm, css, js, xml, csv
- `IsJson` 是否为JSON文件
- `IsImage` 是否为图像文件jpg, jpeg, png, gif, bmp, svg
- `IsDocument` 是否为文档文件pdf, doc, docx, xls, xlsx, ppt, pptx
### 高级操作
- `Open(string url)` 在当前对象上打开新URL
- `DownloadAsync(string localPath = null)` 异步下载文件
- `Download(string localPath = null)` 同步下载文件
## 设计特点
### 统一的HTTP客户端
使用静态 `HttpClient` 实例,避免连接池耗尽
### 自动内容类型检测
基于文件扩展名自动判断内容类型,优化保存和处理策略
### 异步支持
所有网络操作都提供异步和同步两种版本
### 错误处理
网络请求失败时回调函数接收null参数方法返回false
### 文件管理集成
下载的文件自动转换为ToolFile对象与文件系统模块无缝集成
### 灵活的数据格式
支持文本、二进制、JSON等多种数据格式的加载和保存
## 使用示例
### 基本HTTP请求
```csharp
var url = new ToolURL("https://api.example.com/data");
if (url.IsValid)
{
url.Get(response => {
if (response != null && response.IsSuccessStatusCode)
{
// 处理响应
}
});
}
```
### 文件下载
```csharp
var url = new ToolURL("https://example.com/file.json");
var localFile = url.Download("./downloads/file.json");
if (localFile.Exists())
{
var data = localFile.LoadAsJson<MyDataType>();
}
```
### 类型安全的JSON加载
```csharp
var url = new ToolURL("https://api.example.com/users.json");
var users = url.LoadAsJson<List<User>>();
```

View File

@@ -0,0 +1,7 @@
[返回](../Source-README.md)
# /Convention/Static
作用于目标生成前, 将作为静态的辅助部分协助开发, 但最终不参与生成
---

32
RootEnv-README.md Normal file
View File

@@ -0,0 +1,32 @@
# /
根目录用于放置实现代码外的配置文件, 如必要的环境资源或编译指示等
---
# 目录结构
- [Convention](Convention/Source-README.md)
核心内容
# 修改日志
基础标准`BS`, 增强提案`EP`
- `Asynchrony` `EP` Async异步表达式
- `Visual` `EP` Visual
- Visual 视觉与图像
1. BS建立
2. 修改为EP
- `0.1.0` `BS` Runtime标准
- GlobalConfig 面向对象的配置文件与资源管理
- Config 内置功能与配置
- File 面向对象的文件系统
- EasySave 适用于多态的序列化/反序列化方案
- Web 面向对象的网络系统
- Architecture 动态多态的非侵入式架构
- `0.0.1` `BS` 建立标准