.NET Aspire SQL Server Entity Framework Core 통합

아티클
02/14/2025

SQL Server Microsoft에서 개발한 관계형 데이터베이스 관리 시스템입니다. .NET Aspire SQL Server Entity Framework Core 통합을 사용하면 기존 SQL Server 인스턴스에 연결하거나 mcr.microsoft.com/mssql/server 컨테이너 이미지사용하여 .NET 새 인스턴스를 만들 수 있습니다.

호스팅 통합

SQL Server 호스팅 통합은 서버를 SqlServerServerResource 형식으로, 데이터베이스를 SqlServerDatabaseResource 형식으로 모델화합니다. 이러한 형식 및 API에 액세스하려면 📦Aspire.Hosting.SqlServer NuGet 패키지를 앱 호스트 프로젝트에 추가합니다.

.NET CLI
PackageReference

dotnet add package Aspire.Hosting.SqlServer

<PackageReference Include="Aspire.Hosting.SqlServer"
                  Version="*" />

자세한 내용은 dotnet add package 또는 응용프로그램에서 패키지 종속성 관리 .NET.

SQL Server 리소스 및 데이터베이스 리소스 추가

앱 호스트 프로젝트에서 AddSqlServer 호출하여 SQL Server 리소스 작성기를 추가하고 반환합니다. 반환된 리소스 빌더에 체인을 호출하여 AddDatabase에 SQL Server 데이터베이스 리소스를 추가합니다.

var builder = DistributedApplication.CreateBuilder(args);

var sql = builder.AddSqlServer("sql")
                 .WithLifetime(ContainerLifetime.Persistent);

var db = sql.AddDatabase("database");

builder.AddProject<Projects.ExampleProject>()
       .WithReference(db)
       .WaitFor(db);

// After adding all resources, run the app...

메모

SQL Server 컨테이너는 시작 속도가 느리므로 불필요한 다시 시작을 방지하기 위해 영구 수명을 사용하는 것이 가장 좋습니다. 자세한 내용은 컨테이너 리소스 수명참조하세요.

.NET .NET Aspire mcr.microsoft.com/mssql/server 이미지와 함께 이전 예제와 같이 앱 호스트에 컨테이너 이미지를 추가하면 로컬 컴퓨터에 새 SQL Server 인스턴스가 만들어집니다. SQL Server 리소스 작성기(sql 변수)에 대한 참조는 데이터베이스를 추가하는 데 사용됩니다. 데이터베이스의 이름은 database이며, 그 후 ExampleProject에 추가됩니다. SQL Server 리소스에는 sa의 username 및 CreateDefaultPasswordParameter 방법을 사용하여 생성된 임의의 password이 있는 기본 자격 증명이 포함되어 있습니다.

앱 호스트가 실행되면 암호가 앱 호스트의 비밀 저장소에 저장됩니다. 예를 들어 Parameters 섹션에 추가되었습니다.

{
  "Parameters:sql-password": "<THE_GENERATED_PASSWORD>"
}

매개 변수의 이름은 sql-password, 실제로는 리소스 이름에 -password 접미사를 사용하여 서식을 지정하는 것입니다. 자세한 내용은 ASP.NET Core 개발 시 앱 비밀의 안전한 스토리지를 참조하고 매개 변수 SQL Server 리소스 추가를 참조하세요.

WithReference 메서드는 ExampleProject로 명명된 연결 database를 구성합니다.

팁

기존 SQL Server연결하려는 경우 대신 AddConnectionString 호출합니다. 자세한 내용은 기존 리소스 참조를 참조하세요.

데이터 볼륨을 사용하여 SQL Server 리소스 추가

SQL Server 리소스에 데이터 볼륨을 추가하려면 SQL Server 리소스에서 WithDataVolume 메서드를 호출합니다.

var builder = DistributedApplication.CreateBuilder(args);

var sql = builder.AddSqlServer("sql")
                 .WithDataVolume();

var db = sql.AddDatabase("database");

builder.AddProject<Projects.ExampleProject>()
       .WithReference(db)
       .WaitFor(db);

// After adding all resources, run the app...

데이터 볼륨은 컨테이너의 수명 주기 외부에서 SQL Server 데이터를 유지하는 데 사용됩니다. 데이터 볼륨은 SQL Server 컨테이너의 /var/opt/mssql 경로에 탑재되고 name 매개 변수가 제공되지 않으면 이름이 임의로 생성됩니다. 데이터 볼륨에 대한 자세한 내용 및 바인딩 탑재보다 선호하는 이유에 대한 자세한 내용은 Docker 문서: 볼륨참조하세요.

경고

암호는 데이터 볼륨에 저장됩니다. 데이터 볼륨을 사용하는 경우 암호가 변경되면 볼륨을 삭제할 때까지 작동하지 않습니다.

데이터 바인드 마운트를 사용하여 SQL Server 리소스를 추가

SQL Server 리소스에 데이터 바인딩 탑재를 추가하려면 WithDataBindMount 메서드를 호출합니다.

var builder = DistributedApplication.CreateBuilder(args);

var sql = builder.AddSqlServer("sql")
                 .WithDataBindMount(source: @"C:\SqlServer\Data");

var db = sql.AddDatabase("database");

builder.AddProject<Projects.ExampleProject>()
       .WithReference(db)
       .WaitFor(db);

// After adding all resources, run the app...

중요하다

데이터 바인드 마운트는 볼륨에 비해 기능이 제한적이므로 성능, 이식성 및 보안이 향상되어 프로덕션 환경에 더 적합합니다. 그러나 바인딩 탑재를 사용하면 호스트 시스템의 파일에 직접 액세스하고 수정할 수 있으므로 실시간 변경이 필요한 개발 및 테스트에 적합합니다.

데이터 바인딩 탑재는 호스트 컴퓨터의 파일 시스템을 사용하여 컨테이너를 다시 시작하는 동안 SQL Server 데이터를 유지합니다. 데이터 바인드 마운트는 SQL Server 컨테이너의 호스트 컴퓨터에서 Windows의 C:\SqlServer\Data 경로(또는 Unix의 /SqlServer/Data 경로)에 마운트됩니다. 데이터 바인드 마운트에 대한 자세한 내용은 Docker 문서의섹션을 참조하십시오.

매개 변수를 사용하여 SQL Server 리소스 추가

컨테이너 이미지에서 사용하는 암호를 명시적으로 제공하려는 경우 이러한 자격 증명을 매개 변수로 제공할 수 있습니다. 다음 대체 예제를 고려합니다.

var builder = DistributedApplication.CreateBuilder(args);

var password = builder.AddParameter("password", secret: true);

var sql = builder.AddSqlServer("sql", password);
var db = sql.AddDatabase("database");

builder.AddProject<Projects.ExampleProject>()
       .WithReference(db)
       .WaitFor(db);

// After adding all resources, run the app...

매개 변수를 제공하는 방법에 대한 자세한 내용은 외부 매개 변수참조하세요.

데이터베이스 리소스에 연결

.NET .NET Aspire 앱 호스트가 실행되면 SSMS(SQL Server Management Studio) 또는 Visual Studio CodeMSSQL과 같은 외부 도구에서 서버의 데이터베이스 리소스에 액세스할 수 있습니다. 데이터베이스 리소스에 대한 연결 문자열은 종속 리소스 환경 변수에서 사용할 수 있으며 .NET.NET Aspire 대시보드: 리소스 세부 정보 창을 사용하여 액세스됩니다. 환경 변수의 이름은 ConnectionStrings__{name} 이름이 지정됩니다. 여기서 {name} 데이터베이스 리소스의 이름이고, 이 예제에서는 database. 연결 문자열을 사용하여 외부 도구에서 데이터베이스 리소스에 연결합니다. 단일 dbo.Todos 테이블이 있는 todos 데이터베이스가 있다고 상상해 보십시오.

SQL Server 관리 스튜디오
Visual Studio Code 대한 MSSQL

SQL Server Management Studio에서 데이터베이스 리소스에 연결하려면 다음 단계를 수행합니다.

SSMS를 엽니다.
Server 연결 대화 상자에서 추가 연결 매개 변수 탭을 선택합니다.
연결 문자열을 추가 연결 매개 변수 필드에 붙여넣고 연결선택합니다.
연결된 경우 개체 탐색기데이터베이스 리소스를 볼 수 있습니다.

자세한 내용은 SQL Server Management Studio에서 '서버에 연결'을 참조하세요.

호스트 통합 시스템 상태 점검

SQL Server 호스팅 통합은 SQL Server 리소스에 대한 상태 검사를 자동으로 추가합니다. 건강 상태 검사는 SQL Server가 실행 중임을 확인하고, 연결이 설정될 수 있는지 확인합니다.

호스팅 통합은 📦 AspNetCore.HealthChecks.SqlServer NuGet 패키지에 의존합니다.

Client 통합

.NET Aspire SQL Server Entity Framework Core 통합을 시작하려면, 📦Aspire를 설치하십시오. 이는 Microsoft.EntityFrameworkCore.SqlServer NuGet 패키지를, 즉 SQL ServerEntity Framework Core 클라이언트를 사용하는 애플리케이션의 프로젝트인 클라이언트 사용 프로젝트에 설치하는 것입니다.

.NET CLI
PackageReference

dotnet add package Aspire.Microsoft.EntityFrameworkCore.SqlServer

<PackageReference Include="Aspire.Microsoft.EntityFrameworkCore.SqlServer"
                  Version="*" />

자세한 내용은 dotnet add package 또는 .NET 응용 프로그램에서 패키지 종속성 관리을(를) 참조하십시오.

SQL Server 데이터베이스 컨텍스트 추가

클라이언트 사용 프로젝트의 Program.cs 파일에서 모든 IHostApplicationBuilder에 대해 AddSqlServerDbContext 확장 메서드를 호출하여 종속성 주입 컨테이너를 통해 사용할 수 있도록 DbContext을 등록하십시오. 메서드는 연결 이름 매개 변수를 사용합니다.

builder.AddSqlServerDbContext<ExampleDbContext>(connectionName: "database");

팁

connectionName 매개 변수는 앱 호스트 프로젝트에 SQL Server 데이터베이스 리소스를 추가할 때 사용되는 이름과 일치해야 합니다. 즉, AddDatabase을 호출할 때 database의 이름을 제공하고, AddSqlServerDbContext를 호출할 때도 동일한 이름을 사용해야 합니다. 자세한 내용은 SQL Server 리소스 및 데이터베이스 리소스추가를 참조하세요.

서비스에서 ExampleDbContext 개체를 검색하려면 다음을 수행합니다.

public class ExampleService(ExampleDbContext context)
{
    // Use context...
}

종속성 주입에 대한 자세한 내용은 .NET 종속성 주입참조하세요.

보강을 사용하여 SQL Server 데이터베이스 컨텍스트 추가

자동 재시도, 상태 검사, 로깅 및 원격 분석과 같은 추가 서비스로 DbContext 보강하려면 EnrichSqlServerDbContext 메서드를 호출합니다.

builder.EnrichSqlServerDbContext<ExampleDbContext>(
    connectionName: "database",
    configureSettings: settings =>
    {
        settings.DisableRetry = false;
        settings.CommandTimeout = 30 // seconds
    });

settings 매개 변수는 MicrosoftEntityFrameworkCoreSqlServerSettings 클래스의 인스턴스입니다.

구성

.NET Aspire SQL Server Entity Framework Core 통합은 프로젝트의 요구 사항 및 규칙을 충족하는 여러 구성 접근 방식과 옵션을 제공합니다.

연결 문자열 사용

ConnectionStrings 구성 섹션에서 연결 문자열을 사용하는 경우 builder.AddSqlServerDbContext<TContext>()호출할 때 연결 문자열의 이름을 제공합니다.

builder.AddSqlServerDbContext<ExampleDbContext>("sql");

연결 문자열은 ConnectionStrings 구성 섹션에서 검색됩니다.

{
  "ConnectionStrings": {
    "sql": "Data Source=myserver;Initial Catalog=master"
  }
}

EnrichSqlServerDbContext 호출되는 시점에 DbContext 등록될 것으로 예상하기 때문에 ConnectionStrings 구성 섹션을 사용하지 않습니다.

자세한 내용은 ConnectionString참조하세요.

구성 공급자 사용

.NET Aspire SQL Server Entity Framework Core 통합은 Microsoft.Extensions.Configuration지원합니다. Aspire:Microsoft:EntityFrameworkCore:SqlServer 키를 사용하여 appsettings.json 같은 구성 파일에서 MicrosoftEntityFrameworkCoreSqlServerSettings 로드합니다. Aspire:Microsoft:EntityFrameworkCore:SqlServer 섹션에서 구성을 설정한 경우 매개 변수를 전달하지 않고 메서드를 호출할 수 있습니다.

다음은 사용 가능한 옵션 중 일부를 구성하는 appsettings.json 파일의 예입니다.

{
  "Aspire": {
    "Microsoft": {
      "EntityFrameworkCore": {
        "SqlServer": {
          "ConnectionString": "YOUR_CONNECTIONSTRING",
          "DbContextPooling": true,
          "DisableHealthChecks": true,
          "DisableTracing": true,
          "DisableMetrics": false
        }
      }
    }
  }
}

인라인 구성 사용

Action<MicrosoftEntityFrameworkCoreSqlServerSettings> 대리자를 전달하여 일부 또는 모든 옵션을 인라인으로 설정할 수도 있습니다. 예를 들어 메트릭을 해제할 수 있습니다.

builder.AddSqlServerDbContext<YourDbContext>(
    "sql",
    static settings =>
        settings.DisableMetrics = true);

여러 DbContext 연결 구성

서로 다른 구성으로 둘 이상의 DbContext 등록하려는 경우 $"Aspire.Microsoft.EntityFrameworkCore.SqlServer:{typeof(TContext).Name}" 구성 섹션 이름을 사용할 수 있습니다. json 구성은 다음과 같습니다.

{
  "Aspire": {
    "Microsoft": {
      "EntityFrameworkCore": {
          "SqlServer": {
            "ConnectionString": "YOUR_CONNECTIONSTRING",
            "DbContextPooling": true,
            "DisableHealthChecks": true,
            "DisableTracing": true,
            "DisableMetrics": false,
          "AnotherDbContext": {
            "ConnectionString": "AnotherDbContext_CONNECTIONSTRING",
            "DisableTracing": false
          }
        }
      }
    }
  }
}

그런 다음 AnotherDbContext 형식 매개 변수를 사용하여 AddSqlServerDbContext 메서드를 호출하면 Aspire:Microsoft:EntityFrameworkCore:SqlServer:AnotherDbContext 섹션에서 설정이 로드됩니다.

builder.AddSqlServerDbContext<AnotherDbContext>("another-sql");

구성 옵션

해당 기본값을 사용하여 구성할 수 있는 옵션은 다음과 같습니다.

이름	묘사
`ConnectionString`	연결할 SQL Server 데이터베이스의 연결 문자열입니다.
`DbContextPooling`	요청될 때마다 db 컨텍스트가 풀화되거나 명시적으로 생성되는지 여부를 나타내는 부울 값입니다.
`MaxRetryCount`	최대 재시도 횟수입니다. 기본값은 6이며 다시 시도 메커니즘을 사용하지 않도록 설정하려면 0으로 설정합니다.
`DisableHealthChecks`	데이터베이스 건강 상태 확인이 비활성화되어 있는지 여부를 나타내는 부울 값입니다.
`DisableTracing`	OpenTelemetry 추적이 비활성화된 여부를 나타내는 부울 값입니다.
`DisableMetrics`	OpenTelemetry 메트릭이 비활성화되었는지 여부를 나타내는 부울 값입니다.
`Timeout`	명령이 실행되기를 기다리는 시간(초)입니다.

Client 통합 상태 검사

기본적으로 .NET.NET Aspire클라이언트 통합에는 모든 서비스에 대해 상태 검사 사용하도록 설정될 있습니다. 마찬가지로, 많은 .NET.NET Aspire호스팅 통합도 상태 검사 엔드포인트를 활성화합니다. 자세한 내용은 다음을 참조하세요.

.NET C# 애플리케이션 상태 검사
ASP.NET Core 의 상태 검사

기본적으로 .NET Aspire Sql ServerEntity Framework Core 통합은 다음을 처리합니다.

DbContextHealthCheck을 추가하여 EF Core의 CanConnectAsync 메서드를 호출합니다. 상태 검사의 이름은 TContext 형식의 이름에서 유래한 것입니다.
등록된 모든 상태 검사를 통과해야 트래픽을 허용할 준비가 된 것으로 간주되도록 지정하는 /health HTTP 엔드포인트와 통합됩니다.

관찰 가능성 및 원격 분석

.NET .NET Aspire 통합은 로깅, 추적 및 메트릭 구성을 자동으로 설정하며, 이를 관찰성의 핵심 요소 라고도 합니다. 통합 관찰 가능성 및 원격 분석에 대한 자세한 내용은 .NET.NET Aspire 통합 개요참조하세요. 지원 서비스에 따라 일부 통합은 이러한 기능 중 일부만 지원할 수 있습니다. 예를 들어 일부 통합은 로깅 및 추적을 지원하지만 메트릭은 지원하지 않습니다. 구성 섹션에 제시된 기술을 사용하여 원격 분석 기능을 사용하지 않도록 설정할 수도 있습니다.

로깅

.NET Aspire SQL Server Entity Framework Core 통합에서는 다음 로그 범주를 사용합니다.

Microsoft.EntityFrameworkCore.ChangeTracking
Microsoft.EntityFrameworkCore.Database.Command
Microsoft.EntityFrameworkCore.Database.Connection
Microsoft.EntityFrameworkCore.Database.Transaction
Microsoft.EntityFrameworkCore.Infrastructure
Microsoft.EntityFrameworkCore.Migrations
Microsoft.EntityFrameworkCore.Model
Microsoft.EntityFrameworkCore.Model.Validation
Microsoft.EntityFrameworkCore.Query
Microsoft.EntityFrameworkCore.Update

추적

.NET Aspire SQL Server Entity Framework Core 통합은 OpenTelemetry사용하여 다음 추적 작업을 내보낸다.

"OpenTelemetry.Instrumentation.EntityFrameworkCore"

지표

.NET Aspire SQL Server Entity Framework Core 통합은 OpenTelemetry사용하여 다음 메트릭을 내보낸다.

Microsoft.EntityFrameworkCore:
- ec_Microsoft_EntityFrameworkCore_active_db_contexts
- ec_Microsoft_EntityFrameworkCore_total_queries
- ec_Microsoft_EntityFrameworkCore_queries_per_second
- ec_Microsoft_EntityFrameworkCore_total_save_changes
- ec_Microsoft_EntityFrameworkCore_save_changes_per_second
- ec_Microsoft_EntityFrameworkCore_compiled_query_cache_hit_rate
- ec_Microsoft_Entity_total_execution_strategy_operation_failures
- ec_Microsoft_E_execution_strategy_operation_failures_per_second
- ec_Microsoft_EntityFramew_total_optimistic_concurrency_failures
- ec_Microsoft_EntityF_optimistic_concurrency_failures_per_second

다음을 통해 공유