Skip to content

Commit

Permalink
GH-364 - Register reflection metadata for ApplicationListenerMethodAd…
Browse files Browse the repository at this point in the history
…apter.

The maintain general compatibility with Spring Framework 6.0, we issue a few reflective inspections on ApplicationListenerMethodAdapter. To make this work properly in native images, we now register those methods for GraalVM reflection.
  • Loading branch information
odrotbohm committed Nov 7, 2023
1 parent e2cc4fe commit 3692a20
Show file tree
Hide file tree
Showing 3 changed files with 109 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
/*
* Copyright 2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.modulith.events.aot;

import org.springframework.aot.hint.ExecutableMode;
import org.springframework.aot.hint.RuntimeHints;
import org.springframework.aot.hint.RuntimeHintsRegistrar;
import org.springframework.context.ApplicationEvent;
import org.springframework.context.event.ApplicationListenerMethodAdapter;
import org.springframework.util.ReflectionUtils;

/**
* @author Oliver Drotbohm
*/
public class ApplicationListenerMethodAdapterRuntimeHints implements RuntimeHintsRegistrar {

/*
* (non-Javadoc)
* @see org.springframework.aot.hint.RuntimeHintsRegistrar#registerHints(org.springframework.aot.hint.RuntimeHints, java.lang.ClassLoader)
*/
@Override
public void registerHints(RuntimeHints hints, ClassLoader classLoader) {

var reflection = hints.reflection();

var method = ReflectionUtils.findMethod(ApplicationListenerMethodAdapter.class,
"shouldHandle", ApplicationEvent.class);

if (method == null) {
method = ReflectionUtils.findMethod(ApplicationListenerMethodAdapter.class,
"shouldHandle", ApplicationEvent.class, Object[].class);
}

if (method != null) {
reflection.registerMethod(method, ExecutableMode.INVOKE);
}
}
}
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
org.springframework.beans.factory.aot.BeanRegistrationAotProcessor=\
org.springframework.modulith.events.aot.TransactionalEventListenerAotProcessor
org.springframework.aot.hint.RuntimeHintsRegistrar=\
org.springframework.modulith.events.aot.ApplicationListenerMethodAdapterRuntimeHints
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/*
* Copyright 2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.modulith.events.aot;

import static org.assertj.core.api.Assertions.*;
import static org.assertj.core.api.InstanceOfAssertFactories.*;

import org.junit.jupiter.api.Test;
import org.springframework.aot.hint.ExecutableHint;
import org.springframework.aot.hint.ExecutableMode;
import org.springframework.aot.hint.RuntimeHints;
import org.springframework.context.event.ApplicationListenerMethodAdapter;

/**
* Unit tests for {@link ApplicationListenerMethodAdapterRuntimeHints}.
*
* @author Oliver Drotbohm
*/
class ApplicationListenerMethodAdapterRuntimeHintsUnitTests {

@Test // GH-364
void registersMethodsForReflection() {

var hints = new RuntimeHints();

new ApplicationListenerMethodAdapterRuntimeHints()
.registerHints(hints, getClass().getClassLoader());

var typeHint = hints.reflection()
.getTypeHint(ApplicationListenerMethodAdapter.class);

assertThat(typeHint)
.isNotNull()
.extracting(it -> it.methods())
.asInstanceOf(stream(ExecutableHint.class))
.hasSize(1)
.element(0)
.satisfies(it -> {
assertThat(it.getName()).isEqualTo("shouldHandle");
assertThat(it.getMode()).isEqualTo(ExecutableMode.INVOKE);
});
}
}

0 comments on commit 3692a20

Please sign in to comment.