O protobuff é ótimo - você descreve a composição da sua API em um arquivo .proto, composto por primitivas, e pode gerar código-fonte para diferentes plataformas - por exemplo, um servidor em Java e um cliente em C # ou vice-versa. Como na maioria das vezes essa é uma API para sistemas externos, é mais lógico torná-la imutável, e esse código em si gera um gerador padrão para Java.
Vamos considerar um exemplo:
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; // ,
}
Como resultado, obtemos uma classe com a seguinte interface:
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();
}
Observe que as primitivas são usadas por toda parte (o que é eficiente para serialização e desempenho). Mas o campo de idade é opcional, mas o primitivo sempre tem um valor padrão. Isto é o que surpreende um monte de código padrão com o qual estaremos lutando.
Integer johnAge = john.hasAge() ? john.getAge() : null;
Mas eu realmente quero escrever:
Integer johnAge = john.age().orElse(null); // age() - Optional<Integer>
Os Buffers de Protocolo têm um mecanismo de extensibilidade de plugins e podem ser escritos em Java, que é o que faremos.
O que é um plugin protobuf?
Este é um arquivo executável que lê um objeto PluginProtos.CodeGeneratorRequest do fluxo de entrada padrão, gera um PluginProtos.CodeGeneratorResponse a partir do fluxo de entrada padrão e o grava no fluxo de saída padrão.
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);
}
Vamos dar uma olhada no que podemos gerar?
PluginProtos.CodeGeneratorResponse contém a coleção PluginProtos.CodeGeneratorResponse.File.
Cada "arquivo" é uma nova classe que nós mesmos geramos. Isso consiste de:
String name; // , package
String content; //
String insertionPoint; //
A coisa mais importante para escrever plug-ins - não precisamos regenerar todas as classes - podemos complementar as classes existentes usando o inserttionPoint . Se retornarmos à interface gerada acima, veremos lá:
// @@protoc_insertion_point(interface_extends:org.example.api.Person)
é nesses lugares que podemos adicionar nosso código. Portanto, não poderemos adicionar a uma seção arbitrária da classe. Vamos construir sobre isso. Como podemos resolver este problema? Podemos criar nossa nova interface com um método padrão -
public interface PersonOptional extends PersonOrBuilder {
default Optional<Integer> age() {
return hasAge() ? Optional.of(getAge()) : Optional.empty();
}
}
e para a classe Person, adicione a implementação não apenas de PersonOrBuilder, mas também de PersonOptional
Código para gerar a interface que precisamos
@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();
}
}
Agora vamos retornar do plugin o código que precisa ser gerado
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(),
Como vamos usar nosso novo plugin? - via maven, adicione e configure nosso plugin:
<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>
Mas você também pode executá-lo no console - há um recurso para executar não apenas nosso plug-in, mas antes disso você precisa chamar o compilador java padrão (mas precisa criar um arquivo executável - protoc-gen-java8 (no meu caso, apenas um script bash).
protoc -I=./src/main/resources/ --java_out=./src/main/java/ --java8_out=./src/main/java/ ./src/main/resources/example.proto
O código fonte pode ser visto aqui .