Spring Boot启动项目时如何加载缓存

在SpringBoot项目中，执行启动时的初始化工作（如加载缓存）是一个常见的需求。可以通过多种方式实现，包括使用@PostConstruct注解、实现ApplicationRunner或CommandLineRunner接口，以及监听Spring的生命周期事件。下面详细介绍这些方法，并给出相应的代码示例。

方法一：使用 @PostConstruct 注解

@PostConstruct注解可以用来标记一个方法，在依赖注入完成后立即执行。这个方法在Spring容器初始化完毕后自动调用，非常适合做一些初始化工作。

import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;

@Component
public class CacheLoader {

    @PostConstruct
    public void loadCache() {
        // 初始化缓存
        System.out.println("Loading cache at startup...");
        // 例如：缓存某些数据
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

方法二：实现 CommandLineRunner 接口

实现CommandLineRunner接口的run方法，SpringBoot启动时会调用这个方法，适合用来执行启动时的初始化任务。

import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

@Component
public class CacheLoader implements CommandLineRunner {

    @Override
    public void run(String... args) throws Exception {
        // 初始化缓存
        System.out.println("Loading cache at startup...");
        // 例如：缓存某些数据
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

方法三：实现 ApplicationRunner 接口

与CommandLineRunner类似，ApplicationRunner接口也是在SpringBoot启动完成后调用，但提供了更为丰富的ApplicationArguments对象，可以用于处理传入的命令行参数。

import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.stereotype.Component;

@Component
public class CacheLoader implements ApplicationRunner {

    @Override
    public void run(ApplicationArguments args) throws Exception {
        // 初始化缓存
        System.out.println("Loading cache at startup...");
        // 例如：缓存某些数据
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

方法四：监听 Spring 的生命周期事件

通过实现ApplicationListener接口或使用@EventListener注解，监听 ApplicationReadyEvent事件，在SpringBoot启动完成后执行初始化工作。

import org.springframework.boot.context.event.ApplicationReadyEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;
@Component
public class CacheLoader implements ApplicationListener<ApplicationReadyEvent> {
    @Override
    public void onApplicationEvent(ApplicationReadyEvent event) {
        // 初始化缓存
        System.out.println("Loading cache at startup...");
        // 例如：缓存某些数据
    }
}
1
2
3
4
5
6
7
8
9
10
11
12

或者使用 @EventListener 注解：

import org.springframework.boot.context.event.ApplicationReadyEvent;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
@Component
public class CacheLoader {
    @EventListener(ApplicationReadyEvent.class)
    public void onApplicationReady() {
        // 初始化缓存
        System.out.println("Loading cache at startup...");
        // 例如：缓存某些数据
    }
}
1
2
3
4
5
6
7
8
9
10
11
12

选择合适的方法
选择哪种方法取决于具体的需求和使用场景：

• 如果初始化工作是一个Bean的属性，则推荐使用@PostConstruct注解。

• 如果需要访问命令行参数，推荐使用ApplicationRunner或CommandLineRunner。

• 如果需要监听应用上下文事件，推荐使用ApplicationListener或 @EventListener。

示例：加载缓存数据

假设我们要在应用启动时加载一些用户数据到缓存中，以下是一个完整的示例：
示例代码

import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
import java.util.HashMap;
import java.util.Map;
@Component
public class CacheLoader implements CommandLineRunner {
    private Map<Integer, String> userCache = new HashMap<>();
    @Override
    public void run(String... args) throws Exception {
        // 模拟从数据库加载用户数据到缓存
        userCache.put(1, "Alice");
        userCache.put(2, "Bob");
        userCache.put(3, "Charlie");
        System.out.println("User cache loaded at startup: " + userCache);
    }
    public String getUserById(int userId) {
        return userCache.get(userId);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

测试类

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class CacheLoaderApplication implements CommandLineRunner {
    @Autowired
    private CacheLoader cacheLoader;
    public static void main(String[] args) {
        SpringApplication.run(CacheLoaderApplication.class, args);
    }
    @Override
    public void run(String... args) throws Exception {
        // 测试缓存数据
        System.out.println("User with ID 1: " + cacheLoader.getUserById(1));
        System.out.println("User with ID 2: " + cacheLoader.getUserById(2));
        System.out.println("User with ID 3: " + cacheLoader.getUserById(3));
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

通过以上方式，可以确保在SpringBoot项目启动时执行必要的初始化工作，如加载缓存数据，从而提高应用的性能和响应速度。