Only use payload if it actually matches declared event type

Closes gh-22426
This commit is contained in:
Juergen Hoeller 2019-02-25 17:18:07 +01:00
parent 707b8c02fe
commit 4be41e9e26
2 changed files with 82 additions and 8 deletions

View File

@ -188,9 +188,9 @@ public class ApplicationListenerMethodAdapter implements GenericApplicationListe
/** /**
* Resolve the method arguments to use for the specified {@link ApplicationEvent}. * Resolve the method arguments to use for the specified {@link ApplicationEvent}.
* <p>These arguments will be used to invoke the method handled by this instance. Can * <p>These arguments will be used to invoke the method handled by this instance.
* return {@code null} to indicate that no suitable arguments could be resolved and * Can return {@code null} to indicate that no suitable arguments could be resolved
* therefore the method should not be invoked at all for the specified event. * and therefore the method should not be invoked at all for the specified event.
*/ */
@Nullable @Nullable
protected Object[] resolveArguments(ApplicationEvent event) { protected Object[] resolveArguments(ApplicationEvent event) {
@ -201,14 +201,16 @@ public class ApplicationListenerMethodAdapter implements GenericApplicationListe
if (this.method.getParameterCount() == 0) { if (this.method.getParameterCount() == 0) {
return new Object[0]; return new Object[0];
} }
if (!ApplicationEvent.class.isAssignableFrom(declaredEventType.toClass()) && Class<?> declaredEventClass = declaredEventType.toClass();
if (!ApplicationEvent.class.isAssignableFrom(declaredEventClass) &&
event instanceof PayloadApplicationEvent) { event instanceof PayloadApplicationEvent) {
return new Object[] {((PayloadApplicationEvent) event).getPayload()}; Object payload = ((PayloadApplicationEvent) event).getPayload();
if (declaredEventClass.isInstance(payload)) {
return new Object[] {payload};
}
} }
else {
return new Object[] {event}; return new Object[] {event};
} }
}
protected void handleResult(Object result) { protected void handleResult(Object result) {
if (result.getClass().isArray()) { if (result.getClass().isArray()) {

View File

@ -0,0 +1,72 @@
/*
* Copyright 2002-2019 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
*
* http://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.context.event;
import java.util.ArrayList;
import java.util.List;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.PayloadApplicationEvent;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.stereotype.Component;
import static org.junit.Assert.*;
/**
* @author Juergen Hoeller
*/
public class PayloadApplicationEventTests {
@Test
public void testEventClassWithInterface() {
ApplicationContext ac = new AnnotationConfigApplicationContext(Listener.class);
MyEventClass event = new MyEventClass<>(this, "xyz");
ac.publishEvent(event);
assertTrue(ac.getBean(Listener.class).events.contains(event));
}
public interface Auditable {
}
public static class MyEventClass<GT> extends PayloadApplicationEvent<GT> implements Auditable {
public MyEventClass(Object source, GT payload) {
super(source, payload);
}
public String toString() {
return "Payload: " + getPayload();
}
}
@Component
public static class Listener {
public final List<Auditable> events = new ArrayList<>();
@EventListener
public void onEvent(Auditable event) {
events.add(event);
}
}
}