Theia APIs——通过JSON

  • 时间:
  • 浏览:0

上一篇:Theia APIs——事件

通过JSON-PRC进行通信

  在本节中,我将讲解如可创建后端服务并通过JSON-PRC来连接它。

  我将使用debug logging system作为例子来进行讲解。

概述

  本示例将用express框架创建另四个服务,但会 通过websocket连接该服务。

注册服务

  首比较慢做的是将服务公开,另另四个前端就能连接它。

  你也能 创建另四个后端服务模块(同类 logger-server-module.ts):

import { ContainerModule } from 'inversify';
import { ConnectionHandler, JsonRpcConnectionHandler } from "../../messaging/common";
import { ILoggerServer, ILoggerClient } from '../../application/common/logger-protocol';

export const loggerServerModule = new ContainerModule(bind => {
    bind(ConnectionHandler).toDynamicValue(ctx =>
        new JsonRpcConnectionHandler<ILoggerClient>("/services/logger", client => {
            const loggerServer = ctx.container.get<ILoggerServer>(ILoggerServer);
            loggerServer.setClient(client);
            return loggerServer;
        })
    ).inSingletonScope()
});

  你们歌词 来删剪看一下:

import { ConnectionHandler, JsonRpcConnectionHandler } from "../../messaging/common";

  你你这些 行导入了JsonRpcConnectionHandler,这是另四个工厂类,你们歌词 用它创建了另四个onConnection连接除理多多守护进程 ,它为后端通过JSON-RPC调用的对象创建另四个代理,并将另四个本地对象公开给JSON-RPC。

接下来你们歌词 来看看具体的实现过程。

  ConnectionHandler是另四个简单的接口,它指定了连接的路径以及在连接创建时的行为。

  它是另另四个的:

import { MessageConnection } from "vscode-jsonrpc";

export const ConnectionHandler = Symbol('ConnectionHandler');

export interface ConnectionHandler {
    readonly path: string;
    onConnection(connection: MessageConnection): void;
}
import { ILoggerServer, ILoggerClient } from '../../application/common/logger-protocol';

  文件logger-protocol.ts蕴含了服务器和客户端也能 实现的接口。

  这里的服务器指的是将通过JSON-RPC调用的后端对象,而客户端指的是可不也能 接收来自后端对象的通知的对象。

  稍后你们歌词 会删剪介绍。

bind<ConnectionHandler>(ConnectionHandler).toDynamicValue(ctx => {

  这里有个地方很神奇,乍一看,它是另四个ConnectionHandler的实现。

  神奇之地处于,你你这些 ConnectionHandler类型是绑定到messaging-module.ts文件中的ContributionProvider的。

  全都有,当MessageingContribution启动时(调用onStart),它为所有绑定ConnectionHandlers创建另四个websocket连接。

  像另另四个(来自messageing-mocule.ts):

constructor( @inject(ContributionProvider) @named(ConnectionHandler) protected readonly handlers: ContributionProvider<ConnectionHandler>) {
    }

    onStart(server: http.Server): void {
        for (const handler of this.handlers.getContributions()) {
            const path = handler.path;
            try {
                createServerWebSocketConnection({
                    server,
                    path
                }, connection => handler.onConnection(connection));
            } catch (error) {
                console.error(error)
            }
        }
    }

  要深入了解ContributionProvider,可不也能 参考

这里

  但会 :

new JsonRpcConnectionHandler<ILoggerClient>("/services/logger", client => {

  你们歌词 来看看你你这些 类的实现做了哪此事情:

export class JsonRpcConnectionHandler<T extends object> implements ConnectionHandler {
    constructor(
        readonly path: string,
        readonly targetFactory: (proxy: JsonRpcProxy<T>) => any
    ) { }

    onConnection(connection: MessageConnection): void {
        const factory = new JsonRpcProxyFactory<T>(this.path);
        const proxy = factory.createProxy();
        factory.target = this.targetFactory(proxy);
        factory.listen(connection);
    }
}

  你们歌词 看了,这里通过ConnectionHandler类的扩展创建了另四个websocker连接,路径是"/services/logger"。

  你们歌词 歌词 来看看你你这些 onConnection具体做了哪此:

onConnection(connection: MessageConnection): void {
        const factory = new JsonRpcProxyFactory<T>(this.path);
        const proxy = factory.createProxy();
        factory.target = this.targetFactory(proxy);
        factory.listen(connection);

  你们歌词 一行一行来看:

const factory = new JsonRpcProxyFactory<T>(this.path);

  后边你你这些 行在路径"/services/logger"上创建了另四个JsonRpcProxy。

const proxy = factory.createProxy();

  但会 ,你们歌词 从工厂创建了另四个代理对象,它将使用ILoggerClient接口来调用JSON-RPC连接的另一端。

factory.target = this.targetFactory(proxy);

  后边你你这些 行将调用你们歌词 在参数中传递的函数,全都有:

client => {
            const loggerServer = ctx.container.get<ILoggerServer>(ILoggerServer);
            loggerServer.setClient(client);
            return loggerServer;
        }

  这里在loggerServer上设置客户端,本例中它用于向前端发送有关日志更改的通知。

  一同它返回loggerServer,用作在JSON-RPC上公开的对象。

factory.listen(connection);

  后边你你这些 行将工厂连接到Connection。

  蕴含services/*路径的endpoints由webpack开发服务器提供,参见webpack.config.js

'/services/*': {
        target: 'ws://localhost:1150',
        ws: true
    },

连接到服务

  现在你们歌词 但会 有了另四个后端服务,你们歌词 歌词 来看看如可另另四个端连接它。

  要做到你你这些 点,你也能 像下面另另四个:

(来自logger-frontend-module.ts)

import { ContainerModule, Container } from 'inversify';
import { WebSocketConnectionProvider } from '../../messaging/browser/connection';
import { ILogger, LoggerFactory, LoggerOptions, Logger } from '../common/logger';
import { ILoggerServer } from '../common/logger-protocol';
import { LoggerWatcher } from '../common/logger-watcher';

export const loggerFrontendModule = new ContainerModule(bind => {
    bind(ILogger).to(Logger).inSingletonScope();
    bind(LoggerWatcher).toSelf().inSingletonScope();
    bind(ILoggerServer).toDynamicValue(ctx => {
        const loggerWatcher = ctx.container.get(LoggerWatcher);
        const connection = ctx.container.get(WebSocketConnectionProvider);
        return connection.createProxy<ILoggerServer>("/services/logger", loggerWatcher.getLoggerClient());
    }).inSingletonScope();
});

  其中最重要的几行:

bind(ILoggerServer).toDynamicValue(ctx => {
        const loggerWatcher = ctx.container.get(LoggerWatcher);
        const connection = ctx.container.get(WebSocketConnectionProvider);
        return connection.createProxy<ILoggerServer>("/services/logger", loggerWatcher.getLoggerClient());
    }).inSingletonScope();

  你们歌词 一行一行来看:

const loggerWatcher = ctx.container.get(LoggerWatcher);

  你你这些 行创建了另四个监听器,它通过loggerWatcher客户端从后端获取有关事件的通知(loggerWatcher.getLoggerClient())。

  不想了解更多有关事件如可在theia中工作的信息,可不也能 查看

这里

const connection = ctx.container.get(WebSocketConnectionProvider);

  后边你你这些 行获得了另四个websocket连接,它将被用来创建另四个代理。

return connection.createProxy<ILoggerServer>("/services/logger", loggerWatcher.getLoggerClient());

  你们歌词 将另四个本地对象作为第十个 参数传入,用来除理来自远程对象的JSON-RPC消息。有时,本地对象依赖于代理,在代理实例化以前无法实例化。你你这些 情況下,代理接口应该实现JsonRpcServer,而本地对象应该作为客户端来提供。

export type JsonRpcServer<Client> = Disposable & {
    setClient(client: Client | undefined): void;
};

export interface ILoggerServer extends JsonRpcServery<ILoggerClient> {
    // ...
}

const serverProxy = connection.createProxy<ILoggerServer>("/services/logger");
const client = loggerWatcher.getLoggerClient();
serverProxy.setClient(client);

  全都有,在最后一行,你们歌词 将ILoggerServer接口绑定到JsonRpc代理。

  注意底层的调用:

createProxy<T extends object>(path: string, target?: object, options?: WebSocketOptions): T {
        const factory = new JsonRpcProxyFactory<T>(path, target);
        this.listen(factory, options);
        return factory.createProxy();
    }

  你你这些 和后端的例子很像。

  也许你也注意到了,就连接而言,这里前端是服务器而后端是客户端,但对你们歌词 的逻辑来说这不必重要。

  这里还有几点:

  • 在路径"logger"上创建JsonRpc代理。

  • 公开loggerWatcher.getLoggerClient()对象。

  • 返回ILoggerServer类型的代理。

  现在,ILoggerServer的实例通过JSON-RPC被代理到后端的LoggerServer对象。

在示例的前端和后端加载模块

  现在你们歌词 但会 有了哪此模块,你们歌词 也能 将它们引入到你们歌词 的示例中。你们歌词 将使用浏览器作为示例,在electron中代码是相同的。

后端

  在examples/browser/src/backend/main.ts中,你也能 像另另四个来引用:

import { loggerServerModule } from 'theia-core/lib/application/node/logger-server-module';

  但会 将其载入到主容器。

container.load(loggerServerModule);

前端

  在examples/browser/src/frontend/main.ts中,你也能 像另另四个来引用:

import { loggerFrontendModule } from 'theia-core/lib/application/browser/logger-frontend-module';
container.load(frontendLanguagesModule);

完成示例

   但会 你想查看本文中提到的删剪示例,可不也能 查看这里的

commit