程序包 net.sohelp.boot.demo.web.system.config

类 SystemConfigController

java.lang.Object

net.sohelp.boot.admin.core.base.BaseController

net.sohelp.boot.demo.web.system.config.SystemConfigController

@RestController("admin-system-config")
@RequestMapping("/admin/system/config")
public class SystemConfigController
extends BaseController

系统配置控制器，用于管理系统的基本设置、登录方式配置以及消息通知等。

从以下版本开始:

2023/3/28

作者:

AaronFung

字段概要

从类继承的字段 net.sohelp.boot.admin.core.base.BaseController

request, response

构造器概要

构造器

构造器	说明
SystemConfigController()

方法概要

修饰符和类型	方法	说明
ApiResult<Map<String,Object>>	getDingding()	获取钉钉登录的配置信息
ApiResult<Map<String,Object>>	getDingdingMessage()	获取钉钉消息通知的配置信息
ApiResult<Map<String,Object>>	getLogin()	获取完整的登录配置信息（包含忘记密码、注册、Token及验证码等子模块）
ApiResult<Map<String,Object>>	getMailMessage()	获取邮件消息通知的配置信息
ApiResult<Map<String,Object>>	getParam()	获取系统基本参数配置
ApiResult<Map<String,Object>>	getPhone()	获取手机号码登录的配置信息
ApiResult<Map<String,Object>>	getQq()	获取QQ登录的配置信息
ApiResult<Map<String,Object>>	getQywx()	获取企业微信登录的相关配置信息
ApiResult<Map<String,Object>>	getQywxMessage()	获取企业微信消息通知的配置信息
Object	getSystemLogo()	获取当前系统的Logo图片资源
ApiResult<Map<String,Object>>	getWx()	获取已保存的微信登录配置信息
ApiResult<Map<String,Object>>	getWxMessage()	获取微信消息通知的配置信息
ApiResult<String>	save(Map<String,Object> paramMap)	保存系统基础设置参数
ApiResult<String>	saveDingding(Map<String,Object> paramMap)	保存钉钉登录配置信息
ApiResult<String>	saveDingdingMessage(Map<String,Object> paramMap)	保存钉钉消息通知配置信息
ApiResult<String>	saveLogin(Map<String,Object> paramMap)	保存登录相关子模块配置（包括忘记密码、注册、Token及验证码）
ApiResult<String>	saveMailMessage(Map<String,Object> paramMap)	保存邮件消息通知配置信息
ApiResult<String>	savePhone(Map<String,Object> paramMap)	保存手机号码登录配置信息
ApiResult<String>	saveQq(Map<String,Object> paramMap)	保存QQ登录配置信息
ApiResult<String>	saveQywx(Map<String,Object> paramMap)	保存企业微信登录配置，并构建其授权链接模板
ApiResult<String>	saveQywxMessage(Map<String,Object> paramMap)	保存企业微信消息通知配置信息
ApiResult<String>	saveWeixin(Map<String,Object> paramMap)	保存微信登录相关配置，并自动生成开放平台URL
ApiResult<String>	saveWxMessage(Map<String,Object> paramMap)	保存微信消息通知配置信息
ApiResult<String>	uploadLogo(String logo)	上传系统Logo图片并保存到指定目录

从类继承的方法 net.sohelp.boot.admin.core.base.BaseController

error, error, fail, fail, fail, getLoginID, getLoginName, getLoginOrgID, getLoginOrgName, getLoginUser, getNickname, getTenantId, getUserName, getUserNo, i18n, i18n, isAdministrator, isDeveloper, limit, offset, ok, ok, response, response, responseStream, success, success, success, success, validateToken

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

SystemConfigController

public SystemConfigController()

方法详细资料

uploadLogo

@PostMapping("/uploadLogo")
@OperationLog(value="\u4e0a\u4f20\u7cfb\u7edfLogo",
              important=true)
@Permission("DEVELOPER")
public ApiResult<String> uploadLogo(@RequestParam
 String logo)
                             throws SQLException

上传系统Logo图片并保存到指定目录

参数:

logo - base64编码的图片数据

返回:

操作结果信息

抛出:

SQLException - 数据库操作异常时抛出

getSystemLogo

@GetMapping("/getSystemLogo")
public Object getSystemLogo()
                     throws IOException

获取当前系统的Logo图片资源

返回:

返回null表示无内容输出（实际通过response输出流返回图片）

抛出:

IOException - IO读写异常时抛出

getParam

@GetMapping("/getParam")
@Permission("")
public ApiResult<Map<String,Object>> getParam()
                                       throws Exception

获取系统基本参数配置

返回:

包含所有基础配置项的Map对象

抛出:

Exception - 异常处理统一向上抛出

save

@PostMapping("/save")
@Transactional(rollbackFor=java.lang.Exception.class)
@OperationLog(value="\u4fdd\u5b58\u7cfb\u7edf\u57fa\u7840\u8bbe\u7f6e",
              important=true)
@Permission("DEVELOPER")
public ApiResult<String> save(@RequestBody
 Map<String,Object> paramMap)
                       throws Exception

保存系统基础设置参数

参数:

paramMap - 前端传递的基础配置参数键值对

返回:

操作结果提示信息

抛出:

Exception - 异常处理统一向上抛出

saveWeixin

@PostMapping("/saveWeixin")
@Transactional(rollbackFor=java.lang.Exception.class)
@OperationLog(value="\u4fdd\u5b58\u5fae\u4fe1\u767b\u5f55\u914d\u7f6e",
              important=true)
@Permission("DEVELOPER")
public ApiResult<String> saveWeixin(@RequestBody
 Map<String,Object> paramMap)
                             throws Exception

保存微信登录相关配置，并自动生成开放平台URL

参数:

paramMap - 微信登录所需参数（如appid、回调地址等）

返回:

操作结果提示信息

抛出:

Exception - 异常处理统一向上抛出

getWx

@GetMapping("/getWeixin")
@Permission("")
public ApiResult<Map<String,Object>> getWx()

获取已保存的微信登录配置信息

返回:

微信登录相关的配置参数

saveQywx

@PostMapping("/saveQywx")
@Transactional(rollbackFor=java.lang.Exception.class)
@OperationLog(value="\u4fdd\u5b58\u4f01\u4e1a\u5fae\u4fe1\u767b\u5f55\u914d\u7f6e",
              important=true)
@Permission("DEVELOPER")
public ApiResult<String> saveQywx(@RequestBody
 Map<String,Object> paramMap)
                           throws Exception

保存企业微信登录配置，并构建其授权链接模板

参数:

paramMap - 企业微信登录所需的参数（如appid、agentid、回调地址等）

返回:

操作结果提示信息

抛出:

Exception - 异常处理统一向上抛出

getQywx

@GetMapping("/getQywx")
@Permission("")
public ApiResult<Map<String,Object>> getQywx()

获取企业微信登录的相关配置信息

返回:

企业微信登录配置参数

saveQq

@PostMapping("/saveQq")
@Transactional(rollbackFor=java.lang.Exception.class)
@OperationLog(value="\u4fdd\u5b58QQ\u767b\u5f55\u914d\u7f6e",
              important=true)
@Permission("DEVELOPER")
public ApiResult<String> saveQq(@RequestBody
 Map<String,Object> paramMap)
                         throws Exception

保存QQ登录配置信息

参数:

paramMap - QQ登录所需的参数

返回:

操作结果提示信息

抛出:

Exception - 异常处理统一向上抛出

getQq

@GetMapping("/getQq")
@Permission("")
public ApiResult<Map<String,Object>> getQq()

获取QQ登录的配置信息

返回:

QQ登录配置参数

savePhone

@PostMapping("/savePhone")
@Transactional(rollbackFor=java.lang.Exception.class)
@OperationLog(value="\u4fdd\u5b58\u624b\u673a\u767b\u5f55\u914d\u7f6e",
              important=true)
@Permission("DEVELOPER")
public ApiResult<String> savePhone(@RequestBody
 Map<String,Object> paramMap)
                            throws Exception

保存手机号码登录配置信息

参数:

paramMap - 手机号码登录所需的参数

返回:

操作结果提示信息

抛出:

Exception - 异常处理统一向上抛出

getPhone

@GetMapping("/getPhone")
@Permission("")
public ApiResult<Map<String,Object>> getPhone()

获取手机号码登录的配置信息

返回:

手机号码登录配置参数

saveDingding

@PostMapping("/saveDingding")
@Transactional(rollbackFor=java.lang.Exception.class)
@OperationLog(value="\u4fdd\u5b58\u9489\u9489\u767b\u5f55\u914d\u7f6e",
              important=true)
@Permission("DEVELOPER")
public ApiResult<String> saveDingding(@RequestBody
 Map<String,Object> paramMap)
                               throws Exception

保存钉钉登录配置信息

参数:

paramMap - 钉钉登录所需的参数

返回:

操作结果提示信息

抛出:

Exception - 异常处理统一向上抛出

getDingding

@GetMapping("/getDingding")
@Permission("")
public ApiResult<Map<String,Object>> getDingding()

获取钉钉登录的配置信息

返回:

钉钉登录配置参数

saveWxMessage

@PostMapping("/saveWxMessage")
@Transactional(rollbackFor=java.lang.Exception.class)
@OperationLog(value="\u4fdd\u5b58\u5fae\u4fe1\u6d88\u606f\u901a\u77e5\u914d\u7f6e",
              important=true)
@Permission("DEVELOPER")
public ApiResult<String> saveWxMessage(@RequestBody
 Map<String,Object> paramMap)
                                throws Exception

保存微信消息通知配置信息

参数:

paramMap - 微信消息通知所需的参数

返回:

操作结果提示信息

抛出:

Exception - 异常处理统一向上抛出

getWxMessage

@GetMapping("/getWxMessage")
@Permission("")
public ApiResult<Map<String,Object>> getWxMessage()

获取微信消息通知的配置信息

返回:

微信消息通知配置参数

saveMailMessage

@PostMapping("/saveMailMessage")
@Transactional(rollbackFor=java.lang.Exception.class)
@OperationLog(value="\u4fdd\u5b58\u90ae\u4ef6\u6d88\u606f\u901a\u77e5\u914d\u7f6e",
              important=true)
@Permission("DEVELOPER")
public ApiResult<String> saveMailMessage(@RequestBody
 Map<String,Object> paramMap)
                                  throws Exception

保存邮件消息通知配置信息

参数:

paramMap - 邮件消息通知所需的参数

返回:

操作结果提示信息

抛出:

Exception - 异常处理统一向上抛出

getMailMessage

@GetMapping("/getMailMessage")
@Permission("")
public ApiResult<Map<String,Object>> getMailMessage()

获取邮件消息通知的配置信息

返回:

邮件消息通知配置参数

saveDingdingMessage

@PostMapping("/saveDingdingMessage")
@Transactional(rollbackFor=java.lang.Exception.class)
@OperationLog(value="\u4fdd\u5b58\u9489\u9489\u6d88\u606f\u901a\u77e5\u914d\u7f6e",
              important=true)
@Permission("DEVELOPER")
public ApiResult<String> saveDingdingMessage(@RequestBody
 Map<String,Object> paramMap)
                                      throws Exception

保存钉钉消息通知配置信息

参数:

paramMap - 钉钉消息通知所需的参数

返回:

操作结果提示信息

抛出:

Exception - 异常处理统一向上抛出

getDingdingMessage

@GetMapping("/getDingdingMessage")
@Permission("")
public ApiResult<Map<String,Object>> getDingdingMessage()

获取钉钉消息通知的配置信息

返回:

钉钉消息通知配置参数

saveQywxMessage

@PostMapping("/saveQywxMessage")
@Transactional(rollbackFor=java.lang.Exception.class)
@OperationLog(value="\u4fdd\u5b58\u4f01\u4e1a\u5fae\u4fe1\u6d88\u606f\u901a\u77e5\u914d\u7f6e",
              important=true)
@Permission("DEVELOPER")
public ApiResult<String> saveQywxMessage(@RequestBody
 Map<String,Object> paramMap)
                                  throws Exception

保存企业微信消息通知配置信息

参数:

paramMap - 企业微信消息通知所需的参数

返回:

操作结果提示信息

抛出:

Exception - 异常处理统一向上抛出

getQywxMessage

@GetMapping("/getQywxMessage")
@Permission("")
public ApiResult<Map<String,Object>> getQywxMessage()

获取企业微信消息通知的配置信息

返回:

企业微信消息通知配置参数

saveLogin

@PostMapping("/saveLogin")
@Transactional(rollbackFor=java.lang.Exception.class)
@OperationLog(value="\u4fdd\u5b58\u767b\u5f55\u914d\u7f6e",
              important=true)
@Permission("DEVELOPER")
public ApiResult<String> saveLogin(@RequestBody
 Map<String,Object> paramMap)
                            throws Exception

保存登录相关子模块配置（包括忘记密码、注册、Token及验证码）

参数:

paramMap - 登录各子模块的配置参数集合

返回:

操作结果提示信息

抛出:

Exception - 异常处理统一向上抛出

getLogin

@GetMapping("/getLogin")
@Permission("")
public ApiResult<Map<String,Object>> getLogin()

获取完整的登录配置信息（包含忘记密码、注册、Token及验证码等子模块）

返回:

各个登录子模块的配置参数组成的Map结构