對於複雜且快速發展的庫，在改進現有功能的同時保持向後相容性可能具有挑戰性。 程式碼棄用允許您正確標記過時的程式碼，並透過警告使用者，幫助他們過渡到更好的替代方案。

要將函式、類、方法或屬性標記為已棄用，請使用 @deprecated 標記。 下面是一個例子：

```typescript
/**
* @deprecated since 1.0.2
* Use better alternative instead
*/
```

根據實際的棄用政策，此類程式碼將成為下一個主要版本之一中刪除的候選程式碼。

# Marking Deprecated Logic

通常，為了適應向後相容性，一些間接相關的程式碼需要包含額外的邏輯，當相關的棄用功能被刪除時，這些邏輯應該被刪除。 當不清楚應該刪除哪些附加邏輯時，確保刪除過時程式碼的最佳方法是用正確的 TODO 註釋標記它，最好連結到帶有附加詳細資訊的 GitHub 問題。 應正確標記這些票證（例如，具有 deprecated-1.x 的標籤），以便將來更容易將其作為刪除的候選物件引用。

以下是 TODO 註釋的示例：

```typescript
// TODO(issue:3313) Deprecated since 1.1.1
```

# Feature Flags

每個新的次要版本都會發布新功能。 有時，新功能被新增到客戶已經可以使用的現有元件中，這使得這些更改成為破壞性更改，因為新增到 DOM 或因為不同的行為。 為了避免破壞客戶的程式碼，並在不需要過於頻繁地釋出新的主要版本的情況下靈活地改進現有元件的功能，Spartacus 使用了功能標誌。

功能標誌允許我們執行以下操作：

* 根據功能級別區分功能，對應小版本號
* 基於顯式特徵標誌區分特徵

注意：顯式功能標誌可以連結到功能級別，這意味著預設情況下為該特定級別啟用它們。

# Deciding If You Need a Feature Flag

如果不需要，最好避免建立新的功能標誌。這有助於保持我們的配置乾淨並使最終的維護更容易。

以下指南可以幫助您決定應該使用哪個功能標誌（如果有）：

(1) 如果可能，儘量避免使用功能標誌。

相反，將您的功能實現為一個單獨的模組，可以由客戶選擇匯入。

(2) 如果您的功能已經有單獨的配置，請確定以下哪個更方便：

a. 在模組配置中建立一個新選項（對於一般功能，使它們可切換具有實際價值）。
b. 使用功能標誌（特別是當標誌的唯一原因是向後相容時）。

如果可能，儘量避免建立明確的功能標誌。相反，嘗試啟用特定功能級別的功能，例如次要版本。
如果要建立顯式功能標誌，請確保這樣做的原因是合理的（例如，該功能非常重要，可以顯式禁用或啟用）。

# Detecting the Feature Level

如果您的服務或元件已經注入了全域性配置，您可以使用一個簡單的實用程式函式來檢查功能級別，如以下示例所示：

```typescript
if (isFeatureLevel(this.config, '1.1')) {
  // code that is meant to be executed for feature level 1.1 and above
}
```

如果您的元件或服務無權訪問全域性配置，您可以注入 FeatureConfigService 並使用它，如下例所示：

```typescript
 constructor(
    // ...
    protected featureConfig: FeatureConfigService
  ) {}

// set a feature flag based on the feature level
  readonly isSomeNewFeatureEnabled = this.featureConfig.isLevel('1.1');
```

如果要在模板中有條件地顯示元件，可以使用 cxFeatureLevel 指令，如下例所示：

```html
<newcomponent></newcomponent>
```

您可以在沒有額外配置的情況下引入顯式標誌，但建議您將它們包含在店面配置的型別定義中，以將它們公開給客戶。 為此，請將您的標誌作為布林型別的新屬性新增到 feature-toggles.ts 檔案中的 FeatureToggles 介面。 下面是一個例子：

```typescript
export interface FeatureToggles {
  features?: {
    // ...

/**
     * Sample feature description
     */
    consignmentTracking: boolean;
  };
}
```

透過這種方式，您還可以在標誌中新增描述，如果需要，甚至可以新增棄用註釋。

# Linking the Feature Flag to the Feature Level

透過將您的功能標誌連結到功能級別，預設情況下將為該功能級別和所有更高階別啟用您的標誌。 為此，請將功能標誌的預設值作為表示功能級別的字串提供。 您可以將此配置新增到您的模組配置中，如以下示例所示：

```typescript
ConfigModule.withConfig({
  // ...
  features: {
    consignmentTracking: '1.1',
  },
})
```

在此示例中，如果功能級別設定為至少“1.1”，則預設情況下啟用寄售跟蹤功能。

# Disabling a Feature for a Specific Feature Level

您可以透過包含感嘆號來禁用特定功能級別的功能！ 在版本號之前。 下面是一個例子：

```html
<newcomponent></newcomponent>
```

什麼是 SAP Spartacus UI 的 code deprecation

相關文章