Redis 的使用场景非常广泛,可以根据项目的具体需求来选择合适的应用方式。
下面V哥依次对17种业务场景举例说明和解释:
针对Redis作为缓存层的使用场景,我将提供一个简单的Java Spring Boot应用案例,该应用使用Redis缓存来提高数据库查询的效率。
场景描述
假设我们有一个在线书店,用户可以查看书籍的详细信息。每次用户请求书籍详情时,后端需要查询数据库以获取书籍信息。为了提高性能,我们可以使用Redis缓存来存储热门书籍的信息,以减少对数据库的查询次数。
环境准备
创建Spring Boot项目
使用Spring Initializr (https://start.spring.io/
) 创建一个项目,并添加所需的依赖。
配置Redis连接
在src/main/resources/application.properties
中配置Redis服务器的连接信息:
spring.redis.host=localhost
spring.redis.port=6379
编写业务代码
public class Book {
private String id;
private String title;
private String author;
// 省略构造函数、getter和setter方法
}
public interface BookService {
Book getBookById(String id);
}
@Service
public class BookServiceImpl implements BookService {
@Autowired
private BookRepository bookRepository;
@Autowired
private StringRedisTemplate redisTemplate;
@Override
public Book getBookById(String id) {
// 尝试从Redis缓存中获取书籍
Book cachedBook = redisTemplate.opsForValue().get(id);
if (cachedBook != null) {
return cachedBook;
}
// 如果缓存中没有,从数据库查询
Book book = bookRepository.findById(id).orElse(null);
if (book != null) {
// 将查询结果放入缓存,设置过期时间为10分钟
redisTemplate.opsForValue().set(id, book, 10, TimeUnit.MINUTES);
}
return book;
}
}
public interface BookRepository extends JpaRepository<Book, String> {
}
@RestController
@RequestMapping("/books")
public class BookController {
@Autowired
private BookService bookService;
@GetMapping("/{id}")
public ResponseEntity<Book> getBook(@PathVariable String id) {
Book book = bookService.getBookById(id);
if (book != null) {
return ResponseEntity.ok(book);
} else {
return ResponseEntity.notFound().build();
}
}
}
详细解释
定义书籍实体类:这是一个简单的POJO类,代表数据库中的书籍记录。
创建书籍服务:BookService接口定义了获取书籍的方法。BookServiceImpl实现了这个接口,并使用BookRepository从数据库获取数据。同时,它还使用了StringRedisTemplate来操作Redis缓存。
缓存逻辑:在getBookById方法中,首先尝试从Redis缓存中获取书籍信息。如果缓存中存在,直接返回;如果不存在,则从数据库查询,并把结果存入缓存,同时设置10分钟的过期时间。
创建控制器:BookController提供了一个RESTful API端点/books/{id},用于根据书籍ID获取书籍信息。
通过这种方式,我们可以显著减少对数据库的查询次数,特别是对于热门书籍,从而提高应用的性能和响应速度。
针对Redis作为会话存储的使用场景,下面是一个Java Spring Boot应用的案例,其中使用Redis来存储用户会话信息。
场景描述
假设我们正在开发一个Web应用程序,用户需要登录以访问某些受保护的资源。为了管理用户会话,我们可以使用Redis来存储会话信息,而不是将它们存储在服务器的内存中或数据库中。
创建Spring Boot项目
使用Spring Initializr (https://start.spring.io/) 创建一个项目,并添加所需的依赖。
配置Redis连接
在src/main/resources/application.properties中配置Redis服务器的连接信息:
spring.redis.host=localhost
spring.redis.port=6379
server.servlet.session.persistent=false
server.servlet.session.timeout=15
spring.session.store-type=redis
编写业务代码
public class User {
private String username;
private String password;
// 省略构造函数、getter和setter方法
}
这里我们使用内存存储作为示例,实际应用中应连接到数据库。
@Service
public class InMemoryUserRepository implements UserDetailsService {
private static final Map<String, User> users = new HashMap<>();
static {
users.put("user", new User("user", "password"));
// 添加更多用户...
}
@Override
public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
User user = users.get(username);
if (user == null) {
throw new UsernameNotFoundException("User not found with username: " + username);
}
return new org.springframework.security.core.userdetails.User(
user.getUsername(),
user.getPassword(),
new ArrayList<>()
);
}
}
@Configuration
@EnableWebSecurity
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
@Autowired
private UserDetailsService userDetailsService;
@Override
protected void configure(HttpSecurity http) throws Exception {
http
.authorizeRequests()
.antMatchers("/admin/**").hasRole("ADMIN")
.antMatchers("/user/**").hasAnyRole("USER", "ADMIN")
.antMatchers("/", "/home", "/register").permitAll()
.anyRequest().authenticated()
.and()
.formLogin()
.loginPage("/login")
.permitAll()
.and()
.logout()
.permitAll();
}
@Autowired
public void configureGlobal(AuthenticationManagerBuilder auth) throws Exception {
auth.userDetailsService(userDetailsService).passwordEncoder(passwordEncoder());
}
@Bean
public PasswordEncoder passwordEncoder() {
return new BCryptPasswordEncoder();
}
}
@Controller
public class WebController {
@GetMapping("/login"
public String login() {
return "login";
}
@GetMapping("/admin"
public String adminPage() {
return "admin";
}
@GetMapping("/user"
public String userPage() {
return "user";
}
@PostMapping("/logout"
public String logout(HttpServletRequest request) {
request.getSession().invalidate();
return "redirect:/login?logout";
}
}
这是一个简单的HTML页面,包含表单用于用户登录。
详细解释
创建用户实体类:这是一个简单的POJO类,代表用户信息。
用户存储库接口:InMemoryUserRepository实现了UserDetailsService接口,用于Spring Security的认证过程。实际应用中,应连接到数据库来获取用户信息。
配置Spring Security:WebSecurityConfig类配置了Spring Security的认证和授权规则。它还配置了自定义的登录页面和登出逻辑。
创建控制器:WebController提供了访问不同页面的路由和登出逻辑。
登录页面:login.html是用户登录的前端页面。
通过这种方式,Spring Session会自动管理用户的会话信息,并将其存储在Redis中。当用户登录时,会话信息将被存储在Redis中,而不是传统的服务器端HttpSession中。这使得会话信息可以在多个服务器实例之间共享,非常适合于分布式部署的Web应用程序。此外,Redis的高性能也有助于提高应用程序的响应速度。
针对Redis作为排行榜和计数器的使用场景,下面是一个Java Spring Boot应用的案例,其中使用Redis来实现一个简单的文章点赞功能,并将点赞数用作排行榜的依据。
场景描述
假设我们正在开发一个博客平台,用户可以对文章进行点赞。我们希望根据文章的点赞数来显示一个实时更新的热门文章排行榜。
创建Spring Boot项目
使用Spring Initializr (https://start.spring.io/) 创建一个项目,并添加所需的依赖。
配置Redis连接
在src/main/resources/application.properties中配置Redis
服务器的连接信息:
spring.redis.host=localhost
spring.redis.port=6379
编写业务代码
public class Article {
private String id;
private String title;
private int likeCount;
// 省略构造函数、getter和setter方法
}
@Service
public class ArticleService {
@Autowired
private StringRedisTemplate redisTemplate;
public void likeArticle(String articleId) {
// 增加文章的点赞数
redisTemplate.opsForValue().increment(articleId, 1);
}
public List<Article> getTopLikedArticles(int topN) {
// 获取topN个点赞数最多的文章
Set<String> articleIds = redisTemplate.keys("article:*:likeCount");
List<Article> topArticles = new ArrayList<>();
for (String id : articleIds) {
int likeCount = (Integer) redisTemplate.opsForValue().get(id);
Article article = new Article();
article.setId(id.replace("article:", "").replace(":likeCount", ""));
article.setTitle("文章标题待查询");
article.setLikeCount(likeCount);
topArticles.add(article);
}
// 根据点赞数排序
topArticles.sort((a1, a2) -> a2.getLikeCount() - a1.getLikeCount());
return topArticles.subList(0, topN);
}
}
@RestController
@RequestMapping("/articles")
public class ArticleController {
@Autowired
private ArticleService articleService;
@PostMapping("/{id}/like")
public ResponseEntity<String> likeArticle(@PathVariable String id) {
articleService.likeArticle(id);
return ResponseEntity.ok("点赞成功");
}
@GetMapping("/top/{topN}")
public ResponseEntity<List<Article>> getTopLikedArticles(@PathVariable int topN) {
List<Article> topArticles = articleService.getTopLikedArticles(topN);
return ResponseEntity.ok(topArticles);
}
}
详细解释
定义文章实体类:这是一个简单的POJO类,代表文章信息,包括文章ID、标题和点赞数。
创建文章服务:ArticleService提供了两个方法,likeArticle用于增加文章的点赞数,getTopLikedArticles用于获取点赞数最多的前N篇文章。
点赞逻辑:在likeArticle方法中,我们使用StringRedisTemplate的increment操作来原子性地增加文章的点赞数。
获取排行榜逻辑:在getTopLikedArticles方法中,我们首先获取所有文章的点赞数键,然后构建一个包含文章点赞数的列表。接着,我们对这个列表进行排序,以获取点赞数最多的前N篇文章。
创建控制器:ArticleController提供了两个RESTful API端点,/articles/{id}/like用于点赞文章,/articles/top/{topN}用于获取点赞数最多的前N篇文章。
通过这种方式,我们可以利用Redis的原子操作和高性能特性来实现一个高效的点赞和排行榜功能。每次用户点赞时,Redis都会原子性地更新点赞数,而获取排行榜时,我们可以快速地从Redis中检索和排序数据,从而提供实时的热门文章排行。
针对Redis作为消息队列的使用场景,下面是一个Java Spring Boot应用的案例,其中使用Redis的发布/订阅功能来实现一个简单的任务队列。
场景描述
假设我们有一个电商平台,需要处理用户的订单。为了提高效率,我们希望将订单处理任务异步化,即用户下单后,订单信息将被发送到一个队列中,然后由一个或多个后台服务来异步处理这些订单。
创建Spring Boot项目
使用Spring Initializr (https://start.spring.io/) 创建一个项目,并添加所需的依赖。
配置Redis连接
在src/main/resources/application.properties中配置Redis服务器的连接信息:
spring.redis.host=localhost
spring.redis.port=6379
编写业务代码
创建一个配置类来设置发布者和订阅者使用的通道。
@Configuration
public class RedisConfig {
@Bean
public RedisMessageListenerContainer redisMessageListenerContainer(RedisConnectionFactory connectionFactory) {
RedisMessageListenerContainer container = new RedisMessageListenerContainer();
container.setConnectionFactory(connectionFactory);
container.addMessageListener(new MessageListenerImpl(), new PatternTopic("order-channel"));
return container;
}
}
@Component
public class MessageListenerImpl implements MessageListener<String, String> {
@Override
public void onMessage(Message<String, String> message, byte[] pattern) {
String orderData = message.getBody();
processOrder(orderData);
}
private void processOrder(String orderData) {
// 处理订单逻辑
System.out.println("Processing order: " + orderData);
// 假设订单处理成功
}
}
@Service
public class OrderService {
@Autowired
private ReactiveRedisTemplate<String, String> reactiveRedisTemplate;
public Mono<Void> placeOrder(String orderData) {
return reactiveRedisTemplate.convertAndSend("order-channel", orderData)
.then();
}
}
@RestController
@RequestMapping("/orders")
public class OrderController {
@Autowired
private OrderService orderService;
@PostMapping
public Mono<ResponseEntity<?>> placeOrder(@RequestBody String orderData) {
return orderService.placeOrder(orderData)
.then(Mono.just(ResponseEntity.ok().build()))
.defaultIfEmpty(ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build());
}
}
详细解释
配置Redis消息队列:RedisConfig配置类设置了Redis消息监听器容器,它将监听名为order-channel的通道。
实现消息监听器:MessageListenerImpl实现了MessageListener接口,用于接收并处理发送到order-channel的消息。每当有新消息到达时,onMessage方法会被调用,订单数据将被传递到processOrder方法进行处理。
创建订单服务:OrderService服务中定义了placeOrder方法,它使用ReactiveRedisTemplate的convertAndSend方法将订单数据发布到order-channel。
创建控制器:OrderController提供了一个POST端点/orders,用于接收订单数据。当接收到订单请求时,它将调用OrderService的placeOrder方法将订单数据发送到Redis消息队列,并返回相应的响应。
通过这种方式,我们可以将订单处理逻辑异步化,提高系统的整体性能和响应能力。用户下单后,前端可以立即收到响应,而订单处理则在后台异步进行。这种模式适用于需要高吞吐量和快速响应的业务场景。
针对Redis作为实时分析使用场景,下面是一个Java Spring Boot应用的案例,其中使用Redis的Sorted Set来实现一个简单的用户在线时长统计和分析功能。
场景描述
假设我们正在开发一个在线教育平台,需要统计每个用户的在线时长,并根据这些数据生成实时的在线时长排行榜。
创建Spring Boot项目
使用Spring Initializr (https://start.spring.io/) 创建一个项目,并添加所需的依赖。
配置Redis连接
在src/main/resources/application.properties中配置Redis服务器的连接信息:
spring.redis.host=localhost
spring.redis.port=6379
编写业务代码
@Service
public class OnlineDurationService {
@Autowired
private StringRedisTemplate redisTemplate;
public void updateUserOnlineDuration(String userId, long duration) {
// 使用Sorted Set存储用户ID和在线时长
redisTemplate.opsForZSet().incrementScore("user:online:duration", userId, duration);
}
public Set<String> getTopUsersByOnlineDuration(int topN) {
// 获取在线时长最长的前N个用户
Set<String> topUsers = redisTemplate.opsForZSet().reverseRange("user:online:duration", 0, topN - 1);
return topUsers;
}
}
@Controller
public class UserController {
@Autowired
private OnlineDurationService onlineDurationService;
@PostMapping("/user/{userId}/login")
public ResponseEntity<String> userLogin(@PathVariable String userId) {
// 用户登录逻辑,可以是任何触发登录的事件
return ResponseEntity.ok("User " + userId + " logged in");
}
@PostMapping("/user/{userId}/logout")
public ResponseEntity<String> userLogout(@PathVariable String userId) {
// 用户登出时记录在线时长
long duration = // 计算用户在线时长的逻辑
onlineDurationService.updateUserOnlineDuration(userId, duration);
return ResponseEntity.ok("User " + userId + " logged out");
}
}
@RestController
@RequestMapping("/users")
public class UserRankController {
@Autowired
private OnlineDurationService onlineDurationService;
@GetMapping("/online-duration/top/{topN}")
public ResponseEntity<Set<String>> getTopUsersByOnlineDuration(@PathVariable int topN) {
Set<String> topUsers = onlineDurationService.getTopUsersByOnlineDuration(topN);
return ResponseEntity.ok(topUsers);
}
}
详细解释
用户在线时长服务:OnlineDurationService服务中定义了两个方法,updateUserOnlineDuration用于更新用户的在线时长,这里使用Redis的Sorted Set数据结构,将用户ID作为成员,在线时长作为分数进行存储。getTopUsersByOnlineDuration方法用于获取在线时长最长的前N个用户。
用户登录和登出逻辑:在UserController中,定义了用户登录和登出的RESTful API。用户登录时,可以执行任何触发登录的逻辑;用户登出时,计算在线时长并通过OnlineDurationService服务更新到Redis中。
获取在线时长排行榜:UserRankController提供了一个GET端点/users/online-duration/top/{topN},用于获取在线时长最长的前N个用户。
通过这种方式,我们可以利用Redis的Sorted Set来存储和排序用户的在线时长,实现一个高效的实时在线时长统计和分析功能。每当用户登出时,系统都会更新用户的在线时长,并可以快速地根据在线时长对用户进行排名,从而提供一个动态的在线时长排行榜。这对于在线教育平台等需要监控用户活跃度的业务场景非常有用。
针对Redis作为分布式锁的使用场景,下面是一个Java Spring Boot应用的案例,其中使用Redisson作为客户端来实现分布式锁。
场景描述
假设我们有一个高流量的电子商务网站,需要执行一些资源密集型的操作,比如生成日报表。为了防止多个实例同时执行这些操作,我们需要一个分布式锁来确保每次只有一个实例可以执行这些操作。
环境准备
创建Spring Boot项目
使用Spring Initializr (https://start.spring.io/) 创建一个项目,并添加所需的依赖。
配置Redisson连接
在src/main/resources/application.properties或application.yml中配置Redisson客户端连接到Redis服务器:
# application.properties
redisson.address=redis://localhost:6379
或者
# application.yml
redisson:
address: "redis://localhost:6379"
编写业务代码
创建一个配置类来配置Redisson客户端。
@Configuration
public class RedissonConfig {
@Bean(destroyMethod = "shutdown")
public RedissonClient redissonClient() {
RedissonClientConfig config = new RedissonClientConfig();
config.useSingleServer().setAddress(redisson.address);
return Redisson.create(config);
}
@Value("${redisson.address}")
private String redissonAddress;
}
创建一个服务类来执行需要分布式锁保护的资源密集型操作。
@Service
public class ReportService {
@Autowired
private RedissonClient redissonClient;
public void generateDailyReport() {
RLock lock = redissonClient.getLock("dailyReportLock");
try {
// 尝试获取锁,最多等待3秒,锁的自动过期时间设置为10秒
if (lock.tryLock(3, 10, TimeUnit.SECONDS)) {
// 执行生成日报表的操作
System.out.println("Generating daily report...");
// 模拟长时间运行的任务
TimeUnit.SECONDS.sleep(5);
System.out.println("Daily report generated.");
}
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
} finally {
// 释放锁
lock.unlock();
}
}
}
创建一个控制器来触发生成日报表的操作。
@RestController
@RequestMapping("/reports")
public class ReportController {
@Autowired
private ReportService reportService;
@GetMapping("/daily")
public ResponseEntity<String> generateDailyReport() {
reportService.generateDailyReport();
return ResponseEntity.ok("Daily report generation triggered.");
}
}
详细解释
使用分布式锁:ReportService服务中的generateDailyReport方法使用Redisson的RLock来获取一个名为dailyReportLock的分布式锁。tryLock方法尝试获取锁,并指定最多等待时间和锁的自动过期时间。如果成功获取锁,则执行生成日报表的操作;如果获取锁失败,则方法将立即返回,不会执行任何操作。
创建控制器:ReportController提供了一个GET端点/reports/daily,用于触发生成日报表的操作。
通过这种方式,我们可以确保在分布式系统中,即使有多个实例运行,也只有一个实例可以执行生成日报表的操作,从而避免资源冲突和重复劳动。Redisson客户端简化了Redis分布式锁的使用,使得在Spring Boot应用中实现分布式锁变得简单而高效。
针对Redis作为发布/订阅消息队列的使用场景,下面是一个Java Spring Boot应用的案例,其中使用Redis的发布/订阅功能来实现一个简单的实时消息通知系统。
场景描述
假设我们正在开发一个社交媒体平台,需要实现一个功能,当用户发布新帖子时,他/她的关注者能够实时收到通知。
环境准备
创建Spring Boot项目
使用Spring Initializr (https://start.spring.io/) 创建一个项目,并添加所需的依赖。
配置Redis连接
在src/main/resources/application.properties中配置Redis服务器的连接信息:
spring.redis.host=localhost
spring.redis.port=6379
编写业务代码
创建一个配置类来定义发布者和订阅者使用的通道。
@Configuration
public class RedisPubSubConfig {
@Bean
public ReactiveRedisConnectionFactory reactiveRedisConnectionFactory(LettuceClientConfiguration clientConfig) {
return new LettuceConnectionFactory(clientConfig);
}
@Bean
public RedisMessageListenerContainer redisMessageListenerContainer(ReactiveRedisConnectionFactory connectionFactory) {
RedisMessageListenerContainer container = new RedisMessageListenerContainer();
container.setConnectionFactory(connectionFactory);
container.addMessageListener(new PostNotificationListener(), new PatternTopic("newPostChannel"));
return container;
}
@Bean
public LettuceClientConfiguration clientConfig() {
return LettuceClientConfiguration.defaultConfiguration();
}
@Component
public class PostNotificationListener implements MessageListener<String, String> {
@Override
public void onMessage(Message<String, String> message) {
// 处理接收到的帖子通知
String postContent = message.getBody();
System.out.println("New post notification received: " + postContent);
// 这里可以添加逻辑,比如通知关注者
}
}
}
创建一个服务类来发送新帖子的通知。
@Service
public class PostService {
@Autowired
private ReactiveRedisTemplate<String, String> reactiveRedisTemplate;
public Mono<Void> publishNewPostNotification(String postContent) {
return reactiveRedisTemplate.convertAndSend("newPostChannel", postContent);
}
}
创建一个控制器来处理新帖子的发布请求。
@RestController
@RequestMapping("/posts")
public class PostController {
@Autowired
private PostService postService;
@PostMapping
public Mono<ResponseEntity<?>> createPost(@RequestBody String postContent) {
return postService.publishNewPostNotification(postContent)
.then(Mono.just(ResponseEntity.ok().build()))
.defaultIfEmpty(ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build());
}
}
详细解释
配置发布/订阅通道:RedisPubSubConfig配置类设置了ReactiveRedisConnectionFactory和RedisMessageListenerContainer。PostNotificationListener实现了MessageListener接口,用于接收并处理新帖子的通知。
发送新帖子通知:PostService服务中的publishNewPostNotification方法使用ReactiveRedisTemplate的convertAndSend方法将新帖子的内容发布到newPostChannel通道。
创建控制器:PostController提供了一个POST端点/posts,用于接收新帖子的内容。当接收到新帖子的请求时,它将调用PostService的publishNewPostNotification方法将新帖子的内容发送到Redis通道,并返回相应的响应。
通过这种方式,我们可以利用Redis的发布/订阅功能来实现一个高效的实时消息通知系统。每当有新帖子发布时,Redis会将通知消息发布到newPostChannel通道,所有订阅了该通道的监听器(如PostNotificationListener)都会收到消息并进行处理,比如通知帖子作者的关注者。这种模式适用于需要实时通信和通知的业务场景,如社交媒体、实时聊天应用等。
针对Redis作为限流功能的使用场景,下面是一个Java Spring Boot应用的案例,其中使用Redis来实现API的限流。
场景描述
环境准备
创建Spring Boot项目
使用Spring Initializr (https://start.spring.io/) 创建一个项目,并添加所需的依赖。
配置Redis连接
在src/main/resources/application.properties中配置Redis服务器的连接信息:
spring.redis.host=localhost
spring.redis.port=6379
编写业务代码
定义一个自定义注解,用于标识需要限流的API。
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface RateLimit {
int limit() default 10; // 默认每分钟请求次数限制
long timeout() default 60; // 默认时间窗口为60秒
}
实现一个拦截器来检查请求频率。
public class RateLimiterInterceptor implements HandlerInterceptor {
private final RedisTemplate<String, Integer> redisTemplate;
private final String rateLimitKeyPrefix = "rate_limit:";
public RateLimiterInterceptor(RedisTemplate<String, Integer> redisTemplate) {
this.redisTemplate = redisTemplate;
}
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
String ip = request.getRemoteAddr();
String methodName = ((MethodSignature) (handler)).getMethod().getName();
String rateLimitKey = rateLimitKeyPrefix + methodName + ":" + ip;
int currentCount = redisTemplate.opsForValue().increment(rateLimitKey);
if (currentCount > 1) {
// 如果当前计数大于1,则说明请求已超过限制
response.sendError(HttpServletResponse.SC_TOO_MANY_REQUESTS, "Too many requests, please try again later.");
return false;
}
// 设置过期时间
redisTemplate.expire(rateLimitKey, RateLimit.class.cast(((MethodSignature) handler).getMethod().getAnnotation(RateLimit.class)).timeout(), TimeUnit.SECONDS);
return true;
}
}
配置拦截器以应用于所有控制器。
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Autowired
private RateLimiterInterceptor rateLimiterInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(rateLimiterInterceptor);
}
}
在需要限流的API上应用自定义的RateLimit注解。
@RestController
public class ApiController {
@RateLimit(limit = 5, timeout = 60) // 每分钟最多5个请求
@GetMapping("/api/resource")
public ResponseEntity<String> getLimitedResource() {
return ResponseEntity.ok("Access to limited resource");
}
}
详细解释
创建限流注解:定义了一个RateLimit注解,它包含限制的请求次数和时间窗口。
配置拦截器:WebConfig类实现了WebMvcConfigurer接口,用于注册RateLimiterInterceptor拦截器,使其应用于所有的控制器方法。
应用限流注解:在ApiController中的getLimitedResource方法上应用了RateLimit注解,指定了每分钟最多5个请求的限制。
通过这种方式,我们可以利用Redis的原子递增操作和键过期特性来实现API的限流。每次请求都会检查当前IP的请求计数,如果超过限制,则返回429错误码(Too Many Requests)。这有助于保护API免受滥用,并确保服务的稳定性和可用性。
针对Redis作为数据过期自动清理的使用场景,下面是一个Java Spring Boot应用的案例,其中使用Redis来存储临时数据,比如用户会话信息,并设置过期时间以自动清理这些数据。
场景描述
假设我们正在开发一个Web应用,用户登录后生成的会话信息需要在用户登出或一定时间后自动清除。我们可以使用Redis来存储这些会话信息,并利用它的过期时间特性来自动清理这些会话。
环境准备
创建Spring Boot项目
使用Spring Initializr (https://start.spring.io/) 创建一个项目,并添加所需的依赖。
配置Redis连接和Spring Session
在src/main/resources/application.properties中配置Redis服务器的连接信息以及Spring Session的存储类型:
spring.redis.host=localhost
spring.redis.port=6379
spring.session.store-type=redis
编写业务代码
创建配置类以启用Spring Session的Redis支持:
@Configuration
@EnableRedisHttpSession
public class SessionConfig {
// 配置类不需要额外代码,@EnableRedisHttpSession将自动配置所需的Bean
}
创建一个控制器来处理用户登录和登出,并存储会话信息:
@Controller
public class SessionController {
// 用户登录后,Spring Session会自动存储会话信息到Redis
@PostMapping("/login")
public String login(SessionStatus sessionStatus, String username) {
sessionStatus.setAttribute("username", username);
return "loginSuccess";
}
// 用户登出时,清除会话信息
@PostMapping("/logout")
public String logout(SessionStatus sessionStatus) {
sessionStatus.invalidate();
return "logoutSuccess";
}
}
创建一个配置类来设置会话的超时时间:
@Configuration
public class SessionTimeoutConfig {
@Bean
public ConfigurableServletWebServerFactory<?> webServerFactory() {
TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory();
factory.setSessionTimeout(30); // 设置会话超时时间(以分钟为单位)
return factory;
}
}
详细解释
配置Spring Session Redis:SessionConfig类通过@EnableRedisHttpSession注解启用了Spring Session的Redis支持。Spring Session将自动管理HTTP Session,并将其存储在Redis中。
用户登录和登出逻辑:SessionController控制器提供了登录和登出的处理逻辑。在用户登录时,会将用户名存储到会话中。在用户登出时,会话将被无效化,Spring Session会自动从Redis中清除会话信息。
设置会话超时:SessionTimeoutConfig配置类设置了会话的超时时间。Tomcat的TomcatServletWebServerFactory用于设置会话超时时间,这个时间之后,即使用户没有显式登出,会话也会被自动清除。
通过这种方式,我们可以确保用户的会话信息在一定时间后自动从Redis中清除,无需手动干预。这不仅有助于释放Redis存储空间,还可以提高应用的安全性,防止旧会话被滥用。此外,Spring Session的自动管理简化了会话管理的复杂性,使得开发者可以更专注于业务逻辑的实现。
针对Redis作为全页缓存的使用场景,下面是一个Java Spring Boot应用的案例,其中使用Redis来缓存整个页面的HTML内容。
场景描述
假设我们正在开发一个新闻网站,该网站的首页包含多个新闻文章的摘要信息。由于首页访问频率很高,我们希望将整个首页的内容缓存起来,以减少数据库的查询次数和页面渲染时间。
环境准备
创建Spring Boot项目
使用Spring Initializr (https://start.spring.io/) 创建一个项目,并添加所需的依赖。
配置Redis连接
在src/main/resources/application.properties中配置Redis服务器的连接信息:
spring.redis.host=localhost
spring.redis.port=6379
编写业务代码
@Service
public class NewsService {
// 假设有一个方法来获取新闻列表
public List<Article> getNewsList() {
// 这里是获取新闻列表的逻辑
return Collections.emptyList();
}
}
创建一个配置类来设置Spring Cache和Redis缓存。
@Configuration
@EnableCaching
public class CacheConfig {
@Bean
public CacheManager cacheManager(RedisConnectionFactory connectionFactory) {
RedisCacheManager cacheManager = new RedisCacheManager(connectionFactory);
// 设置缓存过期时间(例如5分钟)
cacheManager.setDefaultExpiration(300);
return cacheManager;
}
}
创建一个控制器来返回首页,并使用Redis缓存整个页面。
@Controller
public class NewsController {
@Autowired
private NewsService newsService;
@Autowired
private CacheManager cacheManager;
@GetMapping("/")
@Cacheable(value = "homePage", condition = "#root.caches[0].name == 'homePage'")
public String homePage(Model model) {
// 尝试从缓存中获取页面
model.addAttribute("newsList", newsService.getNewsList());
return "home";
}
}
创建一个Thymeleaf模板home.html来渲染首页。
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<title>首页</title>
</head>
<body>
<h1>新闻首页</h1>
<div th:each="article : ${newsList}">
<h2 th:text="${article.title}"></h2>
<p th:text="${article.summary}"></p>
</div>
</body>
</html>
详细解释
创建新闻文章服务:NewsService服务包含获取新闻列表的逻辑。
配置Redis缓存:CacheConfig配置类通过@EnableCaching注解启用了Spring的缓存支持,并配置了一个RedisCacheManager Bean来管理Redis缓存。
创建控制器和视图:NewsController控制器中的homePage方法使用@Cacheable注解来指定缓存的名称(这里是homePage)。当这个方法被调用时,Spring会检查指定的缓存中是否存在该页面的缓存。如果存在,就直接返回缓存的内容;如果不存在,就执行方法并将结果存储到缓存中。
创建Thymeleaf模板:home.html是一个Thymeleaf模板,用于渲染新闻列表。
通过这种方式,我们可以利用Redis来缓存整个页面的内容。首页的访问非常频繁,通过缓存可以显著减少数据库的查询次数和页面渲染时间,提高网站的响应速度和性能。此外,Spring的缓存抽象和Thymeleaf模板使得实现全页缓存变得简单而高效。
针对Redis作为社交功能存储的使用场景,下面是一个Java Spring Boot应用的案例,其中使用Redis来存储用户的社交关系信息,如好友列表和用户状态更新。
场景描述
假设我们正在开发一个社交网络平台,用户可以添加好友,并且可以发布状态更新。我们需要存储每个用户的好友列表以及状态更新的时间线。
环境准备
创建Spring Boot项目
使用Spring Initializr (https://start.spring.io/) 创建一个项目,并添加所需的依赖。
配置Redis连接
在src/main/resources/application.properties中配置Redis服务器的连接信息:
spring.redis.host=localhost
spring.redis.port=6379
编写业务代码
public class User {
private String id;
private String name;
// 省略构造函数、getter和setter方法
}
public class StatusUpdate {
private String userId;
private String content;
private Instant timestamp;
// 省略构造函数、getter和setter方法
}
@Service
public class SocialService {
@Autowired
private StringRedisTemplate redisTemplate;
public void addFriend(String userOneId, String userTwoId) {
// 使用集合存储用户的好友列表
redisTemplate.opsForSet().add("friends:" + userOneId, userTwoId);
redisTemplate.opsForSet().add("friends:" + userTwoId, userOneId);
}
public Set<String> getFriends(String userId) {
// 获取用户的好友列表
return redisTemplate.opsForSet().members("friends:" + userId);
}
public void postStatusUpdate(String userId, String content) {
// 使用列表存储用户的状态更新时间线
StatusUpdate statusUpdate = new StatusUpdate(userId, content, Instant.now());
redisTemplate.opsForList().rightPush("timeline:" + userId, statusUpdate);
}
public List<StatusUpdate> getStatusUpdates(String userId) {
// 获取用户的状态更新时间线
return redisTemplate.opsForList().range("timeline:" + userId, 0, -1);
}
}
@RestController
@RequestMapping("/social")
public class SocialController {
@Autowired
private SocialService socialService;
@PostMapping("/addFriend")
public ResponseEntity<String> addFriend(@RequestParam String userOneId, @RequestParam String userTwoId) {
socialService.addFriend(userOneId, userTwoId);
return ResponseEntity.ok("Friends added successfully");
}
@GetMapping("/friends/{userId}")
public ResponseEntity<Set<String>> getFriends(@PathVariable String userId) {
Set<String> friends = socialService.getFriends(userId);
return ResponseEntity.ok(friends);
}
@PostMapping("/status")
public ResponseEntity<String> postStatusUpdate(@RequestParam String userId, @RequestParam String content) {
socialService.postStatusUpdate(userId, content);
return ResponseEntity.ok("Status updated successfully");
}
@GetMapping("/timeline/{userId}")
public ResponseEntity<List<StatusUpdate>> getStatusUpdates(@PathVariable String userId) {
List<StatusUpdate> updates = socialService.getStatusUpdates(userId);
return ResponseEntity.ok(updates);
}
}
详细解释
定义用户和状态更新实体类:User类代表用户信息,StatusUpdate类代表用户的状态更新信息。
创建社交服务:SocialService服务提供了添加好友、获取好友列表、发布状态更新和获取状态更新时间线的方法。好友列表使用Redis的Set数据结构存储,确保好友关系是无序且不重复的。状态更新时间线使用List数据结构存储,新的状态更新会被添加到列表的尾部。
创建控制器:SocialController控制器提供了四个RESTful API端点,分别用于添加好友、获取好友列表、发布状态更新和获取状态更新时间线。
通过这种方式,我们可以利用Redis的高性能和数据结构特性来实现社交网络平台中的社交功能。Redis的Set和List数据结构非常适合存储和管理好友关系和状态更新时间线,能够提供快速的读写性能,满足社交网络平台的需求。
针对Redis作为实时推荐系统存储的使用场景,下面是一个Java Spring Boot应用的案例,其中使用Redis来存储用户行为数据和偏好,以及提供一个简单的推荐功能。
场景描述
假设我们正在开发一个电子商务平台,我们希望根据用户的浏览和购买历史来推荐商品。我们将使用Redis来存储用户的这些行为数据,并根据这些数据生成推荐。
环境准备
创建Spring Boot项目
使用Spring Initializr (https://start.spring.io/) 创建一个项目,并添加所需的依赖。
配置Redis连接
在src/main/resources/application.properties中配置Redis服务器的连接信息:
spring.redis.host=localhost
spring.redis.port=6379
编写业务代码
public class Product {
private String id;
private String name;
// 省略构造函数、getter和setter方法
}
public class User {
private String id;
private String username;
// 省略构造函数、getter和setter方法
}
@Service
public class RecommendationService {
@Autowired
private StringRedisTemplate redisTemplate;
public void recordView(String userId, String productId) {
// 记录用户查看的商品
redisTemplate.opsForList().leftPush("user:" + userId + ":views", productId);
}
public List<String> recommendProducts(String userId) {
// 简单推荐算法:返回用户查看次数最多的商品
Set<String> viewedProducts = redisTemplate.opsForSet().members("user:" + userId + ":views");
Map<String, Long> productViewCounts = new HashMap<>();
viewedProducts.forEach(productId -> {
long count = redisTemplate.opsForValue().decrement("user:" + userId + ":views:" + productId);
productViewCounts.put(productId, count);
});
return productViewCounts.entrySet().stream()
.sorted(Map.Entry.<String, Long>comparingByValue().reversed())
.map(Map.Entry::getKey)
.collect(Collectors.toList());
}
}
@RestController
@RequestMapping("/recommendations")
public class RecommendationController {
@Autowired
private RecommendationService recommendationService;
@PostMapping("/view")
public ResponseEntity<String> recordProductView(@RequestParam String userId, @RequestParam String productId) {
recommendationService.recordView(userId, productId);
return ResponseEntity.ok("View recorded");
}
@GetMapping("/products")
public ResponseEntity<List<String>> getRecommendations(@RequestParam String userId) {
List<String> recommendedProducts = recommendationService.recommendProducts(userId);
return ResponseEntity.ok(recommendedProducts);
}
}
详细解释
创建商品和用户实体类:Product类代表商品信息,User类代表用户信息。
创建推荐服务:
创建控制器:
通过这种方式,我们可以利用Redis的高性能和简单的数据结构来快速记录用户行为并生成推荐。虽然这里的推荐算法非常简单,但它展示了如何使用Redis来实现实时推荐系统的基础功能。在实际应用中,推荐算法可能会更复杂,涉及机器学习模型和更丰富的用户行为数据。
针对Redis作为地理位置信息存储的使用场景,下面是一个Java Spring Boot应用的案例,其中使用Redis的Geospatial索引来实现基于地理位置的推荐功能。
场景描述
假设我们正在开发一款基于位置的社交应用,用户可以查看附近的其他用户或地点。我们需要存储用户的地理位置,并能够查询给定位置附近的用户。
环境准备
创建Spring Boot项目
使用Spring Initializr (https://start.spring.io/) 创建一个项目,并添加所需的依赖。
配置Redis连接
在src/main/resources/application.properties中配置Redis服务器的连接信息:
spring.redis.host=localhost
spring.redis.port=6379
编写业务代码
public class User {
private String id;
private String name;
private double longitude;
private double latitude;
// 省略构造函数、getter和setter方法
}
@Service
public class GeoLocationService {
@Autowired
private RedisTemplate<String, User> redisTemplate;
public void addLocation(String userId, double longitude, double latitude) {
User user = new User(userId, "username", longitude, latitude);
// 使用Geospatial索引存储用户位置
redisTemplate.opsForGeo().add("userLocations", new GeoLocation(user.getLongitude(), user.getLatitude()), userId);
}
public List<User> getUsersNearby(double longitude, double latitude, double radius) {
// 查询给定位置附近的用户
List<GeoWithin> nearbyUsersGeo = redisTemplate.opsForGeo().radius("userLocations",
new Circle(new GeoCoordinate(latitude, longitude), radius),
RedisGeoCommands.GeoRadiusCommandArgs.newGeoRadiusArgs());
List<User> nearbyUsers = new ArrayList<>();
for (GeoWithin geoWithin : nearbyUsersGeo) {
nearbyUsers.add(redisTemplate.opsForValue().get(geoWithin.getMember()));
}
return nearbyUsers;
}
}
@RestController
@RequestMapping("/users")
public class UserController {
@Autowired
private GeoLocationService geoLocationService;
@PostMapping("/addLocation")
public ResponseEntity<String> addLocation(@RequestParam String userId,
@RequestParam double longitude,
@RequestParam double latitude) {
geoLocationService.addLocation(userId, longitude, latitude);
return ResponseEntity.ok("User location added");
}
@GetMapping("/nearby")
public ResponseEntity<List<User>> getUsersNearby(@RequestParam double longitude,
@RequestParam double latitude,
@RequestParam double radius) {
List<User> nearbyUsers = geoLocationService.getUsersNearby(longitude, latitude, radius);
return ResponseEntity.ok(nearbyUsers);
}
}
详细解释
创建用户实体类:User类代表用户信息,包括用户的ID、名称、经度和纬度。
创建地理位置服务:
创建控制器:
通过这种方式,我们可以利用Redis的Geospatial索引来存储和查询地理位置信息。这对于需要基于地理位置提供服务的应用非常有用,如社交网络、共享出行、本地服务推荐等。Redis的Geospatial索引提供了高效的邻近查询功能,可以快速找到指定范围内的用户或其他地理位置相关的实体。
针对Redis作为时间序列数据存储的使用场景,下面是一个Java Spring Boot应用的案例,其中使用Redis来存储和查询时间序列数据。
场景描述
假设我们正在开发一个监控系统,需要记录服务器的CPU使用率随时间变化的数据。我们将使用Redis的时间序列数据结构来存储这些监控数据,并能够查询任意时间范围内的CPU使用率。
环境准备
创建Spring Boot项目
使用Spring Initializr (https://start.spring.io/) 创建一个项目,并添加所需的依赖。
配置Redis连接
在src/main/resources/application.properties中配置Redis服务器的连接信息:
spring.redis.host=localhost
spring.redis.port=6379
编写业务代码
public class CpuUsageData {
private Instant timestamp;
private double cpuUsage;
// 省略构造函数、getter和 setter 方法
}
@Service
public class MonitoringService {
@Autowired
private LettuceConnectionFactory connectionFactory;
public void logCpuUsage(String serverId, double cpuUsage) {
// 记录CPU使用率数据
CpuUsageData data = new CpuUsageData(Instant.now(), cpuUsage);
// 使用Lettuce客户端的命令执行器来与RedisTimeSeries模块交互
StatefulRedisConnection<String, CpuUsageData> connection = connectionFactory.connect();
try {
RedisTimeSeriesCommands<String, CpuUsageData> ts = connection.sync();
ts.add(serverId, data.getTimestamp().toEpochMilli() / 1000, data);
} finally {
connection.close();
}
}
public List<CpuUsageData> getCpuUsageHistory(String serverId, Instant start, Instant end) {
// 查询指定时间范围内的CPU使用率历史数据
List<CpuUsageData> history = new ArrayList<>();
StatefulRedisConnection<String, CpuUsageData> connection = connectionFactory.connect();
try {
RedisTimeSeriesCommands<String, CpuUsageData> ts = connection.sync();
Range range = Range.create(start.toEpochMilli() / 1000, end.toEpochMilli() / 1000);
Cursor<CpuUsageData> cursor = ts.rangeRead(serverId, range);
while (cursor.hasNext()) {
history.add(cursor.next().getValue());
}
} finally {
connection.close();
}
return history;
}
}
@RestController
@RequestMapping("/monitoring")
public class MonitoringController {
@Autowired
private MonitoringService monitoringService;
@PostMapping("/logCpuUsage")
public ResponseEntity<String> logCpuUsage(@RequestParam String serverId, @RequestParam double cpuUsage) {
monitoringService.logCpuUsage(serverId, cpuUsage);
return ResponseEntity.ok("CPU usage logged");
}
@GetMapping("/cpuUsageHistory")
public ResponseEntity<List<CpuUsageData>> getCpuUsageHistory(@RequestParam String serverId,
@RequestParam Instant start,
@RequestParam Instant end) {
List<CpuUsageData> history = monitoringService.getCpuUsageHistory(serverId, start, end);
return ResponseEntity.ok(history);
}
}
详细解释
创建监控数据实体类:CpuUsageData类代表CPU使用率数据,包括时间戳和CPU使用率。
创建监控服务:
创建控制器:
通过这种方式,我们可以利用Redis的RedisTimeSeries模块来存储和查询时间序列数据。这对于需要监控和分析随时间变化的数据的应用非常有用,如服务器监控、网站访问量分析等。RedisTimeSeries提供了高效的时间序列数据存储和查询功能,可以快速插入和检索大量时间戳数据。
针对Redis作为任务调度的使用场景,下面是一个Java Spring Boot应用的案例,其中使用Redis的延迟队列特性来实现任务调度。
场景描述
假设我们正在开发一个定时任务管理系统,需要安排一些任务在将来的某个时间点执行。我们将使用Redis的schedule命令来安排任务的执行。
环境准备
创建Spring Boot项目
使用Spring Initializr (https://start.spring.io/) 创建一个项目,并添加所需的依赖。
配置Redis连接
在src/main/resources/application.properties中配置Redis服务器的连接信息:
spring.redis.host=localhost
spring.redis.port=6379
编写业务代码
@Service
public class TaskSchedulingService {
@Autowired
private RedisTemplate<String, Runnable> redisTemplate;
public void scheduleTask(Runnable task, long delay, TimeUnit timeUnit) {
// 将任务和延迟时间存储到Redis中
redisTemplate.opsForValue().set(
"task:" + task.hashCode(),
task,
timeUnit.toSeconds(delay),
timeUnit
);
// 使用schedule命令安排任务在未来执行
String scheduleCommand = String.format(
"SCHEDULE %d %s",
System.currentTimeMillis() + timeUnit.toMillis(delay),
"task:" + task.hashCode()
);
redisTemplate.execute((RedisConnection connection) -> {
connection.schedule(scheduleCommand);
return null;
});
}
}
public class SampleTask implements Runnable {
@Override
public void run() {
System.out.println("Task is running: " + LocalDateTime.now());
// 执行任务逻辑
}
}
@RestController
@RequestMapping("/tasks")
public class TaskController {
@Autowired
private TaskSchedulingService taskSchedulingService;
@PostMapping("/schedule")
public ResponseEntity<String> scheduleTask(@RequestParam long delay, @RequestParam TimeUnit timeUnit) {
taskSchedulingService.scheduleTask(new SampleTask(), delay, timeUnit);
return ResponseEntity.ok("Task scheduled for execution at " + LocalDateTime.now().plusNanos(timeUnit.toNanos(delay)));
}
}
详细解释
创建任务调度服务:scheduleTask方法用于安排一个Runnable任务在未来的某个时间点执行。首先,任务被存储到Redis中,并设置相应的延迟时间。然后,使用Redis的schedule命令安排任务在未来执行。
创建具体的任务:SampleTask类实现了Runnable接口,定义了任务的具体执行逻辑。
创建控制器:scheduleTask端点允许用户安排任务在未来执行。用户需要提供延迟时间和时间单位。
通过这种方式,我们可以利用Redis的schedule命令来安排任务的执行。这对于需要执行定时任务的应用非常有用,如定时数据备份、定时发送通知等。通过Redis的延迟队列特性,我们可以简化任务调度的复杂性,并且能够灵活地安排任务在未来的任意时间点执行。
针对Redis作为数据共享的使用场景,下面是一个Java Spring Boot应用的案例,其中使用Redis来实现微服务架构中的服务间数据共享。
场景描述
假设我们有一个电商平台,它由多个微服务组成,比如用户服务、产品服务和订单服务。这些服务需要共享购物车数据,以确保用户在平台上的购物体验是连贯的。我们将使用Redis来存储和共享购物车数据。
环境准备
创建Spring Boot项目
使用Spring Initializr (https://start.spring.io/) 创建一个项目,并添加所需的依赖。
配置Redis连接
在src/main/resources/application.properties中配置Redis服务器的连接信息:
spring.redis.host=localhost
spring.redis.port=6379
编写业务代码
public class CartItem {
private String productId;
private int quantity;
// 省略构造函数、getter和setter方法
}
@Service
public class CartService {
@Autowired
private StringRedisTemplate redisTemplate;
public void addToCart(String cartId, String productId, int quantity) {
// 将购物车项存储到Redis的Hash结构中
redisTemplate.opsForHash().put("cart:" + cartId, productId, quantity);
}
public Map<String, Integer> getCart(String cartId) {
// 从Redis获取购物车内容
return redisTemplate.opsForHash().entries("cart:" + cartId);
}
}
@RestController
@RequestMapping("/cart")
public class CartController {
@Autowired
private CartService cartService;
@PostMapping("/{cartId}/items")
public ResponseEntity<String> addToCart(@PathVariable String cartId,
@RequestParam String productId,
@RequestParam int quantity) {
cartService.addToCart(cartId, productId, quantity);
return ResponseEntity.ok("Item added to cart");
}
@GetMapping("/{cartId}")
public ResponseEntity<Map<String, Integer>> getCart(@PathVariable String cartId) {
Map<String, Integer> cart = cartService.getCart(cartId);
return ResponseEntity.ok(cart);
}
}
详细解释
创建购物车项实体类:CartItem类代表购物车中的商品项,包含商品ID和数量。
创建购物车服务:
创建控制器:
通过这种方式,我们可以利用Redis的高性能和数据共享能力来实现微服务架构中的服务间数据共享。购物车数据被存储在Redis中,可以被不同的微服务实例访问和修改,确保了数据的一致性和实时性。这对于需要高度协同工作的分布式系统非常有用,如电商平台、在线协作工具等。
针对Redis作为任务调度使用场景,下面是一个Java Spring Boot应用的案例,其中使用Spring的@Scheduled注解与Redisson结合来实现任务调度。
场景描述
假设我们有一个自动化的营销平台,需要定期(例如每天凌晨1点)执行一些任务,比如发送时事通讯邮件给订阅用户。我们将使用Spring的定时任务功能结合Redisson来确保分布式环境下任务的准时和准确执行。
环境准备
创建Spring Boot项目
使用Spring Initializr (https://start.spring.io/) 创建一个项目,并添加所需的依赖。
配置Redis连接
在src/main/resources/application.properties中配置Redis服务器的连接信息:
spring.redis.host=localhost
spring.redis.port=6379
编写业务代码
@Service
public class ScheduledTaskService {
public void executeTask() {
// 执行任务的逻辑,例如发送邮件
System.out.println("Executing scheduled task: " + LocalDateTime.now());
}
}
创建一个配置类来配置Redisson客户端。
@Configuration
public class RedissonConfig {
@Bean(destroyMethod = "shutdown")
public RedissonClient redissonClient() {
RedissonClientConfig config = new RedissonClientConfig();
config.useSingleServer().setAddress("redis://" + spring.redis.host + ":" + spring.redis.port);
return Redisson.create(config);
}
@Value("${spring.redis.host}")
private String redisHost;
@Value("${spring.redis.port}")
private int redisPort;
}
使用Redisson的RedissonScheduledExecutorService来创建一个分布式的调度器。
@Configuration
public class ScheduledConfig {
@Bean
public RedissonScheduledExecutorService redissonScheduledExecutorService(RedissonClient redissonClient) {
return redissonClient.getExecutorService("myScheduler");
}
}
使用Spring的@Scheduled注解和Redisson的调度器来执行定时任务。
@Component
public class ScheduledTasks {
@Autowired
private ScheduledTaskService taskService;
@Autowired
private RedissonScheduledExecutorService scheduler;
@Scheduled(cron = "0 0 1 * * ?") // 每天凌晨1点执行
public void scheduledTask() {
scheduler.schedule(() -> taskService.executeTask(), 0, TimeUnit.SECONDS);
}
}
详细解释
创建任务执行服务:ScheduledTaskService服务包含实际要执行的任务逻辑。
配置Redisson:RedissonConfig配置类设置了Redisson客户端,用于后续创建分布式调度器。
创建定时任务配置:ScheduledConfig配置类创建了一个RedissonScheduledExecutorService Bean,它将被用作分布式任务调度器。
创建定时任务:ScheduledTasks组件包含一个用@Scheduled注解的方法,该方法根据指定的cron表达式触发。当触发时,它使用Redisson的调度器来安排任务的执行。
通过这种方式,我们可以利用Spring的定时任务功能和Redisson的分布式调度器来实现任务调度。这确保了即使在分布式系统中,任务也能准时和准确地执行,避免了任务执行的冲突和重复。这对于需要定时执行的任务,如发送时事通讯、数据备份、报告生成等场景非常有用。