From d76fabb8de03de78221c55f2b386dcaff0fe982f Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Fri, 27 Jun 2025 09:45:15 +0000 Subject: [PATCH] Update README.md --- README.md | 227 +++++++++++++----------------------------------------- 1 file changed, 55 insertions(+), 172 deletions(-) diff --git a/README.md b/README.md index 3cb1045..b6ec48d 100644 --- a/README.md +++ b/README.md @@ -1,187 +1,70 @@ -# LingYan_ASPFramework - -#### 介绍 -适用于Asp.Net Core的后端框架 - -#### 使用说明 -1、模块化注入，模块内类应当继承BaseModule，此抽象类有三种形式 -BaseModule类型 -``` -public class Program -{ - public static void Main(string[] args) - { - var builder = WebApplication.CreateBuilder(args); - - //此扩展方法自动注入各模块及各模块方法及特性注入 - builder.AppRegisterProjectModule(); - - var app = builder.Build(); - - //此扩展方法自动初始化各模块及各模块初始化方法 - app.AppInitializationProjectModule(); - - app.Run(); - } -} -``` - -#### 模块化基类 -模块内应当有一个基类继承BaseModule，此抽象类有三种形式 -##### BaseModule -``` - public class RESTApiModule : BaseModule - { - //此属性为模块注入加载顺序可不重写让其默认即可，如有特殊需求可重写规范加载顺序 - public override int PageIndex { get; set; } = 5; - - //此方法可扩展服务注册 - public override void ARegisterModule(WebApplicationBuilder webBuilder) - { - throw new NotImplementedException(); - } - - //此方法可扩展应用初始化 - public override void BInitializationModule(WebApplication webApp) - { - throw new NotImplementedException(); - } - } -``` -##### BaseModule -``` - public class RESTApiModule : BaseModule - { - //此属性为模块注入加载顺序可不重写让其默认即可，如有特殊需求可重写规范加载顺序 - public override int PageIndex { get; set; } = 5; - - //此方法可扩展服务注册 - public override void ARegisterModule(IServiceCollection services) - { - throw new NotImplementedException(); - } - //此方法可扩展应用初始化 - public override void BInitializationModule(IServiceProvider provider) - { - throw new NotImplementedException(); - } - } -``` -##### BaseModule -``` - public class RESTApiModule : BaseModule - { - //此属性为模块注入加载顺序可不重写让其默认即可，如有特殊需求可重写规范加载顺序 - public override int PageIndex { get; set; } = 5; - - //此方法可扩展服务注册 - public override void ARegisterModule(IServiceCollection services, IConfigurationManager configuration) - { - throw new NotImplementedException(); - } - - //此方法可扩展应用初始化 - public override void BInitializationModule(IServiceProvider provider) - { - throw new NotImplementedException(); - } - } -``` -#### 特性自动注册 -##### LYTServiceAttribute服务特性 -``` -namespace LingTest.TestProvider -{ - //该特性只需要打在服务类上，传入接口类型即可，框架会在启动时自动注入 - [LYTService(typeof(ITestService))] - public class TestService : ITestService - { - public ResponceBody TestBack() - { - return new ResponceBody(20000, "测试返回"); - } - } -} -``` -##### LYInstanceAttribute实例特性 +# LingYan_ASPFramework -``` -namespace LingTest.Helper +## 介绍 +LingYan_ASPFramework 是一个用于构建 ASP.NET Core 应用程序的框架，支持模块化架构、特性自动注册、动态路由、权限处理、全局过滤、仓储模式和工作单元模式。它旨在提高开发效率并简化常见的开发任务，如数据库操作、服务注册和请求处理。 + +## 使用说明 +### 模块化基类 +框架提供了多种模块化基类来支持应用程序的不同部分，包括： +- `BaseModule` +- `BaseModule` +- `BaseModule` + +这些基类允许开发者以统一和可扩展的方式注册服务和初始化模块。 + +### 特性自动注册 +框架支持通过特性自动注册服务和组件，这些特性包括： +- **`LYTServiceAttribute`**: 用于标记服务类，实现自动服务注册。 +- **`LYInstanceAttribute`**: 用于标记需要注册为实例的类。 +- **`LYDynamicRouteAttribute`**: 用于支持动态路由的控制器类。 +- **`LYAuthorizeHandlerAttribute`**: 用于权限处理类。 +- **`LYGlobalFilterAttribute`**: 用于标记全局过滤器。 +- **`LYManagerAttribute`**: 用于领域管理类。 +- **`LYMiddlewareAttribute`**: 用于中间件类。 +- **`LYDbContextAttribute`**: 用于数据库上下文类。 + +这些特性简化了服务、路由和过滤器的注册过程，使得代码更加整洁和易维护。 + +### 仓储与工作单元 +框架内置了仓储模式 (`IRepository`) 和工作单元模式 (`IUnitOfWork`) 来统一管理数据访问逻辑。这些接口支持同步和异步操作，包括： +- 查询操作 (`GetAll`, `GetPagedList`) +- 插入、更新和删除 (`Insert`, `Update`, `Delete`) +- 聚合操作 (`Count`, `Sum`, `Average`) +- 事务管理 (`SaveChanges`, `SaveChangesAsync`) + +仓储模式支持多种数据库操作，如 SQL Server、MySQL 和 PostgreSQL，并且可以通过特性 (`LYDbContextAttribute`) 进行自定义配置。 + +## 安装与配置 +要使用此框架，请确保您的项目已安装 .NET Core SDK 并支持 C# 9.0 或更高版本。然后，将框架引用到您的项目中，并根据需求注册模块和数据库上下文。 + +## 示例代码 +```csharp +// 示例：服务注册 +[LYTService(typeof(ITestService))] +public class TestService : ITestService { - //实例特性，无需任何传参，注册案例 - [LYInstance] - public class TestHelper + public ResponceBody TestBack() { - public void TestInstance() - { - - } + return new ResponceBody("Test successful", 200); } } -``` -##### LYDynamicRouteAttribute动态路由特性 -``` -namespace LingTest.DynamicRoute +// 示例：动态路由控制器 +[LYDynamicRoute] +public class TestDynamicRoute : BaseDynamicRoute { - //动态路由原则上只需要在类上添加[LYDynamicRoute]特性即可 - //BaseDynamicRoute只是继承ControllerBase，可以更方便的使用OK(),NotFound()等种序列化方法 - //动态路由的HTTP类型可以在配置文件中的./Envs/Configs/HttpMethod.json配置,也可以直接打赏路由类型特性 - [LYDynamicRoute] - public class TestDynamicRoute : BaseDynamicRoute + [HttpGet] + public IActionResult TestGet() { - public IActionResult TestPost() - { - return Ok("返回值"); - } - [HttpGet] - public IActionResult TestGet() - { - return Ok("返回值"); - } + return Ok("Dynamic route accessed via GET"); } } ``` -##### LYAuthorizeHandlerAttribute权限处理器特性 -##### LYGlobalFilterAttribute全局过滤器特性 -##### LYManagerAttribute领域管理特性 -##### LYMiddlewareAttribute中间件特性 -##### LYDbContextAttribute数据库上下文特性 -#### 仓储与工作单元 -仓储与工作单元已自动注入，可在任何地方引入。 -##### 仓储注入引用 +## 许可证 +本项目采用 MIT 许可证。详情请查看 LICENSE 文件。 -``` - [LYManager] - public class UserManager - { - public UserManager(IRepository userRepo, - IRepository userTeamRepo, - IRepository userTeamMemborRepo, - IRepository userFileRepo) - { - UserRepo = userRepo; - TeamRepo = userTeamRepo; - TeamMemborRepo = userTeamMemborRepo; - UserFileRepo = userFileRepo; - - } - public IRepository UserRepo { get; } - public IRepository TeamRepo { get; } - public IRepository TeamMemborRepo { get; } - public IRepository UserFileRepo { get; } - - - public async Task Queryuser(long userId) - { - return await this.UserRepo.GetFirstOrDefaultAsync(predicate: p => p.Id == userId && p.IsDeleted == false); - } - public async Task Queryuser(string userPhone) - { - return await this.UserRepo.GetFirstOrDefaultAsync(predicate: p => p.UserPhone == userPhone && p.IsDeleted == false); - } -} -``` \ No newline at end of file +## 贡献 +欢迎贡献！如果您有任何想法或改进，请提交 Pull Request 或创建 Issue。 \ No newline at end of file -- Gitee