docs: 完善sqlsugar文档

This commit is contained in:
yubaolee
2025-05-08 14:54:03 +08:00
parent 6ae0c4b9b2
commit 6ef7c91896
4 changed files with 156 additions and 121 deletions

View File

@@ -74,3 +74,45 @@ public class ResourceApp:SqlSugarBaseApp<Resource>
}
```
## 事务
SqlSugar提供了强大的事务功能在OpenAuth.Net中只需要在业务开始时调用`SugarClient.Ado.BeginTran()`开启事务,在业务结束时,调用`SugarClient.Ado.CommitTran()`提交事务,即可使用事务。
比如一个复杂的主从表业务无论中间过程使用的是SugarClient还是Repository都可以用这种方式来实现事务
```csharp
SugarClient.Ado.BeginTran();
// 更新从表中的字段
if (obj.SubTableReqs != null && obj.SubTableReqs.Any())
{
//id为空时添加
foreach (var detail in obj.SubTableReqs.Where(u => string.IsNullOrEmpty(u.Id)))
{
_subTableApp.Add(detail);
}
//id比数据库少的删除
var containids = obj.SubTableReqs.Select(u => u.Id)
.Where(u => !string.IsNullOrEmpty(u)).ToList();
if (containids.Any())
{
SugarClient.Deleteable<SubTable>(u => !containids.Contains(u.Id) && u.MainTableId == obj.Id).ExecuteCommand();
}
//更新id相同的
foreach (var detail in obj.SubTableReqs.Where(u => !string.IsNullOrEmpty(u.Id)))
{
_subTableApp.Update(detail);
}
}
// 更新主表中的字段
Repository.Update(u => new MainTable
{
NeedUpdateField = obj.NeedUpdateField,
//todo:补充或调整自己需要的字段
}, u => u.Id == obj.Id);
SugarClient.Ado.CommitTran();
```

View File

@@ -4,59 +4,86 @@ createTime: 2025/04/23 23:43:26
permalink: /pro/printerplan/
---
OpenAuth.Pro提供灵活无代码可能需要写SQL)的打印解决方案,无需开发人员参与即可配置自己需要的打印
OpenAuth.Pro提供强大且灵活的低代码打印方案,企业用户仅需进行简单配置(可能需要写SQL查询)即可实现个性化打印需求,无需开发人员参与即可快速部署各类打印模板
打印模板设计界面如下:
## 系统界面展示
### 打印模板设计界面
专业的设计工作台,支持拖拽式操作与精确配置:
![sysprinterplan](http://img.openauth.net.cn/sysprinterplan.png)
挂载到业务系统效果
### 业务系统集成效果
无缝集成到各类业务功能模块中:
![20231002114914](http://img.openauth.net.cn/20231002114914.png)
## 使用指南
## 详细使用指南
### 设计打印模版
### 创建与设计打印模版
在打印中心-打印模版功能新增打印模版。设计界面说明如下:
打印中心】-【打印模版功能新增打印模版。设计界面布局如下:
![20231004165652](http://img.openauth.net.cn/20231004165652.png)
左边为设计工具栏,中间为画布,右边为属性框。可以根据自己需要调整打印界面。
界面分为三大区域:
- 左侧:设计工具栏,提供各类控件与格式设置工具
- 中间:设计画布,实时预览打印效果
- 右侧:属性配置区,精确调整各元素参数与样式
### 设置数据源
用户可根据实际需求,通过拖拽与配置快速构建专业打印模板。
打印模版的核心是设计数据源。用户通过设计数据源,实现无开发打印。如下:
### 配置数据源
数据源是打印模版的核心,通过合理设计数据源,实现真正的低代码打印解决方案:
![20231004165939](http://img.openauth.net.cn/20231004165939.png)
1. 数据源:用于查询打印打印数据。
2. Id:由数据源中的SQL自动生成的参数文本框。
3. 分组字段:如果配置了`分组字段`,则默认对应列表式打印模版。否则,可以看做卡片式。
关键配置项说明:
* 【卡片式】用于打印一页只有一条数据的情况。比如快递的标签、用户名片等。
1. **数据源**用于查询打印数据的SQL语句支持复杂查询与条件筛选
2. **Id参数**系统根据数据源SQL自动生成的参数文本框用于动态传递查询条件
3. **分组字段**:决定打印模版的类型与数据结构处理方式
- 配置分组字段:生成列表式打印模版(一对多数据结构)
- 不配置分组字段:生成卡片式打印模版(单条数据记录)
### 打印模式类型说明
系统支持两种主要打印模式,适应不同业务场景:
* **卡片式打印**:适用于单条记录的打印场景,如快递标签、会员卡、用户名片等
![20231004164125](http://img.openauth.net.cn/20231004164125.png)
* 【列表式】用于打印一页有多条数据的情况,通常是主从结构的表,同时打印主表及从表详情。如客户的发货清单。
![20231004164203](http://img.openauth.net.cn/20231004164203.png)
::: warning 注意
* **列表式打印**:适用于主从结构数据的打印场景,一页包含多条关联数据,如销售订单、发货清单等
![20231004164203](http://img.openauth.net.cn/20231004164203.png)
两种模版类型没有严格的区分。在后端返回相同的数据情况下,如果配置了`分组字段`后端返回的数据会被转化成主从结构。上图即为官网【入库随货同行单列表式【带参数】】按OrderId进行分组后的数据。
::: warning 特别说明
两种模版类型在底层处理上存在灵活性。当配置了`分组字段`后端将自动将数据按该字段进行分组转化为主从结构。例如上图展示的【入库随货同行单列表式【带参数】】正是通过按OrderId分组后生成的数据结构。
:::
### 功能模块挂载打印方案
### 打印方案与功能模块关联
制作完打印方案后,在【模块管理】功能里面,把刚刚打印方案与功能关联
打印方案设计后,在【模块管理】功能中将打印方案与业务功能关联,实现功能集成:
![20231004173811](http://img.openauth.net.cn/20231004173811.png)
### 使用打印
### 实际打印操作
最后就可以在功能里面使用打印了。
完成上述配置后,用户可在相应业务功能中直接调用打印方案,实现一键打印:
![20231002114914](http://img.openauth.net.cn/20231002114914.png)
![20231002114914](http://img.openauth.net.cn/20231002114914.png)
## 最佳实践建议
1. 设计数据源时建议先测试SQL查询结果确保数据结构符合预期
2. 打印模板设计时注意适配不同纸张规格,预留适当边距
3. 对于复杂报表,可考虑使用分组字段实现数据的合理组织
4. 利用系统提供的预览功能,及时调整布局与样式