yudao
/
admin-vben
mirror of https://gitee.com/yudaocode/yudao-ui-admin-vben.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

feat：增加 social 三方登录

pull/68/head
YunaiV 2025-04-06 20:43:40 +08:00
parent 32be95debd
commit c1098109a9
8 changed files with 759 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
apps/web-antd/src/api/system/social/client/index.ts Normal file
View File

@ -0,0 +1,44 @@
import { requestClient } from '#/api/request';
import type { PageParam, PageResult } from '@vben/request';
export namespace SystemSocialClientApi {
/** 社交客户端信息 */
export interface SystemSocialClient {
id?: number;
name: string;
socialType: number;
userType: number;
clientId: string;
clientSecret: string;
agentId?: string;
status: number;
createTime?: Date;
}
}
/** 查询社交客户端列表 */
export function getSocialClientPage(params: PageParam) {
return requestClient.get<PageResult<SystemSocialClientApi.SystemSocialClient>>('/system/social-client/page',
{ params }
);
}
/** 查询社交客户端详情 */
export function getSocialClient(id: number) {
return requestClient.get<SystemSocialClientApi.SystemSocialClient>(`/system/social-client/get?id=${id}`);
}
/** 新增社交客户端 */
export function createSocialClient(data: SystemSocialClientApi.SystemSocialClient) {
return requestClient.post('/system/social-client/create', data);
}
/** 修改社交客户端 */
export function updateSocialClient(data: SystemSocialClientApi.SystemSocialClient) {
return requestClient.put('/system/social-client/update', data);
}
/** 删除社交客户端 */
export function deleteSocialClient(id: number) {
return requestClient.delete(`/system/social-client/delete?id=${id}`);
}

32
apps/web-antd/src/api/system/social/user/index.ts Normal file
View File

@ -0,0 +1,32 @@
import { requestClient } from '#/api/request';
import type { PageParam, PageResult } from '@vben/request';
export namespace SystemSocialUserApi {
/** 社交用户信息 */
export interface SystemSocialUser {
id?: number;
type: number;
openid: string;
token: string;
rawTokenInfo: string;
nickname: string;
avatar: string;
rawUserInfo: string;
code: string;
state: string;
createTime?: Date;
updateTime?: Date;
}
}
/** 查询社交用户列表 */
export function getSocialUserPage(params: PageParam) {
return requestClient.get<PageResult<SystemSocialUserApi.SystemSocialUser>>('/system/social-user/page',
{ params }
);
}
/** 查询社交用户详情 */
export function getSocialUser(id: number) {
return requestClient.get<SystemSocialUserApi.SystemSocialUser>(`/system/social-user/get?id=${id}`);
}

228
apps/web-antd/src/views/system/social/client/data.ts Normal file
View File

@ -0,0 +1,228 @@
import { type VbenFormSchema, z } from '#/adapter/form';
import type { OnActionClickFn, VxeTableGridOptions } from '#/adapter/vxe-table';
import type { SystemSocialClientApi } from '#/api/system/social/client';
import { DICT_TYPE, getDictOptions } from '#/utils/dict';
import { CommonStatusEnum, SystemUserSocialTypeEnum } from '#/utils/constants';
import { useAccess } from '@vben/access';
const { hasAccessByCodes } = useAccess();
/** 新增/修改的表单 */
export function useFormSchema(): VbenFormSchema[] {
return [
{
fieldName: 'id',
label: 'id',
component: 'Input',
dependencies: {
triggerFields: [''],
show: () => false,
},
},
{
fieldName: 'name',
label: '应用名',
component: 'Input',
componentProps: {
placeholder: '请输入应用名',
},
rules: 'required',
},
{
fieldName: 'socialType',
label: '社交平台',
component: 'Select',
componentProps: {
options: getDictOptions(DICT_TYPE.SYSTEM_SOCIAL_TYPE, 'number'),
class: 'w-full',
},
rules: 'required',
},
{
fieldName: 'userType',
label: '用户类型',
component: 'RadioGroup',
componentProps: {
options: getDictOptions(DICT_TYPE.USER_TYPE, 'number'),
buttonStyle: 'solid',
optionType: 'button',
},
rules: 'required',
},
{
fieldName: 'clientId',
label: '客户端编号',
component: 'Input',
componentProps: {
placeholder: '请输入客户端编号，对应各平台的 appKey',
},
rules: 'required',
},
{
fieldName: 'clientSecret',
label: '客户端密钥',
component: 'Input',
componentProps: {
placeholder: '请输入客户端密钥，对应各平台的 appSecret',
},
rules: 'required',
},
{
fieldName: 'agentId',
label: 'agentId',
component: 'Input',
componentProps: {
placeholder: '授权方的网页应用 ID，有则填',
},
dependencies: {
triggerFields: ['socialType'],
show: (values) => values.socialType === SystemUserSocialTypeEnum.WECHAT_ENTERPRISE.type,
},
},
{
fieldName: 'status',
label: '状态',
component: 'RadioGroup',
componentProps: {
options: getDictOptions(DICT_TYPE.COMMON_STATUS, 'number'),
buttonStyle: 'solid',
optionType: 'button',
},
rules: z.number().default(CommonStatusEnum.ENABLE),
},
];
}
/** 列表的搜索表单 */
export function useGridFormSchema(): VbenFormSchema[] {
return [
{
fieldName: 'name',
label: '应用名',
component: 'Input',
componentProps: {
placeholder: '请输入应用名',
},
},
{
fieldName: 'socialType',
label: '社交平台',
component: 'Select',
componentProps: {
options: getDictOptions(DICT_TYPE.SYSTEM_SOCIAL_TYPE, 'number'),
placeholder: '请选择社交平台',
allowClear: true,
},
},
{
fieldName: 'userType',
label: '用户类型',
component: 'Select',
componentProps: {
options: getDictOptions(DICT_TYPE.USER_TYPE, 'number'),
placeholder: '请选择用户类型',
allowClear: true,
},
},
{
fieldName: 'clientId',
label: '客户端编号',
component: 'Input',
componentProps: {
placeholder: '请输入客户端编号',
},
},
{
fieldName: 'status',
label: '状态',
component: 'Select',
componentProps: {
options: getDictOptions(DICT_TYPE.COMMON_STATUS, 'number'),
placeholder: '请选择状态',
allowClear: true,
},
},
];
}
/** 列表的字段 */
export function useGridColumns<T = SystemSocialClientApi.SystemSocialClient>(
onActionClick: OnActionClickFn<T>,
): VxeTableGridOptions['columns'] {
return [
{
field: 'id',
title: '编号',
minWidth: 80,
},
{
field: 'name',
title: '应用名',
minWidth: 120,
},
{
field: 'socialType',
title: '社交平台',
minWidth: 120,
cellRender: {
name: 'CellDict',
props: { type: DICT_TYPE.SYSTEM_SOCIAL_TYPE },
},
},
{
field: 'userType',
title: '用户类型',
minWidth: 120,
cellRender: {
name: 'CellDict',
props: { type: DICT_TYPE.USER_TYPE },
},
},
{
field: 'clientId',
title: '客户端编号',
minWidth: 180,
},
{
field: 'status',
title: '状态',
minWidth: 80,
cellRender: {
name: 'CellDict',
props: { type: DICT_TYPE.COMMON_STATUS },
},
},
{
field: 'createTime',
title: '创建时间',
minWidth: 180,
formatter: 'formatDateTime',
},
{
field: 'operation',
title: '操作',
minWidth: 130,
align: 'center',
fixed: 'right',
cellRender: {
attrs: {
nameField: 'name',
nameTitle: '社交客户端',
onClick: onActionClick,
},
name: 'CellOperation',
options: [
{
code: 'edit',
show: hasAccessByCodes(['system:social-client:update']),
},
{
code: 'delete',
show: hasAccessByCodes(['system:social-client:delete']),
},
],
},
},
];
}

116
apps/web-antd/src/views/system/social/client/index.vue Normal file
View File

@ -0,0 +1,116 @@
<script lang="ts" setup>
import type { OnActionClickParams, VxeTableGridOptions } from '#/adapter/vxe-table';
import type { SystemSocialClientApi } from '#/api/system/social/client';
import { Page, useVbenModal } from '@vben/common-ui';
import { Button, message } from 'ant-design-vue';
import { Plus } from '@vben/icons';
import Form from './modules/form.vue';
import { DocAlert } from '#/components/doc-alert';
import { $t } from '#/locales';
import { useVbenVxeGrid } from '#/adapter/vxe-table';
import { getSocialClientPage, deleteSocialClient } from '#/api/system/social/client';
import { useGridColumns, useGridFormSchema } from './data';
const [FormModal, formModalApi] = useVbenModal({
connectedComponent: Form,
destroyOnClose: true,
});
/** 刷新表格 */
function onRefresh() {
gridApi.query();
}
/** 创建社交客户端 */
function onCreate() {
formModalApi.setData(null).open();
}
/** 编辑社交客户端 */
function onEdit(row: SystemSocialClientApi.SystemSocialClient) {
formModalApi.setData(row).open();
}
/** 删除社交客户端 */
async function onDelete(row: SystemSocialClientApi.SystemSocialClient) {
const hideLoading = message.loading({
content: $t('ui.actionMessage.deleting', [row.name]),
duration: 0,
key: 'action_process_msg',
});
try {
await deleteSocialClient(row.id as number);
message.success({
content: $t('ui.actionMessage.deleteSuccess', [row.name]),
key: 'action_process_msg',
});
onRefresh();
} catch (error) {
hideLoading();
}
}
/** 表格操作按钮的回调函数 */
function onActionClick({
code,
row,
}: OnActionClickParams<SystemSocialClientApi.SystemSocialClient>) {
switch (code) {
case 'edit': {
onEdit(row);
break;
}
case 'delete': {
onDelete(row);
break;
}
}
}
const [Grid, gridApi] = useVbenVxeGrid({
formOptions: {
schema: useGridFormSchema()
},
gridOptions: {
columns: useGridColumns(onActionClick),
height: 'auto',
keepSource: true,
proxyConfig: {
ajax: {
query: async ({ page }, formValues) => {
return await getSocialClientPage({
pageNo: page.currentPage,
pageSize: page.pageSize,
...formValues,
});
},
},
},
rowConfig: {
keyField: 'id',
},
toolbarConfig: {
refresh: { code: 'query' },
search: true,
},
} as VxeTableGridOptions<SystemSocialClientApi.SystemSocialClient>,
});
</script>
<template>
<Page auto-content-height>
<DocAlert title="三方登录" url="https://doc.iocoder.cn/social-user/" />
<FormModal @success="onRefresh" />
<Grid table-title="社交客户端列表">
<template #toolbar-tools>
<Button type="primary" @click="onCreate" v-access:code="['system:social-client:create']">
<Plus class="size-5" />
{{ $t('ui.actionTitle.create', ['社交客户端']) }}
</Button>
</template>
</Grid>
</Page>
</template>

75
apps/web-antd/src/views/system/social/client/modules/form.vue Normal file
View File

@ -0,0 +1,75 @@
<script lang="ts" setup>
import type { SystemSocialClientApi } from '#/api/system/social/client';
import { useVbenModal } from '@vben/common-ui';
import { message } from 'ant-design-vue';
import { $t } from '#/locales';
import { computed, ref } from 'vue';
import { useVbenForm } from '#/adapter/form';
import { createSocialClient, updateSocialClient, getSocialClient } from '#/api/system/social/client';
import { useFormSchema } from '../data';
const emit = defineEmits(['success']);
const formData = ref<SystemSocialClientApi.SystemSocialClient>();
const getTitle = computed(() => {
return formData.value?.id
? $t('ui.actionTitle.edit', ['社交客户端'])
: $t('ui.actionTitle.create', ['社交客户端']);
});
const [Form, formApi] = useVbenForm({
layout: 'horizontal',
schema: useFormSchema(),
showDefaultActions: false,
});
const [Modal, modalApi] = useVbenModal({
async onConfirm() {
const { valid } = await formApi.validate();
if (!valid) {
return;
}
modalApi.lock();
// 提交表单
const data = (await formApi.getValues()) as SystemSocialClientApi.SystemSocialClient;
try {
await (formData.value?.id ? updateSocialClient(data) : createSocialClient(data));
// 关闭并提示
await modalApi.close();
emit('success');
message.success({
content: $t('ui.actionMessage.operationSuccess'),
key: 'action_process_msg',
});
} finally {
modalApi.lock(false);
}
},
async onOpenChange(isOpen: boolean) {
if (!isOpen) {
return;
}
// 加载数据
const data = modalApi.getData<SystemSocialClientApi.SystemSocialClient>();
if (!data || !data.id) {
return;
}
modalApi.lock();
try {
formData.value = await getSocialClient(data.id as number);
// 设置到 values
await formApi.setValues(formData.value);
} finally {
modalApi.lock(false);
}
},
});
</script>
<template>
<Modal :title="getTitle">
<Form class="mx-4" />
</Modal>
</template>

121
apps/web-antd/src/views/system/social/user/data.ts Normal file
View File

@ -0,0 +1,121 @@
import type { VbenFormSchema } from '#/adapter/form';
import type { OnActionClickFn, VxeTableGridOptions } from '#/adapter/vxe-table';
import type { SystemSocialUserApi } from '#/api/system/social/user';
import { DICT_TYPE, getDictOptions } from '#/utils/dict';
import { useAccess } from '@vben/access';
import { getRangePickerDefaultProps } from '#/utils/date';
const { hasAccessByCodes } = useAccess();
/** 列表的搜索表单 */
export function useGridFormSchema(): VbenFormSchema[] {
return [
{
fieldName: 'type',
label: '社交平台',
component: 'Select',
componentProps: {
options: getDictOptions(DICT_TYPE.SYSTEM_SOCIAL_TYPE, 'number'),
placeholder: '请选择社交平台',
allowClear: true,
},
},
{
fieldName: 'nickname',
label: '用户昵称',
component: 'Input',
componentProps: {
placeholder: '请输入用户昵称',
allowClear: true,
},
},
{
fieldName: 'openid',
label: '社交 openid',
component: 'Input',
componentProps: {
placeholder: '请输入社交 openid',
allowClear: true,
},
},
{
fieldName: 'createTime',
label: '创建时间',
component: 'RangePicker',
componentProps: {
...getRangePickerDefaultProps(),
allowClear: true,
},
},
];
}
/** 列表的字段 */
export function useGridColumns<T = SystemSocialUserApi.SystemSocialUser>(
onActionClick: OnActionClickFn<T>,
): VxeTableGridOptions['columns'] {
return [
{
field: 'type',
title: '社交平台',
minWidth: 120,
cellRender: {
name: 'CellDict',
props: { type: DICT_TYPE.SYSTEM_SOCIAL_TYPE },
},
},
{
field: 'openid',
title: '社交 openid',
minWidth: 180,
},
{
field: 'nickname',
title: '用户昵称',
minWidth: 120,
},
{
field: 'avatar',
title: '用户头像',
minWidth: 80,
cellRender: {
name: 'CellImage',
},
},
{
field: 'createTime',
title: '创建时间',
minWidth: 180,
formatter: 'formatDateTime',
},
{
field: 'updateTime',
title: '更新时间',
minWidth: 180,
formatter: 'formatDateTime',
},
{
field: 'operation',
title: '操作',
minWidth: 100,
align: 'center',
fixed: 'right',
cellRender: {
attrs: {
nameField: 'nickname',
nameTitle: '社交用户',
onClick: onActionClick,
},
name: 'CellOperation',
options: [
{
code: 'view',
text: '详情',
show: hasAccessByCodes(['system:social-user:query']),
},
],
},
},
];
}

78
apps/web-antd/src/views/system/social/user/index.vue Normal file
View File

@ -0,0 +1,78 @@
<script lang="ts" setup>
import type { OnActionClickParams, VxeTableGridOptions } from '#/adapter/vxe-table';
import type { SystemSocialUserApi } from '#/api/system/social/user';
import { Page, useVbenModal } from '@vben/common-ui';
import Detail from './modules/detail.vue';
import { DocAlert } from '#/components/doc-alert';
import { useVbenVxeGrid } from '#/adapter/vxe-table';
import { getSocialUserPage } from '#/api/system/social/user';
import { useGridColumns, useGridFormSchema } from './data';
const [DetailModal, detailModalApi] = useVbenModal({
connectedComponent: Detail,
destroyOnClose: true,
});
/** 刷新表格 */
function onRefresh() {
gridApi.query();
}
/** 查看详情 */
function onView(row: SystemSocialUserApi.SystemSocialUser) {
detailModalApi.setData(row).open();
}
/** 表格操作按钮的回调函数 */
function onActionClick({
code,
row,
}: OnActionClickParams<SystemSocialUserApi.SystemSocialUser>) {
switch (code) {
case 'view': {
onView(row);
break;
}
}
}
const [Grid, gridApi] = useVbenVxeGrid({
formOptions: {
schema: useGridFormSchema()
},
gridOptions: {
columns: useGridColumns(onActionClick),
height: 'auto',
keepSource: true,
proxyConfig: {
ajax: {
query: async ({ page }, formValues) => {
return await getSocialUserPage({
pageNo: page.currentPage,
pageSize: page.pageSize,
...formValues,
});
},
},
},
rowConfig: {
keyField: 'id',
},
toolbarConfig: {
refresh: { code: 'query' },
search: true,
},
} as VxeTableGridOptions<SystemSocialUserApi.SystemSocialUser>,
});
</script>
<template>
<Page auto-content-height>
<DocAlert title="三方登录" url="https://doc.iocoder.cn/social-user/" />
<DetailModal />
<Grid table-title="社交用户列表" />
</Page>
</template>

65
apps/web-antd/src/views/system/social/user/modules/detail.vue Normal file
View File

@ -0,0 +1,65 @@
<script lang="ts" setup>
import type { SystemSocialUserApi } from '#/api/system/social/user';
import { useVbenModal } from '@vben/common-ui';
import { Descriptions, DescriptionsItem, Image } from 'ant-design-vue';
import { DictTag } from '#/components/dict-tag';
import { $t } from '#/locales';
import { ref } from 'vue';
import { getSocialUser } from '#/api/system/social/user';
import { DICT_TYPE } from '#/utils/dict';
const formData = ref<SystemSocialUserApi.SystemSocialUser>();
const [Modal, modalApi] = useVbenModal({
title: $t('ui.actionTitle.detail'),
async onOpenChange(isOpen: boolean) {
if (!isOpen) {
return;
}
// 加载数据
const data = modalApi.getData();
if (!data || !data.id) {
return;
}
modalApi.lock();
try {
formData.value = await getSocialUser(data.id);
} finally {
modalApi.lock(false);
}
},
});
</script>
<template>
<Modal title="社交用户详情" class="w-1/2" :show-cancel-button="false" :show-confirm-button="false">
<Descriptions bordered :column="1" size="middle" class="mx-4" :label-style="{ width: '185px' }">
<DescriptionsItem label="社交平台">
<DictTag :type="DICT_TYPE.SYSTEM_SOCIAL_TYPE" :value="formData?.type" />
</DescriptionsItem>
<DescriptionsItem label="用户昵称">
{{ formData?.nickname }}
</DescriptionsItem>
<DescriptionsItem label="用户头像">
<Image :src="formData?.avatar" :width="30" :height="30" />
</DescriptionsItem>
<DescriptionsItem label="社交 token">
{{ formData?.token }}
</DescriptionsItem>
<DescriptionsItem label="原始 Token 数据">
{{ formData?.rawTokenInfo }}
</DescriptionsItem>
<DescriptionsItem label="原始 User 数据">
{{ formData?.rawUserInfo }}
</DescriptionsItem>
<DescriptionsItem label="最后一次的认证 code">
{{ formData?.code }}
</DescriptionsItem>
<DescriptionsItem label="最后一次的认证 state">
{{ formData?.state }}
</DescriptionsItem>
</Descriptions>
</Modal>
</template>