【Caffeine】⭐️SpringBoot 项目整合 Caffeine 实现本地缓存

目录

🍸前言

🍻一、Caffeine

🍺二、项目实践

        2.1 环境准备

        2.2 项目搭建

        2.3 接口测试

​💞️三、章末


🍸前言

        小伙伴们大家好,缓存是提升系统性能的一个不可或缺的工具,通过缓存可以避免大部分重复的请求到数据库层,减少IO链接次数,提升整体的响应速率;具体的缓存工具可以分为本地缓存和分布式缓存(比如 redis),优先使用本地缓存,因为一般情况下使用分布式缓存有点大材小用了;本地缓存中比较常见的比如 Caffeine 缓存,这篇文章将结合具体的 Springboot 项目搭配 Caffeine 实现本地缓存的各种使用方式

🍻一、Caffeine

        Caffeine 是一个现代化的 Java 缓存库,设计用于提供高性能和可伸缩性的本地缓存解决方案。适用于高并发以及快速访问数据的场景,因为内部实现了基于 ConcurrentHashMap 的数据结构,从而保证并发访问时的线程安全和高性能。

        在 Spring Framework 中,通常通过 Spring Cache 抽象来使用 Caffeine 缓存,常用的注解包括:

  • @Cacheable

    • 用于标记方法可以使用缓存。当方法被调用时,Spring 会首先检查缓存中是否存在对应的数据,如果存在则直接返回缓存中的数据,否则执行方法并将返回值存入缓存。
  • @CachePut

    • 用于更新缓存中的数据。与 @Cacheable 不同的是,@CachePut 注解的方法始终会执行,并将执行结果存入指定的缓存中,适用于更新操作后需要同步更新缓存的场景。
  • @CacheEvict

    • 用于从缓存中移除一个或多个条目。可以通过指定的 key 或条件来移除缓存中的数据,常用于执行删除操作后清除相应的缓存条目,以保证数据一致性。

🍺二、项目实践

        2.1 环境准备

        后续测试是基于一个可运行的 SpringBoot 项目,通过 ApiPost 模拟请求测试缓存接口

        2.2 项目搭建

                2.2.1 依赖引入 + 配置

                在项目的 pom.xml 文件中添加以下依赖,然后点击 Maven 刷新,Maven 会从配置的远程仓库中自动下载并导入依赖包

	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-cache</artifactId>
	</dependency>
     <dependency>
        <groupId>com.github.ben-manes.caffeine</groupId>
        <artifactId>caffeine</artifactId>
        <version>2.5.5</version>
    </dependency>

        在 .properties 配置文件中 加入以下配置,设置了缓存的类型以及自定义的缓存参数,比如过期时间

spring.cache.type=caffeine
spring.cache.caffeine.spec=initialCapacity=10,maximumSize=200,expireAfterWrite=30s

        另外不要忘了在启动类上加开启缓存的注解

                2.2.2 测试接口

                 因为 Caffeine 常用的注解有三个,所以这里三个测试接口分别测试每种注解的使用

                第一个测试接口对应的是 @Cacheable 注解的使用,value 指明缓存的名称为 data , key 利用 Spring EL 表达式与请求参数中的 "s" 相关联,方法作用就是打印当前时间

import org.springframework.cache.annotation.CacheEvict;
import org.springframework.cache.annotation.CachePut;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.time.LocalDateTime;

/**
 * @author HuangBen 
 */
@RestController
@RequestMapping("/cache")
public class CachController {

    @Cacheable(value = "data",key = "#s")
    @GetMapping("/get")
    public String getData(String s){
        LocalDateTime now = LocalDateTime.now();
        String time = now.toString();
        System.out.println("查询到数据:"+ time);
        return " 查询到数据 :" + time;

    }

    @CachePut(value = "data",key = "#s")
    @GetMapping("/put")
    public String putData(String s){
        LocalDateTime now = LocalDateTime.now();
        String time = now.toString();
        System.out.println("存储数据:"+ time);
        return " 存储数据 :" + time;

    }

    @CacheEvict(value = "data",key = "#s")
    @PostMapping("/rem")
    public String remData(String s){
        LocalDateTime now = LocalDateTime.now();
        String time = now.toString();
        System.out.println("清除数据 :"+time);
        return " 清除数据 :" + time;
    }

}
        2.3 接口测试

                2.3.1 测试 @Cacheable 注解

                通过模拟请求,可以看到成功创建缓存,并且在三十秒内重复请求的话,直接返回缓存中的数据并不会重新执行方法体,从控制台只打印了一条日志也可以体现

        

                2.3.2 测试 @CachePut 注解

                 @CachePut 注解的特性就是每次都进到方法体,然后执行结束后会进行缓存刷新,这一点可以从测试 @Cacheable 注解体现,执行完一次 cacheput 操作后,之前的接口返回的缓存也是 CachePut 接口产生的数据

                 2.3.3 测试 @CacheEvict 注解

                @CacheEvict 注解的主要作用是清除指定的缓存,通常用于删除数据的业务逻辑之后,一并清除缓存;这里可以通过控制台信息体现,先使用 Cacheput 操作产生缓存,然后调用 CacheEvict 清除缓存,再通过 Cacheable 操作查询缓存,结果显示并未查询到 CachePut 中产生的缓存数据

 

 💞️三、章末

        文章到这里就结束了~

<think>好的,我需要帮助用户解决如何将CaptchaService.java组织到他们现有的service包结构中。用户之前提到他们的service包下有impl子包和customerservice接口,impl子包中有customerserviceimpl类。现在他们想知道如何将CaptchaService.java整合进去。 首先,回顾用户之前的项目结构。service包下有一个接口CustomerService.java,以及impl子包中的CustomerServiceImpl.java。这种结构遵循接口-实现分离的模式,是Java企业开发中的常见做法。现在用户需要添加一个新的验证码服务CaptchaService,我需要考虑如何合理地组织这个新的服务。 根据用户现有的结构,CaptchaService应该作为另一个服务接口放在service包的根目录下,对应的实现类放在impl子包中,命名为CaptchaServiceImpl.java。这样保持结构的一致性,方便维护和查找。例如: src/main/java └── com.example.service ├── CustomerService.java ├── CaptchaService.java # 新增接口 └── impl ├── CustomerServiceImpl.java └── CaptchaServiceImpl.java # 新增实现类 接下来,我需要验证这种结构的合理性。用户之前的结构是每个服务接口在根目录,实现类在impl子包,所以新增的CaptchaService也应遵循同样的模式。这样其他开发人员可以轻松找到接口和实现,符合团队的现有规范。 然后,考虑是否需要将CaptchaService与其他服务进一步模块化。用户之前的结构是按功能分离,但所有服务接口都在同一个包下。如果项目规模扩大,可能需要按模块划分子包,比如将customer相关和captcha相关的服务分开。但目前用户的结构可能还比较简单,保持现有结构更合适,避免过度设计。 另外,需要指导用户如何编写CaptchaService接口及其实现类。接口应定义验证码相关的业务方法,如生成验证码、验证验证码等。实现类则具体实现这些方法,可能依赖其他组件如Redis或缓存工具,需要用Spring的注解进行依赖注入和事务管理。 还要考虑是否需要在接口命名上做出调整。用户之前的接口命名是CustomerService,没有使用前缀,但根据一些编程规范,可能推荐使用ICustomerService或者类似的方式。不过用户现有结构没有使用前缀,所以保持命名一致更好,避免混淆。 在Spring Boot中,如何注入CaptchaService呢?用户需要在Controller或其他服务中通过接口类型注入,Spring会自动找到对应的实现类。这需要确保实现类有@Service或@Component注解,并且接口和实现类在Spring的组件扫描路径下。 另外,可能需要考虑CaptchaService是否属于核心业务服务,或者是一个独立的工具类服务。如果是核心业务的一部分,按现有结构放置合适;如果是工具类,可能需要放在单独的util或helper包中。但根据服务名称判断,CaptchaService可能属于业务服务,比如用户注册或登录时的验证码处理,因此放在service包下是合理的。 用户可能还会关心如何测试CaptchaService。由于接口和实现分离,可以方便地使用Mock框架对接口进行单元测试,而无需依赖具体实现。这也符合用户之前提到的设计优势。 最后,是否需要给CaptchaService添加事务管理?如果验证码的生成和验证涉及到数据库操作,可能需要@Transactional注解。但如果是调用外部API或使用缓存,可能不需要。需要根据具体实现来决定。 总结来说,用户应该将CaptchaService.java作为接口放在service包下,CaptchaServiceImpl.java放在impl子包中,保持结构一致。同时,提供代码示例和Spring配置建议,确保用户能够正确集成和使用新的服务。</think>根据您现有的服务层结构,`CaptchaService`(验证码服务)可以按照以下两种主流方案组织。以下是详细建议和代码示例: --- ### 方案一:保持现有模式(推荐) ```bash service/ ├── CustomerService.java # 原有接口 ├── CaptchaService.java # 新增验证码接口 └── impl/ ├── CustomerServiceImpl.java └── CaptchaServiceImpl.java # 新增实现类 ``` #### 1. 接口定义(`CaptchaService.java`) ```java package com.yourcompany.service; public interface CaptchaService { /** 生成图形验证码 */ String generateImageCaptcha(String clientId); /** 校验验证码有效性 */ boolean validateCaptcha(String clientId, String userInput); /** 发送短信验证码 */ void sendSmsCaptcha(String mobile) throws RateLimitException; } ``` #### 2. 实现类(`impl/CaptchaServiceImpl.java`) ```java package com.yourcompany.service.impl; @Service public class CaptchaServiceImpl implements CaptchaService { private final RedisTemplate<String, String> redisTemplate; private final SmsSender smsSender; @Autowired public CaptchaServiceImpl(RedisTemplate<String, String> redisTemplate, SmsSender smsSender) { this.redisTemplate = redisTemplate; this.smsSender = smsSender; } @Override @Transactional // 如果需要数据库操作 public String generateImageCaptcha(String clientId) { String code = RandomStringUtils.randomNumeric(4); redisTemplate.opsForValue().set("CAPTCHA:"+clientId, code, 5, TimeUnit.MINUTES); return generateBase64Image(code); } @Override public boolean validateCaptcha(String clientId, String userInput) { String storedCode = redisTemplate.opsForValue().get("CAPTCHA:"+clientId); return StringUtils.equalsIgnoreCase(storedCode, userInput); } @Override @RateLimiter(key = "#mobile", limit = 1, period = 60) // 限流注解示例 public void sendSmsCaptcha(String mobile) { String code = RandomStringUtils.randomNumeric(6); redisTemplate.opsForValue().set("SMS_CAPTCHA:"+mobile, code, 10, TimeUnit.MINUTES); smsSender.send(mobile, "您的验证码是:" + code); } } ``` --- ### 方案二:按功能模块划分(适合大型项目) ```bash service/ ├── customer/ # 客户模块 │ ├── CustomerService.java │ └── impl/ └── auth/ # 新增认证模块 ├── CaptchaService.java └── impl/ └── CaptchaServiceImpl.java ``` #### 优势对比 | 方案 | 适用场景 | 可扩展性 | 代码隔离性 | |------------|---------------------------|----------|------------| | 集中式 | 中小型项目 | 一般 | 较低 | | 模块化 | 复杂系统/微服务 | ⭐⭐⭐⭐ | ⭐⭐⭐⭐ | --- ### 关键设计原则 1. **依赖倒置**: ```java // Controller 应依赖接口 @RestController public class LoginController { private final CaptchaService captchaService; // 接口类型 public LoginController(CaptchaService captchaService) { this.captchaService = captchaService; } } ``` 2. **多实现支持**(例如测试环境用内存实现): ```java @Profile("test") @Service public class MemoryCaptchaServiceImpl implements CaptchaService { private final Map<String, String> store = new ConcurrentHashMap<>(); @Override public String generateImageCaptcha(String clientId) { String code = "1234"; // 固定测试码 store.put(clientId, code); return generateBase64Image(code); } } ``` 3. **AOP集成示例**(如添加审计日志): ```java @Aspect @Component public class CaptchaAuditAspect { @AfterReturning( pointcut = "execution(* com.yourcompany.service.CaptchaService.sendSmsCaptcha(..))", returning = "result" ) public void logSmsSent(JoinPoint jp, Object result) { String mobile = (String) jp.getArgs()[0]; LogUtils.info("已向 {} 发送短信验证码", mobile); } } ``` --- ### 技术选型建议 1. **验证码存储**: - 简单场景:使用 `Redis`(推荐TTL自动过期) - 分布式环境:`Redis Cluster` - 无Redis时:`Caffeine` 本地缓存 2. **安全增强**: ```java // 在实现类中添加安全逻辑 public void sendSmsCaptcha(String mobile) { if (!RegexUtils.isMobileValid(mobile)) { throw new IllegalArgumentException("非法手机号格式"); } // 调用第三方前增加限流 rateLimiter.acquire(); } ``` --- ### 测试方案 ```java @SpringBootTest public class CaptchaServiceTest { @Autowired private CaptchaService captchaService; @Test void testCaptchaFlow() { String clientId = "127.0.0.1"; String code = captchaService.generateImageCaptcha(clientId); assertTrue(captchaService.validateCaptcha(clientId, code)); } @Test void testWrongCode() { String clientId = "test-client"; captchaService.generateImageCaptcha(clientId); assertFalse(captchaService.validateCaptcha(clientId, "0000")); } } ``` --- ### 最终建议 选择 **方案一** 如果: - 验证码服务与客户服务关联紧密 - 项目规模中等(<=10个Service类) 选择 **方案二** 如果: - 验证码属于独立的安全认证模块 - 已有多个关联服务(如OAuthService、SSOService) - 计划未来扩展多因素认证功能
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

先锋 Coder

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值