Skip to content

Add Protobuf Support #3954

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

Open
DanielLiu1123 wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Add Protobuf Support #3954

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f563b59
feat: Add Protobuf support
Nov 5, 2025
a6ad574
support oneof
DanielLiu1123 Nov 10, 2025
44b0d5b
add test for proto2 and edition 2023
DanielLiu1123 Nov 10, 2025
6812517
add license header
DanielLiu1123 Nov 10, 2025
6ae402e
fixes lint
DanielLiu1123 Nov 10, 2025
aa82e7c
should not depends on Deprecated annotation
DanielLiu1123 Nov 12, 2025
67d047d
there is a bug for map<string, enum> m_string_enum_map
DanielLiu1123 Nov 12, 2025
4fa356e
fixes previous bug
DanielLiu1123 Nov 13, 2025
998f32d
Add more test case
DanielLiu1123 Nov 13, 2025
08a8e7d
optimize isRepeatedGetter
DanielLiu1123 Nov 13, 2025
c11eecc
Merge branch 'main' into feature-protobuf
DanielLiu1123 Apr 23, 2026
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
Prev Previous commit
Next Next commit
should not depends on Deprecated annotation
  • Loading branch information
@DanielLiu1123
DanielLiu1123 committed Nov 12, 2025
commit aa82e7c55668ec2d7bd2aa0c7672613b03998b9f
182 changes: 140 additions & 42 deletions processor/src/main/java/org/mapstruct/ap/spi/ProtobufAccessorNamingStrategy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,7 @@ public boolean isGetterMethod(ExecutableElement method) {
return hasPrefixWithUpperCaseNext( method, "get" )
&& method.getParameters().isEmpty()
&& !isInternalMethod( method )
&& !isDeprecated( method )
&& !isSpecialGetMethod( method );
&& !isSpecialGetterMethod( method );
}

@Override
Expand Down Expand Up @@ -125,7 +124,7 @@ protected boolean isFluentSetter(ExecutableElement method) {
return hasPrefixWithUpperCaseNext( method, "set" )
&& method.getParameters().size() == 1
&& !isInternalMethod( method )
&& !isSpecialSetMethod( method );
&& !isSpecialSetterMethod( method );
}

@Override
Expand Down Expand Up @@ -159,12 +158,12 @@ public String getPropertyName(ExecutableElement getterOrSetterMethod) {
String methodName = getterOrSetterMethod.getSimpleName().toString();

// 'get...Map'
if ( isGetMap( getterOrSetterMethod ) ) {
if ( isMapGetter( getterOrSetterMethod ) ) {
return IntrospectorUtils.decapitalize( methodName.substring( 3, methodName.length() - 3 ) );
}

// 'get...List'
if ( isGetList( getterOrSetterMethod ) ) {
if ( isRepeatedGetter( getterOrSetterMethod ) ) {
return IntrospectorUtils.decapitalize( methodName.substring( 3, methodName.length() - 4 ) );
}

Expand Down Expand Up @@ -203,6 +202,17 @@ private Map<String, Set<MethodSignature>> getInternalMethods() {

private List<SpecialMethodRule> getSpecialGetterRules() {
List<SpecialMethodRule> rules = new ArrayList<>();
rules.addAll( stringGetterSpecialMethodRules() );
rules.addAll( messageGetterGetterMethodRules() );
rules.addAll( enumGetterSpecialMethodRules() );
rules.addAll( repeatedGetterSpecialMethodRules() );
rules.addAll( mapGetterSpecialMethodRules() );
rules.addAll( oneofGetterSpecialMethodRules() );
return rules;
}

private List<SpecialMethodRule> stringGetterSpecialMethodRules() {
List<SpecialMethodRule> rules = new ArrayList<>();

// string field generates extra getXxxBytes() method
rules.add( new SpecialMethodRule(
Expand All @@ -217,29 +227,11 @@ && isTargetClass( m.getReturnType(), String.class )
}
) );

// repeated and map field generates extra getXxxCount() method
rules.add( new SpecialMethodRule(
method -> getMethodName( method ).endsWith( "Count" ),
(method, methods) -> {
String methodName = getMethodName( method );
String withoutSuffix = methodName.substring( 0, methodName.length() - "Count".length() );
// map field generates getXxxMap() getter (getXxx() is deprecated)
boolean hasMapGetter = methods.stream()
.anyMatch( m -> ( getMethodName( m ).equals( withoutSuffix + "Map" ) ||
getMethodName( m ).equals( withoutSuffix ) )
&& isMapType( m.getReturnType() )
);
if ( hasMapGetter ) {
return true;
}
// repeated field generates getXxxList() getter
return methods.stream()
.anyMatch( m ->
getMethodName( m ).equals( withoutSuffix + "List" )
&& isListType( m.getReturnType() )
);
}
) );
return rules;
}

private List<SpecialMethodRule> messageGetterGetterMethodRules() {
List<SpecialMethodRule> rules = new ArrayList<>();

// message field generates extra getXxxBuilder() method
rules.add( new SpecialMethodRule(
Expand Down Expand Up @@ -293,6 +285,12 @@ && isListType( m.getReturnType() )
}
) );

return rules;
}

private List<SpecialMethodRule> enumGetterSpecialMethodRules() {
List<SpecialMethodRule> rules = new ArrayList<>();

// enum field generates extra 'int getXxxValue()' method
rules.add( new SpecialMethodRule(
method -> getMethodName( method ).endsWith( "Value" ),
Expand Down Expand Up @@ -334,6 +332,74 @@ && isMapType( m.getReturnType() )
}
) );

return rules;
}

private List<SpecialMethodRule> repeatedGetterSpecialMethodRules() {
List<SpecialMethodRule> rules = new ArrayList<>();

// repeated field generates 'getXxxCount()' method
rules.add( new SpecialMethodRule(
method -> getMethodName( method ).endsWith( "Count" ),
(method, methods) -> {
String methodName = getMethodName( method );
String withoutSuffix = methodName.substring( 0, methodName.length() - "Count".length() );
return methods.stream().anyMatch( m ->
getMethodName( m ).equals( withoutSuffix + "List" )
&& isListType( m.getReturnType() )
);
}
) );

return rules;
}

private List<SpecialMethodRule> mapGetterSpecialMethodRules() {
List<SpecialMethodRule> rules = new ArrayList<>();

// map field generates 'getXxxCount()' method
rules.add( new SpecialMethodRule(
method -> getMethodName( method ).endsWith( "Count" ),
(method, methods) -> {
String methodName = getMethodName( method );
String withoutSuffix = methodName.substring( 0, methodName.length() - "Count".length() );
return methods.stream().anyMatch( m ->
getMethodName( m ).equals( withoutSuffix + "Map" )
&& isMapType( m.getReturnType() )
);
}
) );

// map field generates deprecated 'getXxx()' and 'getMutableXxx()' methods
rules.add( new SpecialMethodRule(
method -> getMethodName( method ).startsWith( "get" )
&& !getMethodName( method ).endsWith( "Map" )
&& isMapType( method.getReturnType() ),
(method, methods) -> {
String methodName = getMethodName( method );
if ( methodName.startsWith( "getMutable" ) ) {
String withoutPrefix = methodName.substring( "getMutable".length() );
return methods.stream().anyMatch( m ->
getMethodName( m ).equals( "get" + withoutPrefix + "Map" )
&& isMapType( m.getReturnType() )
);
}
else {
String withoutPrefix = methodName.substring( "get".length() );
return methods.stream().anyMatch( m ->
getMethodName( m ).equals( "get" + withoutPrefix + "Map" )
&& isMapType( m.getReturnType() )
);
}
}
) );

return rules;
}

private List<SpecialMethodRule> oneofGetterSpecialMethodRules() {
List<SpecialMethodRule> rules = new ArrayList<>();

// oneof field generates extra 'getXxxCase()'
rules.add( new SpecialMethodRule(
method -> getMethodName( method ).endsWith( "Case" )
Expand All @@ -347,6 +413,14 @@ && isEnumType( method.getReturnType() )

private List<SpecialMethodRule> getSpecialSetterRules() {
List<SpecialMethodRule> rules = new ArrayList<>();
rules.addAll( stringSetterSpecialMethodRules() );
rules.addAll( enumSetterSpecialMethodRules() );
rules.addAll( messageSetterSpecialMethodRules() );
return rules;
}

private List<SpecialMethodRule> stringSetterSpecialMethodRules() {
List<SpecialMethodRule> rules = new ArrayList<>();

// string field generates extra setXxxBytes() method
rules.add( new SpecialMethodRule(
Expand All @@ -362,7 +436,13 @@ && isFirstParameterTargetClass( m, String.class )
}
) );

// enum field generates extra 'setXxxValue(int value)' method
return rules;
}

private List<SpecialMethodRule> enumSetterSpecialMethodRules() {
List<SpecialMethodRule> rules = new ArrayList<>();

// enum field generates extra 'setXxxValue(int)' method
rules.add( new SpecialMethodRule(
method -> hasPrefixWithUpperCaseNext( method, "set" )
&& getMethodName( method ).endsWith( "Value" )
Expand Down Expand Up @@ -410,6 +490,12 @@ && isFirstParameterTargetClass( m, Map.class )
}
) );

return rules;
}

private List<SpecialMethodRule> messageSetterSpecialMethodRules() {
List<SpecialMethodRule> rules = new ArrayList<>();

// message field generates extra setXxx(Message.Builder builder) method
rules.add( new SpecialMethodRule(
method -> hasPrefixWithUpperCaseNext( method, "set" )
Expand Down Expand Up @@ -440,7 +526,7 @@ private static boolean isFirstParameterTargetClass(ExecutableElement method, Cla
return isFirstParameterTargetClass( method, targetClass.getCanonicalName() );
}

private boolean isSpecialGetMethod(ExecutableElement method) {
private boolean isSpecialGetterMethod(ExecutableElement method) {
List<ExecutableElement> allMethods = getPublicNonStaticMethods( method.getEnclosingElement() );
for ( SpecialMethodRule rule : specialGetterRules ) {
if ( rule.matches( method, allMethods ) ) {
Expand All @@ -450,7 +536,7 @@ private boolean isSpecialGetMethod(ExecutableElement method) {
return false;
}

private boolean isSpecialSetMethod(ExecutableElement method) {
private boolean isSpecialSetterMethod(ExecutableElement method) {
List<ExecutableElement> allMethods = getPublicNonStaticMethods( method.getEnclosingElement() );
for ( SpecialMethodRule rule : specialSetterRules ) {
if ( rule.matches( method, allMethods ) ) {
Expand All @@ -463,13 +549,13 @@ private boolean isSpecialSetMethod(ExecutableElement method) {
private boolean isAddAllMethod(ExecutableElement method) {
return hasPrefixWithUpperCaseNext( method, "addAll" )
&& isFirstParameterTargetClass( method, Iterable.class )
&& !isSpecialSetMethod( method );
&& !isSpecialSetterMethod( method );
}

private boolean isPutAllMethod(ExecutableElement method) {
return hasPrefixWithUpperCaseNext( method, "putAll" )
&& isFirstParameterTargetClass( method, Map.class )
&& !isSpecialSetMethod( method );
&& !isSpecialSetterMethod( method );
}

private static boolean isTargetClass(TypeMirror paramType, Class<?> targetType) {
Expand Down Expand Up @@ -502,30 +588,37 @@ private boolean isEnumType(TypeMirror t) {
return element.getKind() == ElementKind.ENUM;
}

private boolean isGetList(ExecutableElement element) {
private boolean isRepeatedGetter(ExecutableElement element) {
// repeated fields getter: getXxxList()
return hasPrefixWithUpperCaseNext( element, "get" )
&& getMethodName( element ).endsWith( "List" )
&& isListType( element.getReturnType() );
}

private boolean isGetMap(ExecutableElement element) {
private boolean isMapGetter(ExecutableElement element) {
// There are many getter methods for map in protobuf generated code, only one is the real getter:
// - getXxx deprecated
// - getMutableXxx deprecated
// - getXxxMap the real getter
return hasPrefixWithUpperCaseNext( element, "get" )
&& isMapType( element.getReturnType() )
&& !isDeprecated( element );
if ( hasPrefixWithUpperCaseNext( element, "get" )
&& getMethodName( element ).endsWith( "Map" )
&& isMapType( element.getReturnType() ) ) {
List<ExecutableElement> allMethods = getPublicNonStaticMethods( element.getEnclosingElement() );
for ( SpecialMethodRule rule : mapGetterSpecialMethodRules() ) {
if ( rule.matches( element, allMethods ) ) {
return false;
}
}
return true;
}

return false;
}

private static String getMethodName(ExecutableElement element) {
return element.getSimpleName().toString();
}

private static boolean isDeprecated(ExecutableElement element) {
return element.getAnnotation( Deprecated.class ) != null;
}

private static boolean isListType(TypeMirror t) {
return isTargetClass( t, List.class ) || t.toString().startsWith( PROTOCOL_STRING_LIST );
}
Expand Down Expand Up @@ -689,6 +782,11 @@ public SpecialMethodRule(
public boolean matches(ExecutableElement method, List<ExecutableElement> allMethods) {
return quickCheck.test( method ) && fullCheck.test( method, allMethods );
}

public boolean matches(ExecutableElement method) {
List<ExecutableElement> allMethods = getPublicNonStaticMethods( method.getEnclosingElement() );
return quickCheck.test( method ) && fullCheck.test( method, allMethods );
}
}

private static final class MethodSignature {
Expand Down