SpringBoot项目通过自定义注解根据请求头注入用户会话信息_企业级方案

原创 于 2025-08-20 00:36:43 发布 · 728 阅读 · 18 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#spring boot #java #后端 #设计模式 #建造者设计模式 #会话信息 #TheadLocal

目录

1. 引言

2. 示例：

3. 代码

3.1 注解定义@UserSession

3.2 用户会话信息定义UserSessionInfo 

3.3 处理器方法参数解析器

3.4 SessionThreadLocalUtil

3.5 将处理器参数方法解析器注入进WebMvcConfig

4. 测试

4.1 Controller

4.2 ServiceImpl

4.3 控制台

4.4 数据库表

5. 致谢

1. 引言

前面我们讲了

SpringBoot项目自定义统一响应体设计_附上完整测试代码-CSDN博客

SpringBoot项目企业级全局异常处理-CSDN博客

SpringBoot项目配置国际化-CSDN博客

今天来讲讲如何用自定义注解实现用户会话信息自动化注入。

这里并不是写切面类+注解这种传统方式注入会话信息,

而是实现HandlerMethodArgumentResolver , 并配置于

在某个用户在平台上面进行操作的时候, 会存在很多用户会话信息：包括用户id, 用户姓名, 用户邮箱等。

本期将会介绍如何通过自定义注解，并使用ThreadLocal自动根据请求头注入用户会话信息。

看完这篇博客, 宝宝们将会收获：

  1. 如何通过自定义注解注入会话信息
  2. 设计模式：建造者设计模式的实操使用
  3. JUC：会通过ThreadLocal实现企业级实操应用

好处：

一句话：把“从哪来”的横切关注点一次性解决，让业务代码只关心“做什么”。

比如说, 前面的博客在中, 保存订单时候, 需要传入用户的id, 这个是属于会话信息, 实际场景无需传入的：

2. 示例：

在Controller的接口的传参处加上一个注解@UserSession即可：

 @PostMapping("/saveOrder")
    public Result<Boolean> saveOrder(@UserSession UserSessionInfo userSessionInfo, @RequestBody Order order){
        return Result.success(orderService.saveOrder(order));
    }

效果：

前端Header设置：

  public Boolean saveOrder(Order order) {
        UserSessionInfo userSessionInfo = SessionThreadLocalUtil.getCurrentUserInfo();
        System.out.println("当前的UserSessionInfo为 : " + userSessionInfo);
        // 后续逻辑
}

控制台：

3. 代码

3.1 注解定义@UserSession

package com.rehse.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author: Rehse
 * @description: UserSession
 * @date: 2025/8/14
 */
@Target({ElementType.PARAMETER, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface UserSession {
    boolean required() default true;
}

3.2 用户会话信息定义UserSessionInfo 

里面有一个建造者内部类, 方便快速通过链式注入用户会话信息, 

懂得原理之后, 直接在类上面加一个lombok的@Builder注解即可, 就是自动用来生成建造器的。

package com.rehse.po.dto;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @author: Rehse
 * @description: UserSessionInfo 
 * @date: 2025/8/13
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserSessionInfo {
    private Long userId;
    private String userName;
    private Long orgId;
    private String orgName;
    private String email;

    public static UserSessionInfoBuilder builder() {
        return new UserSessionInfoBuilder();
    }

    public static class UserSessionInfoBuilder {
        private Long userId;
        private String userName;
        private Long orgId;
        private String orgName;
        private String email;

        public UserSessionInfoBuilder userId(Long userId) {
            this.userId = userId;
            return this;
        }

        public UserSessionInfoBuilder userName(String userName) {
            this.userName = userName;
            return this;
        }

        public UserSessionInfoBuilder orgId(Long orgId) {
            this.orgId = orgId;
            return this;
        }

        public UserSessionInfoBuilder orgName(String orgName) {
            this.orgName = orgName;
            return this;
        }

        public UserSessionInfoBuilder email(String email) {
            this.email = email;
            return this;
        }

        public UserSessionInfo build() {
            return new UserSessionInfo(this.userId, this.userName, this.orgId, this.orgName, this.email);
        }
    }
}

3.3 处理器方法参数解析器

关键步骤为：

  1. 先通过UserSessionInfo.builder()获取它的内部类：建造者builder。

  2. 获取HttpServlet请求对象。

  3. 后续就是根据请求对象来获取请求头各个参数值, 然后进行各种判断(判空, 判断是否为数字)。

  4. 判断合规, 则通过建造者builder.参数名函数, 设置值。

  5. 最终通过建造者.build()返回UserSessionInfo对象。

  6. 通过ThreadLocal设置UserSessionInfo为线程变量并返回UserSessionInfo。

package com.rehse.interceptor;

import com.rehse.po.dto.UserSessionInfo;
import com.rehse.util.SessionThreadLocalUtil;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.math.NumberUtils;
import org.springframework.core.MethodParameter;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.support.WebDataBinderFactory;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.ModelAndViewContainer;
import javax.servlet.http.HttpServletRequest;
import java.io.UnsupportedEncodingException;

/**
 * @author: Rehse
 * @description: MyUserSessionResolver
 * @date: 2025/8/13
 */
@Slf4j
@Component
public class MyUserSessionResolver implements HandlerMethodArgumentResolver {

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.getParameterType().isAssignableFrom(UserSessionInfo.class)
                && parameter.hasParameterAnnotation(com.rehse.annotation.UserSession.class);
    }

    @Override
    public Object resolveArgument(MethodParameter methodParameter,
                                  ModelAndViewContainer modelAndViewContainer, NativeWebRequest nativeWebRequest,
                                  WebDataBinderFactory webDataBinderFactory) throws UnsupportedEncodingException {
        return buildByRequest(nativeWebRequest);
    }

    private UserSessionInfo buildByRequest(NativeWebRequest nativeWebRequest) throws UnsupportedEncodingException {
        UserSessionInfo.UserSessionInfoBuilder builder = UserSessionInfo.builder();
        HttpServletRequest httpServletRequest = (HttpServletRequest) nativeWebRequest.getNativeRequest();

        if (StringUtils.isNotBlank(httpServletRequest.getHeader("userId"))) {
            builder.userId(Long.valueOf(httpServletRequest.getHeader("userId")));
        }

        if (StringUtils.isNotBlank(httpServletRequest.getHeader("userName"))) {
            builder.userName(httpServletRequest.getHeader("userName"));
        }

        String orgId = httpServletRequest.getHeader("orgId");
        if (NumberUtils.isDigits(orgId)) {
            builder.orgId(Long.valueOf(orgId));
        }

        if (StringUtils.isNotBlank(httpServletRequest.getHeader("orgName"))) {
            builder.orgName(httpServletRequest.getHeader("orgName"));
        }


        if (StringUtils.isNotBlank(httpServletRequest.getHeader("email"))) {
            builder.email(httpServletRequest.getHeader("email"));
        }

        UserSessionInfo userSessionInfo = builder.build();
        SessionThreadLocalUtil.userSessionInfo.set(userSessionInfo);
        return userSessionInfo;
    }
}

其实现的接口是HandlerMethodArgumentResolver

package org.springframework.web.method.support;

import org.springframework.core.MethodParameter;
import org.springframework.lang.Nullable;
import org.springframework.web.bind.support.WebDataBinderFactory;
import org.springframework.web.context.request.NativeWebRequest;

public interface HandlerMethodArgumentResolver {
    boolean supportsParameter(MethodParameter parameter);

    @Nullable
    Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception;
}

3.4 SessionThreadLocalUtil

package com.rehse.util;

import com.rehse.exception.BusinessException;
import com.rehse.exception.SystemCommonErrorCode;
import com.rehse.po.dto.UserSessionInfo;

/**
 * @author: Rehse
 * @description: SessionThreadLocalUtil
 * @date: 2025/8/14
 */
public class SessionThreadLocalUtil {
    public static final ThreadLocal<UserSessionInfo> userSessionInfo = new ThreadLocal();

    public SessionThreadLocalUtil() {
    }

    public static UserSessionInfo getCurrentUserInfo() {
        UserSessionInfo userInfo = (UserSessionInfo) userSessionInfo.get();
        if (userInfo == null) {
            throw new BusinessException(SystemCommonErrorCode.UN_ACCESS_USERINFO_FROM_SESSION);
        } else {
            return userInfo;
        }
    }
}

3.5 将处理器参数方法解析器注入进WebMvcConfig

看下面两个方法即可, 上面那个区域解析器是上一篇文章用来实现国际化的。

package com.rehse.config;

import com.rehse.interceptor.MyUserSessionResolver;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.LocaleResolver;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import java.util.List;

/**
 * @author: Rehse
 * @description: WebMvcConfig
 * @date: 2025/8/13
 */
@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {

    /**
     * 解析请求中的区域设置：从HTTP请求中提取用户的区域设置信息。
     * 设置响应中的区域设置：在响应中设置适当的区域设置，以便返回用户偏好语言的内容。
     * @return LocaleResolver
     */
    @Bean
    public LocaleResolver localeResolver() {
        return new MyLocalResolver();
    }

    // new一个会话信息参数解析器
    @Bean
    public MyUserSessionResolver headerArgumentResolver() {
        return new MyUserSessionResolver();
    }

    // 将会话信息参数解析器添加进参数解析器里面
    // WebMuvConfigurer中也有该同名方法
    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
        argumentResolvers.add(headerArgumentResolver());
    }
}

4. 测试

4.1 Controller

在接口里面添加了注解@UserSession

  @PostMapping("/saveOrder")
    public Result<Boolean> saveOrder(@UserSession UserSessionInfo userSessionInfo, @RequestBody Order order){
        return Result.success(orderService.saveOrder(order));
    }

4.2 ServiceImpl

Order表建表语句, 以及实体类代码等等, 所有的代码都可以在引言提到的前面几篇博客找到。

SpringBoot项目自定义统一响应体设计_附上完整测试代码-CSDN博客

@Override
    public Boolean saveOrder(Order order) {
        UserSessionInfo userSessionInfo = SessionThreadLocalUtil.getCurrentUserInfo();
        System.out.println("当前的UserSessionInfo为 : " + userSessionInfo);
        Order orderNew = new Order();
        BeanUtils.copyProperties(order, orderNew);
        orderNew.setUserId(String.valueOf(userSessionInfo.getUserId()));
        orderNew.setOrderId(String.valueOf(UUID.randomUUID()).replace("-", ""));
        orderNew.setCreateTime(new Date());
        orderNew.setUpdateTime(new Date());
        orderNew.setStatus(0);
        return save(orderNew);
    }

4.3 控制台

4.4 数据库表

业务代码中, 根据userSession自动注入了user_id。

数据库表中也成功注入：

5. 致谢

感谢宝宝们看完这篇博客, 感觉有帮助的话一键三连么么哒！

25届Java小登已入职, 入职后也要继续提升哇,猪咪将会不定期分享学习笔记！

重铸Java荣光, 我辈义不容辞！

【微服务】springboot 整合 SA-Token 使用详解
congge
08-04 1万+
springboot 整合 SA-Token 使用详解
SpringBoot项目企业级全局异常处理
bugMaker_0621的博客
08-18 1085
本文介绍了SpringBoot项目中全局异常处理的实现方法,统一捕获并处理Controller层的异常。文章详细展示了业务异常类、通用错误码枚举的实现，以及全局异常处理器的代码示例。该方法能有效避免代码重复，统一异常响应格式。同时预告了后续将更新的国际化支持和用户会话信息自动注入功能，包括根据请求头语言返回不同响应消息，以及通过@UserSession注解自动注入用户信息的实现方案。
springboot会话
qq_67124455的博客
03-31 1963
springboot会话入门
Spring Boot 自定义注解实现数据权限校验指南
weixin_32535825的博客
08-09 914
在Java中，注解（Annotation）是元数据的一种形式，提供了关于代码的额外信息，但不会直接影响代码的操作。注解的设计初衷是为了解决在JDK5之前XML配置所带来的复杂性问题。注解通过使用元注解（meta-annotations）来声明注解的类型，并且可以应用于类、方法、字段等元素。注解分为两类：运行时注解和编译时注解。运行时注解：指在运行时仍可被识别的注解，可用于控制程序行为，如依赖注入、事务管理等。Spring框架大量使用了运行时注解。编译时注解。
最新Spring Security实战教程（十七）企业级安全方案设计 - 多因素认证（MFA）实现
Micro麦可乐的博客
06-07 3163
在微服务与分布式架构日益普及的今天，传统的 单一凭证（用户名+密码） 已经难以满足企业对于身份验证的高安全性需求。多因素认证（Multi‐Factor Authentication，简称 MFA） 通过用户知道的东西（如密码）+ 用户拥有的东西（如动态验证码）或 用户自身的一部分（如指纹）三种因素的组合，大幅提升了系统防护能力
在springboot项目中集成springsecurity入门教程
m0_74089057的博客
06-01 914
在springboot项目中集成springsecurity入门教程
一个简单的springboot项目（有源码）
Saniana的博客
08-24 1697
开发一个springboot项目代码迭代整合工具 gitee建模意义程序处理方式开发功能的步骤web服务网络状态码web应用的开发分层springboot的作用springboot框架搭建框架中各组件作用框架的演变如何提取hive中的表结构创建springboot 工程的引导模版 要选择aliyun ，否则不支持java8springboot 工程spring 相关组件代码生成器动态数据源整合druid连接池具体代码：代码说明：Controller层注解 说明小练习Redis（代码）5大数据类型 场景自测
SpringBoot项目配置国际化
bugMaker_0621的博客
08-19 948
本文系统介绍了Spring Boot项目中国际化的实现方案。通过MessageSource+LocaleResolver组合，将文案抽离到i18n资源文件，实现运行时自动切换语言。包括：1)创建i18n目录及多语言properties文件；2)配置basename指定资源文件前缀；3)改造响应体和异常码使用MessageSource获取消息；4)自定义LocaleResolver实现请求头语言解析；5)通过MessageUtils工具类实现消息动态切换。文章还预告了后续将实现的用户会话信息自动注入功能。
Springboot入门到精通（超详细文档）
热门推荐
cuiqwei的博客
06-24 38万+
1. Spring Boot是什么 我们知道，从 2002 年开始，Spring 一直在飞速的发展，如今已经成为了在Java EE（Java Enterprise Edition）开发中真正意义上的标准，但是随着技术的发展，Java EE使用 Spring 逐渐变得笨重起来，大量的 XML 文件存在于项目之中。繁琐的配置，整合第三方框架的配置问题，导致了开发和部署效率的降低。 2012 年 10 月，Mike Youngstrom 在 Spring jira 中创建了一个功能请求，要求在 Spring
【SpringBoot企业级应用构建】：项目实战与架构优化策略
SpringBoot作为现代企业级应用开发的首选框架，它简化了基于Spring的应用开发，使得开发者能够快速搭建和运行项目。本文首先回顾了SpringBoot的基础知识，然后深入探讨了在实战项目中如何构建RESTful API、实现核心...
springboot+shiro快速入门 maven项目 可直接运行
06-04
5. **整合Spring Boot**：通过`@Autowired`注解注入Shiro的相关组件，如SecurityManager，然后在SpringBoot的启动类中进行初始化。 **数据库建表语句** 在使用Shiro进行身份验证和授权时，通常需要在数据库中创建...
【Java】Spring Boot 3.0 微服务架构：高效开发与部署的最佳实践指南
一个被知识诅咒的人
08-19 737
Spring Boot 3.0 作为现代 Java 开发框架的核心升级版本，引入了如原生镜像支持、GraalVM 兼容性和增强的响应式编程等新特性，为微服务开发提供了更高效、更可扩展的解决方案。本文深入探讨了 Spring Boot 3.0 在微服务架构中的最佳实践，从基础环境搭建到高级主题如服务发现、API 网关、容错机制、监控与日志、安全认证以及容器化部署等方面进行全面剖析。通过大量代码示例和详细解释，结合中文注释，帮助开发者理解关键实现细节。文章强调了微服务设计原则，如单一职责、松耦合和高可用性，并
SSM-组件的批量扫描
2402_84971234的博客
08-18 254
本文介绍了Spring Boot中组件导入的几种方法：1）导入自己编写的组件，默认仅扫描当前包及其子包；2）导入第三方组件的两种解决方案：手动实例化对象或使用@Import注解；3）推荐通过新建配置类集中管理组件。文章重点解决了第三方组件中@Component注解无效的问题，并提供了标准化的配置方案。
告别手写文档！Spring Boot API 文档终极解决方案：SpringDoc OpenAPI
最新发布
郑龙飞
08-19 637
在现代 Spring Boot 项目中，SpringDoc OpenAPI 已经不再是一个“锦上添花”的工具，而是保障团队高效协作、提升项目专业度的核心基础设施。
Spring Boot 静态函数无法自动注入 Bean？深入解析与解决方案
weixin_62938484的博客
08-15 386
SpringBoot静态方法无法直接使用@Autowired注入Bean的问题解析与解决方案。文章指出该问题的核心在于Spring依赖注入基于对象实例，而静态成员属于类级别。提供了三种解决方案：1）使用@PostConstruct+Setter方法；2）实现ApplicationContextAware接口；3）构造器注入+静态赋值。同时建议优先考虑重构代码，避免使用静态方法，并分析了各方案的优缺点。最后强调理解原理的重要性，指出静态注入是打破Spring设计初衷的妥协方案，建议通过合理设计消除对静态方法的
基于Java飞算AI的Spring Boot聊天室系统全流程实战
u010287024的专栏
08-14 985
在当今数字化时代，实时通讯已成为现代应用不可或缺的核心功能。从社交平台到企业协作，从在线客服到游戏互动，实时聊天功能正以前所未有的速度渗透到各行各业。然而，开发一个功能完善的聊天室系统绝非易事——传统开发模式下，开发者需要耗费数周时间处理用户认证、实时通信、消息存储等复杂技术栈。本文将详细介绍如何借助Java飞算AI的智能代码生成能力，在极短时间内构建一个全功能的Spring Boot聊天室系统，涵盖从需求分析到部署上线的完整开发流程。实时通讯技术的核心价值在于其。
Spring Boot 全局异常处理
BUG糕手的博客
08-19 216
这篇文章介绍了如何在Spring Boot项目中实现全局异常处理机制，以解决重复try-catch、异常格式不统一等问题。通过使用@ControllerAdvice和@ExceptionHandler注解，可以统一处理业务异常、参数校验异常、空指针异常等。文章详细展示了如何定义统一返回格式、自定义业务异常，并提供了完整的全局异常处理器实现代码。此外，还介绍了如何启用404异常捕获，并提供了测试验证的示例。
Spring Boot + Spring Kafka 集成
刘皇叔说Java的博客
08-18 268
包含，做到开箱即用。
Spring Boot初级概念及自动配置原理
2302_78288964的博客
08-13 1122
-- 此处定义全局版本 -->
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值