【功能优化】短信：简化短信 channel 的缓存逻辑

yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/framework/sms/core/client/SmsClientFactory.java

@@ -30,7 +30,8 @@ public interface SmsClientFactory {
      * 创建短信 Client
      *
      * @param properties 配置对象
+     * @return 短信 Client
      */
-    void createOrUpdateSmsClient(SmsChannelProperties properties);
+    SmsClient createOrUpdateSmsClient(SmsChannelProperties properties);
 
 }

yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/framework/sms/core/client/impl/SmsClientFactoryImpl.java

@@ -59,7 +59,7 @@ public class SmsClientFactoryImpl implements SmsClientFactory {
     }
 
     @Override
-    public void createOrUpdateSmsClient(SmsChannelProperties properties) {
+    public SmsClient createOrUpdateSmsClient(SmsChannelProperties properties) {
         AbstractSmsClient client = channelIdClients.get(properties.getId());
         if (client == null) {
             client = this.createSmsClient(properties);
@@ -68,6 +68,7 @@ public class SmsClientFactoryImpl implements SmsClientFactory {
         } else {
             client.refresh(properties);
         }
+        return client;
     }
 
     private AbstractSmsClient createSmsClient(SmsChannelProperties properties) {

yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/service/sms/SmsChannelServiceImpl.java

@@ -1,27 +1,21 @@
 package cn.iocoder.yudao.module.system.service.sms;
 
-import cn.hutool.core.util.StrUtil;
 import cn.iocoder.yudao.framework.common.pojo.PageResult;
 import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
-import cn.iocoder.yudao.module.system.framework.sms.core.client.SmsClient;
-import cn.iocoder.yudao.module.system.framework.sms.core.client.SmsClientFactory;
-import cn.iocoder.yudao.module.system.framework.sms.core.property.SmsChannelProperties;
 import cn.iocoder.yudao.module.system.controller.admin.sms.vo.channel.SmsChannelPageReqVO;
 import cn.iocoder.yudao.module.system.controller.admin.sms.vo.channel.SmsChannelSaveReqVO;
 import cn.iocoder.yudao.module.system.dal.dataobject.sms.SmsChannelDO;
 import cn.iocoder.yudao.module.system.dal.mysql.sms.SmsChannelMapper;
-import com.google.common.cache.CacheLoader;
+import cn.iocoder.yudao.module.system.framework.sms.core.client.SmsClient;
-import com.google.common.cache.LoadingCache;
+import cn.iocoder.yudao.module.system.framework.sms.core.client.SmsClientFactory;
-import lombok.Getter;
+import cn.iocoder.yudao.module.system.framework.sms.core.property.SmsChannelProperties;
+import jakarta.annotation.Resource;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Service;
 
-import jakarta.annotation.Resource;
-import java.time.Duration;
 import java.util.List;
 
 import static cn.iocoder.yudao.framework.common.exception.util.ServiceExceptionUtil.exception;
-import static cn.iocoder.yudao.framework.common.util.cache.CacheUtils.buildAsyncReloadingCache;
 import static cn.iocoder.yudao.module.system.enums.ErrorCodeConstants.SMS_CHANNEL_HAS_CHILDREN;
 import static cn.iocoder.yudao.module.system.enums.ErrorCodeConstants.SMS_CHANNEL_NOT_EXISTS;
 
@@ -34,46 +28,6 @@ import static cn.iocoder.yudao.module.system.enums.ErrorCodeConstants.SMS_CHANNE
 @Slf4j
 public class SmsChannelServiceImpl implements SmsChannelService {
 
-    /**
-     * {@link SmsClient} 缓存，通过它异步刷新 smsClientFactory
-     */
-    @Getter
-    private final LoadingCache<Long, SmsClient> idClientCache = buildAsyncReloadingCache(Duration.ofSeconds(10L),
-            new CacheLoader<Long, SmsClient>() {
-
-                @Override
-                public SmsClient load(Long id) {
-                    // 查询，然后尝试刷新
-                    SmsChannelDO channel = smsChannelMapper.selectById(id);
-                    if (channel != null) {
-                        SmsChannelProperties properties = BeanUtils.toBean(channel, SmsChannelProperties.class);
-                        smsClientFactory.createOrUpdateSmsClient(properties);
-                    }
-                    return smsClientFactory.getSmsClient(id);
-                }
-
-            });
-
-    /**
-     * {@link SmsClient} 缓存，通过它异步刷新 smsClientFactory
-     */
-    @Getter
-    private final LoadingCache<String, SmsClient> codeClientCache = buildAsyncReloadingCache(Duration.ofSeconds(60L),
-            new CacheLoader<String, SmsClient>() {
-
-                @Override
-                public SmsClient load(String code) {
-                    // 查询，然后尝试刷新
-                    SmsChannelDO channel = smsChannelMapper.selectByCode(code);
-                    if (channel != null) {
-                        SmsChannelProperties properties = BeanUtils.toBean(channel, SmsChannelProperties.class);
-                        smsClientFactory.createOrUpdateSmsClient(properties);
-                    }
-                    return smsClientFactory.getSmsClient(code);
-                }
-
-            });
-
     @Resource
     private SmsClientFactory smsClientFactory;
 
@@ -93,41 +47,22 @@ public class SmsChannelServiceImpl implements SmsChannelService {
     @Override
     public void updateSmsChannel(SmsChannelSaveReqVO updateReqVO) {
         // 校验存在
-        SmsChannelDO channel = validateSmsChannelExists(updateReqVO.getId());
+        validateSmsChannelExists(updateReqVO.getId());
         // 更新
         SmsChannelDO updateObj = BeanUtils.toBean(updateReqVO, SmsChannelDO.class);
         smsChannelMapper.updateById(updateObj);
-
-        // 清空缓存
-        clearCache(updateReqVO.getId(), channel.getCode());
     }
 
     @Override
     public void deleteSmsChannel(Long id) {
         // 校验存在
-        SmsChannelDO channel = validateSmsChannelExists(id);
+        validateSmsChannelExists(id);
         // 校验是否有在使用该账号的模版
         if (smsTemplateService.getSmsTemplateCountByChannelId(id) > 0) {
             throw exception(SMS_CHANNEL_HAS_CHILDREN);
         }
         // 删除
         smsChannelMapper.deleteById(id);
-
-        // 清空缓存
-        clearCache(id, channel.getCode());
-    }
-
-    /**
-     * 清空指定渠道编号的缓存
-     *
-     * @param id 渠道编号
-     * @param code 渠道编码
-     */
-    private void clearCache(Long id, String code) {
-        idClientCache.invalidate(id);
-        if (StrUtil.isNotEmpty(code)) {
-            codeClientCache.invalidate(code);
-        }
     }
 
     private SmsChannelDO validateSmsChannelExists(Long id) {
@@ -155,12 +90,14 @@ public class SmsChannelServiceImpl implements SmsChannelService {
 
     @Override
     public SmsClient getSmsClient(Long id) {
-        return idClientCache.getUnchecked(id);
+        SmsChannelDO channel = smsChannelMapper.selectById(id);
+        SmsChannelProperties properties = BeanUtils.toBean(channel, SmsChannelProperties.class);
+        return smsClientFactory.createOrUpdateSmsClient(properties);
     }
 
     @Override
     public SmsClient getSmsClient(String code) {
-        return codeClientCache.getUnchecked(code);
+        return smsClientFactory.getSmsClient(code);
     }
 
 }

yudao-module-system/yudao-module-system-biz/src/test/java/cn/iocoder/yudao/module/system/service/sms/SmsChannelServiceTest.java

@@ -57,9 +57,6 @@ public class SmsChannelServiceTest extends BaseDbUnitTest {
         // 校验记录的属性是否正确
         SmsChannelDO smsChannel = smsChannelMapper.selectById(smsChannelId);
         assertPojoEquals(reqVO, smsChannel, "id");
-        // 断言 cache
-        assertNull(smsChannelService.getIdClientCache().getIfPresent(smsChannel.getId()));
-        assertNull(smsChannelService.getCodeClientCache().getIfPresent(smsChannel.getCode()));
     }
 
     @Test
@@ -79,9 +76,6 @@ public class SmsChannelServiceTest extends BaseDbUnitTest {
         // 校验是否更新正确
         SmsChannelDO smsChannel = smsChannelMapper.selectById(reqVO.getId()); // 获取最新的
         assertPojoEquals(reqVO, smsChannel);
-        // 断言 cache
-        assertNull(smsChannelService.getIdClientCache().getIfPresent(smsChannel.getId()));
-        assertNull(smsChannelService.getCodeClientCache().getIfPresent(smsChannel.getCode()));
     }
 
     @Test
@@ -105,9 +99,6 @@ public class SmsChannelServiceTest extends BaseDbUnitTest {
         smsChannelService.deleteSmsChannel(id);
         // 校验数据不存在了
         assertNull(smsChannelMapper.selectById(id));
-        // 断言 cache
-        assertNull(smsChannelService.getIdClientCache().getIfPresent(dbSmsChannel.getId()));
-        assertNull(smsChannelService.getCodeClientCache().getIfPresent(dbSmsChannel.getCode()));
     }
 
     @Test
@@ -196,29 +187,23 @@ public class SmsChannelServiceTest extends BaseDbUnitTest {
         // mock 数据
         SmsChannelDO channel = randomPojo(SmsChannelDO.class);
         smsChannelMapper.insert(channel);
-        // mock 参数
+        // 准备参数
         Long id = channel.getId();
         // mock 方法
         SmsClient mockClient = mock(SmsClient.class);
-        when(smsClientFactory.getSmsClient(eq(id))).thenReturn(mockClient);
+        SmsChannelProperties properties = BeanUtils.toBean(channel, SmsChannelProperties.class);
+        when(smsClientFactory.createOrUpdateSmsClient(eq(properties))).thenReturn(mockClient);
 
         // 调用
         SmsClient client = smsChannelService.getSmsClient(id);
         // 断言
         assertSame(client, mockClient);
-        verify(smsClientFactory).createOrUpdateSmsClient(argThat(arg -> {
-            SmsChannelProperties properties = BeanUtils.toBean(channel, SmsChannelProperties.class);
-            return properties.equals(arg);
-        }));
     }
 
     @Test
     public void testGetSmsClient_code() {
-        // mock 数据
+        // 准备参数
-        SmsChannelDO channel = randomPojo(SmsChannelDO.class);
+        String code = randomString();
-        smsChannelMapper.insert(channel);
-        // mock 参数
-        String code = channel.getCode();
         // mock 方法
         SmsClient mockClient = mock(SmsClient.class);
         when(smsClientFactory.getSmsClient(eq(code))).thenReturn(mockClient);
@@ -227,10 +212,6 @@ public class SmsChannelServiceTest extends BaseDbUnitTest {
         SmsClient client = smsChannelService.getSmsClient(code);
         // 断言
         assertSame(client, mockClient);
-        verify(smsClientFactory).createOrUpdateSmsClient(argThat(arg -> {
-            SmsChannelProperties properties = BeanUtils.toBean(channel, SmsChannelProperties.class);
-            return properties.equals(arg);
-        }));
     }
 
 }