Add MergedAnnotations.of method
Add a factory method to `MergedAnnotation` that allows an instance to be created for an explicit collection of root annotations. This method will allow ASM based readers to expose a `MergedAnnotation` instance that has root annotations loaded from bytecode, and meta-annotations loaded using reflection. See gh-22884
This commit is contained in:
Phillip Webb
committed by
Juergen Hoeller
Juergen Hoeller
parent
daec3531b3
commit
9d6cf57cb7
@@ -0,0 +1,312 @@
|
||||
/*
|
||||
* 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.core.annotation;
|
||||
|
||||
import java.lang.annotation.Annotation;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.Spliterator;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import static org.assertj.core.api.Assertions.*;
|
||||
import static org.mockito.BDDMockito.*;
|
||||
|
||||
/**
|
||||
* Tests for {@link MergedAnnotationsCollection}.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
public class MergedAnnotationsCollectionTests {
|
||||
|
||||
@Test
|
||||
public void ofWhenDirectAnnotationsIsNullThrowsException() {
|
||||
assertThatIllegalArgumentException().isThrownBy(
|
||||
() -> MergedAnnotationsCollection.of(null)).withMessage(
|
||||
"Annotations must not be null");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void ofWhenEmptyReturnsSharedNoneInstance() {
|
||||
MergedAnnotations annotations = MergedAnnotationsCollection.of(new ArrayList<>());
|
||||
assertThat(annotations).isSameAs(TypeMappedAnnotations.NONE);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void createWhenAnnotationIsNotDirectlyPresentThrowsException() {
|
||||
MergedAnnotation<?> annotation = mock(MergedAnnotation.class);
|
||||
given(annotation.isDirectlyPresent()).willReturn(false);
|
||||
assertThatIllegalArgumentException().isThrownBy(() -> {
|
||||
MergedAnnotationsCollection.of(Collections.singleton(annotation));
|
||||
}).withMessage("Annotation must be directly present");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void createWhenAnnotationAggregateIndexIsNotZeroThrowsException() {
|
||||
MergedAnnotation<?> annotation = mock(MergedAnnotation.class);
|
||||
given(annotation.isDirectlyPresent()).willReturn(true);
|
||||
given(annotation.getAggregateIndex()).willReturn(1);
|
||||
assertThatIllegalArgumentException().isThrownBy(() -> {
|
||||
MergedAnnotationsCollection.of(Collections.singleton(annotation));
|
||||
}).withMessage("Annotation must have aggregate index of zero");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void interateIteratesInCorrectOrder() {
|
||||
MergedAnnotations annotations = getDirectAndSimple();
|
||||
List<Class<?>> types = new ArrayList<>();
|
||||
for (MergedAnnotation<?> annotation : annotations) {
|
||||
types.add(annotation.getType());
|
||||
}
|
||||
assertThat(types).containsExactly(Direct.class, Simple.class, Meta1.class,
|
||||
Meta2.class, Meta11.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void spliteratorIteratesInCorrectOrder() {
|
||||
MergedAnnotations annotations = getDirectAndSimple();
|
||||
Spliterator<MergedAnnotation<Annotation>> spliterator = annotations.spliterator();
|
||||
List<Class<?>> types = new ArrayList<>();
|
||||
spliterator.forEachRemaining(annotation -> types.add(annotation.getType()));
|
||||
assertThat(types).containsExactly(Direct.class, Simple.class, Meta1.class,
|
||||
Meta2.class, Meta11.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void spliteratorEstimatesSize() {
|
||||
MergedAnnotations annotations = getDirectAndSimple();
|
||||
Spliterator<MergedAnnotation<Annotation>> spliterator = annotations.spliterator();
|
||||
assertThat(spliterator.estimateSize()).isEqualTo(5);
|
||||
spliterator.tryAdvance(
|
||||
annotation -> assertThat(annotation.getType()).isEqualTo(Direct.class));
|
||||
assertThat(spliterator.estimateSize()).isEqualTo(4);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isPresentWhenDirectlyPresentReturnsTrue() {
|
||||
MergedAnnotations annotations = getDirectAndSimple();
|
||||
assertThat(annotations.isPresent(Direct.class)).isTrue();
|
||||
assertThat(annotations.isPresent(Direct.class.getName())).isTrue();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isPresentWhenMetaPresentReturnsTrue() {
|
||||
MergedAnnotations annotations = getDirectAndSimple();
|
||||
assertThat(annotations.isPresent(Meta11.class)).isTrue();
|
||||
assertThat(annotations.isPresent(Meta11.class.getName())).isTrue();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isPresentWhenNotPresentReturnsFalse() {
|
||||
MergedAnnotations annotations = getDirectAndSimple();
|
||||
assertThat(annotations.isPresent(Missing.class)).isFalse();
|
||||
assertThat(annotations.isPresent(Missing.class.getName())).isFalse();
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isDirectlyPresentWhenDirectlyPresentReturnsTrue() {
|
||||
MergedAnnotations annotations = getDirectAndSimple();
|
||||
assertThat(annotations.isDirectlyPresent(Direct.class)).isTrue();
|
||||
assertThat(annotations.isDirectlyPresent(Direct.class.getName())).isTrue();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isDirectlyPresentWhenMetaPresentReturnsFalse() {
|
||||
MergedAnnotations annotations = getDirectAndSimple();
|
||||
assertThat(annotations.isDirectlyPresent(Meta11.class)).isFalse();
|
||||
assertThat(annotations.isDirectlyPresent(Meta11.class.getName())).isFalse();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isDirectlyPresentWhenNotPresentReturnsFalse() {
|
||||
MergedAnnotations annotations = getDirectAndSimple();
|
||||
assertThat(annotations.isDirectlyPresent(Missing.class)).isFalse();
|
||||
assertThat(annotations.isDirectlyPresent(Missing.class.getName())).isFalse();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getReturnsAppropriateAnnotation() {
|
||||
MergedAnnotations annotations = getMutiRoute1();
|
||||
assertThat(annotations.get(MutiRouteTarget.class).getString(
|
||||
MergedAnnotation.VALUE)).isEqualTo("12");
|
||||
assertThat(annotations.get(MutiRouteTarget.class.getName()).getString(
|
||||
MergedAnnotation.VALUE)).isEqualTo("12");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getWhenNotPresentReturnsMissing() {
|
||||
MergedAnnotations annotations = getDirectAndSimple();
|
||||
assertThat(annotations.get(Missing.class)).isEqualTo(MergedAnnotation.missing());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getWithPredicateReturnsOnlyMatching() {
|
||||
MergedAnnotations annotations = getMutiRoute1();
|
||||
assertThat(annotations.get(MutiRouteTarget.class,
|
||||
annotation -> annotation.getDepth() >= 3).getString(
|
||||
MergedAnnotation.VALUE)).isEqualTo("111");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getWithSelectorReturnsSelected() {
|
||||
MergedAnnotations annotations = getMutiRoute1();
|
||||
MergedAnnotationSelector<MutiRouteTarget> deepest = (existing,
|
||||
candidate) -> candidate.getDepth() > existing.getDepth() ? candidate
|
||||
: existing;
|
||||
assertThat(annotations.get(MutiRouteTarget.class, null, deepest).getString(
|
||||
MergedAnnotation.VALUE)).isEqualTo("111");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void streamStreamsInCorrectOrder() {
|
||||
MergedAnnotations annotations = getDirectAndSimple();
|
||||
List<Class<?>> types = new ArrayList<>();
|
||||
annotations.stream().forEach(annotation -> types.add(annotation.getType()));
|
||||
assertThat(types).containsExactly(Direct.class, Simple.class, Meta1.class,
|
||||
Meta2.class, Meta11.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void streamWithTypeStreamsInCorrectOrder() {
|
||||
MergedAnnotations annotations = getMutiRoute1();
|
||||
List<String> values = new ArrayList<>();
|
||||
annotations.stream(MutiRouteTarget.class).forEach(
|
||||
annotation -> values.add(annotation.getString(MergedAnnotation.VALUE)));
|
||||
assertThat(values).containsExactly("12", "111");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getMetaWhenRootHasAttributeValuesShouldAlaisAttributes() {
|
||||
MergedAnnotation<Alaised> root = MergedAnnotation.of(null, null, Alaised.class,
|
||||
Collections.singletonMap("testAlias", "test"));
|
||||
MergedAnnotations annotations = MergedAnnotationsCollection.of(
|
||||
Collections.singleton(root));
|
||||
MergedAnnotation<AlaisTarget> metaAnnotation = annotations.get(AlaisTarget.class);
|
||||
assertThat(metaAnnotation.getString("test")).isEqualTo("test");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getMetaWhenRootHasNoAttributeValuesShouldAlaisAttributes() {
|
||||
MergedAnnotation<Alaised> root = MergedAnnotation.of(null, null, Alaised.class,
|
||||
Collections.emptyMap());
|
||||
MergedAnnotations annotations = MergedAnnotationsCollection.of(
|
||||
Collections.singleton(root));
|
||||
MergedAnnotation<AlaisTarget> metaAnnotation = annotations.get(AlaisTarget.class);
|
||||
assertThat(root.getString("testAlias")).isEqualTo("newdefault");
|
||||
assertThat(metaAnnotation.getString("test")).isEqualTo("newdefault");
|
||||
}
|
||||
|
||||
private MergedAnnotations getDirectAndSimple() {
|
||||
List<MergedAnnotation<?>> list = new ArrayList<>();
|
||||
list.add(MergedAnnotation.of(null, null, Direct.class, Collections.emptyMap()));
|
||||
list.add(MergedAnnotation.of(null, null, Simple.class, Collections.emptyMap()));
|
||||
return MergedAnnotationsCollection.of(list);
|
||||
}
|
||||
|
||||
private MergedAnnotations getMutiRoute1() {
|
||||
List<MergedAnnotation<?>> list = new ArrayList<>();
|
||||
list.add(MergedAnnotation.of(null, null, MutiRoute1.class,
|
||||
Collections.emptyMap()));
|
||||
return MergedAnnotationsCollection.of(list);
|
||||
}
|
||||
|
||||
@Meta1
|
||||
@Meta2
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@interface Direct {
|
||||
|
||||
}
|
||||
|
||||
@Meta11
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@interface Meta1 {
|
||||
|
||||
}
|
||||
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@interface Meta2 {
|
||||
|
||||
}
|
||||
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@interface Meta11 {
|
||||
|
||||
}
|
||||
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@interface Simple {
|
||||
|
||||
}
|
||||
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@interface Missing {
|
||||
|
||||
}
|
||||
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@interface MutiRouteTarget {
|
||||
|
||||
String value();
|
||||
|
||||
}
|
||||
|
||||
@MutiRoute11
|
||||
@MutiRoute12
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@interface MutiRoute1 {
|
||||
|
||||
}
|
||||
|
||||
@MutiRoute111
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@interface MutiRoute11 {
|
||||
|
||||
}
|
||||
|
||||
@MutiRouteTarget("12")
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@interface MutiRoute12 {
|
||||
|
||||
}
|
||||
|
||||
@MutiRouteTarget("111")
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@interface MutiRoute111 {
|
||||
|
||||
}
|
||||
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@interface AlaisTarget {
|
||||
|
||||
String test() default "default";
|
||||
|
||||
}
|
||||
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@AlaisTarget
|
||||
@interface Alaised {
|
||||
|
||||
@AliasFor(annotation = AlaisTarget.class, attribute = "test")
|
||||
String testAlias() default "newdefault";
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user