Menggunakan AWSSDK.Extensions.NETCore.Setup dan antarmuka IConfiguration

(Topik ini sebelumnya berjudul, “Mengkonfigurasi AWS SDK untuk .NET dengan.NET Core”)

Salah satu perubahan terbesar di.NET Core adalah penghapusan ConfigurationManager dan standar app.config dan web.config file yang digunakan dengan.NET Framework dan ASP.NET aplikasi.

Konfigurasi di.NET Core didasarkan pada pasangan nilai kunci yang ditetapkan oleh penyedia konfigurasi. Penyedia konfigurasi membaca data konfigurasi menjadi pasangan kunci-nilai dari berbagai sumber konfigurasi, termasuk argumen baris perintah, file direktori, variabel lingkungan, dan file pengaturan.

Untuk membuatnya mudah digunakan den AWS SDK untuk .NET gan.NET Core, Anda dapat menggunakan AWSSDK.Extensions.NETCore.Setup NuGet paket. Seperti banyak pustakan.NET Core, ia menambahkan metode ekstensi ke IConfiguration antarmuka untuk membuat AWS konfigurasi mulus.

Kode sumber untuk paket ini aktif GitHub dihttps://github.com/aws/aws-sdk-net/tree/main/extensions/src/AWSSDK.Extensions.NETCore.Setup.

Menggunakan AWSSDK.Extensions.NETCore.Setup

Misalkan Anda membuat aplikasi ASP.NET Core Model-View-Controller (MVC), yang dapat dilakukan dengan template ASP.NET Core Web Application di Visual Studio atau dengan menjalankan di dotnet new mvc ... .NET Core CLI. Ketika Anda membuat aplikasi seperti itu, konstruktor untuk Startup.cs menangani konfigurasi dengan membaca di berbagai sumber input dari penyedia konfigurasi sepertiappsettings.json.

public Startup(IConfiguration configuration)
{
    Configuration = configuration;
}

Untuk menggunakan Configuration objek untuk mendapatkan AWS opsi, pertama-tama tambahkan AWSSDK.Extensions.NETCore.Setup NuGet paket. Kemudian, tambahkan opsi Anda ke file konfigurasi seperti yang dijelaskan selanjutnya.

Perhatikan bahwa salah satu file yang ditambahkan ke proyek Anda adalahappsettings.Development.json. Ini sesuai dengan satu EnvironmentName set untuk Peng embangan. Selama pengembangan, Anda menempatkan konfigurasi Anda di file ini, yang hanya dibaca selama pengujian lokal. Saat Anda menerapkan instans Amazon EC2 yang telah diset EnvironmentName el ke Produksi, file ini diabaikan dan kembali ke AWS SDK untuk .NET kredenSIAL IAM dan Wilayah yang dikonfigurasi untuk instans Amazon EC2.

Pengaturan konfigurasi berikut menunjukkan contoh nilai yang dapat Anda tambahkan dalam appsettings.Development.json file dalam proyek Anda untuk menyediakan AWS pengaturan.

{
  "AWS": {
    "Profile": "local-test-profile",
    "Region": "us-west-2"
  },
  "SupportEmail": "TechSupport@example.com"
}

Untuk mengakses pengaturan dalam file CSHTML, gunakan direktif. Configuration

@using Microsoft.Extensions.Configuration
@inject IConfiguration Configuration

<h1>Contact</h1>

<p>
    <strong>Support:</strong> <a href='mailto:@Configuration["SupportEmail"]'>@Configuration["SupportEmail"]</a><br />
</p>

Untuk mengakses AWS opsi yang ditetapkan dalam file dari kode, panggil metode GetAWSOptions ekstensi yang ditambahkan keIConfiguration.

Untuk membangun klien layanan dari opsi ini, panggilCreateServiceClient. Contoh berikut menunjukkan cara membuat klien layanan Amazon S3. (Pastikan untuk menambahkan AWSSDK.S3 NuGet paket ke proyek Anda.)

var options = Configuration.GetAWSOptions();
IAmazonS3 client = options.CreateServiceClient<IAmazonS3>();

Anda juga dapat membuat beberapa klien layanan dengan pengaturan yang tidak kompatibel dengan menggunakan beberapa entri dalam appsettings.Development.json file, seperti yang ditunjukkan dalam contoh berikut di mana konfigurasi untuk service1 menyertakan Wil us-west-2 ayah dan konfigurasi untuk menyer service2 takan URL titik akhir khusus.

{
  "service1": {
    "Profile": "default",
    "Region": "us-west-2"
  },
  "service2": {
    "Profile": "default",
    "ServiceURL": "URL"
  }
}

Anda kemudian bisa mendapatkan opsi untuk layanan tertentu dengan menggunakan entri di file JSON. Misalnya, untuk mendapatkan pengaturan untuk service1 menggunakan berikut ini.

var options = Configuration.GetAWSOptions("service1");

Nilai yang diizinkan dalam file appsettings

Nilai konfigurasi aplikasi berikut dapat diatur dalam appsettings.Development.json file. Nama bidang harus menggunakan casing yang ditunjukkan. Untuk detail tentang pengaturan ini, lihat AWS.Runtime.ClientConfig kelas.

ASP.NET Injeksi ketergantungan inti

AWSSDK.Extensions.NETCore.Setup NuGet Paket ini juga terintegrasi dengan sistem injeksi ketergantungan baru di ASP.NET Core. ConfigureServicesMetode di Startup kelas aplikasi Anda adalah tempat layanan MVC ditambahkan. Jika aplikasi menggunakan Entity Framework, ini juga di mana itu diinisialisasi.

public void ConfigureServices(IServiceCollection services)
{
    // Add framework services.
    services.AddMvc();
}

AWSSDK.Extensions.NETCore.Setup NuGet Paket menambahkan metode ekstensi baru IServiceCollection yang dapat Anda gunakan untuk menambahkan AWS layanan ke injeksi ketergantungan. Kode berikut menunjukkan cara menambahkan AWS opsi yang dibaca IConfiguration untuk menambahkan Amazon S3 dan DynamoDB ke daftar layanan. (Pastikan untuk menambahkan AWSSDK.DynamoDBv2 NuGet paket AWSSDK.S3 dan ke proyek Anda.)

public void ConfigureServices(IServiceCollection services)
{
    // Add framework services.
    services.AddMvc();

    services.AddDefaultAWSOptions(Configuration.GetAWSOptions());
    services.AddAWSService<IAmazonS3>();
    services.AddAWSService<IAmazonDynamoDB>();
}

Sekarang, jika pengontrol MVC Anda menggunakan salah IAmazonS3 satu atau IAmazonDynamoDB sebagai parameter dalam konstruktornya, sistem injeksi ketergantungan melewati layanan tersebut.

public class HomeController : Controller
{
    IAmazonS3 S3Client { get; set; }

    public HomeController(IAmazonS3 s3Client)
    {
        this.S3Client = s3Client;
    }

    ...

}