2.0.0B4

文档和小bug

Author: Coloryr

README.md

@@ -2,7 +2,6 @@
 ![ico](./ColoryrWork.png)  
 
 2.0.0版本正在进行中  
-2.0.0B2已完成
 
 一个多功能服务器/应用框架  
 
@@ -27,9 +26,7 @@
 
 [部署&启动](./doc/run.md)
 
-[目录文件说明](./doc/dir.md)
-
-[配置文件说明](./doc/config.md)
+[目录结构与文件信息](./doc/config.md)
 
 [业务代码编写](./doc/code.md)
 ```

doc/builder.md

@@ -7,16 +7,18 @@
 
 连接服务器后得到下面的窗口，在这里可以进行服务器业务代码的编写
 
-![图片](pic_code/builder.png)
+![图片](pic/pic1.png)
 
-在编辑器选择接口选项卡，右键添加一个接口（在文档里面我用test为UUID）
+在编辑器选择接口选项卡，右键添加一个接口  
+内容是软路由地址
 
-![图片](pic_code/builder1.png)
+![图片](pic/pic2.png)
 
 右键接口编辑即可修改代码
 
-![图片](pic_code/builder2.png)
+![图片](pic/pic7.png)
 
-其他都相同
+其他类型基本都相同  
+`网页`和`class`类型在修改代码后需要点击更新才能保存代码更改
 
 如果你不想用自带的代码编辑器，可以用其他编辑器打开`CodeTemp`文件夹

doc/code.md

@@ -1,8 +1,69 @@
 # ColoryrServer
-
 ## 业务代码编写
 [返回](../README.md)
 
-默认的账户密码均为`Admin`
+**默认的账户密码均为`Admin`**
+
+[接口代码编写](./code/http.md)
+
+[类代码编写](./code/class.md)
+
+[Socket代码编写](./code/socket.md)
+
+[机器人代码编写](./code/robot.md)
+
+[WebSocket代码编写](./code/websocket.md)
+
+[Mqtt代码编写](./code/mqtt.md)
+
+[Task代码编写](./code/task.md)
+
+[网页代码编写](./code/web.md)
+
+## 软路由
+
+`接口`和`网页`类型需要注意软路由路径  
+例如你的UUID设置为`WebApi/test`，则访问地址为
+```
+{服务器基地址}/WebApi/test
+```
+
+## 服务器SDK
+
+服务器提供了一些重复使用的方法[ColoryrSDK](../src/ColoryrServer/Core/SDK/ColoryrSDK.cs)
+
+数据库包装方法[DatabaseSDK](../src/ColoryrServer/Core/SDK/DatabaseSDK.cs)
+
+HttpClient包装方法[HtmlSDK](../src/ColoryrServer/Core/SDK/HtmlSDK.cs)
+
+Mqtt包装方法[MqttSDK](../src/ColoryrServer/Core/SDK/MqttSDK.cs)
+
+机器人数据包[RobotSDK](../src/ColoryrServer/Core/SDK/RobotSDK.cs)
+
+任务包装方法[TaskSDK](../src/ColoryrServer/Core/SDK/TaskSDK.cs)
+
+Web资源包装方法[WebHtmlSDK](../src/ColoryrServer/Core/SDK/WebHtmlSDK.cs)
+
+## Vue项目构建
+Vue项目构建会执行指令
+```
+$ npm run build
+```
+因此需要nodejs运行环境，并且配置好环境变量才能正常编译
+
+`node_modules`需要手动准备  
+在文件夹`ColoryrServer/Codes/Static`下有一个`node_modules`文件夹，里面装的是Vue编译需要的库
+
+如果你只使用框架自带的Vue项目
+按照下面步骤做即可
+1. 安装nodejs配置环境变量
+2. 新建一个Vue项目
+3. 在Vue项目文件夹下打开命令行输入
+```
+$ npm i
+```
+4. 结束后剪切`node_modules`文件夹到`ColoryrServer/Codes/Static`中去
 
-## [接口代码编写](http.md)
+注意：如果你使用自己的Vue项目要配置好路径
+例如你的`网页项目`的UUID为`Web/test`，则需要在`vite.config.ts`或其他配置文件设置输出路径为`./Web/test/`
+如果不设置会无法正确找到文件

doc/code/class.md

@@ -0,0 +1,29 @@
+# ColoryrServer
+
+## 类代码编写
+[返回](code.md)
+
+默认的类代码  
+
+```C#
+using ColoryrServer.SDK;
+
+[DLLIN]
+public class test
+{
+    public test()
+    {
+             
+    }
+
+    public string getString(string data)
+    {
+        return data + "test";
+    }
+}
+```
+
+每个类代码**至少有一个类必须**带有[ColoryrServer.SDK.DLLIN](../../src/ColoryrServer/Core/SDK/NotesSDK.cs#L21)的属性 
+
+类代码没有太多限制，也支持多文件  
+只要注意类名不要冲突即可

doc/code/http.md

@@ -0,0 +1,145 @@
+# ColoryrServer
+
+## 接口代码编写
+[返回](code.md)
+
+默认的接口代码  
+```C#
+using ColoryrServer.SDK;
+
+[DLLIN(true)]//true则报错输出至网页
+public class app_FD578CDE687FD183ED8E321C7A1ACEC25BDAF9CF
+{
+    [NotesSDK("一个接口", new string[1]{ "输入" }, new string[1]{ "输出" })]
+    public dynamic Main(HttpDllRequest http)
+    {  
+        return "true";
+    }
+}
+```
+
+该代码中包含一个[接口类](#接口类)和一个[接口函数](#接口函数)
+
+## 接口函数
+一个标准的接口函数  
+在[接口类](#接口类)中，所有的`public`函数都为接口函数
+```C#
+[NotesSDK("一个接口", new string[1]{ "输入" }, new string[1]{ "输出" })]
+public dynamic Main(HttpDllRequest http)
+{  
+    return "true";
+}
+```
+接口函数输入的参数**必须**是[ColoryrServer.SDK.HttpDllRequest](../../src/ColoryrServer/Core/SDK/WebApiSDK.cs#L8)  
+并且**必须**带有[ColoryrServer.SDK.NotesSDK](../../src/ColoryrServer/Core/SDK/NotesSDK.cs#L6)的属性
+
+## 接口类
+**必须**带有[ColoryrServer.SDK.DLLIN](../../src/ColoryrServer/Core/SDK/NotesSDK.cs#L21)的属性  
+`DLLIN`中可以设置报错是否输出到网页中去
+
+一个接口类**必须**包含名字为`Main`的[接口函数](#接口函数)  
+不是叫`Main`的[接口函数](#接口函数)都为识别为[子接口](#子接口)  
+
+接口类**必须**是`public`否则将无法调用  
+
+接口类的请求地址为
+```
+http://{服务器基地址}/{UUID}
+``` 
+例如你的接口UUID为`WebApi/test`，默认配置文件的情况下，则默认的URL地址为  
+```
+http://127.0.0.1/WebApi/test
+```
+
+## 子接口
+一个接口类里面可以有多个子接口  
+子接口的请求地址为
+```
+http://{服务器基地址}/{UUID}/{name}
+```  
+例如下面的代码
+```C#
+using ColoryrServer.SDK;
+
+[DLLIN(true)]
+public class app_FD578CDE687FD183ED8E321C7A1ACEC25BDAF9CF
+{
+    [NotesSDK("主接口", new string[1]{ "输入" }, new string[1]{ "输出" })]
+    public dynamic Main(HttpDllRequest http)
+    {  
+        return "true";
+    }
+    [NotesSDK("子接口", new string[1]{ "输入" }, new string[1]{ "输出" })]
+    public dynamic push(HttpDllRequest http)
+    {  
+        return "ok";
+    }
+}
+```
+请求
+```
+http://127.0.0.1:25555/WebApi/test
+```
+后返回的数据为
+```
+test
+```
+请求
+```
+http://127.0.0.1:25555/WebApi/test/push
+```
+后返回的数据为
+```
+ok
+```
+
+### 接口请求参数
+接口函数传入的对象为[ColoryrServer.SDK.HttpDllRequest](../../src/ColoryrServer/Core/SDK/WebApiSDK.cs#L8)  
+```C#
+public class HttpDllRequest
+{
+    /// <summary>
+    /// 请求参数
+    /// </summary>
+    public Dictionary<string, dynamic> Parameter { get; init; }
+    /// <summary>
+    /// 请求头
+    /// </summary>
+    public NameValueCollection RowRequest { get; init; }
+    /// <summary>
+    /// Cookie
+    /// </summary>
+    public Dictionary<string, List<string>> Cookie { get; init; }
+    /// <summary>
+    /// 请求体类型
+    /// </summary>
+    public MyContentType ContentType { get; init; }
+    /// <summary>
+    /// 请求体流
+    /// </summary>
+    public Stream Stream { get; init; }
+    /// <summary>
+    /// 请求方法
+    /// </summary>
+    public string Method { get; init; }
+
+    /// <summary>
+    /// 获取请求数据
+    /// </summary>
+    /// <param name="arg">参数名</param>
+    /// <returns>返回</returns>
+    public dynamic Get(string arg)
+        => Parameter.ContainsKey(arg) ? Parameter[arg] : null;
+}
+```
+### 接口返回类型
+接口可以返回的类型可以是
+- string
+- Dictionary<string, object>
+- [ColoryrServer.SDK.HttpResponseString](../../src/ColoryrServer/Core/SDK/WebApiSDK.cs#L68)
+- [ColoryrServer.SDK.HttpResponseDictionary](../../src/ColoryrServer/Core/SDK/WebApiSDK.cs#L90)
+- [ColoryrServer.SDK.HttpResponseStream](../../src/ColoryrServer/Core/SDK/WebApiSDK.cs#L123)
+- [ColoryrServer.SDK.HttpResponseBytes](../../src/ColoryrServer/Core/SDK/WebApiSDK.cs#L139)
+
+其他返回类型均会报错
+

doc/code/mqtt.md

@@ -0,0 +1,45 @@
+# ColoryrServer
+
+## Mqtt代码编写
+[返回](code.md)
+
+默认的Mqtt代码  
+
+```C#
+using ColoryrServer.SDK;
+
+[DLLIN]
+public class test
+{
+    public bool OnMessage(DllMqttMessage head)
+    {
+        return false; //true表示事件已处理完毕
+    }
+    public bool OnMessageLoading(DllMqttLoadingRetainedMessages head)
+    {
+        return false;
+    }
+    public bool OnValidator(DllMqttConnectionValidator head)
+    {
+        return false;
+    }
+    public bool OnSubscription(DllMqttSubscription head)
+    {
+        return false;
+    }
+    public bool OnUnsubscription(DllMqttUnsubscription head)
+    {
+        return false;
+    }
+}
+```
+
+类**必须**带有[ColoryrServer.SDK.DLLIN](../../src/ColoryrServer/Core/SDK/NotesSDK.cs#L21)的属性 
+
+- `OnMessage`表示收到消息
+- `OnMessageLoading`表示消息正在加载
+- `OnValidator`表示有客户端正在验证链接
+- `OnSubscription`表示有客户端正在订阅频道
+- `OnUnsubscription`表示有客户端正在取消订阅频道
+
+返回如果为true，则这个事件不会传到下个Dll中去

doc/code/robot.md

@@ -0,0 +1,35 @@
+# ColoryrServer
+
+## 机器人代码编写
+[返回](code.md)
+
+默认的机器人代码  
+
+```C#
+using ColoryrServer.SDK;
+
+[DLLIN]
+public class test
+{
+    public bool OnMessage(RobotMessage head)
+    {
+        return false; //true表示事件已处理完毕
+    }
+    public bool OnMessagSend(RobotSend head)
+    {
+        return false;
+    }
+    public bool OnRobotEvent(RobotEvent head)
+    {
+        return false;
+    }
+}
+```
+
+类**必须**带有[ColoryrServer.SDK.DLLIN](../../src/ColoryrServer/Core/SDK/NotesSDK.cs#L21)的属性 
+
+- `OnMessage`表示收到消息
+- `OnMessagSend`表示机器人发送消息后
+- `OnRobotEvent`表示收到其他事件后，需要在服务器配置中添加
+
+返回如果为true，则这个事件不会传到下个Dll中去