yudao-cloud 开发指南 yudao-cloud 开发指南
      视频教程
        单体版 (opens new window)
        作者博客 (opens new window)
        GitHub (opens new window)
        • 萌新必读

          • 简介
          • 交流群
          • 视频教程
          • 功能列表
          • 快速启动(后端项目)
          • 快速启动(前端项目)
          • 接口文档
          • 技术选型
          • 项目结构
          • 代码热加载
          • 一键改包
          • 删除功能
          • 内网穿透
          • 达梦数据库专属
        • 后端手册

          • 新建服务
          • 代码生成【单表】(新增功能)
          • 代码生成【主子表】
          • 代码生成(树表)
          • 功能权限
          • 数据权限
          • 用户体系
          • 三方登录
            • OAuth 2.0(SSO 单点登录)
            • SaaS 多租户【字段隔离】
            • SaaS 多租户【数据库隔离】
            • WebSocket 实时通信
            • 异常处理(错误码)
            • 参数校验
            • 分页实现
            • VO 对象转换、数据翻译
            • 文件存储(上传下载)
            • Excel 导入导出
            • 操作日志、访问日志、异常日志
            • MyBatis 数据库
            • MyBatis 联表&分页查询
            • 多数据源(读写分离)
            • Redis 缓存
            • 本地缓存
            • 异步任务
            • 分布式锁
            • 幂等性(防重复提交)
            • 请求限流(RateLimiter)
            • 单元测试
            • 验证码
            • 工具类 Util
            • 数据库文档
          • 微服务手册

            • 微服务调试(必读)
            • 注册中心 Nacos
            • 配置中心 Nacos
            • 服务网关 Spring Cloud Gateway
            • 服务调用 Feign
            • 定时任务 XXL Job
            • 消息队列(内存)
            • 消息队列(Redis)
            • 消息队列(RocketMQ)
            • 消息队列(RabbitMQ)
            • 消息队列(Kafka)
            • 消息队列(Cloud)
            • 分布式事务 Seata
            • 服务保障 Sentinel
          • 工作流手册

            • 工作流演示
            • 功能开启
            • 工作流(达梦适配)
            • 审批接入(流程表单)
            • 审批接入(业务表单)
            • 流程设计器(BPMN)
            • 流程设计器(钉钉、飞书)
            • 选择审批人、发起人自选
            • 会签、或签、依次审批
            • 流程发起、取消、重新发起
            • 审批通过、不通过、驳回
            • 审批加签、减签
            • 审批转办、委派、抄送
            • 执行监听器、任务监听器
            • 流程表达式
            • 流程审批通知
          • 大屏手册

            • 报表设计器
            • 大屏设计器
          • 支付手册

            • 功能开启
            • 支付宝支付接入
            • 微信公众号支付接入
            • 微信小程序支付接入
            • 支付宝、微信退款接入
          • 会员手册

            • 功能开启
            • 微信公众号登录
            • 微信小程序登录
            • 会员用户、标签、分组
            • 会员等级、积分、签到
          • 商城手册

            • 商城演示
            • 功能开启
            • 商城装修
            • 【商品】商品分类
            • 【商品】商品属性
            • 【商品】商品 SPU 与 SKU
            • 【商品】商品评价
            • 【交易】购物车
            • 【交易】交易订单
            • 【交易】售后退款
            • 【交易】快递发货
            • 【交易】门店自提
            • 【交易】分销返佣
            • 【营销】优惠劵
            • 【营销】拼团活动
            • 【营销】秒杀活动
            • 【营销】砍价活动
            • 【营销】满减送
            • 【营销】限时折扣
            • 【营销】内容管理
            • 【统计】会员、商品、交易统计
          • ERP手册

            • ERP 演示
            • 功能开启
            • 【产品】产品信息、分类、单位
            • 【库存】产品库存、库存明细
            • 【库存】其它入库、其它出库
            • 【库存】库存调拨、库存盘点
            • 【采购】采购订单、入库、退货
            • 【销售】销售订单、出库、退货
            • 【财务】采购付款、销售收款
          • CRM手册

            • CRM 演示
            • 功能开启
            • 【线索】线索管理
            • 【客户】客户管理、公海客户
            • 【商机】商机管理、商机状态
            • 【合同】合同管理、合同提醒
            • 【回款】回款管理、回款计划
            • 【产品】产品管理、产品分类
            • 【通用】数据权限
            • 【通用】跟进记录、待办事项
          • 公众号手册

            • 功能开启
            • 公众号接入
            • 公众号粉丝
            • 公众号标签
            • 公众号消息
            • 自动回复
            • 公众号菜单
            • 公众号素材
            • 公众号图文
            • 公众号统计
          • 系统手册

            • 短信配置
            • 邮件配置
            • 站内信配置
            • 数据脱敏
            • 敏感词
            • 地区 & IP 库
          • 运维手册

            • 开发环境
            • Linux 部署
            • Docker 部署
            • Jenkins 部署
            • HTTPS 证书
            • 服务监控
          • 前端手册 Vue 3.x

            • 开发规范
            • 菜单路由
            • Icon 图标
            • 字典数据
            • 系统组件
            • 通用方法
            • 配置读取
            • CRUD 组件
            • 国际化
            • IDE 调试
            • 代码格式化
          • 前端手册 Vue 2.x

            • 开发规范
            • 菜单路由
            • Icon 图标
            • 字典数据
            • 系统组件
            • 通用方法
            • 配置读取
          • 更新日志

            • 【v2.1.0】开发中
            • 【v2.0.1】2024-03-01
            • 【v2.0.0】2024-01-26
            • 【v1.9.0】2023-12-01
            • 【v1.8.3】2023-10-24
          • 开发指南
          • 后端手册
          芋道源码
          2022-03-28
          目录
          1. 表结构
          2. 绑定登录
          3. 快捷登录
          4. 绑定与解绑
          5. 配置管理
          5.1 配置文件
          5.2 数据库配置
          6. 第三方平台的申请

          三方登录

          系统对接国内多个第三方平台,实现三方登录的功能。例如说:

          • 管理后台:企业微信、阿里钉钉
          • 用户 App:微信公众号、微信小程序

          管理后台

          友情提示:为了表述方便,本文主要使用管理后台的三方登录作为示例。

          用户 App 也是支持该功能,你可以自己去体验一下。

          # 1. 表结构

          ① 三方登录完成时,系统会将三方用户存储到 system_social_user (opens new window) 表中,通过 type (opens new window) 标记对应的第三方平台。

          ② 【未】关联本系统 User 的三方用户,需要在三方登录完成后,使用账号密码进行「绑定登录」,成功后记录到 system_social_user_bind (opens new window) 表中。

          【已】关联本系统 User 的三方用户,在三方登录完成后,直接进入系统,即「快捷登录」。

          # 2. 绑定登录

          ① 使用浏览器访问 http://127.0.0.1:1024/login (opens new window) 地址,点击 [钉钉] 或者 [企业微信] 进行三方登录。此时,会调用 /admin-api/system/auth/social-auth-redirect (opens new window) 接口,获得第三方平台的登录地址,并进行跳转。

          三方登录

          然后,使用 [钉钉] 或者 [企业微信] 进行扫码,完成三方登录。

          ② 三方登录成功后,跳转回 http://127.0.0.1:1024/social-login (opens new window) 地址。此时,会调用 /admin-api/system/auth/social-login (opens new window) 接口,尝试「快捷登录」。由于该三方用户【未】关联管理后台的 AdminUser 用户,所以会看到 “未绑定账号,需要进行绑定” 报错。

          三方登录页

          ③ 输入账号密码,点击 [提交] 按钮,进行「绑定登录」。此时,会调用 /admin-api/system/auth/login (opens new window) 接口(在账号密码登录的基础上,额外带上 socialType + socialCode + socialState 参数)。成功后,即可进入系统的首页。

          三方登录页

          # 3. 快捷登录

          退出系统,再进行一次三方登录的流程。

          【相同】① 使用浏览器访问 http://127.0.0.1:1024/login (opens new window) 地址,点击 [钉钉] 或者 [企业微信] 进行三方登录。此时,会调用 /admin-api/system/auth/social-auth-redirect (opens new window) 接口,获得第三方平台的登录地址,并进行跳转。

          三方登录

          【不同】② 三方登录成功后,跳转回 http://127.0.0.1:1024/social-login (opens new window) 地址。此时,会调用 /admin-api/system/auth/social-login (opens new window) 接口,尝试「快捷登录」。由于该三方用户【已】关联管理后台的 AdminUser 用户,所以直接进入系统的首页。

          三方登录页

          # 4. 绑定与解绑

          访问 http://127.0.0.1:1024/user/profile (opens new window) 地址,选择 [社交信息] 选项,可以三方用户的绑定与解绑。

          绑定与解绑

          # 5. 配置管理

          # 5.1 配置文件

          在 application-{env}.yaml (opens new window) 配置文件中,对应 justauth 配置项,填写你的第三方平台的配置信息。

          配置文件

          系统使用 JustAuth (opens new window) 组件,想要对接其它第三方平台,只需要新增对应的配置信息即可。

          # 5.2 数据库配置

          ① system_social_client 表,它本质上是 JustAuth 配置的 DB 存储。

          主要实现两个目的:

          CREATE TABLE `system_social_client` (
            `id` bigint NOT NULL AUTO_INCREMENT COMMENT '编号',
            `name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '应用名',
            `status` tinyint NOT NULL COMMENT '状态',
            // JustAuth 配置项
            `social_type` tinyint NOT NULL COMMENT '社交平台的类型',
            `client_id` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '客户端编号',
            `client_secret` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '客户端密钥',
            `agent_id` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '代理编号',
            // 目的 1
            `tenant_id` bigint NOT NULL DEFAULT '0' COMMENT '租户编号',
            // 目的 2
            `user_type` tinyint NOT NULL COMMENT '用户类型',
            // ... 省略其它非关键字段
            PRIMARY KEY (`id`) USING BTREE
          ) ENGINE=InnoDB AUTO_INCREMENT=44 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='社交客户端表';
          
          1. 在需要 SaaS 多租户的项目中,通过 tenant_id 字段隔离,实现不同租户对应不同第三方平台的配置
          2. 在多用户类型的项目中,通过 user_type 字段区分,实现不同用户类型对应不同第三方平台的配置

          注意,system_social_client 表的优先级,比 application-{env}.yaml 配置文件高!具体逻辑,可见 SocialClientServiceImpl 类的 #buildAuthRequest(...) 方法。

          疑问:系统目前支持指定租户 + 用户类型 + 社交平台,对应多套配置吗?

          不支持,需要自己改造。总体思路是:

          1. system_social_client 额外再增加一个 application 应用字段,存储应用名,进行一步隔离
          2. 前端调用三方登录时,额外传递 application 应用字段,用于查询对应应用的配置

          ② 在 [系统管理 -> 三方登录 -> 三方应用] 菜单下,可以进行当前租户的 system_social_client 表的配置管理。如下图所示:

          三方应用

          另外,在 [系统管理 -> 三方登录 -> 三方用户] 菜单下,可以进行当前租户的 system_social_user 三方用户表的查询。如下图所示:

          三方应用

          # 6. 第三方平台的申请

          • 阿里钉钉:https://justauth.wiki/guide/oauth/dingtalk/ (opens new window)
          • 企业微信:https://justauth.wiki/guide/oauth/wechat_enterprise_qrcode/ (opens new window)
          • 微信开放平台:https://justauth.wiki/guide/oauth/wechat_open/ (opens new window)

          注意,如果第三方平台如果需要配置具体的授信地址,需要添加 /social-login 用于三方登录回调页、/user/profile 用于三方用户的绑定与解绑。

          用户体系
          OAuth 2.0(SSO 单点登录)

          ← 用户体系 OAuth 2.0(SSO 单点登录)→

          Theme by Vdoing | Copyright © 2019-2024 芋道源码 | MIT License
            ×