Theia APIs——通过JSON

  • 时间:
  • 浏览:4

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