mirror of
https://gitee.com/dotnetchina/OpenAuth.Net.git
synced 2025-09-20 10:37:55 +08:00
docs: 更新文档
This commit is contained in:
@@ -48,11 +48,11 @@ stop
|
|||||||
|
|
||||||
流程模板指流程的定义。数据存放在FlowScheme表中,该表核心字段如下:
|
流程模板指流程的定义。数据存放在FlowScheme表中,该表核心字段如下:
|
||||||
|
|
||||||
#### FrmId:流程模版关联的表单id
|
### FrmId:流程模版关联的表单id
|
||||||
|
|
||||||
#### FrmType:表单类型
|
### FrmType:表单类型
|
||||||
|
|
||||||
#### SchemeContent:流程实例的具体内容
|
### SchemeContent:流程实例的具体内容
|
||||||
|
|
||||||
该字段存储的是一个JSON对象,具体内容如下所示:
|
该字段存储的是一个JSON对象,具体内容如下所示:
|
||||||
|
|
||||||
@@ -120,8 +120,9 @@ stop
|
|||||||
```
|
```
|
||||||
其中:nodes为流程实例的所有节点。lines为流程实例的所有连线。节点属性如下:
|
其中:nodes为流程实例的所有节点。lines为流程实例的所有连线。节点属性如下:
|
||||||
|
|
||||||
|
### 节点属性
|
||||||
|
|
||||||
###### 基础属性
|
#### 基础属性
|
||||||
|
|
||||||
| 属性名 | 类型 | 说明 | 可选值 |
|
| 属性名 | 类型 | 说明 | 可选值 |
|
||||||
|--------|------|------|---------|
|
|--------|------|------|---------|
|
||||||
@@ -131,22 +132,22 @@ stop
|
|||||||
| belongto | 字符串 | 节点样式类型 | - |
|
| belongto | 字符串 | 节点样式类型 | - |
|
||||||
| id | 字符串 | 节点id | - |
|
| id | 字符串 | 节点id | - |
|
||||||
|
|
||||||
###### 配置信息(setInfo)
|
#### 配置信息(setInfo)
|
||||||
|
|
||||||
####### 节点驳回配置
|
##### 节点驳回配置
|
||||||
|
|
||||||
| 属性名 | 类型 | 说明 | 可选值 |
|
| 属性名 | 类型 | 说明 | 可选值 |
|
||||||
|--------|------|------|---------|
|
|--------|------|------|---------|
|
||||||
| NodeRejectType | 数字 | 节点驳回类型 | 0:前一步<br>1:第一步<br>2:指定节点 |
|
| NodeRejectType | 数字 | 节点驳回类型 | 0:前一步<br>1:第一步<br>2:指定节点 |
|
||||||
| NodeRejectStep | 字符串 | 驳回节点id | 当NodeRejectType=2时使用 |
|
| NodeRejectStep | 字符串 | 驳回节点id | 当NodeRejectType=2时使用 |
|
||||||
|
|
||||||
###### 节点会签/网关配置
|
##### 节点会签/网关配置
|
||||||
|
|
||||||
| 属性名 | 类型 | 说明 | 可选值 |
|
| 属性名 | 类型 | 说明 | 可选值 |
|
||||||
|--------|------|------|---------|
|
|--------|------|------|---------|
|
||||||
| NodeConfluenceType | 字符串 | 节点会签/网关类型 | sequential:顺序<br>all:全部通过<br>one:至少一个通过 |
|
| NodeConfluenceType | 字符串 | 节点会签/网关类型 | sequential:顺序<br>all:全部通过<br>one:至少一个通过 |
|
||||||
|
|
||||||
###### 执行权限配置
|
##### 执行权限配置
|
||||||
|
|
||||||
| 属性名 | 类型 | 说明 | 可选值 |
|
| 属性名 | 类型 | 说明 | 可选值 |
|
||||||
|--------|------|------|---------|
|
|--------|------|------|---------|
|
||||||
@@ -155,7 +156,7 @@ stop
|
|||||||
| NodeDesignateData.datas | 数组 | 执行权限数据 | - |
|
| NodeDesignateData.datas | 数组 | 执行权限数据 | - |
|
||||||
| NodeDesignateData.Texts | 字符串 | 执行权限数据 | - |
|
| NodeDesignateData.Texts | 字符串 | 执行权限数据 | - |
|
||||||
|
|
||||||
###### 其他配置
|
##### 其他配置
|
||||||
|
|
||||||
| 属性名 | 类型 | 说明 |
|
| 属性名 | 类型 | 说明 |
|
||||||
|--------|------|------|
|
|--------|------|------|
|
||||||
@@ -167,7 +168,7 @@ stop
|
|||||||
|
|
||||||
流程实例指正在运行的一个流程。数据存放在FlowInstance表中,该表核心字段如下:
|
流程实例指正在运行的一个流程。数据存放在FlowInstance表中,该表核心字段如下:
|
||||||
|
|
||||||
#### IsFinish:流程的当前状态
|
### IsFinish:流程的当前状态
|
||||||
|
|
||||||
- -1 草稿/召回:流程发起人主动召回流程;
|
- -1 草稿/召回:流程发起人主动召回流程;
|
||||||
|
|
||||||
@@ -180,12 +181,12 @@ stop
|
|||||||
- 4 驳回:流程结束,可能发起的流程内容有问题,要求被驳回重新提交;
|
- 4 驳回:流程结束,可能发起的流程内容有问题,要求被驳回重新提交;
|
||||||
|
|
||||||
|
|
||||||
#### ActivityId: 当前活动节点,即待审批的节点
|
### ActivityId: 当前活动节点,即待审批的节点
|
||||||
|
|
||||||
与流程实例密切相关的还有两个表:流程实例的操作记录FlowInstanceOperationHistory及流转记录FlowInstanceTransitionHistory。它们有不同的作用:
|
与流程实例密切相关的还有两个表:流程实例的操作记录FlowInstanceOperationHistory及流转记录FlowInstanceTransitionHistory。它们有不同的作用:
|
||||||
|
|
||||||
### 操作记录FlowInstanceOperationHistory
|
## 操作记录FlowInstanceOperationHistory
|
||||||
该表记录了流程实例的所有操作记录,包括流程的创建、撤回、驳回、同意、不同意等操作。
|
该表记录了流程实例的所有操作记录,包括流程的创建、撤回、驳回、同意、不同意等操作。
|
||||||
|
|
||||||
### 流转记录FlowInstanceTransitionHistory
|
## 流转记录FlowInstanceTransitionHistory
|
||||||
记录某个流程实例所有已审批的从一个活动节点到下一个活动节点的操作人、操作时间。
|
记录某个流程实例所有已审批的从一个活动节点到下一个活动节点的操作人、操作时间。
|
||||||
|
@@ -4,6 +4,32 @@ createTime: 2025/04/23 21:03:10
|
|||||||
permalink: /core/specialist/
|
permalink: /core/specialist/
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## 新增功能文件结构
|
||||||
|
|
||||||
|
如果新增功能时,尽量按框架原有文件结构。比如新增仓库功能,实体名Stock,则:
|
||||||
|
::: file-tree
|
||||||
|
- OpenAuth.WebApi
|
||||||
|
- Controllers
|
||||||
|
- StocksController.cs // WebApi控制器
|
||||||
|
- OpenAuth.Mvc
|
||||||
|
- Controllers
|
||||||
|
- StocksController.cs // MVC控制器
|
||||||
|
- Views
|
||||||
|
- Stocks
|
||||||
|
- index.cshtml // MVC视图
|
||||||
|
- wwwroot
|
||||||
|
- userJs
|
||||||
|
- stock.js // 业务脚本
|
||||||
|
- OpenAuth.App
|
||||||
|
- StockApp.cs // 应用层
|
||||||
|
- Request
|
||||||
|
- QueryStockReq.cs // 请求参数
|
||||||
|
- OpenAuth.Repository
|
||||||
|
- OpenAuthDBContext.cs // EF数据库上下文
|
||||||
|
- Domain
|
||||||
|
- Stock.cs // 实体
|
||||||
|
:::
|
||||||
|
|
||||||
## 数据库表及字段命名
|
## 数据库表及字段命名
|
||||||
|
|
||||||
SqlServer采用PascalCase命名,Oracle采用全大写命名,其他数据库采用camelCase命名。
|
SqlServer采用PascalCase命名,Oracle采用全大写命名,其他数据库采用camelCase命名。
|
||||||
@@ -20,11 +46,50 @@ SqlServer采用PascalCase命名,Oracle采用全大写命名,其他数据库
|
|||||||
|
|
||||||
## 数据库字段类型
|
## 数据库字段类型
|
||||||
|
|
||||||
主键id统一使用Domain:PrimaryKey(针对SqlServer数据库,非Sql Server根据需要定义)
|
### SqlServer
|
||||||
|
|
||||||
状态类,标识类的字段,统一使用bit not null
|
* 主键统一命名为Id,类型为Domain:PrimaryKey,方便统一修改主键类型。
|
||||||
|
|
||||||
表示分类的字段,统一使用PrimaryKey。数值从Category中获取。
|
* 状态类,标识类的字段,统一使用bit not null
|
||||||
|
|
||||||
|
* 表示分类的字段,统一使用PrimaryKey,数值从Category中获取
|
||||||
|
|
||||||
|
### Mysql
|
||||||
|
|
||||||
|
* 主键统一命名为id,类型varchar(50)
|
||||||
|
|
||||||
|
* 状态类,标识类的字段,统一使用tinyint(4) NOT NULL
|
||||||
|
|
||||||
|
### Oracle
|
||||||
|
|
||||||
|
* 主键统一命名为ID,类型为varchar2(50)
|
||||||
|
|
||||||
|
* 状态类,标识类的字段,统一使用NUMBER(4,0) NOT NULL
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## 代码注释
|
||||||
|
|
||||||
|
所有的实体属性都会有2个注释:
|
||||||
|
|
||||||
|
* summary: 用于编写代码时,IDE提示
|
||||||
|
|
||||||
|
* Description: 用于Swagger接口文档
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
/// <summary>
|
||||||
|
/// 应用
|
||||||
|
/// </summary>
|
||||||
|
[Table("Application")]
|
||||||
|
public partial class Application : StringEntity
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// 应用名称
|
||||||
|
/// </summary>
|
||||||
|
[Description("应用名称")]
|
||||||
|
public string Name { get; set; }
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user