weblog/7.8 用户退出登录接口开发.md at 0d814a6e991e7b4417ae4ad014579d2edcbba3ed

stu/weblog

Fork 0

cuijiawang 0d814a6e99 doc 7 9 10 14

2025-02-17 11:57:55 +08:00

5.9 KiB

Raw Blame History

在上小节中，我们已经实现了网关透传用户 ID 给下游服务，下游服务知道了请求对应的用户 ID，才能方便的处理相关业务，比如用户退出登录。本小节中，就来把用户退出登录接口开发完成。

接口定义

接口地址

POST /user/logout

入参

无入参。只需请求头中携带上 Token 即可。

出参

{
	"success": true, // true 表示退出登录成功
	"message": null,
	"errorCode": null,
	"data": null
}

编写业务逻辑

之前测试权限校验的时候，退出登录接口已经在认证服务中定义好了，接下来，仅需补充对应逻辑即可。

service 业务层

编辑 UserService 业务接口，声明一个退出登录方法，入参为请求头透传过来的用户 ID, 代码如下：

package com.quanxiaoha.xiaohashu.auth.service;

import com.quanxiaoha.framework.common.response.Response;
import com.quanxiaoha.xiaohashu.auth.model.vo.user.UserLoginReqVO;

public interface UserService {

	// 省略...

    /**
     * 退出登录
     * @return
     */
    Response<?> logout(Long userId);

}

接着，编辑其实现类 UserServiceImpl，实现上述方法，并添加逻辑代码如下：

package com.quanxiaoha.xiaohashu.auth.service.impl;

import cn.dev33.satoken.stp.SaTokenInfo;
import cn.dev33.satoken.stp.StpUtil;
import com.google.common.base.Preconditions;
import com.google.common.collect.Lists;
import com.quanxiaoha.framework.common.enums.DeletedEnum;
import com.quanxiaoha.framework.common.enums.StatusEnum;
import com.quanxiaoha.framework.common.exception.BizException;
import com.quanxiaoha.framework.common.response.Response;
import com.quanxiaoha.framework.common.util.JsonUtils;
import com.quanxiaoha.xiaohashu.auth.constant.RedisKeyConstants;
import com.quanxiaoha.xiaohashu.auth.constant.RoleConstants;
import com.quanxiaoha.xiaohashu.auth.domain.dataobject.PermissionDO;
import com.quanxiaoha.xiaohashu.auth.domain.dataobject.RoleDO;
import com.quanxiaoha.xiaohashu.auth.domain.dataobject.UserDO;
import com.quanxiaoha.xiaohashu.auth.domain.dataobject.UserRoleDO;
import com.quanxiaoha.xiaohashu.auth.domain.mapper.RoleDOMapper;
import com.quanxiaoha.xiaohashu.auth.domain.mapper.UserDOMapper;
import com.quanxiaoha.xiaohashu.auth.domain.mapper.UserRoleDOMapper;
import com.quanxiaoha.xiaohashu.auth.enums.LoginTypeEnum;
import com.quanxiaoha.xiaohashu.auth.enums.ResponseCodeEnum;
import com.quanxiaoha.xiaohashu.auth.model.vo.user.UserLoginReqVO;
import com.quanxiaoha.xiaohashu.auth.service.UserService;
import jakarta.annotation.Resource;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Service;
import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.transaction.TransactionStatus;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.transaction.support.DefaultTransactionDefinition;
import org.springframework.transaction.support.TransactionTemplate;

import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

@Service
@Slf4j
public class UserServiceImpl implements UserService {

   // 省略...

    /**
     * 退出登录
     *
     * @param userId
     * @return
     */
    @Override
    public Response<?> logout(Long userId) {
        // 退出登录 (指定用户 ID)
        StpUtil.logout(userId);
        
        return Response.success();
    }

    // 省略...

}

逻辑很简单，通过 SaToken 的工具类方法 StpUtil.logout(userId); ，传入想要退出登录的用户 ID 即可。

Controller 层

最后，编辑 UserController 控制器，修改代码如下：

package com.quanxiaoha.xiaohashu.auth.controller;

import com.quanxiaoha.framework.biz.operationlog.aspect.ApiOperationLog;
import com.quanxiaoha.framework.common.response.Response;
import com.quanxiaoha.xiaohashu.auth.model.vo.user.UserLoginReqVO;
import com.quanxiaoha.xiaohashu.auth.service.UserService;
import jakarta.annotation.Resource;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

/**
 * @author: 犬小哈
 * @date: 2024/5/29 15:32
 * @version: v1.0.0
 * @description: TODO
 **/
@RestController
@RequestMapping("/user")
@Slf4j
public class UserController {

    @Resource
    private UserService userService;

    // 省略...

    @PostMapping("/logout")
    @ApiOperationLog(description = "账号登出")
    public Response<?> logout(@RequestHeader("userId") String userId) {
        return userService.logout(Long.valueOf(userId));
    }

}