refactor(web): 登录会话与协议同意逻辑抽到 service/login

账号密码登录、微信小程序登录共用同一套:客户端归一、协议校验(428)、
落库同意记录、签发令牌 + 主体列表。auth 控制器只保留参数校验与业务编排。

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
liufumingren 2026-10-21 00:47:06 +08:00
parent 413bd9f981
commit 517fafeef9
2 changed files with 95 additions and 73 deletions

View File

@ -14,76 +14,9 @@ const EMAIL_RE = /^[^\s@]+@[^\s@]+\.[^\s@]{2,}$/;
* 统一响应:成功 `{ ok:true, data }`;失败 `{ ok:false, status?, message }`。
*/
class WebAuthController extends Controller {
/** 客户端标识(只认白名单,避免任意字符串进库) */
normalizeClient(value) {
const client = String(value || '').trim().toLowerCase();
return [ 'mini_program', 'web', 'h5' ].includes(client) ? client : '';
}
/** 当前配置下,这个客户端是否必须先同意协议 */
shouldEnforceAgreement(client) {
const mode = String(this.app.config.agreement.enforce || 'mini_program').toLowerCase();
if ([ 'off', 'false', '0', 'no' ].includes(mode)) return false;
if (mode === 'all') return true;
return client === 'mini_program';
}
/**
* 校验协议同意情况
* 通过 → 返回可落库的 `[{ agreementId, code, versionId, version }]`;
* 不通过 → 直接写 428 响应并返回 null(客户端拿到最新协议后重新展示)
*/
async requireAgreements(input) {
const { ctx } = this;
const required = await ctx.service.agreement.requiredVersions();
const check = ctx.service.agreement.verifyAcceptance(required, input);
if (check.ok) return check.accepted;
ctx.status = 428;
ctx.body = {
ok: false,
status: 'agreement_required',
message: '请阅读并同意用户协议后再登录',
data: { agreements: required },
};
return null;
}
/** 落库同意记录(失败不阻断登录,只记错误日志) */
async recordAgreements(user, accepted, client) {
const { ctx } = this;
try {
return await ctx.service.agreement.record(user.id, accepted, {
source: client || 'unknown',
ip: ctx.ip,
userAgent: String(ctx.get('user-agent') || ''),
});
} catch (err) {
ctx.logger.error('[web] 记录协议同意失败, userId=%s: %s', user.id, err.message);
return [];
}
}
/**
* 签发令牌 + 返回脱敏用户(登录 / 注册成功后都走它)
*
* `subjects` 带上当前账号可进入的主体列表(前端登录后直接拿它渲染切换器,不用再请求一次)
*/
/** 签发令牌 + 返回脱敏用户(登录 / 注册成功后都走它) */
async issue(user) {
const { ctx } = this;
let subjects = [];
try {
subjects = await ctx.service.subject.listForUser(user.id);
} catch (err) {
ctx.logger.warn('[web] 登录时读取主体列表失败: %s', err.message);
}
return {
token: ctx.service.jwt.signUser(user),
tokenType: 'Bearer',
expiresIn: ctx.app.config.jwt.userExpiresIn,
user,
subjects,
};
return this.ctx.service.login.issue(user);
}
/**
@ -98,7 +31,7 @@ class WebAuthController extends Controller {
const { ctx } = this;
const body = ctx.request.body || {};
const { account, password } = body;
const client = this.normalizeClient(body.client);
const client = ctx.service.login.normalizeClient(body.client);
if (!account || !password) {
ctx.status = 422;
ctx.body = { ok: false, message: '请填写账号和密码' };
@ -106,8 +39,8 @@ class WebAuthController extends Controller {
}
let accepted = null;
if (this.shouldEnforceAgreement(client)) {
accepted = await this.requireAgreements(body.agreements);
if (ctx.service.login.shouldEnforceAgreement(client)) {
accepted = await ctx.service.login.requireAgreements(body.agreements);
if (!accepted) return;
}
@ -121,7 +54,7 @@ class WebAuthController extends Controller {
ctx.logger.info('[web] %s 登录成功(API, client=%s)', user.username || account, client || 'unknown');
const data = await this.issue(user);
if (accepted) {
data.agreements = await this.recordAgreements(user, accepted, client);
data.agreements = await ctx.service.login.recordAgreements(user, accepted, client);
ctx.logger.info('[web] 用户 %s 同意协议:%s', user.id, accepted.map(item => `${item.code}@${item.version}`).join(', '));
}
ctx.body = { ok: true, data };

View File

@ -0,0 +1,89 @@
'use strict';
const { Service } = require('egg');
/** 允许的客户端标识(只认白名单,避免任意字符串进库) */
const CLIENTS = [ 'mini_program', 'web', 'h5' ];
/**
* 登录会话(账号密码登录 / 微信小程序登录共用)
*
* - `issue(user)`:签发 user JWT + 带上可进入的主体列表
* - `requireAgreements(input)`:校验协议是否为当前版本,不通过直接写 428
* - `recordAgreements(user, accepted, client)`:把同意记录落库
*/
class LoginService extends Service {
/** 客户端标识归一(非法返回空串) */
normalizeClient(value) {
const client = String(value || '').trim().toLowerCase();
return CLIENTS.includes(client) ? client : '';
}
/** 当前配置下,这个客户端是否必须先同意协议 */
shouldEnforceAgreement(client) {
const mode = String(this.app.config.agreement.enforce || 'mini_program').toLowerCase();
if ([ 'off', 'false', '0', 'no' ].includes(mode)) return false;
if (mode === 'all') return true;
return client === 'mini_program';
}
/**
* 校验协议同意情况
* @return {Promise<Array|null>} 通过 → 可落库的 `[{ agreementId, code, versionId, version }]`;
* 不通过 → 写 428 并返回 null
*/
async requireAgreements(input) {
const { ctx } = this;
const required = await ctx.service.agreement.requiredVersions();
const check = ctx.service.agreement.verifyAcceptance(required, input);
if (check.ok) return check.accepted;
ctx.status = 428;
ctx.body = {
ok: false,
status: 'agreement_required',
message: '请阅读并同意用户协议后再登录',
data: { agreements: required },
};
return null;
}
/** 落库同意记录(失败不阻断登录,只记错误日志) */
async recordAgreements(user, accepted, client) {
const { ctx } = this;
try {
return await ctx.service.agreement.record(user.id, accepted, {
source: client || 'unknown',
ip: ctx.ip,
userAgent: String(ctx.get('user-agent') || ''),
});
} catch (err) {
ctx.logger.error('[login] 记录协议同意失败, userId=%s: %s', user.id, err.message);
return [];
}
}
/**
* 签发令牌 + 返回脱敏用户
*
* `subjects` 带上当前账号可进入的主体列表(前端登录后直接拿它渲染切换器,不用再请求一次)
*/
async issue(user) {
const { ctx } = this;
let subjects = [];
try {
subjects = await ctx.service.subject.listForUser(user.id);
} catch (err) {
ctx.logger.warn('[login] 登录时读取主体列表失败: %s', err.message);
}
return {
token: ctx.service.jwt.signUser(user),
tokenType: 'Bearer',
expiresIn: this.app.config.jwt.userExpiresIn,
user,
subjects,
};
}
}
module.exports = LoginService;