Developing with feature flags · Gitlab 中文文檔

# Developing with feature flags > 原文：[https://docs.gitlab.com/ee/development/feature_flags/development.html](https://docs.gitlab.com/ee/development/feature_flags/development.html) * [Feature groups](#feature-groups) * [Frontend](#frontend) * [Specs](#specs) * [`stub_feature_flags: true` (default and preferred)](#stub_feature_flags-true-default-and-preferred) * [`stub_feature_flags: false`](#stub_feature_flags-false) * [Enabling a feature flag (in development)](#enabling-a-feature-flag-in-development) # Developing with feature flags[](#developing-with-feature-flags "Permalink") 通常，最好有一個基于組或基于用戶的門，并且您應該比使用百分比門更好. 這將使調試更加容易，因為您也可以根據參與者過濾示例日志和錯誤. 此外，這允許首先啟用`gitlab-org`或`gitlab-com`組，而其余用戶則`gitlab-com` . ``` # Good Feature.enabled?(:feature_flag, project) # Avoid, if possible Feature.enabled?(:feature_flag) ``` 要使用基于角色的特征門，模型需要響應`flipper_id` . 例如，要啟用 Foo 模型： ``` class Foo < ActiveRecord::Base include FeatureGate end ``` 只有`include FeatureGate`或公開的`flipper_id`方法的模型才能用作`Feature.enabled?` `flipper_id` `Feature.enabled?` . 已開發并打算在功能標記后合并的功能不應包含變更日志條目. 該條目應添加到刪除功能部件標記的合并請求中，或在功能部件標記的默認值設置為 true 的合并請求中添加. 如果功能包含任何數據庫遷移，則該功能應包括數據庫更改的更改日志條目. 如果您需要功能標記自動打開，請在檢查以下內容時使用`default_enabled: true` ： ``` Feature.enabled?(:feature_flag, project, default_enabled: true) ``` [`Project#feature_available?`](https://gitlab.com/gitlab-org/gitlab/blob/4cc1c62918aa4c31750cb21dfb1a6c3492d71080/app/models/project_feature.rb#L63-68) ， [`Namespace#feature_available?`](https://gitlab.com/gitlab-org/gitlab/blob/4cc1c62918aa4c31750cb21dfb1a6c3492d71080/ee/app/models/ee/namespace.rb#L71-85) （EE）和[`License.feature_available?`](https://gitlab.com/gitlab-org/gitlab/blob/4cc1c62918aa4c31750cb21dfb1a6c3492d71080/ee/app/models/license.rb#L293-300) （EE）方法都隱式檢查默認情況下啟用的功能標志，該標志與提供的參數同名. 例如，如果某個功能是許可門控的，則無需添加其他顯式功能標志檢查，因為該標志將作為`License.feature_available?`一部分進行檢查`License.feature_available?` 呼叫. 同樣，功能達到通用狀態后，也無需"清理"功能標志. 您是否仍想使用顯式`Feature.enabled?` 檢查您的新功能是否不受許可或計劃的限制. **上面提到的隱式功能標志的一個重要副作用是，除非功能被明確禁用或限制為一定比例的用戶，否則功能標志檢查將默認為`true` .** 當使用[幾個較小的合并請求](https://about.gitlab.com/handbook/values/#make-small-merge-requests)開發功能時，或者當該功能被視為[alpha 或 beta 時](https://about.gitlab.com/handbook/product/#alpha-beta-ga) ，這是相關的，并且默認情況下不可用. 例如，如果要交付功能的前端一半而沒有后端，則希望完全禁用該功能，直到也可以交付后端一半. 要確保 GitLab.com 和自我管理實例均禁用此功能，應使用[`Namespace#alpha_feature_available?`](https://gitlab.com/gitlab-org/gitlab/blob/458749872f4a8f27abe8add930dbb958044cb926/ee/app/models/ee/namespace.rb#L113) 或[`Namespace#beta_feature_available?`](https://gitlab.com/gitlab-org/gitlab/blob/458749872f4a8f27abe8add930dbb958044cb926/ee/app/models/ee/namespace.rb#L100-112) 方法，根據我們的[定義](https://about.gitlab.com/handbook/product/#alpha-beta-ga) . 這樣可以確保禁用功能，除非*明確*啟用了功能標志. ## Feature groups[](#feature-groups "Permalink") 從 GitLab 9.4 開始，我們通過[Flipper 組](https://github.com/jnunemaker/flipper/blob/v0.10.2/docs/Gates.md#2-group)支持功能[組](https://github.com/jnunemaker/flipper/blob/v0.10.2/docs/Gates.md#2-group) . 功能組必須在`lib/feature.rb` （在`.register_feature_groups`方法中）靜態定義，但是它們的實現顯然可以是動態的（查詢數據庫等）. 在`lib/feature.rb`定義后，您將能夠通過[features API](../../api/features.html#set-or-create-a-feature)的[`feature_group`參數](../../api/features.html#set-or-create-a-feature)激活給定功能組[的功能](../../api/features.html#set-or-create-a-feature) ### Frontend[](#frontend "Permalink") 對于前端代碼，可以使用方法`push_frontend_feature_flag` ，該方法適用于所有從`ApplicationController`繼承的控制器. 使用此方法，可以按如下所示公開功能部件標志的狀態： ``` before_action do # Prefer to scope it per project or user e.g. push_frontend_feature_flag(:vim_bindings, project) # Avoid, if possible push_frontend_feature_flag(:vim_bindings) end def index # ... end def edit # ... end ``` 然后，您可以按照以下步驟檢查 JavaScript 中功能部件標志的狀態： ``` if ( gon.features.vimBindings ) { // ... } ``` JavaScript 中的功能標志的名稱將始終為 camelCased，這意味著檢查`gon.features.vim_bindings`將不起作用. 有關如何訪問 Vue 組件中的功能標志的詳細信息，請參見[Vue 指南](../fe_guide/vue.html#accessing-feature-flags) . ### Specs[](#specs "Permalink") 我們在測試環境中的 Flipper 引擎以`Flipper::Adapters::Memory`的內存模式工作. `production`和`development`模式使用`Flipper::Adapters::ActiveRecord` . ### `stub_feature_flags: true` (default and preferred)[](#stub_feature_flags-true-default-and-preferred "Permalink") 在此模式下，將 Flipper 配置為使用`Flipper::Adapters::Memory`并將所有功能標志標記為默認狀態，并在首次使用時保持不變. 這將覆蓋`Feature.enabled?`的`default_enabled:` `Feature.enabled?` 和`Feature.disabled?` 除非功能標記持續存在，否則始終返回`true` . Make sure behavior under feature flag doesn’t go untested in some non-specific contexts. 有關如何在測試中添加功能標志的信息和示例，請參見[測試指南](../testing_guide/best_practices.html#feature-flags-in-tests) . ### `stub_feature_flags: false`[](#stub_feature_flags-false "Permalink") 這將禁用存儲在內存中的鰭狀肢，并使用`Flipper::Adapters::ActiveRecord`一種`production`和`development`所使用的模式. 僅當您確實想測試 Flipper 的各個方面及其與`ActiveRecord`交互方式時，才應使用此模式. ### Enabling a feature flag (in development)[](#enabling-a-feature-flag-in-development "Permalink") 在 rails 控制臺（ `rails c` ）中，輸入以下命令以啟用功能部件標志 ``` Feature.enable(:feature_flag_name) ``` 同樣，以下命令將禁用功能部件標志： ``` Feature.disable(:feature_flag_name) ``` 您也可以為給定的門啟用功能標志： ``` Feature.enable(:feature_flag_name, Project.find_by_full_path("root/my-project")) ```