ProtocolBuffersのTypeScriptを生成するプラグインを作ってみた

ProtocolBuffersとは

gRPC？

デメリット

今回作ったもの

使用準備

1. protocを取得
2. goをインストール
3. ソースをビルド

1. protocを取得

2. goをインストール

3. ソースをビルド

$ go get github.com/golang/protobuf/proto
$ go build plugin/src/protoc-gen-tsi.go

実行

1. protoファイル用意
2. 各種ツール配置
3. 実行
4. 結果

1. protoファイル用意

syntax = "proto3";

package Sample1;

enum Sample1Enum {
    V1 = 0;
    V2 = 1;
    V3 = 2;
}

message Sample1Input {
    string Vaue1 = 1;
    int32 Value2 = 2;
}

message Sample1Output {
    string Value1 = 1;
    string Value2 = 2;
    Sample1Enum Value3 = 3;
}

message Sample1Output2 {
    int64 Value1 = 1;
}

service Sample1 {
    rpc API1 (Sample1Input) returns (Sample1Output);
    rpc API2 (Sample1Input) returns (Sample1Output2);
}

syntax = "proto3";

package Sample2;
import "Sample1.proto";

message Sample2Input {
    Sample1.Sample1Input Value = 1;
}

message Sample2Output {
    string Value = 1;
}

service Sample2 {
    rpc API1 (Sample2Input) returns (Sample2Output);
}

2. 各種ツール配置

root
┝ bin
│┝ protoc (公式からダウンロードしてきたやつ)
│└ protoc-gen-tsi (上でgoで作ったやつ)
┝ outut (フォルダ)
┝ Sample1.proto
└ Sampel2.proto

3. 実行

$ ./bin/protoc --plugin="protoc-gen-tsi=./bin/protoc-gen-tsi" --tsi_out=./output *.proto

# Windowsの場合は.exeがいるかも
$ ./bin/protoc --plugin="protoc-gen-tsi=./bin/protoc-gen-tsi.exe" --tsi_out=./output *.proto

4. 結果

export const PackageName = 'Sample1';

export enum Sample1Enum
{
    V1 = 0,
    V2 = 1,
    V3 = 2,
}

export interface Sample1Input
{
    Vaue1? : string;
    Value2? : number;
}

export interface Sample1Output
{
    Value1? : string;
    Value2? : string;
    Value3? : Sample1Enum;
}

export interface Sample1Output2
{
    Value1? : number;
}


export interface Sample1
{
    API1(input: Sample1Input) : Promise;
    API2(input: Sample1Input) : Promise;
}

export class Sample1Client
    implements Sample1
{

    constructor(
        private basePath: string
                = '',                                          // default
        private makeUrl: (basePath: string, packageName: string, className:string, methodName: string) => string
                = (b, _, c, m) => `${b}${c}/${m}`,             // =default
        private makeHeaders: (baseHeaders: {}) => {}
                = (h) => h,                                    // =default
        private makeQuery: (baseQuery: {}) => {}
                = (q) => q                                     // =default
    ) {}

    
    async API1 (input: Sample1Input) : Promise {
        const url = this.makeUrl(this.basePath, PackageName, 'Sample1', 'API1');
        const headers = this.makeHeaders({'Content-Type': 'application/json'});
        const query = this.makeQuery({
            method: 'POST',
            headers,
            body: JSON.stringify(input)
        });
        const response = await fetch(url, query);
        return (await response.json()) as Sample1Output;
    }
    
    async API2 (input: Sample1Input) : Promise {
        const url = this.makeUrl(this.basePath, PackageName, 'Sample1', 'API2');
        const headers = this.makeHeaders({'Content-Type': 'application/json'});
        const query = this.makeQuery({
            method: 'POST',
            headers,
            body: JSON.stringify(input)
        });
        const response = await fetch(url, query);
        return (await response.json()) as Sample1Output2;
    }
    
}

import * as Sample1 from './Sample1.proto';


export const PackageName = 'Sample2';


export interface Sample2Input
{
    Value? : Sample1.Sample1Input;
}

export interface Sample2Output
{
    Value? : string;
}


export interface Sample2
{
    API1(input: Sample2Input) : Promise;
}

export class Sample2Client
    implements Sample2
{

    constructor(
        private basePath: string
                = '',                                          // default
        private makeUrl: (basePath: string, packageName: string, className:string, methodName: string) => string
                = (b, _, c, m) => `${b}${c}/${m}`,             // =default
        private makeHeaders: (baseHeaders: {}) => {}
                = (h) => h,                                    // =default
        private makeQuery: (baseQuery: {}) => {}
                = (q) => q                                     // =default
    ) {}

    
    async API1 (input: Sample2Input) : Promise {
        const url = this.makeUrl(this.basePath, PackageName, 'Sample2', 'API1');
        const headers = this.makeHeaders({'Content-Type': 'application/json'});
        const query = this.makeQuery({
            method: 'POST',
            headers,
            body: JSON.stringify(input)
        });
        const response = await fetch(url, query);
        return (await response.json()) as Sample2Output;
    }
    
}