root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 12 Packages Projects Releases Wiki Activity

Preserve ObjectName property order when name is unchanged 

Closes gh-29953
This commit is contained in:
Andy Wilkinson 2022-02-22 20:05:39 +00:00
parent 9c9e04b8e4
commit 7aca75c58c
2 changed files with 120 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jmx/ParentAwareNamingStrategy.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2012-2021 the original author or authors.
* Copyright 2012-2022 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.
@ -26,6 +26,7 @@ import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.jmx.export.metadata.JmxAttributeSource;
import org.springframework.jmx.export.naming.MetadataNamingStrategy;
import org.springframework.jmx.support.JmxUtils;
import org.springframework.jmx.support.ObjectNameManager;
import org.springframework.util.ObjectUtils;
@ -56,21 +57,20 @@ public class ParentAwareNamingStrategy extends MetadataNamingStrategy implements
}
@Override
public ObjectName getObjectName(Object managedBean, String beanKey) throws MalformedObjectNameException {
ObjectName name = super.getObjectName(managedBean, beanKey);
Hashtable<String, String> properties = new Hashtable<>(name.getKeyPropertyList());
if (this.ensureUniqueRuntimeObjectNames) {
properties.put("identity", ObjectUtils.getIdentityHexString(managedBean));
}
else if (parentContextContainsSameBean(this.applicationContext, beanKey)) {
properties.put("context", ObjectUtils.getIdentityHexString(this.applicationContext));
}
return ObjectNameManager.getInstance(name.getDomain(), properties);
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
this.applicationContext = applicationContext;
}
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
this.applicationContext = applicationContext;
public ObjectName getObjectName(Object managedBean, String beanKey) throws MalformedObjectNameException {
ObjectName name = super.getObjectName(managedBean, beanKey);
if (this.ensureUniqueRuntimeObjectNames) {
return JmxUtils.appendIdentityToObjectName(name, managedBean);
}
if (parentContextContainsSameBean(this.applicationContext, beanKey)) {
return appendToObjectName(name, "context", ObjectUtils.getIdentityHexString(this.applicationContext));
}
return name;
}
private boolean parentContextContainsSameBean(ApplicationContext context, String beanKey) {
@ -86,4 +86,11 @@ public class ParentAwareNamingStrategy extends MetadataNamingStrategy implements
}
}
private ObjectName appendToObjectName(ObjectName name, String key, String value)
throws MalformedObjectNameException {
Hashtable<String, String> keyProperties = name.getKeyPropertyList();
keyProperties.put(key, value);
return ObjectNameManager.getInstance(name.getDomain(), keyProperties);
}
}

100
spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/jmx/ParentAwareNamingStrategyTests.java Normal file
View File

@ -0,0 +1,100 @@
/*
* Copyright 2012-2022 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.boot.autoconfigure.jmx;
import javax.management.MalformedObjectNameException;
import javax.management.ObjectName;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.jmx.export.annotation.AnnotationJmxAttributeSource;
import org.springframework.jmx.export.annotation.ManagedResource;
import org.springframework.util.ObjectUtils;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link ParentAwareNamingStrategy}.
*
* @author Andy Wilkinson
*/
class ParentAwareNamingStrategyTests {
private ApplicationContextRunner contextRunner = new ApplicationContextRunner();
@Test
void objectNameMatchesManagedResourceByDefault() throws MalformedObjectNameException {
this.contextRunner.withBean("testManagedResource", TestManagedResource.class).run((context) -> {
ParentAwareNamingStrategy strategy = new ParentAwareNamingStrategy(new AnnotationJmxAttributeSource());
strategy.setApplicationContext(context);
assertThat(strategy.getObjectName(context.getBean("testManagedResource"), "testManagedResource")
.getKeyPropertyListString()).isEqualTo("type=something,name1=def,name2=ghi");
});
}
@Test
void uniqueObjectNameAddsIdentityProperty() throws MalformedObjectNameException {
this.contextRunner.withBean("testManagedResource", TestManagedResource.class).run((context) -> {
ParentAwareNamingStrategy strategy = new ParentAwareNamingStrategy(new AnnotationJmxAttributeSource());
strategy.setApplicationContext(context);
strategy.setEnsureUniqueRuntimeObjectNames(true);
Object resource = context.getBean("testManagedResource");
ObjectName objectName = strategy.getObjectName(resource, "testManagedResource");
assertThat(objectName.getDomain()).isEqualTo("ABC");
assertThat(objectName.getCanonicalKeyPropertyListString()).isEqualTo(
"identity=" + ObjectUtils.getIdentityHexString(resource) + ",name1=def,name2=ghi,type=something");
});
}
@Test
void sameBeanInParentContextAddsContextProperty() throws MalformedObjectNameException {
this.contextRunner.withBean("testManagedResource", TestManagedResource.class).run((parent) -> this.contextRunner
.withBean("testManagedResource", TestManagedResource.class).withParent(parent).run((context) -> {
ParentAwareNamingStrategy strategy = new ParentAwareNamingStrategy(
new AnnotationJmxAttributeSource());
strategy.setApplicationContext(context);
Object resource = context.getBean("testManagedResource");
ObjectName objectName = strategy.getObjectName(resource, "testManagedResource");
assertThat(objectName.getDomain()).isEqualTo("ABC");
assertThat(objectName.getCanonicalKeyPropertyListString()).isEqualTo("context="
+ ObjectUtils.getIdentityHexString(context) + ",name1=def,name2=ghi,type=something");
}));
}
@Test
void uniqueObjectNameAndSameBeanInParentContextOnlyAddsIdentityProperty() throws MalformedObjectNameException {
this.contextRunner.withBean("testManagedResource", TestManagedResource.class).run((parent) -> this.contextRunner
.withBean("testManagedResource", TestManagedResource.class).withParent(parent).run((context) -> {
ParentAwareNamingStrategy strategy = new ParentAwareNamingStrategy(
new AnnotationJmxAttributeSource());
strategy.setApplicationContext(context);
strategy.setEnsureUniqueRuntimeObjectNames(true);
Object resource = context.getBean("testManagedResource");
ObjectName objectName = strategy.getObjectName(resource, "testManagedResource");
assertThat(objectName.getDomain()).isEqualTo("ABC");
assertThat(objectName.getCanonicalKeyPropertyListString()).isEqualTo("identity="
+ ObjectUtils.getIdentityHexString(resource) + ",name1=def,name2=ghi,type=something");
}));
}
@ManagedResource(objectName = "ABC:type=something,name1=def,name2=ghi")
public static class TestManagedResource {
}
}