Add SimpleAnnotationMeta classes and readers

Replace the existing ASM based readers with new implementations that
also support MergedAnnotations. The meta-data classes themselves are
now immutable, and constructed via separate reader classes.

The `SimpleMetadataReader` class has been updated to return the new
classes, however the old ones remain since some of them are public
and might be being used directly.

Closes gh-22884
This commit is contained in:
Phillip Webb
2019-05-06 10:37:59 -07:00
committed by Juergen Hoeller
parent 8c2ccfe6a3
commit 7fbf3f97cd
18 changed files with 1198 additions and 30 deletions

View File

@@ -35,6 +35,7 @@ import static org.assertj.core.api.Assertions.*;
*
* @author Phillip Webb
*/
@SuppressWarnings("deprecation")
public class AnnotationMetadataReadingVisitorTests
extends AbstractAnnotationMetadataTests {

View File

@@ -0,0 +1,264 @@
/*
* 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.type.classreading;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import org.junit.Test;
import org.springframework.asm.AnnotationVisitor;
import org.springframework.asm.ClassReader;
import org.springframework.asm.ClassVisitor;
import org.springframework.asm.SpringAsmInfo;
import org.springframework.core.annotation.MergedAnnotation;
import static org.assertj.core.api.Assertions.*;
/**
* Tests for {@link MergedAnnotationReadingVisitor}.
*
* @author Phillip Webb
*/
public class MergedAnnotationMetadataVisitorTests {
private MergedAnnotation<?> annotation;
@Test
public void visitWhenHasSimpleTypesCreatesAnnotation() {
loadFrom(WithSimpleTypesAnnotation.class);
assertThat(this.annotation.getType()).isEqualTo(SimpleTypesAnnotation.class);
assertThat(this.annotation.getValue("stringValue")).contains("string");
assertThat(this.annotation.getValue("byteValue")).contains((byte) 1);
assertThat(this.annotation.getValue("shortValue")).contains((short) 2);
assertThat(this.annotation.getValue("intValue")).contains(3);
assertThat(this.annotation.getValue("longValue")).contains(4L);
assertThat(this.annotation.getValue("booleanValue")).contains(true);
assertThat(this.annotation.getValue("charValue")).contains('c');
assertThat(this.annotation.getValue("doubleValue")).contains(5.0);
assertThat(this.annotation.getValue("floatValue")).contains(6.0f);
}
@Test
public void visitWhenHasSimpleArrayTypesCreatesAnnotation() {
loadFrom(WithSimpleArrayTypesAnnotation.class);
assertThat(this.annotation.getType()).isEqualTo(SimpleArrayTypesAnnotation.class);
assertThat(this.annotation.getValue("stringValue")).contains(
new String[] { "string" });
assertThat(this.annotation.getValue("byteValue")).contains(new byte[] { 1 });
assertThat(this.annotation.getValue("shortValue")).contains(new short[] { 2 });
assertThat(this.annotation.getValue("intValue")).contains(new int[] { 3 });
assertThat(this.annotation.getValue("longValue")).contains(new long[] { 4 });
assertThat(this.annotation.getValue("booleanValue")).contains(
new boolean[] { true });
assertThat(this.annotation.getValue("charValue")).contains(new char[] { 'c' });
assertThat(this.annotation.getValue("doubleValue")).contains(
new double[] { 5.0 });
assertThat(this.annotation.getValue("floatValue")).contains(new float[] { 6.0f });
}
@Test
public void visitWhenHasEmptySimpleArrayTypesCreatesAnnotation() {
loadFrom(WithSimpleEmptyArrayTypesAnnotation.class);
assertThat(this.annotation.getType()).isEqualTo(SimpleArrayTypesAnnotation.class);
assertThat(this.annotation.getValue("stringValue")).contains(new String[] {});
assertThat(this.annotation.getValue("byteValue")).contains(new byte[] {});
assertThat(this.annotation.getValue("shortValue")).contains(new short[] {});
assertThat(this.annotation.getValue("intValue")).contains(new int[] {});
assertThat(this.annotation.getValue("longValue")).contains(new long[] {});
assertThat(this.annotation.getValue("booleanValue")).contains(new boolean[] {});
assertThat(this.annotation.getValue("charValue")).contains(new char[] {});
assertThat(this.annotation.getValue("doubleValue")).contains(new double[] {});
assertThat(this.annotation.getValue("floatValue")).contains(new float[] {});
}
@Test
public void visitWhenHasEnumAttributesCreatesAnnotation() {
loadFrom(WithEnumAnnotation.class);
assertThat(this.annotation.getType()).isEqualTo(EnumAnnotation.class);
assertThat(this.annotation.getValue("enumValue")).contains(ExampleEnum.ONE);
assertThat(this.annotation.getValue("enumArrayValue")).contains(
new ExampleEnum[] { ExampleEnum.ONE, ExampleEnum.TWO });
}
@Test
public void visitWhenHasAnnotationAttributesCreatesAnnotation() {
loadFrom(WithAnnotationAnnotation.class);
assertThat(this.annotation.getType()).isEqualTo(AnnotationAnnotation.class);
MergedAnnotation<NestedAnnotation> value = this.annotation.getAnnotation(
"annotationValue", NestedAnnotation.class);
assertThat(value.isPresent()).isTrue();
assertThat(value.getString(MergedAnnotation.VALUE)).isEqualTo("a");
MergedAnnotation<NestedAnnotation>[] arrayValue = this.annotation.getAnnotationArray(
"annotationArrayValue", NestedAnnotation.class);
assertThat(arrayValue).hasSize(2);
assertThat(arrayValue[0].getString(MergedAnnotation.VALUE)).isEqualTo("b");
assertThat(arrayValue[1].getString(MergedAnnotation.VALUE)).isEqualTo("c");
}
@Test
public void visitWhenHasClassAttributesCreatesAnnotation() {
loadFrom(WithClassAnnotation.class);
assertThat(this.annotation.getType()).isEqualTo(ClassAnnotation.class);
assertThat(this.annotation.getString("classValue")).isEqualTo(InputStream.class.getName());
assertThat(this.annotation.getClass("classValue")).isEqualTo(InputStream.class);
assertThat(this.annotation.getValue("classValue")).contains(InputStream.class);
assertThat(this.annotation.getStringArray("classArrayValue")).containsExactly(OutputStream.class.getName());
assertThat(this.annotation.getValue("classArrayValue")).contains(new Class<?>[] {OutputStream.class});
}
private void loadFrom(Class<?> type) {
ClassVisitor visitor = new ClassVisitor(SpringAsmInfo.ASM_VERSION) {
@Override
public AnnotationVisitor visitAnnotation(String descriptor, boolean visible) {
return MergedAnnotationReadingVisitor.get(getClass().getClassLoader(),
null, descriptor, visible,
annotation -> MergedAnnotationMetadataVisitorTests.this.annotation = annotation);
}
};
try {
new ClassReader(type.getName()).accept(visitor, ClassReader.SKIP_DEBUG
| ClassReader.SKIP_CODE | ClassReader.SKIP_FRAMES);
}
catch (IOException ex) {
throw new IllegalStateException(ex);
}
}
@SimpleTypesAnnotation(stringValue = "string", byteValue = 1, shortValue = 2, intValue = 3, longValue = 4, booleanValue = true, charValue = 'c', doubleValue = 5.0, floatValue = 6.0f)
static class WithSimpleTypesAnnotation {
}
@Retention(RetentionPolicy.RUNTIME)
@interface SimpleTypesAnnotation {
String stringValue();
byte byteValue();
short shortValue();
int intValue();
long longValue();
boolean booleanValue();
char charValue();
double doubleValue();
float floatValue();
}
@SimpleArrayTypesAnnotation(stringValue = "string", byteValue = 1, shortValue = 2, intValue = 3, longValue = 4, booleanValue = true, charValue = 'c', doubleValue = 5.0, floatValue = 6.0f)
static class WithSimpleArrayTypesAnnotation {
}
@SimpleArrayTypesAnnotation(stringValue = {}, byteValue = {}, shortValue = {}, intValue = {}, longValue = {}, booleanValue = {}, charValue = {}, doubleValue = {}, floatValue = {})
static class WithSimpleEmptyArrayTypesAnnotation {
}
@Retention(RetentionPolicy.RUNTIME)
@interface SimpleArrayTypesAnnotation {
String[] stringValue();
byte[] byteValue();
short[] shortValue();
int[] intValue();
long[] longValue();
boolean[] booleanValue();
char[] charValue();
double[] doubleValue();
float[] floatValue();
}
@EnumAnnotation(enumValue = ExampleEnum.ONE, enumArrayValue = { ExampleEnum.ONE,
ExampleEnum.TWO })
static class WithEnumAnnotation {
}
@Retention(RetentionPolicy.RUNTIME)
@interface EnumAnnotation {
ExampleEnum enumValue();
ExampleEnum[] enumArrayValue();
}
enum ExampleEnum {
ONE, TWO, THREE
}
@AnnotationAnnotation(annotationValue = @NestedAnnotation("a"), annotationArrayValue = {
@NestedAnnotation("b"), @NestedAnnotation("c") })
static class WithAnnotationAnnotation {
}
@Retention(RetentionPolicy.RUNTIME)
@interface AnnotationAnnotation {
NestedAnnotation annotationValue();
NestedAnnotation[] annotationArrayValue();
}
@Retention(RetentionPolicy.RUNTIME)
@interface NestedAnnotation {
String value() default "";
}
@ClassAnnotation(classValue = InputStream.class, classArrayValue = OutputStream.class)
static class WithClassAnnotation {
}
@Retention(RetentionPolicy.RUNTIME)
@interface ClassAnnotation {
Class<?> classValue();
Class<?>[] classArrayValue();
}
}

View File

@@ -0,0 +1,43 @@
/*
* 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.type.classreading;
import org.springframework.core.type.AbstractAnnotationMetadataTests;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.core.type.classreading.SimpleMetadataReaderFactory;
/**
* Tests for {@link SimpleAnnotationMetadata} and
* {@link SimpleAnnotationMetadataReadingVistor}.
*
* @author Phillip Webb
*/
public class SimpleAnnotationMetadataTests extends AbstractAnnotationMetadataTests {
@Override
protected AnnotationMetadata get(Class<?> source) {
try {
return new SimpleMetadataReaderFactory(
source.getClassLoader()).getMetadataReader(
source.getName()).getAnnotationMetadata();
}
catch (Exception ex) {
throw new IllegalStateException(ex);
}
}
}

View File

@@ -0,0 +1,43 @@
/*
* 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.type.classreading;
import org.springframework.core.type.AbstractMethodMetadataTests;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.core.type.classreading.SimpleMetadataReaderFactory;
/**
* Tests for {@link SimpleMethodMetadata} and
* {@link SimpleMethodMetadataReadingVistor}.
*
* @author Phillip Webb
*/
public class SimpleMethodMetadataTests extends AbstractMethodMetadataTests {
@Override
protected AnnotationMetadata get(Class<?> source) {
try {
return new SimpleMetadataReaderFactory(
source.getClassLoader()).getMetadataReader(
source.getName()).getAnnotationMetadata();
}
catch (Exception ex) {
throw new IllegalStateException(ex);
}
}
}