Theia APIs——Preferences

  • 时间:
  • 浏览:0

上一篇:Theia APIs——命令和快捷键

Preferences

  Theia有三个白preference service,模块都后能 通过它来获取preference的值,提供默认的preferences以及监听preference的更改。

  Preferences的内容都后能 保趋于稳定workspace根目录下的.theia/settings.json中,意味着着Linux系统的$HOME/.theia/settings.json文件中。在Windows系统中,用户设置默认保趋于稳定%USERPROFILE%/.theia/settings.json文件中(这俩于c:\Users\epatpol\.theia\settings.json)。

  所有那先 文件都时需包含三个白有效的JSON,其中包含preferences的名称和值(注意下面例子中的preference全部全是官方指定的,这里仅作为三个白示例)。如有时需,你也都后能 在settings.json文件中加在注释。如:

{
    // Enable/Disable the line numbers in the monaco editor
    "monaco.lineNumbers": "off",
    // Tab width in the editor
    "monaco.tabWidth": 4,
    "fs.watcherExcludes": "path/to/file"
}

  亲们以filesystem作为示例,它是使用preference service的三个白模块。

使用inversity创建具有默认preferences的模块

  为了提供preference的值,模块时需提供三个白有效的json schema,用来验证所提供的值。模块时需像下面本来将PreferenceContributton绑定到值:

export interface PreferenceSchema {
    [name: string]: Object,
    properties: {
        [name: string]: object
    }
}

export interface PreferenceContribution {
    readonly schema: PreferenceSchema;
}

  这俩于,filesystem中的代码:

export const filesystemPreferenceSchema: PreferenceSchema = {
    "type": "object",
    "properties": {
        "files.watcherExclude": {
            "description": "List of paths to exclude from the filesystem watcher",
            "additionalProperties": {
                "type": "boolean"
            }
        }
    }
};

bind(PreferenceContribution).toConstantValue(
{ 
    schema: filesystemPreferenceSchema 
});

  下面是有些有关提供验证的schema的链接:

通过配置监听preference的更改

  要使用preference的值,只需从容器中获得注入的PreferenceService。

const preferences = ctx.container.get(PreferenceService);

   对filesystem而言,服务在一开始英语 英文英文绑定的就让获取。这里,我能 使用onPreferenceChanged最好的法律法律依据来注册preference更改的回调。

constructor(@inject(PreferenceService) protected readonly prefService: PreferenceService
    prefService.onPreferenceChanged(e => { callback }

  这里,事件接收到的对象e是下面这俩于于类型:

export interface PreferenceChangedEvent {
    readonly preferenceName: string;
    readonly newValue?: any;
    readonly oldValue?: any;
}

   着实亲们都后能 在类中直接本来使用,不过filesystem提供了三个白特定于filesystem preferences的代理preference服务(该服务在后台运行),本来都后能 放慢、更有效地搜索preference(意味着着它在filesystem preference service中进行搜索,而全部全是通过更通用的preference service搜索所有的内容)。从五种意义上来说,它也更高效,意味着着越来越那先 监视与某个模块相关的特定preferences的模块才会得到通知。要做到这俩于于点,都后能 看看有关filesystem配置的代理接口是怎么才能 才能 绑定使用preference代理接口的:

export type PreferenceProxy<T> = Readonly<T> & Disposable & PreferenceEventEmitter<T>;
export function createPreferenceProxy<T extends Configuration>(preferences: PreferenceService, configuration: T): PreferenceProxy<T> {
    /* Register a client to the preference server
    When a preference is received, it is validated against the schema and then fired if valid, otherwise the default value is provided.

    This proxy is also in charge of calling the configured preference service when the proxy object is called i.e editorPrefs['preferenceName']

    It basically forwards methods to the real object, i.e dispose/ready etc.
}

  要使用这俩于于代理,只时需将它绑定到三个白新类型X = PreferenceProxy<CONFIGURATION_INTERFACE>,但会 使用里面的最好的法律法律依据bind(X)到三个白代理。

export interface FileSystemConfiguration {
    'files.watcherExclude': { [globPattern: string]: boolean }
}

export const FileSystemPreferences = Symbol('FileSystemPreferences');
export type FileSystemPreferences = PreferenceProxy<FileSystemConfiguration>;

export function createFileSystemPreferences(preferences: PreferenceService): FileSystemPreferences {
    return createPreferenceProxy(preferences, defaultFileSystemConfiguration, filesystemPreferenceSchema);
}

export function bindFileSystemPreferences(bind: interfaces.Bind): void {

    bind(FileSystemPreferences).toDynamicValue(ctx => {
        const preferences = ctx.container.get(PreferenceService);
        return createFileSystemPreferences(preferences);
    });

    bind(PreferenceContribution).toConstantValue({ schema: filesystemPreferenceSchema });

}

  最后,在模块中使用filesystem配置,只时需将它注入到你时需的地方。我能 像本来访问preference(以filesystem为例):

const patterns = this.preferences['files.watcherExclude'];

  你也都后能 像本来监听preference的更改:

this.toDispose.push(preferences.onPreferenceChanged(e => {
    if (e.preferenceName === 'files.watcherExclude') {
        this.toRestartAll.dispose();
    }
}));
constructor(...,
        @inject(FileSystemPreferences) protected readonly preferences: FileSystemPreferences) {
    ...
         this.toDispose.push(preferences.onPreferenceChanged(e => {
            if (e.preferenceName === 'files.watcherExclude') {
                this.toRestartAll.dispose();
            }
        }));
    ...
}

Preference的修改流程

  当在${workspace}/.theia/意味着着os.homedir()/.theia/中修改settings.json的内容时,JSON preference服务器会触发三个白事件。首先,CompoundPreferenceServer用来管理不同的服务器(作用域),这俩于workspace/user/defaults(提供里面说的contributions)。接下来,PreferenceService管理该服务器并在其加在在更多api以方便调用(这俩于getBoolean,getSrtring等等),它同去还允许客户端监听preference的修改。这俩于于PreferenceService都后能 直接或通过特定的代理(如里面这俩于于filesystem配置)被注入到模块中。

  当preference被修改时,对应的流程是:

.theia/settings.json -> JsonPreferenceServer -> CompoundPreferenceServer -> PreferenceService -> PreferenceProxy<FileSystemConfiguration> -> FileSystemWatcher

获取preference的值

  对于filesystem来说,亲们都后能 使用与里面相同的代理配置来访问preference的内容。

    if (this.prefService['preferenceName']) {
    ...
    }
    
    if (this.prefService['preferenceName2']) {
    ...
    }
})

  它能正常工作,正如亲们在里面所看过的那样,代理将简单地调用prefService.get('preferenceName')。

TODO/FIXME

  • 在CompoundPreferenceServer中加在server优先级

  • 当在theia的settings.json中修改内容时加在自动完成和描述功能

原文地址:https://theia-ide.org/docs/preferences