net.sohelp.boot.dev.web.login

类 LoginController

java.lang.Object

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

net.sohelp.boot.dev.web.login.LoginController

@RestController(value="dev-core-login")
 @RequestMapping(value="/dev/login")
public class LoginController
extends BaseController

用户登录Controller

字段概要

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

request, response

构造器概要

构造器

构造器和说明
LoginController()

方法概要

限定符和类型	方法和说明
ApiResult<Map<String,Object>>	captcha() 获取验证码接口 该接口用于生成并返回验证码相关信息
ApiResult<String>	changeLanguage(String language) 修改系统语言 根据传入的language参数修改系统的语言环境，支持英文、繁体中文和简体中文。
ApiResult<Map<String,Object>>	getLoginConfig() 获取登录配置接口 该接口用于获取系统登录相关的配置信息，包括用户个性化语言配置、系统基础配置和安全配置。
ApiResult<Map<String,Object>>	login(Map<String,Object> paramMap) 用户登录接口 该接口用于处理用户的登录请求，包括验证用户名、密码、验证码，以及根据用户角色生成对应的token。
ApiResult<String>	logout() 用户退出登录接口 该接口用于处理用户的退出登录请求，执行退出登录逻辑并返回结果

从类继承的方法 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, success, success, success, success, validateToken

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

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

构造器详细资料

LoginController

public LoginController()

方法详细资料

logout

@PostMapping(value="/logout")
 @OperationLog(value="\u9000\u51fa\u767b\u5f55")
public ApiResult<String> logout()
                                                                                                          throws Exception

用户退出登录接口 该接口用于处理用户的退出登录请求，执行退出登录逻辑并返回结果

返回:

返回注销成功的ApiResult对象

抛出:

Exception - 如果注销过程中发生异常，则抛出Exception异常

login

@PostMapping(value="/login")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<Map<String,Object>> login(@RequestBody
                                                                                                                                 Map<String,Object> paramMap)
                                                                                                                          throws Exception

用户登录接口 该接口用于处理用户的登录请求，包括验证用户名、密码、验证码，以及根据用户角色生成对应的token。

参数:

paramMap - 请求参数，包含用户名、密码、验证码等 - username: 用户名（必填） - password: 密码（必填） - code: 验证码（可选，根据系统配置决定是否需要）

返回:

返回登录结果，包含access_token等信息的ApiResult对象

抛出:

Exception - 如果登录过程中发生任何异常，将抛出Exception异常

captcha

@GetMapping(value="/captcha")
public ApiResult<Map<String,Object>> captcha()

获取验证码接口 该接口用于生成并返回验证码相关信息

返回:

ApiResult> 包含验证码相关信息的ApiResult对象

getLoginConfig

@GetMapping(value="/getLoginConfig")
public ApiResult<Map<String,Object>> getLoginConfig()

获取登录配置接口 该接口用于获取系统登录相关的配置信息，包括用户个性化语言配置、系统基础配置和安全配置。

返回:

返回包含登录配置信息的ApiResult对象

changeLanguage

@PostMapping(value="/changeLanguage")
public ApiResult<String> changeLanguage(@RequestParam
                                                                               String language)

修改系统语言 根据传入的language参数修改系统的语言环境，支持英文、繁体中文和简体中文。

参数:

language - 语言类型，可选值为"en"、"en_US"（均代表英文），"zh_TW"（代表繁体中文），其他值默认代表简体中文

返回:

返回操作结果的API结果对象，包含操作成功的信息