econets-vue开发指南 econets-vue开发指南
首页
  • 萌新必读
  • 后端手册
  • 中间件手册
  • 工作流手册
  • 工作流手册
  • 大屏手册
  • 支付手册
  • 会员手册
  • 商城手册
  • 公众号手册
  • CRM手册
  • 运维手册
GitHub (opens new window)
首页
  • 萌新必读
  • 后端手册
  • 中间件手册
  • 工作流手册
  • 工作流手册
  • 大屏手册
  • 支付手册
  • 会员手册
  • 商城手册
  • 公众号手册
  • CRM手册
  • 运维手册
GitHub (opens new window)
  • 萌新必读

    • 简介
    • 功能列表
    • 快速启动(后端项目)
    • 快速启动(前端项目)
    • 技术选型
    • 项目结构
    • 代码热加载
    • 一键改包
    • 删除功能
    • 内网穿透
  • 后端手册

    • 新建服务
    • 代码生成【单表】(新增功能)
    • 代码生成【主子表】
    • 代码生成(树表)
    • 功能权限
    • 数据权限
    • 用户体系
      • 1. 表结构
      • 2. 如何获取当前登录的用户?
      • 3. 账号密码登录
        • 3.1 管理后台的实现
        • 3.2 用户 App 的实现
      • 4. 手机验证码登录
        • 4.1 管理后台的实现
        • 4.2 用户 App 的实现
      • 5. 三方登录
        • 5.1 管理后台的实现
        • 5.2 用户 App 的实现
      • 6. 注册
        • 6.1 管理后台的实现
        • 6.2 用户 App 的实现
      • 7. 用户登出
    • 三方登录
    • OAuth 2.0(SSO 单点登录)
    • SaaS 多租户【字段隔离】
    • SaaS 多租户【数据库隔离】
    • WebSocket 实时通信
    • 13异常处理(错误码)
    • 参数校验
    • 分页实现
    • 文件存储(上传下载)
    • Excel 导入导出
    • 系统日志
    • MyBatis 数据库
    • MyBatis 联表&分页查询
    • 多数据源(读写分离)
    • Redis 缓存
    • 本地缓存
    • 异步任务
    • 配置管理
    • 工具类 Util
    • 单元测试
    • 分布式锁
    • 幂等性(防重复提交)
    • 数据库文档
    • 验证码
  • 中间件手册

    • 定时任务
    • 消息队列(内存)
    • 消息队列(Redis)
    • 消息队列(RocketMQ)
    • 消息队列(RabbitMQ)
    • 消息队列(Kafka)
    • 限流熔断
  • 工作流手册

    • 工作流(Flowable)会签、或签
  • 指南
  • 后端手册
EcoNets Tech
2024-01-13
目录

用户体系

系统提供了 2 种类型的用户,分别满足对应的管理后台、用户 App 场景。

  • AdminUser 管理员用户,前端访问 econets-ui-admin-vue3 (opens new window)管理后台,后端访问 /admin-api/** RESTful API 接口。

虽然是不同类型的用户,他们访问 RESTful API 接口时,都通过 Token 认证机制

# 1. 表结构

2 种类型的时候,采用不同数据库的表进行存储,管理员用户对应 system_users (opens new window)表,会员用户对应 member_user表。如下图所示:

为什么不使用统一的用户表?

确实可以采用这样的方案,新增 type 字段区分用户类型。不同用户类型的信息字段,例如说上图的 dept_id、post_ids 等等,可以增加拓展表,或者就干脆“冗余”在用户表中。

不过实际项目中,不同类型的用户往往是不同的团队维护,并且这也是绝大多团队的实践,所以我们采用了多个用户表的方案。

如果表需要关联多种类型的用户,例如说上述的 system_oauth2_access_token 访问令牌表,可以通过 user_type 字段进行区分。并且 user_type 对应 UserTypeEnum (opens new window)全局枚举,代码如下:

# 2. 如何获取当前登录的用户?

使用 SecurityFrameworkUtils (opens new window)提供的如下方法,可以获得当前登录用户的信息:

/**
 * 【最常用】获得当前用户的编号,从上下文中
 *
 * @return 用户编号
 */
@Nullable
public static Long getLoginUserId() { /** 省略实现 */ }

/**
 * 获取当前用户
 *
 * @return 当前用户
 */
@Nullable
public static LoginUser getLoginUser() { /** 省略实现 */ }

# 3. 账号密码登录

# 3.1 管理后台的实现

使用 username 账号 + password 密码进行登录,由 AuthController (opens new window)提供 /admin-api/system/auth/login 接口。代码如下:

@PostMapping("/login")
@Operation(summary = "使用账号密码登录")
@OperateLog(enable = false) // 避免 Post 请求被记录操作日志
public CommonResult<AuthLoginRespVO> login(@RequestBody @Valid AuthLoginReqVO reqVO) {
    String token = authService.login(reqVO, getClientIP(), getUserAgent());
    // 返回结果
    return success(AuthLoginRespVO.builder().token(token).build());
}

如何关闭验证码?

参见 《后端手册 —— 验证码》 (opens new window) 文档。

# 3.2 用户 App 的实现

使用 mobile 手机 + password 密码进行登录,由 AppAuthController提供 /app-api/member/auth/login 接口。代码如下:

@PostMapping("/login")
@Operation(summary = "使用手机 + 密码登录")
@OperateLog(enable = false) // 避免 Post 请求被记录操作日志
public CommonResult<AppAuthLoginRespVO> login(@RequestBody @Valid AppAuthLoginReqVO reqVO) {
    String token = authService.login(reqVO, getClientIP(), getUserAgent());
    // 返回结果
    return success(AppAuthLoginRespVO.builder().token(token).build());
}

# 4. 手机验证码登录

# 4.1 管理后台的实现

① 使用 mobile 手机号获得验证码,由 AuthController提供 /admin-api/system/auth/send-sms-code 接口。代码如下:

@PostMapping("/send-sms-code")
@Operation(summary = "发送手机验证码")
@OperateLog(enable = false) // 避免 Post 请求被记录操作日志
public CommonResult<Boolean> sendSmsCode(@RequestBody @Valid AuthSendSmsReqVO reqVO) {
    authService.sendSmsCode(getLoginUserId(), reqVO);
    return success(true);
}

② 使用 mobile 手机 + code 验证码进行登录,由 AppAuthController提供 /admin-api/system/auth/sms-login 接口。代码如下:

@PostMapping("/sms-login")
@Operation(summary = "使用短信验证码登录")
@OperateLog(enable = false) // 避免 Post 请求被记录操作日志
public CommonResult<AuthLoginRespVO> smsLogin(@RequestBody @Valid AuthSmsLoginReqVO reqVO) {
    String token = authService.smsLogin(reqVO, getClientIP(), getUserAgent());
    // 返回结果
    return success(AuthLoginRespVO.builder().token(token).build());
}

# 4.2 用户 App 的实现

① 使用 mobile 手机号获得验证码,由 AppAuthController提供 /app-api/member/auth/send-sms-code 接口。代码如下:

@PostMapping("/send-sms-code")
@Operation(summary = "发送手机验证码")
@OperateLog(enable = false) // 避免 Post 请求被记录操作日志
public CommonResult<Boolean> sendSmsCode(@RequestBody @Valid AppAuthSendSmsReqVO reqVO) {
    authService.sendSmsCode(getLoginUserId(), reqVO);
    return success(true);
}

② 使用 mobile 手机 + code 验证码进行登录,由 AppAuthController提供 /app-api/member/auth/sms-login 接口。代码如下:

@PostMapping("/sms-login")
@Operation(summary = "使用手机 + 验证码登录")
@OperateLog(enable = false) // 避免 Post 请求被记录操作日志
public CommonResult<AppAuthLoginRespVO> smsLogin(@RequestBody @Valid AppAuthSmsLoginReqVO reqVO) {
    String token = authService.smsLogin(reqVO, getClientIP(), getUserAgent());
    // 返回结果
    return success(AppAuthLoginRespVO.builder().token(token).build());
}

如果用户未注册,会自动使用手机号进行注册会员用户。所以,/app-api/member/user/sms-login 接口也提供了用户注册的功能。

# 5. 三方登录

详细参见 《开发指南 —— 三方登录》 (opens new window) 文章。

# 5.1 管理后台的实现

① 跳转第三方平台,来获得三方授权码,由 AuthController提供 /admin-api/system/auth/social-auth-redirect 接口。代码如下:

@GetMapping("/social-auth-redirect")
@Operation(summary = "社交授权的跳转")
@Parameters({
        @Parameter(name = "type", description = "社交类型", required = true),
        @Parameter(name = "redirectUri", description = "回调路径")
})
public CommonResult<String> socialAuthRedirect(@RequestParam("type") Integer type,
                                                @RequestParam("redirectUri") String redirectUri) {
    return CommonResult.success(socialUserService.getAuthorizeUrl(type, redirectUri));
}

② 使用 code 三方授权码进行快登录,由 AuthController提供 /admin-api/system/auth/social-login 接口。代码如下:

@PostMapping("/social-login")
@Operation(summary = "社交快捷登录,使用 code 授权码")
@OperateLog(enable = false) // 避免 Post 请求被记录操作日志
public CommonResult<AuthLoginRespVO> socialQuickLogin(@RequestBody @Valid AuthSocialQuickLoginReqVO reqVO) {
    String token = authService.socialLogin(reqVO, getClientIP(), getUserAgent());
    // 返回结果
    return success(AuthLoginRespVO.builder().token(token).build());
}

③ 使用 socialCode 三方授权码 + username + password 进行绑定登录,直接使用 /admin-api/system/auth/login 账号密码登录的接口,区别在于额外带上 socialType + socialCode + socialState 参数。

# 5.2 用户 App 的实现

① 跳转第三方平台,来获得三方授权码,由 AppAuthController提供 /app-api/member/auth/social-auth-redirect 接口。代码如下:

@GetMapping("/social-auth-redirect")
@Operation(summary = "社交授权的跳转")
@Parameters({
        @Parameter(name = "type", description = "社交类型", required = true),
        @Parameter(name = "redirectUri", description = "回调路径")
})
public CommonResult<String> socialAuthRedirect(@RequestParam("type") Integer type,
                                               @RequestParam("redirectUri") String redirectUri) {
    return CommonResult.success(socialUserService.getAuthorizeUrl(type, redirectUri));
}

② 使用 code 三方授权码进行快登录,由 AppAuthController提供 /app-api/member/auth/social-login 接口。代码如下:

@PostMapping("/social-login")
@Operation(summary = "社交快捷登录,使用 code 授权码")
@OperateLog(enable = false) // 避免 Post 请求被记录操作日志
public CommonResult<AppAuthLoginRespVO> socialQuickLogin(@RequestBody @Valid AuthSocialQuickLoginReqVO reqVO) {
    String token = authService.socialLogin(reqVO, getClientIP(), getUserAgent());
    // 返回结果
    return success(AuthLoginRespVO.builder().token(token).build());
}

③ 使用 socialCode 三方授权码 + username + password 进行绑定登录,直接使用 /app-api/system/auth/login 手机验证码登录的接口,区别在于额外带上 socialType + socialCode + socialState 参数。

④ 【微信小程序特有】使用 phoneCode + loginCode 实现获取手机号并一键登录,由 AppAuthController提供 /app-api/member/auth/weixin-mini-app-login 接口。代码如下:

@PostMapping("/weixin-mini-app-login")
@Operation(summary = "微信小程序的一键登录")
public CommonResult<AppAuthLoginRespVO> weixinMiniAppLogin(@RequestBody @Valid AppAuthWeixinMiniAppLoginReqVO reqVO) {
    return success(authService.weixinMiniAppLogin(reqVO));
}

# 6. 注册

# 6.1 管理后台的实现

管理后台暂不支持用户注册,而是通过在 [系统管理 -> 用户管理] 菜单,进行添加用户,由 UserController提供 /admin-api/system/user/create 接口。代码如下:

@PostMapping("/create")
@Operation(summary = "新增用户")
@PreAuthorize("@ss.hasPermission('system:user:create')")
public CommonResult<Long> createUser(@Valid @RequestBody UserCreateReqVO reqVO) {
    Long id = userService.createUser(reqVO);
    return success(id);
}

# 6.2 用户 App 的实现

手机验证码登录时,如果用户未注册,会自动使用手机号进行注册会员用户。所以,/app-api/system/user/sms-login 接口也提供了用户注册的功能。

# 7. 用户登出

用户登出的功能,统一使用 Spring Security 框架,通过删除用户 Token 的方式来实现。代码如下:

差别在于使用的 API 接口不同,管理员用户使用 /admin-api/system/logout,会员用户使用 /app-api/member/logout。

上次更新: 2024/01/15, 14:28:02
数据权限
三方登录

← 数据权限 三方登录→

Theme by Vdoing | Copyright © 2019-2024 EcoNets Tech | MIT License
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式