Compare commits

...

4 Commits

Author SHA1 Message Date
Geonhu Park 665f20642e
Merge cc7dc955ac into 7e6874ad80 2025-10-07 18:54:14 +03:00
Sam Brannen 7e6874ad80 Polish @⁠Autowired section of the reference manual
Build and Deploy Snapshot / Build and Deploy Snapshot (push) Waiting to run Details
Build and Deploy Snapshot / Verify (push) Blocked by required conditions Details
Deploy Docs / Dispatch docs deployment (push) Waiting to run Details
2025-10-07 17:17:27 +02:00
Sam Brannen 097463e3b7 Remove outdated reference to JSR 305 in the reference documentation
Closes gh-35580
2025-10-07 17:10:40 +02:00
Geonhu Park cc7dc955ac Provide programmatic alternative to @ConcurrencyLimit
Closes gh-35460

Signed-off-by: Geonhu Park <parkgeonhu@gmail.com>
2025-09-29 04:18:10 +09:00
6 changed files with 249 additions and 26 deletions

View File

@ -37,18 +37,18 @@ Kotlin::
----
======
[NOTE]
[TIP]
====
As of Spring Framework 4.3, an `@Autowired` annotation on such a constructor is no longer
necessary if the target bean defines only one constructor to begin with. However, if
several constructors are available and there is no primary/default constructor, at least
one of the constructors must be annotated with `@Autowired` in order to instruct the
container which one to use. See the discussion on
xref:core/beans/annotation-config/autowired.adoc#beans-autowired-annotation-constructor-resolution[constructor resolution] for details.
An `@Autowired` annotation on such a constructor is not necessary if the target bean
defines only one constructor. However, if several constructors are available and there is
no primary or default constructor, at least one of the constructors must be annotated
with `@Autowired` in order to instruct the container which one to use. See the discussion
on xref:core/beans/annotation-config/autowired.adoc#beans-autowired-annotation-constructor-resolution[constructor resolution]
for details.
====
You can also apply the `@Autowired` annotation to _traditional_ setter methods,
as the following example shows:
You can apply the `@Autowired` annotation to _traditional_ setter methods, as the
following example shows:
[tabs]
======
@ -84,8 +84,8 @@ Kotlin::
----
======
You can also apply the annotation to methods with arbitrary names and multiple
arguments, as the following example shows:
You can apply `@Autowired` to methods with arbitrary names and multiple arguments, as the
following example shows:
[tabs]
======
@ -176,14 +176,15 @@ Kotlin::
====
Make sure that your target components (for example, `MovieCatalog` or `CustomerPreferenceDao`)
are consistently declared by the type that you use for your `@Autowired`-annotated
injection points. Otherwise, injection may fail due to a "no type match found" error at runtime.
injection points. Otherwise, injection may fail due to a "no type match found" error at
runtime.
For XML-defined beans or component classes found via classpath scanning, the container
usually knows the concrete type up front. However, for `@Bean` factory methods, you need
to make sure that the declared return type is sufficiently expressive. For components
that implement several interfaces or for components potentially referred to by their
implementation type, consider declaring the most specific return type on your factory
method (at least as specific as required by the injection points referring to your bean).
implementation type, declare the most specific return type on your factory method (at
least as specific as required by the injection points referring to your bean).
====
.[[beans-autowired-annotation-self-injection]]Self Injection
@ -312,8 +313,8 @@ through `@Order` values in combination with `@Primary` on a single bean for each
====
Even typed `Map` instances can be autowired as long as the expected key type is `String`.
The map values contain all beans of the expected type, and the keys contain the
corresponding bean names, as the following example shows:
The map values are all beans of the expected type, and the keys are the corresponding
bean names, as the following example shows:
[tabs]
======
@ -431,7 +432,7 @@ annotated constructor does not have to be public.
====
Alternatively, you can express the non-required nature of a particular dependency
through Java 8's `java.util.Optional`, as the following example shows:
through Java's `java.util.Optional`, as the following example shows:
[source,java,indent=0,subs="verbatim,quotes"]
----
@ -445,8 +446,8 @@ through Java 8's `java.util.Optional`, as the following example shows:
----
You can also use a parameter-level `@Nullable` annotation (of any kind in any package --
for example, `javax.annotation.Nullable` from JSR-305) or just leverage Kotlin built-in
null-safety support:
for example, `org.jspecify.annotations.Nullable` from JSpecify) or just leverage Kotlin's
built-in null-safety support:
[tabs]
======
@ -477,13 +478,6 @@ Kotlin::
----
======
[NOTE]
====
A type-level `@Nullable` annotation such as from JSpecify is not supported in Spring
Framework 6.2 yet. You need to upgrade to Spring Framework 7.0 where the framework
detects type-level annotations and consistently declares JSpecify in its own codebase.
====
You can also use `@Autowired` for interfaces that are well-known resolvable
dependencies: `BeanFactory`, `ApplicationContext`, `Environment`, `ResourceLoader`,
`ApplicationEventPublisher`, and `MessageSource`. These interfaces and their extended
@ -528,5 +522,6 @@ class MovieRecommender {
The `@Autowired`, `@Inject`, `@Value`, and `@Resource` annotations are handled by Spring
`BeanPostProcessor` implementations. This means that you cannot apply these annotations
within your own `BeanPostProcessor` or `BeanFactoryPostProcessor` types (if any).
These types must be 'wired up' explicitly by using XML or a Spring `@Bean` method.
====

View File

@ -0,0 +1,72 @@
/*
* Copyright 2002-present 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.core.concurrency;
import org.jspecify.annotations.Nullable;
import org.springframework.util.ConcurrencyThrottleSupport;
/**
* Template-style API that throttles concurrent executions of user-provided callbacks
* according to a configurable concurrency limit.
*
* <p>Blocking semantics are identical to {@link ConcurrencyThrottleSupport}:
* when the configured limit is reached, additional callers will block until a
* permit becomes available.
*
* <p>The default concurrency limit of this template is 1.
*
* @author Geonhu Park
* @since 7.1
* @see ConcurrencyThrottleSupport
*/
@SuppressWarnings("serial")
public class ConcurrencyLimitTemplate extends ConcurrencyThrottleSupport {
/**
* Create a default {@code ConcurrencyLimitTemplate}
* with concurrency limit 1.
*/
public ConcurrencyLimitTemplate() {
this(1);
}
/**
* Create a {@code ConcurrencyThrottleInterceptor}
* with the given concurrency limit.
*/
public ConcurrencyLimitTemplate(int concurrencyLimit) {
setConcurrencyLimit(concurrencyLimit);
}
/**
* Execute the supplied callback under the configured concurrency limit.
* @param concurrencyLimited the unit of work to run
* @param <R> the result type (nullable)
* @return the callback's result (possibly {@code null})
* @throws Throwable any exception thrown by the callback
*/
public <R extends @Nullable Object> @Nullable R execute(ConcurrencyLimited<R> concurrencyLimited) throws Throwable {
beforeAccess();
try {
return concurrencyLimited.execute();
}
finally {
afterAccess();
}
}
}

View File

@ -0,0 +1,39 @@
/*
* Copyright 2002-present 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.core.concurrency;
import org.jspecify.annotations.Nullable;
/**
* Functional callback representing a single unit of work to be executed under
* the concurrency throttling of a {@link ConcurrencyLimitTemplate}.
*
* @author Geonhu Park
* @since 7.1
* @param <R> the result type (nullable)
* @see ConcurrencyLimitTemplate
*/
@FunctionalInterface
public interface ConcurrencyLimited<R extends @Nullable Object> {
/**
* Execute the concurrency-limited operation.
* @return the result (may be {@code null})
* @throws Throwable any error from the underlying operation
*/
R execute() throws Throwable;
}

View File

@ -0,0 +1,5 @@
/**
* Concurrency limiting (throttling) support via {@link org.springframework.core.concurrency.ConcurrencyLimitTemplate}
* and {@link org.springframework.core.concurrency.ConcurrencyLimited}.
*/
package org.springframework.core.concurrency;

View File

@ -44,6 +44,7 @@ import org.apache.commons.logging.LogFactory;
* @see #beforeAccess()
* @see #afterAccess()
* @see org.springframework.aop.interceptor.ConcurrencyThrottleInterceptor
* @see org.springframework.core.concurrency.ConcurrencyLimitTemplate
* @see java.io.Serializable
*/
@SuppressWarnings("serial")

View File

@ -0,0 +1,111 @@
/*
* Copyright 2002-present 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.core.concurrency;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
/**
* Tests for {@link ConcurrencyLimitTemplate}.
*
* @author Geonhu Park
*/
class ConcurrencyLimitTemplateTests {
private static final Log logger = LogFactory.getLog(ConcurrencyLimitTemplateTests.class);
private static final int NR_OF_THREADS = 100;
private static final int NR_OF_ITERATIONS = 1000;
@ParameterizedTest
@ValueSource(ints = {1, 10})
void multipleThreadsWithLimit(int concurrencyLimit) {
ConcurrencyLimitTemplate template = new ConcurrencyLimitTemplate(concurrencyLimit);
Thread[] threads = new Thread[NR_OF_THREADS];
for (int i = 0; i < NR_OF_THREADS; i++) {
threads[i] = new ConcurrencyThread(template, null);
threads[i].start();
}
for (int i = 0; i < NR_OF_THREADS / 10; i++) {
try {
Thread.sleep(5);
}
catch (InterruptedException ex) {
ex.printStackTrace();
}
threads[i] = new ConcurrencyThread(template,
(i % 2 == 0 ? new OutOfMemoryError() : new IllegalStateException()));
threads[i].start();
}
for (Thread t : threads) {
try {
t.join();
}
catch (InterruptedException ex) {
ex.printStackTrace();
}
}
}
private static class ConcurrencyThread extends Thread {
private final ConcurrencyLimitTemplate template;
private final Throwable ex;
ConcurrencyThread(ConcurrencyLimitTemplate template, Throwable ex) {
this.template = template;
this.ex = ex;
}
@Override
public void run() {
if (this.ex != null) {
try {
this.template.execute(() -> {
throw this.ex;
});
}
catch (RuntimeException | Error err) {
if (err == this.ex) {
logger.info("Expected exception thrown", err);
}
else {
ex.printStackTrace();
}
}
catch (Throwable th) {
th.printStackTrace();
}
}
else {
for (int i = 0; i < NR_OF_ITERATIONS; i++) {
try {
this.template.execute(() -> null);
}
catch (Throwable th) {
th.printStackTrace();
break;
}
}
}
}
}
}