基础框架文档中心

外观

版本日志 ​

v3.2.1 ​

2024/11/20

此版本添加了一些功能。

新增 ​

  1. 工作流：流程新增分类功能，支持按分类查询待办。
  2. 工作流：新增用户工作查询功能，支持按需关联业务数据查询。
  3. 工作流：工作组件支持接收 BizId / WorkId 参数，查看任意工作信息，不限制实际操作人。
  4. 新增SignedOldApiFilterAttribute、SignedPlusApiFilterAttribute特性，支持不同版本的 API 签名认证。
  5. OptionalExpressionBuilder 新增 Where 方法，支持添加固定条件。

修正 ​

  1. 修正 UAC 代理配置不生效问题。
  2. 修正 ApiPlus 认证模式在部分情况下不生效问题。
  3. 修正字典翻译接口无法接收请求体问题。

变更 ​

  1. 工作流：在工作组件查看工作详情时，支持仅传递 WorkId 参数。
  2. 工作流：结束节点任务不再使用当前处理人信息，无需办理。

移除 ​

无

升级指南 ​

  1. 执行v3.2.1.sql。

v3.2.0 ​

2024/10/25

此版本添加了工作流、岗位同步功能，以及一些其它优化。

新增 ​

  1. 新增工作流功能，支持流程定义、任务办理、超时提醒、流程干预等功能。具体请参考框架在线文档。
  2. 新增岗位同步功能。
  3. 用户新增岗位与上下级信息，用户服务支持根据上下级查询。
  4. 新增 AllowedEnvironmentsAttribute 特性，限定接口服务仅在指定环境下可访问。
  5. 新增 OptionalExpressionBuilder 类，提供多个判断方法简化服务层的动态条件生成。
  6. BaseEntity 添加 ClearBaseFields 方法，支持清空实体基础属性。

修正 ​

无

变更 ​

  1. BaseDal 中的 QueryListPage 已调整为公共方法，支持由传入的 Query 参数返回分页结果。
  2. 进一步优化 NAutowired 库，添加 AspectCore 支持，不再依赖 AspectCore.Extensions.DependencyInjection.NAutowired。

移除 ​

无

升级指南 ​

  1. 执行v3.2.0.sql。
  2. 将 Program.cs 中导入的命名空间 AspectCore.Extensions.DependencyInjection.NAutowired，修改为 AspectCore.Extensions.DependencyInjection。
  3. 如果需要使用工作流完整功能
    • 请在 XxlJob 服务端创建 wf-timeout、wf-message 两个任务，触发频率建议分别为 20 分钟、5 分钟。
    • 在配置文件中添加 xxlJob 配置，启用定时任务。
      "xxlJob": {
    "Enable": true,
    "AdminAddresses": "http://服务地址/xxl-job-admin",
    "appName": "执行器名",
    "specialBindUrl": "http://程序地址/xxl-job",
    "specialBindPath": "/xxl-job",
    "autoRegistry": true,
    "accessToken": "",
    "logRetentionDays": 30
  },
    • 在配置文件中添加消息服务配置。
      "Umpp": {
    "Url": "uip地址",
    "AppId": "uip应用",
    "Secret": "uip密钥",
    "QyId": "uhp企业应用",
    "EmailAccountCode": "umpp邮箱码"
  }

v3.1.1 ​

2024/9/12

此版本添加了一些功能。

新增 ​

  1. 新增文件对象存储管理功能，支持文件状态记录、业务绑定、数据查询。
    • 新增BindBizFileAttribute特性，支持声明式的业务数据与文件记录绑定。
    • 新增ResponseBizFileAttribute特性，支持声明式的业务数据已关联的文件记录查询返回。
  2. 新增Xxl-Job任务调度集成，简化配置与开发模式。详情请查看框架在线文档。
    • 新增XxlJobHandler特性，声明任务处理器并注册为 Scoped 服务。
  3. 新增LoginLogAttribute、LogoutLogAttribute特性，支持声明式的登录、登出日志记录。
  4. 新增日志清理功能，支持以多种形式清理系统、用户、登录日志。详情请查看框架在线文档。
  5. UserLogAttribute 特性新增几个参数，支持限定内容长度与忽略请求头或请求体。

修正 ​

无

变更 ​

  1. Swagger 文档地址修改。
  2. About 接口除 version 外，不再支持匿名访问。
  3. 登录日志清理接口不再支持传入时间参数，需要前端 2.2.0+ 版本支持。
  4. NAutowired 库切换为自定义版本，提升性能。

移除 ​

无

升级指南 ​

  1. 执行v3.1.1.sql。
  2. 如果需要启用Xxl-Job功能，请参考框架在线文档进行配置。
  3. 如果需要启用日志自动清理功能，请参考框架在线文档进行配置。

v3.1.0 ​

2024/2/6

此版本重构部分代码，添加了一些新功能。

新增 ​

  1. 新增第三方接口请求响应日志记录功能。
  2. 新增接口配置功能，支持独立设置每个接口的日志启用状态。
  3. 新增系统设置功能，可以进行网络请求等相关参数设置。
  4. 新增登录日志功能，记录登录与登出日志。
  5. 新增在线用户功能，支持在线用户查询与清除。
  6. 新增缓存管理功能，支持缓存数据查询与清除。
  7. 新增彩色日志输出，区分不同级别日志。
  8. 任意级别的日志，当内容以[force]开头时，会写入数据库保存。
  9. 新增ToResult方法，简化控制器响应对象创建方式。具体请参考各控制器方法。
  10. BaseGenericService类中支持排序的方法，新增了对应重载方法，支持传入任意数量的排序字段。
  11. BaseGenericService.GetListPage方法现在可以传入字符串式排序信息，以支持前端页面的自定义排序情况。
  12. 新增WebApiClient引用，支持声明式调用外部Http接口。具体使用方法参考IUacApi相关代码。
  13. Common库新增ValidationHelper，支持手动调用模型验证。
  14. Common库新增IpAddressHelper，支持IP归属地离线查询。

修正 ​

  1. 修正树字典查询时排序不正常问题。
  2. 修正更新时间与创建时间一致性问题。现统一取web服务时间，不再使用数据库时间。
  3. 修正特定情况下AutoMapper执行报错问题。

变更 ​

  1. 代码重构为使用主构造函数注入模式，同时保留[Autowried]注入支持。
  2. 代码重构为使用文件域命名空间（file-scoped namespace）。
  3. 模型层Input、Output、Bo类分别移至独立的命名空间。
  4. 控制器参数错误不再返回500响应。修改为响应码200，错误码999。
  5. Result<T>不再允许忽略Body参数。如有需要请使用非泛型类Result。
  6. ServiceProviderAccessor变更为正式特性，可在请求管道范围内任意位置获取服务容器。
  7. BaseGenericService类中支持两个排序字段的查询方法，标记为已过时。
  8. BaseGenericService类中的分页查询方法，现已不再支持通过特殊参数值查询全量数据。
  9. 默认不再在控制台显示SQL日志，需要时请至系统设置页面开启。
  10. 非超级管理员操作角色时，可操作数据限定在其自身拥有的资源范围内。无法操作他人创建的角色，也无法授权给用户。
  11. 优化部分类名。
    • AbstractRowObjectMapper更改为AbstractDbRowMapper。
    • WrapperBo更改为MultiApiCallResult。
  12. 字典、用户、角色、资源等路由重构为Restfull格式，原路由已标记为过时。
  13. 重构Common库Excel相关类方法。合并至ExcelHelper类，其它类标记为过时。
  14. 调整Common库EPPlus依赖版本，消除潜在的版权问题。

移除 ​

  1. 移除Result<T>类的Success()、Success(msg)重载方法。
  2. 移除HZCC.UAC.Client引用。

升级指南 ​

  1. 执行v3.1.0.sql。
  2. 从HZCC.Frm.Api复制nlog.config文件，覆盖至Api项目根目录。
  3. 按需修正模型类的引用命名空间。

v3.0.0 ​

2023/12/18

此版本升级.NET框架至.NET8，使用C#12语法重构现有代码。同时添加了一些新功能，修复了一些已知问题。

新增 ​

  1. Swagger文档新增签名认证模式，支持基于签名认证的接口在线调用。
  2. 新增OptionalExpression<>类，简化ORM动态条件生成。
  3. BaseGenericService新增Add(object)方法。
  4. DbCommandInterceptor添加sql参数输出。
  5. 新增RequiredIfAttribute特性，支持根据其它属性值决定当前属性是否必填。
  6. 支持低级别日志按需入库（日志内容以[db]开头即可）。
  7. 新增ServiceProviderAccessor类，支持以静态属性获取ServiceProvider。[实验性功能]
  8. 数据维度功能，支持针对树模式的更多配置选项。

修正 ​

  1. 修正用户数据权限不能按条件查询问题。
  2. 修正用户数据权限列表排序混乱问题。
  3. 修正用户无法批量查询问题。
  4. 修正菜单禁用后无法再找回问题。
  5. 修正默认认证策略在特殊情况下重复执行问题。
  6. 修正组织机构同步中潜在的死循环问题。
  7. 修正树字典缓存异常问题。
  8. 修正同时使用新老版本签名认证时，新版本不生效问题。

以上修正已同步至2.6.0+。

变更 ​

  1. DataScopeAttribute、UserLogAttribute类移至Attributes命名空间。
  2. 优化调整了操作日志记录格式。
  3. 优化了swagger接口排序。
  4. 消除部分分页参数PageInfo，由dto继承。
  5. BaseService.Update方法忽略值为default(DateTime)的字段更新。
  6. 增强版签名认证模式名称，由api-plus更名为sign。原api模式标记为过时。

移除 ​

  1. BaseGenericService移除Update(T)方法。
  2. 移除CodeGenerateController控制器。
  3. 移除UserService类无用的GetByEmp、GetListSimple、Update方法。
  4. 移除RoleResService类无用的GetRoleResources方法。

升级指南 ​

  1. 确保项目从基础框架2.7.0版本开始升级。若低于该版本，请先参考各版本升级指南进行升级。(新项目忽略此条)
  2. 更新后端开发工具软件至最新版。
  3. 修改主项目中各csproj文件，更新为<TargetFramework>net8.0</TargetFramework>。
  4. 从HZCC.Frm.Api项目复制nlog.config文件，覆盖至主项目Api项目根目录。
  5. 从本项目根目录复制Dockerfile文件，覆盖至主项目根目录。
  6. 开放接口给第三方调用时，优先使用AuthenticationSchemes = "sign"认证模式。具体算法请查看swagger文档。