Skip to content

Support parsing custom REST paths from proto files and generating @Ma… #14796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oxsean merged 13 commits into from
Nov 3, 2024
+248 −96
Merged

Support parsing custom REST paths from proto files and generating @Ma… #14796

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
207acd9
Support parsing custom REST paths from proto files and generating @Ma…
heliang666s Oct 19, 2024
1a1b134
add Apache License
heliang666s Oct 19, 2024
cad87be
add @Body annotation and add GrpcBodyArgumentResolver
heliang666s Oct 24, 2024
cff30c8
add Apache License
heliang666s Oct 24, 2024
2d5e9e0
fix ci
heliang666s Oct 29, 2024
1558e14
rename annotation
heliang666s Oct 30, 2024
c8ffb11
optimise import
heliang666s Oct 30, 2024
78db13a
fix bug
heliang666s Oct 30, 2024
3229941
fix bug
heliang666s Oct 30, 2024
d138109
Merge branch '3.3' into custom-uri
heliang666s Oct 30, 2024
9e27114
fix bug
heliang666s Nov 2, 2024
fdb5047
Merge remote-tracking branch 'origin/custom-uri' into custom-uri
heliang666s Nov 2, 2024
2b69646
fix bug
heliang666s Nov 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion dubbo-plugin/dubbo-compiler/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@
<groupId>com.salesforce.servicelibs</groupId>
<artifactId>grpc-contrib</artifactId>
</dependency>
<dependency>
Copy link
Contributor

@oxsean oxsean Oct 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need this module just to generate code?

<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-remoting-http12</artifactId>
<version>${revision}</version>
</dependency>
</dependencies>

<build>
Expand Down Expand Up @@ -100,5 +105,4 @@
</plugin>
</plugins>
</build>

</project>
75 changes: 74 additions & 1 deletion dubbo-plugin/dubbo-compiler/src/main/java/org/apache/dubbo/gen/AbstractGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package org.apache.dubbo.gen;

import org.apache.dubbo.gen.utils.ProtoTypeMap;
import org.apache.dubbo.remoting.http12.HttpMethods;

import javax.annotation.Nonnull;

Expand All @@ -33,6 +34,8 @@
import com.github.mustachejava.DefaultMustacheFactory;
import com.github.mustachejava.Mustache;
import com.github.mustachejava.MustacheFactory;
import com.google.api.AnnotationsProto;
import com.google.api.HttpRule;
import com.google.common.base.Charsets;
import com.google.common.base.Preconditions;
import com.google.common.base.Strings;
Expand All @@ -42,6 +45,7 @@
import com.google.protobuf.DescriptorProtos.MethodDescriptorProto;
import com.google.protobuf.DescriptorProtos.ServiceDescriptorProto;
import com.google.protobuf.DescriptorProtos.SourceCodeInfo.Location;
import com.google.protobuf.ExtensionRegistry;
import com.google.protobuf.compiler.PluginProtos;

public abstract class AbstractGenerator {
Expand Down Expand Up @@ -75,16 +79,32 @@ private String getMethodJavaDocPrefix() {
}

public List<PluginProtos.CodeGeneratorResponse.File> generateFiles(PluginProtos.CodeGeneratorRequest request) {
final ProtoTypeMap typeMap = ProtoTypeMap.of(request.getProtoFileList());
// 1. build ExtensionRegistry and registry
ExtensionRegistry registry = ExtensionRegistry.newInstance();
AnnotationsProto.registerAllExtensions(registry);

// 2. compile proto file
List<FileDescriptorProto> protosToGenerate = request.getProtoFileList().stream()
.filter(protoFile -> request.getFileToGenerateList().contains(protoFile.getName()))
.map(protoFile -> parseWithExtensions(protoFile, registry))
.collect(Collectors.toList());

// 3. use compiled proto file build ProtoTypeMap
final ProtoTypeMap typeMap = ProtoTypeMap.of(protosToGenerate);

// 4. find and generate serviceContext
List<ServiceContext> services = findServices(protosToGenerate, typeMap);
return generateFiles(services);
}

private FileDescriptorProto parseWithExtensions(FileDescriptorProto protoFile, ExtensionRegistry registry) {
try {
return FileDescriptorProto.parseFrom(protoFile.toByteString(), registry);
} catch (Exception e) {
return protoFile;
}
}

private List<ServiceContext> findServices(List<FileDescriptorProto> protos, ProtoTypeMap typeMap) {
List<ServiceContext> contexts = new ArrayList<>();

Expand Down Expand Up @@ -171,6 +191,43 @@ private MethodContext buildMethodContext(
methodContext.isManyOutput = methodProto.getServerStreaming();
methodContext.methodNumber = methodNumber;

// compile google.api.http option
HttpRule httpRule = parseHttpRule(methodProto);
if (httpRule != null) {
methodContext.hasMappings = true;
if (!httpRule.getGet().isEmpty()) {
methodContext.httpMethod = HttpMethods.GET;
} else if (!httpRule.getPost().isEmpty()) {
methodContext.httpMethod = HttpMethods.POST;
} else if (!httpRule.getPut().isEmpty()) {
methodContext.httpMethod = HttpMethods.PUT;
} else if (!httpRule.getDelete().isEmpty()) {
methodContext.httpMethod = HttpMethods.DELETE;
} else {
methodContext.httpMethod = null;
}

if (!httpRule.getGet().isEmpty()) {
methodContext.path = httpRule.getGet();
Copy link
Contributor

@oxsean oxsean Oct 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can it be mege with line 199?

} else if (!httpRule.getPost().isEmpty()) {
methodContext.path = httpRule.getPost();
} else if (!httpRule.getPut().isEmpty()) {
methodContext.path = httpRule.getPut();
} else if (!httpRule.getDelete().isEmpty()) {
methodContext.path = httpRule.getDelete();
} else {
methodContext.path = "";
}

methodContext.body = httpRule.getBody();
} else {
methodContext.httpMethod = null;
methodContext.path = "";
methodContext.body = "";
}

methodContext.hasBody = !Strings.isNullOrEmpty(methodContext.body);

Location methodLocation = locations.stream()
.filter(location -> location.getPathCount() == METHOD_NUMBER_OF_PATHS
&& location.getPath(METHOD_NUMBER_OF_PATHS - 1) == methodNumber)
Expand All @@ -197,6 +254,17 @@ private MethodContext buildMethodContext(
return methodContext;
}

private HttpRule parseHttpRule(MethodDescriptorProto methodProto) {
HttpRule rule = null;
// check methodProto have options
if (methodProto.hasOptions()) {
if (methodProto.getOptions().hasExtension(AnnotationsProto.http)) {
rule = methodProto.getOptions().getExtension(AnnotationsProto.http);
}
}
return rule;
}

private String lowerCaseFirst(String s) {
return Character.toLowerCase(s.charAt(0)) + s.substring(1);
}
Expand Down Expand Up @@ -360,6 +428,11 @@ private static class MethodContext {
public String grpcCallsMethodName;
public int methodNumber;
public String javaDoc;
public HttpMethods httpMethod;
public String path;
public String body; // requestBody
Copy link
Contributor

@oxsean oxsean Oct 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make the comments readable
e.g.: Specify the message field that the HTTP request body mapping to

public boolean hasMappings;
public boolean hasBody;

// This method mimics the upper-casing method ogf gRPC to ensure compatibility
// See https://github.com/grpc/grpc-java/blob/v1.8.0/compiler/src/java_plugin/cpp/java_generator.cpp#L58
Expand Down
40 changes: 29 additions & 11 deletions dubbo-plugin/dubbo-compiler/src/main/resources/Dubbo3TripleInterfaceStub.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,14 @@
*/

{{#packageName}}
package {{packageName}};
package {{packageName}};
Copy link
Contributor

@oxsean oxsean Oct 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unnecessary indent?

{{/packageName}}

import org.apache.dubbo.common.stream.StreamObserver;
import org.apache.dubbo.remoting.http12.HttpMethods;
import org.apache.dubbo.remoting.http12.rest.Mapping;
import org.apache.dubbo.rpc.stub.annotations.Grequest;

import com.google.protobuf.Message;

import java.util.HashMap;
Expand All @@ -29,44 +33,58 @@ import java.util.concurrent.CompletableFuture;

public interface {{interfaceClassName}} extends org.apache.dubbo.rpc.model.DubboStub {

String JAVA_SERVICE_NAME = "{{packageName}}.{{serviceName}}";
String JAVA_SERVICE_NAME = "{{packageName}}.{{serviceName}}";
{{#commonPackageName}}
String SERVICE_NAME = "{{commonPackageName}}.{{serviceName}}";
{{/commonPackageName}}
{{^commonPackageName}}
String SERVICE_NAME = "{{serviceName}}";
{{/commonPackageName}}

{{#unaryMethods}}
{{#javaDoc}}
{{{javaDoc}}}
{{{javaDoc}}}
{{/javaDoc}}
{{outputType}} {{methodName}}({{inputType}} request);

CompletableFuture<{{outputType}}> {{methodName}}Async({{inputType}} request);

{{#hasMappings}}
@Mapping(method = HttpMethods.{{httpMethod}}, path = "{{path}}")
Copy link
Contributor

@oxsean oxsean Oct 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Try to make sure that the indents of the generated code is correct.

{{/hasMappings}}
public {{outputType}} {{methodName}}({{#hasBody}}@Grequest {{/hasBody}}{{inputType}} request);

CompletableFuture<{{outputType}}> {{methodName}}Async({{#hasBody}}@Grequest {{/hasBody}}{{inputType}} request);

{{/unaryMethods}}

{{#serverStreamingMethods}}
{{#javaDoc}}
{{{javaDoc}}}
{{{javaDoc}}}
{{/javaDoc}}
void {{methodName}}({{inputType}} request, StreamObserver<{{outputType}}> responseObserver);

{{#hasMappings}}
@Mapping(method = HttpMethods.{{httpMethod}}, uri = "{{uri}}")
{{/hasMappings}}
void {{methodName}}({{#hasBody}}@Grequest{{/hasBody}}{{inputType}} request, StreamObserver<{{outputType}}> responseObserver);
{{/serverStreamingMethods}}

{{#biStreamingWithoutClientStreamMethods}}
{{#javaDoc}}
{{{javaDoc}}}
{{{javaDoc}}}
{{/javaDoc}}

{{#hasMappings}}
@Mapping(method = HttpMethods.{{httpMethod}}, uri = "{{uri}}")
{{/hasMappings}}
StreamObserver<{{inputType}}> {{methodName}}(StreamObserver<{{outputType}}> responseObserver);
{{/biStreamingWithoutClientStreamMethods}}


{{#clientStreamingMethods}}
{{#javaDoc}}
{{{javaDoc}}}
{{{javaDoc}}}
{{/javaDoc}}

{{#hasMappings}}
@Mapping(method = HttpMethods.{{httpMethod}}, uri = "{{uri}}")
{{/hasMappings}}
StreamObserver<{{inputType}}> {{methodName}}(StreamObserver<{{outputType}}> responseObserver);
{{/clientStreamingMethods}}

Expand Down
Loading