# 设置指南

设置在 Windows中是Settings，在macOS中是Preferences，所有基于IntelliJ Platform平台的IDE中的设置都由Settings 控制。

插件使用持久化模型 来创建和存储它们的配置。可以在IDE的设置
open in new window 对话框中添加用户自定义的设置项。

设置（Settings）可以设置不同级别的作用域。当前文档主要是添加项目级、应用级和全局级（Project and Application，Global）的自定义设置项

# 设置（Settings）的扩展点

根据设置项的作用域，可以使用两个扩展点 [extension points (缩写为EP)] 之一在 plugin.xml 注册自定义设置项。两个扩展点大部门的属性是共享的。

项目级、应用级（Project and Application)的设置项不能使用运行时依赖，需要提供一个Configurable
open in new window 接口的实现类，具体可以在下文中的扩展点的实现类中查看如何实现。

# 注册应用级（application-level）设置项

用com.intellij.applicationConfigurable 扩展点来注册应用级的设置项

# 注册项目级（project-level）设置

用 com.intellij.projectConfigurable 扩展点来注册项目级（project-level）的设置

# 注册点的属性

鼓励开发者去查看 Configurable
open in new window 和 ConfigurableProvider 的 Javadoc 注释，下面内容对注释提供了补充说明。

# 属性列表

下面包括com.intellij.projectConfigurable 和com.intellij.applicationConfigurable 扩展点的属性描述

注意事项：

1. instance 或 provider 必须指定一个

2. displayName 和 key and bundle 必须指定一个，文本不需要国际化使用displayName，需要国际化使用key and bundle

3. 如果同时配置了groupId和parentId，idea会提示警告信息。parentId列表见下文 设置的id列表

# 设置的id列表

上文中的parentId的列表

# 扩展点的实现类

com.intellij.projectConfigurable 和com.intellij.applicationConfigurable 扩展点的实现有以下2种方式:

• Configurable
  open in new window 接口：提供 Swing 表单。大多数的设置都基于该接口或该接口的子类或超类

• ConfigurableProvider
  open in new window 可以在运行时条件隐藏某一个设置项

# Configurable接口

intellij-community 大多数的设置项都基于 Configurable 接口或它的子类，例如 SearchableConfigurable
open in new window ，推荐开发者阅读 Configurable接口的 Javadoc注释

# 构造器

实现类的构造器，必须满足以下一些条件

• 使用com.intellij.applicationConfigurable扩展点注册的实现类，必须有默认无参构造器

• 使用com.intellij.projectConfigurable扩展点注册的设置实现类，必须有带 Project
  open in new window 一个参数的构造器

• 从2020.2版本开始，不允许构造器注入其它参数（除了 Project ）

对使用扩展点正确注册的设置项来说，用户不该设置，不会调用该实现类的构造器进行初始化。

# IntelliJ Platform和Configurable接口交互

Configurable接口常用方法如下：

• 在调用了Configurable.createComponent() 方法后会立即调用 Configurable.reset() 方法。所以不需要在构造函数或 createComponent() 方法中初始化设置项相关组件

• 上文中的构造器内容

• 一旦Configurable实例化，无论设置是否更改，或者用户在设置对话框菜单上选择其它条目，实例的生命周期都会继续

• 当用户了设置对话框里的OK或Cancel时，Configurable实例的生命周期才会结束。关闭设置对话框时会调用Configurable.disposeUIResources() 方法

打开设置对话框或显示某一个 Configurable，可以使用 ShowSettingsUtil 类

# Configurable的标记接口

基于Configurable的实现类也可以实现标记接口，标记接口提供了一些特性

下面的标记接口，可以将 Swing表单信息传递给 IntelliJ Platform

• Configurable.NoScroll 通知设置对话框不能增加滚动条。默认情况下，设置的组件会放入一个带滚动条的面板里，这个接口可以删除滚动条
• Configurable.NoMargin 通知设置对话框不能添加空边框。默认情况下，插件的组件会添加一个空边框

# 基于Configurable的其它接口

IntelliJ Platform有一些基于 com.intellij.openapi.options.ConfigurableEP 特定功能的类。例如：Settings/Preferences | Editor | General | Appearance 中可以使用 EditorSmartKeysConfigurableEP和com.intellij.editorSmartKeysConfigurable 扩展点来注册设置项

# 示例

可以参考以下实现：

• ConsoleConfigurable
  open in new window 应用级设置(application configurable)

• AutoImportOptionsConfigurable
  open in new window 项目级设置(project configurable)

# ConfigurableProvider接口

ConfigurableProvider
open in new window 只在满足某些条件的时候提供 Configurable实现类。IntelliJ Platform 先调用ConfigurableProvider.canCreateConfigurable() 方法，进行逻辑判断，返回true 表示当前设置是有效的，然后调用 ConfigurableProvider.createConfigurable() 方法获取设置项。

ConfigurableProvider 是通过属性列表 中的provider 属性来指定的

示例: RunToolbarSettingsConfigurableProvider
open in new window

今天的文章
idea插件配置分享到此就结束了，感谢您的阅读。