refactor 重构 common, framework 包结构, 参照 cloud 版本拆分子模块 ; update 更新模块包名 ; delet...

zlyx

2023-01-18 71a2a8245db4c04be3f96a9eb9b47931d3130650

 ruoyi-system/src/main/java/com/ruoyi/system/service/impl/SysConfigServiceImpl.java

@@ -1,226 +1,227 @@
package com.ruoyi.system.service.impl;



import com.ruoyi.common.annotation.DataSource;

import com.ruoyi.common.constant.Constants;

import com.ruoyi.common.constant.UserConstants;

import com.ruoyi.common.core.redis.RedisCache;

import com.ruoyi.common.core.text.Convert;

import com.ruoyi.common.enums.DataSourceType;

import com.ruoyi.common.exception.ServiceException;

import com.ruoyi.common.utils.StringUtils;

import com.ruoyi.system.domain.SysConfig;

import com.ruoyi.system.mapper.SysConfigMapper;

import com.ruoyi.system.service.ISysConfigService;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.stereotype.Service;

import javax.annotation.PostConstruct;

import java.util.Collection;

import java.util.List;



/**

 * 参数配置 服务层实现

 * 
 * @author ruoyi

 */

@Service

public class SysConfigServiceImpl implements ISysConfigService

{

    @Autowired

    private SysConfigMapper configMapper;



    @Autowired

    private RedisCache redisCache;



    /**

     * 项目启动时，初始化参数到缓存

     */

    @PostConstruct

    public void init()

    {

        loadingConfigCache();

    }



    /**

     * 查询参数配置信息

     * 
     * @param configId 参数配置ID

     * @return 参数配置信息

     */

    @Override

    @DataSource(DataSourceType.MASTER)

    public SysConfig selectConfigById(Long configId)

    {

        SysConfig config = new SysConfig();

        config.setConfigId(configId);

        return configMapper.selectConfig(config);

    }



    /**

     * 根据键名查询参数配置信息

     * 
     * @param configKey 参数key

     * @return 参数键值

     */

    @Override

    public String selectConfigByKey(String configKey)

    {

        String configValue = Convert.toStr(redisCache.getCacheObject(getCacheKey(configKey)));

        if (StringUtils.isNotEmpty(configValue))

        {

            return configValue;

        }

        SysConfig config = new SysConfig();

        config.setConfigKey(configKey);

        SysConfig retConfig = configMapper.selectConfig(config);

        if (StringUtils.isNotNull(retConfig))

        {

            redisCache.setCacheObject(getCacheKey(configKey), retConfig.getConfigValue());

            return retConfig.getConfigValue();

        }

        return StringUtils.EMPTY;

    }



    /**

     * 获取验证码开关

     * 
     * @return true开启，false关闭

     */

    @Override

    public boolean selectCaptchaOnOff()

    {

        String captchaOnOff = selectConfigByKey("sys.account.captchaOnOff");

        if (StringUtils.isEmpty(captchaOnOff))

        {

            return true;

        }

        return Convert.toBool(captchaOnOff);

    }



    /**

     * 查询参数配置列表

     * 
     * @param config 参数配置信息

     * @return 参数配置集合

     */

    @Override

    public List<SysConfig> selectConfigList(SysConfig config)

    {

        return configMapper.selectConfigList(config);

    }



    /**

     * 新增参数配置

     * 
     * @param config 参数配置信息

     * @return 结果

     */

    @Override

    public int insertConfig(SysConfig config)

    {

        int row = configMapper.insertConfig(config);

        if (row > 0)

        {

            redisCache.setCacheObject(getCacheKey(config.getConfigKey()), config.getConfigValue());

        }

        return row;

    }



    /**

     * 修改参数配置

     * 
     * @param config 参数配置信息

     * @return 结果

     */

    @Override

    public int updateConfig(SysConfig config)

    {

        int row = configMapper.updateConfig(config);

        if (row > 0)

        {

            redisCache.setCacheObject(getCacheKey(config.getConfigKey()), config.getConfigValue());

        }

        return row;

    }



    /**

     * 批量删除参数信息

     * 
     * @param configIds 需要删除的参数ID

     */

    @Override

    public void deleteConfigByIds(Long[] configIds)

    {

        for (Long configId : configIds)

        {

            SysConfig config = selectConfigById(configId);

            if (StringUtils.equals(UserConstants.YES, config.getConfigType()))

            {

                throw new ServiceException(String.format("内置参数【%1$s】不能删除 ", config.getConfigKey()));

            }

            configMapper.deleteConfigById(configId);

            redisCache.deleteObject(getCacheKey(config.getConfigKey()));

        }

    }



    /**

     * 加载参数缓存数据

     */

    @Override

    public void loadingConfigCache()

    {

        List<SysConfig> configsList = configMapper.selectConfigList(new SysConfig());

        for (SysConfig config : configsList)

        {

            redisCache.setCacheObject(getCacheKey(config.getConfigKey()), config.getConfigValue());

        }

    }



    /**

     * 清空参数缓存数据

     */

    @Override

    public void clearConfigCache()

    {

        Collection<String> keys = redisCache.keys(Constants.SYS_CONFIG_KEY + "*");

        redisCache.deleteObject(keys);

    }



    /**

     * 重置参数缓存数据

     */

    @Override

    public void resetConfigCache()

    {

        clearConfigCache();

        loadingConfigCache();

    }



    /**

     * 校验参数键名是否唯一

     * 
     * @param config 参数配置信息

     * @return 结果

     */

    @Override

    public String checkConfigKeyUnique(SysConfig config)

    {

        Long configId = StringUtils.isNull(config.getConfigId()) ? -1L : config.getConfigId();

        SysConfig info = configMapper.checkConfigKeyUnique(config.getConfigKey());

        if (StringUtils.isNotNull(info) && info.getConfigId().longValue() != configId.longValue())

        {

            return UserConstants.NOT_UNIQUE;

        }

        return UserConstants.UNIQUE;

    }



    /**

     * 设置cache key

     * 
     * @param configKey 参数键

     * @return 缓存键key

     */

    private String getCacheKey(String configKey)

    {

        return Constants.SYS_CONFIG_KEY + configKey;

    }

}

package com.ruoyi.system.service.impl;

import cn.hutool.core.convert.Convert;
import cn.hutool.core.util.ObjectUtil;
import com.baomidou.dynamic.datasource.annotation.DS;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.ruoyi.common.core.constant.CacheNames;
import com.ruoyi.common.core.constant.UserConstants;
import com.ruoyi.common.mybatis.core.page.PageQuery;
import com.ruoyi.common.mybatis.core.page.TableDataInfo;
import com.ruoyi.common.core.service.ConfigService;
import com.ruoyi.common.core.exception.ServiceException;
import com.ruoyi.common.core.utils.StringUtils;
import com.ruoyi.common.redis.utils.CacheUtils;
import com.ruoyi.common.core.utils.SpringUtils;
import com.ruoyi.system.domain.SysConfig;
import com.ruoyi.system.mapper.SysConfigMapper;
import com.ruoyi.system.service.ISysConfigService;
import lombok.RequiredArgsConstructor;
import org.springframework.cache.annotation.CachePut;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;

import java.util.Arrays;
import java.util.List;
import java.util.Map;

/**
 * 参数配置 服务层实现
 *
 * @author Lion Li
 */
@RequiredArgsConstructor
@Service
public class SysConfigServiceImpl implements ISysConfigService, ConfigService {

    private final SysConfigMapper baseMapper;

    @Override
    public TableDataInfo<SysConfig> selectPageConfigList(SysConfig config, PageQuery pageQuery) {
        Map<String, Object> params = config.getParams();
        LambdaQueryWrapper<SysConfig> lqw = new LambdaQueryWrapper<SysConfig>()
            .like(StringUtils.isNotBlank(config.getConfigName()), SysConfig::getConfigName, config.getConfigName())
            .eq(StringUtils.isNotBlank(config.getConfigType()), SysConfig::getConfigType, config.getConfigType())
            .like(StringUtils.isNotBlank(config.getConfigKey()), SysConfig::getConfigKey, config.getConfigKey())
            .between(params.get("beginTime") != null && params.get("endTime") != null,
                SysConfig::getCreateTime, params.get("beginTime"), params.get("endTime"));
        Page<SysConfig> page = baseMapper.selectPage(pageQuery.build(), lqw);
        return TableDataInfo.build(page);
    }

    /**
     * 查询参数配置信息
     *
     * @param configId 参数配置ID
     * @return 参数配置信息
     */
    @Override
    @DS("master")
    public SysConfig selectConfigById(Long configId) {
        return baseMapper.selectById(configId);
    }

    /**
     * 根据键名查询参数配置信息
     *
     * @param configKey 参数key
     * @return 参数键值
     */
    @Cacheable(cacheNames = CacheNames.SYS_CONFIG, key = "#configKey")
    @Override
    public String selectConfigByKey(String configKey) {
        SysConfig retConfig = baseMapper.selectOne(new LambdaQueryWrapper<SysConfig>()
            .eq(SysConfig::getConfigKey, configKey));
        if (ObjectUtil.isNotNull(retConfig)) {
            return retConfig.getConfigValue();
        }
        return StringUtils.EMPTY;
    }

    /**
     * 获取验证码开关
     *
     * @return true开启，false关闭
     */
    @Override
    public boolean selectCaptchaEnabled() {
        String captchaEnabled = SpringUtils.getAopProxy(this).selectConfigByKey("sys.account.captchaEnabled");
        if (StringUtils.isEmpty(captchaEnabled)) {
            return true;
        }
        return Convert.toBool(captchaEnabled);
    }

    /**
     * 查询参数配置列表
     *
     * @param config 参数配置信息
     * @return 参数配置集合
     */
    @Override
    public List<SysConfig> selectConfigList(SysConfig config) {
        Map<String, Object> params = config.getParams();
        LambdaQueryWrapper<SysConfig> lqw = new LambdaQueryWrapper<SysConfig>()
            .like(StringUtils.isNotBlank(config.getConfigName()), SysConfig::getConfigName, config.getConfigName())
            .eq(StringUtils.isNotBlank(config.getConfigType()), SysConfig::getConfigType, config.getConfigType())
            .like(StringUtils.isNotBlank(config.getConfigKey()), SysConfig::getConfigKey, config.getConfigKey())
            .between(params.get("beginTime") != null && params.get("endTime") != null,
                SysConfig::getCreateTime, params.get("beginTime"), params.get("endTime"));
        return baseMapper.selectList(lqw);
    }

    /**
     * 新增参数配置
     *
     * @param config 参数配置信息
     * @return 结果
     */
    @CachePut(cacheNames = CacheNames.SYS_CONFIG, key = "#config.configKey")
    @Override
    public String insertConfig(SysConfig config) {
        int row = baseMapper.insert(config);
        if (row > 0) {
            return config.getConfigValue();
        }
        throw new ServiceException("操作失败");
    }

    /**
     * 修改参数配置
     *
     * @param config 参数配置信息
     * @return 结果
     */
    @CachePut(cacheNames = CacheNames.SYS_CONFIG, key = "#config.configKey")
    @Override
    public String updateConfig(SysConfig config) {
        int row = 0;
        if (config.getConfigId() != null) {
            SysConfig temp = baseMapper.selectById(config.getConfigId());
            if (!StringUtils.equals(temp.getConfigKey(), config.getConfigKey())) {
                CacheUtils.evict(CacheNames.SYS_CONFIG, temp.getConfigKey());
            }
            row = baseMapper.updateById(config);
        } else {
            row = baseMapper.update(config, new LambdaQueryWrapper<SysConfig>()
                .eq(SysConfig::getConfigKey, config.getConfigKey()));
        }
        if (row > 0) {
            return config.getConfigValue();
        }
        throw new ServiceException("操作失败");
    }

    /**
     * 批量删除参数信息
     *
     * @param configIds 需要删除的参数ID
     */
    @Override
    public void deleteConfigByIds(Long[] configIds) {
        for (Long configId : configIds) {
            SysConfig config = selectConfigById(configId);
            if (StringUtils.equals(UserConstants.YES, config.getConfigType())) {
                throw new ServiceException(String.format("内置参数【%1$s】不能删除 ", config.getConfigKey()));
            }
            CacheUtils.evict(CacheNames.SYS_CONFIG, config.getConfigKey());
        }
        baseMapper.deleteBatchIds(Arrays.asList(configIds));
    }

    /**
     * 加载参数缓存数据
     */
    @Override
    public void loadingConfigCache() {
        List<SysConfig> configsList = selectConfigList(new SysConfig());
        configsList.forEach(config ->
            CacheUtils.put(CacheNames.SYS_CONFIG, config.getConfigKey(), config.getConfigValue()));
    }

    /**
     * 清空参数缓存数据
     */
    @Override
    public void clearConfigCache() {
        CacheUtils.clear(CacheNames.SYS_CONFIG);
    }

    /**
     * 重置参数缓存数据
     */
    @Override
    public void resetConfigCache() {
        clearConfigCache();
        loadingConfigCache();
    }

    /**
     * 校验参数键名是否唯一
     *
     * @param config 参数配置信息
     * @return 结果
     */
    @Override
    public String checkConfigKeyUnique(SysConfig config) {
        Long configId = ObjectUtil.isNull(config.getConfigId()) ? -1L : config.getConfigId();
        SysConfig info = baseMapper.selectOne(new LambdaQueryWrapper<SysConfig>().eq(SysConfig::getConfigKey, config.getConfigKey()));
        if (ObjectUtil.isNotNull(info) && info.getConfigId().longValue() != configId.longValue()) {
            return UserConstants.NOT_UNIQUE;
        }
        return UserConstants.UNIQUE;
    }

    /**
     * 根据参数 key 获取参数值
     *
     * @param configKey 参数 key
     * @return 参数值
     */
    @Override
    public String getConfigValue(String configKey) {
        return SpringUtils.getAopProxy(this).selectConfigByKey(configKey);
    }

}