All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.github.foxnic.web.system.controller.ConfigController Maven / Gradle / Ivy

Go to download

System Service Module Of Foxnic-Web

There is a newer version: 1.7.1.RELEASE
Show newest version
package org.github.foxnic.web.system.controller;

import com.alibaba.csp.sentinel.annotation.SentinelResource;
import com.github.foxnic.api.swagger.ApiParamSupport;
import com.github.foxnic.api.swagger.InDoc;
import com.github.foxnic.api.transter.Result;
import com.github.foxnic.commons.lang.DateUtil;
import com.github.foxnic.dao.data.PagedList;
import com.github.foxnic.dao.data.SaveMode;
import com.github.xiaoymin.knife4j.annotations.ApiOperationSupport;
import com.github.xiaoymin.knife4j.annotations.ApiSort;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.github.foxnic.web.constants.enums.SystemConfigEnum;
import org.github.foxnic.web.domain.system.Config;
import org.github.foxnic.web.domain.system.ConfigVO;
import org.github.foxnic.web.domain.system.meta.ConfigVOMeta;
import org.github.foxnic.web.framework.sentinel.SentinelExceptionUtil;
import org.github.foxnic.web.framework.web.SuperController;
import org.github.foxnic.web.proxy.system.ConfigServiceProxy;
import org.github.foxnic.web.system.service.IConfigService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.event.ApplicationStartedEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Date;
import java.util.List;

/**
 * 

 * 系统配置表 接口控制器
 * 

 * @author 李方捷 , [email protected]
 * @since 2021-12-03 09:07:26
 * @version
 */
@InDoc
@Api(tags = "系统服务/系统配置")
@ApiSort(0)
@RestController("SysConfigController")
public class ConfigController extends SuperController implements ApplicationListener  {

    @Autowired
    private IConfigService configService;

    /**
     * 添加系统配置
     */
    @ApiOperation(value = "添加系统配置")
    @ApiImplicitParams({ @ApiImplicitParam(name = ConfigVOMeta.CODE, value = "配置键", required = true, dataTypeClass = String.class, example = "eam.assetDirectUpdateMode"), @ApiImplicitParam(name = ConfigVOMeta.NAME, value = "配置名", required = false, dataTypeClass = String.class, example = "资产页面直接更新"), @ApiImplicitParam(name = ConfigVOMeta.TYPE, value = "数据类型", required = false, dataTypeClass = String.class, example = "ENUM"), @ApiImplicitParam(name = ConfigVOMeta.TYPE_DESC, value = "类型描述", required = false, dataTypeClass = String.class, example = "org.github.foxnic.web.constants.enums.system.YesNo"), @ApiImplicitParam(name = ConfigVOMeta.VALUE, value = "配置值", required = false, dataTypeClass = String.class, example = "1"), @ApiImplicitParam(name = ConfigVOMeta.VALID, value = "是否生效", required = true, dataTypeClass = Integer.class, example = "1"), @ApiImplicitParam(name = ConfigVOMeta.NOTES, value = "说明", required = false, dataTypeClass = String.class), @ApiImplicitParam(name = ConfigVOMeta.PROFILE_ID, value = "Profile", required = true, dataTypeClass = String.class, example = "default"), @ApiImplicitParam(name = ConfigVOMeta.CATALOG_CODE, value = "分类代码", required = false, dataTypeClass = String.class, example = "system"), @ApiImplicitParam(name = ConfigVOMeta.ID, value = "主键", required = true, dataTypeClass = String.class, example = "eam.assetDirectUpdateMode") })
    @ApiOperationSupport(order = 1)
    @SentinelResource(value = ConfigServiceProxy.INSERT, blockHandlerClass = { SentinelExceptionUtil.class }, blockHandler = SentinelExceptionUtil.HANDLER)
    @PostMapping(ConfigServiceProxy.INSERT)
    @ApiParamSupport(ignoreDBTreatyProperties = true, ignoreDefaultVoProperties = true, ignorePrimaryKey = true)
    public Result insert(ConfigVO configVO) {
        Result result = configService.insert(configVO, false);
        return result;
    }

    /**
     * 删除系统配置
     */
    @ApiOperation(value = "删除系统配置")
    @ApiImplicitParams({ @ApiImplicitParam(name = ConfigVOMeta.ID, value = "主键", required = true, dataTypeClass = String.class, example = "eam.assetDirectUpdateMode") })
    @ApiOperationSupport(order = 2)
    @SentinelResource(value = ConfigServiceProxy.DELETE, blockHandlerClass = { SentinelExceptionUtil.class }, blockHandler = SentinelExceptionUtil.HANDLER)
    @PostMapping(ConfigServiceProxy.DELETE)
    public Result deleteById(String id) {
        Result result = configService.deleteByIdLogical(id);
        return result;
    }

    /**
     * 批量删除系统配置 

     * 联合主键时，请自行调整实现
     */
    @ApiOperation(value = "批量删除系统配置")
    @ApiImplicitParams({ @ApiImplicitParam(name = ConfigVOMeta.IDS, value = "主键清单", required = true, dataTypeClass = List.class, example = "[1,3,4]") })
    @ApiOperationSupport(order = 3)
    @SentinelResource(value = ConfigServiceProxy.DELETE_BY_IDS, blockHandlerClass = { SentinelExceptionUtil.class }, blockHandler = SentinelExceptionUtil.HANDLER)
    @PostMapping(ConfigServiceProxy.DELETE_BY_IDS)
    public Result deleteByIds(List ids) {
        Result result = configService.deleteByIdsLogical(ids);
        return result;
    }

    /**
     * 更新系统配置
     */
    @ApiOperation(value = "更新系统配置")
    @ApiImplicitParams({ @ApiImplicitParam(name = ConfigVOMeta.CODE, value = "配置键", required = true, dataTypeClass = String.class, example = "eam.assetDirectUpdateMode"), @ApiImplicitParam(name = ConfigVOMeta.NAME, value = "配置名", required = false, dataTypeClass = String.class, example = "资产页面直接更新"), @ApiImplicitParam(name = ConfigVOMeta.TYPE, value = "数据类型", required = false, dataTypeClass = String.class, example = "ENUM"), @ApiImplicitParam(name = ConfigVOMeta.TYPE_DESC, value = "类型描述", required = false, dataTypeClass = String.class, example = "org.github.foxnic.web.constants.enums.system.YesNo"), @ApiImplicitParam(name = ConfigVOMeta.VALUE, value = "配置值", required = false, dataTypeClass = String.class, example = "1"), @ApiImplicitParam(name = ConfigVOMeta.VALID, value = "是否生效", required = true, dataTypeClass = Integer.class, example = "1"), @ApiImplicitParam(name = ConfigVOMeta.NOTES, value = "说明", required = false, dataTypeClass = String.class), @ApiImplicitParam(name = ConfigVOMeta.PROFILE_ID, value = "Profile", required = true, dataTypeClass = String.class, example = "default"), @ApiImplicitParam(name = ConfigVOMeta.CATALOG_CODE, value = "分类代码", required = false, dataTypeClass = String.class, example = "system"), @ApiImplicitParam(name = ConfigVOMeta.ID, value = "主键", required = true, dataTypeClass = String.class, example = "eam.assetDirectUpdateMode") })
    @ApiOperationSupport(order = 4, ignoreParameters = { ConfigVOMeta.PAGE_INDEX, ConfigVOMeta.PAGE_SIZE, ConfigVOMeta.SEARCH_FIELD, ConfigVOMeta.FUZZY_FIELD, ConfigVOMeta.SEARCH_VALUE, ConfigVOMeta.DIRTY_FIELDS, ConfigVOMeta.SORT_FIELD, ConfigVOMeta.SORT_TYPE, ConfigVOMeta.IDS })
    @SentinelResource(value = ConfigServiceProxy.UPDATE, blockHandlerClass = { SentinelExceptionUtil.class }, blockHandler = SentinelExceptionUtil.HANDLER)
    @PostMapping(ConfigServiceProxy.UPDATE)
    @ApiParamSupport(ignoreDBTreatyProperties = true, ignoreDefaultVoProperties = true)
    public Result update(ConfigVO configVO) {
        Result result = configService.update(configVO, SaveMode.DIRTY_OR_NOT_NULL_FIELDS, false);
        return result;
    }

    /**
     * 保存系统配置
     */
    @ApiOperation(value = "保存系统配置")
    @ApiImplicitParams({ @ApiImplicitParam(name = ConfigVOMeta.CODE, value = "配置键", required = true, dataTypeClass = String.class, example = "eam.assetDirectUpdateMode"), @ApiImplicitParam(name = ConfigVOMeta.NAME, value = "配置名", required = false, dataTypeClass = String.class, example = "资产页面直接更新"), @ApiImplicitParam(name = ConfigVOMeta.TYPE, value = "数据类型", required = false, dataTypeClass = String.class, example = "ENUM"), @ApiImplicitParam(name = ConfigVOMeta.TYPE_DESC, value = "类型描述", required = false, dataTypeClass = String.class, example = "org.github.foxnic.web.constants.enums.system.YesNo"), @ApiImplicitParam(name = ConfigVOMeta.VALUE, value = "配置值", required = false, dataTypeClass = String.class, example = "1"), @ApiImplicitParam(name = ConfigVOMeta.VALID, value = "是否生效", required = true, dataTypeClass = Integer.class, example = "1"), @ApiImplicitParam(name = ConfigVOMeta.NOTES, value = "说明", required = false, dataTypeClass = String.class), @ApiImplicitParam(name = ConfigVOMeta.PROFILE_ID, value = "Profile", required = true, dataTypeClass = String.class, example = "default"), @ApiImplicitParam(name = ConfigVOMeta.CATALOG_CODE, value = "分类代码", required = false, dataTypeClass = String.class, example = "system"), @ApiImplicitParam(name = ConfigVOMeta.ID, value = "主键", required = true, dataTypeClass = String.class, example = "eam.assetDirectUpdateMode") })
    @ApiOperationSupport(order = 5, ignoreParameters = { ConfigVOMeta.PAGE_INDEX, ConfigVOMeta.PAGE_SIZE, ConfigVOMeta.SEARCH_FIELD, ConfigVOMeta.FUZZY_FIELD, ConfigVOMeta.SEARCH_VALUE, ConfigVOMeta.DIRTY_FIELDS, ConfigVOMeta.SORT_FIELD, ConfigVOMeta.SORT_TYPE, ConfigVOMeta.IDS })
    @SentinelResource(value = ConfigServiceProxy.SAVE, blockHandlerClass = { SentinelExceptionUtil.class }, blockHandler = SentinelExceptionUtil.HANDLER)
    @PostMapping(ConfigServiceProxy.SAVE)
    @ApiParamSupport(ignoreDBTreatyProperties = true, ignoreDefaultVoProperties = true)
    public Result save(ConfigVO configVO) {
        Result result = configService.save(configVO, SaveMode.DIRTY_OR_NOT_NULL_FIELDS, false);
        return result;
    }

    /**
     * 获取系统配置
     */
    @ApiOperation(value = "获取系统配置")
    @ApiImplicitParams({ @ApiImplicitParam(name = ConfigVOMeta.ID, value = "主键", required = true, dataTypeClass = String.class, example = "1") })
    @ApiOperationSupport(order = 6)
    @SentinelResource(value = ConfigServiceProxy.GET_BY_ID, blockHandlerClass = { SentinelExceptionUtil.class }, blockHandler = SentinelExceptionUtil.HANDLER)
    @PostMapping(ConfigServiceProxy.GET_BY_ID)
    public Result getById(String id) {
        Result result = new Result<>();
        Config config = configService.getById(id);
        result.success(true).data(config);
        return result;
    }

    /**
     * 获取系统配置
     */
    @ApiOperation(value = "获取系统配置")
    @ApiImplicitParams({ @ApiImplicitParam(name = ConfigVOMeta.CODE, value = "代码", required = true, dataTypeClass = String.class, example = "1") })
    @ApiOperationSupport(order = 6)
    @SentinelResource(value = ConfigServiceProxy.GET_BY_CODE, blockHandlerClass = { SentinelExceptionUtil.class }, blockHandler = SentinelExceptionUtil.HANDLER)
    @PostMapping(ConfigServiceProxy.GET_BY_CODE)
    public Result getByCode(String code) {
        Result result = new Result<>();
        Config config = configService.getByCode(code);
        result.success(true).data(config);
        return result;
    }

    /**
     * 获取系统配置
     */
    @ApiOperation(value = "获取系统配置")
    @ApiImplicitParams({ @ApiImplicitParam(name = "codes", value = "代码", required = true, dataTypeClass = String.class, example = "1") })
    @ApiOperationSupport(order = 6)
    @SentinelResource(value = ConfigServiceProxy.GET_BY_CODES, blockHandlerClass = { SentinelExceptionUtil.class }, blockHandler = SentinelExceptionUtil.HANDLER)
    @PostMapping(ConfigServiceProxy.GET_BY_CODES)
    public Result> getByCodes(List codes) {
        Result> result = new Result<>();
        List configs = configService.getByCodes(codes);
        result.success(true).data(configs);
        return result;
    }

    /**
     * 批量获取系统配置 

     * 联合主键时，请自行调整实现
     */
    @ApiOperation(value = "批量获取系统配置")
    @ApiImplicitParams({ @ApiImplicitParam(name = ConfigVOMeta.IDS, value = "主键清单", required = true, dataTypeClass = List.class, example = "[1,3,4]") })
    @ApiOperationSupport(order = 3)
    @SentinelResource(value = ConfigServiceProxy.GET_BY_IDS, blockHandlerClass = { SentinelExceptionUtil.class }, blockHandler = SentinelExceptionUtil.HANDLER)
    @PostMapping(ConfigServiceProxy.GET_BY_IDS)
    public Result> getByIds(List ids) {
        Result> result = new Result<>();
        List list = configService.getByIds(ids);
        result.success(true).data(list);
        return result;
    }

    /**
     * 查询系统配置
     */
    @ApiOperation(value = "查询系统配置")
    @ApiImplicitParams({ @ApiImplicitParam(name = ConfigVOMeta.CODE, value = "配置键", required = true, dataTypeClass = String.class, example = "eam.assetDirectUpdateMode"), @ApiImplicitParam(name = ConfigVOMeta.NAME, value = "配置名", required = false, dataTypeClass = String.class, example = "资产页面直接更新"), @ApiImplicitParam(name = ConfigVOMeta.TYPE, value = "数据类型", required = false, dataTypeClass = String.class, example = "ENUM"), @ApiImplicitParam(name = ConfigVOMeta.TYPE_DESC, value = "类型描述", required = false, dataTypeClass = String.class, example = "org.github.foxnic.web.constants.enums.system.YesNo"), @ApiImplicitParam(name = ConfigVOMeta.VALUE, value = "配置值", required = false, dataTypeClass = String.class, example = "1"), @ApiImplicitParam(name = ConfigVOMeta.VALID, value = "是否生效", required = true, dataTypeClass = Integer.class, example = "1"), @ApiImplicitParam(name = ConfigVOMeta.NOTES, value = "说明", required = false, dataTypeClass = String.class), @ApiImplicitParam(name = ConfigVOMeta.PROFILE_ID, value = "Profile", required = true, dataTypeClass = String.class, example = "default"), @ApiImplicitParam(name = ConfigVOMeta.CATALOG_CODE, value = "分类代码", required = false, dataTypeClass = String.class, example = "system"), @ApiImplicitParam(name = ConfigVOMeta.ID, value = "主键", required = true, dataTypeClass = String.class, example = "eam.assetDirectUpdateMode") })
    @ApiOperationSupport(order = 5, ignoreParameters = { ConfigVOMeta.PAGE_INDEX, ConfigVOMeta.PAGE_SIZE })
    @SentinelResource(value = ConfigServiceProxy.QUERY_LIST, blockHandlerClass = { SentinelExceptionUtil.class }, blockHandler = SentinelExceptionUtil.HANDLER)
    @PostMapping(ConfigServiceProxy.QUERY_LIST)
    public Result> queryList(ConfigVO sample) {
        Result> result = new Result<>();
        List list = configService.queryList(sample);
        result.success(true).data(list);
        return result;
    }

    /**
     * 分页查询系统配置
     */
    @ApiOperation(value = "分页查询系统配置")
    @ApiImplicitParams({ @ApiImplicitParam(name = ConfigVOMeta.CODE, value = "配置键", required = true, dataTypeClass = String.class, example = "eam.assetDirectUpdateMode"), @ApiImplicitParam(name = ConfigVOMeta.NAME, value = "配置名", required = false, dataTypeClass = String.class, example = "资产页面直接更新"), @ApiImplicitParam(name = ConfigVOMeta.TYPE, value = "数据类型", required = false, dataTypeClass = String.class, example = "ENUM"), @ApiImplicitParam(name = ConfigVOMeta.TYPE_DESC, value = "类型描述", required = false, dataTypeClass = String.class, example = "org.github.foxnic.web.constants.enums.system.YesNo"), @ApiImplicitParam(name = ConfigVOMeta.VALUE, value = "配置值", required = false, dataTypeClass = String.class, example = "1"), @ApiImplicitParam(name = ConfigVOMeta.VALID, value = "是否生效", required = true, dataTypeClass = Integer.class, example = "1"), @ApiImplicitParam(name = ConfigVOMeta.NOTES, value = "说明", required = false, dataTypeClass = String.class), @ApiImplicitParam(name = ConfigVOMeta.PROFILE_ID, value = "Profile", required = true, dataTypeClass = String.class, example = "default"), @ApiImplicitParam(name = ConfigVOMeta.CATALOG_CODE, value = "分类代码", required = false, dataTypeClass = String.class, example = "system"), @ApiImplicitParam(name = ConfigVOMeta.ID, value = "主键", required = true, dataTypeClass = String.class, example = "eam.assetDirectUpdateMode") })
    @ApiOperationSupport(order = 8)
    @SentinelResource(value = ConfigServiceProxy.QUERY_PAGED_LIST, blockHandlerClass = { SentinelExceptionUtil.class }, blockHandler = SentinelExceptionUtil.HANDLER)
    @PostMapping(ConfigServiceProxy.QUERY_PAGED_LIST)
    public Result> queryPagedList(ConfigVO sample) {
        Result> result = new Result<>();
        PagedList list = configService.queryPagedList(sample, sample.getPageSize(), sample.getPageIndex());
        result.success(true).data(list);
        return result;
    }

    @Override
    public void onApplicationEvent(ApplicationStartedEvent event) {
        Config sample=new Config();
        sample.setCode(SystemConfigEnum.SYSTEM_CACHEKEY.code());
       List list=configService.queryList(sample);
       String cacheKey= DateUtil.format(new Date(),"yyyyMMddHHmmss");
        for (Config config : list) {
            config.setValue(cacheKey);
        }
        configService.updateList(list,SaveMode.DIRTY_FIELDS);
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy