プロトバフはすばらしいことです。APIの構成をプリミティブで構成される.protoファイルで記述し、JavaのサーバーとC＃のクライアント、またはその逆など、さまざまなプラットフォームのソースコードを生成できます。ほとんどの場合、これは外部システム用のAPIであるため、不変にする方が論理的であり、このコード自体がJavaの標準ジェネレーターを生成します。
例を考えてみましょう：
syntax = "proto2";
option java_multiple_files = true;
package org.example.api;
message Person { //
required int32 id = 1; // ,
required string name = 2; // ,
optional int32 age = 3; // ,
}
その結果、次のインターフェースを持つクラスを取得します。
public interface PersonOrBuilder extends
// @@protoc_insertion_point(interface_extends:org.example.api.Person)
com.google.protobuf.MessageOrBuilder {
boolean hasId();
int getId();
boolean hasName();
java.lang.String getName();
com.google.protobuf.ByteString getNameBytes();
boolean hasAge();
int getAge();
}
プリミティブは全体で使用されることに注意してください（これはシリアライズとパフォーマンスにとって効率的です）。ただし、年齢フィールドはオプションですが、プリミティブには常にデフォルト値があります。これは、私たちがこれから戦うボイラープレートコードの束を驚かせるものです。
Integer johnAge = john.hasAge() ? john.getAge() : null;
しかし、私は本当に書きたいです：
Integer johnAge = john.age().orElse(null); // age() - Optional<Integer>
プロトコルバッファにはプラグイン拡張メカニズムがあり、Javaで記述できます。
protobufプラグインとは何ですか？
これは、標準入力ストリームからPluginProtos.CodeGeneratorRequestオブジェクトを読み取り、標準入力ストリームからPluginProtos.CodeGeneratorResponseを生成して、標準出力ストリームに書き込む実行可能ファイルです。
public static void main(String[] args) throws IOException {
PluginProtos.CodeGeneratorRequest codeRequest = PluginProtos.CodeGeneratorRequest.parseFrom(System.in);
PluginProtos.CodeGeneratorResponse codeResponse;
try {
codeResponse = generate(codeRequest);
} catch (Exception e) {
codeResponse = PluginProtos.CodeGeneratorResponse.newBuilder()
.setError(e.getMessage())
.build();
}
codeResponse.writeTo(System.out);
}
生成できるものを詳しく見てみましょう。
PluginProtos.CodeGeneratorResponseには、PluginProtos.CodeGeneratorResponse.Fileコレクションが含まれています。
各「ファイル」は、私たちが自分で生成する新しいクラスです。それはで構成されています：
String name; // , package
String content; //
String insertionPoint; //
プラグインを書くための最も重要なことは-私たちは、すべてのクラスを再生成する必要はありません-私たちが使用して既存のクラス補完することができinsertionPointを。上記の生成されたインターフェースに戻ると、そこに表示されます。
// @@protoc_insertion_point(interface_extends:org.example.api.Person)
コードを追加できるのはこれらの場所です。したがって、クラスの任意のセクションに追加することはできません。これに基づいて構築します。どうすればこの問題を解決できますか？デフォルトのメソッドで新しいインターフェースを作成できます-
public interface PersonOptional extends PersonOrBuilder {
default Optional<Integer> age() {
return hasAge() ? Optional.of(getAge()) : Optional.empty();
}
}
Personクラスには、PersonOrBuilderだけでなくPersonOptionalの実装も追加します
必要なインターフェースを生成するコード
@Builder
public class InterfaceWriter {
private static final Map<DescriptorProtos.FieldDescriptorProto.Type, Class<?>> typeToClassMap = ImmutableMap.<DescriptorProtos.FieldDescriptorProto.Type, Class<?>>builder()
.put(TYPE_DOUBLE, Double.class)
.put(TYPE_FLOAT, Float.class)
.put(TYPE_INT64, Long.class)
.put(TYPE_UINT64, Long.class)
.put(TYPE_INT32, Integer.class)
.put(TYPE_FIXED64, Long.class)
.put(TYPE_FIXED32, Integer.class)
.put(TYPE_BOOL, Boolean.class)
.put(TYPE_STRING, String.class)
.put(TYPE_UINT32, Integer.class)
.put(TYPE_SFIXED32, Integer.class)
.put(TYPE_SINT32, Integer.class)
.put(TYPE_SFIXED64, Long.class)
.put(TYPE_SINT64, Long.class)
.build();
private final String packageName;
private final String className;
private final List<DescriptorProtos.FieldDescriptorProto> fields;
public String getCode() {
List<MethodSpec> methods = fields.stream().map(field -> {
ClassName fieldClass;
if (typeToClassMap.containsKey(field.getType())) {
fieldClass = ClassName.get(typeToClassMap.get(field.getType()));
} else {
int lastIndexOf = StringUtils.lastIndexOf(field.getTypeName(), '.');
fieldClass = ClassName.get(field.getTypeName().substring(1, lastIndexOf), field.getTypeName().substring(lastIndexOf + 1));
}
return MethodSpec.methodBuilder(field.getName())
.addModifiers(Modifier.DEFAULT, Modifier.PUBLIC)
.returns(ParameterizedTypeName.get(ClassName.get(Optional.class), fieldClass))
.addStatement("return has$N() ? $T.of(get$N()) : $T.empty()", capitalize(field.getName()), Optional.class, capitalize(field.getName()), Optional.class)
.build();
}).collect(Collectors.toList());
TypeSpec generatedInterface = TypeSpec.interfaceBuilder(className + "Optional")
.addSuperinterface(ClassName.get(packageName, className + "OrBuilder"))
.addModifiers(Modifier.PUBLIC)
.addMethods(methods)
.build();
return JavaFile.builder(packageName, generatedInterface).build().toString();
}
}
次に、生成する必要があるコードをプラグインから戻しましょう
PluginProtos.CodeGeneratorResponse.File.newBuilder() // InsertionPoint,
.setName(String.format("%s/%sOptional.java", clazzPackage.replaceAll("\\.", "/"), clazzName))
.setContent(InterfaceWriter.builder().packageName(clazzPackage).className(clazzName).fields(optionalFields).build().getCode())
.build();
PluginProtos.CodeGeneratorResponse.File.newBuilder()
.setName(String.format("%s/%s.java", clazzPackage.replaceAll("\\.", "/"), clazzName))
.setInsertionPoint(String.format("message_implements:%s.%s", clazzPackage, clazzName)) // - message -
.setContent(String.format(" %s.%sOptional, ", clazzPackage, clazzName))
.build(),
新しいプラグインをどのように使用しますか？-mavenを介して、プラグインを追加して構成します。
<plugin>
<groupId>org.xolstice.maven.plugins</groupId>
<artifactId>protobuf-maven-plugin</artifactId>
<version>0.6.1</version>
<extensions>true</extensions>
<configuration>
<pluginId>java8</pluginId>
<protoSourceRoot>${basedir}/src/main/proto</protoSourceRoot>
<protocPlugins>
<protocPlugin>
<id>java8</id>
<groupId>org.example.protobuf</groupId>
<artifactId>optional-plugin</artifactId>
<version>1.0-SNAPSHOT</version>
<mainClass>org.example.proto2plugin.OptionalPlugin</mainClass>
</protocPlugin>
</protocPlugins>
</configuration>
</plugin>
ただし、コンソールから実行することもできます。プラグインだけでなく、その前に標準のJavaコンパイラを呼び出す必要がある機能が1つあります（ただし、実行可能ファイルを作成する必要があります-protoc-gen-java8（私の場合は、bashスクリプトのみ））。
protoc -I=./src/main/resources/ --java_out=./src/main/java/ --java8_out=./src/main/java/ ./src/main/resources/example.proto
ソースコードはこちらからご覧いただけます。