Custom thread pool configuration in Spring Boot - Mini Project: Build & Apply

Custom thread pool configuration

📖 Scenario: You are building a Spring Boot application that needs to handle multiple tasks concurrently. To improve performance and control resource usage, you want to create a custom thread pool.

🎯 Goal: Create a custom thread pool configuration in Spring Boot using ThreadPoolTaskExecutor with specific settings for core pool size, max pool size, and queue capacity.

📋 What You'll Learn

Create a configuration class named ThreadPoolConfig

Define a ThreadPoolTaskExecutor bean named taskExecutor

Set corePoolSize to 5

Set maxPoolSize to 10

Set queueCapacity to 25

💡 Why This Matters

🌍 Real World

Custom thread pools help manage concurrent tasks efficiently in web applications, improving performance and resource control.

💼 Career

Understanding thread pool configuration is essential for backend developers working with Spring Boot to build scalable and responsive applications.

1

Create configuration class

Create a public class named ThreadPoolConfig annotated with @Configuration.

Spring Boot

@Configuration
// Your code here

Hint

Use @Configuration annotation above the class declaration.

2

Define ThreadPoolTaskExecutor bean

Inside ThreadPoolConfig, create a public method named taskExecutor annotated with @Bean that returns a ThreadPoolTaskExecutor instance.

Spring Boot

import org.springframework.context.annotation.Bean;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;

@Configuration
public class ThreadPoolConfig {
    // Your code here
}

Hint

Remember to import @Bean and ThreadPoolTaskExecutor.

3

Configure thread pool properties

In the taskExecutor method, create a ThreadPoolTaskExecutor object named executor. Set its corePoolSize to 5, maxPoolSize to 10, and queueCapacity to 25.

Spring Boot

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;

@Configuration
public class ThreadPoolConfig {
    @Bean
    public ThreadPoolTaskExecutor taskExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        // Your code here
        return executor;
    }
}

Hint

Use the setter methods on the executor object to set the sizes.

4

Initialize the executor

Before returning executor in the taskExecutor method, call executor.initialize() to complete the setup.

Spring Boot

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;

@Configuration
public class ThreadPoolConfig {
    @Bean
    public ThreadPoolTaskExecutor taskExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(5);
        executor.setMaxPoolSize(10);
        executor.setQueueCapacity(25);
        // Your code here
        return executor;
    }
}

Hint

Call initialize() on the executor before returning it.

Practice

1. What is the main purpose of configuring a custom thread pool in a Spring Boot application?

easy

A. To change the database connection settings

B. To control the number of threads used for asynchronous tasks

C. To modify the HTTP request timeout

D. To customize the logging format

Solution

1. Step 1: Understand thread pools in Spring Boot

   Thread pools manage how many threads run tasks concurrently, improving performance and resource use.

2. Step 2: Identify the role of custom thread pools

   Custom thread pools let you set limits on thread count and behavior for asynchronous processing.

3. Final Answer:

   To control the number of threads used for asynchronous tasks -> Option B

4. Quick Check:

   Thread pool purpose = control threads [OK]

Hint: Thread pools manage threads for async tasks [OK]

Common Mistakes:

• Confusing thread pool with database or HTTP settings
• Thinking thread pools affect logging
• Assuming thread pools are for UI rendering

2. Which of the following is the correct way to define a custom thread pool bean in Spring Boot using Java configuration?

easy

A. @Bean public Executor taskExecutor() { return Executors.newFixedThreadPool(5); }

B. @Bean public Executor taskExecutor() { return new ThreadPoolExecutor(); }

C. @Bean public Executor taskExecutor() { return new ScheduledThreadPoolExecutor(10); }

D. @Bean public Executor taskExecutor() { return new ThreadPoolTaskExecutor(); }

Solution

1. Step 1: Recall Spring Boot thread pool bean creation

   Spring Boot uses ThreadPoolTaskExecutor for custom thread pools, which integrates with Spring's task execution.

2. Step 2: Analyze options

   @Bean public Executor taskExecutor() { return new ThreadPoolTaskExecutor(); } correctly returns a new ThreadPoolTaskExecutor instance, which is the recommended way.

3. Final Answer:

   @Bean public Executor taskExecutor() { return new ThreadPoolTaskExecutor(); } -> Option D

4. Quick Check:

   Spring thread pool bean = ThreadPoolTaskExecutor [OK]

Hint: Use ThreadPoolTaskExecutor for Spring thread pools [OK]

Common Mistakes:

• Using Executors.newFixedThreadPool directly without Spring wrapper
• Trying to instantiate ThreadPoolExecutor without parameters
• Confusing scheduled thread pools with normal thread pools

3. Given this Spring Boot configuration snippet, what will be the maximum number of threads allowed in the pool?

@Bean
public ThreadPoolTaskExecutor taskExecutor() {
  ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
  executor.setCorePoolSize(3);
  executor.setMaxPoolSize(6);
  executor.setQueueCapacity(10);
  executor.initialize();
  return executor;
}

medium

A. 6

B. 3

C. 10

D. 13

Solution

1. Step 1: Understand core and max pool size

   Core pool size is minimum threads kept alive; max pool size is the maximum threads allowed.

2. Step 2: Identify maxPoolSize value

   The code sets maxPoolSize to 6, so the pool can grow up to 6 threads.

3. Final Answer:

   6 -> Option A

4. Quick Check:

   Max threads = maxPoolSize = 6 [OK]

Hint: Max threads = maxPoolSize property [OK]

Common Mistakes:

• Confusing queue capacity with max threads
• Thinking corePoolSize is max threads
• Adding corePoolSize and queueCapacity incorrectly

4. What is wrong with this custom thread pool configuration in Spring Boot?

@Bean
public ThreadPoolTaskExecutor taskExecutor() {
  ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
  executor.setCorePoolSize(5);
  executor.setMaxPoolSize(3);
  executor.setQueueCapacity(10);
  executor.initialize();
  return executor;
}

medium

A. Missing @EnableAsync annotation on configuration class

B. Queue capacity cannot be set in ThreadPoolTaskExecutor

C. Core pool size is greater than max pool size, which is invalid

D. ThreadPoolTaskExecutor cannot be returned as a bean

Solution

1. Step 1: Check core and max pool size relationship

   Core pool size must be less than or equal to max pool size; here core is 5 but max is 3, which is invalid.

2. Step 2: Validate other settings

   Queue capacity is valid; @EnableAsync is optional but recommended; returning ThreadPoolTaskExecutor bean is correct.

3. Final Answer:

   Core pool size is greater than max pool size, which is invalid -> Option C

4. Quick Check:

   Core pool ≤ max pool required [OK]

Hint: Core pool size must not exceed max pool size [OK]

Common Mistakes:

• Setting core pool size larger than max pool size
• Assuming queue capacity is mandatory to set
• Forgetting to add @EnableAsync (not always required)

5. You want to create a custom thread pool in Spring Boot that has a core pool size of 4, max pool size of 8, and a queue capacity of 20. You also want to set a thread name prefix "MyApp-" for easier debugging. Which of the following code snippets correctly implements this configuration?

hard

A. @Bean
public ThreadPoolTaskExecutor taskExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
executor.setCorePoolSize(4);
executor.setMaxPoolSize(8);
executor.setQueueCapacity(20);
executor.setThreadNamePrefix("MyApp-");
executor.initialize();
return executor;
}

B. @Bean
public Executor taskExecutor() {
return Executors.newFixedThreadPool(8);
}

C. @Bean
public ThreadPoolTaskExecutor taskExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
executor.setCorePoolSize(8);
executor.setMaxPoolSize(4);
executor.setQueueCapacity(20);
executor.setThreadNamePrefix("MyApp-");
executor.initialize();
return executor;
}

D. @Bean
public ThreadPoolTaskExecutor taskExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
executor.setCorePoolSize(4);
executor.setMaxPoolSize(8);
executor.setQueueCapacity(20);
executor.setThreadNamePrefix("App-");
executor.initialize();
return executor;
}

Solution

1. Step 1: Verify core, max pool sizes and queue capacity

   Core pool size 4, max pool size 8, and queue capacity 20 match the requirement in @Bean public ThreadPoolTaskExecutor taskExecutor() { ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor(); executor.setCorePoolSize(4); executor.setMaxPoolSize(8); executor.setQueueCapacity(20); executor.setThreadNamePrefix("MyApp-"); executor.initialize(); return executor; }.

2. Step 2: Check thread name prefix correctness

   @Bean public ThreadPoolTaskExecutor taskExecutor() { ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor(); executor.setCorePoolSize(4); executor.setMaxPoolSize(8); executor.setQueueCapacity(20); executor.setThreadNamePrefix("MyApp-"); executor.initialize(); return executor; } sets thread name prefix to "MyApp-" exactly as requested.

3. Step 3: Validate other options

   @Bean public Executor taskExecutor() { return Executors.newFixedThreadPool(8); } uses fixed thread pool without prefix; @Bean public ThreadPoolTaskExecutor taskExecutor() { ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor(); executor.setCorePoolSize(8); executor.setMaxPoolSize(4); executor.setQueueCapacity(20); executor.setThreadNamePrefix("MyApp-"); executor.initialize(); return executor; } reverses core and max sizes (invalid); @Bean public ThreadPoolTaskExecutor taskExecutor() { ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor(); executor.setCorePoolSize(4); executor.setMaxPoolSize(8); executor.setQueueCapacity(20); executor.setThreadNamePrefix("App-"); executor.initialize(); return executor; } uses wrong prefix.

4. Final Answer:

   Option A code snippet correctly implements the required configuration -> Option A

5. Quick Check:

   Correct sizes and prefix = @Bean public ThreadPoolTaskExecutor taskExecutor() { ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor(); executor.setCorePoolSize(4); executor.setMaxPoolSize(8); executor.setQueueCapacity(20); executor.setThreadNamePrefix("MyApp-"); executor.initialize(); return executor; } [OK]

Hint: Match core, max sizes and prefix exactly [OK]

Common Mistakes:

• Swapping core and max pool sizes
• Using wrong thread name prefix
• Using fixed thread pool instead of ThreadPoolTaskExecutor