refactor(controller): 将控制器响应结果统一为R类型并继承BaseController

liyong

6 天以前 9a30a3a8d3862a9b2ce898535b7cb51c3ddac816

 src/main/java/com/ruoyi/project/system/controller/SysConfigController.java

@@ -1,127 +1,129 @@
package com.ruoyi.project.system.controller;



import com.ruoyi.common.utils.poi.ExcelUtil;

import com.ruoyi.framework.aspectj.lang.annotation.Log;

import com.ruoyi.framework.aspectj.lang.enums.BusinessType;

import com.ruoyi.framework.web.controller.BaseController;

import com.ruoyi.framework.web.domain.AjaxResult;

import com.ruoyi.framework.web.page.TableDataInfo;

import com.ruoyi.project.system.domain.SysConfig;

import com.ruoyi.project.system.service.ISysConfigService;

import jakarta.servlet.http.HttpServletResponse;

import lombok.AllArgsConstructor;

import org.springframework.security.access.prepost.PreAuthorize;

import org.springframework.validation.annotation.Validated;

import org.springframework.web.bind.annotation.*;



import java.util.List;



/**

 * 参数配置 信息操作处理

 * 
 * @author ruoyi

 */

@RestController

@RequestMapping("/system/config")

@AllArgsConstructor

public class SysConfigController extends BaseController

{

    private ISysConfigService configService;



    /**

     * 获取参数配置列表

     */

    @PreAuthorize("@ss.hasPermi('system:config:list')")

    @GetMapping("/list")

    public TableDataInfo list(SysConfig config)

    {

        startPage();

        List<SysConfig> list = configService.selectConfigList(config);

        return getDataTable(list);

    }



    @Log(title = "参数管理", businessType = BusinessType.EXPORT)

    @PreAuthorize("@ss.hasPermi('system:config:export')")

    @PostMapping("/export")

    public void export(HttpServletResponse response, SysConfig config)

    {

        List<SysConfig> list = configService.selectConfigList(config);

        ExcelUtil<SysConfig> util = new ExcelUtil<SysConfig>(SysConfig.class);

        util.exportExcel(response, list, "参数数据");

    }



    /**

     * 根据参数编号获取详细信息

     */

    @PreAuthorize("@ss.hasPermi('system:config:query')")

    @GetMapping(value = "/{configId}")

    public AjaxResult getInfo(@PathVariable Long configId)

    {

        return success(configService.selectConfigById(configId));

    }



    /**

     * 根据参数键名查询参数值

     */

    @GetMapping(value = "/configKey/{configKey}")

    public AjaxResult getConfigKey(@PathVariable String configKey)

    {

        return success(configService.selectConfigByKey(configKey));

    }



    /**

     * 新增参数配置

     */

    @PreAuthorize("@ss.hasPermi('system:config:add')")

    @Log(title = "参数管理", businessType = BusinessType.INSERT)

    @PostMapping

    public AjaxResult add(@Validated @RequestBody SysConfig config)

    {

        if (!configService.checkConfigKeyUnique(config))

        {

            return error("新增参数'" + config.getConfigName() + "'失败，参数键名已存在");

        }

        config.setCreateBy(getUsername());

        return toAjax(configService.insertConfig(config));

    }



    /**

     * 修改参数配置

     */

    @PreAuthorize("@ss.hasPermi('system:config:edit')")

    @Log(title = "参数管理", businessType = BusinessType.UPDATE)

    @PutMapping

    public AjaxResult edit(@Validated @RequestBody SysConfig config)

    {

        if (!configService.checkConfigKeyUnique(config))

        {

            return error("修改参数'" + config.getConfigName() + "'失败，参数键名已存在");

        }

        config.setUpdateBy(getUsername());

        return toAjax(configService.updateConfig(config));

    }



    /**

     * 删除参数配置

     */

    @PreAuthorize("@ss.hasPermi('system:config:remove')")

    @Log(title = "参数管理", businessType = BusinessType.DELETE)

    @DeleteMapping("/{configIds}")

    public AjaxResult remove(@PathVariable Long[] configIds)

    {

        configService.deleteConfigByIds(configIds);

        return success();

    }



    /**

     * 刷新参数缓存

     */

    @PreAuthorize("@ss.hasPermi('system:config:remove')")

    @Log(title = "参数管理", businessType = BusinessType.CLEAN)

    @DeleteMapping("/refreshCache")

    public AjaxResult refreshCache()

    {

        configService.resetConfigCache();

        return success();

    }

}

package com.ruoyi.project.system.controller;

import java.util.List;

import com.ruoyi.framework.web.domain.R;
import com.ruoyi.common.utils.poi.ExcelUtil;
import com.ruoyi.framework.aspectj.lang.annotation.Log;
import com.ruoyi.framework.aspectj.lang.enums.BusinessType;
import com.ruoyi.framework.web.controller.BaseController;
import com.ruoyi.framework.web.page.TableDataInfo;
import com.ruoyi.project.system.domain.SysConfig;
import com.ruoyi.project.system.service.ISysConfigService;
import jakarta.servlet.http.HttpServletResponse;
import lombok.AllArgsConstructor;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

/**
 * 参数配置 信息操作处理
 *
 * @author ruoyi
 */
@RestController
@RequestMapping("/system/config")
@AllArgsConstructor
public class SysConfigController extends BaseController
{
    private ISysConfigService configService;

    /**
     * 获取参数配置列表
     */
    @PreAuthorize("@ss.hasPermi('system:config:list')")
    @GetMapping("/list")
    public TableDataInfo list(SysConfig config)
    {
        startPage();
        List<SysConfig> list = configService.selectConfigList(config);
        return getDataTable(list);
    }

    @Log(title = "参数管理", businessType = BusinessType.EXPORT)
    @PreAuthorize("@ss.hasPermi('system:config:export')")
    @PostMapping("/export")
    public void export(HttpServletResponse response, SysConfig config)
    {
        List<SysConfig> list = configService.selectConfigList(config);
        ExcelUtil<SysConfig> util = new ExcelUtil<SysConfig>(SysConfig.class);
        util.exportExcel(response, list, "参数数据");
    }

    /**
     * 根据参数编号获取详细信息
     */
    @PreAuthorize("@ss.hasPermi('system:config:query')")
    @GetMapping(value = "/{configId}")
    public R<?> getInfo(@PathVariable Long configId)
    {
        return R.ok(configService.selectConfigById(configId));
    }

    /**
     * 根据参数键名查询参数值
     */
    @GetMapping(value = "/configKey/{configKey}")
    public R<?> getConfigKey(@PathVariable String configKey)
    {
        return R.ok(configService.selectConfigByKey(configKey));
    }

    /**
     * 新增参数配置
     */
    @PreAuthorize("@ss.hasPermi('system:config:add')")
    @Log(title = "参数管理", businessType = BusinessType.INSERT)
    @PostMapping
    public R<?> add(@Validated @RequestBody SysConfig config)
    {
        if (!configService.checkConfigKeyUnique(config))
        {
            return R.fail("新增参数'" + config.getConfigName() + "'失败，参数键名已存在");
        }
        config.setCreateBy(getUsername());
        configService.insertConfig(config);
        return R.ok();
    }

    /**
     * 修改参数配置
     */
    @PreAuthorize("@ss.hasPermi('system:config:edit')")
    @Log(title = "参数管理", businessType = BusinessType.UPDATE)
    @PutMapping
    public R<?> edit(@Validated @RequestBody SysConfig config)
    {
        if (!configService.checkConfigKeyUnique(config))
        {
            return R.fail("修改参数'" + config.getConfigName() + "'失败，参数键名已存在");
        }
        config.setUpdateBy(getUsername());
        configService.updateConfig(config);
        return R.ok();
    }

    /**
     * 删除参数配置
     */
    @PreAuthorize("@ss.hasPermi('system:config:remove')")
    @Log(title = "参数管理", businessType = BusinessType.DELETE)
    @DeleteMapping("/{configIds}")
    public R<?> remove(@PathVariable Long[] configIds)
    {
        configService.deleteConfigByIds(configIds);
        return R.ok();
    }

    /**
     * 刷新参数缓存
     */
    @PreAuthorize("@ss.hasPermi('system:config:remove')")
    @Log(title = "参数管理", businessType = BusinessType.CLEAN)
    @DeleteMapping("/refreshCache")
    public R<?> refreshCache()
    {
        configService.resetConfigCache();
        return R.ok();
    }
}