Theia APIs——Preferences

  • 时间:
  • 浏览:0
  • 来源:5分时时彩官网_5分时时彩正规平台_5分时时彩平台网址

上一篇: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