程序包 net.sohelp.boot.demo.web.login

类 LoginPhoneController

java.lang.Object

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

net.sohelp.boot.demo.web.login.LoginPhoneController

@RestController("login-phone")
@RequestMapping("/login/phone")
public class LoginPhoneController
extends BaseController

手机短信登录控制器 提供基于手机号码的验证码发送、登录验证及密码重置功能。

从以下版本开始:

2024/10/27 11:21

作者:

AaronFung

字段概要

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

request, response

构造器概要

构造器

构造器	说明
LoginPhoneController()

方法概要

修饰符和类型	方法	说明
ApiResult<String>	getCode(String reqCode, String uuid, String code, String type)	获取并发送手机验证码接口 校验图形验证码后向指定手机号发送四位随机数字验证码，并清除图形验证码缓存。
String	getPhoneCode(String phone, String uuid, String code)	实际执行发送手机验证码逻辑的方法 包括系统配置检查、图形验证码校验、用户绑定状态判断等前置条件验证， 成功后调用通知服务发送验证码。
ApiResult<Map<String,Object>>	phoneBinding(Map<String,Object> paramMap)	使用手机号与验证码进行登录认证 验证验证码有效性后查询对应用户信息，若有效则生成访问令牌返回给客户端。
ApiResult	phoneRetrievePwd(Map<String,Object> paramMap)	手机号码找回密码接口 在满足配置要求的前提下，允许用户通过手机号+验证码方式修改其密码。

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

构造器详细资料

LoginPhoneController

public LoginPhoneController()

方法详细资料

getCode

@GetMapping("/getCode")
public ApiResult<String> getCode(@RequestParam
 String reqCode,
 @RequestParam
 String uuid,
 @RequestParam
 String code,
 @RequestParam
 String type)
                          throws Exception

获取并发送手机验证码接口 校验图形验证码后向指定手机号发送四位随机数字验证码，并清除图形验证码缓存。

参数:

reqCode - 请求中的手机号（实际参数名为 phone）

uuid - 图形验证码对应的唯一标识符

code - 用户输入的图形验证码

type - 验证类型（预留字段）

返回:

发送结果信息

抛出:

Exception - 操作过程中可能抛出异常

getPhoneCode

public String getPhoneCode(String phone,
 String uuid,
 String code)
                    throws Exception

实际执行发送手机验证码逻辑的方法 包括系统配置检查、图形验证码校验、用户绑定状态判断等前置条件验证， 成功后调用通知服务发送验证码。

参数:

phone - 目标手机号

uuid - 图形验证码的 UUID

code - 用户输入的图形验证码

返回:

发送结果描述字符串

抛出:

Exception - 可能发生的业务或运行时异常

phoneBinding

@PostMapping("/phone/login")
public ApiResult<Map<String,Object>> phoneBinding(@RequestBody
 Map<String,Object> paramMap)
                                           throws SQLException,
EntityException,
EntityValidateException,
EntityFormulaException,
EntityEventException,
DuplicateKeyException

使用手机号与验证码进行登录认证 验证验证码有效性后查询对应用户信息，若有效则生成访问令牌返回给客户端。

参数:

paramMap - 包含 phone 和 code 的请求体数据

返回:

登录成功后的 token 数据或其他失败提示

抛出:

SQLException - SQL 查询异常

EntityException - 实体操作相关异常

EntityValidateException - 实体验证异常

EntityFormulaException - 公式计算异常

EntityEventException - 事件处理异常

DuplicateKeyException - 主键冲突异常

phoneRetrievePwd

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

手机号码找回密码接口 在满足配置要求的前提下，允许用户通过手机号+验证码方式修改其密码。

参数:

paramMap - 包含 phone、code、password、confirmPassword 的请求体数据

返回:

修改密码的结果反馈

抛出:

Exception - 操作过程可能出现的各种异常