Skip to content

Commit

Permalink
Add required AspectJ field hints
Browse files Browse the repository at this point in the history
This commit adds reflection hints on fields for
classes compiled by AspectJ.

Closes gh-31575
  • Loading branch information
sdeleuze committed Nov 15, 2023
1 parent e12269e commit 92c3843
Show file tree
Hide file tree
Showing 4 changed files with 145 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ private boolean hasAspectAnnotation(Class<?> clazz) {
* We need to detect this as "code-style" AspectJ aspects should not be
* interpreted by Spring AOP.
*/
private boolean compiledByAjc(Class<?> clazz) {
static boolean compiledByAjc(Class<?> clazz) {
// The AJTypeSystem goes to great lengths to provide a uniform appearance between code-style and
// annotation-style aspects. Therefore there is no 'clean' way to tell them apart. Here we rely on
// an implementation detail of the AspectJ compiler.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/*
* Copyright 2002-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.aop.aspectj.annotation;

import org.springframework.aot.generate.GenerationContext;
import org.springframework.aot.hint.MemberCategory;
import org.springframework.beans.factory.aot.BeanRegistrationAotContribution;
import org.springframework.beans.factory.aot.BeanRegistrationAotProcessor;
import org.springframework.beans.factory.aot.BeanRegistrationCode;
import org.springframework.beans.factory.support.RegisteredBean;

/**
* An AOT {@link BeanRegistrationAotProcessor} that detects the presence of
* classes compiled with AspectJ and adds the related required field hints.
*
* @author Sebastien Deleuze
* @since 6.1
*/
public class AspectJAdvisorBeanRegistrationAotProcessor implements BeanRegistrationAotProcessor {

@Override
public BeanRegistrationAotContribution processAheadOfTime(RegisteredBean registeredBean) {
Class<?> beanClass = registeredBean.getBeanClass();
if (AbstractAspectJAdvisorFactory.compiledByAjc(beanClass)) {
return new AspectJAdvisorContribution(beanClass);
}
return null;
}

private static class AspectJAdvisorContribution implements BeanRegistrationAotContribution {

private final Class<?> beanClass;

public AspectJAdvisorContribution(Class<?> beanClass) {
this.beanClass = beanClass;
}

@Override
public void applyTo(GenerationContext generationContext, BeanRegistrationCode beanRegistrationCode) {
generationContext.getRuntimeHints().reflection().registerType(this.beanClass, MemberCategory.DECLARED_FIELDS);
}
}

}
3 changes: 2 additions & 1 deletion spring-aop/src/main/resources/META-INF/spring/aot.factories
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
org.springframework.beans.factory.aot.BeanRegistrationAotProcessor=\
org.springframework.aop.scope.ScopedProxyBeanRegistrationAotProcessor
org.springframework.aop.scope.ScopedProxyBeanRegistrationAotProcessor,\
org.springframework.aop.aspectj.annotation.AspectJAdvisorBeanRegistrationAotProcessor

org.springframework.beans.factory.aot.BeanFactoryInitializationAotProcessor= \
org.springframework.aop.aspectj.annotation.AspectJBeanFactoryInitializationAotProcessor
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
/*
* Copyright 2002-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.aop.aspectj;

import org.junit.jupiter.api.Test;

import org.springframework.aop.aspectj.annotation.AspectJAdvisorBeanRegistrationAotProcessor;
import org.springframework.aot.generate.GenerationContext;
import org.springframework.aot.hint.MemberCategory;
import org.springframework.aot.hint.RuntimeHints;
import org.springframework.aot.test.generate.TestGenerationContext;
import org.springframework.beans.factory.aot.BeanRegistrationAotContribution;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.beans.factory.support.RegisteredBean;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.lang.Nullable;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
import static org.springframework.aot.hint.predicate.RuntimeHintsPredicates.reflection;

/**
* Tests for {@link AspectJAdvisorBeanRegistrationAotProcessor}.
*
* @author Sebastien Deleuze
*/
public class AspectJAdvisorBeanRegistrationAotProcessorTests {

private final GenerationContext generationContext = new TestGenerationContext();

private final RuntimeHints runtimeHints = this.generationContext.getRuntimeHints();

@Test
void shouldProcessesAspectJClass() {
process(AspectJClass.class);
assertThat(reflection().onType(AspectJClass.class).withMemberCategory(MemberCategory.DECLARED_FIELDS))
.accepts(this.runtimeHints);
}

@Test
void shouldSkipRegularClass() {
process(RegularClass.class);
assertThat(this.runtimeHints.reflection().typeHints()).isEmpty();
}

void process(Class<?> beanClass) {
BeanRegistrationAotContribution contribution = createContribution(beanClass);
if (contribution != null) {
contribution.applyTo(this.generationContext, mock());
}
}

@Nullable
private static BeanRegistrationAotContribution createContribution(Class<?> beanClass) {
DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
beanFactory.registerBeanDefinition(beanClass.getName(), new RootBeanDefinition(beanClass));
return new AspectJAdvisorBeanRegistrationAotProcessor()
.processAheadOfTime(RegisteredBean.of(beanFactory, beanClass.getName()));
}


static class AspectJClass {
private static java.lang.Throwable ajc$initFailureCause;
}

static class RegularClass {
private static java.lang.Throwable initFailureCause;
}

}

0 comments on commit 92c3843

Please sign in to comment.