Ini adalah Panduan Pengembang AWS CDK v2. CDK v1 yang lebih lama memasuki pemeliharaan pada 1 Juni 2022 dan mengakhiri dukungan pada 1 Juni 2023.

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Pertahankan sumber daya yang digunakan saat memfaktorkan ulang kode CDK

Dengan refactoring AWS Cloud Development Kit (AWS CDK), Anda dapat memfaktorkan ulang kode CDK Anda, seperti mengganti nama konstruksi, memindahkan sumber daya antar tumpukan, dan mengatur ulang aplikasi Anda, sambil mempertahankan sumber daya yang Anda gunakan alih-alih menggantinya. Fitur ini membantu Anda mempertahankan praktik terbaik rekayasa perangkat lunak yang baik tanpa mengakibatkan penggantian sumber daya yang tidak disengaja.

Apa itu refactoring CDK dengan pelestarian sumber daya?

Ketika Anda menyebarkan aplikasi CDK, AWS CloudFormation mengidentifikasi sumber daya dengan logisnya. IDs AWS CDK menghasilkan logika ini IDs berdasarkan ID konstruksi dan jalurnya di pohon konstruksi. Jika Anda mengubah ID konstruksi atau memindahkannya ke lokasi yang berbeda dalam kode Anda, AWS CloudFormation biasanya menafsirkan ini sebagai permintaan untuk membuat sumber daya baru dan menghapus yang lama. Untuk sumber daya stateful seperti database, bucket penyimpanan, atau antrian, penggantian ini dapat menyebabkan gangguan layanan atau kehilangan data.

Refactoring CDK mengatasi tantangan ini dengan:

Anda dapat melakukan refactoring CDK menggunakan cdk refactor perintah CDK CLI atau tindakan CDK Toolkit Library. refactor Panduan ini terutama membahas pendekatan CLI, tetapi prinsip-prinsip yang mendasarinya berlaku untuk kedua metode. Untuk informasi tentang penggunaan Perpustakaan Toolkit, lihat Melakukan tindakan terprogram menggunakan CDK Toolkit Library.

Manfaat refactoring CDK

Refactoring CDK menawarkan manfaat berikut untuk pengembang CDK: AWS

Cara kerja perintah CDK cdk refactor CLI

Pertama, Anda menerapkan aplikasi CDK awal Anda untuk membuat sumber daya dasar di akun Anda. AWS Setelah memfaktorkan ulang kode CDK Anda, seperti mengganti nama konstruksi atau memindahkan sumber daya antar tumpukan, gunakan cdk refactor perintah untuk memulai proses refactoring sumber daya yang Anda gunakan.

Saat Anda menjalankan perintah refactor, CDK CLI mendeteksi perubahan lokal Anda dengan membandingkan kode Anda saat ini dengan status yang diterapkan. Ini memverifikasi bahwa aplikasi CDK Anda berisi kumpulan sumber daya yang persis sama dengan status yang diterapkan, hanya berbeda di lokasi mereka di pohon konstruksi. CDK CLI kemudian menghasilkan rencana refactor yang memetakan lokasi sumber daya lama ke lokasi baru mereka. CDK CLI menunjukkan kepada Anda perubahan yang diusulkan dan, setelah konfirmasi Anda, AWS CloudFormation menggunakan API refactoring untuk memperbarui IDs logika sumber daya tanpa menggantinya.

Di belakang layar, CDK CLI menentukan sumber daya mana yang telah dipindahkan dengan membandingkan properti dan dependensinya, mengidentifikasi sumber daya yang setara secara fungsional tetapi memiliki jalur yang berbeda di pohon konstruksi. Jika mendeteksi penambahan, penghapusan, atau modifikasi sumber daya apa pun, operasi refactoring akan ditolak dengan pesan kesalahan.

Contoh melestarikan sumber daya saat memfaktorkan ulang kode CDK

Dalam contoh ini, kami mempertahankan sumber daya yang digunakan saat memfaktorkan ulang kode CDK kami menggunakan perintah CDK CLI. cdk refactor

Contoh aplikasi CDK kami terdiri dari tumpukan tunggal yang berisi bucket S3, CloudFront distribusi, dan fungsi Lambda. Pohon konstruksi disusun sebagai berikut:

App
└─ MyStack
   ├─ Bucket
   ├─ Distribution
   └─ Function

Berikut ini adalah contoh kode aplikasi kami:

const app = new cdk.App();
const myStack = new cdk.Stack(app, 'MyStack');

const bucket = new s3.Bucket(myStack, 'Bucket');
const distribution = new cloudfront.Distribution(myStack, 'Distribution', {
  defaultBehavior: { origin: new origins.S3Origin(bucket) }
});
const function = new lambda.Function(myStack, 'Function', {
  // function properties
});

// Synthesize the app
app.synth();

Sekarang, bayangkan Anda ingin memfaktorkan ulang kode ini menjadi:

Setelah refactoring, pohon konstruksi akan terlihat seperti ini:

App
├─ WebStack
│  ├─ WebsiteOrigin
│  └─ Distribution
└─ MyStack
   └─ Function

Dan kode yang difaktorkan ulang adalah:

// Refactored structure
const app = new cdk.App();

// New WebStack with the bucket and distribution
const webStack = new cdk.Stack(app, 'WebStack');
const bucket = new s3.Bucket(webStack, 'WebsiteOrigin');
const distribution = new cloudfront.Distribution(webStack, 'Distribution', {
  defaultBehavior: { origin: new origins.S3Origin(bucket) }
});

// Original MyStack with just the function
const myStack = new cdk.Stack(app, 'MyStack');
const function = new lambda.Function(myStack, 'Function', {
  // function properties
});

// Synthesize the app
app.synth();

Tanpa refactoring CDK, perubahan ini akan AWS CloudFormation menyebabkan pembuatan sumber daya baru dan menghapus yang lama, karena logika akan berubah: IDs

Dengan refactoring CDK, CDK CLI mendeteksi perubahan jalur ini dan menggunakan AWS CloudFormation kemampuan refactoring untuk melestarikan sumber daya yang mendasarinya. Saat Anda menjalankancdk refactor, CLI menunjukkan kepada Anda perubahan yang akan dibuatnya:

$ cdk refactor

The following resources were moved or renamed:

┌───────────────────────────────┬───────────────────────────────┬───────────────────────────────────┐
│ Resource Type                 │ Old Construct Path            │ New Construct Path                │
├───────────────────────────────┼───────────────────────────────┼───────────────────────────────────┤
│ AWS::S3::Bucket               │ MyStack/Bucket/Resource       │ WebStack/WebsiteOrigin/Resource   │
├───────────────────────────────┼───────────────────────────────┼───────────────────────────────────┤
│ AWS::CloudFront::Distribution │ MyStack/Distribution/Resource │ WebStack/Distribution/Resource    │
└───────────────────────────────┴───────────────────────────────┴───────────────────────────────────┘

Do you wish refactor these resources (y/n)?

Saat Anda mengonfirmasi dengan memasukkany, CDK CLI menunjukkan kemajuan operasi refactoring:

Refactoring...
✅  Stack refactor complete

Setelah mengonfirmasi, CDK CLI menjalankan operasi refactoring, mempertahankan kedua sumber daya sambil memperbarui IDs logisnya agar sesuai dengan struktur kode baru Anda.

Pemetaan yang sama juga ditampilkan dalam output cdk diff perintah, yang diatur oleh tumpukan:

Stack MyStack
Resources
[-] AWS::S3::Bucket Bucket Bucket1234567 destroy (OR move to WebStack.WebsiteOrigin1234567 via refactoring)
[-] AWS::CloudFront::Distribution Distribution Distribution1234567 destroy (OR move to WebStack.Distribution1234567)
...

Stack WebStack
Resources
[+] AWS::S3::Bucket WebsiteOrigin WebsiteOrigin1234567 (OR move from MyStack.Bucket1234567)
[+] AWS::CloudFront::Distribution Distribution Distribution1234567 (OR move from MyStack.Distribution1234567)
...

Memulai dengan refactoring CDK

Untuk memulai refactoring, lengkapi prasyarat ini:

Gunakan file override untuk menyelesaikan ambiguitas dalam refactoring

CDK CLI secara otomatis menghitung semua pemetaan sumber daya berdasarkan membandingkan kode Anda dengan sumber daya yang digunakan. Dalam kebanyakan kasus, deteksi otomatis ini berfungsi dengan baik, tetapi ada situasi di mana CLI mungkin menghadapi ambiguitas yang tidak dapat diselesaikan sendiri. Untuk memberikan panduan ke CDK CLI, gunakan file override.

Tumpukan refactoring di berbagai lingkungan

Aplikasi CDK dapat berisi beberapa tumpukan yang disebarkan ke lingkungan yang berbeda (AWS akun dan Wilayah). Saat melestarikan sumber daya selama refactoring dalam aplikasi tersebut, CDK CLI menangani lingkungan dengan cara tertentu:

Perilaku ini memastikan bahwa sumber daya tetap berada dalam AWS akun asli dan Wilayah mereka, yang diperlukan karena CloudFormation sumber daya tidak dapat dipindahkan secara fisik melintasi batas akun atau Wilayah.

Misalnya, jika aplikasi CDK Anda mendefinisikan tumpukan untuk lingkungan pengembangan dan produksi, operasi refactoring akan dilakukan secara independen di setiap lingkungan. Sumber daya dapat dipindahkan antara tumpukan dalam lingkungan pengembangan atau dalam lingkungan produksi, tetapi tidak dari pengembangan ke produksi atau sebaliknya.

Penanganan sumber daya yang dirancang untuk diganti

Beberapa konstruksi CDK mengandalkan CloudFormation perilaku penggantian sumber daya sebagai bagian dari desainnya. Misalnya, Version konstruksi API Gateway Deployment dan Lambda dirancang untuk membuat sumber daya baru saat propertinya berubah.

Saat refactoring, jangan sertakan perubahan apa pun yang akan menghasilkan penggantian sumber daya. Jika tidak, CDK CLI dapat mendeteksi dan melestarikan sumber daya ini. Ini berarti bahwa sumber daya yang dirancang untuk diganti harus ditangani secara terpisah dari operasi refactoring.

Untuk mengelola sumber daya dengan benar yang dirancang untuk diganti:

Pendekatan dua langkah ini memastikan bahwa sumber daya yang dirancang untuk diganti ditangani dengan benar, sambil tetap memungkinkan Anda untuk mendapatkan manfaat dari refactoring CDK untuk sumber daya lain.

Pertimbangan dan keterbatasan umum

Saat melestarikan sumber daya selama refactoring CDK, ingatlah pertimbangan ini:

Refactoring dengan jaringan pipa CI/CD

Untuk menggunakan fitur refactoring di CI/CD pipeline, Anda harus dapat menjalankan CDK CLI sebagai bagian dari pipeline Anda. Berikut ini adalah beberapa pertimbangan penting untuk mengintegrasikan refactoring ke dalam alur kerja Anda. CI/CD

Sumber daya terkait

Untuk informasi tentang opsi dan argumen untuk perintah CDK cdk refactor CLI, lihat. cdk refactor

Untuk memulai tindakan CDK Toolkit Library, lihat Melakukan refactor tindakan terprogram menggunakan CDK Toolkit Library.