URF.NET 项目使用教程

URF.NET 项目使用教程

1. 项目目录结构及介绍

URF.NET 项目的目录结构如下：

URF.NET/
├── .github/
│   └── workflows/
├── src/
│   ├── URF.Core/
│   │   ├── Abstractions/
│   │   ├── Data/
│   │   ├── EntityFrameworkCore/
│   │   └── Trackable/
│   ├── URF.Demo/
│   │   ├── URF.Demo.Core/
│   │   ├── URF.Demo.Data/
│   │   ├── URF.Demo.Service/
│   │   └── URF.Demo.Web/
│   └── URF.Tests/
│       ├── URF.Core.Tests/
│       └── URF.Demo.Tests/
├── .gitignore
├── LICENSE
├── README.md
└── URF.sln

目录结构介绍

• .github/workflows/：包含 GitHub Actions 的工作流配置文件。
• src/URF.Core/：URF.NET 的核心库，包含抽象层、数据层、Entity Framework Core 支持以及可追踪实体的支持。
• src/URF.Demo/：URF.NET 的演示项目，包含核心逻辑、数据访问、服务层和 Web 应用。
• src/URF.Tests/：URF.NET 的测试项目，包含核心库和演示项目的单元测试。
• .gitignore：Git 忽略文件配置。
• LICENSE：项目许可证文件。
• README.md：项目说明文件。
• URF.sln：Visual Studio 解决方案文件。

2. 项目启动文件介绍

在 URF.NET 项目中，启动文件通常位于 src/URF.Demo/URF.Demo.Web/ 目录下。主要的启动文件是 Startup.cs，它负责配置应用程序的服务和中间件。

Startup.cs 文件介绍

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // 注册服务
        services.AddControllers();
        services.AddDbContext<NorthwindContext>(options =>
            options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")));
        services.AddScoped<IUnitOfWorkAsync, UnitOfWork>();
        services.AddScoped<ICustomerService, CustomerService>();
        // 其他服务注册
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        app.UseRouting();
        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
        });
    }
}

启动文件功能

• ConfigureServices：配置应用程序的服务，如数据库上下文、工作单元、服务等。
• Configure：配置应用程序的中间件，如路由、异常处理等。

3. 项目的配置文件介绍

URF.NET 项目的配置文件主要位于 src/URF.Demo/URF.Demo.Web/ 目录下，通常是 appsettings.json 文件。

appsettings.json 文件介绍

{
  "ConnectionStrings": {
    "DefaultConnection": "Server=.;Database=Northwind;Trusted_Connection=True;"
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*"
}

配置文件功能

• ConnectionStrings：数据库连接字符串配置。
• Logging：日志级别配置。
• AllowedHosts：允许访问的主机配置。

通过以上配置，可以轻松启动和配置 URF.NET 项目。